flexirest 1.10.2 → 1.10.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8001a7a20f2054fd34a7f09ae350253da96eba3dc4ff8b390e5b07509f1f09ea
-  data.tar.gz: 8f96916235d0f45fa9aa1c3ff5f37502f81c5d2f2a1c5db079d72e63d0de923c
+  metadata.gz: 53b34d9600101b9d80a61559054a3599242a7739b12845df02bde410c5858d94
+  data.tar.gz: e7398bcc97a8a0f89fb3380110e126e482d5fc1e14a973dd9e34208f28634814
 SHA512:
-  metadata.gz: ad2e6dad01ee45f4d0b0540b53e8c6f20329d94cae6364f59d281ede3c45955959d3ecb70762249911cf05cc637840ba7e88a1c2fac49ff329ad3de680f643b3
-  data.tar.gz: de207d3cb3ac7bb243137925217efc0067d7c80950bac1a6a02450f251da0380470866e448ffd5c876e6009ed07b2cf0573ad82ce0782ad07cfb53c839a8e70d
+  metadata.gz: 32014dfe143032f040ae140cdcf562f05832f74d0b05e692b8f866d4636363b6f7ffcbe0a4de0e7a895c8b1722aef0f6736f34c130916dc5c02869caa198434a
+  data.tar.gz: a7f3cb00fd3451c4f06ef32bf6e148f90d4046c1cce7526a8bfe6c247e2d65dcd68a0d924f85683ef052929432ddf341768578a7591b37db8b7729ed96053c80

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 1.10.3
+
+Enhancement:
+
+- Ignore/wrap root functionality available for all routes, rather than just route specifically (thanks to Sampat Badhe for the PR)
+
 ## 1.10.2
 
 Bugfix:

data/docs/filtering-result-lists.md

@@ -1,6 +1,6 @@
 # *Flexirest:* Filtering result lists
 
-If the API returns a JSON list of items, this is retured to you as a `Flexirest::ResultIterator` object. A `ResultIterator` sorts simple filtering of the list using a `where` method based on values matching a specified criteria (or matching using regular expressions):
+If the API returns a JSON list of items, this is returned to you as a `Flexirest::ResultIterator` object. A `ResultIterator` sorts simple filtering of the list using a `where` method based on values matching a specified criteria (or matching using regular expressions):
 
 ```ruby
 class Article < Flexirest::Base

data/docs/proxying-apis.md

@@ -40,7 +40,7 @@ Article.all.first_name == "Billy"
 This example does two things:
 
 1. It rewrites the incoming URL for any requests matching "_/all_" to "/all_people"
-2. It uses the `translate` method to move the "fname" attribute from the response body to be called "first_name". The translate method must return the new object at the end (either the existing object alterered, or a new object to replace it with)
+2. It uses the `translate` method to move the "fname" attribute from the response body to be called "first_name". The translate method must return the new object at the end (either the existing object altered, or a new object to replace it with)
 
 As the comment shows, you can use `url value` to set the request URL to a particular value, or you can call `gsub!` on the url to replace parts of it using more complicated regular expressions.
 

data/docs/raw-requests.md

@@ -12,7 +12,7 @@ people = Person._request('http://api.example.com/v1/people') # Defaults to get w
 Person._request('http://api.example.com/v1/people', :post, {id:1234,name:"John"}) # Post with parameters
 ```
 
-When you need to specify custom headers (for example for authentication) you can do this with a fourth option to the `_request` method. If you are using the default paramaters you'll need to specify them. For example:
+When you need to specify custom headers (for example for authentication) you can do this with a fourth option to the `_request` method. If you are using the default parameters you'll need to specify them. For example:
 
 ```ruby
 Person._request("http://api.example.com/v1/people", :get, {}, {headers:{"X-Something": "foo/bar"}})

data/docs/root-elements.md

@@ -2,13 +2,32 @@
 
 If your response comes back with a root node and you'd like to ignore it, you can define the mapping as:
 
+```ruby
+Flexirest::Base.ignore_root = "data"
+```
+
+Any `ignore_root` setting in specific class overrides this declared default.
+
 ```ruby
 class Feed < Flexirest::Base
-  post :list, "/feed", ignore_root: "feed"
+  ignore_root: "feed"
+
+  post :list, "/feed"
+end
+```
+
+And any `ignore_root` setting in specific request overrides the both default and class specific setting.
+
+
+```ruby
+class Feed < Flexirest::Base
+  ignore_root: 'feed'
+
+  post :list, "/feed", ignore_root: "result"
 end
 ```
 
-This also works if you'd want to remove a tree of root nodes:
+You can also assign an array to `ignore_root` if you'd want to remove a tree of root nodes.
 
 ```ruby
 class Feed < Flexirest::Base
@@ -26,16 +45,32 @@ Alternatively if you want to wrap your JSON request body in a root element, e.g.
 }
 ```
 
-You can do it like this:
+You can do it using `wrap_root`:
+
+```ruby
+Flexirest::Base.wrap_root = "data"
+```
+
+Any `wrap_root` setting in specific class overrides this declared default.
 
 ```ruby
 class Feed < Flexirest::Base
-  post :list, "/feed", wrap_root: "feed"
-end
+  wrap_root: "feed"
 
-Feed.list(id: 1)
+  post :list, "/feed"
+end
 ```
 
+And any `wrap_root` setting in specific request overrides the both default and class specific setting.
+
+
+```ruby
+class Feed < Flexirest::Base
+  wrap_root: 'feed'
+
+  post :list, "/feed", wrap_root: "data"
+end
+```
 
 -----
 

data/flexirest.gemspec

@@ -39,7 +39,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "api-auth", ">= 1.3.1", "< 2.4"
   spec.add_development_dependency 'typhoeus'
   spec.add_development_dependency 'activemodel'
-  spec.add_development_dependency 'rest-client', ">= 1.8.0"
+  spec.add_development_dependency 'rest-client'
 
   spec.add_runtime_dependency "mime-types"
   spec.add_runtime_dependency "multi_json"

data/lib/flexirest/configuration.rb

@@ -13,6 +13,32 @@ module Flexirest
       @api_auth_access_id = nil
       @api_auth_secret_key = nil
       @api_auth_options = {}
+      @ignore_root = nil
+      @wrap_root = nil
+
+      def ignore_root(value=nil)
+        if value.nil?
+          value = if @ignore_root.nil? && superclass.respond_to?(:ignore_root)
+            superclass.ignore_root
+          else
+            @ignore_root
+          end
+        else
+          @ignore_root = value
+        end
+      end
+
+      def wrap_root(value=nil)
+        if value.nil?
+          value = if @wrap_root.nil? && superclass.respond_to?(:wrap_root)
+            superclass.wrap_root
+          else
+            @wrap_root
+          end
+        else
+          @wrap_root = value
+        end
+      end
 
       def base_url(value = nil)
         @base_url ||= nil

data/lib/flexirest/request.rb

@@ -136,6 +136,30 @@ module Flexirest
       end
     end
 
+    def ignore_root
+      if @method[:options][:ignore_root]
+        @method[:options][:ignore_root]
+      elsif @object.nil?
+        nil
+      elsif object_is_class?
+        @object.ignore_root
+      else
+        @object.class.ignore_root
+      end
+    end
+
+    def wrap_root
+      if @method[:options][:wrap_root]
+        @method[:options][:wrap_root]
+      elsif @object.nil?
+        nil
+      elsif object_is_class?
+        @object.wrap_root
+      else
+        @object.class.wrap_root
+      end
+    end
+
     def verbose?
       if object_is_class?
         @object.verbose
@@ -438,8 +462,8 @@ module Flexirest
           @post_params
         else
           p = (params || @post_params || {})
-          if @method[:options][:wrap_root].present?
-            p = {@method[:options][:wrap_root] => p}
+          if wrap_root.present?
+            p = {wrap_root => p}
           end
           p.to_query
         end
@@ -452,8 +476,8 @@ module Flexirest
           @post_params
         else
           p = (params || @post_params || {})
-          if @method[:options][:wrap_root].present?
-            p = {@method[:options][:wrap_root] => p}
+          if wrap_root.present?
+            p = {wrap_root => p}
           end
           data, mp_headers = Flexirest::Multipart::Post.prepare_query(p)
           mp_headers.each do |k,v|
@@ -467,8 +491,8 @@ module Flexirest
         elsif @post_params.is_a?(String)
           @post_params
         else
-          if @method[:options][:wrap_root].present?
-            {@method[:options][:wrap_root] => (params || @post_params || {})}.to_json
+          if wrap_root.present?
+            {wrap_root => (params || @post_params || {})}.to_json
           else
             (params || @post_params || {}).to_json
           end
@@ -601,7 +625,7 @@ module Flexirest
           else
             Flexirest::Logger.debug "  \033[1;4;32m#{Flexirest.name}\033[0m #{@instrumentation_name} - Response received #{@response.body.size} bytes"
           end
-          result = generate_new_object(ignore_root: @method[:options][:ignore_root], ignore_xml_root: @method[:options][:ignore_xml_root])
+          result = generate_new_object(ignore_root: ignore_root, ignore_xml_root: @method[:options][:ignore_xml_root])
           # TODO: Cleanup when ignore_xml_root is removed
         else
           raise ResponseParseException.new(status:status, body:@response.body, headers: @response.headers)
@@ -814,15 +838,15 @@ module Flexirest
           body = JsonAPIProxy::Response.parse(body, @object)
         end
 
-        if options[:ignore_root]
-          [options[:ignore_root]].flatten.each do |key|
+        if ignore_root
+          [ignore_root].flatten.each do |key|
             body = body[key.to_s]
           end
         end
       elsif is_xml_response?
         body = @response.body.blank? ? {} : Crack::XML.parse(@response.body)
-        if options[:ignore_root]
-          [options[:ignore_root]].flatten.each do |key|
+        if ignore_root
+          [ignore_root].flatten.each do |key|
             body = body[key.to_s]
           end
         elsif options[:ignore_xml_root]

data/lib/flexirest/version.rb

@@ -1,3 +1,3 @@
 module Flexirest
-  VERSION = "1.10.2"
+  VERSION = "1.10.3"
 end

data/spec/lib/request_spec.rb

@@ -199,6 +199,89 @@ describe Flexirest::Request do
       }
     end
 
+    class LocalIgnoredRootExampleClient < ExampleClient
+      ignore_root "feed"
+
+      get :root, "/root", fake: %Q{
+        {
+          "feed": {
+            "title": "Example Feed"
+          }
+        }
+      }
+    end
+
+    class LocalIgnoredMultiLevelRootExampleClient < ExampleClient
+      ignore_root [:response, "data", "object"]
+
+      get :multi_level_root, "/multi-level-root", fake: %Q{
+        {
+          "response": {
+            "data": {
+              "object": {
+                "title": "Example Multi Level Feed"
+              }
+            }
+          }
+        }
+      }
+    end
+
+    class BaseIgnoredRootExampleClient < Flexirest::Base
+      base_url "http://www.example.com"
+      ignore_root "feed"
+    end
+
+    class GlobalIgnoredRootExampleClient < BaseIgnoredRootExampleClient
+      get :root, "/root", fake: %Q{
+        {
+          "feed": {
+            "title": "Example Feed"
+          }
+        }
+      }
+    end
+
+    class OverrideGlobalIgnoredRootForFileExampleClient < BaseIgnoredRootExampleClient
+      ignore_root "data"
+
+      get :root, "/root", fake: %Q{
+        {
+          "data": {
+            "title": "Example Feed"
+          }
+        }
+      }
+    end
+
+    class OverrideGlobalIgnoredRootForRequestExampleClient < BaseIgnoredRootExampleClient
+      get :root, "/root", ignore_root: "data", fake: %Q{
+        {
+          "data": {
+            "title": "Example Feed"
+          }
+        }
+      }
+    end
+
+    class BaseWrappedRootExampleClient < Flexirest::Base
+      base_url "http://www.example.com"
+      wrap_root "base_data"
+    end
+
+    class GlobalWrappedRootExampleClient < BaseWrappedRootExampleClient
+      put :wrapped, "/put/:id"
+    end
+
+    class OverrideGlobalWrappedRootForFileExampleClient < BaseWrappedRootExampleClient
+      wrap_root "class_specific_data"
+      put :wrapped, "/put/:id"
+    end
+
+    class OverrideGlobalWrappedRootForRequestExampleClient < BaseWrappedRootExampleClient
+      put :wrapped, "/put/:id", wrap_root: "request_specific_data"
+    end
+
     class WhitelistedDateClient < Flexirest::Base
       base_url "http://www.example.com"
       put :conversion, "/put/:id"
@@ -1355,6 +1438,62 @@ describe Flexirest::Request do
     expect(IgnoredMultiLevelRootExampleClient.multi_level_root.title).to eq("Example Multi Level Feed")
   end
 
+  it "should ignore a specified root element" do
+    expect(LocalIgnoredRootExampleClient.root.title).to eq("Example Feed")
+  end
+
+  it "should ignore a specified multi-level root element" do
+    expect(LocalIgnoredMultiLevelRootExampleClient.multi_level_root.title).to eq("Example Multi Level Feed")
+  end
+
+  it "should ignore a specified root element" do
+    expect(GlobalIgnoredRootExampleClient.root.title).to eq("Example Feed")
+  end
+
+  it "should ignore a specified root element" do
+    expect(OverrideGlobalIgnoredRootForFileExampleClient.root.title).to eq("Example Feed")
+  end
+
+  it "should ignore a specified root element" do
+    expect(OverrideGlobalIgnoredRootForRequestExampleClient.root.title).to eq("Example Feed")
+  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(base_data%5Bdebug%5D=true&base_data%5Btest%5D=foo), an_instance_of(Hash)).and_return(::FaradayResponseMock.new(OpenStruct.new(body:"{\"result\":true}", response_headers:{})))
+    GlobalWrappedRootExampleClient.request_body_type :form_encoded
+    GlobalWrappedRootExampleClient.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(class_specific_data%5Bdebug%5D=true&class_specific_data%5Btest%5D=foo), an_instance_of(Hash)).and_return(::FaradayResponseMock.new(OpenStruct.new(body:"{\"result\":true}", response_headers:{})))
+    OverrideGlobalWrappedRootForFileExampleClient.request_body_type :form_encoded
+    OverrideGlobalWrappedRootForFileExampleClient.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(request_specific_data%5Bdebug%5D=true&request_specific_data%5Btest%5D=foo), an_instance_of(Hash)).and_return(::FaradayResponseMock.new(OpenStruct.new(body:"{\"result\":true}", response_headers:{})))
+    OverrideGlobalWrappedRootForRequestExampleClient.request_body_type :form_encoded
+    OverrideGlobalWrappedRootForRequestExampleClient.wrapped id:1234, debug:true, test:'foo'
+  end
+
+  it "should encode the body wrapped in a root element in a JSON format if specified" do
+    expect_any_instance_of(Flexirest::Connection).to receive(:put).with("/put/1234", %q({"base_data":{"debug":true,"test":"foo"}}), an_instance_of(Hash)).and_return(::FaradayResponseMock.new(OpenStruct.new(body:"{\"result\":true}", response_headers:{})))
+    GlobalWrappedRootExampleClient.request_body_type :json
+    GlobalWrappedRootExampleClient.wrapped id:1234, debug:true, test:'foo'
+  end
+
+  it "should encode the body wrapped in a root element in a JSON format if specified" do
+    expect_any_instance_of(Flexirest::Connection).to receive(:put).with("/put/1234", %q({"class_specific_data":{"debug":true,"test":"foo"}}), an_instance_of(Hash)).and_return(::FaradayResponseMock.new(OpenStruct.new(body:"{\"result\":true}", response_headers:{})))
+    OverrideGlobalWrappedRootForFileExampleClient.request_body_type :json
+    OverrideGlobalWrappedRootForFileExampleClient.wrapped id:1234, debug:true, test:'foo'
+  end
+
+  it "should encode the body wrapped in a root element in a JSON format if specified" do
+    expect_any_instance_of(Flexirest::Connection).to receive(:put).with("/put/1234", %q({"request_specific_data":{"debug":true,"test":"foo"}}), an_instance_of(Hash)).and_return(::FaradayResponseMock.new(OpenStruct.new(body:"{\"result\":true}", response_headers:{})))
+    OverrideGlobalWrappedRootForRequestExampleClient.request_body_type :json
+    OverrideGlobalWrappedRootForRequestExampleClient.wrapped id:1234, debug:true, test:'foo'
+  end
+
   context "Parameter preparation" do
     method = {url: "http://www.example.com", method: :get}
     object = nil

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flexirest
 version: !ruby/object:Gem::Version
-  version: 1.10.2
+  version: 1.10.3
 platform: ruby
 authors:
 - Andy Jeffries
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-26 00:00:00.000000000 Z
+date: 2021-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -176,14 +176,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: mime-types
   requirement: !ruby/object:Gem::Requirement