flexirest 1.10.8 → 1.10.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b83cde99ff35cebe79fea42a56376731df479a41668d080adc68ff5be4a24dc
-  data.tar.gz: 9170fdcf1afaa4d94d55d13b67c406ef470d3793ea9c7738416cd55b4fdc8107
+  metadata.gz: 60510339b01a0ade8d9cd94686ecec5f431bcb58570c66b48fdc76075faf4d4f
+  data.tar.gz: 203e88d288ba8fa7f46f757a9aa24177908df116a272b754dc9bd685b19302db
 SHA512:
-  metadata.gz: 70e59dcfcfc93ce1af97961756bc92c6f53f3d438afea748c918cad5b00583afda7678de691a8ce0bf7f2e45619d73adba2b3c5be4a80c29fd80550fccb9e62b
-  data.tar.gz: 953064ac2ad371bc5d793291ceef862092983a34489b6e5780b7f4d84a4d568e4520b50df41ebd8f9663412a80feeeac1562767ff879eedae235576284fc3771
+  metadata.gz: f2d51bcbce5d390baa8140cc222cbe69bfb873cb6db399a3e955358b36b39aea6241df15abd8458b79e03d87e3e4643551d2d809dabd0a4ae92c9131e9277da1
+  data.tar.gz: 73445e4f9be17c311354112a41e7a9290695da228d853e1a67ea063d8aae8a1370f7bf4991fa43bd70a264b608c94416ad005929aa055863686ca919c6fe19ce

data/CHANGELOG.md

@@ -1,5 +1,25 @@
 # Changelog
 
+## 1.10.11
+
+Bugfix:
+
+- HTTPClientException's instance body was return nil instead of the response. (thanks to @pinifloyd for the issue and PR)
+
+## 1.10.10
+
+Bugfix:
+
+- Specifically requiring a 1.x Faraday. They changed the engine inclusion in 2.x and it's not necessary for Flexirest to need that. If anyone does need it, feel free to raise a PR.
+
+## 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/body-types.md

@@ -45,10 +45,10 @@ class Person < Flexirest::Base
   put :save, '/person/:id/logs', request_body_type: :plain
 end
 
-Person.save(id: 1, body: '["Something here"]', 
+Person.save(id: 1, body: '["Something here"]',
             content_type: "application/json")
 ```
 
 -----
 
-[< Authentication](authentication.md) | [Parallel requests >](parallel-requests.md)
+[< Authentication](authentication.md) | [Empty body handling >](empty-body-handling.md)

data/docs/empty-body-handling.md

@@ -0,0 +1,26 @@
+# *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
+```
+
+-----
+
+[< Body types](body-types.md) | [Parallel requests >](parallel-requests.md)

data/docs/parallel-requests.md

@@ -25,4 +25,4 @@ puts @employers.size #=> 7
 
 -----
 
-[< Body types](body-types.md) | [Faking calls >](faking-calls.md)
+[< Empty body handling](empty-body-handling.md) | [Faking calls >](faking-calls.md)

data/docs/using-callbacks.md

@@ -105,6 +105,7 @@ class Animal < Flexirest::Base
       Flexirest::Logger.info("  \033[1;4;32m#{Flexirest.name}\033[0m Invalidating cache for #{self.class.name} #{request.url}")
       Rails.cache.delete("#{self.class.name}:#{request.url}")
     end
+    nil
   end
 
   def cache(name, response)

data/flexirest.gemspec

@@ -44,7 +44,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "mime-types"
   spec.add_runtime_dependency "multi_json"
   spec.add_runtime_dependency "crack"
-  spec.add_runtime_dependency "faraday"
+  spec.add_runtime_dependency "faraday", "~> 1.0"
 
   # Use Gem::Version to parse the Ruby version for reliable comparison
   # ActiveSupport 5+ requires Ruby 2.2.2

data/lib/flexirest/base_without_validation.rb

@@ -66,7 +66,7 @@ module Flexirest
       @dirty_attributes.keys
     end
 
-    # Returns hash of old and new vaules for each changed field
+    # Returns hash of old and new values for each changed field
     def changes
       @dirty_attributes
     end

data/lib/flexirest/request.rb

@@ -404,7 +404,7 @@ module Flexirest
           end
         end
         if missing.any?
-          raise Flexirest::MissingParametersException.new("The following parameters weren't specifed: #{missing.join(", ")}")
+          raise Flexirest::MissingParametersException.new("The following parameters weren't specified: #{missing.join(", ")}")
         end
       end
     end
@@ -434,7 +434,7 @@ module Flexirest
       end
 
       if missing.present?
-        raise Flexirest::MissingParametersException.new("The following parameters weren't specifed: #{missing.join(", ")}")
+        raise Flexirest::MissingParametersException.new("The following parameters weren't specified: #{missing.join(", ")}")
       end
     end
 
@@ -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?
@@ -930,7 +934,7 @@ module Flexirest
   end
 
   class HTTPException < RequestException
-    attr_accessor :status, :result, :request_url, :body, :raw_response
+    attr_accessor :status, :result, :request_url, :body
     def initialize(options)
       @status = options[:status]
       @result = options[:result]
@@ -938,7 +942,7 @@ module Flexirest
       @body = options[:raw_response]
       @method = options[:method]
     end
-    alias_method :body, :raw_response
+    alias_method :raw_response, :body
 
     def message
       method = @method.try(:upcase)

data/lib/flexirest/version.rb

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

data/spec/lib/base_without_validation_spec.rb

@@ -114,12 +114,12 @@ describe Flexirest::BaseWithoutValidation do
     expect(client["test"]).to be_an_instance_of(DateTime)
   end
 
-  it "should allow strings of 4 digits and not intepret them as dates" do
+  it "should allow strings of 4 digits and not interpret them as dates" do
     client = EmptyExample.new(test: "2015")
     expect(client["test"]).to be_an_instance_of(String)
   end
 
-  it "should allow strings of 8 digits and not intepret them as dates" do
+  it "should allow strings of 8 digits and not interpret them as dates" do
     client = EmptyExample.new(test: "1266129")
     expect(client["test"]).to be_an_instance_of(String)
   end

data/spec/lib/configuration_spec.rb

@@ -209,7 +209,7 @@ describe Flexirest::Configuration do
     end
   end
 
-  it "should default to non-verbose loggingg" do
+  it "should default to non-verbose logging" do
     class VerboseConfigurationExample1
       include Flexirest::Configuration
     end

data/spec/lib/connection_spec.rb

@@ -10,7 +10,7 @@ describe Flexirest::Connection do
     @connection.reconnect
   end
 
-  it "should contain a Farday connection" do
+  it "should contain a Faraday connection" do
     expect(@connection.session).to be_a_kind_of(Faraday::Connection)
   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 200 response with an empty body 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.11
 platform: ruby
 authors:
 - Andy Jeffries
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-01 00:00:00.000000000 Z
+date: 2022-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -230,16 +230,16 @@ dependencies:
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -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
@@ -369,7 +370,7 @@ licenses:
 - MIT
 metadata:
   source_code_uri: https://github.com/flexirest/flexirest
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -384,8 +385,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: This gem is for accessing REST services in a flexible way.  ActiveResource
   already exists for this, but it doesn't work where the resource naming doesn't follow