api-client 2.6.0 → 2.7.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 44c8775d6a585af08c1ac80b3263e77f4922983d
+  data.tar.gz: 5be3312583e04df381e4a3c537515cf843b4a925
+SHA512:
+  metadata.gz: 14583a5cabbfe1fa3a2eb56c9bb96c39343e19fcecaf224a15dac5f3babbfa7a584c57899db1f2b9e8241a6970a2e3adfb368a3919c11f1fa3e2d29066185904
+  data.tar.gz: 7f42c5147782929e1c0b4972b421fb12cbc599f0044cd2a943ca165bbb9953ecd4c816ba6bf972a9d32028d40cb860c72b63954319822ff1719bd69a94334ea2

data/.ruby-version

@@ -1 +1 @@
-ruby-1.9.3-p429
+ruby-2.0.0

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # CHANGELOG
 
+## v2.7.0
+
+* Fixed update routes to add resource id.
+
+## v2.6.0
+
+* Add support for pagination attributes.
+
 ## v2.5.0
 
 * Add support for parallel requests. Yay! =)

data/README.md

@@ -39,6 +39,8 @@ Or install it yourself as:
 
     $ gem install api-client
 
+If you will use Typhoeus (https://github.com/typhoeus/typhoeus), you must have Typhoeus version above 0.5.0.
+
 ## Basic Usage
 
 Create an initializer:
@@ -136,6 +138,26 @@ end
 
 This code will create a setter and a getter for houses and cars and initialize the respective class.
 
+When you are working with collections you can use api pagination according Hal Specification (http://stateless.co/hal_specification.html) .
+You just need to pass a hash as:
+
+```ruby
+{
+  total: 10,
+  total_pages: 1,
+  offset: 10,
+  _links: {
+    first: { href: "/api/clients" },
+    previous: null,
+    self: { href: "/api/clients" },
+    next: null,
+    last: { href: "/api/clients?page=1" }
+  },
+  users: [ { user: { name: "example1" } }, { user: { name: "example2" } } ]
+}
+```
+
+
 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
 

data/examples/controllers/book_controller.rb

@@ -27,7 +27,7 @@ class BookController < ApplicationController
 
   # It will hit http://api.example.com/books with a put request
   def update
-    @book = Book.update_attributes({ :book => params[:book] })
+    @book = Book.update_attributes(params[:id], { :book => params[:book] })
     respond_with(@book)
   end
 

data/examples/controllers/user_controller.rb

@@ -27,7 +27,7 @@ class UserController < ApplicationController
 
   # It will hit http://api.example.com/users with a patch request
   def update
-    @user = User.patch({ :user => params[:user] })
+    @user = User.patch(params[:id], { :user => params[:user] })
     respond_with(@user)
   end
 

data/lib/api-client/class_methods.rb

@@ -34,9 +34,9 @@ module ApiClient
     # @param [Hash] attributes hash with the attributes to send.
     # @param [Hash] header hash with the header options.
     # @return [Base] the object initialized.
-    def put(attributes, header = {})
+    def put(id, attributes, header = {})
       return new(attributes) if ApiClient.config.mock
-      url = "#{ApiClient.config.path[path]}#{self.resource_path}"
+      url = "#{ApiClient.config.path[path]}#{self.resource_path}/#{id}"
       response = ApiClient::Dispatcher.put(url, attributes, header)
       build(response, url)
     end
@@ -48,9 +48,9 @@ module ApiClient
     # @param [Hash] attributes hash with the attributes to send.
     # @param [Hash] header hash with the header options.
     # @return [Base] the object initialized.
-    def patch(attributes, header = {})
+    def patch(id, attributes, header = {})
       return new(attributes) if ApiClient.config.mock
-      url = "#{ApiClient.config.path[path]}#{self.resource_path}"
+      url = "#{ApiClient.config.path[path]}#{self.resource_path}/#{id}"
       response = ApiClient::Dispatcher.patch(url, attributes, header)
       build(response, url)
     end

data/lib/api-client/instance_methods.rb

@@ -33,7 +33,7 @@ module ApiClient
     # @return [Base] the object updated.
     def put(header = {})
       return self if ApiClient.config.mock
-      url = "#{ApiClient.config.path[path]}#{self.class.resource_path}"
+      url = "#{ApiClient.config.path[path]}#{self.class.resource_path}/#{id}"
       response = ApiClient::Dispatcher.put(url, self.to_hash, header)
       update(response, url)
     end
@@ -46,7 +46,7 @@ module ApiClient
     # @return [Base] the object updated.
     def patch(header = {})
       return self if ApiClient.config.mock
-      url = "#{ApiClient.config.path[path]}#{self.class.resource_path}"
+      url = "#{ApiClient.config.path[path]}#{self.class.resource_path}/#{id}"
       response = ApiClient::Dispatcher.patch(url, self.to_hash, header)
       update(response, url)
     end

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.6.0'
-end
+  VERSION = '2.7.0'
+end

data/spec/api-client/class_methods_spec.rb

@@ -33,19 +33,19 @@ describe ApiClient::ClassMethods do
 
     context '.put' do
       it 'should return an user' do
-        User.put({}).should be_an_instance_of(User)
+        User.put(1, {}).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)
+        User.update_attributes(1, {}).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)
+        User.patch(1, {}).should be_an_instance_of(User)
       end
     end
 
@@ -101,19 +101,19 @@ describe ApiClient::ClassMethods do
 
     context '.put' do
       it 'should return an user' do
-        User.put({}).should be_an_instance_of(User)
+        User.put(1, {}).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)
+        User.update_attributes(1, {}).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)
+        User.patch(1, {}).should be_an_instance_of(User)
       end
     end
 

metadata

@@ -1,126 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: api-client
 version: !ruby/object:Gem::Version
-  version: 2.6.0
-  prerelease: 
+  version: 2.7.0
 platform: ruby
 authors:
 - Paulo Henrique Lopes Ribeiro
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-06 00:00:00.000000000 Z
+date: 2014-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: json_pure
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: 
@@ -192,33 +177,26 @@ files:
 homepage: 
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 2568135155809841734
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 2568135155809841734
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.1.11
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Api client easy to play with parallelism support!
 test_files:
 - examples/config/initializers/api-client.rb