api-client 1.10.0 → 2.0.0.rc1

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## v1.10.0
+
+* Add Support for api responses with collections
+
 ## v1.9.1
 
 * Fix for Net::Http on NotFound Exception

data/README.md

@@ -66,7 +66,15 @@ class User < ApiClient::Base
 Then, on your action, just put into it:
 
 ```ruby
-@user = User.get("http://api.example.com/user/3")
+@user = User.get(3)
+```
+
+where 3 is the id of the user.
+
+To a request that returns a collection of the object, use:
+
+```ruby
+@user = User.collection
 ```
 
 ## Advanced Usage
@@ -104,4 +112,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/api-client.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |gem|
   gem.summary     = %q{Client to make Api calls}
 
   gem.files         = `git ls-files`.split("\n")
-  gem.test_files    = `git ls-files -- {test,spec,features, gemfiles}/*`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features,examples,gemfiles}/*`.split("\n")
   gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   gem.require_paths = %w(lib)
 

data/examples/config/initializers/api-client.rb

@@ -0,0 +1,5 @@
+# Global Configuration
+# Api path
+ApiClient.configure do |config|
+  config.path = "http://api.example.com"
+end

data/examples/controllers/user_controller.rb

@@ -1,38 +1,45 @@
+# It will works with respond_with.
+# Your action should looks like any other one: A model with a method call. =D
 class UserController < ApplicationController
-  # It will works with respond_with.
-  # Your action should looks like any other one: A model with a method call. =D
+  # It will hit http://api.example.com/users with a get request
   def index
-    @users = User.get("api.example.com/users")
+    @users = User.collection
     respond_with(@users)
   end
 
+  # It will initialize a new object based on the attribute accessors
   def new
     @user = User.new
     respond_with(@user)
   end
 
+  # It will hit http://api.example.com/users with a post request
   def create
-    @user = User.post("api.example.com/users", :user => params[:user])
+    @user = User.post("", :user => params[:user])
     respond_with(@user)
   end
 
+  # It will hit http://api.example.com/users/1 with a get request
   def edit
-    @user = User.get("api.example.com/users/#{params[:id]}")
+    @user = User.get(params[:id])
     respond_with(@user)
   end
 
+  # It will hit http://api.example.com/users/1 with a patch request
   def update
-    @user = User.patch("api.example.com/users", { :id => params[:id], :user => params[:user]})
+    @user = User.patch("", { :id => params[:id], :user => params[:user] })
     respond_with(@user)
   end
 
+  # It will hit http://api.example.com/users/1 with a get request
   def show
-    @user = User.get("api.example.com/users/#{params[:id]}")
+    @user = User.get(params[:id])
     respond_with(@user)
   end
 
+  # It will hit http://api.example.com/users/1 with a delete request
   def delete
-    @user = User.delete("api.example.com/users/#{params[:id]}")
+    @user = User.delete(params[:id])
     respond_with(@user)
   end
-end
+end

data/examples/models/admin.rb

@@ -8,4 +8,4 @@ class Admin < ApiClient::Base
   # Validations will work as well
   validates :email, :presence => true, :uniqueness => true
   validates :password, :confirmation => true
-end
+end

data/examples/models/group.rb

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

data/examples/models/user.rb

@@ -7,4 +7,4 @@ class User < ApiClient::Base
   # Validations will work as well
   validates :email, :presence => true, :uniqueness => true
   validates :password, :confirmation => true
-end
+end

data/lib/api-client.rb

@@ -7,9 +7,10 @@ module ApiClient
   autoload :Configuration, 'api-client/configuration'
   autoload :Base, 'api-client/base'
   autoload :Collection, 'api-client/collection'
+  autoload :ClassMethods, 'api-client/class_methods'
+  autoload :InstanceMethods, 'api-client/instance_methods'
   autoload :Dispatcher, 'api-client/dispatcher'
   autoload :Parser, 'api-client/parser'
-  autoload :Builder, 'api-client/builder'
 
   # Configures global settings
   #   ApiClient.configure do |config|
@@ -27,4 +28,4 @@ module ApiClient
   configure do |config|
     config.path = ''
   end
-end
+end

data/lib/api-client/base.rb

@@ -12,7 +12,8 @@ module ApiClient
     include ActiveModel::Conversion
     extend ActiveModel::Naming
 
-    extend ApiClient::Builder
+    extend ApiClient::ClassMethods
+    include ApiClient::InstanceMethods
 
     # @return [Hash] the request response.
     attr_accessor :response
@@ -71,7 +72,7 @@ module ApiClient
     # Set methods to initialize associated objects.
     #
     # @param [Hash] association classes.
-    def self.associations(associations = {})
+    def self.associations=(associations = {})
       associations.each do |association, class_name|
         class_eval <<-EVAL
           def #{association.to_s}=(attributes = {})
@@ -86,7 +87,7 @@ module ApiClient
     end
 
     class << self
-      alias_method :association, :associations
+      alias_method :association=, :associations=
     end
 
     # Overwrite #attr_acessor method to save instance_variable names.
@@ -94,7 +95,7 @@ module ApiClient
     # @param [Array] instance variables.
     def self.attr_accessor(*vars)
       @attributes ||= []
-      @attributes.concat vars
+      @attributes.concat(vars)
       super
     end
 
@@ -119,8 +120,8 @@ module ApiClient
     #
     # @param [String] url to get the collection.
     # @return [Collection] a collection of objects.
-    def self.collection(url)
-      ApiClient::Collection.new(self, url).collection
+    def self.collection
+      ApiClient::Collection.new(self, self.path).collection
     end
 
     # Set the hash of errors, making keys symbolic.
@@ -129,12 +130,5 @@ module ApiClient
     def errors=(errs = {})
       errors.add_errors(Hash[errs.map{|(key,value)| [key.to_sym,value]}])
     end
-
-    protected
-
-    def self.method_missing(method, *args)
-      @response = ApiClient::Parser.response(ApiClient::Dispatcher.send(method, *args), *args[0])
-      build(self, @response)
-    end
   end
-end
+end

data/lib/api-client/class_methods.rb

@@ -0,0 +1,30 @@
+module ApiClient
+  # This module handles the logic to make an api call and initialize an object with the response.
+  module ClassMethods
+    # Initialize an object based on a hash of attributes.
+    #
+    # @param [Hash] attributes hash of attributes.
+    # @return [Base] the object initialized.
+    def build(params)
+      if params.key?(remote_object)
+        new(params[remote_object].merge(:response => params))
+      else
+        new(params.merge(:response => params))
+      end
+    end
+
+    # Make the api call and pass the parsed response to build to create a new object.
+    #
+    # @param [Symbol] method_name the name of the method.
+    # @param [Integer] id the id of the object.
+    # @param [Array] args an array of params.
+    # @return [Base] the object initialized.
+    def method_missing(method_name, id = nil, *args)
+      url = "#{ApiClient.config.path}#{self.path}"
+      "#{url}/#{id}" unless id.nil?
+      response = ApiClient::Dispatcher.send(method_name.to_sym, url, *args)
+      params = ApiClient::Parser.response(response, url)
+      build(params)
+    end
+  end
+end

data/lib/api-client/collection.rb

@@ -9,7 +9,8 @@ class ApiClient::Collection
   # @param [Class] The class to instantiate the objects.
   # @param [String] The url to get the data.
   # @return [Collection] the collection of objects.
-  def initialize(klass, url)
+  def initialize(klass, resource_path)
+    url = "#{ApiClient.config.path}#{resource_path}"
     @collection = ApiClient::Parser.response(ApiClient::Dispatcher.get(url), url)
     @collection.map! do |attributes|
       klass.new(attributes)

data/lib/api-client/instance_methods.rb

@@ -0,0 +1,37 @@
+module ApiClient
+  # This module handles the logic to make an api call and update the current object with the response.
+  module InstanceMethods
+    # Update an object based on a hash of attributes.
+    #
+    # @param [Hash] attributes hash of attributes.
+    # @return [Base] the updated object.
+    def update(params)
+      if params.key?(self.class.remote_object)
+        params[self.class.remote_object].each do |key, value|
+          instance_variable_set(key.to_sym, value)
+        end
+        instance_variable_set(response.to_sym, params[self.class.remote_object])
+      else
+        params.each do |key, value|
+          instance_variable_set("@#{key}", value)
+        end
+        instance_variable_set("@response", params)
+      end
+      self
+    end
+
+    # Make the api call and pass the parsed response to update the current object.
+    #
+    # @param [Symbol] method_name the name of the method.
+    # @param [Integer] id the id of the current object.
+    # @param [Array] args an array of params.
+    # @return [Base] the object updated.
+    def method_missing(method_name, id = nil, *args)
+      url = "#{ApiClient.config.path}#{self.class.path}"
+      "#{url}/#{id}" unless id.nil?
+      response = ApiClient::Dispatcher.send(method_name.to_sym, url, *args)
+      params = ApiClient::Parser.response(response, url)
+      update(params)
+    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.10.0"
+  VERSION = "2.0.0.rc1"
 end

data/spec/api-client/base_spec.rb

@@ -118,12 +118,12 @@ describe ApiClient::Base do
 
   describe "#collection" do
     before :each do
-      ApiClient::Collection.stub(:new).with(User, "http://api.example.com").and_return(collection)
+      ApiClient::Collection.stub(:new).with(User, "users").and_return(collection)
       collection.stub(:collection => [ user, user ])
     end
 
     it "should return a collection of objects" do
-      User.collection("http://api.example.com").should == [ user, user ]
+      User.collection.should == [ user, user ]
     end
   end
 
@@ -138,28 +138,33 @@ describe ApiClient::Base do
   end
 
   describe "requests" do
-    context "with an object as response" do
+    context "on the class" do
       before :each do
-        stub_request(:any, "http://api.example.com").to_return(:body => {"a" => "b"}.to_json)
+        stub_request(:any, "http://api.example.com/users").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)
+        User.get.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"}
+        User.get.response.should == {"a" => "b"}
       end
     end
 
-    context "with an array as response" do
+    context "on an object" do
       before :each do
-        stub_request(:any, "http://api.example.com").to_return(:body => [{"a" => "b"}].to_json)
+        stub_request(:any, "http://api.example.com/users").to_return(:body => {"a" => "b"}.to_json)
+        @user = User.new
       end
 
-      it "should return an array of instances" do
-        User.get("http://api.example.com").should be_an_instance_of(Array)
+      it "should return a new instance" do
+        @user.get.should be_an_instance_of(User)
+      end
+
+      it "should set the response on the instance" do
+        @user.get.response.should == {"a" => "b"}
       end
     end
   end
-end
+end

data/spec/api-client/collection_spec.rb

@@ -4,9 +4,9 @@ describe ApiClient::Collection do
   let(:user) { User.new }
 
   before :each do
-    stub_request(:get, "http://api.example.com").to_return(:body => [ {"a" => "b"}, {"a" => "b2"} ].to_json)
+    stub_request(:get, "http://api.example.com/users").to_return(:body => [ {"a" => "b"}, {"a" => "b2"} ].to_json)
     User.stub(:new => user)
-    @collection = ApiClient::Collection.new(User, "http://api.example.com")
+    @collection = ApiClient::Collection.new(User, "users")
   end
 
   it "should include enumerable module" do

data/spec/api-client/configuration_spec.rb

@@ -3,6 +3,12 @@ require 'spec_helper'
 describe ApiClient::Configuration do
   describe "#path" do
     describe "when not configured" do
+      before :each do
+        ApiClient.configure do |config|
+          config.path = ""
+        end
+      end
+
       it "should raise an error" do
         lambda { ApiClient.config.path }.should raise_error(ApiClient::Exceptions::NotConfigured)
       end
@@ -11,7 +17,7 @@ describe ApiClient::Configuration do
     describe "when properly configured" do
       before :each do
         ApiClient.configure do |config|
-          config.path = "api.example.com"
+          config.path = "http://api.example.com"
         end
       end
 
@@ -24,21 +30,21 @@ describe ApiClient::Configuration do
   describe "#path=" do
     describe "with a string without '/'" do
       before :each do
-        ApiClient.config.path = "api.example.com"
+        ApiClient.config.path = "http://api.example.com"
       end
 
       it "should set it with a '/'" do
-        ApiClient.config.path.should == "api.example.com/"
+        ApiClient.config.path.should == "http://api.example.com/"
       end
     end
 
     describe "with a string with '/'" do
       before :each do
-        ApiClient.config.path = "api.example.com/"
+        ApiClient.config.path = "http://api.example.com/"
       end
 
       it "should set it as passed" do
-        ApiClient.config.path.should == "api.example.com/"
+        ApiClient.config.path.should == "http://api.example.com/"
       end
     end
   end

data/spec/spec_helper.rb

@@ -21,11 +21,15 @@ class Admin < ApiClient::Base
 end
 
 class Post < ApiClient::Base
-  self.association({ :writer => "User" })
+  self.association = { :writer => "User" }
 
   attr_accessor :a
 end
 
 class Group < ApiClient::Base
-  self.associations({ :members => "User", :owner => "Admin" })
+  self.associations = { :members => "User", :owner => "Admin" }
 end
+
+ApiClient.configure do |config|
+  config.path = 'http://api.example.com'
+end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: api-client
 version: !ruby/object:Gem::Version
-  version: 1.10.0
-  prerelease: 
+  version: 2.0.0.rc1
+  prerelease: 6
 platform: ruby
 authors:
 - Paulo Henrique Lopes Ribeiro
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-04 00:00:00.000000000 Z
+date: 2013-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -140,6 +140,7 @@ files:
 - README.md
 - Rakefile
 - api-client.gemspec
+- examples/config/initializers/api-client.rb
 - examples/controllers/application_controller.rb
 - examples/controllers/user_controller.rb
 - examples/models/admin.rb
@@ -149,7 +150,7 @@ files:
 - gemfiles/Gemfile.typhoeus
 - lib/api-client.rb
 - lib/api-client/base.rb
-- lib/api-client/builder.rb
+- lib/api-client/class_methods.rb
 - lib/api-client/collection.rb
 - lib/api-client/configuration.rb
 - lib/api-client/dispatcher.rb
@@ -166,6 +167,7 @@ files:
 - lib/api-client/exceptions/not_found.rb
 - lib/api-client/exceptions/service_unavailable.rb
 - lib/api-client/exceptions/unauthorized.rb
+- lib/api-client/instance_methods.rb
 - lib/api-client/net/http.rb
 - lib/api-client/parser.rb
 - lib/api-client/version.rb
@@ -190,16 +192,13 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4163480247094767209
+      hash: 3711980256019663374
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
-      segments:
-      - 0
-      hash: 4163480247094767209
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25

data/lib/api-client/builder.rb

@@ -1,12 +0,0 @@
-module ApiClient
-  module Builder
-    def build(object, params)
-      case true
-        when params.instance_of?(Array) then return params.map { |a| new(a.merge(:response => params)) }
-        when params.key?(remote_object) then return new(params[remote_object].merge(:response => params))
-        when params.key?(remote_object.pluralize) then return params[remote_object.pluralize].map { |a| new(a.merge(:response => params)) }
-        else return new(params.merge(:response => params))
-      end
-    end
-  end
-end