Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
iOS/Mac OS framework for Rails

readme.md

nsrails.com


NSRails is a lightweight framework that makes mapping client-side objects to remote Rails objects a breeze, and calling CRUD operations and others super easy. It's accessible while also extremely flexible and customizable, to the point that it'll work with any RESTful server, not just Rails. Also, CoreData support is seamless.

Here's how easy it is to get started. Set the root URL of your app somewhere during launch:

NSRConfig.defaultConfig().rootURL = NSURL(string:"http://localhost:3000")
[NSRConfig defaultConfig].rootURL = [NSURL URLWithString:@"http://localhost:3000"];

Inherit model objects from NSRRemoteObject, or NSRRemoteManagedObject with CoreData:

@objc(Post) class Post : NSRRemoteObject {
  var author: String
  var content: String
  var createdAt: NSDate
  var responses: [Response]
}
@interface Post : NSRRemoteObject

@property (nonatomic, strong) NSString *author, *content;
@property (nonatomic, strong) NSDate *createdAt;
@property (nonatomic, strong) NSArray *responses;

@end

Note: @objc(<ClassName>) is currently required for Swift so the class name bridges over nicely.

That's it! Instances inherit methods to remotely create, read, update, or destroy their corresponding remote object:

let post = Post()
post.author = "Me"
post.content = "Some text"

// POST /posts.json => {post:{author:"Me", content:"Some text"}}
post.remoteCreateAsync() { error in
    ...
}

post.content = "Changed!"
// PATCH /posts/1.json => {post:{author:"Me", content:"Changed!"}}
post.remoteUpdateAsync() { error in ... }

// Fetch any latest data for this post and update locally
// GET /posts/1.json
post.remoteFetchAsync() { error in ... }

// DELETE /posts/1.json
post.remoteDestroyAsync() { error in ... }

// GET /posts.json
Post.remoteAllAsync() { allPosts, error in ... }

// GET /posts/1.json
Post.remoteObjectWithID(1) { post, error in ... }

// Retrieve a collection based on an object
// GET /posts/1/responses.json
Response.remoteAllViaObject(post) { responses, error in ... }

A lot of behavior is customized via overrides. For instance, in the previous example, in order to populate a Post's responses array with Response objects automatically when a Post is retrieved, we have to specify the Response class as the type for that property.

@implementation Post

//override
- (Class) nestedClassForProperty:(NSString *)property {
    if ([property isEqualToString:@"response"]) {
        return [Response class];
    }

    return [super nestedClassForProperty:property];
}

@end

(Sidenote: This is necessary for Objective-C of course, but at least in Swift, there's probably a good way to automatically infer the type from the generic specified in the array, which I haven't looked into it yet. Let me know if this is possible!)

See the documentation for more on what you can do with NSRails-charged classes, or the cookbook for quick NSRRemoteObject override recipes.

NSRRequest

Requests themselves can be customized with query parameters (/?a=b&c=d), additional HTTP headers, or to go to custom routes (i.e. for custom controller methods) using the NSRRequest class. The results of these requests can easily be converted from JSON into native model objects using inherited convenience methods such as +[MyClass objectWithRemoteDictionary:] and +[MyClass objectsWithRemoteDictionaries:].

Support

Installation

The best way to install NSRails is to use the Great CocoaPods. Add pod 'NSRails' to your Podfile, or pod 'NSRails/CoreData' if you're using CoreData.

  • Getting started using NSRails with Ruby has been moved here.
  • Also, autogenerate NSRails-ready classes from a Rails project.

Dependencies

  • iOS 5.0+ / OS X 10.7+
  • Automatic Reference Counting (ARC)

Credits

NSRails is written and maintained by Dan Hassin. A lot of it was inspired by the ObjectiveResource project, many thanks there!

http://nsrails.com – an open forum -type thing running on Rails/Heroku and powered by the included NSRails demo app!

Something went wrong with that request. Please try again.