rapidash 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b7cf2002fd2e632f1c5150d3d3a5d858d58ec09c
-  data.tar.gz: 6de1e547b1243cce13a8440a41ac28113e191843
+  metadata.gz: 25d2edf71b1e0e81782f4d56e4926b963c57e053
+  data.tar.gz: 6982fb798abb4b49ba0ce54f72bca5c3086cb56b
 SHA512:
-  metadata.gz: b64aa96d960b5a4bb1e2e50bd7c16c262e40fe57548745d1410385c3ce25f8b3374dc2673da012c0d9c5038c21e0e3746eb3fe4405a8c30b1a8b308d2215cd64
-  data.tar.gz: 9e1d5838e548568064e63bfe8ff2c3cc173d308c7a4f5c9c79615cb7fdf29fedeb837c51c352ec0d5813643bba8c4598b9e1e2e6eb467ba9dc9c3b253798c777
+  metadata.gz: c769c2bcb2074211878609785ca58e2fae9840861f6a6cb6636760b6b22dd97b65e0330a9c110724e1f247e5f2d35fe96395056d23239fe1d9325b987863866c
+  data.tar.gz: 7bbc9e3833e52d99c723a43f088f2b3abe51d720f9366993f845aac55df7c9d2f05c4406f71c26f4ce856ed35a270c9acf944719fa55642b69a300adbe52dea5

data/README.md

@@ -74,7 +74,7 @@ The main thing a client must do is define a method, `oauth` and `http` are curre
 ```ruby
 class Client < Rapidash::Client
   method :oauth
-  resource :users
+  resource :users, :repos #An array can be passed through
   use_patch # This will use PATCH when updating instead of POST
   extension :json #Append the extension fo the urls
 end

data/examples/github.rb

@@ -0,0 +1,64 @@
+require 'rapidash'
+
+class Repos < Rapidash::Base
+  def repo!(owner, repo)
+    self.url += "/#{owner}/#{repo}"
+    call!
+  end
+end
+
+class Users < Rapidash::Base
+  resource :repos
+end
+
+class Emojis < Rapidash::Base
+end
+
+class Events < Rapidash::Base
+end
+
+class Gists < Rapidash::Base
+
+  def public!
+    self.url += "/public"
+    call!
+  end
+
+end
+
+class Organisations < Rapidash::Base
+  url "orgs"
+end
+
+class Limit < Rapidash::Base
+  url "rate_limit"
+end
+
+
+class Client < Rapidash::Client
+  method :http
+  site "https://api.github.com/"
+  resource :users, :repos, :emojis, :events, :gists, :organisations, :limit
+end
+
+client = Client.new
+
+p client.limit!.rate.remaining
+
+p client.gists.public!
+
+client.users("Gazler").repos!.each do |repo|
+  p repo.name
+end
+
+client.emojis!.each do |emoji|
+  p emoji
+end
+
+client.events!.each do |event|
+  p event
+end
+
+p client.organisations!("powershift")
+
+p client.repos.repo!("Gazler", "rapidash")

data/lib/rapidash/clientable.rb

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

data/lib/rapidash/errors.rb

@@ -1,4 +1,5 @@
 module Rapidash
   class ParseError < StandardError; end
   class ConfigurationError < StandardError; end
+  class ResponseError < StandardError; end
 end

data/lib/rapidash/http_client.rb

@@ -33,6 +33,10 @@ module Rapidash
 
       # "foo"[0] does not work in 1.8.7, "foo"[0,1] is required
       case response.status.to_s[0,1]
+      when "5", "4"
+        error = ResponseError.new(response)
+        raise error if self.class.respond_to?(:raise_error) && self.class.raise_error
+        return nil
       #Handle redirects
       when "3"
         request(verb, response.headers["location"], options)

data/lib/rapidash/oauth_client.rb

@@ -23,17 +23,9 @@ module Rapidash
       elsif self.class.respond_to?(:url_extension) && self.class.url_extension
         url = "#{url}.#{(self.class.url_extension)}"
       end
+        options[:raise_errors] = self.class.respond_to?(:raise_error) && self.class.raise_error
       response = oauth_access_token.send(verb.to_sym, "#{site}/#{url}", options)
-      body = JSON.parse(response.body)
-      if body.kind_of?(Hash)
-        return Hashie::Mash.new(body)
-      elsif body.kind_of?(Array)
-        output = []
-        body.each do |el|
-          output << Hashie::Mash.new(el)
-        end
-        return output
-      end
+      return Response.new(response)
     end
 
     def access_token_from_code(code, url)

data/lib/rapidash/resourceable.rb

@@ -7,40 +7,40 @@ module Rapidash
 
     module ClassMethods
 
-      def resource(name)
+      def resource(*names)
         mod = self.to_s.split("::")[0...-1]
         if mod.empty?
           mod = Kernel
         else
           mod = Kernel.const_get(mod.join("::"))
         end
-        klass = mod.const_get(name.to_s.capitalize)
 
-        def get_client(me)
-          client = me
-          if me.respond_to?(:client)
-            client = me.client
-          end
-          client
-        end
 
-        mod = self
 
-        define_method(name) do |*args|
-          if self.respond_to?(:url)
-            options = {:previous_url => self.url}
-            if args[args.length].is_a?(Hash)
-              args[args.length].merge!(options)
-            else
-              args << options
+        names.each do |name|
+          klass = mod.const_get(name.to_s.capitalize)
+
+          define_method(name) do |*args|
+            if self.respond_to?(:url)
+              options = {:previous_url => self.url}
+              if args[args.length].is_a?(Hash)
+                args[args.length].merge!(options)
+              else
+                args << options
+              end
             end
+            client = self
+            client = self.client if self.respond_to?(:client)
+            klass.new(client, *args)
+          end
+
+          define_method("#{name}!".to_sym) do |*args|
+            self.send(name, *args).call!
           end
-          klass.new(mod.get_client(self), *args)
-        end
-        define_method("#{name}!".to_sym) do |*args|
-          self.send(name, *args).call!
         end
       end
+
     end
+
   end
 end

data/lib/rapidash/version.rb

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

data/spec/rapidash/clientable_spec.rb

@@ -18,6 +18,11 @@ class HTTPClientExtensionTester < HTTPClientTester
   extension :json
 end
 
+class HTTPClientErrorTester < HTTPClientTester
+  raise_errors
+end
+
+
 class TestClientTester
   include Rapidash::Clientable
   method :test
@@ -74,4 +79,10 @@ describe Rapidash::Clientable do
     end
   end
 
+  describe "#raise_errors" do
+    it "should set the raise_error variable" do
+      HTTPClientErrorTester.new.class.instance_variable_get(:@raise_error).should eql(true)
+    end
+  end
+
 end

data/spec/rapidash/http_client_spec.rb

@@ -15,6 +15,12 @@ class HTTPExtensionTester < HTTPTester
   end
 end
 
+class HTTPErrorTester < HTTPTester
+  def self.raise_error
+    true
+  end
+end
+
 describe Rapidash::HTTPClient do
 
   let!(:subject) { HTTPTester.new }
@@ -57,37 +63,62 @@ describe Rapidash::HTTPClient do
 
     let!(:valid_response) { OpenStruct.new(:status => "200")}
     let!(:redirect_response) { OpenStruct.new(:status => "301", :headers => {"location" => "http://example.com/redirect"})}
+    let!(:error_response) { OpenStruct.new(:status => "404")}
 
     before(:each) do
       subject.site = "http://example.com"
-      Rapidash::Response.should_receive(:new).and_return("response")
     end
 
-    it "should add an extension if one is set" do
-      subject.extension = :json
-      subject.connection.should_receive(:run_request).with(:get, "http://example.com/foo.json", nil, nil).and_return(valid_response)
-      subject.request(:get, "foo")
-    end
+    describe "valid response" do
+
+      before(:each) do
+        Rapidash::Response.should_receive(:new).and_return("response")
+      end
+        
+      it "should add an extension if one is set" do
+        subject.extension = :json
+        subject.connection.should_receive(:run_request).with(:get, "http://example.com/foo.json", nil, nil).and_return(valid_response)
+        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")
+        response.should eql("response")
+      end
+
+      it "should perform a redirect" do
+        subject.connection.should_receive(:run_request).with(:get, "http://example.com/foo", nil, nil).and_return(redirect_response)
+        subject.connection.should_receive(:run_request).with(:get, "http://example.com/redirect", nil, nil).and_return(valid_response)
+        response = subject.request(:get, "foo")
+        response.should eql("response")
+      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
 
+    describe "error response" do
+      
+      it "should not raise an error by default" do
+          subject.connection.should_receive(:run_request).with(:get, "http://example.com/error", nil, nil).and_return(error_response)
+          response = subject.request(:get, "error")
+          response.should be_nil
+      end
+
+      it "should raise an error if the option is set" do
+          subject = HTTPErrorTester.new
+          subject.connection.should_receive(:run_request).with(:get, anything, nil, nil).and_return(error_response)
+          expect {
+            response = subject.request(:get, "error")
+          }.to raise_error(Rapidash::ResponseError)
+      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")
-      response.should eql("response")
-    end
-
-    it "should perform a redirect" do
-      subject.connection.should_receive(:run_request).with(:get, "http://example.com/foo", nil, nil).and_return(redirect_response)
-      subject.connection.should_receive(:run_request).with(:get, "http://example.com/redirect", nil, nil).and_return(valid_response)
-      response = subject.request(:get, "foo")
-      response.should eql("response")
     end
   end
-
 end

data/spec/rapidash/oauth_client_spec.rb

@@ -10,16 +10,26 @@ class OAuthExtensionTester < OAuthTester
   end
 end
 
+class OAuthErrorTester < OAuthTester
+  def self.raise_error
+    true
+  end
+end
+
 describe Rapidash::OAuthClient do
 
-  let(:options) do
+  before(:each) do
+    Rapidash::Response.stub(:new).and_return(Hashie::Mash.new)
+  end
+
+  let(:options) {
     {
       :uid => "foo",
       :secret => "bar",
       :access_token => "baz",
       :site => "http://example.com"
     }
- end 
+  }
 
  let(:subject) { OAuthTester.new(options) }
 
@@ -59,13 +69,10 @@ describe Rapidash::OAuthClient do
 
     describe "object returned from API call" do
 
-      let(:body) { {:foo => "bar"}.to_json }
-      let(:response) { OpenStruct.new(:body => body) }
-
       before(:each) do
         subject.extension = :json
         subject.stub(:oauth_access_token).and_return(request)
-        request.stub(:get).and_return(response)
+        request.stub(:get)
       end
 
       it "should add an extension to the url if one is set" do
@@ -76,7 +83,7 @@ describe Rapidash::OAuthClient do
       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.stub(:get)
         request.should_receive(:get).with("http://example.com/me.json", anything)
         subject.request(:get, "me")
       end
@@ -86,31 +93,16 @@ describe Rapidash::OAuthClient do
         subject.request(:get, "me").class.should eql(Hashie::Mash)
       end
 
-      it "should return a traversable object" do
-        subject.request(:get, "me").foo.should eql("bar")
-      end
-
     end
 
-    describe "array returned from API call" do
-
-      let(:body) { [{:foo => "bar"}, {:baz => "bra"}].to_json }
-      let(:response) { OpenStruct.new(:body => body) }
-
-      before(:each) do
+    describe "when errors are set" do
+      it "should call oauth_access_token.send with errors set" do
+        subject = OAuthErrorTester.new(options)
         subject.stub(:oauth_access_token).and_return(request)
-        request.stub(:get).and_return(response)
-      end
-      it "should return an array" do
-        subject.request(:get, "me").class.should eql(Array)
+        request.should_receive(:send).with(:get, "http://example.com/error", {:raise_errors => true})
+        subject.request(:get, "error")
       end
-
-      it "should return a traversable object" do
-        response = subject.request(:get, "me")
-        response[0].foo.should eql("bar")
-        response[1].baz.should eql("bra")
-      end
-
+      
     end
   end
 

data/spec/rapidash/resourceable_spec.rb

@@ -28,6 +28,11 @@ class Rapidash::ClientTester
   resource :users
 end
 
+class Rapidash::MultiResourceTester
+  include Rapidash::Resourceable
+  resource :users, :repos
+end
+
 class ClientTester
   include Rapidash::Resourceable
   resource :users
@@ -50,6 +55,11 @@ describe Rapidash::Resourceable do
     it "should add a bang method with the name of the argument" do
       Rapidash::ClientTester.new.methods.map { |m| m.to_sym }.should include(:users!)
     end
+
+    it "should add a method for each resource is an array is passed" do
+      methods = Rapidash::MultiResourceTester.new.methods.map { |m| m.to_sym }
+      (methods & [:users, :users!, :repos, :repos!]).length.should eql(4)
+    end
   end
 
   describe ".users" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rapidash
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Gary 'Gazler' Rennie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-10 00:00:00.000000000 Z
+date: 2013-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -122,6 +122,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- examples/github.rb
 - lib/rapidash.rb
 - lib/rapidash/base.rb
 - lib/rapidash/client.rb