REST Adapter for DataMapper
Ruby
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib Remove jeweler Nov 16, 2011
spec Make sure to finalize the models before using them Jul 28, 2011
tasks Updated jeweler dep to 1.5.2 Feb 19, 2011
.gitignore
Gemfile Remove jeweler Nov 16, 2011
LICENSE Updated Copyright year Mar 1, 2011
README.rdoc Stripped whitespace Feb 19, 2011
Rakefile Remove jeweler Nov 16, 2011
dm-rest-adapter.gemspec Remove jeweler Nov 16, 2011

README.rdoc

dm-rest-adapter

A DataMapper adapter for REST Web Services

Usage

DM Rest Adapter requires the use of a model which is the same name as the resource you are using. For example, if you have a resource named “posts” you will create a standard datamapper object called post.rb in app/models. The only difference in this model is you will need to define the rest adapter for the model.

The following is an example of a post model, where the host settings point to the app you are running the resource on. In addition I have included a basic auth login which will be used if your resource requires auth:

DataMapper.setup(:default, {
  :adapter  => 'rest',
  :format   => 'xml',
  :host     => 'localhost',
  :port     => 4000,
  :login    => 'user',
  :password => 'verys3crit'
})

class Post

  include DataMapper::Resource

  property :id, Serial
  property :title, String
  property :body,  Text

end

If you notice this looks exactly like a normal datmapper model. Every property you define will map itself with the xml returned or posted from/to the resource.

Code

Now for some code examples. DM Rest Adapter uses the same methods as datamapper including during creation.

Post.first
# => returns the object from the resouce
Post.get(1)
# => returns the object from the resource
p = Post.new(:title => "My awesome blog post", :body => "I really have nothing to say...")
p.save
# => saves the resource on the remote

Caveat

Posts do not honor RESTful HTTP status codes. I might fix this…

TODO:

Nested resources Put verb actions