api-client 2.0.2 → 2.0.3

data/CHANGELOG.md

@@ -1,10 +1,34 @@
 # CHANGELOG
 
+## v2.0.3
+
+* Fix put and patch requisitions.
+
+## v2.0.2
+
+* Changed to_hash method behavior to return a root node.
+* Fix instance requisitions by send a root node.
+
+## v2.0.1
+
+* Removed trailing slash from post requisitions.
+
+## v2.0.0
+
+* Fix typhoeus requisitions by changing params method to body.
+* Add Support to configure header globally.
+* Improved readability by changing methods names.
+
+## v2.0.0.rc2
+
+* Fix initialization with root nodes for nested objects.
+* Add Support for object initialization with strings as keys.
+
 ## v2.0.0.rc1
 
 * Add Support for global url.
 * Add Support for instance requests.
-* Changed behavior of request methods to only accepts the resource id if needed..
+* Changed behavior of request methods to only accepts the resource id if needed.
 
 ## v1.10.0
 

data/README.md

@@ -84,7 +84,15 @@ In Some cases, that is not the required behavior. To Redefine it, use remote_obj
 
 ```ruby
 class Admin < ApiClient::Base
-    self.remote_object = "user"
+    self.root_node = 'user'
+end
+```
+
+To specify a resource path different from the expected, you can overwrite the behavior by setting resouce_path:
+
+```ruby
+class Admin < ApiClient::Base
+    self.resource_path = 'users?type=admin'
 end
 ```
 
@@ -98,6 +106,9 @@ end
 
 This code will create a setter and a getter for houses and cars and initialize the respective class.
 
+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
+
 ## TODO
    * Add support for parallel requests
    * Add more Response Handlers
@@ -112,4 +123,4 @@ This code will create a setter and a getter for houses and cars and initialize t
 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

@@ -1,5 +1,7 @@
 # Global Configuration
-# Api path
 ApiClient.configure do |config|
+  # Api path
   config.path = 'http://api.example.com'
+  # Default header
+  config.header = { :token => '123329845729384759237592348712876817234'}
 end

data/examples/controllers/user_controller.rb

@@ -15,7 +15,7 @@ class UserController < ApplicationController
 
   # It will hit http://api.example.com/users with a post request
   def create
-    @user = User.post('', :user => params[:user])
+    @user = User.post(:user => params[:user])
     respond_with(@user)
   end
 

data/examples/models/admin.rb

@@ -1,9 +1,9 @@
 class Admin < ApiClient::Base
-  self.remote_object = 'user'
+  self.resource_path = 'users?type=admin'
   self.association = { :groups => 'Group' }
 
   # Any of this fields can be called to manage rails form.
-  attr_accessor :id, :email, :password, :password_confirmation
+  attr_accessor :email, :password, :password_confirmation
 
   # Validations will work as well
   validates :email, :presence => true, :uniqueness => true

data/examples/models/author.rb

@@ -0,0 +1,3 @@
+class Author < ApiClient::Base
+  attr_accessor :name
+end

data/examples/models/book.rb

@@ -0,0 +1,5 @@
+class Book < ApiClient::Base
+  self.association = { :author => 'Author' }
+
+  attr_accessor :name, :author_id, :publish_date
+end

data/examples/models/group.rb

@@ -1,3 +1,4 @@
 class Group < ApiClient::Base
   self.associations = { :members => 'User', :owner => 'Admin' }
+  self.root_node = 'people'
 end

data/examples/models/user.rb

@@ -1,8 +1,8 @@
 class User < ApiClient::Base
-  self.association = { :groups => 'Group' }
+  self.associations = { :groups => 'Group', :books => 'Book' }
 
   # Any of this fields can be called to manage rails form.
-  attr_accessor :id, :email, :password, :password_confirmation
+  attr_accessor :email, :password, :password_confirmation, :type
 
   # Validations will work as well
   validates :email, :presence => true, :uniqueness => true

data/examples/scripts/example.rb

@@ -0,0 +1,42 @@
+require 'api-client'
+
+# Make a get requisition to http://api.example.com/users and initialize an user object for each user returned
+users = User.collection
+
+# Get the first user
+user = users.first
+
+# Set the attribute type to 'admin'
+user.type = 'admin'
+
+# Make a put requisition to http://api.example.com/users/:id to update the user attributes
+user.put # or user.patch
+
+# Iterate over the books of the given user
+user.books.each do |book|
+  # Make a get requisition to http://api.example.com/books/:id to update the given book attributes
+  book.get
+  # Make a delete requisition to http://api.example.com/books/:id destroy the object if the publish_date is equal '1990'
+  book.delete if book.publish_date == '1990'
+end
+
+# Make a get requisition to http://api.example.com/authors and initialize an author object for each author returned
+authors = Author.collection
+
+# Iterate over the authors
+authors.each do |author|
+  # Set @author to the current author if it is the one
+  @author = author if author.name == 'Author Name'
+end
+
+# Initialize a new object
+book = Book.new
+
+# Set the name on the book object
+book.name = 'book'
+# Set the author_id of the book object with the chosen author id
+book.author_id = @author.id
+# Set the publish date of the book object
+book.publish_date = '2002'
+# Make a post requisition to http://api.example.com/books to create the book with the object attributes
+book.post

data/lib/api-client.rb

@@ -27,5 +27,6 @@ module ApiClient
 
   configure do |config|
     config.path = ''
+    config.header = { 'Content-Type' => 'application/json' }
   end
 end

data/lib/api-client/class_methods.rb

@@ -41,8 +41,8 @@ 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(id, attributes, header = {})
-      url = "#{ApiClient.config.path}#{self.resource_path}/#{id}"
+    def put(attributes, header = {})
+      url = "#{ApiClient.config.path}#{self.resource_path}"
       response = ApiClient::Dispatcher.put(url, attributes, header)
       params = ApiClient::Parser.response(response, url)
       build(params)
@@ -54,8 +54,8 @@ 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(id, attributes, header = {})
-      url = "#{ApiClient.config.path}#{self.resource_path}/#{id}"
+    def patch(attributes, header = {})
+      url = "#{ApiClient.config.path}#{self.resource_path}"
       response = ApiClient::Dispatcher.patch(url, attributes, header)
       params = ApiClient::Parser.response(response, url)
       build(params)
@@ -73,6 +73,10 @@ module ApiClient
       build(params)
     end
 
+    # Removes the root node attribute if found.
+    #
+    # @param [Hash] attributes the hash with attributes.
+    # @return [Hash] the hash with attributes without the root node.
     def remove_root(attributes = {})
       attributes = attributes[self.root_node.to_sym] if attributes.key?(self.root_node.to_sym)
       attributes = attributes[self.root_node.to_s] if attributes.key?(self.root_node.to_s)

data/lib/api-client/dispatcher/typhoeus.rb

@@ -8,7 +8,7 @@ module ApiClient::Dispatcher::Typhoeus
   # @param [Hash] header attributes of the request.
   # @return [Typhoeus::Request] the response object.
   def self.get(url, header = {})
-    ::Typhoeus::Request.get(url, :headers => ApiClient.config.header.merge(header))
+    ::Typhoeus.get(url, :headers => ApiClient.config.header.merge(header))
   end
 
   # Make a post request and returns it.
@@ -18,7 +18,7 @@ module ApiClient::Dispatcher::Typhoeus
   # @param [Hash] header attributes of the request.
   # @return [Typhoeus::Request] the response object.
   def self.post(url, args, header = {})
-    ::Typhoeus::Request.post(url, :body => args, :headers => ApiClient.config.header.merge(header))
+    ::Typhoeus.post(url, :body => args, :headers => ApiClient.config.header.merge(header))
   end
 
   # Make a put request and returns it.
@@ -28,7 +28,7 @@ module ApiClient::Dispatcher::Typhoeus
   # @param [Hash] header attributes of the request.
   # @return [Typhoeus::Request] the response object.
   def self.put(url, args, header = {})
-    ::Typhoeus::Request.put(url, :body => args, :headers => ApiClient.config.header.merge(header))
+    ::Typhoeus.put(url, :body => args, :headers => ApiClient.config.header.merge(header))
   end
 
   # Make a patch request and returns it.
@@ -38,7 +38,7 @@ module ApiClient::Dispatcher::Typhoeus
   # @param [Hash] header attributes of the request.
   # @return [Typhoeus::Request] the response object.
   def self.patch(url, args, header = {})
-    ::Typhoeus::Request.patch(url, :body => args, :headers => ApiClient.config.header.merge(header))
+    ::Typhoeus.patch(url, :body => args, :headers => ApiClient.config.header.merge(header))
   end
 
   # Make a delete request and returns it.
@@ -47,6 +47,6 @@ module ApiClient::Dispatcher::Typhoeus
   # @param [Hash] header attributes of the request.
   # @return [Typhoeus::Request] the response object.
   def self.delete(url, header = {})
-    ::Typhoeus::Request.delete(url, :headers => ApiClient.config.header.merge(header))
+    ::Typhoeus.delete(url, :headers => ApiClient.config.header.merge(header))
   end
 end

data/lib/api-client/instance_methods.rb

@@ -3,7 +3,7 @@ module ApiClient
   module InstanceMethods
     # Update an object based on a hash of attributes.
     #
-    # @param [Hash] params hash of attributes.
+    # @param [Hash] attributes hash of attributes.
     # @return [Base] the update_attributes object.
     def update_attributes(attributes)
       hash = remove_root(attributes)
@@ -14,6 +14,10 @@ module ApiClient
       self
     end
 
+    # Make a get requisition and update the object with the response.
+    #
+    # @param [Hash] header hash with the header options.
+    # @return [Base] the object updated.
     def get(header = {})
       url = "#{ApiClient.config.path}#{self.class.resource_path}/#{id}"
       response = ApiClient::Dispatcher.get(url, header)
@@ -21,6 +25,10 @@ module ApiClient
       update_attributes(attributes)
     end
 
+    # Make a post requisition and update the object with the response.
+    #
+    # @param [Hash] header hash with the header options.
+    # @return [Base] the object updated.
     def post(header = {})
       url = "#{ApiClient.config.path}#{self.class.resource_path}"
       response = ApiClient::Dispatcher.post(url, self.to_hash, header)
@@ -28,27 +36,43 @@ module ApiClient
       update_attributes(attributes)
     end
 
+    # Make a put requisition and update the object with the response.
+    #
+    # @param [Hash] header hash with the header options.
+    # @return [Base] the object updated.
     def put(header = {})
-      url = "#{ApiClient.config.path}#{self.class.resource_path}/#{id}"
+      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)
     end
 
+    # Make a patch requisition and update the object with the response.
+    #
+    # @param [Hash] header hash with the header options.
+    # @return [Base] the object updated.
     def patch(header = {})
-      url = "#{ApiClient.config.path}#{self.class.resource_path}/#{id}"
-      response = ApiClient::Dispatcher.post(url, self.to_hash, header)
+      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)
     end
 
+    # Make a delete requisition and update the object with the response.
+    #
+    # @param [Hash] header hash with the header options.
+    # @return [Base] the object updated.
     def delete(header = {})
       url = "#{ApiClient.config.path}#{self.class.resource_path}/#{id}"
-      response = ApiClient::Dispatcher.post(url, header)
+      response = ApiClient::Dispatcher.delete(url, header)
       attributes = ApiClient::Parser.response(response, url)
       update_attributes(attributes)
     end
 
+    # Removes the root node attribute if found.
+    #
+    # @param [Hash] attributes the hash with attributes.
+    # @return [Hash] the hash with attributes without the root node.
     def remove_root(attributes = {})
       attributes = attributes[self.class.root_node.to_sym] if attributes.key?(self.class.root_node.to_sym)
       attributes = attributes[self.class.root_node.to_s] if attributes.key?(self.class.root_node.to_s)

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.0.2'
+  VERSION = '2.0.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: api-client
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-14 00:00:00.000000000 Z
+date: 2013-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -144,8 +144,11 @@ files:
 - examples/controllers/application_controller.rb
 - examples/controllers/user_controller.rb
 - examples/models/admin.rb
+- examples/models/author.rb
+- examples/models/book.rb
 - examples/models/group.rb
 - examples/models/user.rb
+- examples/scripts/example.rb
 - gemfiles/Gemfile.net_http
 - gemfiles/Gemfile.typhoeus
 - lib/api-client.rb
@@ -194,7 +197,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 725018755031888977
+      hash: -3513012909283666012
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -203,7 +206,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 725018755031888977
+      hash: -3513012909283666012
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25
@@ -215,8 +218,11 @@ test_files:
 - examples/controllers/application_controller.rb
 - examples/controllers/user_controller.rb
 - examples/models/admin.rb
+- examples/models/author.rb
+- examples/models/book.rb
 - examples/models/group.rb
 - examples/models/user.rb
+- examples/scripts/example.rb
 - gemfiles/Gemfile.net_http
 - gemfiles/Gemfile.typhoeus
 - spec/api-client/base_spec.rb