active_rest_client 1.0.5 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dd23c05a32d0575c6e4ff7d2334b7264ca1ee1db
-  data.tar.gz: 4abca247cd1cc050a34f9f50edc60c82408fde93
+  metadata.gz: 3477c6e4b20c5133c874a8ef329c9e71f2d50be0
+  data.tar.gz: 7cdfcda9c6f33f0262228c80a5b1cdade5aee5ff
 SHA512:
-  metadata.gz: e98ae059859804960a1a7030ef3662536787a4dda830318f4c35f5470198ae85f3d3f17857dd0a4d9d4291e71923f1f8f4a9ef25ef7ad613216d8a7b672cfc09
-  data.tar.gz: cb70cc5f0ce3a0138f8d6767f1aa0a15b46eecaf75a473e9acd48de5f175c25388e8f7e9802d8a6e697fc3cc017437342c00e8381b34af7e1f08819cf63bb022
+  metadata.gz: 29e829f81a617090b82e56cb68a03f46ca92238bcc6c9f5d056ad524daa5822724ad65dc9a79f1fdebf60e642d270200bd379748257ba84771d9454167000743
+  data.tar.gz: 9b2b9b9de8634f62e9ff1a78879dd0d5fd1ec7272550ab4dfa7a6e2aee74e41cbe927f6e784f0abffb8f1ebab250cbd106351927642b86d7b7e4ba560a7ecbc4

data/README.md

@@ -315,9 +315,9 @@ ActiveRestClient::Base.cache_store = Redis::Store.new("redis://localhost:6379/0/
 
 ### Using filters
 
-You can use filters to alter get/post parameters, the URL or set the post body (doing so overrides normal parameter insertion in to the body) before a request.  This can either be a block or a named method (like ActionController's `before_filter`/`before_action` methods).
+You can use filters to alter get/post parameters, the URL or set the post body (doing so overrides normal parameter insertion in to the body) before a request or to adjust the response after a request.  This can either be a block or a named method (like ActionController's `before_filter`/`before_action` methods).
 
-The filter is passed the name of the method (e.g. `:save`) and a request object. The request object has four public attributes `post_params` (a Hash of the POST parameters), `get_params` (a Hash of the GET parameters), headers and `url` (a String containing the full URL without GET parameters appended)
+The filter is passed the name of the method (e.g. `:save`) and an object (a request object for `before_filter` and a response object for `after_filter`). The request object has four public attributes `post_params` (a Hash of the POST parameters), `get_params` (a Hash of the GET parameters), headers and `url` (a String containing the full URL without GET parameters appended)
 
 ```ruby
 require 'secure_random'
@@ -368,6 +368,22 @@ class Person < MyProject::Base
 end
 ```
 
+After filters work in exactly the same way:
+
+```ruby
+class Person < ActiveRestClient::Base
+  after_filter :fix_empty_content
+
+  private
+
+  def fix_empty_content
+    if response.status == 204 && response.body.blank?
+      response.body = '{"empty": true}'
+    end
+  end
+end
+```
+
 ### Lazy Loading
 
 ActiveRestClient supports lazy loading (delaying the actual API call until the response is actually used, so that views can be cached without still causing API calls).

data/lib/active_rest_client/proxy_base.rb

@@ -69,8 +69,9 @@ module ActiveRestClient
       def translate(result, options = {})
         result.headers["content-type"] = "application/hal+json"
         result = OpenStruct.new(status:result.status, headers:result.headers, body:result.body)
-        obj = MultiJson.load(result.body)
-        result.body = yield obj
+        if result.body.present?
+          result.body = yield MultiJson.load(result.body)
+        end
         result
       end
 

data/lib/active_rest_client/request.rb

@@ -99,9 +99,9 @@ module ActiveRestClient
           return handle_response(OpenStruct.new(status:200, body:fake, headers:{"X-ARC-Faked-Response" => "true"}))
         end
         if object_is_class?
-          @object.send(:_filter_request, @method[:name], self)
+          @object.send(:_filter_request, :before, @method[:name], self)
         else
-          @object.class.send(:_filter_request, @method[:name], self)
+          @object.class.send(:_filter_request, :before, @method[:name], self)
         end
         append_get_parameters
         prepare_request_body
@@ -126,6 +126,11 @@ module ActiveRestClient
         if object_is_class? && @object.record_response?
           @object.record_response(self.url, response)
         end
+        if object_is_class?
+          @object.send(:_filter_request, :after, @method[:name], response)
+        else
+          @object.class.send(:_filter_request, :after, @method[:name], response)
+        end
         result = handle_response(response, cached)
         original_object_class.write_cached_response(self, response, result)
         result
@@ -417,7 +422,7 @@ module ActiveRestClient
       if @response.body.is_a?(Array) || @response.body.is_a?(Hash)
         body = @response.body
       else
-        body = MultiJson.load(@response.body) || {}
+        body = @response.body.blank? ? {} : MultiJson.load(@response.body)
       end
       body = begin
         @method[:name].nil? ? body : translator.send(@method[:name], body)

data/lib/active_rest_client/request_filtering.rb

@@ -2,35 +2,45 @@ module ActiveRestClient
   module RequestFiltering
     module ClassMethods
       def before_request(method_name = nil, &block)
-        @filters ||= []
+        @before_filters ||= []
         if block
-          @filters << block
+          @before_filters << block
         elsif method_name
-          @filters << method_name
+          @before_filters << method_name
         end
       end
 
-      def _filter_request(name, request)
-        _handle_super_class_filters(name, request)
-        @filters ||= []
-        @filters.each do |filter|
+      def after_request(method_name = nil, &block)
+        @after_filters ||= []
+        if block
+          @after_filters << block
+        elsif method_name
+          @after_filters << method_name
+        end
+      end
+
+      def _filter_request(type, name, param)
+        _handle_super_class_filters(type, name, param)
+        filters = (type == :before ? @before_filters : @after_filters)
+        filters ||= []
+        filters.each do |filter|
           if filter.is_a? Symbol
             if self.respond_to?(filter)
-              self.send(filter, name, request)
+              self.send(filter, name, param)
             else
               instance = self.new
-              instance.send(filter, name, request)
+              instance.send(filter, name, param)
             end
           else
-            filter.call(name, request)
+            filter.call(name, param)
           end
         end
       end
 
-      def _handle_super_class_filters(name, request)
+      def _handle_super_class_filters(type, name, request)
         @parents ||= []
         @parents.each do |parent|
-          parent._filter_request(name, request)
+          parent._filter_request(type, name, request)
         end
       end
 

data/lib/active_rest_client/version.rb

@@ -1,3 +1,3 @@
 module ActiveRestClient
-  VERSION = "1.0.5"
+  VERSION = "1.0.6"
 end

data/spec/lib/base_spec.rb

@@ -204,7 +204,7 @@ describe ActiveRestClient::Base do
 
     it "runs filters as usual" do
       ActiveRestClient::Request.any_instance.should_receive(:do_request).with(any_args).and_return(OpenStruct.new(status:200, headers:{}, body:"{\"first_name\":\"Billy\"}"))
-      EmptyExample.should_receive(:_filter_request).with(any_args)
+      EmptyExample.should_receive(:_filter_request).with(any_args).exactly(2).times
       EmptyExample._request("http://api.example.com/")
     end
 

data/spec/lib/proxy_spec.rb

@@ -120,6 +120,13 @@ describe ActiveRestClient::Base do
     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: {}))
+    result = ProxyClientExample.change_format
+    expect(result._attributes).to be_empty
+  end
+
   it "can continue with the request in the normal way, passing it on to the server" do
     ActiveRestClient::Connection.any_instance.should_receive(:get).with("/not_proxied?id=1", instance_of(Hash)).and_return(OpenStruct.new(body:"{\"result\":true}", status:200, headers:{}))
     ProxyClientExample.not_proxied(id:1)

data/spec/lib/request_filtering_spec.rb

@@ -18,6 +18,8 @@ class RequestFilteringExample
   before_request :set_to_ssl
   before_request :set_via_instance
 
+  after_request :change_body
+
   private
 
   def self.set_to_ssl(name, request)
@@ -27,6 +29,10 @@ class RequestFilteringExample
   def set_via_instance(name, request)
     request.url.gsub!("//www", "//new")
   end
+
+  def change_body(name, response)
+    response.body = "{test: 1}"
+  end
 end
 
 class SubClassedRequestFilteringExample < RequestFilteringExample
@@ -37,36 +43,42 @@ end
 
 describe ActiveRestClient::RequestFiltering do
   let(:request) { OpenStruct.new(get_params:{}, post_params:{}, url:"http://www.example.com", headers:ActiveRestClient::HeadersList.new) }
+  let(:response) { OpenStruct.new(body:"") }
 
   it "should call through to adjust the parameters" do
-    RequestFilteringExample._filter_request(:test, request)
+    RequestFilteringExample._filter_request(:before, :test, request)
     expect(request.get_params).to have_key(:filter1)
   end
 
   it "should call through for more than one filter" do
-    RequestFilteringExample._filter_request(:test, request)
+    RequestFilteringExample._filter_request(:before, :test, request)
     expect(request.get_params).to have_key(:filter1)
     expect(request.post_params).to have_key(:post_filter1)
   end
 
   it "should allow adjusting the URL via a named filter" do
-    RequestFilteringExample._filter_request(:test, request)
+    RequestFilteringExample._filter_request(:before, :test, request)
     expect(request.url).to match(/https:\/\//)
   end
 
   it "should allow adjusting the URL via a named filter as an instance method" do
-    RequestFilteringExample._filter_request(:test, request)
+    RequestFilteringExample._filter_request(:before, :test, request)
     expect(request.url).to match(/\/\/new\./)
   end
 
   it "should allow filters to be set on the parent or on the child" do
-    SubClassedRequestFilteringExample._filter_request(:test, request)
+    SubClassedRequestFilteringExample._filter_request(:before, :test, request)
     expect(request.url).to match(/\/\/new\./)
     expect(request.get_params[:api_key]).to eq(1234)
   end
 
   it "should allow filters to add custom headers" do
-    RequestFilteringExample._filter_request(:test, request)
+    RequestFilteringExample._filter_request(:before, :test, request)
     expect(request.headers["X-My-Header"]).to eq("myvalue")
   end
+
+  it "should be able to alter the response body" do
+    RequestFilteringExample._filter_request(:after, :test, response)
+    expect(response.body).to eq("{test: 1}")
+  end
 end

data/spec/lib/request_spec.rb

@@ -13,10 +13,17 @@ describe ActiveRestClient::Request do
         end
       end
 
+      after_request do |name, response|
+        if name == :change
+          response.body = "{\"test\": 1}"
+        end
+      end
+
       get :all, "/", :has_many => {:expenses => ExampleOtherClient}
       get :babies, "/babies", :has_many => {:children => ExampleOtherClient}
       get :headers, "/headers"
       get :find, "/:id"
+      get :change, "/change"
       post :create, "/create"
       put :update, "/put/:id"
       delete :remove, "/remove/:id"
@@ -440,17 +447,23 @@ describe ActiveRestClient::Request do
 
   it "should send all class mapped methods through _filter_request" do
     ActiveRestClient::Connection.any_instance.should_receive(:get).with("/", an_instance_of(Hash)).and_return(OpenStruct.new(body:"{\"first_name\":\"Johnny\", \"expenses\":[{\"amount\":1}, {\"amount\":2}]}", status:200, headers:{}))
-    ExampleClient.should_receive(:_filter_request).with(any_args)
+    ExampleClient.should_receive(:_filter_request).with(any_args).exactly(2).times
     ExampleClient.all
   end
 
   it "should send all instance mapped methods through _filter_request" do
     ActiveRestClient::Connection.any_instance.should_receive(:get).with("/", an_instance_of(Hash)).and_return(OpenStruct.new(body:"{\"first_name\":\"Johnny\", \"expenses\":[{\"amount\":1}, {\"amount\":2}]}", status:200, headers:{}))
-    ExampleClient.should_receive(:_filter_request).with(any_args)
+    ExampleClient.should_receive(:_filter_request).with(any_args).exactly(2).times
     e = ExampleClient.new
     e.all
   end
 
+  it "should change the generated object if an after_filter changes it" do
+    ActiveRestClient::Connection.any_instance.should_receive(:get).with("/change", an_instance_of(Hash)).and_return(OpenStruct.new(body:"{\"first_name\":\"Johnny\", \"expenses\":[{\"amount\":1}, {\"amount\":2}]}", status:200, headers:{}))
+    obj = ExampleClient.change
+    expect(obj.test).to eq(1)
+  end
+
   context "Direct URL requests" do
     class SameServerExampleClient < ActiveRestClient::Base
       URL = "http://www.example.com/some/url"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_rest_client
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
 platform: ruby
 authors:
 - Which Ltd
@@ -9,202 +9,202 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-06 00:00:00.000000000 Z
+date: 2015-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   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
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
 - !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
     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: simplecov
   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: simplecov-rcov
   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: guard-rspec
   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: terminal-notifier-guard
   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: coveralls
   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: multi_json
   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: activesupport
   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: 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: :development
   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
@@ -215,10 +215,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .simplecov
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".simplecov"
+- ".travis.yml"
 - CONTRIBUTING.md
 - Gemfile
 - Guardfile
@@ -275,17 +275,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: This gem is for accessing REST services in an ActiveRecord style.  ActiveResource
@@ -311,4 +311,3 @@ test_files:
 - spec/lib/result_iterator_spec.rb
 - spec/lib/validation_spec.rb
 - spec/spec_helper.rb
-has_rdoc: