active_rest_client 0.9.66 → 0.9.67

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ccfdfcc6a1a86c7b5715f7666c383abf9d99481b
-  data.tar.gz: 678bcfbdab8714ce08456de2a1d1bd569017eba6
+  metadata.gz: bad00208370951aee8feea5b4880654dc658d124
+  data.tar.gz: 4fb5e5c094fe3482f1ac9ad24955bce475e0dd0d
 SHA512:
-  metadata.gz: cffb6450b43e6346772df324e73bbdb23b7db4feb47c9b305c55a3db41c9414d04f308438d388e55d33d1d8f273946dd9711a008b671339d1fa58778da930e74
-  data.tar.gz: 2140ca597671d258f351bcd040e827629f9ad9a2c3e92c726e75f509d05cdf782ec87f9837349bb3c6897a9ed34478eccda6240823281e51d8e7c01ff6fa8778
+  metadata.gz: 104fdb894bda35c42fe84a536b546b17aeeba7fb667bb0facf020cc1ee3b77c5b5c8c79c9e22c24c81a2824e9cafc7003a56280a2a7f735fe4083ac21aa2f0f2
+  data.tar.gz: 21c02661cea31ccff13ee10245396b1459c541aa5f9fa5fab70b01420b88ba5319473f8b4aeae9d67c90e8e9a0278acdfacfa51a379477f0962f1b0d74f90c3f

data/README.md

@@ -104,6 +104,23 @@ puts @tv.properties["3d"]
 
 ## Advanced Features
 
+### Configuration
+
+ActiveRestClient uses Faraday to allow switching HTTP backends, the default is Patron. To change the used backend just set it in the class by setting `adapter` to a Faraday supported adapter symbol.
+
+```ruby
+ActiveRestClient::Base.adapter = :net_http
+```
+
+If you want more control you can pass a complete configuration block. For available config variables look into the Faraday documentation.
+
+```ruby
+ActiveRestClient::Base.faraday_config do |faraday|
+  faraday.adapter(:net_http)
+  faraday.options.timeout       = 10
+  faraday.headers['User-Agent'] = "ActiveRestClient/#{ActiveRestClient::VERSION}"
+end
+````
 ### Associations
 
 There are two types of association.  One assumes when you call a method you actually want it to call the method on a separate class (as that class has other methods that are useful).  The other is lazy loading related classes from a separate URL.

data/active_rest_client.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "webmock"
   spec.add_development_dependency "rspec_junit_formatter"
   spec.add_development_dependency "simplecov"
   spec.add_development_dependency "simplecov-rcov"
@@ -31,5 +32,6 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency "oj", "=2.1.4" # 2.1.7 breaks under linux
   spec.add_runtime_dependency "activesupport"
-  spec.add_runtime_dependency "patron", '=0.4.9' # 0.4.18 breaks against Curl v0.7.15
+  spec.add_runtime_dependency "faraday"
+  spec.add_runtime_dependency "patron", ">= 0.4.9" # 0.4.18 breaks against Curl v0.7.15 but works with webmock
 end

data/lib/active_rest_client/configuration.rb

@@ -23,6 +23,23 @@ module ActiveRestClient
         @@base_url = value
       end
 
+      def adapter=(adapter)
+        ActiveRestClient::Logger.info "\033[1;4;32m#{name}\033[0m Adapter set to be #{adapter}"
+        @adapter = adapter
+      end
+
+      def adapter
+        @adapter ||= :patron
+      end
+
+      def faraday_config(&block)
+        if block
+          @faraday_config = block
+        else
+          @faraday_config ||= default_faraday_config
+        end
+      end
+
       def lazy_load!
         @lazy_load = true
       end
@@ -57,6 +74,21 @@ module ActiveRestClient
         @@base_url        = nil
         @whiny_missing    = nil
         @lazy_load        = false
+        @faraday_config   = default_faraday_config
+        @adapter          = :patron
+      end
+
+      private
+
+      def default_faraday_config
+        Proc.new do |faraday|
+          faraday.adapter(adapter)
+          faraday.options.timeout       = 10
+          faraday.options.open_timeout  = 10
+          faraday.headers['User-Agent'] = "ActiveRestClient/#{ActiveRestClient::VERSION}"
+          faraday.headers['Connection'] = "Keep-Alive"
+          faraday.headers['Accept']     = "application/json"
+        end
       end
     end
 

data/lib/active_rest_client/connection.rb

@@ -1,4 +1,4 @@
-require 'patron'
+require 'faraday'
 
 module ActiveRestClient
 
@@ -10,25 +10,11 @@ module ActiveRestClient
 
     def initialize(base_url)
       @base_url                      = base_url
-      @session                       = Patron::Session.new
-      @session.timeout               = 10
-      @session.connect_timeout       = 10
-      @session.base_url              = base_url
-      @session.insecure              = true
-      @session.headers['User-Agent'] = "ActiveRestClient/#{ActiveRestClient::VERSION}"
-      @session.headers['Connection'] = "Keep-Alive"
-      @session.headers['Accept']     = "application/json"
+      @session                       = new_session
     end
 
     def reconnect
-      session          = Patron::Session.new
-      session.timeout  = @session.timeout
-      session.base_url = @session.base_url
-      session.insecure              = true
-      @session.headers.each do |k,v|
-        session.headers[k] = v
-      end
-      @session         = session
+      @session         = new_session
     end
 
     def headers
@@ -37,40 +23,56 @@ module ActiveRestClient
 
     def make_safe_request(path, &block)
       block.call
-    rescue Patron::TimeoutError
+    rescue Faraday::TimeoutError
       raise ActiveRestClient::TimeoutException.new("Timed out getting #{@base_url}#{path}")
-    rescue Patron::ConnectionFailed
+    rescue Faraday::ConnectionFailed
       begin
         reconnect
         block.call
-      rescue Patron::ConnectionFailed
+      rescue Faraday::ConnectionFailed
         raise ActiveRestClient::ConnectionFailedException.new("Unable to connect to #{@base_url}#{path}")
       end
     end
 
     def get(path, headers={})
       make_safe_request(path) do
-        @session.get(path, headers)
+        @session.get(path) do |req|
+          req.headers = headers
+        end
       end
     end
 
     def put(path, data, headers={})
       make_safe_request(path) do
-        @session.put(path, data, headers)
+        @session.put(path) do |req|
+          req.headers = headers
+          req.body = data
+        end
       end
     end
 
     def post(path, data, headers={})
       make_safe_request(path) do
-        @session.post(path, data, headers)
+        @session.post(path) do |req|
+          req.headers = headers
+          req.body = data
+        end
       end
     end
 
     def delete(path, headers={})
       make_safe_request(path) do
-        @session.delete(path, headers)
+        @session.delete(path) do |req|
+          req.headers = headers
+        end
       end
     end
 
+    private
+
+    def new_session
+      Faraday.new({url: @base_url}, &ActiveRestClient::Base.faraday_config)
+    end
+
   end
 end

data/lib/active_rest_client/version.rb

@@ -1,3 +1,3 @@
 module ActiveRestClient
-  VERSION = "0.9.66"
+  VERSION = "0.9.67"
 end

data/spec/lib/configuration_spec.rb

@@ -101,5 +101,30 @@ describe ActiveRestClient::Configuration do
     expect{ ConfigurationExample.proxy.respond_to?(:length) }.to be_true
   end
 
+  describe "faraday_config" do
+    let(:faraday_double){double(:faraday).as_null_object}
+
+    it "should use default adapter if no other block set" do
+      faraday_double.should_receive(:adapter).with(:patron)
+      ConfigurationExample.faraday_config.call(faraday_double)
+    end
+
+    it "should us set adapter if no other block set" do
+      ConfigurationExample.adapter = :net_http
+
+      faraday_double.should_receive(:adapter).with(:net_http)
+
+      ConfigurationExample.faraday_config.call(faraday_double)
+    end
+
+    it "should use the adapter of the passed in faraday_config block" do
+      ConfigurationExample.faraday_config {|faraday| faraday.adapter(:rack)}
+
+      faraday_double.should_receive(:adapter).with(:rack)
+
+      ConfigurationExample.faraday_config.call(faraday_double)
+    end
+
+  end
 
 end

data/spec/lib/connection_spec.rb

@@ -5,68 +5,53 @@ describe ActiveRestClient::Connection do
     @connection = ActiveRestClient::Connection.new("http://www.example.com")
   end
 
-  it "should contain a patron session" do
-    expect(@connection.session).to be_a_kind_of(Patron::Session)
+  it "should contain a Farday connection" do
+    expect(@connection.session).to be_a_kind_of(Faraday::Connection)
   end
 
-  it "should set the Base URL for Patron to be the one passed in" do
-    expect(@connection.session.base_url).to eq("http://www.example.com")
+  it "should set the Base URL to be the one passed in" do
+    expect(@connection.session.url_prefix.to_s).to eq("http://www.example.com/")
   end
 
-  it "should set a user agent for the Patron session" do
+  it "should set a user agent for the session" do
     expect(@connection.headers["User-Agent"]).to match(/^ActiveRestClient\/[0-9.]+$/)
   end
 
-  it "should try to Keep-Alive Patron session connections" do
+  it "should try to Keep-Alive session connections" do
     expect(@connection.headers["Connection"]).to match(/Keep-Alive/)
   end
 
-  it "should pass a GET request through to Patron" do
-    @connection.session = double(Patron::Session)
-    @connection.session.stub(:get).with("/foo", {}).and_return(OpenStruct.new(body:"{result:true}"))
+  it "should pass a GET request through to Faraday" do
+    stub_request(:get, "www.example.com/foo").to_return(body: "{result:true}")
     result = @connection.get("/foo")
     expect(result.body).to eq("{result:true}")
   end
 
-  it "should pass a PUT request through to Patron" do
-    @connection.session = double(Patron::Session)
-    allow(@connection.session).to receive(:put).with("/foo", "body", {}).and_return(OpenStruct.new(body:"{result:true}"))
+  it "should pass a PUT request through to Faraday" do
+    stub_request(:put, "www.example.com/foo").with(body: "body").to_return(body: "{result:true}")
     result = @connection.put("/foo", "body")
     expect(result.body).to eq("{result:true}")
   end
 
-  it "should pass a POST request through to Patron" do
-    @connection.session = double(Patron::Session)
-    @connection.session.stub(:post).with("/foo", "body", {}).and_return(OpenStruct.new(body:"{result:true}"))
+  it "should pass a POST request through to Faraday" do
+    stub_request(:post, "www.example.com/foo").with(body: "body").to_return(body: "{result:true}")
     result = @connection.post("/foo", "body")
     expect(result.body).to eq("{result:true}")
   end
 
-  it "should pass a DELETE request through to Patron" do
-    @connection.session = double(Patron::Session)
-    @connection.session.stub(:delete).with("/foo", {}).and_return(OpenStruct.new(body:"{result:true}"))
+  it "should pass a DELETE request through to Faraday" do
+    stub_request(:delete, "www.example.com/foo").to_return(body: "{result:true}")
     result = @connection.delete("/foo")
     expect(result.body).to eq("{result:true}")
   end
 
   it "should retry once in the event of a connection failed" do
-    @times_called = 0
-    Patron::Session.any_instance.stub(:get).and_return do
-      raise Patron::ConnectionFailed.new("Foo") if (@times_called += 1) == 1
-    end
-    expect { @connection.get("/foo") }.to_not raise_error
-  end
-
-  it "should not retry more than once in the event of a connection failed" do
-    @times_called = 0
-    Patron::Session.any_instance.stub(:get).and_return do
-      raise Patron::ConnectionFailed.new("Foo")
-    end
+    stub_request(:get, "www.example.com/foo").to_raise(Faraday::ConnectionFailed.new("Foo"))
     expect { @connection.get("/foo") }.to raise_error(ActiveRestClient::ConnectionFailedException)
   end
 
   it "should raise an exception on timeout" do
-    Patron::Session.any_instance.stub(:get).and_raise Patron::TimeoutError.new("Foo")
+    stub_request(:get, "www.example.com/foo").to_timeout
     expect { @connection.get("/foo") }.to raise_error(ActiveRestClient::TimeoutException)
   end
 

data/spec/spec_helper.rb

@@ -2,6 +2,7 @@ require 'rspec'
 require 'simplecov'
 require 'active_rest_client'
 require "ostruct"
+require 'webmock/rspec'
 
 if ENV["JENKINS"]
   require 'simplecov-rcov'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_rest_client
 version: !ruby/object:Gem::Version
-  version: 0.9.66
+  version: 0.9.67
 platform: ruby
 authors:
 - Which Ltd
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-17 00:00:00.000000000 Z
+date: 2014-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -53,6 +53,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
@@ -165,18 +179,32 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: patron
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.4.9
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.4.9
 description: Accessing REST services in an ActiveRecord style