Rounded Robot

[](https://travis-ci.org/Brian Weinreich/RoundedRobot)

Usage

To run the example project, clone the repo, and run pod install from the Example directory first.

Requirements

iOS 7 or greater

Installation

ROBot is available through CocoaPods. To install it, simply add the following line to your Podfile:

pod "RoundedRobot"

How to use

ROBot a stand alone libraby that handles CRUD methods for NSManagedObjects. Calling create, read, update, delete, or index, will make the API and update the database appropriately.

To begin, call this line:

[ROBotManager initializeWithBaseURL:@"https://your_base_url"];

If you plan on using the index methods or caching, you'll also need to set your persistent store coordinator:

[ROBotManager sharedInstance].persistentStoreCoordinator = [self persistentStoreCoordinator];

Next, #import "ROBot.h" into the classes you plan on using ROBot in.

You'll need to override the CRUD urls in your NSManagedObject (or corresponding category). Ex:

  + (NSString *)indexURL
  {
      return @"/users";
  }

  - (NSString *)createURL
  {
      return @"/users";
  }

  - (NSString *)readURL
  {
      return [NSString stringWithFormat:@"/users/%@", self.user_id];
  }

  - (NSString *)updateURL
  {
      return [NSString stringWithFormat:@"/users/%@", self.user_id];
  }

  - (NSString *)deleteURL
  {
      return [NSString stringWithFormat:@"/users/%@", self.user_id];
  }

Note that the url path are instance methods, and will populate the variables in the url string when the url methods is called.

You can then call CRUD methods on the instances of the model, and the changes will be made to your database and API.

Index

[User index:^{
  // Finished index call
} failure:^(ROBotError *error) {
  // Finished with error
}];

Create

User *user = // create new entity
user.first_name = @"Heather";
user.last_name = @"Sneps";
[user create:^{} failure:^{}];

Read

User *user = ... // get user
[user read:nil failure:nil];

Update

User *user = ... // get user
[user update:nil failure:nil];

Delete

User *user = ... // get user
[user delete:nil failure:nil];

Save

For the lazy people who don't want to figure out if it needs to be created or updated...

User *user = ... // get user
[user save:nil failure:nil];

Customization

You can specify a custom mapping from the API response to the database object. If you don't specify a mapping, ROBot will map the results from the API directly to the corresponding fields in your database.

To specify a mapping, do the following:

[User setMapping:@[@"last_name": @"lname", @"first_name": @"fname"]];

Note that a partial mapping can be used. In the case above, the email will still map to email.

Headers

To add custom headers to requests, do the following:

[[ROBotManager sharedInstance] addHeaderValue:@"Hunting" forHeaderField:@"SL-Sport"];

You can add as many default headers as you would like.

Logging

By default, logging is disabled. To enable logging for all your ROBotManagedObjects, use

ROBotManagedObject.verboseLogging = true

to enable logging for a single ROBotManagedObject class, use

User.verboseLogging = true

Thanks!

Feel free to submit a pull request and add your own contributions!

Authors

• Heather Snepenger, [email protected] (WAAH WAAAH)
• Brian Weinreich, [email protected] (Mr. Amazing)

License

ROBot is available under the MIT license. See the LICENSE file for more info.