rapidash 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dc6b0e6636bacbfbc9b0294b808b87e69d8ed6d9
-  data.tar.gz: 58ff477a1fd01590ed8deb47647e9be8c0212ff5
+  metadata.gz: b7cf2002fd2e632f1c5150d3d3a5d858d58ec09c
+  data.tar.gz: 6de1e547b1243cce13a8440a41ac28113e191843
 SHA512:
-  metadata.gz: 715b0e98003340a217a1d0d3b673a7f0b5d96e4dbbe45b0f26e718d949a5777c5ae16b392573df2f005fa36e69f2dfa1347c5c9e320827ad957ab177ebb438e7
-  data.tar.gz: 470f35e9d9234fd207d1a002875957f453c8fd55541a3c2ecd86a91124fca19dd48d890e3b7f3fe2cac1ec56db000783d7169d4db0768eadec61aa6eb4dd1edc
+  metadata.gz: b64aa96d960b5a4bb1e2e50bd7c16c262e40fe57548745d1410385c3ce25f8b3374dc2673da012c0d9c5038c21e0e3746eb3fe4405a8c30b1a8b308d2215cd64
+  data.tar.gz: 9e1d5838e548568064e63bfe8ff2c3cc173d308c7a4f5c9c79615cb7fdf29fedeb837c51c352ec0d5813643bba8c4598b9e1e2e6eb467ba9dc9c3b253798c777

data/README.md

@@ -22,32 +22,65 @@ Or install it yourself as:
 
 Resources can be defined as follows:
 
-    class Users < Rapidash::Base
-    end
+```ruby
+class Users < Rapidash::Base
+end
+```
 
 The URL of the resource will be inferred from the class name.  In this case Users.  If you want to override that, you can with the url method.
 
-    class Users < Rapidash::Base
-      url :members  # or url "members" is also supported
-    end
+```ruby
+class Users < Rapidash::Base
+  url :members  # or url "members" is also supported
+end
+```
 
 Resources can exist inside other resources.  For example, on Github, a user has repositories.  The following could be how you build the resources:
 
-    class Repos < Rapidash::Base
-    end
+```ruby
+class Repos < Rapidash::Base
+end
 
-    class Users < Rapidash::Base
-      resource :repos
-    end
+class Users < Rapidash::Base
+  resource :repos
+end
+```
+
+#### Root elements
+
+A root element can be set for create and post actions
+
+```ruby
+class Posts < Rapidash::Base
+end
+
+client.posts.create!({:post => {:name => "a post"}})
+```
+
+With a root element, the code would look like this:
+
+```ruby
+class Posts < Rapidash::Base
+  root :post
+end
+
+client.posts.create!(:name => "a post")
+```
 
 ### Client
 
 The main thing a client must do is define a method, `oauth` and `http` are currently supported.  You can also define resources which links a resource as defined above to the client.
 
-    class Client < Rapidash::Client
-      method :oauth
-      resource :users
-    end
+```ruby
+class Client < Rapidash::Client
+  method :oauth
+  resource :users
+  use_patch # This will use PATCH when updating instead of POST
+  extension :json #Append the extension fo the urls
+end
+```
+
+
 
 OAuth provides an initialize method which you can see in the Facebook client example.
 
@@ -55,57 +88,63 @@ Currently when using the HTTP method, you will need to define your own initializ
 
 ### Making calls
 
-    client = Client.new
-    client.site = "http://example.com/"
-    client.users #Returns an instance of Users
-    client.users! #Will make a call to "http://example.com/users
-    client.users!(1) #Will make a call to http://example.com/users/1
-    client.users!(params => {:page => 1}}) # Will make a call to http://example.com/users?page=1
+```ruby
+client = Client.new
+client.site = "http://example.com/"
+client.users                                            #Returns an instance of Users
+client.users!                                           #Will make a call to "http://example.com/users.json
+client.users!(1)                                        #Will make a call to http://example.com/users/1.json
+client.users!(params => {:page => 1}})                  #Will make a call to http://example.com/users.json?page=1
+client.users.create!({:user => {:name => "Gazler"}})    #POST requst to /users.json
+client.users(1).update!({:user => {:name => "Gazler"}}) #PUT or PATCH requst to /users.json
+client.users(1).delete!                                 #DELETE requst to /users.json
+```
 
 ## Example Clients
 
 ### Facebook
 
-    require 'rapidash'
+```ruby
+require 'rapidash'
 
-    class Me < Rapidash::Base
-    end
+class Me < Rapidash::Base
+end
 
-    class Facebook < Rapidash::Client
-      method :oauth
-      resource :me
-    end
+class Facebook < Rapidash::Client
+  method :oauth
+  resource :me
+end
 
-    client = Facebook.new({
-      :site => "https://graph.facebook.com",
-      :uid => "YOUR_ID",
-      :secret => "YOUR_SECRET",
-      :access_token => "YOUR_TOKEN"
-    })
-    p client.me!.first_name #Gary
+client = Facebook.new({
+  :site => "https://graph.facebook.com",
+  :uid => "YOUR_ID",
+  :secret => "YOUR_SECRET",
+  :access_token => "YOUR_TOKEN"
+})
+p client.me!.first_name #Gary
+```
 
 ### Github
 
-    require 'rapidash'
-
-    class Repos < Rapidash::Base
+```ruby
+require 'rapidash'
 
-    class Users < Rapidash::Base
-      resource :repos
-    end
+class Repos < Rapidash::Base
 
-    class Github < Rapidash::Client
-      method :http
-      resource :users
+class Users < Rapidash::Base
+  resource :repos
+end
 
-      def initialize
-        @site = "https://api.github.com/"
-      end
-    end
+class Github < Rapidash::Client
+  method :http
+  resource :users
+  site "https://api.github.com/"
+end
 
-    client = Github.new
-    p client.users!("Gazler").name           #Gary Rennie
-    p client.users("Gazler").repos![0].name  #Githug
+client = Github.new
+p client.users!("Gazler").name           #Gary Rennie
+p client.users("Gazler").repos![0].name  #Githug
+```
 
 ## Contributing
 

data/lib/rapidash/base.rb

@@ -3,8 +3,17 @@ module Rapidash
 
     include Urlable
     include Resourceable
+
     attr_accessor :url, :options, :client
 
+    class << self
+      attr_accessor :root_element
+
+      def root(name)
+        @root_element = name.to_sym
+      end
+    end
+
     def initialize(*args)
       @client, @id, options = args
 
@@ -20,34 +29,42 @@ module Rapidash
     end
 
     def create!(params)
-      self.options[:method] = :post
-      self.options[:body] = params.to_json
+      options[:method] = :post
+      set_body!(params)
       call!
     end
 
     def update!(params)
-      self.options[:method] = client.class.patch ? :patch : :put
-      self.options[:body] = params.to_json
+      options[:method] = client.class.patch ? :patch : :put
+      set_body!(params)
       call!
     end
 
     def delete!
-      self.options[:method] = :delete
+      options[:method] = :delete
       call!
     end
 
 
     def call!
       self.options ||= {}
-      self.options.delete(:previous_url)
-      self.options[:header] ||= {}
-      self.options[:header]["content-type"] = "application/json"
-      method = self.options.delete(:method) || :get
-      client.send(method, url, self.options)
+      options.delete(:previous_url)
+      options[:header] ||= {}
+      options[:header]["content-type"] = "application/json"
+      method = options.delete(:method) || :get
+      client.send(method, url, options)
     end
 
     private
 
+    def set_body!(params)
+      if self.class.root_element
+        options[:body] = {self.class.root_element => params}.to_json
+      else
+        options[:body] = params.to_json
+      end
+    end
+
     def base_url
       if old_url = self.options[:previous_url]
         return "#{old_url}/"

data/lib/rapidash/client.rb

@@ -26,5 +26,6 @@ module Rapidash
     def delete(url, options = {})
       request(:delete, url, options)
     end
+
   end
 end

data/lib/rapidash/clientable.rb

@@ -7,7 +7,7 @@ module Rapidash
 
     module ClassMethods
 
-      attr_accessor :patch
+      attr_accessor :patch, :url_extension
 
       def method(method)
         case method
@@ -22,6 +22,10 @@ module Rapidash
       def use_patch
         @patch = true
       end
+
+      def extension(extension)
+        @url_extension = extension
+      end
     end
   end
 end

data/lib/rapidash/http_client.rb

@@ -3,20 +3,31 @@ require 'faraday'
 module Rapidash
   module HTTPClient
 
-    attr_accessor :site, :extension
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    attr_accessor :extension, :site
     attr_writer :connection
 
-    def site=(value)
+    def initialize
+    end
+
+    def site=(site)
+      @site = site
       @connection = nil
-      @site = value
     end
 
     def connection
-      @connection ||= Faraday.new(site)
+      @connection ||= Faraday.new(site || self.class.site_url)
     end
 
     def request(verb, url, options = {})
-      url = "#{url}.#{extension}" if extension
+      if extension
+        url = "#{url}.#{(extension)}"
+      elsif self.class.respond_to?(:url_extension) && self.class.url_extension
+        url = "#{url}.#{(self.class.url_extension)}"
+      end
       url = connection.build_url(url, options[:params]).to_s
       response = connection.run_request(verb, url, options[:body], options[:header])
 
@@ -29,5 +40,15 @@ module Rapidash
         return Response.new(response)
       end
     end
+
+
+
+    module ClassMethods
+      attr_accessor :site_url
+
+      def site(site)
+        @site_url = site
+      end
+    end
   end
 end

data/lib/rapidash/oauth_client.rb

@@ -18,7 +18,11 @@ module Rapidash
     end
 
     def request(verb, url, options = {})
-      url = "#{url}.#{extension}" if extension
+      if extension
+        url = "#{url}.#{(extension)}"
+      elsif self.class.respond_to?(:url_extension) && self.class.url_extension
+        url = "#{url}.#{(self.class.url_extension)}"
+      end
       response = oauth_access_token.send(verb.to_sym, "#{site}/#{url}", options)
       body = JSON.parse(response.body)
       if body.kind_of?(Hash)

data/lib/rapidash/response.rb

@@ -1,4 +1,3 @@
-require 'rubygems'
 require 'json'
 require 'hashie'
 

data/lib/rapidash/version.rb

@@ -1,3 +1,3 @@
 module Rapidash
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/spec/rapidash/base_spec.rb

@@ -16,6 +16,10 @@ class BaseTesterClient
   end
 end
 
+class RootTester < Rapidash::Base
+  root :post
+end
+
 
 describe Rapidash::Base do
 
@@ -38,11 +42,15 @@ describe Rapidash::Base do
   let(:headers) { {"content-type" => "application/json"} }
   let(:subject) { BaseTester.new(client) }
 
+  let(:no_root) {
+    {
+      :title => "A test post"
+    }
+  }
+
   let(:post) {
     {
-      :post => {
-        :title => "A test post"
-      }
+      :post => no_root
     }
   }
 
@@ -55,6 +63,16 @@ describe Rapidash::Base do
         :body => post.to_json
       })
     end
+
+    it "should use the root element if one is defined" do
+      subject = RootTester.new
+      subject.should_receive(:call!)
+      subject.create!(no_root)
+      subject.instance_variable_get(:@options).should eql({
+        :method => :post,
+        :body => post.to_json
+      })
+    end
   end
 
   describe ".update!" do
@@ -76,6 +94,16 @@ describe Rapidash::Base do
         :body => post.to_json
       })
     end
+
+    it "should use the root element if one is defined" do
+      subject = RootTester.new(client)
+      subject.should_receive(:call!)
+      subject.update!(no_root)
+      subject.instance_variable_get(:@options).should eql({
+        :method => :patch,
+        :body => post.to_json
+      })
+    end
   end
 
   describe ".delete!" do

data/spec/rapidash/clientable_spec.rb

@@ -10,6 +10,14 @@ class HTTPClientTester
   method :http
 end
 
+class HTTPClientPatchTester < HTTPClientTester
+  use_patch
+end
+
+class HTTPClientExtensionTester < HTTPClientTester
+  extension :json
+end
+
 class TestClientTester
   include Rapidash::Clientable
   method :test
@@ -54,4 +62,16 @@ describe Rapidash::Clientable do
     
   end
 
+  describe "#use_patch" do
+    it "should set the patch variable to true" do
+      HTTPClientPatchTester.new.class.instance_variable_get(:@patch).should eql(true)
+    end
+  end
+
+  describe "#extension" do
+    it "should set the url_extension variable" do
+      HTTPClientExtensionTester.new.class.instance_variable_get(:@url_extension).should eql(:json)
+    end
+  end
+
 end

data/spec/rapidash/http_client_spec.rb

@@ -4,6 +4,17 @@ class HTTPTester
   include Rapidash::HTTPClient
 end
 
+class HTTPSiteTester < HTTPTester
+  site "http://mysite.com/"
+end
+
+class HTTPExtensionTester < HTTPTester
+  site "http://mysite.com/"
+  def self.url_extension 
+    :json
+  end
+end
+
 describe Rapidash::HTTPClient do
 
   let!(:subject) { HTTPTester.new }
@@ -28,6 +39,18 @@ describe Rapidash::HTTPClient do
     it "should create a Faraday object" do
       subject.connection.class.should eql(Faraday::Connection)
     end
+
+    it "should use the site variable if set" do
+      Faraday.should_receive(:new).with("http://example.com/")
+      subject.site = "http://example.com/"
+      subject.connection
+    end
+
+    it "should use the class URL if one is defined" do
+      subject = HTTPSiteTester.new
+      Faraday.should_receive(:new).with("http://mysite.com/")
+      subject.connection
+    end
   end
 
   describe ".request" do
@@ -46,6 +69,13 @@ describe Rapidash::HTTPClient do
       subject.request(:get, "foo")
     end
 
+    it "should use the class extension if one is set" do
+      subject = HTTPExtensionTester.new
+      subject.connection.should_receive(:run_request).with(:get, "http://mysite.com/foo.json", nil, nil).and_return(valid_response)
+      subject.request(:get, "foo")
+    end
+
+
     it "should return a response object" do
       subject.connection.should_receive(:run_request).with(:get, "http://example.com/foo", nil, nil).and_return(valid_response)
       response = subject.request(:get, "foo")

data/spec/rapidash/oauth_client_spec.rb

@@ -4,6 +4,12 @@ class OAuthTester
   include Rapidash::OAuthClient
 end
 
+class OAuthExtensionTester < OAuthTester
+  def self.url_extension 
+    :json
+  end
+end
+
 describe Rapidash::OAuthClient do
 
   let(:options) do
@@ -67,6 +73,15 @@ describe Rapidash::OAuthClient do
         subject.request(:get, "me")
       end
 
+      it "should use the class extension if one is set" do
+        subject = OAuthExtensionTester.new(options)
+        subject.stub(:oauth_access_token).and_return(request)
+        request.stub(:get).and_return(response)
+        request.should_receive(:get).with("http://example.com/me.json", anything)
+        subject.request(:get, "me")
+      end
+
+
       it "should return a Hashie::Mash" do
         subject.request(:get, "me").class.should eql(Hashie::Mash)
       end

data/spec/spec_helper.rb

@@ -1,3 +1,2 @@
-require 'rubygems'
 require "./lib/rapidash"
 require "ostruct"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rapidash
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Gary 'Gazler' Rennie