flexirest 1.10.8 → 1.10.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b83cde99ff35cebe79fea42a56376731df479a41668d080adc68ff5be4a24dc
-  data.tar.gz: 9170fdcf1afaa4d94d55d13b67c406ef470d3793ea9c7738416cd55b4fdc8107
+  metadata.gz: '010099426a7d7332a404d79bb7efa98c7c236b3ccf6124c2c300e276b1d5192a'
+  data.tar.gz: 15c9b6e809ac7c0dc0fd3f254efb9f8f69ca4255b5e4e888907fab252efadfd4
 SHA512:
-  metadata.gz: 70e59dcfcfc93ce1af97961756bc92c6f53f3d438afea748c918cad5b00583afda7678de691a8ce0bf7f2e45619d73adba2b3c5be4a80c29fd80550fccb9e62b
-  data.tar.gz: 953064ac2ad371bc5d793291ceef862092983a34489b6e5780b7f4d84a4d568e4520b50df41ebd8f9663412a80feeeac1562767ff879eedae235576284fc3771
+  metadata.gz: c540558e844d25850a99b56e1a85ef919832ebc3496d26689d80080a39e2e635ff2df2a53b234740cf79c7119c0fb8ff91296e0e119e1eaf06525d72d8f1fdf6
+  data.tar.gz: 887afa323b740f966bd4c481066d7109fab4212d3b940b5c2c4603675d7f3f6f423bd54e8401bb1ed09e21f4856a5ebab1d96c05fbe57864663da9b32051ee7a

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 1.10.9
+
+Bugfix:
+
+- Correctly handle a 204 response to not wipe an instance's attributes (thanks to @couchbelag for the issue)
+- Add an option to handle a 200 response with an empty body to not wipe an instance's attributes (thanks to @couchbelag for the issue)
+- Fixed a couple of typos in error messages (thanks to Sampat Badhe/@sampatbadhe for the PR)
+
 ## 1.10.8
 
 Bugfix:

data/README.md

@@ -4,7 +4,7 @@
 >
 > Write your API classes in an ActiveRecord-style; like ActiveResource but Flexirest works where the resource naming doesn't follow Rails conventions, it has built-in caching and is much more flexible.
 
-[![Build](https://github.com/flexirest/flexirest/actions/workflows/build_test.yml/badge.svg)](https://github.com/flexirest/flexirest/actions/workflows/build.yml)
+[![Build](https://github.com/flexirest/flexirest/actions/workflows/build.yml/badge.svg)](https://github.com/flexirest/flexirest/actions/workflows/build.yml)
 [![Coverage Status](https://coveralls.io/repos/github/flexirest/flexirest/badge.svg?branch=master)](https://coveralls.io/github/flexirest/flexirest?branch=master)
 [![Code Climate](https://codeclimate.com/github/flexirest/flexirest.png)](https://codeclimate.com/github/flexirest/flexirest)
 [![Gem Version](https://badge.fury.io/rb/flexirest.png)](http://badge.fury.io/rb/flexirest)
@@ -49,8 +49,8 @@ You can then use your new class like this:
 ```ruby
 # Create a new person
 @person = Person.create(
-  first_name:"John"
-  last_name:"Smith"
+  first_name: "John",
+  last_name: "Smith"
 )
 
 # Find a person (not needed after creating)
@@ -82,6 +82,7 @@ I've written a TON of documentation on how to use Flexirest and a LITTLE bit on
 - [Lazy loading](docs/lazy-loading.md)
 - [Authentication](docs/authentication.md)
 - [Body types](docs/body-types.md)
+- [Empty body handling](docs/empty-body-handling.md)
 - [Parallel requests](docs/parallel-requests.md)
 - [Faking calls](docs/faking-calls.md)
 - [Per-request timeouts](docs/per-request-timeouts.md)

data/docs/empty-body-handling.md

@@ -0,0 +1,22 @@
+# *Flexirest:* Empty body handling
+
+If you call a RESTful method that correctly returns a 204 when the request was accepted, but no body is supplied, Flexirest will return `true`. If you call this on an instance of a Flexirest subclass, it will not affect the existing attributes.
+
+```ruby
+class Person < Flexirest::Base
+  put :save, "/people/:id"
+end
+
+p = Person.new(id: "1", name: "Jenny")
+saved = p.save
+puts saved === true # true
+puts p.name # Jenny
+```
+
+If your API returns a 200 OK status with an empty body, by default this is handled in the normal way - the attributes are set to an empty set. If you intend to handle it as above for the 204, you can set an extra option on the mapped method like this:
+
+```ruby
+class Person < Flexirest::Base
+  put :save, "/people/:id", ignore_empty_response: true
+end
+```

data/lib/flexirest/request.rb

@@ -627,7 +627,7 @@ module Flexirest
     def handle_response(response, cached = nil)
       @response = response
       status = @response.status || 200
-      if @response.body.blank?
+      if @response.body.blank? && !@method[:options][:ignore_empty_response]
         @response.response_headers['Content-Type'] = "application/json"
         @response.body = "{}"
       end
@@ -639,6 +639,10 @@ module Flexirest
       end
 
       if (200..399).include?(status)
+        if status == 204 || (@response.body.blank? && @method[:options][:ignore_empty_response])
+          return true
+        end
+
         if @method[:options][:plain]
           return @response = Flexirest::PlainResponse.from_response(@response)
         elsif is_json_response? || is_xml_response?

data/lib/flexirest/version.rb

@@ -1,3 +1,3 @@
 module Flexirest
-  VERSION = "1.10.8"
+  VERSION = "1.10.9"
 end

data/spec/lib/request_spec.rb

@@ -48,6 +48,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 :update_with_empty, "/put/:id", ignore_empty_response: true
       put :wrapped, "/put/:id", wrap_root: "example"
       put :conversion, "/put/:id", parse_fields: [:converted]
       put :conversion_child, "/put/:id", parse_fields: [:converted_child]
@@ -522,6 +523,24 @@ describe Flexirest::Request do
     ExampleClient.find("1234")
   end
 
+  it "should handle a 204 response and not erase the instance's attributes" do
+    expect_any_instance_of(Flexirest::Connection).to receive(:put).and_return(::FaradayResponseMock.new(OpenStruct.new(body: "", response_headers: {}, status: 204)))
+    client = ExampleClient.new
+    client.id = "1234"
+    ret = client.update
+    expect(client.id).to eq("1234")
+    expect(ret).to be_truthy
+  end
+
+  it "should handle a 204 response and not erase the instance's attributes" do
+    expect_any_instance_of(Flexirest::Connection).to receive(:put).and_return(::FaradayResponseMock.new(OpenStruct.new(body: "", response_headers: {}, status: 200)))
+    client = ExampleClient.new
+    client.id = "1234"
+    ret = client.update_with_empty
+    expect(client.id).to eq("1234")
+    expect(ret).to be_truthy
+  end
+
   it "should pass through url parameters and get parameters" do
     expect_any_instance_of(Flexirest::Connection).to receive(:get).with("/1234?debug=true", an_instance_of(Hash)).and_return(::FaradayResponseMock.new(OpenStruct.new(body:"{\"result\":true}", response_headers:{})))
     ExampleClient.find id:1234, debug:true

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flexirest
 version: !ruby/object:Gem::Version
-  version: 1.10.8
+  version: 1.10.9
 platform: ruby
 authors:
 - Andy Jeffries
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-01 00:00:00.000000000 Z
+date: 2022-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -282,6 +282,7 @@ files:
 - docs/combined-example.md
 - docs/debugging.md
 - docs/default-parameters.md
+- docs/empty-body-handling.md
 - docs/faking-calls.md
 - docs/faraday-configuration.md
 - docs/filtering-result-lists.md