api-client 2.2.0 → 2.3.0

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # CHANGELOG
 
+## v2.3.0
+
+* Add support to global mock of requisitions for testing purposes.
+
+## v2.2.0
+
+* Add support global basic authentication.
+* Add support for gem Zertico
+
 ## v2.1.0
 
 * Add support for classes with compost names.
@@ -139,4 +148,4 @@
 ## v0.0.1
 
 * get method added.
-* handler for response code 404 added.
+* handler for response code 404 added.

data/README.md

@@ -122,6 +122,18 @@ This code will create a setter and a getter for houses and cars and initialize t
 Since version 2.0.0, it is possible to make api calls from the object. The syntax is pretty much the same.
 It will make the call and update the fields with the response. Look at the examples folder to see more code examples
 
+## Testing
+
+Set mock config variable as true inside yout spec_helper or test_helper:
+
+```ruby
+ApiClient.configure do |config|
+   config.mock = true
+end
+```
+
+With this setting no requisitions will be made. All calls will just return a new object with the attributes received.
+
 ## More Examples
 [Project](https://github.com/zertico/api-client/tree/master/examples)
 

data/lib/api-client.rb

@@ -14,7 +14,7 @@ module ApiClient
 
   # Configures global settings
   #   ApiClient.configure do |config|
-  #     config.url_path = "api.example.com"
+  #     config.path = "api.example.com"
   #   end
   def self.configure(&block)
     yield @config ||= ApiClient::Configuration.new
@@ -29,5 +29,6 @@ module ApiClient
   configure do |config|
     config.path = ''
     config.header = {}
+    config.mock = false
   end
 end

data/lib/api-client/class_methods.rb

@@ -17,6 +17,7 @@ module ApiClient
     # @param [Hash] header hash with the header options.
     # @return [Base] the object initialized.
     def get(id, header = {})
+      return build(:id => id) if ApiClient.config.mock
       url = "#{ApiClient.config.path}#{self.resource_path}/#{id}"
       response = ApiClient::Dispatcher.get(url, header)
       params = ApiClient::Parser.response(response, url)
@@ -31,6 +32,7 @@ module ApiClient
     # @param [Hash] header hash with the header options.
     # @return [Base] the object initialized.
     def post(attributes, header = {})
+      return build(attributes) if ApiClient.config.mock
       url = "#{ApiClient.config.path}#{self.resource_path}"
       response = ApiClient::Dispatcher.post(url, attributes, header)
       params = ApiClient::Parser.response(response, url)
@@ -46,6 +48,7 @@ module ApiClient
     # @param [Hash] header hash with the header options.
     # @return [Base] the object initialized.
     def put(attributes, header = {})
+      return build(attributes) if ApiClient.config.mock
       url = "#{ApiClient.config.path}#{self.resource_path}"
       response = ApiClient::Dispatcher.put(url, attributes, header)
       params = ApiClient::Parser.response(response, url)
@@ -61,6 +64,7 @@ module ApiClient
     # @param [Hash] header hash with the header options.
     # @return [Base] the object initialized.
     def patch(attributes, header = {})
+      return build(attributes) if ApiClient.config.mock
       url = "#{ApiClient.config.path}#{self.resource_path}"
       response = ApiClient::Dispatcher.patch(url, attributes, header)
       params = ApiClient::Parser.response(response, url)
@@ -73,6 +77,7 @@ module ApiClient
     # @param [Hash] header hash with the header options.
     # @return [Base] the object initialized.
     def delete(id, header = {})
+      return build(:id => id) if ApiClient.config.mock
       url = "#{ApiClient.config.path}#{self.resource_path}/#{id}"
       response = ApiClient::Dispatcher.delete(url, header)
       params = ApiClient::Parser.response(response, url)

data/lib/api-client/configuration.rb

@@ -1,6 +1,7 @@
 module ApiClient
   # ApiClient::Configuration provides a way to configure ApiClient globally.
   class Configuration
+    attr_accessor :mock
     attr_reader :header
 
     # Return the api url.

data/lib/api-client/instance_methods.rb

@@ -19,6 +19,7 @@ module ApiClient
     # @param [Hash] header hash with the header options.
     # @return [Base] the object updated.
     def get(header = {})
+      return update({}) if ApiClient.config.mock
       url = "#{ApiClient.config.path}#{self.class.resource_path}/#{id}"
       response = ApiClient::Dispatcher.get(url, header)
       attributes = ApiClient::Parser.response(response, url)
@@ -32,6 +33,7 @@ module ApiClient
     # @param [Hash] header hash with the header options.
     # @return [Base] the object updated.
     def post(header = {})
+      return update({}) if ApiClient.config.mock
       url = "#{ApiClient.config.path}#{self.class.resource_path}"
       response = ApiClient::Dispatcher.post(url, self.to_hash, header)
       attributes = ApiClient::Parser.response(response, url)
@@ -45,6 +47,7 @@ module ApiClient
     # @param [Hash] header hash with the header options.
     # @return [Base] the object updated.
     def put(header = {})
+      return update({}) if ApiClient.config.mock
       url = "#{ApiClient.config.path}#{self.class.resource_path}"
       response = ApiClient::Dispatcher.put(url, self.to_hash, header)
       attributes = ApiClient::Parser.response(response, url)
@@ -58,6 +61,7 @@ module ApiClient
     # @param [Hash] header hash with the header options.
     # @return [Base] the object updated.
     def patch(header = {})
+      return update({}) if ApiClient.config.mock
       url = "#{ApiClient.config.path}#{self.class.resource_path}"
       response = ApiClient::Dispatcher.patch(url, self.to_hash, header)
       attributes = ApiClient::Parser.response(response, url)
@@ -69,6 +73,7 @@ module ApiClient
     # @param [Hash] header hash with the header options.
     # @return [Base] the object updated.
     def delete(header = {})
+      return update({}) if ApiClient.config.mock
       url = "#{ApiClient.config.path}#{self.class.resource_path}/#{id}"
       response = ApiClient::Dispatcher.delete(url, header)
       attributes = ApiClient::Parser.response(response, url)

data/lib/api-client/version.rb

@@ -1,5 +1,5 @@
 # High Level Namespace of the library ApiClient.
 module ApiClient
   # Version of the library.
-  VERSION = '2.2.0'
+  VERSION = '2.3.0'
 end

data/spec/api-client.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe ApiClient do
+  context 'default settings' do
+    it 'should have a blank path' do
+      ApiClient.config.path.should == ''
+    end
+
+    it 'should have an empty header' do
+      ApiClient.config.header.should == {}
+    end
+
+    it 'should have mock equal false' do
+      ApiClient.config.mock.should be_false
+    end
+  end
+end

data/spec/api-client/class_methods_spec.rb

@@ -1,84 +1,154 @@
 require 'spec_helper'
 
 describe ApiClient::ClassMethods do
-  before :each do
-    stub_request(:any, 'http://api.example.com/users').to_return(:body => {'a' => 'b'}.to_json)
-    stub_request(:any, 'http://api.example.com/users/1').to_return(:body => {'a' => 'b'}.to_json)
-  end
+  context 'with mock equal false' do
+    before :each do
+      stub_request(:any, 'http://api.example.com/users').to_return(:body => {'a' => 'b'}.to_json)
+      stub_request(:any, 'http://api.example.com/users/1').to_return(:body => {'a' => 'b'}.to_json)
+    end
+
+    context '.build' do
+      context 'with a root node' do
+        it 'should return an user' do
+          User.build('user' => { 'a' => 'b'}).should be_an_instance_of(User)
+        end
+
+        it 'should set the response' do
+          User.build('user' => { 'a' => 'b'}).response.should == { 'user' => { 'a' => 'b' } }
+        end
+      end
+
+      context 'without a root node' do
+        it 'should return an user' do
+          User.build('a' => 'b').should be_an_instance_of(User)
+        end
+
+        it 'should set the response' do
+          User.build('a' => 'b').response.should == { 'a' => 'b' }
+        end
+      end
+    end
 
-  context '.build' do
-    context 'with a root node' do
+    context '.get' do
       it 'should return an user' do
-        User.build('user' => { 'a' => 'b'}).should be_an_instance_of(User)
+        User.get(1).should be_an_instance_of(User)
       end
+    end
 
-      it 'should set the response' do
-        User.build('user' => { 'a' => 'b'}).response.should == { 'user' => { 'a' => 'b' } }
+    context '.find' do
+      it 'should return an user' do
+        User.find(1).should be_an_instance_of(User)
       end
     end
 
-    context 'without a root node' do
+    context '.post' do
       it 'should return an user' do
-        User.build('a' => 'b').should be_an_instance_of(User)
+        User.post({}).should be_an_instance_of(User)
       end
+    end
 
-      it 'should set the response' do
-        User.build('a' => 'b').response.should == { 'a' => 'b' }
+    context '.create' do
+      it 'should return an user' do
+        User.create({}).should be_an_instance_of(User)
       end
     end
-  end
 
-  context '.get' do
-    it 'should return an user' do
-      User.get(1).should be_an_instance_of(User)
+    context '.put' do
+      it 'should return an user' do
+        User.put(1, {}).should be_an_instance_of(User)
+      end
     end
-  end
 
-  context '.find' do
-    it 'should return an user' do
-      User.find(1).should be_an_instance_of(User)
+    context '.update_attributes' do
+      it 'should return an user' do
+        User.update_attributes(1, {}).should be_an_instance_of(User)
+      end
     end
-  end
 
-  context '.post' do
-    it 'should return an user' do
-      User.post({}).should be_an_instance_of(User)
+    context '.patch' do
+      it 'should return an user' do
+        User.patch(1, {}).should be_an_instance_of(User)
+      end
     end
-  end
 
-  context '.create' do
-    it 'should return an user' do
-      User.create({}).should be_an_instance_of(User)
+    context '.delete' do
+      it 'should return an user' do
+        User.delete(1).should be_an_instance_of(User)
+      end
     end
-  end
 
-  context '.put' do
-    it 'should return an user' do
-      User.put(1, {}).should be_an_instance_of(User)
+    context '.destroy' do
+      it 'should return an user' do
+        User.destroy(1).should be_an_instance_of(User)
+      end
     end
   end
 
-  context '.update_attributes' do
-    it 'should return an user' do
-      User.update_attributes(1, {}).should be_an_instance_of(User)
+  context 'with mock equal true' do
+    before :each do
+      ApiClient.configure do |config|
+        config.mock = true
+      end
     end
-  end
 
-  context '.patch' do
-    it 'should return an user' do
-      User.patch(1, {}).should be_an_instance_of(User)
+    after :each do
+      ApiClient.configure do |config|
+        config.mock = false
+      end
     end
-  end
 
-  context '.delete' do
-    it 'should return an user' do
-      User.delete(1).should be_an_instance_of(User)
+    context '.get' do
+      it 'should return an user' do
+        User.get(1).should be_an_instance_of(User)
+      end
+    end
+
+    context '.find' do
+      it 'should return an user' do
+        User.find(1).should be_an_instance_of(User)
+      end
+    end
+
+    context '.post' do
+      it 'should return an user' do
+        User.post({}).should be_an_instance_of(User)
+      end
+    end
+
+    context '.create' do
+      it 'should return an user' do
+        User.create({}).should be_an_instance_of(User)
+      end
+    end
+
+    context '.put' do
+      it 'should return an user' do
+        User.put({}).should be_an_instance_of(User)
+      end
+    end
+
+    context '.update_attributes' do
+      it 'should return an user' do
+        User.update_attributes({}).should be_an_instance_of(User)
+      end
+    end
+
+    context '.patch' do
+      it 'should return an user' do
+        User.patch({}).should be_an_instance_of(User)
+      end
+    end
+
+    context '.delete' do
+      it 'should return an user' do
+        User.delete(1).should be_an_instance_of(User)
+      end
     end
-  end
 
-  context '.destroy' do
-    it 'should return an user' do
-      User.destroy(1).should be_an_instance_of(User)
+    context '.destroy' do
+      it 'should return an user' do
+        User.destroy(1).should be_an_instance_of(User)
+      end
     end
   end
 end

data/spec/api-client/instance_methods_spec.rb

@@ -2,85 +2,155 @@ require 'spec_helper'
 
 describe ApiClient::InstanceMethods do
   let(:user) { User.new(:id => 1) }
-  
-  before :each do
-    stub_request(:any, 'http://api.example.com/users').to_return(:body => {'a' => 'b'}.to_json)
-    stub_request(:any, 'http://api.example.com/users/1').to_return(:body => {'a' => 'b'}.to_json)
-  end
 
-  context '.update' do
-    context 'with a root node' do
-      it 'should update the object' do
-        user.update('user' => { 'a' => 'b'}).should be_an_instance_of(User)
+  context 'with mock equal false' do
+    before :each do
+      stub_request(:any, 'http://api.example.com/users').to_return(:body => {'a' => 'b'}.to_json)
+      stub_request(:any, 'http://api.example.com/users/1').to_return(:body => {'a' => 'b'}.to_json)
+    end
+
+    context '.update' do
+      context 'with a root node' do
+        it 'should update the object' do
+          user.update('user' => { 'a' => 'b'}).should be_an_instance_of(User)
+        end
+
+        it 'should set the response' do
+          user.update('user' => { 'a' => 'b'}).response.should == { 'user' => { 'a' => 'b' } }
+        end
       end
 
-      it 'should set the response' do
-        user.update('user' => { 'a' => 'b'}).response.should == { 'user' => { 'a' => 'b' } }
+      context 'without a root node' do
+        it 'should update the object' do
+          user.update('a' => 'b').should be_an_instance_of(User)
+        end
+
+        it 'should set the response' do
+          user.update('a' => 'b').response.should == { 'a' => 'b' }
+        end
       end
     end
 
-    context 'without a root node' do
-      it 'should update the object' do
-        user.update('a' => 'b').should be_an_instance_of(User)
+    context '.get' do
+      it 'should return an user' do
+        user.get.should be_an_instance_of(User)
       end
+    end
 
-      it 'should set the response' do
-        user.update('a' => 'b').response.should == { 'a' => 'b' }
+    context '.reload' do
+      it 'should return an user' do
+        user.reload.should be_an_instance_of(User)
       end
     end
-  end
 
-  context '.get' do
-    it 'should return an user' do
-      user.get.should be_an_instance_of(User)
+    context '.post' do
+      it 'should return an user' do
+        user.post.should be_an_instance_of(User)
+      end
     end
-  end
 
-  context '.reload' do
-    it 'should return an user' do
-      user.reload.should be_an_instance_of(User)
+    context '.create' do
+      it 'should return an user' do
+        user.create.should be_an_instance_of(User)
+      end
     end
-  end
 
-  context '.post' do
-    it 'should return an user' do
-      user.post.should be_an_instance_of(User)
+    context '.put' do
+      it 'should return an user' do
+        user.put.should be_an_instance_of(User)
+      end
     end
-  end
 
-  context '.create' do
-    it 'should return an user' do
-      user.create.should be_an_instance_of(User)
+    context '.update_attributes' do
+      it 'should return an user' do
+        user.update_attributes.should be_an_instance_of(User)
+      end
     end
-  end
 
-  context '.put' do
-    it 'should return an user' do
-      user.put.should be_an_instance_of(User)
+    context '.patch' do
+      it 'should return an user' do
+        user.patch.should be_an_instance_of(User)
+      end
     end
-  end
 
-  context '.update_attributes' do
-    it 'should return an user' do
-      user.update_attributes.should be_an_instance_of(User)
+    context '.delete' do
+      it 'should return an user' do
+        user.delete.should be_an_instance_of(User)
+      end
     end
-  end
 
-  context '.patch' do
-    it 'should return an user' do
-      user.patch.should be_an_instance_of(User)
+    context '.destroy' do
+      it 'should return an user' do
+        user.destroy.should be_an_instance_of(User)
+      end
     end
   end
 
-  context '.delete' do
-    it 'should return an user' do
-      user.delete.should be_an_instance_of(User)
+  context 'with mock equal true' do
+    before :each do
+      ApiClient.configure do |config|
+        config.mock = true
+      end
+    end
+
+    after :each do
+      ApiClient.configure do |config|
+        config.mock = false
+      end
     end
-  end
 
-  context '.destroy' do
-    it 'should return an user' do
-      user.destroy.should be_an_instance_of(User)
+    context '.get' do
+      it 'should return an user' do
+        user.get.should be_an_instance_of(User)
+      end
+    end
+
+    context '.reload' do
+      it 'should return an user' do
+        user.reload.should be_an_instance_of(User)
+      end
+    end
+
+    context '.post' do
+      it 'should return an user' do
+        user.post.should be_an_instance_of(User)
+      end
+    end
+
+    context '.create' do
+      it 'should return an user' do
+        user.create.should be_an_instance_of(User)
+      end
+    end
+
+    context '.put' do
+      it 'should return an user' do
+        user.put.should be_an_instance_of(User)
+      end
+    end
+
+    context '.update_attributes' do
+      it 'should return an user' do
+        user.update_attributes.should be_an_instance_of(User)
+      end
+    end
+
+    context '.patch' do
+      it 'should return an user' do
+        user.patch.should be_an_instance_of(User)
+      end
+    end
+
+    context '.delete' do
+      it 'should return an user' do
+        user.delete.should be_an_instance_of(User)
+      end
+    end
+
+    context '.destroy' do
+      it 'should return an user' do
+        user.destroy.should be_an_instance_of(User)
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: api-client
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-23 00:00:00.000000000 Z
+date: 2013-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -174,6 +174,7 @@ files:
 - lib/api-client/net/http.rb
 - lib/api-client/parser.rb
 - lib/api-client/version.rb
+- spec/api-client.rb
 - spec/api-client/base_spec.rb
 - spec/api-client/class_methods_spec.rb
 - spec/api-client/collection_spec.rb
@@ -197,7 +198,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3470123561334596428
+      hash: -2067654543697834646
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -206,7 +207,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3470123561334596428
+      hash: -2067654543697834646
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25
@@ -225,6 +226,7 @@ test_files:
 - examples/scripts/example.rb
 - gemfiles/Gemfile.net_http
 - gemfiles/Gemfile.typhoeus
+- spec/api-client.rb
 - spec/api-client/base_spec.rb
 - spec/api-client/class_methods_spec.rb
 - spec/api-client/collection_spec.rb