Build Status (master):

Build Status (develop):

This library is a port of Parse's REST API to CodenameOne (and by extension to Java).

• Synopsis
• License
• Requirements
• Installation
• Coverage
  • Release Planning
• Usage Examples
• Contributing
• Credits

The Parse platform provides a complete backend solution for your mobile application. Parse provides a REST API as well as libraries for different mobile platforms like Android and iOS. CodenameOne (CN1 for short) on the other hand is a great framework for cross-platform mobile application development. Although some of the functionality provided by Parse is offered to paying CN1 users, integration of third-party libraries is allowed and even encouraged in CN1. This project aims at making the Parse platform available to CN1 apps thereby giving developers more options for cloud-based backend solutions in CN1. In order to maximize platform support, this library aims at implementing the REST API specification rather than for instance, integrating the existing Parse native libraries for various platforms. Of course, where possible, advanced features that go beyond the REST API (e.g., background operations) will also be supported by this library provided they can be implemented in a generic manner. Since CN1 is written in Java, this library can also be used in pure Java projects as illustrated here.

Apache License, Version 2.0

1. Codename One 1.0 or higher (tested with the CN1 Netbeans plugin but should work with others)
2. CN1JSON library (delivered along with this library for compatibility; see the Installation section below)

1. Download the dist/parse4cn1.cn1lib and dist/CN1JSON.cn1lib files and copy them into your Codename One Application's "lib" directory (or alternatively, use the corresponding JARs in dist/parse4cn1.jar and dist/lib/CN1JSON.jar).
2. If using Netbeans, right-click on your application's icon in the Netbeans project explorer, and select "Refresh Libs".

The Parse RESTAPI is quite extensive. As such, we maintain an overview of the functionality that is currently covered. Developers are most welcome to work on pending functionality. Note that some of the functionality marked as pending below may actually be present in the source code inherited from Parse4J. However, the status here reflects what has been tested and verified to work with CN1. Any functionality not marked as implemented below may be used at own risk :)

Unscheduled

• Analytics
• Roles
• Sessions
• Linking users
• Background operations (e.g. saving, fetching)
• Pinning items (offline mode)
• Expose cloud modules like Twilio and Mailgun via cloud code

See Usage examples

Contributing to this project is most welcome; the more, the merrier! Simply fork the master branch, implement a feature / bug fix and initiate a pull request. Please bear the following in mind though to ensure smooth and timely integration of your changes:

1. The public interface of this API is as much as possible aligned to the official Parse Android SDK. When implementing functionality already present there, please try to use the same method names and structure where possible. This just makes it consistent and easier to follow.

   Of course, there may be cases where you really think a different name for a given functionality or different semantics for the same method name are much better. That's fine. Just try to make the deviations clear in the method documentation, which leads me to the next point.

2. Document at least all public facing methods with comments that add value (not simply boilerplate comments that state the obvious).

3. Write tests for added functionality (see the test directory for some inspiration if needed).

4. Make sure all tests are passing in both the Java test application (run on travis) and the CN1 test app before issuing a pull request.

Furthermore, it's handy, at the time you pick up a feature, to mention it so that others can see what's in progress and efforts can be consolidated (there's little or no value in having multiple implementations of the same feature going on in parallel). So update the coverage table above with what you're working on as well as an estimate of when you expect it to be done. If you can't update this page directly, just create a ticket with the information and this page will be updated for you. Thanks!

1. Thiago Locatelli's Parse4J project (version 1.3) from which the initial design and implementation of Parse4CN1 were adapted.
2. Steve Hannah's CN1JSON library.