api-client 2.1.0 → 2.2.0

data/README.md

@@ -41,6 +41,19 @@ Or install it yourself as:
 
 ## Basic Usage
 
+Create an initializer:
+
+```ruby
+ApiClient.configure do |config|
+   # Api path
+   config.path = 'http://api.example.com'
+   # Default header
+   config.header = { 'param1' => '123329845729384759237592348712876817234'}
+   # Basic Auth
+   config.basic_auth('user', 'pass')
+end
+```
+
 Add this to your ApplicationController:
 
 ```ruby
@@ -109,12 +122,15 @@ 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
 
+## More Examples
+[Project](https://github.com/zertico/api-client/tree/master/examples)
+
 ## TODO
-   * Add support for parallel requests
-   * Add more Response Handlers
+* Add support for parallel requests
+* Add more Response Handlers
 
 ## Mantainers
-  [@plribeiro3000](https://github.com/plribeiro3000)
+[@plribeiro3000](https://github.com/plribeiro3000)
 
 
 ## Contributing
@@ -123,4 +139,4 @@ It will make the call and update the fields with the response. Look at the examp
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Added some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+5. Create new Pull Request

data/examples/config/initializers/api-client.rb

@@ -3,5 +3,7 @@ ApiClient.configure do |config|
   # Api path
   config.path = 'http://api.example.com'
   # Default header
-  config.header = { :token => '123329845729384759237592348712876817234'}
+  config.header = { 'param' => '123329845729384759237592348712876817234'}
+  # Basic Authentication
+  config.basic_auth('user', 'pass')
 end

data/gemfiles/Gemfile.net_http

@@ -1,3 +1,5 @@
 source :rubygems
 
+gem 'activesupport', '>= 3.0', '< 4'
+
 gemspec :path => '../'

data/gemfiles/Gemfile.typhoeus

@@ -2,4 +2,6 @@ source :rubygems
 
 gem 'typhoeus'
 
+gem 'activesupport', '>= 3.0', '< 4'
+
 gemspec :path => '../'

data/lib/api-client.rb

@@ -25,8 +25,9 @@ module ApiClient
     @config
   end
 
+  # Default Settings
   configure do |config|
     config.path = ''
-    config.header = { 'Content-Type' => 'application/json' }
+    config.header = {}
   end
 end

data/lib/api-client/base.rb

@@ -132,6 +132,10 @@ module ApiClient
       ApiClient::Collection.new(self, self.resource_path).collection
     end
 
+    class << self
+      alias_method :all, :collection
+    end
+
     # Set the hash of errors, making keys symbolic.
     #
     # @param [Hash] errs errors of the object.

data/lib/api-client/class_methods.rb

@@ -23,6 +23,8 @@ module ApiClient
       build(params)
     end
 
+    alias_method :find, :get
+
     # Make a post requisition and initialize an object with the response.
     #
     # @param [Hash] attributes hash with the attributes to send.
@@ -35,6 +37,8 @@ module ApiClient
       build(params)
     end
 
+    alias_method :create, :post
+
     # Make a put requisition and initialize an object with the response.
     #
     # @param [Integer] id id of the object.
@@ -48,6 +52,8 @@ module ApiClient
       build(params)
     end
 
+    alias_method :update_attributes, :put
+
     # Make a patch requisition and initialize an object with the response.
     #
     # @param [Integer] id id of the object.
@@ -73,6 +79,8 @@ module ApiClient
       build(params)
     end
 
+    alias_method :destroy, :delete
+
     # Removes the root node attribute if found.
     #
     # @param [Hash] attributes the hash with attributes.

data/lib/api-client/configuration.rb

@@ -1,6 +1,8 @@
 module ApiClient
   # ApiClient::Configuration provides a way to configure ApiClient globally.
   class Configuration
+    attr_reader :header
+
     # Return the api url.
     #
     # @return [String] the api url.
@@ -17,19 +19,18 @@ module ApiClient
       @path = path
     end
 
-    # Return the default header for requisitions.
+    # Set the default params of header.
     #
-    # @return [Hash] the default header.
-    def header
-      return { 'Content-Type' => 'application/json' } unless @header
-      @header
+    # @param [Hash] header the default header for requisitions.
+    def header=(header = {})
+      @header = { 'Content-Type' => 'application/json' }.merge(header)
     end
 
-    # Set the default header for requisitions.
+    # Set a basic authentication for all requisitions.
     #
-    # @param [Hash] header the default header for requitions.
-    def header=(header = {})
-      @header = { 'Content-Type' => 'application/json' }.merge(header)
+    # @param [Hash] header the default header for requisitions.
+    def basic_auth(account, password)
+      @header.merge!({ 'Authorization' => "Basic #{["#{account}:#{password}"].pack('m').delete("\r\n")}" })
     end
   end
 end

data/lib/api-client/instance_methods.rb

@@ -5,7 +5,7 @@ module ApiClient
     #
     # @param [Hash] attributes hash of attributes.
     # @return [Base] the update_attributes object.
-    def update_attributes(attributes)
+    def update(attributes)
       hash = remove_root(attributes)
       hash = hash.merge({ 'response' => attributes })
       hash.each do |key, value|
@@ -22,9 +22,11 @@ module ApiClient
       url = "#{ApiClient.config.path}#{self.class.resource_path}/#{id}"
       response = ApiClient::Dispatcher.get(url, header)
       attributes = ApiClient::Parser.response(response, url)
-      update_attributes(attributes)
+      update(attributes)
     end
 
+    alias_method :reload, :get
+
     # Make a post requisition and update the object with the response.
     #
     # @param [Hash] header hash with the header options.
@@ -33,9 +35,11 @@ module ApiClient
       url = "#{ApiClient.config.path}#{self.class.resource_path}"
       response = ApiClient::Dispatcher.post(url, self.to_hash, header)
       attributes = ApiClient::Parser.response(response, url)
-      update_attributes(attributes)
+      update(attributes)
     end
 
+    alias_method :create, :post
+
     # Make a put requisition and update the object with the response.
     #
     # @param [Hash] header hash with the header options.
@@ -44,9 +48,11 @@ module ApiClient
       url = "#{ApiClient.config.path}#{self.class.resource_path}"
       response = ApiClient::Dispatcher.put(url, self.to_hash, header)
       attributes = ApiClient::Parser.response(response, url)
-      update_attributes(attributes)
+      update(attributes)
     end
 
+    alias_method :update_attributes, :put
+
     # Make a patch requisition and update the object with the response.
     #
     # @param [Hash] header hash with the header options.
@@ -55,7 +61,7 @@ module ApiClient
       url = "#{ApiClient.config.path}#{self.class.resource_path}"
       response = ApiClient::Dispatcher.patch(url, self.to_hash, header)
       attributes = ApiClient::Parser.response(response, url)
-      update_attributes(attributes)
+      update(attributes)
     end
 
     # Make a delete requisition and update the object with the response.
@@ -66,9 +72,11 @@ module ApiClient
       url = "#{ApiClient.config.path}#{self.class.resource_path}/#{id}"
       response = ApiClient::Dispatcher.delete(url, header)
       attributes = ApiClient::Parser.response(response, url)
-      update_attributes(attributes)
+      update(attributes)
     end
 
+    alias_method :destroy, :delete
+
     # Removes the root node attribute if found.
     #
     # @param [Hash] attributes the hash with attributes.

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.1.0'
+  VERSION = '2.2.0'
 end

data/spec/api-client/class_methods_spec.rb

@@ -8,7 +8,7 @@ describe ApiClient::ClassMethods do
 
   context '.build' do
     context 'with a root node' do
-      it 'should return a new object' do
+      it 'should return an user' do
         User.build('user' => { 'a' => 'b'}).should be_an_instance_of(User)
       end
 
@@ -18,7 +18,7 @@ describe ApiClient::ClassMethods do
     end
 
     context 'without a root node' do
-      it 'should return a new object' do
+      it 'should return an user' do
         User.build('a' => 'b').should be_an_instance_of(User)
       end
 
@@ -29,32 +29,56 @@ describe ApiClient::ClassMethods do
   end
 
   context '.get' do
-    it 'should return a new object' 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 a new object' 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 a new object' do
+    it 'should return an user' do
       User.put(1, {}).should be_an_instance_of(User)
     end
   end
 
+  context '.update_attributes' do
+    it 'should return an user' do
+      User.update_attributes(1, {}).should be_an_instance_of(User)
+    end
+  end
+
   context '.patch' do
-    it 'should return a new object' do
+    it 'should return an user' do
       User.patch(1, {}).should be_an_instance_of(User)
     end
   end
 
   context '.delete' do
-    it 'should return a new object' do
+    it 'should return an user' do
       User.delete(1).should be_an_instance_of(User)
     end
   end
+
+  context '.destroy' do
+    it 'should return an user' do
+      User.destroy(1).should be_an_instance_of(User)
+    end
+  end
 end

data/spec/api-client/configuration_spec.rb

@@ -78,4 +78,23 @@ describe ApiClient::Configuration do
       ApiClient.config.header.should == { 'Content-Type' => 'application/xml' }
     end
   end
+
+  describe '#basic_auth=' do
+    before :each do
+      ApiClient.configure do |config|
+        config.basic_auth('user', 'pass')
+      end
+    end
+
+    after :each do
+      ApiClient.configure do |config|
+        config.header = {}
+      end
+    end
+
+    it 'should merge basic_auth in header params' do
+      ApiClient.config.header.should == { 'Content-Type' => 'application/xml',
+                                          'Authorization' => 'Basic dXNlcjpwYXNz' }
+    end
+  end
 end

data/spec/api-client/instance_methods_spec.rb

@@ -8,55 +8,79 @@ describe ApiClient::InstanceMethods do
     stub_request(:any, 'http://api.example.com/users/1').to_return(:body => {'a' => 'b'}.to_json)
   end
 
-  context '.update_attributes' do
+  context '.update' do
     context 'with a root node' do
       it 'should update the object' do
-        user.update_attributes('user' => { 'a' => 'b'}).should be_an_instance_of(User)
+        user.update('user' => { 'a' => 'b'}).should be_an_instance_of(User)
       end
 
       it 'should set the response' do
-        user.update_attributes('user' => { 'a' => 'b'}).response.should == { 'user' => { 'a' => 'b' } }
+        user.update('user' => { 'a' => 'b'}).response.should == { 'user' => { 'a' => 'b' } }
       end
     end
 
     context 'without a root node' do
       it 'should update the object' do
-        user.update_attributes('a' => 'b').should be_an_instance_of(User)
+        user.update('a' => 'b').should be_an_instance_of(User)
       end
 
       it 'should set the response' do
-        user.update_attributes('a' => 'b').response.should == { 'a' => 'b' }
+        user.update('a' => 'b').response.should == { 'a' => 'b' }
       end
     end
   end
 
   context '.get' do
-    it 'should return a new object' 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 a new object' 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 a new object' 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 a new object' do
+    it 'should return an user' do
       user.patch.should be_an_instance_of(User)
     end
   end
 
   context '.delete' do
-    it 'should return a new object' 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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: api-client
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-17 00:00:00.000000000 Z
+date: 2013-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -197,7 +197,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3129970379733886747
+      hash: 3470123561334596428
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -206,7 +206,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3129970379733886747
+      hash: 3470123561334596428
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25