api-client 2.3.0 → 2.4.0

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## v2.4.0
+
+* Add support to multiple api entry points.
+* Added license to gemspec.
+
 ## v2.3.0
 
 * Add support to global mock of requisitions for testing purposes.

data/api-client.gemspec

@@ -13,6 +13,8 @@ Gem::Specification.new do |gem|
   gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   gem.require_paths = %w(lib)
 
+  gem.license = 'MIT'
+
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'webmock'
   gem.add_development_dependency 'rspec'

data/examples/controllers/book_controller.rb

@@ -0,0 +1,45 @@
+# It will works with respond_with.
+# Your action should looks like any other one: A model with a method call. =D
+class BookController < ApplicationController
+  # It will hit http://api.example.com/books with a get request
+  def index
+    @books = Book.all
+    respond_with(@books)
+  end
+
+  # It will initialize a new object based on the attribute accessors
+  def new
+    @book = Book.new
+    respond_with(@book)
+  end
+
+  # It will hit http://api.example.com/books with a post request
+  def create
+    @book = Book.create(:book => params[:book])
+    respond_with(@user)
+  end
+
+  # It will hit http://api.example.com/books/1 with a get request
+  def edit
+    @book = Book.find(params[:id])
+    respond_with(@book)
+  end
+
+  # It will hit http://api.example.com/books with a put request
+  def update
+    @book = Book.update_attributes({ :book => params[:book] })
+    respond_with(@book)
+  end
+
+  # It will hit http://api.example.com/books/1 with a get request
+  def show
+    @book = Book.find(params[:id])
+    respond_with(@book)
+  end
+
+  # It will hit http://api.example.com/books/1 with a delete request
+  def delete
+    @book = Book.destroy(params[:id])
+    respond_with(@book)
+  end
+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
 
@@ -25,9 +25,9 @@ class UserController < ApplicationController
     respond_with(@user)
   end
 
-  # It will hit http://api.example.com/users/1 with a patch request
+  # It will hit http://api.example.com/users with a patch request
   def update
-    @user = User.patch(params[:id], { :user => params[:user] })
+    @user = User.patch({ :user => params[:user] })
     respond_with(@user)
   end
 

data/lib/api-client/base.rb

@@ -42,6 +42,28 @@ module ApiClient
       false
     end
 
+
+    # Return the api name to be used by this model.
+    #
+    # @return [False] return the default api name.
+    def self.path
+      @path || :default
+    end
+
+    # Return the api name to be used by this model.
+    #
+    # @return [False] return the default api name.
+    def self.path=(path)
+      @path = path.to_sym
+    end
+
+    # Return the api name to be used by this model.
+    #
+    # @return [False] return the default api name.
+    def path
+      self.class.path
+    end
+
     # Return the resource path of the object on the api url.
     #
     # @return [String] the resource path on the api for this object.
@@ -129,7 +151,7 @@ module ApiClient
     # @param [String] url to get the collection.
     # @return [Collection] a collection of objects.
     def self.collection
-      ApiClient::Collection.new(self, self.resource_path).collection
+      ApiClient::Collection.new(self, self.path, self.resource_path).collection
     end
 
     class << self

data/lib/api-client/class_methods.rb

@@ -18,7 +18,7 @@ module ApiClient
     # @return [Base] the object initialized.
     def get(id, header = {})
       return build(:id => id) if ApiClient.config.mock
-      url = "#{ApiClient.config.path}#{self.resource_path}/#{id}"
+      url = "#{ApiClient.config.path[path]}#{self.resource_path}/#{id}"
       response = ApiClient::Dispatcher.get(url, header)
       params = ApiClient::Parser.response(response, url)
       build(params)
@@ -33,7 +33,7 @@ module ApiClient
     # @return [Base] the object initialized.
     def post(attributes, header = {})
       return build(attributes) if ApiClient.config.mock
-      url = "#{ApiClient.config.path}#{self.resource_path}"
+      url = "#{ApiClient.config.path[path]}#{self.resource_path}"
       response = ApiClient::Dispatcher.post(url, attributes, header)
       params = ApiClient::Parser.response(response, url)
       build(params)
@@ -43,13 +43,12 @@ module ApiClient
 
     # Make a put requisition and initialize an object with the response.
     #
-    # @param [Integer] id id of the object.
     # @param [Hash] attributes hash with the attributes to send.
     # @param [Hash] header hash with the header options.
     # @return [Base] the object initialized.
     def put(attributes, header = {})
       return build(attributes) if ApiClient.config.mock
-      url = "#{ApiClient.config.path}#{self.resource_path}"
+      url = "#{ApiClient.config.path[path]}#{self.resource_path}"
       response = ApiClient::Dispatcher.put(url, attributes, header)
       params = ApiClient::Parser.response(response, url)
       build(params)
@@ -59,13 +58,12 @@ module ApiClient
 
     # Make a patch requisition and initialize an object with the response.
     #
-    # @param [Integer] id id of the object.
     # @param [Hash] attributes hash with the attributes to send.
     # @param [Hash] header hash with the header options.
     # @return [Base] the object initialized.
     def patch(attributes, header = {})
       return build(attributes) if ApiClient.config.mock
-      url = "#{ApiClient.config.path}#{self.resource_path}"
+      url = "#{ApiClient.config.path[path]}#{self.resource_path}"
       response = ApiClient::Dispatcher.patch(url, attributes, header)
       params = ApiClient::Parser.response(response, url)
       build(params)
@@ -78,7 +76,7 @@ module ApiClient
     # @return [Base] the object initialized.
     def delete(id, header = {})
       return build(:id => id) if ApiClient.config.mock
-      url = "#{ApiClient.config.path}#{self.resource_path}/#{id}"
+      url = "#{ApiClient.config.path[path]}#{self.resource_path}/#{id}"
       response = ApiClient::Dispatcher.delete(url, header)
       params = ApiClient::Parser.response(response, url)
       build(params)

data/lib/api-client/collection.rb

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

data/lib/api-client/configuration.rb

@@ -8,8 +8,10 @@ module ApiClient
     #
     # @return [String] the api url.
     def path
-      raise Exceptions::NotConfigured unless @path.size > 1
-      @path
+      @paths.each do |name, path|
+        raise Exceptions::BadlyConfigured.new(name) unless path.size > 1
+      end
+      @paths
     end
 
     # Set the api url.
@@ -17,7 +19,21 @@ module ApiClient
     # @param [String] path api url.
     def path=(path)
       path = "#{path}/" unless path[path.size - 1, 1] == '/'
-      @path = path
+      @paths = { :default => path }
+    end
+
+    # Set several api urls.
+    #
+    # @param [Hash] hash with paths to api urls.
+    def paths=(paths = {})
+      @paths = {}
+      paths.each do |name, path|
+        if path[path.size - 1, 1] == '/'
+          @paths[name] = path
+        else
+          @paths[name] = "#{path}/"
+        end
+      end
     end
 
     # Set the default params of header.

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

@@ -9,8 +9,7 @@ module ApiClient::Dispatcher::NetHttp
   # @param [Hash] header attributes of the request.
   # @return [HTTP] the response object.
   def self.get(url, header = {})
-    initialize_connection(url)
-    call { @http.get(@uri.request_uri, ApiClient.config.header.merge(header)) }
+    dispatch(:get, url, { :header => header })
   end
 
   # Make a post request and returns it.
@@ -20,8 +19,7 @@ module ApiClient::Dispatcher::NetHttp
   # @param [Hash] header attributes of the request.
   # @return [HTTP] the response object.
   def self.post(url, args, header = {})
-    initialize_connection(url)
-    call { @http.post(@uri.request_uri, args.to_json, ApiClient.config.header.merge(header)) }
+    dispatch(:post, url, { :args => args, :header => header })
   end
 
   # Make a put request and returns it.
@@ -31,8 +29,7 @@ module ApiClient::Dispatcher::NetHttp
   # @param [Hash] header attributes of the request.
   # @return [HTTP] the response object.
   def self.put(url, args, header = {})
-    initialize_connection(url)
-    call { @http.put(@uri.request_uri, args.to_json, ApiClient.config.header.merge(header)) }
+    dispatch(:put, url, { :args => args, :header => header })
   end
 
   # Make a patch request and returns it.
@@ -42,8 +39,7 @@ module ApiClient::Dispatcher::NetHttp
   # @param [Hash] header attributes of the request.
   # @return [HTTP] the response object.
   def self.patch(url, args, header = {})
-    initialize_connection(url)
-    call { @http.patch(@uri.request_uri, args.to_json, ApiClient.config.header.merge(header)) }
+    dispatch(:patch, url, { :args => args, :header => header })
   end
 
   # Make a delete request and returns it.
@@ -52,22 +48,24 @@ module ApiClient::Dispatcher::NetHttp
   # @param [Hash] header attributes of the request.
   # @return [HTTP] the response object.
   def self.delete(url, header = {})
-    initialize_connection(url)
-    call { @http.delete(@uri.request_uri, header) }
+    dispatch(:delete, url, { :header => header })
   end
 
   protected
 
-  def self.initialize_connection(url = '')
-    @uri = URI(url)
-    @http = Net::HTTP.start(@uri.host, @uri.port)
-  end
-
-  def self.call
+  def self.dispatch(method, url, options = {})
+    args = options[:args].to_json if options[:args]
+    header = ApiClient.config.header.merge(options[:header])
+    uri = URI(url)
+    http = Net::HTTP.start(uri.host, uri.port)
     begin
-      yield
+      if args
+        http.send(method, uri.request_uri, args, header)
+      else
+        http.send(method, uri.request_uri, header)
+      end
     rescue Errno::ECONNREFUSED
       raise ApiClient::Exceptions::ConnectionRefused
     end
   end
-end
+end

data/lib/api-client/exceptions.rb

@@ -1,12 +1,12 @@
 # Namespace for the ApiClient Exceptions.
 module ApiClient::Exceptions
-  autoload :Generic, 'api-client/exceptions/generic'
-  autoload :NotFound, 'api-client/exceptions/not_found'
-  autoload :Unauthorized, 'api-client/exceptions/unauthorized'
+  autoload :BadGateway, 'api-client/exceptions/bad_gateway'
+  autoload :BadlyConfigured, 'api-client/exceptions/badly_configured'
+  autoload :ConnectionRefused, 'api-client/exceptions/connection_refused'
   autoload :Forbidden, 'api-client/exceptions/forbidden'
+  autoload :Generic, 'api-client/exceptions/generic'
   autoload :InternalServerError, 'api-client/exceptions/internal_server_error'
-  autoload :BadGateway, 'api-client/exceptions/bad_gateway'
+  autoload :NotFound, 'api-client/exceptions/not_found'
   autoload :ServiceUnavailable, 'api-client/exceptions/service_unavailable'
-  autoload :ConnectionRefused, 'api-client/exceptions/connection_refused'
-  autoload :NotConfigured, 'api-client/exceptions/not_configured'
+  autoload :Unauthorized, 'api-client/exceptions/unauthorized'
 end

data/lib/api-client/exceptions/{not_configured.rb → badly_configured.rb}

@@ -1,9 +1,9 @@
 # Exception for requests where the full path is not properly configured.
-class ApiClient::Exceptions::NotConfigured < StandardError
+class ApiClient::Exceptions::BadlyConfigured < StandardError
   # Initialize a new exception.
   #
   # @return [NotConfigured] a new exception.
-  def self.initialize
-    super('The api path is not properly configured!')
+  def self.initialize(name)
+    super("The api path #{name} is not properly configured!")
   end
 end

data/lib/api-client/instance_methods.rb

@@ -20,7 +20,7 @@ module ApiClient
     # @return [Base] the object updated.
     def get(header = {})
       return update({}) if ApiClient.config.mock
-      url = "#{ApiClient.config.path}#{self.class.resource_path}/#{id}"
+      url = "#{ApiClient.config.path[path]}#{self.class.resource_path}/#{id}"
       response = ApiClient::Dispatcher.get(url, header)
       attributes = ApiClient::Parser.response(response, url)
       update(attributes)
@@ -34,7 +34,7 @@ module ApiClient
     # @return [Base] the object updated.
     def post(header = {})
       return update({}) if ApiClient.config.mock
-      url = "#{ApiClient.config.path}#{self.class.resource_path}"
+      url = "#{ApiClient.config.path[path]}#{self.class.resource_path}"
       response = ApiClient::Dispatcher.post(url, self.to_hash, header)
       attributes = ApiClient::Parser.response(response, url)
       update(attributes)
@@ -48,7 +48,7 @@ module ApiClient
     # @return [Base] the object updated.
     def put(header = {})
       return update({}) if ApiClient.config.mock
-      url = "#{ApiClient.config.path}#{self.class.resource_path}"
+      url = "#{ApiClient.config.path[path]}#{self.class.resource_path}"
       response = ApiClient::Dispatcher.put(url, self.to_hash, header)
       attributes = ApiClient::Parser.response(response, url)
       update(attributes)
@@ -62,7 +62,7 @@ module ApiClient
     # @return [Base] the object updated.
     def patch(header = {})
       return update({}) if ApiClient.config.mock
-      url = "#{ApiClient.config.path}#{self.class.resource_path}"
+      url = "#{ApiClient.config.path[path]}#{self.class.resource_path}"
       response = ApiClient::Dispatcher.patch(url, self.to_hash, header)
       attributes = ApiClient::Parser.response(response, url)
       update(attributes)
@@ -74,7 +74,7 @@ module ApiClient
     # @return [Base] the object updated.
     def delete(header = {})
       return update({}) if ApiClient.config.mock
-      url = "#{ApiClient.config.path}#{self.class.resource_path}/#{id}"
+      url = "#{ApiClient.config.path[path]}#{self.class.resource_path}/#{id}"
       response = ApiClient::Dispatcher.delete(url, header)
       attributes = ApiClient::Parser.response(response, url)
       update(attributes)

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.3.0'
+  VERSION = '2.4.0'
 end

data/spec/api-client/base_spec.rb

@@ -116,6 +116,32 @@ describe ApiClient::Base do
     end
   end
 
+  describe '.path' do
+    it 'should return :default' do
+      User.path.should == :default
+    end
+  end
+
+  describe '.path=' do
+    before :each do
+      User.path = 'auth'
+    end
+
+    after :each do
+      User.path = 'default'
+    end
+
+    it 'should set the name of the api to use' do
+      User.path.should == :auth
+    end
+  end
+
+  describe '#path' do
+    it 'should return :default' do
+      User.new.path.should == :default
+    end
+  end
+
   describe '.associations=' do
     before :each do
       @group = Group.new(:members => [ :user => {:a => 'a'}], :owner => {:b => 'b'})
@@ -154,7 +180,7 @@ describe ApiClient::Base do
 
   describe '.collection' do
     before :each do
-      ApiClient::Collection.stub(:new).with(User, 'users').and_return(collection)
+      ApiClient::Collection.stub(:new).with(User, :default, 'users').and_return(collection)
       collection.stub(:collection => [ user, user ])
     end
 

data/spec/api-client/class_methods_spec.rb

@@ -55,19 +55,19 @@ describe ApiClient::ClassMethods do
 
     context '.put' do
       it 'should return an user' do
-        User.put(1, {}).should be_an_instance_of(User)
+        User.put({}).should be_an_instance_of(User)
       end
     end
 
     context '.update_attributes' do
       it 'should return an user' do
-        User.update_attributes(1, {}).should be_an_instance_of(User)
+        User.update_attributes({}).should be_an_instance_of(User)
       end
     end
 
     context '.patch' do
       it 'should return an user' do
-        User.patch(1, {}).should be_an_instance_of(User)
+        User.patch({}).should be_an_instance_of(User)
       end
     end
 

data/spec/api-client/collection_spec.rb

@@ -6,7 +6,7 @@ describe ApiClient::Collection do
   before :each do
     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, 'users')
+    @collection = ApiClient::Collection.new(User, :default, 'users')
   end
 
   it 'should include enumerable module' do

data/spec/api-client/configuration_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe ApiClient::Configuration do
   describe '#path' do
-    context 'when not configured' do
+    context 'when badly configured' do
       before :each do
         ApiClient.configure do |config|
           config.path = ''
@@ -10,7 +10,7 @@ describe ApiClient::Configuration do
       end
 
       it 'should raise an error' do
-        lambda { ApiClient.config.path }.should raise_error(ApiClient::Exceptions::NotConfigured)
+        expect { ApiClient.config.path }.to raise_error(ApiClient::Exceptions::BadlyConfigured)
       end
     end
 
@@ -34,7 +34,7 @@ describe ApiClient::Configuration do
       end
 
       it "should set it with a '/'" do
-        ApiClient.config.path.should == 'http://api.example.com/'
+        ApiClient.config.path.should == { :default => 'http://api.example.com/' }
       end
     end
 
@@ -44,11 +44,21 @@ describe ApiClient::Configuration do
       end
 
       it "should set it as passed" do
-        ApiClient.config.path.should == 'http://api.example.com/'
+        ApiClient.config.path.should == { :default => 'http://api.example.com/' }
       end
     end
   end
 
+  describe '#paths=' do
+    before :each do
+      ApiClient.config.paths = { :auth => 'http://auth.example.com', :default => 'http://panel.example.com' }
+    end
+
+    it 'should set several paths in a hash' do
+      ApiClient.config.path.should == { :auth => 'http://auth.example.com/', :default => 'http://panel.example.com/' }
+    end
+  end
+
   describe '#header' do
     context 'when not configured' do
       it 'should return a hash with configs for content_type only' do

data/spec/api-client/instance_methods_spec.rb

@@ -5,6 +5,9 @@ describe ApiClient::InstanceMethods do
 
   context 'with mock equal false' do
     before :each do
+      ApiClient.configure do |config|
+        config.path = 'http://api.example.com'
+      end
       stub_request(:any, 'http://api.example.com/users').to_return(:body => {'a' => 'b'}.to_json)
       stub_request(:any, 'http://api.example.com/users/1').to_return(:body => {'a' => 'b'}.to_json)
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: api-client
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-25 00:00:00.000000000 Z
+date: 2013-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -142,6 +142,7 @@ files:
 - api-client.gemspec
 - examples/config/initializers/api-client.rb
 - examples/controllers/application_controller.rb
+- examples/controllers/book_controller.rb
 - examples/controllers/user_controller.rb
 - examples/models/admin.rb
 - examples/models/author.rb
@@ -162,11 +163,11 @@ files:
 - lib/api-client/errors.rb
 - lib/api-client/exceptions.rb
 - lib/api-client/exceptions/bad_gateway.rb
+- lib/api-client/exceptions/badly_configured.rb
 - lib/api-client/exceptions/connection_refused.rb
 - lib/api-client/exceptions/forbidden.rb
 - lib/api-client/exceptions/generic.rb
 - lib/api-client/exceptions/internal_server_error.rb
-- lib/api-client/exceptions/not_configured.rb
 - lib/api-client/exceptions/not_found.rb
 - lib/api-client/exceptions/service_unavailable.rb
 - lib/api-client/exceptions/unauthorized.rb
@@ -185,7 +186,8 @@ files:
 - spec/api-client/parser_spec.rb
 - spec/spec_helper.rb
 homepage: 
-licenses: []
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -198,7 +200,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2067654543697834646
+      hash: -3601308474644028566
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -207,7 +209,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2067654543697834646
+      hash: -3601308474644028566
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25
@@ -217,6 +219,7 @@ summary: Client to make Api calls
 test_files:
 - examples/config/initializers/api-client.rb
 - examples/controllers/application_controller.rb
+- examples/controllers/book_controller.rb
 - examples/controllers/user_controller.rb
 - examples/models/admin.rb
 - examples/models/author.rb