rapidash 0.1.2 → 0.2.0

data/spec/rapidash/resourceable_spec.rb

@@ -1,6 +1,6 @@
 require "spec_helper"
 
-class Rapidash::Repos
+class Rapidash::Repo
   attr_accessor :client, :args
   def initialize(client, *args)
     @client = client
@@ -8,7 +8,7 @@ class Rapidash::Repos
   end
 end
 
-class Rapidash::Users
+class Rapidash::User
   include Rapidash::Resourceable
   attr_accessor :client, :url
   resource :repos
@@ -18,11 +18,22 @@ class Rapidash::Users
   end
 end
 
-class Users 
+class User
   def initialize(*args)
   end
 end
 
+class AdminUser
+  def initialize(*args)
+  end
+end
+
+class CoreMembers
+  def initialize(*args)
+  end
+end
+
+
 class Rapidash::ClientTester
   include Rapidash::Resourceable
   resource :users
@@ -47,11 +58,82 @@ describe Rapidash::Resourceable do
 
   end
 
+
+  describe "instance methods" do
+    let(:client) { ClientTester.new }
+
+    describe ".resource" do
+
+
+      it "should create a Rapidash::Base" do
+        client.resource(:users, 1).class.should eql(Rapidash::Base)
+      end
+
+      it "should set the url to the resource name" do
+        resource = client.resource(:users)
+        resource.url.should eql("users")
+      end
+
+      it "should pass the id through if specified" do
+        resource = client.resource(:users, 1)
+        resource.url.should eql("users/1")
+      end
+
+      it "should pass the previous url through" do
+        def client.url
+          "base"
+        end
+        resource = client.resource(:users, 1)
+        resource.url.should eql("base/users/1")
+      end
+
+      it "should pass the client through" do
+        resource = client.resource(:users, 1)
+        resource.client.should eql(client)
+      end
+
+      it "should allow an explicit url to be sent" do
+        resource = client.resource(:users, 1, :url => "people")
+        resource.url.should eql("people/1")
+      end
+
+      it "should be chainable" do
+        resource = client.resource(:users, 1).resource(:comments, 2)
+        resource.url.should eql("users/1/comments/2")
+        resource.client.should eql(client)
+      end
+    end
+
+    describe ".resource!" do
+      it "should call the call! method on a resource" do
+        resource = mock
+        Rapidash::Base.stub(:new).and_return(resource)
+        resource.should_receive(:call!)
+        client.resource!(:users, 1)
+      end
+    end
+  end
+
   describe "#resource" do
     it "should add a method with the name of the argument" do
       Rapidash::ClientTester.new.methods.map { |m| m.to_sym }.should include(:users)
     end
 
+    it "should not fail when presented with a multi-word resource" do
+      expect { 
+        class ClientTester
+          resource :admin_users
+        end
+      }.to_not raise_error(NameError)
+    end
+
+    it "should load the plural class with a warning if the singular is not defined" do
+      Kernel.should_receive(:warn).with("[DEPRECATED] - RAPIDASH WARNING using CoreMembers instead of CoreMember - please either use `CoreMember` or set the class name with `resource core_members, :class_name => CoreMembers` implicit plural naming will be deprecated in Rapidash 1.0")
+      class ClientTester
+        resource :core_members
+      end
+    end
+
     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
@@ -64,18 +146,18 @@ describe Rapidash::Resourceable do
 
   describe ".users" do
     it "should return an instance of the resource" do
-      Rapidash::ClientTester.new.users.class.should eql(Rapidash::Users)
+      Rapidash::ClientTester.new.users.class.should eql(Rapidash::User)
     end
 
     it "should not use a namespace if not in a module" do
-      ClientTester.new.users.class.should eql(Users)
+      ClientTester.new.users.class.should eql(User)
     end
   end
 
   describe ".tickets!" do
     it "should return an instance of the resource and call it" do
       users = mock
-      Rapidash::Users.should_receive(:new).and_return(users)
+      Rapidash::User.should_receive(:new).and_return(users)
       users.should_receive(:call!)
       Rapidash::ClientTester.new.users!
     end
@@ -84,22 +166,71 @@ describe Rapidash::Resourceable do
   describe "chaining resources" do
     it "should allow resources to be nested" do
       client = mock
-      users = Rapidash::Users.new(client)
+      users = Rapidash::User.new(client)
       users.methods.map { |m| m.to_sym }.should include(:repos)
       users.methods.map { |m| m.to_sym }.should include(:repos!)
     end
 
     it "should maintain the client across resources " do
       client = mock
-      users = Rapidash::Users.new(client)
+      users = Rapidash::User.new(client)
       users.repos.instance_variable_get(:@client).should eql(client)
     end
 
     it "should maintain the URL when chaining" do
       client = mock
-      users = Rapidash::Users.new(client)
+      users = Rapidash::User.new(client)
       users.repos.instance_variable_get(:@args)[0].keys.should include(:previous_url)
     end
+
+    it "should maintain the URL as well as the options when chaining" do
+      client = mock
+      users = Rapidash::User.new(client)
+      repos = users.repos(:params => {:foo => :bar})
+      repos.instance_variable_get(:@args)[0].should include(:params)
+      repos.instance_variable_get(:@args)[0].should include(:previous_url)
+    end
   end
 
+  describe "resource with module" do
+    module Facebook
+      class User
+        def initialize(*args)
+        end
+      end
+
+      class Posts
+        def initialize(*args)
+        end
+      end
+    end
+
+    module Its
+      module A
+        class DeepResource
+          def initialize(*args)
+          end
+        end
+      end
+    end
+
+    class ModuleTester
+      include Rapidash::Resourceable
+      resource :users, :class_name => "Facebook::User"
+      resource :posts, :class_name => Facebook::Posts
+      resource :deep_resources, :class_name => Its::A::DeepResource
+    end
+
+    it "should find user in another module" do
+      ModuleTester.new.users.class.should eql(Facebook::User)
+    end
+
+    it "should allow a plural class name" do
+      ModuleTester.new.posts.class.should eql(Facebook::Posts)
+    end
+
+    it "should find deep_resource in a nested module" do
+      ModuleTester.new.deep_resources.class.should eql(Its::A::DeepResource)
+    end
+  end
 end

data/spec/rapidash/response_spec.rb

@@ -31,6 +31,26 @@ def valid_js_response_object
   })
 end
 
+def valid_null_response_object
+  body = nil.to_json
+  OpenStruct.new({
+    :headers => {
+      "content-type" => "application/json"
+    },
+    :body => body
+  })
+end
+
+def valid_empty_response_object
+  body = ""
+  OpenStruct.new({
+    :headers => {
+      "content-type" => "application/json"
+    },
+    :body => body
+  })
+end
+
 
 def valid_response_array
   body = [{"foo" => "bar" }, {"baz" => "bra"}].to_json
@@ -85,6 +105,17 @@ describe Rapidash::Response do
       response.foo.should eql("bar")
     end        
 
+    it "should parse a JSON null" do
+      response = Rapidash::Response.new(valid_null_response_object)
+      response.should eql(nil)
+    end
+
+    it "should parse an empty body" do
+      response = Rapidash::Response.new(valid_empty_response_object)
+      response.should eql(nil)
+    end
+
+
     it "should parse JSON Arrays" do
       response = Rapidash::Response.new(valid_response_array)
       response[0].foo.should eql("bar")

data/spec/rapidash/urlable_spec.rb

@@ -28,7 +28,7 @@ describe Rapidash::Urlable do
 
   describe "#url" do
     it "should override the initialize to set a url" do
-      ApiTesterNoUrl.new.instance_variable_get(:@url).should eql("apitesternourl")
+      ApiTesterNoUrl.new.instance_variable_get(:@url).should eql("apitesternourls")
       ApiTester.new.instance_variable_get(:@url).should eql("foo")
     end
 

data/spec/spec_helper.rb

@@ -1,2 +1,5 @@
-require "./lib/rapidash"
+require "simplecov"
+SimpleCov.start
+
+require "rapidash"
 require "ostruct"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rapidash
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Gary 'Gazler' Rennie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-22 00:00:00.000000000 Z
+date: 2013-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +122,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Evolve your API
 email:
 - gazler@gmail.com
@@ -126,7 +154,6 @@ files:
 - lib/rapidash.rb
 - lib/rapidash/base.rb
 - lib/rapidash/client.rb
-- lib/rapidash/clientable.rb
 - lib/rapidash/errors.rb
 - lib/rapidash/http_client.rb
 - lib/rapidash/oauth_client.rb
@@ -138,7 +165,6 @@ files:
 - rapidash.gemspec
 - spec/rapidash/base_spec.rb
 - spec/rapidash/client_spec.rb
-- spec/rapidash/clientable_spec.rb
 - spec/rapidash/http_client_spec.rb
 - spec/rapidash/integration/test_client_spec.rb
 - spec/rapidash/oauth_client_spec.rb
@@ -167,14 +193,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.0
+rubygems_version: 2.0.2
 signing_key: 
 specification_version: 4
 summary: An opinionated core for creating clients for RESTful APIs quickly
 test_files:
 - spec/rapidash/base_spec.rb
 - spec/rapidash/client_spec.rb
-- spec/rapidash/clientable_spec.rb
 - spec/rapidash/http_client_spec.rb
 - spec/rapidash/integration/test_client_spec.rb
 - spec/rapidash/oauth_client_spec.rb

data/lib/rapidash/clientable.rb

@@ -1,35 +0,0 @@
-module Rapidash
-  module Clientable
-
-    def self.included(base)
-      base.extend ClassMethods
-    end
-
-    module ClassMethods
-
-      attr_accessor :patch, :url_extension, :raise_error
-
-      def method(method)
-        case method
-        when :http then include HTTPClient
-        when :oauth then include OAuthClient
-        when :test then include TestClient
-        else
-          raise ConfigurationError.new "Invalid API Authentication Method"
-        end
-      end
-
-      def use_patch
-        @patch = true
-      end
-
-      def extension(extension)
-        @url_extension = extension
-      end
-
-      def raise_errors
-        @raise_error = true
-      end
-    end
-  end
-end

data/spec/rapidash/clientable_spec.rb

@@ -1,88 +0,0 @@
-require "spec_helper"
-
-class OAuthClientTester
-  include Rapidash::Clientable
-  method :oauth
-end
-
-class HTTPClientTester
-  include Rapidash::Clientable
-  method :http
-end
-
-class HTTPClientPatchTester < HTTPClientTester
-  use_patch
-end
-
-class HTTPClientExtensionTester < HTTPClientTester
-  extension :json
-end
-
-class HTTPClientErrorTester < HTTPClientTester
-  raise_errors
-end
-
-
-class TestClientTester
-  include Rapidash::Clientable
-  method :test
-end
-
-
-
-
-describe Rapidash::Clientable do
-
-  describe "#included" do
-    it "should include the method method" do
-      HTTPClientTester.methods.map { |m| m.to_sym }.should include(:method)
-    end
-  end
-
-  describe "#method" do
-
-    it "should include the HTTPClient" do
-      client = HTTPClientTester.new
-      client.class.ancestors.should include(Rapidash::HTTPClient)
-    end
-
-    it "should include the OAuthClient" do
-      client = OAuthClientTester.new({:uid => "foo", :secret => "bar", :site => "baz"})
-      client.class.ancestors.should include(Rapidash::OAuthClient)
-    end
-
-    it "should include the OAuthClient" do
-      client = TestClientTester.new
-      client.class.ancestors.should include(Rapidash::TestClient)
-    end
-
-    it "should raise an error on anything else" do
-      expect {
-        class InvalidClientTester
-          include Rapidash::Clientable
-          method :invalid
-        end
-      }.to raise_error(Rapidash::ConfigurationError)
-    end
-    
-  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
-
-  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