flexirest 1.7.2 → 1.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ddeed579fa942a385f6b7abb6c67ce95cbec9663
-  data.tar.gz: f95768e9b39ffe1df399d531e12fd3f76a40424f
+  metadata.gz: 4588448f89d5370f5b208ad7185537c4c70fac4d
+  data.tar.gz: b496d2852fdacc8ef9656656e96a5a469419de4e
 SHA512:
-  metadata.gz: 8f3eecbc6d5a7b3075b616c30eb2bb1f0d8ead60605b719cd2f3289e7ecc59e2c3333ec6b9171d2a15869a44521fa3060a3d2b3c12d0f109e0685d9fbc073b5f
-  data.tar.gz: d382545e8d5e382affc6780a5d4478acb9fc17181e8637e0ce665f64ac07bdfff220e99a6e0b3a80692a5b35ff19fbf5f45f220648c2817a61a732e645e7ac0d
+  metadata.gz: 055f11c39ba735be43fdb5bebabb77d9c1912fded9cfe0040c06dfe4b12b33f093b8dc60295cb8abf7ccd8bac4ffd40b0729e6b47bd179b262818848e12490d6
+  data.tar.gz: c131e203c28350206d3f18ddaeb0c6610b099f192e8c85d7f29756343da06bdcd1875636067465ff136d750a12ed23d7690bc7bcadead01cc7380f85fe7f2a89

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## 1.7.3
+
+Bugfix:
+
+- Form encoded requests should also honour `wrap_root` (thanks to noctivityinc for the issue report)
+
+Feature:
+
+- Returning `false` from a callback will halt the callback chain and cancel the request (thanks to noctivityinc for the feature request)
+
 ## 1.7.2
 
 Bugfix:

data/docs/using-callbacks.md

@@ -108,6 +108,8 @@ class Person < Flexirest::Base
 end
 ```
 
+If you want to cancel the request from within a callback, you can simply return `false` and the mapped method result will also be `false`, however, we would normally advocate raising an exception so the reason for the callback failure is more explicit.
+
 
 -----
 

data/lib/flexirest/callbacks.rb

@@ -35,6 +35,9 @@ module Flexirest
           else
             result = callback.call(name, param)
           end
+          if result == false
+            return false
+          end
           if result == :retry
             return :retry
           end

data/lib/flexirest/request.rb

@@ -192,10 +192,14 @@ 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(:_callback_request, :before, @method[:name], self)
+          callback_result = @object.send(:_callback_request, :before, @method[:name], self)
         else
-          @object.class.send(:_callback_request, :before, @method[:name], self)
+          callback_result = @object.class.send(:_callback_request, :before, @method[:name], self)
         end
+        if callback_result == false
+          return false
+        end
+
         append_get_parameters
         prepare_request_body
         self.original_url = self.url
@@ -405,7 +409,11 @@ module Flexirest
         elsif @post_params.is_a?(String)
           @post_params
         else
-          (params || @post_params || {}).to_query
+          p = (params || @post_params || {})
+          if @method[:options][:wrap_root].present?
+            p = {@method[:options][:wrap_root] => p}
+          end
+          p.to_query
         end
         headers["Content-Type"] ||= "application/x-www-form-urlencoded"
       elsif request_body_type == :json

data/lib/flexirest/version.rb

@@ -1,3 +1,3 @@
 module Flexirest
-  VERSION = "1.7.2"
+  VERSION = "1.7.3"
 end

data/spec/lib/request_spec.rb

@@ -15,6 +15,12 @@ describe Flexirest::Request do
         end
       end
 
+      before_request do |name, request|
+        if request.method[:name] == :cancel_callback
+          false
+        end
+      end
+
       after_request do |name, response|
         if name == :change
           response.body = "{\"test\": 1}"
@@ -27,6 +33,7 @@ describe Flexirest::Request do
       get :babies, "/babies", :has_many => {:children => ExampleOtherClient}
       get :single_association, "/single", :has_one => {:single => ExampleSingleClient}, :has_many => {:children => ExampleOtherClient}
       get :headers, "/headers"
+      get :cancel_callback, "/cancel-callback"
       put :headers_default, "/headers_default"
       put :headers_json, "/headers_json", request_body_type: :json
       get :find, "/:id", required: [:id]
@@ -290,6 +297,11 @@ describe Flexirest::Request do
     ExampleClient.update id:1234, debug:true
   end
 
+  it "should pass through url parameters and get parameters" do
+    expect_any_instance_of(Flexirest::Connection).to_not receive(:get)
+    ExampleClient.cancel_callback
+  end
+
   it "should pass through 'array type' get parameters" do
     expect_any_instance_of(Flexirest::Connection).to receive(:get).with("/?include%5B%5D=your&include%5B%5D=friends", an_instance_of(Hash)).and_return(::FaradayResponseMock.new(OpenStruct.new(body:"{\"result\":true}", response_headers:{})))
     ExampleClient.all :include => [:your,:friends]
@@ -317,6 +329,11 @@ describe Flexirest::Request do
     ExampleClient.wrapped id:1234, debug:true, test:'foo'
   end
 
+  it "should wrap elements if specified, in form-encoded format" do
+    expect_any_instance_of(Flexirest::Connection).to receive(:put).with("/put/1234", %q(example%5Bdebug%5D=true&example%5Btest%5D=foo), an_instance_of(Hash)).and_return(::FaradayResponseMock.new(OpenStruct.new(body:"{\"result\":true}", response_headers:{})))
+    ExampleClient.wrapped id:1234, debug:true, test:'foo'
+  end
+
   it "should not pass through an encoded empty body parameter" do
     expect_any_instance_of(Flexirest::Connection).to receive(:get).with("/1234", an_instance_of(Hash)).and_return(::FaradayResponseMock.new(OpenStruct.new(body:"{\"result\":true}", response_headers:{})))
     ExampleClient.request_body_type :json

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flexirest
 version: !ruby/object:Gem::Version
-  version: 1.7.2
+  version: 1.7.3
 platform: ruby
 authors:
 - Andy Jeffries
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-28 00:00:00.000000000 Z
+date: 2018-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler