api-client 1.4.1 → 1.5.0

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # CHANGELOG
 
+## 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
+
 ## v1.3.0
 
 * functionality to read args with a root node added.

data/README.md

@@ -1,6 +1,6 @@
 # ApiClient [![Build Status](https://secure.travis-ci.org/plribeiro3000/api-client.png)](http://travis-ci.org/plribeiro3000/api-client)
 
-Client to make Api calls inside Rails easily. The master only supports ruby-1.9.3.
+Client to make Api calls easily. The master only supports ruby-1.9.3.
 For older versions, check branch retro-compatibility.
 
 ## Installation
@@ -17,7 +17,7 @@ Or install it yourself as:
 
     $ gem install api-client
 
-## Usage
+## Basic Usage
 
 Add this to your ApplicationController:
 
@@ -39,6 +39,15 @@ Then, on your action, just put into it:
 
     @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
+
 ## TODO
    * Add Support to Typhoeus and Faraday
    * Proper Treatment for validation errors

data/lib/api-client/base.rb

@@ -31,13 +31,16 @@ class ApiClient::Base
     false
   end
 
-  # Return the an array of errors if existent, otherwise instantiate a new ApiClient::Errors object with self.
+  # 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
@@ -134,6 +137,7 @@ class ApiClient::Base
       raise ApiClient::Exceptions::ConnectionRefused
     end
     raise_exception(code)
+    return object.map { |a| new(a) } if object.instance_of?(Array)
     new(object)
   end
 

data/lib/api-client/parser.rb

@@ -6,12 +6,26 @@ module ApiClient::Parser
   # @return [Array] the code and the body parsed.
   def _response(response)
     begin
-      body = JSON.parse(response.body)
-      root_node =  name.split('::').last.downcase
-      object = body.key?(root_node) ? body[root_node] : body
+      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
     end
     return 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
+
+  # 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
+  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.4.1"
+  VERSION = "1.5.0"
 end

data/spec/api-client/base/delete_spec.rb

@@ -75,13 +75,59 @@ describe ApiClient::Base do
     end
 
     context "when response code is 2xx" do
-      before :each do
-        FakeWeb.register_uri(:delete, "http://api.example.com/user/5", :status => "201", :body => '{"a": "a", "b": "b"}')
-        User.stub(:new).and_return(user)
+      context "without any specifications" do
+        before :each do
+          FakeWeb.register_uri(:delete, "http://api.example.com/user/5", :status => "201", :body => '{"a": "a", "b": "b"}')
+          User.stub(:new).and_return(user)
+        end
+
+        it "should return a object initialized with the response" do
+          User.delete('http://api.example.com/user/5').should == user
+        end
+      end
+
+      context "with a specified port" do
+        before :each do
+          FakeWeb.register_uri(:delete, "http://api.example.com:3001/user/5", :status => "201", :body => '{"a": "a", "b": "b"}')
+          User.stub(:new).and_return(user)
+        end
+
+        it "should return a object initialized with the response" do
+          User.delete('http://api.example.com:3001/user/5', {}).should == user
+        end
+      end
+
+      context "with a specified remote object name" do
+        before :each do
+          FakeWeb.register_uri(:delete, "http://api.example.com/user/5", :status => "201", :body => '{"user": {"a": "a", "b": "b"} }')
+          Admin.stub(:new).and_return(user)
+        end
+
+        it "should return a object initialized with the response" do
+          Admin.delete('http://api.example.com/user/5', {}).should == user
+        end
+      end
+
+      context "with a collection" do
+        before :each do
+          FakeWeb.register_uri(:delete, "http://api.example.com/user/5", :status => "201", :body => '{"users": [ {"a": "a", "b": "b"}, {"a": "a", "b": "b"} ] }')
+          User.stub(:new).and_return(user)
+        end
+
+        it "should return a collection of objects initialized with the response" do
+          User.delete('http://api.example.com/user/5', {}).should == [ user, user ]
+        end
       end
 
-      it "should return a object intialized with the response" do
-        User.delete('http://api.example.com/user/5').should == user
+      context "with a collection and a specified remote object name" do
+        before :each do
+          FakeWeb.register_uri(:delete, "http://api.example.com/user/5", :status => "201", :body => '{"users": [ {"a": "a", "b": "b"}, {"a": "a", "b": "b"} ] }')
+          Admin.stub(:new).and_return(user)
+        end
+
+        it "should return a collection of objects initialized with the response" do
+          Admin.delete('http://api.example.com/user/5', {}).should == [ user, user ]
+        end
       end
     end
   end

data/spec/api-client/base/get_spec.rb

@@ -75,13 +75,59 @@ describe ApiClient::Base do
     end
 
     context "when response code is 2xx" do
-      before :each do
-        FakeWeb.register_uri(:get, "http://api.example.com/user/5", :status => "201", :body => '{"a": "a", "b": "b"}')
-        User.stub(:new).and_return(user)
+      context "without any specifications" do
+        before :each do
+          FakeWeb.register_uri(:get, "http://api.example.com/user/5", :status => "201", :body => '{"a": "a", "b": "b"}')
+          User.stub(:new).and_return(user)
+        end
+
+        it "should return a object initialized with the response" do
+          User.get('http://api.example.com/user/5').should == user
+        end
+      end
+
+      context "with a specified port" do
+        before :each do
+          FakeWeb.register_uri(:get, "http://api.example.com:3001/user/5", :status => "201", :body => '{"a": "a", "b": "b"}')
+          User.stub(:new).and_return(user)
+        end
+
+        it "should return a object initialized with the response" do
+          User.get('http://api.example.com:3001/user/5', {}).should == user
+        end
+      end
+
+      context "with a specified remote object name" do
+        before :each do
+          FakeWeb.register_uri(:get, "http://api.example.com/user/5", :status => "201", :body => '{"user": {"a": "a", "b": "b"} }')
+          Admin.stub(:new).and_return(user)
+        end
+
+        it "should return a object initialized with the response" do
+          Admin.get('http://api.example.com/user/5', {}).should == user
+        end
+      end
+
+      context "with a collection" do
+        before :each do
+          FakeWeb.register_uri(:get, "http://api.example.com/user/5", :status => "201", :body => '{"users": [ {"a": "a", "b": "b"}, {"a": "a", "b": "b"} ] }')
+          User.stub(:new).and_return(user)
+        end
+
+        it "should return a collection of objects initialized with the response" do
+          User.get('http://api.example.com/user/5', {}).should == [ user, user ]
+        end
       end
 
-      it "should return a object intialized with the response" do
-        User.get('http://api.example.com/user/5').should == user
+      context "with a collection and a specified remote object name" do
+        before :each do
+          FakeWeb.register_uri(:get, "http://api.example.com/user/5", :status => "201", :body => '{"users": [ {"a": "a", "b": "b"}, {"a": "a", "b": "b"} ] }')
+          Admin.stub(:new).and_return(user)
+        end
+
+        it "should return a collection of objects initialized with the response" do
+          Admin.get('http://api.example.com/user/5', {}).should == [ user, user ]
+        end
       end
     end
   end

data/spec/api-client/base/patch_spec.rb

@@ -75,24 +75,59 @@ describe ApiClient::Base do
     end
 
     context "when response code is 2xx" do
-      before :each do
-        FakeWeb.register_uri(:patch, "http://api.example.com/user/5", :status => "201", :body => '{"a": "a", "b": "b"}')
-        User.stub(:new).and_return(user)
+      context "without any specifications" do
+        before :each do
+          FakeWeb.register_uri(:patch, "http://api.example.com/user/5", :status => "201", :body => '{"a": "a", "b": "b"}')
+          User.stub(:new).and_return(user)
+        end
+
+        it "should return a object initialized with the response" do
+          User.patch('http://api.example.com/user/5', {}).should == user
+        end
       end
 
-      it "should return a object initialized with the response" do
-        User.patch('http://api.example.com/user/5', {}).should == user
+      context "with a specified port" do
+        before :each do
+          FakeWeb.register_uri(:patch, "http://api.example.com:3001/user/5", :status => "201", :body => '{"a": "a", "b": "b"}')
+          User.stub(:new).and_return(user)
+        end
+
+        it "should return a object initialized with the response" do
+          User.patch('http://api.example.com:3001/user/5', {}).should == user
+        end
       end
-    end
 
-    context "with a specified port" do
-      before :each do
-        FakeWeb.register_uri(:patch, "http://api.example.com:3001/user/5", :status => "201", :body => '{"a": "a", "b": "b"}')
-        User.stub(:new).and_return(user)
+      context "with a specified remote object name" do
+        before :each do
+          FakeWeb.register_uri(:patch, "http://api.example.com/user/5", :status => "201", :body => '{"user": {"a": "a", "b": "b"} }')
+          Admin.stub(:new).and_return(user)
+        end
+
+        it "should return a object initialized with the response" do
+          Admin.patch('http://api.example.com/user/5', {}).should == user
+        end
       end
 
-      it "should return a object initialized with the response" do
-        User.patch('http://api.example.com:3001/user/5', {}).should == user
+      context "with a collection" do
+        before :each do
+          FakeWeb.register_uri(:patch, "http://api.example.com/user/5", :status => "201", :body => '{"users": [ {"a": "a", "b": "b"}, {"a": "a", "b": "b"} ] }')
+          User.stub(:new).and_return(user)
+        end
+
+        it "should return a collection of objects initialized with the response" do
+          User.patch('http://api.example.com/user/5', {}).should == [ user, user ]
+        end
+      end
+
+      context "with a collection and a specified remote object name" do
+        before :each do
+          FakeWeb.register_uri(:patch, "http://api.example.com/user/5", :status => "201", :body => '{"users": [ {"a": "a", "b": "b"}, {"a": "a", "b": "b"} ] }')
+          Admin.stub(:new).and_return(user)
+        end
+
+        it "should return a collection of objects initialized with the response" do
+          Admin.patch('http://api.example.com/user/5', {}).should == [ user, user ]
+        end
       end
     end
   end

data/spec/api-client/base/post_spec.rb

@@ -75,24 +75,59 @@ describe ApiClient::Base do
     end
 
     context "when response code is 2xx" do
-      before :each do
-        FakeWeb.register_uri(:post, "http://api.example.com/user/5", :status => "201", :body => '{"a": "a", "b": "b"}')
-        User.stub(:new).and_return(user)
+      context "without a specified port" do
+        before :each do
+          FakeWeb.register_uri(:post, "http://api.example.com/user/5", :status => "201", :body => '{"a": "a", "b": "b"}')
+          User.stub(:new).and_return(user)
+        end
+
+        it "should return a object initialized with the response" do
+          User.post('http://api.example.com/user/5', {}).should == user
+        end
       end
 
-      it "should return a object initialized with the response" do
-        User.post('http://api.example.com/user/5', {}).should == user
+      context "with a specified port" do
+        before :each do
+          FakeWeb.register_uri(:post, "http://api.example.com:3001/user/5", :status => "201", :body => '{"a": "a", "b": "b"}')
+          User.stub(:new).and_return(user)
+        end
+
+        it "should return a object initialized with the response" do
+          User.post('http://api.example.com:3001/user/5', {}).should == user
+        end
       end
-    end
 
-    context "with a specified port" do
-      before :each do
-        FakeWeb.register_uri(:post, "http://api.example.com:3001/user/5", :status => "201", :body => '{"a": "a", "b": "b"}')
-        User.stub(:new).and_return(user)
+      context "with a specified remote object name" do
+        before :each do
+          FakeWeb.register_uri(:post, "http://api.example.com/user/5", :status => "201", :body => '{"user": {"a": "a", "b": "b"} }')
+          Admin.stub(:new).and_return(user)
+        end
+
+        it "should return a object initialized with the response" do
+          Admin.post('http://api.example.com/user/5', {}).should == user
+        end
       end
 
-      it "should return a object initialized with the response" do
-        User.post('http://api.example.com:3001/user/5', {}).should == user
+      context "with a collection" do
+        before :each do
+          FakeWeb.register_uri(:post, "http://api.example.com/user/5", :status => "201", :body => '{"users": [ {"a": "a", "b": "b"}, {"a": "a", "b": "b"} ] }')
+          User.stub(:new).and_return(user)
+        end
+
+        it "should return a collection of objects initialized with the response" do
+          User.post('http://api.example.com/user/5', {}).should == [ user, user ]
+        end
+      end
+
+      context "with a collection and a specified remote object name" do
+        before :each do
+          FakeWeb.register_uri(:post, "http://api.example.com/user/5", :status => "201", :body => '{"users": [ {"a": "a", "b": "b"}, {"a": "a", "b": "b"} ] }')
+          Admin.stub(:new).and_return(user)
+        end
+
+        it "should return a collection of objects initialized with the response" do
+          Admin.post('http://api.example.com/user/5', {}).should == [ user, user ]
+        end
       end
     end
   end

data/spec/api-client/base/put_spec.rb

@@ -75,24 +75,59 @@ describe ApiClient::Base do
     end
 
     context "when response code is 2xx" do
-      before :each do
-        FakeWeb.register_uri(:put, "http://api.example.com/user/5", :status => "201", :body => '{"a": "a", "b": "b"}')
-        User.stub(:new).and_return(user)
+      context "without a specified port" do
+        before :each do
+          FakeWeb.register_uri(:put, "http://api.example.com/user/5", :status => "201", :body => '{"a": "a", "b": "b"}')
+          User.stub(:new).and_return(user)
+        end
+
+        it "should return a object initialized with the response" do
+          User.put('http://api.example.com/user/5', {}).should == user
+        end
       end
 
-      it "should return a object initialized with the response" do
-        User.put('http://api.example.com/user/5', {}).should == user
+      context "with any specifications" do
+        before :each do
+          FakeWeb.register_uri(:put, "http://api.example.com:3001/user/5", :status => "201", :body => '{"a": "a", "b": "b"}')
+          User.stub(:new).and_return(user)
+        end
+
+        it "should return a object initialized with the response" do
+          User.put('http://api.example.com:3001/user/5', {}).should == user
+        end
       end
-    end
 
-    context "with a specified port" do
-      before :each do
-        FakeWeb.register_uri(:put, "http://api.example.com:3001/user/5", :status => "201", :body => '{"a": "a", "b": "b"}')
-        User.stub(:new).and_return(user)
+      context "with a specified remote object name" do
+        before :each do
+          FakeWeb.register_uri(:put, "http://api.example.com/user/5", :status => "201", :body => '{"user": {"a": "a", "b": "b"} }')
+          Admin.stub(:new).and_return(user)
+        end
+
+        it "should return a object initialized with the response" do
+          Admin.put('http://api.example.com/user/5', {}).should == user
+        end
       end
 
-      it "should return a object initialized with the response" do
-        User.put('http://api.example.com:3001/user/5', {}).should == user
+      context "with a collection" do
+        before :each do
+          FakeWeb.register_uri(:put, "http://api.example.com/user/5", :status => "201", :body => '{"users": [ {"a": "a", "b": "b"}, {"a": "a", "b": "b"} ] }')
+          User.stub(:new).and_return(user)
+        end
+
+        it "should return a collection of objects initialized with the response" do
+          User.put('http://api.example.com/user/5', {}).should == [ user, user ]
+        end
+      end
+
+      context "with a collection and a specified remote object name" do
+        before :each do
+          FakeWeb.register_uri(:put, "http://api.example.com/user/5", :status => "201", :body => '{"users": [ {"a": "a", "b": "b"}, {"a": "a", "b": "b"} ] }')
+          Admin.stub(:new).and_return(user)
+        end
+
+        it "should return a collection of objects initialized with the response" do
+          Admin.put('http://api.example.com/user/5', {}).should == [ user, user ]
+        end
       end
     end
   end

data/spec/api-client/parser_spec.rb

@@ -43,4 +43,24 @@ describe ApiClient::Parser do
       end
     end
   end
+
+  describe "#remote_object" do
+    context "on a class without remote object specification" do
+      it "should return the class name" do
+        User.remote_object.should == "user"
+      end
+    end
+
+    context "on a class with remote object specification" do
+      it "should return the class name" do
+        Admin.remote_object.should == "user"
+      end
+    end
+  end
+
+  describe "#remote_object=" do
+    it "should set the remote object name" do
+      Admin.remote_object.should == "user"
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -9,4 +9,10 @@ class User < ApiClient::Base
 
   validates_presence_of :a
   validates_inclusion_of :a, :in => %w(a A)
+end
+
+class Admin < ApiClient::Base
+  self.remote_object = "user"
+
+  attr_accessor :a, :b
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: api-client
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-12 00:00:00.000000000 Z
+date: 2012-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake