active_rest_client 1.1.12 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fc5afe34d70f60f5233cff03578fe4a768aa7270
-  data.tar.gz: 8dda814fdaccf4329fbe0314a72e274607a2eaf7
+  metadata.gz: aa1076e05dc54a578810a49033b1cfc0502b1292
+  data.tar.gz: 6f191932544fa702a4924b52baa9dc938a7a026e
 SHA512:
-  metadata.gz: f2978f90bc9d9cbf9008c0567511b0f9eeb77ac6db7305437eb65456fe7e71f983e72fa6c03c17e44aa49e7290638c9537451a221fcffce6b1e0f12ff288c9fd
-  data.tar.gz: df05700d52bff47bd9ff118f5da673e3b0c4a5a208f6cf3641d62d7e2815131e75c142aa0574d6709f5862f43ff38a21ad0a9edec073036e396ee3813a75a27f
+  metadata.gz: 0cd5f8c5c5e9cd899c2d079e0daaa16afe0529eb9dbbf07612cbba5d9086ccf0d1114ba93991c1c6294039b5366e99a1a560b997b82bbfa32ca79a9745131a2b
+  data.tar.gz: fb8400a0f3c11bc3fbb5ce3a531119dc8af08f5700ebcf286dc4399a320286f4cc80a84e4e5892d23fb46cd808522ea3938a9409c43395f74ab648cb032690c6

data/CHANGELOG.md

@@ -0,0 +1,37 @@
+# Changelog
+
+## 1.2.0
+
+Features:
+
+- Allows for beta-support for XML APIs as well as JSON ones.
+
+Bugfixes:
+
+- In order to allow JRuby to work with ActiveRestClient, the hard-coded dependency on Patron has been removed.
+
+## 1.1.10 - 1.1.12
+
+Features:
+
+- Parallel requests can now be made
+
+Bugfixes
+
+- Some work around Faraday's weird method naming
+- Start of XML support
+- URL encoding username and password
+
+## 1.0.9
+
+Bugfixes
+
+- Correctly handling invalid cache expiry times
+
+## 1.0.8
+
+Features:
+
+- Added Api-Auth for authentication against APIs that use it
+- Supporting array parameter types
+- Relationships for 'has_one' can now be used

data/README.md

@@ -4,6 +4,8 @@
 [![Coverage Status](https://coveralls.io/repos/whichdigital/active-rest-client/badge.png)](https://coveralls.io/r/whichdigital/active-rest-client)
 [![Code Climate](https://codeclimate.com/github/whichdigital/active-rest-client.png)](https://codeclimate.com/github/whichdigital/active-rest-client)
 [![Gem Version](https://badge.fury.io/rb/active_rest_client.png)](http://badge.fury.io/rb/active_rest_client)
+[![Average time to resolve an issue](http://isitmaintained.com/badge/resolution/whichdigital/active-rest-client.svg)](http://isitmaintained.com/project/whichdigital/active-rest-client "Average time to resolve an issue")
+[![Percentage of issues still open](http://isitmaintained.com/badge/open/whichdigital/active-rest-client.svg)](http://isitmaintained.com/project/whichdigital/active-rest-client "Percentage of issues still open")
 
 This gem is for accessing REST services in an ActiveRecord style.  ActiveResource already exists for this, but it doesn't work where the resource naming doesn't follow Rails conventions, it doesn't have in-built caching and it's not as flexible in general.
 
@@ -125,13 +127,17 @@ puts @person.to_json
 
 ### Faraday 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.
+ActiveRestClient uses Faraday to allow switching HTTP backends, the default is to just use Faraday's default. 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
+# or ...
+ActiveRestClient::Base.adapter = :patron
 ```
 
-If you want more control you can pass a complete configuration block. For available config variables look into the Faraday documentation.
+In versions before 1.2.0 the adapter was hardcoded to `:patron`, so if you want to ensure it still uses Patron, you should set this setting.
+
+If you want more control you can pass a **complete** configuration block ("complete" means that the block does not *override* [the default configuration](https://github.com/whichdigital/active-rest-client/blob/5b1953d89e26c02ca74f74464ccb7cd4c9439dcc/lib/active_rest_client/configuration.rb#L184-L201), but rather *replaces* it). For available config variables look into the Faraday documentation.
 
 ```ruby
 ActiveRestClient::Base.faraday_config do |faraday|
@@ -139,7 +145,7 @@ ActiveRestClient::Base.faraday_config do |faraday|
   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.
@@ -205,9 +211,9 @@ And use it like this:
 
 #### Association Type 3 - HAL Auto-loaded Resources
 
-You don't need to define lazy attributes if they are defined using [HAL](http://stateless.co/hal_specification.html) (with an optional embedded representation).  If your resource has an _links item (and optionally an _embedded item) then it will automatically treat the linked resources (with the _embedded cache) as if they were defined using `:lazy` as per type 2 above.
+You don't need to define lazy attributes if they are defined using [HAL](http://stateless.co/hal_specification.html) (with an optional embedded representation).  If your resource has an `_links` item (and optionally an `_embedded` item) then it will automatically treat the linked resources (with the `_embedded` cache) as if they were defined using `:lazy` as per type 2 above.
 
-If you need to, you can access properties of the HAL association.  By default just using the HAL association gets the embedded resource (or requests the remote resource if not available in the _embedded list).
+If you need to, you can access properties of the HAL association.  By default just using the HAL association gets the embedded resource (or requests the remote resource if not available in the `_embedded` list).
 
 ```ruby
 @person = Person.find(1)
@@ -464,6 +470,13 @@ require 'api-auth'
 ActiveRestClient::Base.api_auth_credentials(@access_id, @secret_key)
 ```
 
+You can also specify different credentials for different models just like configuring base_url
+```ruby
+class Person < ActiveRestClient::Base
+  api_auth_credentials('123456', 'abcdef')
+end
+```
+
 For more information on how to generate an access id and secret key please read the [Api-Auth](https://github.com/mgomes/api_auth) documentation.
 
 ### Body Types
@@ -577,7 +590,7 @@ people = Person._plain_request('http://api.example.com/v1/people') # Defaults to
 Person._plain_request('http://api.example.com/v1/people', :post, {id:1234,name:"John"}) # Post with parameters
 ```
 
-The parameters are the same as for _request, but it does no parsing on the response
+The parameters are the same as for `_request`, but it does no parsing on the response
 
 ### Proxying APIs
 
@@ -814,6 +827,14 @@ puts @atom.feed.link.href
 end
 ```
 
+If your XML object comes back with a root node and you'd like to ignore it, you can define the mapping as:
+
+```ruby
+class Feed < ActiveRestClient::Base
+  get :atom, "/atom", ignore_xml_root: "feed"
+end
+```
+
 For testing purposes, if you are using a `fake` content response when defining your endpoint, you should also provide `fake_content_type: "application/xml"` so that the parser knows to use XML parsing.
 
 ## Contributing
@@ -822,4 +843,4 @@ For testing purposes, if you are using a `fake` content response when defining y
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+5. Create new Pull Request

data/active_rest_client.gemspec

@@ -36,5 +36,4 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "crack"
   spec.add_runtime_dependency "activesupport"
   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/base.rb

@@ -24,10 +24,10 @@ module ActiveRestClient
 
       attrs.each do |attribute_name, attribute_value|
         attribute_name = attribute_name.to_sym
-        if attribute_value.to_s[/\d{4}\-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(Z|[+-]\d{2}:\d{2})/]
-          @attributes[attribute_name] = DateTime.parse(attribute_value)
-        elsif attribute_value.to_s =~ /^\d{4}\-\d{2}-\d{2}$/
+        if attribute_value.to_s[/^([\+-]?\d{4}(?!\d{2}\b))((-?)((0[1-9]|1[0-2])(\3([12]\d|0[1-9]|3[01]))?|W([0-4]\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\d|[12]\d{2}|3([0-5]\d|6[1-6]))))$/]
           @attributes[attribute_name] = Date.parse(attribute_value)
+        elsif attribute_value.to_s[/^([\+-]?\d{4}(?!\d{2}\b))((-?)((0[1-9]|1[0-2])(\3([12]\d|0[1-9]|3[01]))?|W([0-4]\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\d|[12]\d{2}|3([0-5]\d|6[1-6])))([T\s]((([01]\d|2[0-3])((:?)[0-5]\d)?|24\:?00)([\.,]\d+(?!:))?)?(\17[0-5]\d([\.,]\d+)?)?([zZ]|([\+-])([01]\d|2[0-3]):?([0-5]\d)?)?)?)?$/]
+          @attributes[attribute_name] = DateTime.parse(attribute_value)
         else
           @attributes[attribute_name] = attribute_value
         end

data/lib/active_rest_client/configuration.rb

@@ -8,8 +8,8 @@ module ActiveRestClient
       @@password = nil
       @@request_body_type = :form_encoded
       @lazy_load = false
-      @@api_auth_access_id = nil
-      @@api_auth_secret_key = nil
+      @api_auth_access_id = nil
+      @api_auth_secret_key = nil
 
       def base_url(value = nil)
         if value.nil?
@@ -91,7 +91,7 @@ module ActiveRestClient
       end
 
       def adapter
-        @adapter ||= :patron
+        @adapter ||= Faraday.default_adapter
       end
 
       def faraday_config(&block)
@@ -121,20 +121,32 @@ module ActiveRestClient
           raise MissingOptionalLibraryError.new("You must include the gem 'api-auth' in your Gemfile to set api-auth credentials.")
         end
 
-        @@api_auth_access_id = access_id
-        @@api_auth_secret_key = secret_key
+        @api_auth_access_id = access_id
+        @api_auth_secret_key = secret_key
       end
 
       def using_api_auth?
-        !@@api_auth_access_id.nil? && !@@api_auth_secret_key.nil?
+        !self.api_auth_access_id.nil? && !self.api_auth_secret_key.nil?
       end
 
       def api_auth_access_id
-        @@api_auth_access_id
+        if !@api_auth_access_id.nil?
+          return @api_auth_access_id
+        elsif self.superclass.respond_to?(:api_auth_access_id)
+          return self.superclass.api_auth_access_id
+        end
+
+        return nil
       end
 
       def api_auth_secret_key
-        @@api_auth_secret_key
+        if !@api_auth_secret_key.nil?
+          return @api_auth_secret_key
+        elsif self.superclass.respond_to?(:api_auth_secret_key)
+          return self.superclass.api_auth_secret_key
+        end
+
+        return nil
       end
 
       def verbose!
@@ -162,9 +174,9 @@ module ActiveRestClient
         @whiny_missing        = nil
         @lazy_load            = false
         @faraday_config       = default_faraday_config
-        @adapter              = :patron
-        @@api_auth_access_id  = nil
-        @@api_auth_secret_key = nil
+        @adapter              = Faraday.default_adapter
+        @api_auth_access_id   = nil
+        @api_auth_secret_key  = nil
       end
 
       private

data/lib/active_rest_client/connection.rb

@@ -34,40 +34,44 @@ module ActiveRestClient
       end
     end
 
-    def get(path, headers={})
+    def get(path, options={})
+      set_defaults(options)
       make_safe_request(path) do
         @session.get(path) do |req|
-          req.headers = req.headers.merge(headers)
-          sign_request(req)
+          req.headers = req.headers.merge(options[:headers])
+          sign_request(req, options[:api_auth])
         end
       end
     end
 
-    def put(path, data, headers={})
+    def put(path, data, options={})
+      set_defaults(options)
       make_safe_request(path) do
         @session.put(path) do |req|
-          req.headers = req.headers.merge(headers)
+          req.headers = req.headers.merge(options[:headers])
           req.body = data
-          sign_request(req)
+          sign_request(req, options[:api_auth])
         end
       end
     end
 
-    def post(path, data, headers={})
+    def post(path, data, options={})
+      set_defaults(options)
       make_safe_request(path) do
         @session.post(path) do |req|
-          req.headers = req.headers.merge(headers)
+          req.headers = req.headers.merge(options[:headers])
           req.body = data
-          sign_request(req)
+          sign_request(req, options[:api_auth])
         end
       end
     end
 
-    def delete(path, headers={})
+    def delete(path, options={})
+      set_defaults(options)
       make_safe_request(path) do
         @session.delete(path) do |req|
-          req.headers = req.headers.merge(headers)
-          sign_request(req)
+          req.headers = req.headers.merge(options[:headers])
+          sign_request(req, options[:api_auth])
         end
       end
     end
@@ -82,12 +86,18 @@ module ActiveRestClient
       @session.build_url(path).to_s
     end
 
-    def sign_request(request)
-      return if !ActiveRestClient::Base.using_api_auth?
+    def set_defaults(options)
+      options[:headers]   ||= {}
+      options[:api_auth]  ||= {}
+      return options
+    end
+
+    def sign_request(request, api_auth)
+      return if api_auth[:api_auth_access_id].nil? || api_auth[:api_auth_secret_key].nil?
       ApiAuth.sign!(
         request,
-        ActiveRestClient::Base.api_auth_access_id,
-        ActiveRestClient::Base.api_auth_secret_key)
+        api_auth[:api_auth_access_id],
+        api_auth[:api_auth_secret_key])
     end
   end
 end

data/lib/active_rest_client/monkey_patching.rb

@@ -1,3 +1,7 @@
-class Faraday::Env
-  alias_method :headers, :response_headers
+require 'faraday'
+
+if defined?("Faraday::Env")
+  class Faraday::Env
+    alias_method :headers, :response_headers
+  end
 end

data/lib/active_rest_client/proxy_base.rb

@@ -66,11 +66,24 @@ module ActiveRestClient
         @original_handler.call(@request)
       end
 
+      def result_is_json_or_unspecified?(result)
+        result.headers['Content-Type'].include?('json')
+      rescue
+        true
+      end
+
       def translate(result, options = {})
-        result.headers["content-type"] = "application/hal+json"
+        incoming_content_type = result.headers['Content-Type']
+        if result_is_json_or_unspecified?(result)
+          result.headers["content-type"] = "application/hal+json"
+        end
         result = FaradayResponseProxy.new(OpenStruct.new(status:result.status, response_headers:result.headers, body:result.body))
         if result.body.present?
-          result.body = yield MultiJson.load(result.body)
+          if incoming_content_type && incoming_content_type["xml"]
+            result.body = yield Crack::XML.parse(result.body)
+          else
+            result.body = yield MultiJson.load(result.body)
+          end
         end
         result
       end

data/lib/active_rest_client/request.rb

@@ -48,6 +48,30 @@ module ActiveRestClient
       end
     end
 
+    def using_api_auth?
+      if object_is_class?
+        @object.using_api_auth?
+      else
+        @object.class.using_api_auth?
+      end
+    end
+
+    def api_auth_access_id
+      if object_is_class?
+        @object.api_auth_access_id
+      else
+        @object.class.api_auth_access_id
+      end
+    end
+
+    def api_auth_secret_key
+      if object_is_class?
+        @object.api_auth_secret_key
+      else
+        @object.class.api_auth_secret_key
+      end
+    end
+
     def username
       if object_is_class?
         @object.username
@@ -283,15 +307,23 @@ module ActiveRestClient
         ActiveRestClient::Logger.debug "  >> Body:\n#{@body}"
       end
 
+      request_options = {:headers => http_headers}
+      if using_api_auth?
+        request_options[:api_auth] = {
+          :api_auth_access_id => api_auth_access_id,
+          :api_auth_secret_key => api_auth_secret_key
+        }
+      end
+
       case http_method
       when :get
-        response = connection.get(@url, http_headers)
+        response = connection.get(@url, request_options)
       when :put
-        response = connection.put(@url, @body, http_headers)
+        response = connection.put(@url, @body, request_options)
       when :post
-        response = connection.post(@url, @body, http_headers)
+        response = connection.post(@url, @body, request_options)
       when :delete
-        response = connection.delete(@url, http_headers)
+        response = connection.delete(@url, request_options)
       else
         raise InvalidRequestException.new("Invalid method #{http_method}")
       end
@@ -331,13 +363,13 @@ module ActiveRestClient
           else
             ActiveRestClient::Logger.debug "  \033[1;4;32m#{ActiveRestClient::NAME}\033[0m #{@instrumentation_name} - Response received #{@response.body.size} bytes"
           end
-          result = generate_new_object
+          result = generate_new_object(ignore_xml_root: @method[:options][:ignore_xml_root])
         else
           raise ResponseParseException.new(status:status, body:@response.body)
         end
       else
         if is_json_response? || is_xml_response?
-          error_response = generate_new_object(mutable: false)
+          error_response = generate_new_object(mutable: false, ignore_xml_root: @method[:options][:ignore_xml_root])
         else
           error_response = @response.body
         end
@@ -483,6 +515,9 @@ module ActiveRestClient
         body = @response.body.blank? ? {} : MultiJson.load(@response.body)
       elsif is_xml_response?
         body = @response.body.blank? ? {} : Crack::XML.parse(@response.body)
+        if options[:ignore_xml_root]
+          body = body[options[:ignore_xml_root].to_s]
+        end
       end
       body = begin
         @method[:name].nil? ? body : translator.send(@method[:name], body)

data/lib/active_rest_client/version.rb

@@ -1,3 +1,3 @@
 module ActiveRestClient
-  VERSION = "1.1.12"
+  VERSION = "1.2.0"
 end

data/spec/lib/base_spec.rb

@@ -80,6 +80,13 @@ describe ActiveRestClient::Base do
     expect(client["test"].to_s).to eq(t.to_datetime.to_s)
   end
 
+  it "should automatically parse ISO 8601 format date and time with milliseconds" do
+    t = Time.now
+    client = EmptyExample.new(:test => t.iso8601(3))
+    expect(client["test"]).to be_an_instance_of(DateTime)
+    expect(client["test"].to_s).to eq(t.to_datetime.to_s)
+  end
+
   it "should automatically parse ISO 8601 format dates" do
     d = Date.today
     client = EmptyExample.new(:test => d.iso8601)

data/spec/lib/caching_spec.rb

@@ -111,7 +111,10 @@ describe ActiveRestClient::Caching do
         result:@cached_object,
         etag:@etag)
       expect_any_instance_of(CachingExampleCacheStore5).to receive(:read).once.with("Person:/").and_return(Marshal.dump(cached_response))
-      expect_any_instance_of(ActiveRestClient::Connection).to receive(:get).with("/", hash_including("If-None-Match" => @etag)).and_return(::FaradayResponseMock.new(OpenStruct.new(status:304, response_headers:{})))
+      expect_any_instance_of(ActiveRestClient::Connection).to receive(:get){ |connection, path, options|
+        expect(path).to eq('/')
+        expect(options[:headers]).to include("If-None-Match" => @etag)
+      }.and_return(::FaradayResponseMock.new(OpenStruct.new(status:304, response_headers:{})))
       ret = Person.all
       expect(ret.first_name).to eq("Johnny")
     end
@@ -127,7 +130,10 @@ describe ActiveRestClient::Caching do
       response_body = Person.new(first_name: new_name).to_json
       response = ::FaradayResponseMock.new(double(status: 200, response_headers: {}, body: response_body))
       allow_any_instance_of(ActiveRestClient::Connection).to(
-        receive(:get).with('/', hash_including('If-None-Match' => @etag)).and_return(response))
+        receive(:get){ |connection, path, options|
+          expect(path).to eq('/')
+          expect(options[:headers]).to include('If-None-Match' => @etag)
+        }.and_return(response))
 
       result = Person.all
 

data/spec/lib/configuration_spec.rb

@@ -155,6 +155,21 @@ describe ActiveRestClient::Configuration do
       it "should remember setting api_auth_secret_key" do
         expect(ConfigurationExample.api_auth_secret_key).to eq('secret123')
       end
+
+      it "should inherit api_auth_credentials when not set" do
+        class ConfigurationExtension < ConfigurationExample
+        end
+        expect(ConfigurationExtension.api_auth_access_id).to eq('id123')
+        expect(ConfigurationExtension.api_auth_secret_key).to eq('secret123')
+      end
+
+      it "should override inherited api_auth_credentials when set" do
+        class ConfigurationExtension2 < ConfigurationExample
+        end
+        ConfigurationExtension2.api_auth_credentials('id456', 'secret456')
+        expect(ConfigurationExtension2.api_auth_access_id).to eq('id456')
+        expect(ConfigurationExtension2.api_auth_secret_key).to eq('secret456')
+      end
     end
   end
 
@@ -194,7 +209,7 @@ describe ActiveRestClient::Configuration do
     let(:faraday_double){double(:faraday).as_null_object}
 
     it "should use default adapter if no other block set" do
-      expect(faraday_double).to receive(:adapter).with(:patron)
+      expect(faraday_double).to receive(:adapter).with(Faraday.default_adapter)
       ConfigurationExample.faraday_config.call(faraday_double)
     end
 

data/spec/lib/connection_spec.rb

@@ -100,8 +100,16 @@ describe ActiveRestClient::Connection do
 
   context 'with api auth signing requests' do
     before(:each) do
+      # Need to still call this to load the api_auth library so tests work
       ActiveRestClient::Base.api_auth_credentials('id123', 'secret123')
 
+      @options = {
+        :api_auth => {
+          :api_auth_access_id => 'id123',
+          :api_auth_secret_key => 'secret123'
+        }
+      }
+
       @default_headers = {'Date' => 'Sat, 14 Mar 2015 15:13:24 GMT'}
 
       ActiveRestClient::Base.faraday_config do |faraday|
@@ -115,7 +123,7 @@ describe ActiveRestClient::Connection do
       stub_request(:get, "www.example.com/foo")
         .with(:headers => @default_headers)
         .to_return(body: "{result:true}")
-      result = @connection.get("/foo")
+      result = @connection.get("/foo", @options)
       expect(result.env.request_headers['Authorization']).to eq("APIAuth id123:PMWBThkB8vKbvUccHvoqu9G3eVk=")
     end
 
@@ -124,7 +132,7 @@ describe ActiveRestClient::Connection do
         with(body: "body", :headers => @default_headers).
         to_return(body: "{result:true}")
 
-      result = @connection.put("/foo", "body")
+      result = @connection.put("/foo", "body", @options)
       expect(result.env.request_headers['Content-MD5']).to eq("hBotaJrYa9FhFEdFPCLG/A==")
     end
   end

data/spec/lib/proxy_spec.rb

@@ -43,6 +43,14 @@ class ProxyExample < ActiveRestClient::ProxyBase
     end
   end
 
+  get "/change-xml-format" do
+    response = passthrough
+    translate(response) do |body|
+      body["first_name"] = body["object"].delete("fname")
+      body
+    end
+  end
+
   get "/hal_test/:id" do
     response = passthrough
     translate(response) do |body|
@@ -70,6 +78,7 @@ class ProxyClientExample < ActiveRestClient::Base
   get :fake, "/fake"
   get :param, "/param/:id/:name"
   get :change_format, "/change-format"
+  get :change_xml_format, "/change-xml-format"
   post :create, "/create"
   put :update, "/update"
   get :not_proxied, "/not_proxied"
@@ -120,6 +129,16 @@ describe ActiveRestClient::Base do
     expect(ret.first_name).to eq("Billy")
   end
 
+  it "can intercept XML responses, parse the response, alter it and pass it on during the request" do
+    expect_any_instance_of(ActiveRestClient::Connection).to receive(:get).with("/change-xml-format",
+      instance_of(Hash)).and_return(::FaradayResponseMock.new(OpenStruct.new(
+      body:"<?xml version=\"1.0\" encoding=\"UTF-8\"?><object><fname>Billy</fname></object>",
+      status:200,
+      response_headers:{"Content-Type" => "application/xml"})))
+    ret = ProxyClientExample.change_xml_format
+    expect(ret.first_name).to eq("Billy")
+  end
+
   it 'skips the altering of the response body when there is none' do
     allow_any_instance_of(ActiveRestClient::Connection).to receive(:get).with('/change-format', instance_of(Hash))
       .and_return(double(body: '', status: 200, headers: {}))

data/spec/lib/request_spec.rb

@@ -7,6 +7,7 @@ describe ActiveRestClient::Request do
     class ExampleClient < ActiveRestClient::Base
       base_url "http://www.example.com"
       request_body_type :form_encoded
+      api_auth_credentials('id123', 'secret123')
 
       before_request do |name, request|
         if request.method[:name] == :headers
@@ -160,17 +161,28 @@ describe ActiveRestClient::Request do
   end
 
   it "should pass through custom headers" do
-    expect_any_instance_of(ActiveRestClient::Connection).to receive(:get).with("/headers", hash_including("X-My-Header" => "myvalue")).and_return(::FaradayResponseMock.new(OpenStruct.new(body:'{"result":true}', response_headers:{})))
+    expect_any_instance_of(ActiveRestClient::Connection).to receive(:get){ |connection, path, options|
+      expect(path).to eq('/headers')
+      expect(options[:headers]).to include("X-My-Header" => "myvalue")
+    }.and_return(::FaradayResponseMock.new(OpenStruct.new(body:'{"result":true}', response_headers:{})))
     ExampleClient.headers
   end
 
   it "should set request header with content-type for default" do
-    expect_any_instance_of(ActiveRestClient::Connection).to receive(:put).with("/headers_default", "", hash_including("Content-Type" => "application/x-www-form-urlencoded")).and_return(::FaradayResponseMock.new(OpenStruct.new(body:'{"result":true}', response_headers:{})))
+    expect_any_instance_of(ActiveRestClient::Connection).to receive(:put){ |connection, path, data, options|
+      expect(path).to eq('/headers_default')
+      expect(data).to eq('')
+      expect(options[:headers]).to include("Content-Type" => "application/x-www-form-urlencoded")
+    }.and_return(::FaradayResponseMock.new(OpenStruct.new(body:'{"result":true}', response_headers:{})))
     ExampleClient.headers_default
   end
 
   it "should set request header with content-type for JSON" do
-    expect_any_instance_of(ActiveRestClient::Connection).to receive(:put).with("/headers_json", "{}", hash_including("Content-Type" => "application/json; charset=utf-8")).and_return(::FaradayResponseMock.new(OpenStruct.new(body:'{"result":true}', response_headers:{})))
+    expect_any_instance_of(ActiveRestClient::Connection).to receive(:put){ |connection, path, data, options|
+      expect(path).to eq('/headers_json')
+      expect(data).to eq('{}')
+      expect(options[:headers]).to include("Content-Type" => "application/json; charset=utf-8")
+    }.and_return(::FaradayResponseMock.new(OpenStruct.new(body:'{"result":true}', response_headers:{})))
     ExampleClient.headers_json
   end
 
@@ -578,7 +590,10 @@ describe ActiveRestClient::Request do
     let(:hal) { ExampleClient.hal }
 
     it "should request a HAL response or plain JSON" do
-      expect_any_instance_of(ActiveRestClient::Connection).to receive(:get).with("/headers", hash_including("Accept" => "application/hal+json, application/json;q=0.5")).and_return(::FaradayResponseMock.new(OpenStruct.new(body:'{"result":true}', response_headers:{})))
+      expect_any_instance_of(ActiveRestClient::Connection).to receive(:get){ |connection, path, options|
+        expect(path).to eq('/headers')
+        expect(options[:headers]).to include("Accept" => "application/hal+json, application/json;q=0.5")
+      }.and_return(::FaradayResponseMock.new(OpenStruct.new(body:'{"result":true}', response_headers:{})))
       ExampleClient.headers
     end
 

data/spec/lib/xml_spec.rb

@@ -2,6 +2,12 @@ require 'spec_helper'
 
 class XmlResponseExample < ActiveRestClient::Base
   base_url "http://www.example.com/v1/"
+  get :root, "/root", ignore_xml_root: "feed", fake_content_type: "application/xml", fake: %Q{
+    <?xml version="1.0" encoding="utf-8"?>
+    <feed xmlns="http://www.w3.org/2005/Atom">
+      <title>Example Feed</title>
+    </feed>
+  }
   get :atom, "/atom", fake: %Q{
     <?xml version="1.0" encoding="utf-8"?>
     <feed xmlns="http://www.w3.org/2005/Atom">
@@ -61,4 +67,8 @@ describe XmlResponseExample do
     expect(@atom.feed.entry[1].title).to eq("Something else cool happened")
   end
 
+  it "allows ignoring of the XML root node" do
+    @feed = XmlResponseExample.root
+    expect(@feed.title).to eq("Example Feed")
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_rest_client
 version: !ruby/object:Gem::Version
-  version: 1.1.12
+  version: 1.2.0
 platform: ruby
 authors:
 - Which Ltd
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-12 00:00:00.000000000 Z
+date: 2015-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -235,20 +235,6 @@ dependencies:
     - - ">="
       - !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
 email:
 - swlicensing@which.co.uk
@@ -261,6 +247,7 @@ files:
 - ".rspec"
 - ".simplecov"
 - ".travis.yml"
+- CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
 - Guardfile