flexirest 1.10.4 → 1.10.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a072753fe6a84d8f13ae90d26cdff777e78fc129d4555b5188ae0c0be35ad78
-  data.tar.gz: 7e6ecfe247cc9f021a3e35f9cf4d3b28a6743694b53a2ca32c0ea988a2113276
+  metadata.gz: 1b83cde99ff35cebe79fea42a56376731df479a41668d080adc68ff5be4a24dc
+  data.tar.gz: 9170fdcf1afaa4d94d55d13b67c406ef470d3793ea9c7738416cd55b4fdc8107
 SHA512:
-  metadata.gz: 561fdb72c84a9bd3d0a353f46d4761179df66f3e45967bec4b4b620c6f818dca0058388b5f83c2d2455da1f21fa90a72ec0f73ab056fbf086dab522cc8f48fd7
-  data.tar.gz: 95d6f2852392a23c82a5ae0e157a9ad1bc391c4846e79946eab75236c1c3b409c8193a3550e42b9e19676b94a3cccda28e6f0ddf438e47b3e77de9c66669006a
+  metadata.gz: 70e59dcfcfc93ce1af97961756bc92c6f53f3d438afea748c918cad5b00583afda7678de691a8ce0bf7f2e45619d73adba2b3c5be4a80c29fd80550fccb9e62b
+  data.tar.gz: 953064ac2ad371bc5d793291ceef862092983a34489b6e5780b7f4d84a4d568e4520b50df41ebd8f9663412a80feeeac1562767ff879eedae235576284fc3771

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,29 @@
 # Changelog
 
+## 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_test.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)

data/docs/caching.md

@@ -14,6 +14,14 @@ class Person < Flexirest::Base
 end
 ```
 
+or per request endpoint with:
+
+```ruby
+class Person < Flexirest::Base
+    get :all, "/people", skip_caching: true
+end
+```
+
 If Rails is defined, it will default to using Rails.cache as the cache store, if not, you'll need to configure one with a `ActiveSupport::Cache::Store` compatible object using:
 
 ```ruby

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

@@ -312,7 +312,7 @@ module Flexirest
 
           result = handle_response(response_env, cached)
           @response_delegate.__setobj__(result)
-          original_object_class.write_cached_response(self, response_env, result)
+          original_object_class.write_cached_response(self, response_env, result) unless @method[:options][:skip_caching]
         end
 
         # If this was not a parallel request just return the original result
@@ -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]
@@ -523,7 +523,7 @@ module Flexirest
 
     def do_request(etag)
       http_headers = {}
-      http_headers["If-None-Match"] = etag if etag
+      http_headers["If-None-Match"] = etag if etag && !@method[:options][:skip_caching]
       http_headers["Accept"] = "application/hal+json, application/json;q=0.5"
       headers.each do |key,value|
         value = value.join(",") if value.is_a?(Array)
@@ -862,14 +862,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`")
@@ -890,7 +890,7 @@ module Flexirest
         result = new_object(body, @overridden_name)
         result._status = @response.status
         result._headers = @response.response_headers
-        result._etag = @response.response_headers['ETag']
+        result._etag = @response.response_headers['ETag'] unless @method[:options][:skip_caching]
         if !object_is_class? && options[:mutable] != false
           @object._copy_from(result)
           @object._clean!

data/lib/flexirest/version.rb

@@ -1,3 +1,3 @@
 module Flexirest
-  VERSION = "1.10.4"
+  VERSION = "1.10.8"
 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

@@ -41,6 +41,7 @@ describe Flexirest::Request do
       get :find, "/:id", required: [:id]
       get :find_cat, "/:id/cat"
       get :fruits, "/fruits"
+      get :uncached, "/uncached", skip_caching: true
       get :change, "/change"
       get :plain, "/plain/:id", plain: true
       post :create, "/create", rubify_names: true
@@ -205,6 +206,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{
         {
@@ -425,7 +436,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
 
@@ -997,6 +1008,35 @@ describe Flexirest::Request do
     expect(object._etag).to eq("123456")
   end
 
+  it "shouldn't expose the etag header if skip_caching is enabled" do
+    response = ::FaradayResponseMock.new(OpenStruct.new(body: "{}", response_headers: {"ETag" => "123456"}, status: 200))
+    expect_any_instance_of(Flexirest::Connection).to receive(:get).with("/uncached", an_instance_of(Hash)).and_return(response)
+    object = ExampleClient.uncached
+    expect(object._etag).to_not eq("123456")
+  end
+
+  it "shouldn't send the etag header if skip_caching is enabled" do
+    cached_response = Flexirest::CachedResponse.new(status:200, result:"", response_headers: {})
+    cached_response.etag = "123456"
+    expect(ExampleClient).to receive(:read_cached_response).and_return(cached_response)
+
+    response = ::FaradayResponseMock.new(OpenStruct.new(body: "{}", response_headers: {"ETag" => "123456"}, status: 200))
+    expect_any_instance_of(Flexirest::Connection).to receive(:get).with("/uncached", {
+      api_auth: {
+        api_auth_access_id: "id123",
+        api_auth_options: {},
+        api_auth_secret_key: "secret123"
+      },
+      headers: {
+        "Accept"=>"application/hal+json, application/json;q=0.5",
+        "Content-Type"=>"application/x-www-form-urlencoded; charset=utf-8"
+      }
+    }).and_return(response)
+
+    expect(ExampleClient).to_not receive(:write_cached_response)
+    object = ExampleClient.uncached
+  end
+
   it "should expose all headers" do
     response = ::FaradayResponseMock.new(OpenStruct.new(body: "{}", response_headers: {"X-Test-Header" => "true"}, status: 200))
     expect_any_instance_of(Flexirest::Connection).to receive(:get).with("/123", an_instance_of(Hash)).and_return(response)
@@ -1494,6 +1534,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.4
+  version: 1.10.8
 platform: ruby
 authors:
 - Andy Jeffries
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-16 00:00:00.000000000 Z
+date: 2021-10-01 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

data/.travis.yml

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