api-client 1.6.1 → 1.7.0

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## v1.7.0
+
+* Support for Associations added.
+
 ## v1.6.0
 
 * Initial Support for Typhoeus added.

data/README.md

@@ -57,8 +57,17 @@ class Admin < ApiClient::Base
 end
 ```
 
+It can handle associations. It will automatically instantiate an association for you if properly setted like below:
+
+```ruby
+class Person < ApiClient::Base
+    self.associations = { :houses => "House", :cars => "Car" }
+```
+
+This code will create a setter and a getter for houses and cars and initialize the respective class inside the setter.
+
 ## TODO
-   * Add Support to Faraday
+   * Add support for parallel requests
    * Add more Response Handlers
 
 ## Contributing
@@ -67,4 +76,4 @@ end
 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/lib/api-client/base.rb

@@ -12,16 +12,26 @@ module ApiClient
     include ActiveModel::Conversion
     extend ActiveModel::Naming
 
+    # @return [Hash] the request response.
+    attr_accessor :response
+
     # 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)
+        send("#{name.to_s}=", value)
       end
     end
 
+    # Return if a object is persisted on the database or not.
+    #
+    # @return [False] always return false.
+    def persisted?
+      false
+    end
+
     # Return the Remote Object Name.
     #
     # @return [String] a string with the remote object class name.
@@ -36,11 +46,24 @@ module ApiClient
       @remote_object = remote_object
     end
 
-    # Return if a object is persisted on the database or not.
+    # Set methods to initialize associated objects.
     #
-    # @return [False] always return false.
-    def persisted?
-      false
+    # @param [Hash] association classes.
+    def self.associations(associations = {})
+      associations.each do |association, class_name|
+        class_eval <<-EVAL
+          def #{association.to_s}=(attributes = {})
+            @association = #{class_name.constantize}.new(attributes)
+          end
+          def #{association.to_s}
+            @association
+          end
+        EVAL
+      end
+    end
+
+    class << self
+      alias_method :association, :associations
     end
 
     # Return the hash of errors if existent, otherwise instantiate a new ApiClient::Errors object with self.
@@ -52,7 +75,7 @@ module ApiClient
 
     # Set the hash of errors, making keys symbolic.
     #
-    # @param [Hash] errors of the object..
+    # @param [Hash] errors of the object.
     def errors=(errs = {})
       @errors = Errors.new(self)
       @errors.add_errors(Hash[errs.map{|(key,value)| [key.to_sym,value]}])
@@ -61,9 +84,12 @@ module ApiClient
     protected
 
     def self.method_missing(method, *args)
-      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)
+      @response = Parser.response(Dispatcher.send(method, *args))
+      case true
+        when @response.key?(remote_object) then return new(@response[remote_object].merge(:response => @response))
+        when @response.key?(remote_object.pluralize) then return @response[remote_object.pluralize].map { |a| new(a.merge(:response => @response)) }
+        else return new(@response.merge(:response => @response))
+      end
     end
   end
 end

data/lib/api-client/dispatcher.rb

@@ -10,4 +10,4 @@ module ApiClient::Dispatcher
         NetHttp.send(method, *args)
     end
   end
-end
+end

data/lib/api-client/dispatcher/net-http.rb

@@ -60,6 +60,7 @@ module ApiClient::Dispatcher::NetHttp
 
   def self.initialize_connection(url = '')
     @uri = URI(url)
+    @uri.path = "/" if @uri.path.blank?
     @http = Net::HTTP.new(@uri.host, @uri.port)
   end
 
@@ -70,4 +71,4 @@ module ApiClient::Dispatcher::NetHttp
       raise ApiClient::Exceptions::ConnectionRefused
     end
   end
-end
+end

data/lib/api-client/parser.rb

@@ -4,12 +4,10 @@ module ApiClient::Parser
   #
   # @param [HTTP] response HTTP object for the request.
   # @return [Array] the code and the body parsed.
-  def self.response(response, remote_object)
+  def self.response(response)
     raise_exception(response.code)
     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, TypeError
       object = {}
     end
@@ -29,4 +27,4 @@ module ApiClient::Parser
       else return
     end
   end
-end
+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 = "1.6.1"
+  VERSION = "1.7.0"
 end

data/spec/api-client/base_spec.rb

@@ -43,6 +43,8 @@ describe ApiClient::Base do
     end
   end
 
+  describe
+
   describe "#errors" do
     context "when @errors is not nil" do
       before :each do
@@ -65,6 +67,20 @@ describe ApiClient::Base do
     end
   end
 
+  describe "#associations" do
+    before :each do
+      @post = Post.new({:a => "a", :writer => {:b => "b"}})
+    end
+
+    it "should instantiate a new instance of the association" do
+      @post.writer.should be_an_instance_of(User)
+    end
+
+    it "should create a setter and a getter for the associations" do
+      @post.writer.b.should == "b"
+    end
+  end
+
   describe "#errors=" do
     before :each do
       @user = User.new(:errors => { "a" => "message", "b" => "message" })
@@ -74,4 +90,18 @@ describe ApiClient::Base do
       @user.errors.messages.should == { :a => %w(message), :b => %w(message) }
     end
   end
+
+  describe "requests" do
+    before :each do
+      stub_request(:any, "http://api.example.com").to_return(:body => {"a" => "b"}.to_json)
+    end
+
+    it "should return a new instance" do
+      User.get("http://api.example.com").should be_an_instance_of(User)
+    end
+
+    it "should set the response on the instance" do
+      User.get("http://api.example.com").response.should == {"a" => "b"}
+    end
+  end
 end

data/spec/api-client/parser_spec.rb

@@ -2,31 +2,14 @@ require 'spec_helper'
 
 describe ApiClient::Parser do
   describe "#response" do
-    before :each do
-      @remote_object = ApiClient::Base.remote_object
-    end
-
     context "with a valid json response" do
-      context "without a root node" do
-        before :each do
-          stub_request(:post, "http://api.example.com/user/5").to_return(:body => { :a => :b }.to_json, :status => "201")
-          @response = ApiClient::Dispatcher.post('http://api.example.com/user/5', {}, {})
-        end
-
-        it "should return the response code and the body parsed" do
-          ApiClient::Parser.response(@response, @remote_object).should == { "a" => "b" }
-        end
+      before :each do
+        stub_request(:post, "http://api.example.com/user/5").to_return(:body => {:base => { :a => :b } }.to_json, :status => "201")
+        @response = ApiClient::Dispatcher.post('http://api.example.com/user/5', {}, {})
       end
 
-      context "with a root node" do
-        before :each do
-          stub_request(:post, "http://api.example.com/user/5").to_return(:body => {:base => { :a => :b } }.to_json, :status => "201")
-          @response = ApiClient::Dispatcher.post('http://api.example.com/user/5', {}, {})
-        end
-
-        it "should return the response code and the body parsed" do
-          ApiClient::Parser.response(@response, @remote_object).should == { "a" => "b" }
-        end
+      it "should return the response code and the body parsed" do
+        ApiClient::Parser.response(@response).should == { "base" => { "a" => "b" } }
       end
     end
 
@@ -37,7 +20,7 @@ describe ApiClient::Parser do
       end
 
       it "should return the response code and an empty hash" do
-        ApiClient::Parser.response(@response, @remote_object).should == {}
+        ApiClient::Parser.response(@response).should == {}
       end
     end
 
@@ -49,7 +32,7 @@ describe ApiClient::Parser do
         end
 
         it "should return a Unauthorized exception" do
-          lambda { ApiClient::Parser.response(@response, @remote_object) }.should raise_error(ApiClient::Exceptions::Unauthorized)
+          lambda { ApiClient::Parser.response(@response) }.should raise_error(ApiClient::Exceptions::Unauthorized)
         end
       end
 
@@ -60,7 +43,7 @@ describe ApiClient::Parser do
         end
 
         it "should return a Forbidden exception" do
-          lambda { ApiClient::Parser.response(@response, @remote_object) }.should raise_error(ApiClient::Exceptions::Forbidden)
+          lambda { ApiClient::Parser.response(@response) }.should raise_error(ApiClient::Exceptions::Forbidden)
         end
       end
 
@@ -71,7 +54,7 @@ describe ApiClient::Parser do
         end
 
         it "should return a NotFound exception" do
-          lambda { ApiClient::Parser.response(@response, @remote_object) }.should raise_error(ApiClient::Exceptions::NotFound)
+          lambda { ApiClient::Parser.response(@response) }.should raise_error(ApiClient::Exceptions::NotFound)
         end
       end
 
@@ -82,7 +65,7 @@ describe ApiClient::Parser do
         end
 
         it "should return a InternalServerError exception" do
-          lambda { ApiClient::Parser.response(@response, @remote_object) }.should raise_error(ApiClient::Exceptions::InternalServerError)
+          lambda { ApiClient::Parser.response(@response) }.should raise_error(ApiClient::Exceptions::InternalServerError)
         end
       end
 
@@ -93,7 +76,7 @@ describe ApiClient::Parser do
         end
 
         it "should return a BadGateway exception" do
-          lambda { ApiClient::Parser.response(@response, @remote_object) }.should raise_error(ApiClient::Exceptions::BadGateway)
+          lambda { ApiClient::Parser.response(@response) }.should raise_error(ApiClient::Exceptions::BadGateway)
         end
       end
 
@@ -104,9 +87,9 @@ describe ApiClient::Parser do
         end
 
         it "should return a ServiceUnavailable exception" do
-          lambda { ApiClient::Parser.response(@response, @remote_object) }.should raise_error(ApiClient::Exceptions::ServiceUnavailable)
+          lambda { ApiClient::Parser.response(@response) }.should raise_error(ApiClient::Exceptions::ServiceUnavailable)
         end
       end
     end
   end
-end
+end

data/spec/spec_helper.rb

@@ -15,4 +15,10 @@ class Admin < ApiClient::Base
   self.remote_object = "user"
 
   attr_accessor :a, :b
-end
+end
+
+class Post < ApiClient::Base
+  self.association({ :writer => "User" })
+
+  attr_accessor :a
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: api-client
 version: !ruby/object:Gem::Version
-  version: 1.6.1
+  version: 1.7.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-07 00:00:00.000000000 Z
+date: 2012-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -165,7 +165,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3779983035564175223
+      hash: 3232996777461905993
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -174,7 +174,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3779983035564175223
+      hash: 3232996777461905993
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24