api-client 1.5.0 → 1.5.1

data/CHANGELOG.md

@@ -1,12 +1,17 @@
 # CHANGELOG
 
+## v1.5.0
+
+* Handler of arrays as response.
+* Method to redefine response object added.
+
 ## v1.4.1
 
 * ActiveModel compatibility for errors added. make all error keys symbolic.
 
 ## v1.4.0
 
-* functionality to validate on client side using ApiClient::Base added
+* functionality to validate on client side using ApiClient::Base added.
 
 ## v1.3.0
 

data/README.md

@@ -21,32 +21,42 @@ Or install it yourself as:
 
 Add this to your ApplicationController:
 
-    rescue_from ApiClient::Exceptions::NotFound, :with => :not_found
+```ruby
+rescue_from ApiClient::Exceptions::NotFound, :with => :not_found
 
-    def not_found
-       #Specify your own behavior here
-    end
+def not_found
+    #Specify your own behavior here
+end
+```
 
 You can define a more generic rescue that will work for any error:
 
-    rescue_from ApiClient::Exceptions::Generic, :with => :generic_error
+```ruby
+rescue_from ApiClient::Exceptions::Generic, :with => :generic_error
+```
 
 On Your model, extend ApiClient::Base
 
-    class User < ApiClient::Base
+```ruby
+class User < ApiClient::Base
+```
 
 Then, on your action, just put into it:
 
-    @user = User.get("http://api.example.com/user/3")
+```ruby
+@user = User.get("http://api.example.com/user/3")
+```
 
 ## Advanced Usage
 
 ApiClient can read api responses with root nodes based on the name of the virtual class.
 In Some cases, that is not the required behavior. To Redefine it, use remote_object method:
 
-    class Admin < ApiClient::Base
-       self.remote_object = "user"
-    end
+```ruby
+class Admin < ApiClient::Base
+    self.remote_object = "user"
+end
+```
 
 ## TODO
    * Add Support to Typhoeus and Faraday
@@ -59,4 +69,4 @@ In Some cases, that is not the required behavior. To Redefine it, use remote_obj
 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/controllers/user_controller.rb

@@ -2,7 +2,7 @@ class UserController < ApplicationController
   # It will works with respond_with.
   # Your action should looks like any other one: A model with a method call. =D
   def index
-    @user = User.get("api.example.com/users")
+    @users = User.get("api.example.com/users")
     respond_with(@users)
   end
 end

data/examples/models/user.rb

@@ -1,4 +1,8 @@
 class User < ApiClient::Base
   # Any of this fields can be called to manage rails form.
   attr_accessor :id, :email, :password, :password_confirmation
+
+  # Validations will work as well
+  validates :email, :presence => true, :uniqueness => true
+  validates :password, :confirmation => true
 end

data/lib/api-client/base.rb

@@ -1,155 +1,69 @@
 require "active_model"
 
-# ApiClient::Base provides a way to make easy api requests as well as making possible to use it inside rails.
-# A possible implementation:
-#  class Car < ApiClient::Base
-#    attr_accessor :color, :name, :year
-#  end
-# This class will handle Rails form as well as it works with respond_with.
-class ApiClient::Base
-  include ActiveModel::Validations
-  include ActiveModel::Conversion
-  extend ActiveModel::Naming
+module ApiClient
+  # ApiClient::Base provides a way to make easy api requests as well as making possible to use it inside rails.
+  # A possible implementation:
+  #  class Car < ApiClient::Base
+  #    attr_accessor :color, :name, :year
+  #  end
+  # This class will handle Rails form as well as it works with respond_with.
+  class Base
+    include ActiveModel::Validations
+    include ActiveModel::Conversion
+    extend ActiveModel::Naming
 
-  extend ApiClient::Parser
-  extend ApiClient::Dispatcher
-
-  # Initialize an object based on a hash of attributes.
-  #
-  # @param [Hash] attributes object attributes.
-  # @return [Base] the object initialized.
-  def initialize(attributes = {})
-    attributes.each do |name, value|
-      send("#{name}=", value)
+    # Initialize an object based on a hash of attributes.
+    #
+    # @param [Hash] attributes object attributes.
+    # @return [Base] the object initialized.
+    def initialize(attributes = {})
+      attributes.each do |name, value|
+        send("#{name}=", value)
+      end
     end
-  end
-
-  # Return if a object is persisted on the database or not.
-  #
-  # @return [False] always return false.
-  def persisted?
-    false
-  end
-
-  # Return the hash of errors if existent, otherwise instantiate a new ApiClient::Errors object with self.
-  #
-  # @return [ApiClient::Errors] the validation errors.
-  def errors
-    @errors ||= ApiClient::Errors.new(self)
-  end
 
-  # Set the hash of errors, making keys symbolic.
-  #
-  # @param [Hash] errors of the object..
-  def errors=(errors = {})
-    @errors = Hash[errors.map{|(key,value)| [key.to_sym,value]}]
-  end
-
-  # Make a get request and returns a new instance with te response attributes.
-  #
-  # @param [String] url of the api request.
-  # @param [Hash] header attributes of the request.
-  # @return [Base] a new object initialized with the response.
-  # @raise [ApiClient::Exceptions::ConnectionRefused] The request was refused by the api.
-  # @raise [ApiClient::Exceptions::Unauthorized] The request requires user authentication.
-  # @raise [ApiClient::Exceptions::Forbidden] The request was refused.
-  # @raise [ApiClient::Exceptions::NotFound] The request uri has not be found.
-  # @raise [ApiClient::Exceptions::InternalServerError] The request was not fulfilled by the api.
-  # @raise [ApiClient::Exceptions::BadGateway] The request was not fulfilled by the api.
-  # @raise [ApiClient::Exceptions::ServiceUnavailable] The api was unable to handle the request.
-  def self.get(url = '', header = {})
-    dispatch { _get(url, header) }
-  end
-
-  # Make a post request and returns a new instance with te response attributes.
-  #
-  # @param [String] url of the api request.
-  # @param [Hash] args attributes of object.
-  # @param [Hash] header attributes of the request.
-  # @return [Base] a new object initialized with the response.
-  # @raise [ApiClient::Exceptions::ConnectionRefused] The request was refused by the api.
-  # @raise [ApiClient::Exceptions::Unauthorized] The request requires user authentication.
-  # @raise [ApiClient::Exceptions::Forbidden] The request was refused.
-  # @raise [ApiClient::Exceptions::NotFound] The request uri has not be found.
-  # @raise [ApiClient::Exceptions::InternalServerError] The request was not fulfilled by the api.
-  # @raise [ApiClient::Exceptions::BadGateway] The request was not fulfilled by the api.
-  # @raise [ApiClient::Exceptions::ServiceUnavailable] The api was unable to handle the request.
-  def self.post(url = '', args = {}, header = {})
-    dispatch { _post(url, args, header) }
-  end
-
-  # Make a put request and returns a new instance with te response attributes.
-  #
-  # @param [String] url of the api request.
-  # @param [Hash] args attributes of object.
-  # @param [Hash] header attributes of the request.
-  # @return [Base] a new object initialized with the response.
-  # @raise [ApiClient::Exceptions::ConnectionRefused] The request was refused by the api.
-  # @raise [ApiClient::Exceptions::Unauthorized] The request requires user authentication.
-  # @raise [ApiClient::Exceptions::Forbidden] The request was refused.
-  # @raise [ApiClient::Exceptions::NotFound] The request uri has not be found.
-  # @raise [ApiClient::Exceptions::InternalServerError] The request was not fulfilled by the api.
-  # @raise [ApiClient::Exceptions::BadGateway] The request was not fulfilled by the api.
-  # @raise [ApiClient::Exceptions::ServiceUnavailable] The api was unable to handle the request.
-  def self.put(url = '', args = {}, header = {})
-    dispatch { _put(url, args, header) }
-  end
+    # Return the Remote Object Name.
+    #
+    # @return [String] a string with the remote object class name.
+    def self.remote_object
+      @remote_object.blank? ? self.to_s.split('::').last.downcase : @remote_object
+    end
 
-  # Make a patch request and returns a new instance with te response attributes.
-  #
-  # @param [String] url of the api request.
-  # @param [Hash] args attributes of object.
-  # @param [Hash] header attributes of the request.
-  # @return [Base] a new object initialized with the response.
-  # @raise [ApiClient::Exceptions::ConnectionRefused] The request was refused by the api.
-  # @raise [ApiClient::Exceptions::Unauthorized] The request requires user authentication.
-  # @raise [ApiClient::Exceptions::Forbidden] The request was refused.
-  # @raise [ApiClient::Exceptions::NotFound] The request uri has not be found.
-  # @raise [ApiClient::Exceptions::InternalServerError] The request was not fulfilled by the api.
-  # @raise [ApiClient::Exceptions::BadGateway] The request was not fulfilled by the api.
-  # @raise [ApiClient::Exceptions::ServiceUnavailable] The api was unable to handle the request.
-  def self.patch(url = '', args = {}, header = {})
-    dispatch { _patch(url, args, header) }
-  end
+    # Set a custom remote object name instead of the virtual class name.
+    #
+    # @param [String] remote_object name.
+    def self.remote_object=(remote_object)
+      @remote_object = remote_object
+    end
 
-  # Make a delete request and returns a new instance with te response attributes.
-  #
-  # @param [String] url of the api request.
-  # @param [Hash] header attributes of the request.
-  # @return [Base] a new object initialized with the response.
-  # @raise [ApiClient::Exceptions::ConnectionRefused] The request was refused by the api.
-  # @raise [ApiClient::Exceptions::Unauthorized] The request requires user authentication.
-  # @raise [ApiClient::Exceptions::Forbidden] The request was refused.
-  # @raise [ApiClient::Exceptions::NotFound] The request uri has not be found.
-  # @raise [ApiClient::Exceptions::InternalServerError] The request was not fulfilled by the api.
-  # @raise [ApiClient::Exceptions::BadGateway] The request was not fulfilled by the api.
-  # @raise [ApiClient::Exceptions::ServiceUnavailable] The api was unable to handle the request.
-  def self.delete(url = '', header = {})
-    dispatch { _delete(url, header) }
-  end
+    # Return if a object is persisted on the database or not.
+    #
+    # @return [False] always return false.
+    def persisted?
+      false
+    end
 
-  protected
+    # Return the hash of errors if existent, otherwise instantiate a new ApiClient::Errors object with self.
+    #
+    # @return [ApiClient::Errors] the validation errors.
+    def errors
+      @errors ||= Errors.new(self)
+    end
 
-  def self.dispatch
-    begin
-      code, object = _response(yield)
-    rescue Errno::ECONNREFUSED
-      raise ApiClient::Exceptions::ConnectionRefused
+    # Set the hash of errors, making keys symbolic.
+    #
+    # @param [Hash] errors of the object..
+    def errors=(errors = {})
+      @errors = Errors.new(self).add_errors(Hash[errors.map{|(key,value)| [key.to_sym,value]}])
     end
-    raise_exception(code)
-    return object.map { |a| new(a) } if object.instance_of?(Array)
-    new(object)
-  end
 
-  def self.raise_exception(code)
-    case code
-      when '401' then raise ApiClient::Exceptions::Unauthorized
-      when '403' then raise ApiClient::Exceptions::Forbidden
-      when '404' then raise ApiClient::Exceptions::NotFound
-      when '500' then raise ApiClient::Exceptions::InternalServerError
-      when '502' then raise ApiClient::Exceptions::BadGateway
-      when '503' then raise ApiClient::Exceptions::ServiceUnavailable
-      else return
+    protected
+
+    def self.method_missing(method, *args)
+      return super unless Dispatcher.respond_to?(method)
+      json_object = Parser.response(Dispatcher.send(method, *args), remote_object)
+      return json_object.map { |a| new(a) } if json_object.instance_of?(Array)
+      new(json_object)
     end
   end
-end
+end

data/lib/api-client/dispatcher.rb

@@ -7,9 +7,9 @@ module ApiClient::Dispatcher
   # @param [String] url of the api request.
   # @param [Hash] header attributes of the request.
   # @return [HTTP] the response object.
-  def _get(url, header)
+  def self.get(url, header = {})
     initialize_connection(url)
-    @http.get(@uri.path, header)
+    call { @http.get(@uri.path, header) }
   end
 
   # Make a post request and returns it.
@@ -18,9 +18,9 @@ module ApiClient::Dispatcher
   # @param [Hash] args attributes of object.
   # @param [Hash] header attributes of the request.
   # @return [HTTP] the response object.
-  def _post(url, args, header)
+  def self.post(url, args, header = {})
     initialize_connection(url)
-    @http.post(@uri.path, args.to_json, { 'Content-Type' => 'application/json' }.merge(header))
+    call { @http.post(@uri.path, args.to_json, { 'Content-Type' => 'application/json' }.merge(header)) }
   end
 
   # Make a put request and returns it.
@@ -29,9 +29,9 @@ module ApiClient::Dispatcher
   # @param [Hash] args attributes of object.
   # @param [Hash] header attributes of the request.
   # @return [HTTP] the response object.
-  def _put(url, args, header)
+  def self.put(url, args, header = {})
     initialize_connection(url)
-    @http.put(@uri.path, args.to_json, { 'Content-Type' => 'application/json' }.merge(header))
+    call { @http.put(@uri.path, args.to_json, { 'Content-Type' => 'application/json' }.merge(header)) }
   end
 
   # Make a patch request and returns it.
@@ -40,9 +40,9 @@ module ApiClient::Dispatcher
   # @param [Hash] args attributes of object.
   # @param [Hash] header attributes of the request.
   # @return [HTTP] the response object.
-  def _patch(url, args, header)
+  def self.patch(url, args, header = {})
     initialize_connection(url)
-    @http.patch(@uri.path, args.to_json, { 'Content-Type' => 'application/json' }.merge(header))
+    call { @http.patch(@uri.path, args.to_json, { 'Content-Type' => 'application/json' }.merge(header)) }
   end
 
   # Make a delete request and returns it.
@@ -50,15 +50,23 @@ module ApiClient::Dispatcher
   # @param [String] url of the api request.
   # @param [Hash] header attributes of the request.
   # @return [HTTP] the response object.
-  def _delete(url, header)
+  def self.delete(url, header = {})
     initialize_connection(url)
-    @http.delete(@uri.path, header)
+    call { @http.delete(@uri.path, header) }
   end
 
   protected
 
-  def initialize_connection(url = '')
+  def self.initialize_connection(url = '')
     @uri = URI(url)
     @http = Net::HTTP.new(@uri.host, @uri.port)
   end
+
+  def self.call
+    begin
+      yield
+    rescue Errno::ECONNREFUSED
+      raise ApiClient::Exceptions::ConnectionRefused
+    end
+  end
 end

data/lib/api-client/errors.rb

@@ -2,16 +2,25 @@ require "active_model"
 
 # ApiClient::Errors provide extra functionality to ActiveModel::Errors.
 class ApiClient::Errors < ActiveModel::Errors
+  # Add serveral errors from a hash to the object.
+  #
+  # @return [ApiClient::Errors] The Error object.
+  def add_errors(errors = {})
+    errors.each do |key, value|
+      self.set(key, value)
+    end
+    self
+  end
+
   # Create a hash of attributes with unique validation error messages.
   #
   # Example:
   #    user.errors.unique_messages   #=> { :name => [ can't be empty and is invalid ]}
   #
   # @return [Hash] The hash of attributes with a unique error message.
-  #
   def unique_messages
     errors = {}
     to_hash.each do |attribute, messages| errors[attribute] = messages.join(" and ") end
     errors
   end
-end
+end

data/lib/api-client/parser.rb

@@ -4,28 +4,29 @@ module ApiClient::Parser
   #
   # @param [HTTP] response HTTP object for the request.
   # @return [Array] the code and the body parsed.
-  def _response(response)
+  def self.response(response, remote_object)
     begin
       object = JSON.parse(response.body)
       object = object[remote_object] if object.key?(remote_object)
       object = object[remote_object.pluralize] if object.key?(remote_object.pluralize)
     rescue JSON::ParserError
-      object = nil
+      object = {}
     end
-    return response.code, object
+    raise_exception(response.code)
+    object
   end
 
-  # Return the Remote Object Name.
-  #
-  # @return [String] a string with the remote object class name.
-  def remote_object
-    @remote_object.blank? ? self.to_s.split('::').last.downcase : @remote_object
-  end
+  protected
 
-  # Set a custom remote object name instead of the virtual class name.
-  #
-  # @param [String] remote_object name.
-  def remote_object=(remote_object)
-    @remote_object = remote_object
+  def self.raise_exception(code)
+    case code
+      when '401' then raise ApiClient::Exceptions::Unauthorized
+      when '403' then raise ApiClient::Exceptions::Forbidden
+      when '404' then raise ApiClient::Exceptions::NotFound
+      when '500' then raise ApiClient::Exceptions::InternalServerError
+      when '502' then raise ApiClient::Exceptions::BadGateway
+      when '503' then raise ApiClient::Exceptions::ServiceUnavailable
+      else return
+    end
   end
 end