flexirest 1.5.9 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2e9ebcb294d7f5316e0a89a7805ff160801d4979
-  data.tar.gz: c72f3a2d84d9899c3f218458f6506b4ce3d5f46b
+  metadata.gz: 8959a6f4a0183bc9395d12c61676d30da8157f30
+  data.tar.gz: dedf65e6535a9da183a39a8cae90aea1c95584f6
 SHA512:
-  metadata.gz: 3c24542bfe2f4c19b11d75a7942019ba7d3264a998d3333b5bd86031048266df58e072ec95f4578c885b6f953b09129abf773cb4cb9a9a3ab7975d3c1a75d266
-  data.tar.gz: 06aecf662c5f925856d8f6f99b79027f073248e947ef4e53718d23fd674c4402f18b4902a4cec092b7750fbb364ad19c77d1752a88345cc5dfa42b872a0cc364
+  metadata.gz: 49edb2862a956a893d484d01a9baab9a53645129d29c8445cbabb59684355381b8127d3be16ec93d7b67b033984247efe9a6b74654ab579829a59ad661f9729d
+  data.tar.gz: 1edb7882ab1e52bfbffebf5940c53e95f878a9665aa2c07a8789a1f038b62c60b04f514d491b54c3964cef0b49753effffa97d1b0621e490633937f9f1da4c1d

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 1.6.0
+
+Feature:
+
+- APIs that expect request bodies to have a wrapping element can now have this specified at mapping time.
+
 ## 1.5.9
 
 Bugfix:

data/README.md

@@ -1026,16 +1026,36 @@ class Person < Flexirest::Base
 end
 ```
 
-### Root element removal
+### Root elements
 
 If your JSON or XML object comes back with a root node and you'd like to ignore it, you can define the mapping as:
 
 ```ruby
 class Feed < Flexirest::Base
-  get :list, "/feed", ignore_root: "feed"
+  post :list, "/feed", ignore_root: "feed"
 end
 ```
 
+Alternatively if you want to wrap your JSON request body in a root element, e.g.:
+
+```json
+{
+  "feed": {
+    "id": 1
+  }
+}
+```
+
+You can do it like this:
+
+```ruby
+class Feed < Flexirest::Base
+  post :list, "/feed", wrap_root: "feed"
+end
+
+Feed.list(id: 1)
+```
+
 ### Required Parameters
 
 If you want to specify that certain parameters are required for a specific call, you can specify them like:

data/lib/flexirest/request.rb

@@ -402,7 +402,11 @@ module Flexirest
         elsif @post_params.is_a?(String)
           @post_params
         else
-          (params || @post_params || {}).to_json
+          if @method[:options][:wrap_root].present?
+            {@method[:options][:wrap_root] => (params || @post_params || {})}.to_json
+          else
+            (params || @post_params || {}).to_json
+          end
         end
         headers["Content-Type"] ||= "application/json; charset=utf-8"
       end

data/lib/flexirest/version.rb

@@ -1,3 +1,3 @@
 module Flexirest
-  VERSION = "1.5.9"
+  VERSION = "1.6.0"
 end

data/spec/lib/request_spec.rb

@@ -36,6 +36,7 @@ describe Flexirest::Request do
       post :test_encoding, "/encoding", request_body_type: :json
       post :testing_no_content_headers, "/no-content"
       put :update, "/put/:id"
+      put :wrapped, "/put/:id", wrap_root: "example"
       put :conversion, "/put/:id", parse_fields: [:converted]
       delete :remove, "/remove/:id"
       delete :remove_body, "/remove/:id", send_delete_body: true
@@ -282,6 +283,12 @@ describe Flexirest::Request do
     ExampleClient.update id:1234, debug:true, test:'foo'
   end
 
+  it "should encode the body in a JSON format if specified" do
+    expect_any_instance_of(Flexirest::Connection).to receive(:put).with("/put/1234", %q({"example":{"debug":true,"test":"foo"}}), an_instance_of(Hash)).and_return(::FaradayResponseMock.new(OpenStruct.new(body:"{\"result\":true}", response_headers:{})))
+    ExampleClient.request_body_type :json
+    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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flexirest
 version: !ruby/object:Gem::Version
-  version: 1.5.9
+  version: 1.6.0
 platform: ruby
 authors:
 - Andy Jeffries