A C library to use the REST API at parse.com.
Use cmake to generate for the build system of your choice:
- mkdir debug; cd debug
- cmake -DCMAKE_BUILD_TYPE=Debug ..
- make
- make test
options supported are:
-DCODE_COVERAGE=ON : enable code coverage using lcov
-DMEMORY_CHECK=ON : enable valgrind memory checking on tests
The unit tests will require a parse.test.json file or the environment variables PARSE_APP_ID and PARSE_API_KEY set.
-
libcurl for HTTP requests
-
libjson (json-c) for JSON parsing
-
pthreads
-
check for unit testing
-
lcov for code coverage
Set the parse application and api keys with cparse_set_application_id() and cparse_set_api_key() and starting parsing your objects.
cParseObject *obj = cparse_object_with_class_name("Wizards");
cParseError *error = NULL;
/* set some values */
cparse_object_set_string(obj, "name", "Harry Potter");
cparse_object_set_number(obj, "score", 24);
cparse_object_set_public_acl(obj, cParseAccessWrite, false);
if(!cparse_object_save(obj, &error))
{
puts(cparse_error_message(error));
cparse_error_free(error);
}
cparse_object_free(obj);
/* Voila, we have saved a Wizard object */void magical_callback(cParseObject *obj, cParseError *error, void *userInfo)
{
int *test = (int*) userInfo;
if(error) {
puts(cparse_error_message(error));
return;
}
if (test && cparse_object_get_number(obj, "magic") == *test) {
do_some_other_action_with_object(obj, userInfo);
}
}
cParseObject *obj = cparse_object_with_class_name("Wizards");
int userInfo = MAGIC_NUM;
cparse_object_set_string(obj, "name", "Harry Potter");
cparse_object_save_in_background(obj, magical_callback, &userInfo);cParseQuery *query = cparse_query_with_class_name("Wizards");
cparse_query_where_gte(query, "score", cparse_json_new_number(24));
if(!cparse_query_find_objects(query, &error))
{
puts(cparse_error_message(error));
cparse_error_free(error);
return;
}
/* get the second result */
if(cparse_query_size(query) > 1)
{
cParseObject *obj = cparse_query_get_result(query, 1);
}A query builder structure can be used to combine multiple conditions.
cParseQuery *query = cparse_query_with_class_name("Wizards");
cParseQueryBuilder *builder = cparse_query_build_new();
cParseJson *names = cparse_json_new_array();
/* query score >= 24 && score < 50 */
cparse_query_build_gte(builder, "score", cparse_json_new_number(24));
cparse_query_build_lt(builder, "score", cparse_json_new_number(50));
/* build an array of names */
cparse_json_add_string(names, "Harry");
cparse_json_add_string(names, "Dumbledore");
/* query by name in array */
cparse_query_build_in(builder, "name", names);
/* assign builder to the query */
cparse_query_build_where(query, builder);
/* free the builder */
cparse_query_build_free(builder);
if(!cparse_query_find_objects(query, &error))
{
puts(cparse_error_message(error));
cparse_error_free(error);
return;
}
/* etc, free more resources */Users are objects as well, so you can use any of the object functions, but there are special functions just for users as well.
cParseUser *user = cparse_user_with_name("Ronald");
/* set object attributes */
cparse_object_set_string(user, "last_name", "Weasley");
cparse_object_set_number(user, "birth_year", 1980);
/* TODO: obviously, this password should be encrypted already at this point */
if(!cparse_user_sign_up(user, "Password!", &error)) {
puts(cparse_error_message(error));
cparse_error_free(error);
return;
}
cparse_user_free(user);
/* now login as the created user */
user = cparse_user_login("Ronald", "Password!", &error);
if(user == NULL) {
puts(cparse_error_message(error));
cparse_error_free(error);
return;
}
/* user is logged in at this point and can call cparse_current_user() */
loggedInUser = cparse_current_user();This is how you would query users.
/* create a query for a user type */
cParseQuery *query = cparse_user_query_new();
/* name not equals Harry */
cparse_query_where_ne(query, "name", "Harry");
if(!cparse_query_find_objects(query, &error))
{
puts(cparse_error_message(error));
cparse_error_free(error);
return;
}
if (cparse_query_size(query) > 0) {
cParseUser *user = cparse_query_get_result(query, 0);
/* etc */
}Roles define access control for a group of users and can inherit from other roles.
cParseRole *role = cparse_role_with_name("Students");
cParseQuery *query = NULL;
/* set read only access */
cparse_role_set_public_acl(role, cParseAccessRead, true);
cparse_role_set_public_acl(role, cParseAccessWrite, false);
/* add a user to the role */
cparse_role_add_user(role, user);
/* add an inherited role */
cparse_role_add_role(role, inherited_role);
/* create the Students role */
if (!cparse_role_save(role, &error)) {
puts(cparse_error_message(error));
cparse_error_free(error);
}
/* look up users associated with the role */
query = cparse_role_query_users(role);
if (cparse_query_size(query) > 0) {
}
/* look up role heirarchy */
query = cparse_role_query_roles(role);
if (cparse_query_size(query) > 0) {
}Control read/write access for any object. Access can for public, user or roles.
cParseObject *obj = cparse_object_with_class_name("Wizards");
/* restrict public write access */
cparse_object_set_public_acl(obj, cParseAccessWrite, false);
/* allow write access for a specific user */
cparse_object_set_user_acl(obj, user, cParseAccessWrite, true);
/* allow write access for users in a role */
cparse_object_set_role_acl(obj, role, cParseAccessWrite, true);Obiously parse wrote the REST API, I'm showing off C skills.
If you like the library or have improvements/questions, drop me a line and let me know!
I know my code style goes against the norms (wha? no camel case??) so you can probably save yourself the time for that comment.
My blog has more information about me.
- complete the full parse REST API
- performance benchmarking
- try and simplify the code for complex queries