api-client 1.5.4 → 1.6.0

data/.travis.yml

@@ -1,2 +1,6 @@
 rvm:
-  - 1.9.3
+  - 1.9.2
+  - 1.9.3
+gemfile:
+  - gemfiles/Gemfile.net_http
+  - gemfiles/Gemfile.typhoeus

data/CHANGELOG.md

@@ -1,16 +1,8 @@
 # CHANGELOG
 
-## v1.5.3
+## v1.5.1 to v1.5.4
 
-* Improving #unique_messages method to work with #to_sentence from ActiveSupport.
-
-## v1.5.2
-
-* Fixed return from #add_errors.
-
-## v1.5.1
-
-* Fixed Error Setter for erros from an external API.
+* Fixed Bug with errors from external API and self.
 
 ## v1.5.0
 

data/README.md

@@ -60,7 +60,6 @@ end
 
 ## TODO
    * Add Support to Typhoeus and Faraday
-   * Proper Treatment for validation errors
    * Add more Response Handlers
 
 ## Contributing

data/api-client.gemspec

@@ -10,12 +10,12 @@ 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}/*`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features, gemfiles}/*`.split("\n")
   gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   gem.require_paths = %w(lib)
 
   gem.add_development_dependency "rake"
-  gem.add_development_dependency "fakeweb"
+  gem.add_development_dependency "webmock"
   gem.add_development_dependency "rspec"
   gem.add_development_dependency "yard"
 

data/gemfiles/Gemfile.net_http

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec :path => '../'

data/gemfiles/Gemfile.typhoeus

@@ -0,0 +1,5 @@
+source :rubygems
+
+gem 'typhoeus', '0.4.2'
+
+gemspec :path => '../'

data/lib/api-client/dispatcher.rb

@@ -1,72 +1,13 @@
-require "net/http"
-
-# ApiClient::Dispatcher provides methods to make requests using the native ruby library 'net/http'
+# ApiClient::Dispatcher provides methods to make requests
 module ApiClient::Dispatcher
-  # Make a get request and returns it.
-  #
-  # @param [String] url of the api request.
-  # @param [Hash] header attributes of the request.
-  # @return [HTTP] the response object.
-  def self.get(url, header = {})
-    initialize_connection(url)
-    call { @http.get(@uri.path, header) }
-  end
-
-  # Make a post request and returns it.
-  #
-  # @param [String] url of the api request.
-  # @param [Hash] args attributes of object.
-  # @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.path, args.to_json, { 'Content-Type' => 'application/json' }.merge(header)) }
-  end
-
-  # Make a put request and returns it.
-  #
-  # @param [String] url of the api request.
-  # @param [Hash] args attributes of object.
-  # @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.path, args.to_json, { 'Content-Type' => 'application/json' }.merge(header)) }
-  end
-
-  # Make a patch request and returns it.
-  #
-  # @param [String] url of the api request.
-  # @param [Hash] args attributes of object.
-  # @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.path, args.to_json, { 'Content-Type' => 'application/json' }.merge(header)) }
-  end
-
-  # Make a delete request and returns it.
-  #
-  # @param [String] url of the api request.
-  # @param [Hash] header attributes of the request.
-  # @return [HTTP] the response object.
-  def self.delete(url, header = {})
-    initialize_connection(url)
-    call { @http.delete(@uri.path, header) }
-  end
-
-  protected
-
-  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
+  autoload :Typhoeus, 'api-client/dispatcher/typhoeus'
+  autoload :NetHttp, 'api-client/dispatcher/net-http'
+
+  def self.method_missing(method, *args)
+    if defined?(::Typhoeus)
+        Typhoeus.send(method, *args)
+    else
+        NetHttp.send(method, *args)
     end
   end
 end

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

@@ -0,0 +1,73 @@
+require "net/http"
+require "api-client/net/http" unless Net::HTTP.new("").respond_to?(:patch)
+
+# ApiClient::Dispatcher provides methods to make requests using the native ruby library 'net/http'
+module ApiClient::Dispatcher::NetHttp
+  # Make a get request and returns it.
+  #
+  # @param [String] url of the api request.
+  # @param [Hash] header attributes of the request.
+  # @return [HTTP] the response object.
+  def self.get(url, header = {})
+    initialize_connection(url)
+    call { @http.get(@uri.path, { 'Content-Type' => 'application/json' }.merge(header)) }
+  end
+
+  # Make a post request and returns it.
+  #
+  # @param [String] url of the api request.
+  # @param [Hash] args attributes of object.
+  # @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.path, args.to_json, { 'Content-Type' => 'application/json' }.merge(header)) }
+  end
+
+  # Make a put request and returns it.
+  #
+  # @param [String] url of the api request.
+  # @param [Hash] args attributes of object.
+  # @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.path, args.to_json, { 'Content-Type' => 'application/json' }.merge(header)) }
+  end
+
+  # Make a patch request and returns it.
+  #
+  # @param [String] url of the api request.
+  # @param [Hash] args attributes of object.
+  # @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.path, args.to_json, { 'Content-Type' => 'application/json' }.merge(header)) }
+  end
+
+  # Make a delete request and returns it.
+  #
+  # @param [String] url of the api request.
+  # @param [Hash] header attributes of the request.
+  # @return [HTTP] the response object.
+  def self.delete(url, header = {})
+    initialize_connection(url)
+    call { @http.delete(@uri.path, header) }
+  end
+
+  protected
+
+  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/dispatcher/typhoeus.rb

@@ -0,0 +1,52 @@
+require 'typhoeus'
+
+# ApiClient::Dispatcher provides methods to make requests using typhoeus
+module ApiClient::Dispatcher::Typhoeus
+  # Make a get request and returns it.
+  #
+  # @param [String] url of the api request.
+  # @param [Hash] header attributes of the request.
+  # @return [Typhoeus::Request] the response object.
+  def self.get(url, header = {})
+    ::Typhoeus::Request.get(url, :headers => header)
+  end
+
+  # Make a post request and returns it.
+  #
+  # @param [String] url of the api request.
+  # @param [Hash] args attributes of object.
+  # @param [Hash] header attributes of the request.
+  # @return [Typhoeus::Request] the response object.
+  def self.post(url, args, header = {})
+    ::Typhoeus::Request.post(url, :params => args, :headers => header)
+  end
+
+  # Make a put request and returns it.
+  #
+  # @param [String] url of the api request.
+  # @param [Hash] args attributes of object.
+  # @param [Hash] header attributes of the request.
+  # @return [Typhoeus::Request] the response object.
+  def self.put(url, args, header = {})
+    ::Typhoeus::Request.put(url, :params => args, :headers => header)
+  end
+
+  # Make a patch request and returns it.
+  #
+  # @param [String] url of the api request.
+  # @param [Hash] args attributes of object.
+  # @param [Hash] header attributes of the request.
+  # @return [Typhoeus::Request] the response object.
+  def self.patch(url, args, header = {})
+    ::Typhoeus::Request.patch(url, :params => args, :headers => header)
+  end
+
+  # Make a delete request and returns it.
+  #
+  # @param [String] url of the api request.
+  # @param [Hash] header attributes of the request.
+  # @return [Typhoeus::Request] the response object.
+  def self.delete(url, header = {})
+    ::Typhoeus::Request.delete(url, :headers => header)
+  end
+end

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

@@ -0,0 +1,29 @@
+module Net
+  class HTTP
+    # Sends a PATCH request to the +path+ and gets a response,
+    # as an HTTPResponse object.
+    def patch(path, data, initheader = nil, dest = nil, &block) # :yield: +body_segment+
+      res = nil
+      request(Patch.new(path, initheader), data) {|r|
+        r.read_body dest, &block
+        res = r
+      }
+      unless @newimpl
+        res.value
+        return res, res.body
+      end
+      res
+    end
+
+    #
+    # PATCH method --- RFC5789
+    #
+
+    # See Net::HTTPGenericRequest for attributes and methods.
+    class Patch < HTTPRequest
+      METHOD = 'PATCH'
+      REQUEST_HAS_BODY = true
+      RESPONSE_HAS_BODY = true
+    end
+  end
+end

data/lib/api-client/parser.rb

@@ -5,27 +5,27 @@ 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)
+    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
+    rescue JSON::ParserError, TypeError
       object = {}
     end
-    raise_exception(response.code)
     object
   end
 
   protected
 
   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
+    case code.to_i
+      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

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.5.4"
+  VERSION = "1.6.0"
 end

data/spec/api-client/dispatcher_spec.rb

@@ -1,103 +1,37 @@
 require 'spec_helper'
 
 describe ApiClient::Dispatcher do
-  describe "#get" do
-    before :each do
-      FakeWeb.register_uri(:get, "http://api.example.com/user/5", :status => "200")
-    end
+  before :each do
+    stub_request(:any, "http://api.example.com/user/5").to_return(:body => "asd")
+  end
 
+  describe "#get" do
     it "should return the request" do
-      ApiClient::Dispatcher.get("http://api.example.com/user/5", {}).should be_a(Net::HTTPOK)
-    end
-
-    context "when connection is refused" do
-      before :each do
-        FakeWeb.register_uri(:get, "http://api.example.com/user/5", :exception => Errno::ECONNREFUSED)
-      end
-
-      it "should return a ConnectionRefused exception" do
-        lambda { ApiClient::Dispatcher.get('http://api.example.com/user/5') }.should raise_error(ApiClient::Exceptions::ConnectionRefused)
-      end
+      ApiClient::Dispatcher.get("http://api.example.com/user/5", {}).body.should == ("asd")
     end
   end
 
   describe "#post" do
-    before :each do
-      FakeWeb.register_uri(:post, "http://api.example.com/user/5", :status => "201")
-    end
-
     it "should return the request" do
-      ApiClient::Dispatcher.post("http://api.example.com/user/5", {}, {}).should be_a(Net::HTTPCreated)
-    end
-
-    context "when connection is refused" do
-      before :each do
-        FakeWeb.register_uri(:post, "http://api.example.com/user/5", :exception => Errno::ECONNREFUSED)
-      end
-
-      it "should return a ConnectionRefused exception" do
-        lambda { ApiClient::Dispatcher.post('http://api.example.com/user/5', {}) }.should raise_error(ApiClient::Exceptions::ConnectionRefused)
-      end
+      ApiClient::Dispatcher.post("http://api.example.com/user/5", {}, {}).body.should == ("asd")
     end
   end
 
   describe "#put" do
-    before :each do
-      FakeWeb.register_uri(:put, "http://api.example.com/user/5", :status => "200")
-    end
-
     it "should return the request" do
-      ApiClient::Dispatcher.put("http://api.example.com/user/5", {}, {}).should be_a(Net::HTTPOK)
-    end
-
-    context "when connection is refused" do
-      before :each do
-        FakeWeb.register_uri(:put, "http://api.example.com/user/5", :exception => Errno::ECONNREFUSED)
-      end
-
-      it "should return a ConnectionRefused exception" do
-        lambda { ApiClient::Dispatcher.put('http://api.example.com/user/5', {}) }.should raise_error(ApiClient::Exceptions::ConnectionRefused)
-      end
+      ApiClient::Dispatcher.put("http://api.example.com/user/5", {}, {}).body.should == ("asd")
     end
   end
 
   describe "#patch" do
-    before :each do
-      FakeWeb.register_uri(:patch, "http://api.example.com/user/5", :status => "200")
-    end
-
     it "should return the request" do
-      ApiClient::Dispatcher.patch("http://api.example.com/user/5", {}, {}).should be_a(Net::HTTPOK)
-    end
-
-    context "when connection is refused" do
-      before :each do
-        FakeWeb.register_uri(:patch, "http://api.example.com/user/5", :exception => Errno::ECONNREFUSED)
-      end
-
-      it "should return a ConnectionRefused exception" do
-        lambda { ApiClient::Dispatcher.patch('http://api.example.com/user/5', {}) }.should raise_error(ApiClient::Exceptions::ConnectionRefused)
-      end
+      ApiClient::Dispatcher.patch("http://api.example.com/user/5", {}, {}).body.should == ("asd")
     end
-  end
+  end if ApiClient::Dispatcher.respond_to?(:patch)
 
   describe "#delete" do
-    before :each do
-      FakeWeb.register_uri(:delete, "http://api.example.com/user/5", :status => "200")
-    end
-
     it "should return the request" do
-      ApiClient::Dispatcher.delete("http://api.example.com/user/5", {}).should be_a(Net::HTTPOK)
-    end
-
-    context "when connection is refused" do
-      before :each do
-        FakeWeb.register_uri(:delete, "http://api.example.com/user/5", :exception => Errno::ECONNREFUSED)
-      end
-
-      it "should return a ConnectionRefused exception" do
-        lambda { ApiClient::Dispatcher.delete('http://api.example.com/user/5', {}) }.should raise_error(ApiClient::Exceptions::ConnectionRefused)
-      end
+      ApiClient::Dispatcher.delete("http://api.example.com/user/5", {}).body.should == ("asd")
     end
   end
 end

data/spec/api-client/parser_spec.rb

@@ -9,9 +9,7 @@ describe ApiClient::Parser do
     context "with a valid json response" do
       context "without a root node" do
         before :each do
-          FakeWeb.register_uri(:post, "http://api.example.com/user/5",
-                               :body => { :a => :b }.to_json,
-                               :status => "201")
+          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
 
@@ -22,9 +20,7 @@ describe ApiClient::Parser do
 
       context "with a root node" do
         before :each do
-          FakeWeb.register_uri(:post, "http://api.example.com/user/5",
-                               :body => { :base => { :a => :b } }.to_json,
-                               :status => "201")
+          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
 
@@ -36,9 +32,7 @@ describe ApiClient::Parser do
 
     context "with a invalid json response" do
       before :each do
-        FakeWeb.register_uri(:post, "http://api.example.com/user/5",
-                             :body => "wrong",
-                             :status => "201")
+        stub_request(:post, "http://api.example.com/user/5").to_return(:body => "wrong", :status => "201")
         @response = ApiClient::Dispatcher.post('http://api.example.com/user/5', {}, {})
       end
 
@@ -50,7 +44,7 @@ describe ApiClient::Parser do
     context "with a response code of" do
       context "401" do
         before :each do
-          FakeWeb.register_uri(:get, "http://api.example.com/user/5", :status => "401")
+          stub_request(:get, "http://api.example.com/user/5").to_return(:status => 401)
           @response = ApiClient::Dispatcher.get('http://api.example.com/user/5')
         end
 
@@ -61,7 +55,7 @@ describe ApiClient::Parser do
 
       context "403" do
         before :each do
-          FakeWeb.register_uri(:get, "http://api.example.com/user/5", :status => "403")
+          stub_request(:get, "http://api.example.com/user/5").to_return(:status => 403)
           @response = ApiClient::Dispatcher.get('http://api.example.com/user/5')
         end
 
@@ -72,7 +66,7 @@ describe ApiClient::Parser do
 
       context "404" do
         before :each do
-          FakeWeb.register_uri(:get, "http://api.example.com/user/5", :status => "404")
+          stub_request(:get, "http://api.example.com/user/5").to_return(:status => 404)
           @response = ApiClient::Dispatcher.get('http://api.example.com/user/5')
         end
 
@@ -83,7 +77,7 @@ describe ApiClient::Parser do
 
       context "500" do
         before :each do
-          FakeWeb.register_uri(:get, "http://api.example.com/user/5", :status => "500")
+          stub_request(:get, "http://api.example.com/user/5").to_return(:status => 500)
           @response = ApiClient::Dispatcher.get('http://api.example.com/user/5')
         end
 
@@ -94,7 +88,7 @@ describe ApiClient::Parser do
 
       context "502" do
         before :each do
-          FakeWeb.register_uri(:get, "http://api.example.com/user/5", :status => "502")
+          stub_request(:get, "http://api.example.com/user/5").to_return(:status => 502)
           @response = ApiClient::Dispatcher.get('http://api.example.com/user/5')
         end
 
@@ -105,7 +99,7 @@ describe ApiClient::Parser do
 
       context "503" do
         before :each do
-          FakeWeb.register_uri(:get, "http://api.example.com/user/5", :status => "503")
+          stub_request(:get, "http://api.example.com/user/5").to_return(:status => 503)
           @response = ApiClient::Dispatcher.get('http://api.example.com/user/5')
         end
 

data/spec/spec_helper.rb

@@ -1,5 +1,5 @@
 require "rspec"
-require "fakeweb"
+require 'webmock/rspec'
 require "json"
 
 require File.dirname(__FILE__) + "/../lib/api-client"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: api-client
 version: !ruby/object:Gem::Version
-  version: 1.5.4
+  version: 1.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-05 00:00:00.000000000 Z
+date: 2012-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -28,7 +28,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: fakeweb
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -126,9 +126,13 @@ files:
 - examples/controllers/application_controller.rb
 - examples/controllers/user_controller.rb
 - examples/models/user.rb
+- gemfiles/Gemfile.net_http
+- gemfiles/Gemfile.typhoeus
 - lib/api-client.rb
 - lib/api-client/base.rb
 - lib/api-client/dispatcher.rb
+- lib/api-client/dispatcher/net-http.rb
+- lib/api-client/dispatcher/typhoeus.rb
 - lib/api-client/errors.rb
 - lib/api-client/exceptions.rb
 - lib/api-client/exceptions/bad_gateway.rb
@@ -139,6 +143,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/net/http.rb
 - lib/api-client/parser.rb
 - lib/api-client/version.rb
 - spec/api-client/base_spec.rb
@@ -158,12 +163,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -3045857671343172453
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -3045857671343172453
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24