dm-media / deploydkit

DeploydKit makes it easy to add a professional web backend to your iOS app with Deployd.

Do you need a professional backend for your iOS app? Add one with DeploydKit for Deployd in minutes!

DeploydKit is a lightweight framework (based on DataKit project) to work with Deployd API (open source) that has great features to create a solid backend for the production environment. Integrate the SDK into your app, configure Deployd and you are ready to go! DeploydKit requires iOS 6 and ARC and has been tested with Deployd 0.6.11. DeploydKit has not been developed by Deployd team, so do not disturb them with information relating to DeploydKit, use the issues of this project.

Thanks to Erik for your great work with DataKit and thanks to Deployd team for your great work with Deployd.

Author: Denis Berton @DenisBerton

Server Configuration

Refer to Deployd.com documentation.

Integrate the SDK

Link to DeploydKit and import <DeploydKit/DeploydKit.h>. Now you only need to configure the DeploydKit manager and you are almost there (this needs to be done before any other DeploydKit objects are invoked, so the app delegate would be a good place to put it).

[DKManager setAPIEndpoint:@"http://localhost:2403/"];
// key difficult to guess, used in DKChannel for configure secureudid (http://secureudid.org)  
[DKManager setAPISecret:@"4333f0a9d92257804a8c396677f9f8e4c8313e6e1c85bd244192c743ce898285"];

The following linker flags must be set:

-ObjC -all_load

Start Coding

Here are some examples on how to use DeploydKit, this is in no way the complete feature set.

Classes:

• DKManager
• DKEntity
• DKQuery
• DKFile
• DKChannel
• DKReachability
• DKNetworkActivity
• DKQueryTableViewController

Entites

DKEntity supports all of Deployd's commands for storing and updating an object in a collection.

// Saving
DKEntity *entity = [DKEntity entityWithName:@"user"];
[entity setObject:@"Denis" forKey:@"name"];
[entity setObject:@"Berton" forKey:@"surname"];
[entity setObject:[NSNumber numberWithInteger:10] forKey:@"credits"];
[entity save];

Authenticating Users

DKEntity defines the following methods to authenticate with Deployd's User collection:

// Log in a user with their username and password
- (BOOL)login:(NSError **)error username:(NSString*)username password:(NSString*)password;

// Logging out for the current user
- (BOOL)logout:(NSError **)error;

// Checks if the current user is logged
- (BOOL)loggedUser:(NSError **)error;

Queries

DKQuery supports all of Deployd's operators and Deployd's custom commands for querying Deployd's collections.

// Sample query for $regex command that allows you to specify a regular expression to match a string property.
DKQuery *query = [DKQuery queryWithEntityName:@"SearchableEntity"];
[query whereKey:@"text" matchesRegex:@"\\s+words"];
NSArray *results = [query findAll];

Files

Require a Amazon Simple Storage Service (Amazon S3) configured on s3-bucket resource for Deployd on Deployd-Modules.

// Saving
// filename generated server side with DeploydKit s3-bucket module, or chosen by the client using with Deployd deployd/dpd-s3
DKFile *file = [DKFile fileWithName:nil data:data];
[file save];
// Loading
DKFile *loadMe = [DKFile fileWithName:@"SomeFileName"];
NSData *data =[loadMe loadData:&error];

Push notifications

DKChannel is a representation of an installation persisted that defines methods for push notification that can be sent from a client device, require apn module on Deployd-Modules. This tutorial from parse.com provides a step-by-step guide to configuring iOS application for push notifications. Refer to node-apn documentation to configure apn module on Deployd-Modules.

Caching

DeploydKit provides disk caching for DKQuery, DKFile (loadData methods only) and DKEntity (refresh methods only)

// The cache policy to use for the query (DKCachePolicyIgnoreCache,DKCachePolicyUseCacheIfOffline,DKCachePolicyUseCacheElseLoad)
@property (nonatomic, assign) DKCachePolicy cachePolicy;

// The age after which a cached value will be ignored
@property (readwrite, assign) NSTimeInterval maxCacheAge;

// Returns whether there is a cached result for this query
- (BOOL)hasCachedResult;

// Clears the cached results for all requests.
[DKManager clearAllCachedResults];

Project Status

Work in progress to switch DeploydKit on AFNetworking with several improvements, stay tuned!