flexirest 1.3.20 → 1.3.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a08b537f83b7e91f676166915c6db2858aaf3858
-  data.tar.gz: a1962938bb89f82b79640aa29e619ec3ba48d857
+  metadata.gz: 7b44e78f8e0339a35faa3fb279633ed5ef81f7ae
+  data.tar.gz: d83135c90a5d429189f808f13ead3e729ec4bd65
 SHA512:
-  metadata.gz: d1af9fae82540fcff4c45dcedd9c5074743188531b1481a3d02ace07ab1cdcc537d8b505027a818f18dcff3f1a0a90ec7ee57fc1f0d0502d4a52de206dc71ba0
-  data.tar.gz: b3eaa600d7ecd24034168a57ec10376ed1b5a4f29570f6762f3ff7eea2ecbf82f48ba036d5a401edd4d986bcda2c6c34e681a4d7bca7fbf25052e438d93bbf25
+  metadata.gz: c3b04f2aaa9fe1f67601ab242374d6c2f142a859bac9185bfa46857947467edd1379a63be9896dfccf7353479f4015eb17a3b92f080e9eedd44b74ed7378a6bb
+  data.tar.gz: f2dc4c231338f6bfa6c8b5323c09f4226c5fd4cf79564cce936186c8f3b07de6f89ab2041b27b03561ffb4074ac87dddf3e95114930e75b314ec1a0190ac81db

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 1.3.21
+
+Feature:
+
+- Now any requests returning a 204 with an empty (nil or blank) body return true instead of raising a ParseException
+
 ## 1.3.20
 
 Bugfix:

data/README.md

@@ -396,11 +396,11 @@ If Rails is defined, it will default to using Rails.cache as the cache store, if
 Flexirest::Base.cache_store = Redis::Store.new("redis://localhost:6379/0/cache")
 ```
 
-### Using filters
+### Using callbacks
 
-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).
+You can use callbacks 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_callback`/`before_action` methods).
 
-The filter is passed the name of the method (e.g. `:save`) and an object (a request object for `before_request` and a response object for `after_request`). 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 callback is passed the name of the method (e.g. `:save`) and an object (a request object for `before_request` and a response object for `after_request`). 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'
@@ -445,7 +445,7 @@ class Person < Flexirest::Base
 end
 ```
 
-If you need to, you can create a custom parent class with a `before_request` filter and all children will inherit this filter.
+If you need to, you can create a custom parent class with a `before_request` callback and all children will inherit this callback.
 
 ```ruby
 class MyProject::Base < Flexirest::Base
@@ -459,7 +459,7 @@ class Person < MyProject::Base
 end
 ```
 
-After filters work in exactly the same way:
+After callbacks work in exactly the same way:
 
 ```ruby
 class Person < Flexirest::Base
@@ -475,6 +475,8 @@ class Person < Flexirest::Base
 end
 ```
 
+**Note:** since v1.3.21 this isn't necessary, empty responses for 204 are accepted normally (the method returns `true`), but this is hear to show an example of an `after_request` callback.
+
 ### Lazy Loading
 
 Flexirest 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).
@@ -565,7 +567,7 @@ or
 Flexirest::Base.request_body_type = :json
 ```
 
-This will also set the header `Content-Type` to `application/x-www-form-urlencoded` by default or `application/json; charset=utf-8` when `:json`. You can override this using the filter `before_request`.
+This will also set the header `Content-Type` to `application/x-www-form-urlencoded` by default or `application/json; charset=utf-8` when `:json`. You can override this using the callback `before_request`.
 
 If you have an API that is inconsistent in its body type requirements, you can also specify it on the individual method mapping:
 
@@ -673,7 +675,7 @@ end
 
 ### Raw Requests
 
-Sometimes you have have a URL that you just want to force through, but have the response handled in the same way as normal objects or you want to have the filters run (say for authentication).  The easiest way to do that is to call `_request` on the class:
+Sometimes you have have a URL that you just want to force through, but have the response handled in the same way as normal objects or you want to have the callbacks run (say for authentication).  The easiest way to do that is to call `_request` on the class:
 
 ```ruby
 class Person < Flexirest::Base

data/lib/flexirest/base.rb

@@ -2,7 +2,7 @@ module Flexirest
   class Base
     include Mapping
     include Configuration
-    include RequestFiltering
+    include Callbacks
     include Validation
     include Caching
     include Recording

data/lib/flexirest/callbacks.rb

@@ -0,0 +1,63 @@
+module Flexirest
+  module Callbacks
+    module ClassMethods
+      def before_request(method_name = nil, &block)
+        @before_callbacks ||= []
+        if block
+          @before_callbacks << block
+        elsif method_name
+          @before_callbacks << method_name
+        end
+      end
+
+      def after_request(method_name = nil, &block)
+        @after_callbacks ||= []
+        if block
+          @after_callbacks << block
+        elsif method_name
+          @after_callbacks << method_name
+        end
+      end
+
+      def _callback_request(type, name, param)
+        _handle_super_class_callbacks(type, name, param)
+        @before_callbacks ||= []
+        @after_callbacks ||= []
+        callbacks = (type == :before ? @before_callbacks : @after_callbacks)
+        callbacks.each do |callback|
+          if callback.is_a? Symbol
+            if self.respond_to?(callback)
+              self.send(callback, name, param)
+            else
+              instance = self.new
+              instance.send(callback, name, param)
+            end
+          else
+            callback.call(name, param)
+          end
+        end
+      end
+
+      def _handle_super_class_callbacks(type, name, request)
+        @parents ||= []
+        @parents.each do |parent|
+          parent._callback_request(type, name, request)
+        end
+      end
+
+      def _parents
+        @parents ||= []
+      end
+
+      def inherited(subclass)
+        subclass._parents << self
+        super
+      end
+    end
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+  end
+end

data/lib/flexirest/request.rb

@@ -161,9 +161,9 @@ module Flexirest
           return handle_response(OpenStruct.new(status:200, body:fake, response_headers:{"X-ARC-Faked-Response" => "true", "Content-Type" => content_type}))
         end
         if object_is_class?
-          @object.send(:_filter_request, :before, @method[:name], self)
+          @object.send(:_callback_request, :before, @method[:name], self)
         else
-          @object.class.send(:_filter_request, :before, @method[:name], self)
+          @object.class.send(:_callback_request, :before, @method[:name], self)
         end
         append_get_parameters
         prepare_request_body
@@ -205,9 +205,9 @@ module Flexirest
             @object.record_response(self.url, response_env)
           end
           if object_is_class?
-            @object.send(:_filter_request, :after, @method[:name], response_env)
+            @object.send(:_callback_request, :after, @method[:name], response_env)
           else
-            @object.class.send(:_filter_request, :after, @method[:name], response_env)
+            @object.class.send(:_callback_request, :after, @method[:name], response_env)
           end
 
           result = handle_response(response_env, cached)
@@ -402,6 +402,8 @@ module Flexirest
       if (200..399).include?(status)
         if @method[:options][:plain]
           return @response = Flexirest::PlainResponse.from_response(response)
+        elsif status == 204 && @response.body.blank?
+          return true
         elsif is_json_response? || is_xml_response?
           if @response.respond_to?(:proxied) && @response.proxied
             Flexirest::Logger.debug "  \033[1;4;32m#{Flexirest.name}\033[0m #{@instrumentation_name} - Response was proxied, unable to determine size"

data/lib/flexirest/version.rb

@@ -1,3 +1,3 @@
 module Flexirest
-  VERSION = "1.3.20"
+  VERSION = "1.3.21"
 end

data/lib/flexirest.rb

@@ -16,7 +16,7 @@ require "flexirest/lazy_association_loader"
 require "flexirest/request"
 require "flexirest/request_delegator"
 require "flexirest/validation"
-require "flexirest/request_filtering"
+require "flexirest/callbacks"
 require "flexirest/proxy_base"
 require "flexirest/recording"
 require "flexirest/base"

data/spec/lib/base_spec.rb

@@ -272,9 +272,9 @@ describe Flexirest::Base do
       EmptyExample._request("http://api.example.com/")
     end
 
-    it "runs filters as usual" do
+    it "runs callbacks as usual" do
       expect_any_instance_of(Flexirest::Request).to receive(:do_request).with(any_args).and_return(::FaradayResponseMock.new(OpenStruct.new(status:200, response_headers:{}, body:"{\"first_name\":\"Billy\"}")))
-      expect(EmptyExample).to receive(:_filter_request).with(any_args).exactly(2).times
+      expect(EmptyExample).to receive(:_callback_request).with(any_args).exactly(2).times
       EmptyExample._request("http://api.example.com/")
     end
 

data/spec/lib/{request_filtering_spec.rb → callbacks_spec.rb}

@@ -1,14 +1,14 @@
 require 'spec_helper'
 
-class RequestFilteringExample
-  include Flexirest::RequestFiltering
+class CallbacksExample
+  include Flexirest::Callbacks
 
   before_request do |name, request|
-    request.get_params[:filter1] = "Hello"
+    request.get_params[:callback1] = "Hello"
   end
 
   before_request do |name, request|
-    request.post_params[:post_filter1] = "World"
+    request.post_params[:post_callback1] = "World"
   end
 
   before_request do |name, request|
@@ -35,50 +35,50 @@ class RequestFilteringExample
   end
 end
 
-class SubClassedRequestFilteringExample < RequestFilteringExample
+class SubClassedCallbacksExample < CallbacksExample
   before_request do |name, request|
     request.get_params[:api_key] = 1234
   end
 end
 
-describe Flexirest::RequestFiltering do
+describe Flexirest::Callbacks do
   let(:request) { OpenStruct.new(get_params:{}, post_params:{}, url:"http://www.example.com", headers:Flexirest::HeadersList.new) }
   let(:response) { OpenStruct.new(body:"") }
 
   it "should call through to adjust the parameters" do
-    RequestFilteringExample._filter_request(:before, :test, request)
-    expect(request.get_params).to have_key(:filter1)
+    CallbacksExample._callback_request(:before, :test, request)
+    expect(request.get_params).to have_key(:callback1)
   end
 
-  it "should call through for more than one filter" do
-    RequestFilteringExample._filter_request(:before, :test, request)
-    expect(request.get_params).to have_key(:filter1)
-    expect(request.post_params).to have_key(:post_filter1)
+  it "should call through for more than one callback" do
+    CallbacksExample._callback_request(:before, :test, request)
+    expect(request.get_params).to have_key(:callback1)
+    expect(request.post_params).to have_key(:post_callback1)
   end
 
-  it "should allow adjusting the URL via a named filter" do
-    RequestFilteringExample._filter_request(:before, :test, request)
+  it "should allow adjusting the URL via a named callback" do
+    CallbacksExample._callback_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(:before, :test, request)
+  it "should allow adjusting the URL via a named callback as an instance method" do
+    CallbacksExample._callback_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(:before, :test, request)
+  it "should allow callbacks to be set on the parent or on the child" do
+    SubClassedCallbacksExample._callback_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(:before, :test, request)
+  it "should allow callbacks to add custom headers" do
+    CallbacksExample._callback_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)
+    CallbacksExample._callback_request(:after, :test, response)
     expect(response.body).to eq("{test: 1}")
   end
 end

data/spec/lib/proxy_spec.rb

@@ -194,7 +194,7 @@ describe Flexirest::Base do
     expect(ret.name).to eq("Johnny")
   end
 
-  it "can force the URL from a filter without it being passed through URL replacement" do
+  it "can force the URL from a callback without it being passed through URL replacement" do
     expect_any_instance_of(Flexirest::Connection).to receive(:get).with("/hal_test/1", instance_of(Hash)).and_return(::FaradayResponseMock.new(OpenStruct.new(body:"{\"result\":true}", status:200, response_headers:{})))
     expect_any_instance_of(Flexirest::Connection).to receive(:get).with("/this/is/a/test", instance_of(Hash)).and_return(::FaradayResponseMock.new(OpenStruct.new(body:"{\"result\":true}", status:200, response_headers:{})))
     expect(ProxyClientExample.hal_test(id:1).test.result).to eq(true)
@@ -203,10 +203,8 @@ describe Flexirest::Base do
   it "properly passes basic HTTP auth credentials" do
     host, credentials, url_path = 'www.example.com', 'user:pass', '/getAll?id=1'
     ProxyClientExample.base_url "http://#{credentials}@#{host}"
-    stub_request(:get, "#{host}#{url_path}")
+    stub_request(:get, "http://#{credentials}@#{host}#{url_path}")
     ProxyClientExample.all(id:1)
-    expect(a_request(:get, "#{host}#{url_path}").with(headers: {
-      'Authorization'=>"Basic #{Base64.strict_encode64(credentials)}"
-    })).to have_been_made
+    expect(a_request(:get, "#{credentials}@#{host}#{url_path}")).to have_been_made
   end
 end

data/spec/lib/request_spec.rb

@@ -80,7 +80,7 @@ describe Flexirest::Request do
       post :create, "/create"
     end
 
-    class FilteredBodyExampleClient < ExampleClient
+    class CallbackBodyExampleClient < ExampleClient
       base_url "http://www.example.com"
       before_request do |name, request|
         request.body = MultiJson.dump(request.post_params)
@@ -312,6 +312,11 @@ describe Flexirest::Request do
     expect(ExampleClient.plain(id:1234)).to be_a(Flexirest::PlainResponse)
   end
 
+  it "should return true from 204 with empty bodies" do
+    expect_any_instance_of(Flexirest::Connection).to receive(:get).with(any_args).and_return(::FaradayResponseMock.new(OpenStruct.new(status:204, response_headers:{}, body: nil)))
+    expect(ExampleClient.all).to be_truthy
+  end
+
   it "should return a lazy loader object if lazy loading is enabled" do
     object = LazyLoadedExampleClient.fake id:1234, debug:true
     expect(object).to be_an_instance_of(Flexirest::LazyLoader)
@@ -640,7 +645,7 @@ describe Flexirest::Request do
       def username ; end
       def password ; end
       def name ; end
-      def _filter_request(*args) ; end
+      def _callback_request(*args) ; end
       def verbose ; false ; end
     end
     fake_object = RequestFakeObject.new
@@ -649,20 +654,20 @@ describe Flexirest::Request do
     expect{request.call}.to raise_error(Flexirest::InvalidRequestException)
   end
 
-  it "should send all class mapped methods through _filter_request" do
+  it "should send all class mapped methods through _callback_request" do
     expect_any_instance_of(Flexirest::Connection).to receive(:get).with("/", an_instance_of(Hash)).and_return(::FaradayResponseMock.new(OpenStruct.new(body:"{\"first_name\":\"Johnny\", \"expenses\":[{\"amount\":1}, {\"amount\":2}]}", status:200, response_headers:{})))
-    expect(ExampleClient).to receive(:_filter_request).with(any_args).exactly(2).times
+    expect(ExampleClient).to receive(:_callback_request).with(any_args).exactly(2).times
     ExampleClient.all
   end
 
-  it "should send all instance mapped methods through _filter_request" do
+  it "should send all instance mapped methods through _callback_request" do
     expect_any_instance_of(Flexirest::Connection).to receive(:get).with("/", an_instance_of(Hash)).and_return(::FaradayResponseMock.new(OpenStruct.new(body:"{\"first_name\":\"Johnny\", \"expenses\":[{\"amount\":1}, {\"amount\":2}]}", status:200, response_headers:{})))
-    expect(ExampleClient).to receive(:_filter_request).with(any_args).exactly(2).times
+    expect(ExampleClient).to receive(:_callback_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
+  it "should change the generated object if an after_request changes it" do
     expect_any_instance_of(Flexirest::Connection).to receive(:get).with("/change", an_instance_of(Hash)).and_return(::FaradayResponseMock.new(OpenStruct.new(body:"{\"first_name\":\"Johnny\", \"expenses\":[{\"amount\":1}, {\"amount\":2}]}", status:200, response_headers:{})))
     obj = ExampleClient.change
     expect(obj.test).to eq(1)
@@ -737,7 +742,7 @@ describe Flexirest::Request do
         end
 
         def name ; end
-        def _filter_request(*args) ; end
+        def _callback_request(*args) ; end
       end
       fake_object = RequestFakeObject.new
       request = Flexirest::Request.new(method, fake_object, {})
@@ -784,9 +789,9 @@ describe Flexirest::Request do
     end
   end
 
-  it "replaces the body completely in a filter" do
+  it "replaces the body completely in a callback" do
     expect_any_instance_of(Flexirest::Connection).to receive(:post).with("/save", "{\"id\":1234,\"name\":\"john\"}", an_instance_of(Hash)).and_return(::FaradayResponseMock.new(OpenStruct.new(body:"{}", response_headers:{})))
-    FilteredBodyExampleClient.save id:1234, name:'john'
+    CallbackBodyExampleClient.save id:1234, name:'john'
   end
 
   context 'Simulating Faraday connection in_parallel' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flexirest
 version: !ruby/object:Gem::Version
-  version: 1.3.20
+  version: 1.3.21
 platform: ruby
 authors:
 - Andy Jeffries
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-21 00:00:00.000000000 Z
+date: 2016-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -236,6 +236,7 @@ files:
 - lib/flexirest/attribute_parsing.rb
 - lib/flexirest/base.rb
 - lib/flexirest/caching.rb
+- lib/flexirest/callbacks.rb
 - lib/flexirest/configuration.rb
 - lib/flexirest/connection.rb
 - lib/flexirest/connection_manager.rb
@@ -251,7 +252,6 @@ files:
 - lib/flexirest/recording.rb
 - lib/flexirest/request.rb
 - lib/flexirest/request_delegator.rb
-- lib/flexirest/request_filtering.rb
 - lib/flexirest/result_iterator.rb
 - lib/flexirest/validation.rb
 - lib/flexirest/version.rb
@@ -259,6 +259,7 @@ files:
 - spec/lib/attribute_parsing_spec.rb
 - spec/lib/base_spec.rb
 - spec/lib/caching_spec.rb
+- spec/lib/callbacks_spec.rb
 - spec/lib/configuration_spec.rb
 - spec/lib/connection_manager_spec.rb
 - spec/lib/connection_spec.rb
@@ -272,7 +273,6 @@ files:
 - spec/lib/plain_response_spec.rb
 - spec/lib/proxy_spec.rb
 - spec/lib/recording_spec.rb
-- spec/lib/request_filtering_spec.rb
 - spec/lib/request_spec.rb
 - spec/lib/result_iterator_spec.rb
 - spec/lib/validation_spec.rb
@@ -310,6 +310,7 @@ test_files:
 - spec/lib/attribute_parsing_spec.rb
 - spec/lib/base_spec.rb
 - spec/lib/caching_spec.rb
+- spec/lib/callbacks_spec.rb
 - spec/lib/configuration_spec.rb
 - spec/lib/connection_manager_spec.rb
 - spec/lib/connection_spec.rb
@@ -323,7 +324,6 @@ test_files:
 - spec/lib/plain_response_spec.rb
 - spec/lib/proxy_spec.rb
 - spec/lib/recording_spec.rb
-- spec/lib/request_filtering_spec.rb
 - spec/lib/request_spec.rb
 - spec/lib/result_iterator_spec.rb
 - spec/lib/validation_spec.rb

data/lib/flexirest/request_filtering.rb

@@ -1,63 +0,0 @@
-module Flexirest
-  module RequestFiltering
-    module ClassMethods
-      def before_request(method_name = nil, &block)
-        @before_filters ||= []
-        if block
-          @before_filters << block
-        elsif method_name
-          @before_filters << method_name
-        end
-      end
-
-      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)
-        @before_filters ||= []
-        @after_filters ||= []
-        filters = (type == :before ? @before_filters : @after_filters)
-        filters.each do |filter|
-          if filter.is_a? Symbol
-            if self.respond_to?(filter)
-              self.send(filter, name, param)
-            else
-              instance = self.new
-              instance.send(filter, name, param)
-            end
-          else
-            filter.call(name, param)
-          end
-        end
-      end
-
-      def _handle_super_class_filters(type, name, request)
-        @parents ||= []
-        @parents.each do |parent|
-          parent._filter_request(type, name, request)
-        end
-      end
-
-      def _parents
-        @parents ||= []
-      end
-
-      def inherited(subclass)
-        subclass._parents << self
-        super
-      end
-    end
-
-    def self.included(base)
-      base.extend(ClassMethods)
-    end
-
-  end
-end