flexirest 1.10.5 → 1.10.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 10e663045de906cbfcd8e79800a795c440cb32b5f8e47e4b54b38aa85c450f15
-  data.tar.gz: c6b66793a525149f3fa1eec607c8a5cb8f3fa43fd5386b4e5a845b5e0d8359e3
+  metadata.gz: '010099426a7d7332a404d79bb7efa98c7c236b3ccf6124c2c300e276b1d5192a'
+  data.tar.gz: 15c9b6e809ac7c0dc0fd3f254efb9f8f69ca4255b5e4e888907fab252efadfd4
 SHA512:
-  metadata.gz: 16bf500083c920340ff812d84d6cd6d6a7489783b229eb51822e4b994bba812226574c5831dc34bb1bcbe3c2a98e155ceaceb13c41270309b3573268ffced862
-  data.tar.gz: eff6f4b1699d63af2390b3c7ef970c301d2fc62cd2fda190b57f28132353c00f3a365567193cf9a2c98f5e97c5b7a1027fcf01197af34aa54f26dc57764319e6
+  metadata.gz: c540558e844d25850a99b56e1a85ef919832ebc3496d26689d80080a39e2e635ff2df2a53b234740cf79c7119c0fb8ff91296e0e119e1eaf06525d72d8f1fdf6
+  data.tar.gz: 887afa323b740f966bd4c481066d7109fab4212d3b940b5c2c4603675d7f3f6f423bd54e8401bb1ed09e21f4856a5ebab1d96c05fbe57864663da9b32051ee7a

data/.github/workflows/build.yml

@@ -0,0 +1,35 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Build
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.5', '2.6', '2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake

data/CHANGELOG.md

@@ -1,5 +1,37 @@
 # 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:
+
+- Flexirest didn't set DELETE params in the URL if send_request_body was false
+
+## 1.10.7
+
+Bugfix:
+
+- Flexirest didn't find the elements if the specified root wasn't found, e.g. in error conditions (thanks to Jolyon Pawlyn/@jpawlyn for the PR)
+
+## 1.10.6
+
+Bugfix:
+
+- Flexirest was erroring if Rails.logger was defined but was nil (thanks to Alex Oxte for the PR)
+
+## 1.10.5
+
+Enhancement:
+
+- Allow skipping of caching for single endpoints
+
 ## 1.10.4
 
 Enhancement:

data/README.md

@@ -1,10 +1,10 @@
 # Flexirest
 
 > Access your REST APIs in a flexible way.
-> 
+>
 > 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 Status](https://travis-ci.org/flexirest/flexirest.svg?branch=master)](https://travis-ci.org/flexirest/flexirest)
+[![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/logger.rb

@@ -17,7 +17,7 @@ module Flexirest
     end
 
     def self.debug(message)
-      if defined?(Rails) && Rails.respond_to?(:logger)
+      if defined?(Rails) && Rails.logger.present?
         Rails.logger.debug(message)
       elsif @logfile
         if @logfile.is_a?(String)
@@ -33,7 +33,7 @@ module Flexirest
     end
 
     def self.info(message)
-      if defined?(Rails) && Rails.respond_to?(:logger) && Rails.logger
+      if defined?(Rails) && Rails.logger.present?
         Rails.logger.info(message)
       elsif @logfile
         if @logfile.is_a?(String)
@@ -49,7 +49,7 @@ module Flexirest
     end
 
     def self.warn(message)
-      if defined?(Rails) && Rails.respond_to?(:logger)
+      if defined?(Rails) && Rails.logger.present?
         Rails.logger.warn(message)
       elsif @logfile
         if @logfile.is_a?(String)
@@ -65,7 +65,7 @@ module Flexirest
     end
 
     def self.error(message)
-      if defined?(Rails) && Rails.respond_to?(:logger)
+      if defined?(Rails) && Rails.logger.present?
         Rails.logger.error(message)
       elsif @logfile
         if @logfile.is_a?(String)

data/lib/flexirest/request.rb

@@ -347,7 +347,7 @@ module Flexirest
       if @explicit_parameters
         params = @explicit_parameters
       end
-      if http_method == :get
+      if http_method == :get || (http_method == :delete && !@method[:options][:send_delete_body] && proxy != :json_api)
         @get_params = default_params.merge(params || {})
         @post_params = nil
       elsif http_method == :delete && @method[:options][:send_delete_body]
@@ -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?
@@ -862,14 +866,14 @@ module Flexirest
 
         if ignore_root
           [ignore_root].flatten.each do |key|
-            body = body[key.to_s]
+            body = body[key.to_s] if body.has_key?(key.to_s)
           end
         end
       elsif is_xml_response?
         body = @response.body.blank? ? {} : Crack::XML.parse(@response.body)
         if ignore_root
           [ignore_root].flatten.each do |key|
-            body = body[key.to_s]
+            body = body[key.to_s] if body.has_key?(key.to_s)
           end
         elsif options[:ignore_xml_root]
           Flexirest::Logger.warn("Using `ignore_xml_root` is deprecated, please switch to `ignore_root`")

data/lib/flexirest/version.rb

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

data/spec/lib/base_without_validation_spec.rb

@@ -236,6 +236,8 @@ describe Flexirest::BaseWithoutValidation do
 
     Flexirest::Base.base_url = "https://www.example.com/api/v2"
     expect(OutsideBaseExample.base_url).to eq("https://www.example.com/api/v2")
+  ensure
+    Flexirest::Base.base_url = 'http://www.example.com'
   end
 
   it "should include the Mapping module" do

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]
@@ -206,6 +207,16 @@ describe Flexirest::Request do
       }
     end
 
+    class IgnoredRootWithUnexpectedResponseExampleClient < ExampleClient
+      get :root, "/root", ignore_root: "feed", fake: %Q{
+        {
+          "error": {
+            "message": "Example Error"
+          }
+        }
+      }
+    end
+
     class IgnoredMultiLevelRootExampleClient < ExampleClient
       get :multi_level_root, "/multi-level-root", ignore_root: [:response, "data", "object"], fake: %Q{
         {
@@ -426,7 +437,7 @@ describe Flexirest::Request do
   end
 
   it "should get an HTTP connection when called and call delete without a body if send_delete_body is not specified" do
-    expect_any_instance_of(Flexirest::Connection).to receive(:delete).with("/remove/1", "", an_instance_of(Hash)).and_return(::FaradayResponseMock.new(OpenStruct.new(body:'{"result":true}', response_headers:{})))
+    expect_any_instance_of(Flexirest::Connection).to receive(:delete).with("/remove/1?something=else", "", an_instance_of(Hash)).and_return(::FaradayResponseMock.new(OpenStruct.new(body:'{"result":true}', response_headers:{})))
     ExampleClient.remove(id:1, something: "else")
   end
 
@@ -512,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
@@ -1524,6 +1553,10 @@ describe Flexirest::Request do
     expect(IgnoredRootExampleClient.root.title).to eq("Example Feed")
   end
 
+  it "should ignore an ignore_root parameter if the specified element is not in the response" do
+    expect(IgnoredRootWithUnexpectedResponseExampleClient.root.error.message).to eq("Example Error")
+  end
+
   it "should ignore a specified multi-level root element" do
     expect(IgnoredMultiLevelRootExampleClient.multi_level_root.title).to eq("Example Multi Level Feed")
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flexirest
 version: !ruby/object:Gem::Version
-  version: 1.10.5
+  version: 1.10.9
 platform: ruby
 authors:
 - Andy Jeffries
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-20 00:00:00.000000000 Z
+date: 2022-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -261,10 +261,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/build.yml"
 - ".gitignore"
 - ".rspec"
 - ".simplecov"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -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

data/.travis.yml

@@ -1,5 +0,0 @@
-language: ruby
-rvm:
-  - 2.7.0
-  - 2.6.0
-  - 2.5.0