flexirest 1.12.3 → 1.12.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61eaaa77dfcbab57b714007844456fe903c759cbb981761a43b7eb4910da3463
-  data.tar.gz: 10e7bbe8cc3b35887eb34c32562af637ed8cd4aae34df0547c2e2cd52a730a7e
+  metadata.gz: 44aa9166918c27766f3d696c23cc78b08e1f956edb6ae8a7413c9e88f01c48e7
+  data.tar.gz: 1068bcb89fb8da7af5505177f989997794615703df092d8d27fa55479987565c
 SHA512:
-  metadata.gz: 251b2a247480a4f7b3c46a70cd469c3ad24cbdb6c245703ec60658ae3429107a7a364eb12e8794c2e28729ebb58e7a17bc1d2fbeebf59a035d5f277032ba7d82
-  data.tar.gz: e4fb534d1775963465155761cd4e6b8a7f14e7c66b0f0406d48d39abe4810906c588a9f00fea1b9325b1ed6d1682c9224f47b07c0f75e51b48986d2be43f5e0c
+  metadata.gz: 9cddabff55c7531fdb3856c863fc9888fa3731c82135f9a02c4e3d5026514c479815ecaa499fc38b6f50c6579bff7703bcbaef688d76ea067a43f7a26dc8efc5
+  data.tar.gz: 204f29f4a0baa07661ea497d88799f137ed55114fdea808f5a1ea905a21f9ff51f2d0ce1c9a82d985c140c6e6f4fc29ae26e394a34a63cc51b87907dbef81139

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 1.12.5
+
+Feature:
+
+- Some broken APIs require a GET body, even though this is against HTTP spec. Added a `send_get_body` parameter like we already have for DELETE requests (thanks to Jan Schroeder for the request)
+
+## 1.12.4
+
+Bugfix:
+
+- 204 responses could not be read from Cache (thanks to rgisiger for the PR)
+
 ## 1.12.3
 
 Bugfix:

data/docs/basic-usage.md

@@ -52,6 +52,12 @@ For `delete` requests whether an API can handle a body or not is undefined. The
   delete :remove, "/people/:id", send_delete_body: true
 ```
 
+In a similar way, although it's against the HTTP specification, you can force a GET request to send a request body if your API requires that:
+
+```
+  get :people_search, "/people/search", send_get_body: true
+```
+
 If an API returns an array of results and you have [will_paginate](https://rubygems.org/gems/will_paginate) installed then you can call the paginate method to return a particular page of the results (note: this doesn't reduce the load on the server, but it can help with pagination if you have a cached response).
 
 ```ruby

data/lib/flexirest/caching.rb

@@ -68,9 +68,10 @@ module Flexirest
         end
 
         if cache_store && (headers[:etag] || headers[:expires])
-          key = "#{request.class_name}:#{request.original_url}"
+          class_name = request.class_name
+          key = "#{class_name}:#{request.original_url}"
           Flexirest::Logger.debug "  \033[1;4;32m#{Flexirest.name}\033[0m #{key} - Writing to cache" unless quiet
-          cached_response = CachedResponse.new(status:response.status, result:result, response_headers: headers)
+          cached_response = CachedResponse.new(status:response.status, result:result, response_headers: headers, class_name:class_name)
           cached_response.etag = "#{headers[:etag]}" if headers[:etag]
           cached_response.expires = Time.parse(headers[:expires]) rescue nil if headers[:expires]
           if cached_response.etag.present? || cached_response.expires
@@ -101,18 +102,19 @@ module Flexirest
       @etag = options[:etag]
       @expires = options[:expires]
       @response_headers = options[:response_headers]
+      @old_cached_instance = options[:result].class.name.nil?
 
-      @class_name = options[:result].class.name
       if options[:result].is_a?(ResultIterator)
         @class_name = options[:result][0].class.name
         @result = options[:result].map{|i| {}.merge(i._attributes)}
       else
+        @class_name = options[:class_name]
         @result = {}.merge(options[:result].try(:_attributes) || {})
       end
     end
 
     def result
-      return @result if @class_name.nil? # Old cached instance
+      return @result if @old_cached_instance
 
       if @result.is_a?(Array)
         ri = ResultIterator.new(self)

data/lib/flexirest/request.rb

@@ -361,10 +361,10 @@ module Flexirest
       if @explicit_parameters
         params = @explicit_parameters
       end
-      if http_method == :get || (http_method == :delete && !@method[:options][:send_delete_body] && proxy != :json_api)
+      if (http_method == :get && !@method[:options][:send_get_body]) || (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]
+      elsif (http_method == :get && @method[:options][:send_get_body]) || (http_method == :delete && @method[:options][:send_delete_body])
         @post_params = default_params.merge(params || {})
         @get_params = {}
       elsif params.is_a? String
@@ -476,7 +476,7 @@ module Flexirest
 
         headers["Accept"] ||= "application/vnd.api+json"
         JsonAPIProxy::Headers.save(headers)
-      elsif http_method == :get || (http_method == :delete && !@method[:options][:send_delete_body])
+      elsif (http_method == :get && !@method[:options][:send_get_body]) || (http_method == :delete && !@method[:options][:send_delete_body])
         if request_body_type == :form_encoded
           headers["Content-Type"] ||= "application/x-www-form-urlencoded; charset=utf-8"
         elsif request_body_type == :form_multipart
@@ -607,16 +607,17 @@ module Flexirest
         request_options[:timeout] = @method[:options][:timeout]
       end
 
-      case http_method
-      when :get
+      if http_method == :get && !@method[:options][:send_get_body]
         response = connection.get(@url, request_options)
-      when :put
+      elsif http_method == :get
+          response = connection.get(@url, @body, request_options)
+      elsif http_method == :put
         response = connection.put(@url, @body, request_options)
-      when :post
+      elsif http_method == :post
         response = connection.post(@url, @body, request_options)
-      when :patch
+      elsif http_method == :patch
         response = connection.patch(@url, @body, request_options)
-      when :delete
+      elsif http_method == :delete
         response = connection.delete(@url, @body, request_options)
       else
         raise InvalidRequestException.new("Invalid method #{http_method}")

data/lib/flexirest/version.rb

@@ -1,3 +1,3 @@
 module Flexirest
-  VERSION = "1.12.3"
+  VERSION = "1.12.5"
 end

data/spec/lib/caching_spec.rb

@@ -109,6 +109,7 @@ describe Flexirest::Caching do
         base_url "http://www.example.com"
         get :all, "/"
         put :save_all, "/"
+        get :plain, "/plain/:id", plain: true
       end
 
       Person.cache_store = CachingExampleCacheStore5.new({ expires_in: 1.day.to_i }) # default cache expiration
@@ -121,7 +122,8 @@ describe Flexirest::Caching do
       cached_response = Flexirest::CachedResponse.new(
         status:200,
         result:@cached_object,
-        etag:@etag)
+        etag:@etag,
+        class_name:Person.name)
       expect_any_instance_of(CachingExampleCacheStore5).to receive(:read).once.with("Person:/").and_return(Marshal.dump(cached_response))
       expect_any_instance_of(Flexirest::Connection).to receive(:get){ |connection, path, options|
         expect(path).to eq('/')
@@ -131,11 +133,23 @@ describe Flexirest::Caching do
       expect(ret.first_name).to eq("Johnny")
     end
 
+    it "should read the response to the cache store if response is a 204 with empty bodies and cache is wanted" do
+      cached_response = Flexirest::CachedResponse.new(
+        status:204,
+        result:true,
+        expires:Time.now + 30,
+        class_name:Person.name)
+      expect_any_instance_of(CachingExampleCacheStore5).to receive(:read).once.with("Person:/").and_return(Marshal.dump(cached_response))
+      expect_any_instance_of(Flexirest::Connection).not_to receive(:get)
+      Person.all
+    end
+
     it "should not read from the cache store to check for an etag unless it's a GET request" do
       cached_response = Flexirest::CachedResponse.new(
         status:200,
         result:@cached_object,
-        etag:@etag)
+        etag:@etag,
+        class_name:Person.name)
       expect_any_instance_of(CachingExampleCacheStore5).to_not receive(:read)
       expect_any_instance_of(Flexirest::Connection).to receive(:put).and_return(::FaradayResponseMock.new(OpenStruct.new(status:200, body: {result: "foo"}.to_json, response_headers:{})))
       ret = Person.save_all
@@ -145,7 +159,8 @@ describe Flexirest::Caching do
       cached_response = Flexirest::CachedResponse.new(
         status: 200,
         result: @cached_object,
-        etag: @etag
+        etag: @etag,
+        class_name:Person.name
       )
       allow_any_instance_of(CachingExampleCacheStore5).to receive(:read).and_return(Marshal.dump(cached_response))
       new_name = 'Pete'
@@ -166,7 +181,8 @@ describe Flexirest::Caching do
       cached_response = Flexirest::CachedResponse.new(
         status:200,
         result:@cached_object,
-        expires:Time.now + 30)
+        expires:Time.now + 30,
+        class_name:Person.name)
       expect_any_instance_of(CachingExampleCacheStore5).to receive(:read).once.with("Person:/").and_return(Marshal.dump(cached_response))
       expect_any_instance_of(Flexirest::Connection).not_to receive(:get)
       ret = Person.all
@@ -177,7 +193,8 @@ describe Flexirest::Caching do
       cached_response = Flexirest::CachedResponse.new(
         status:200,
         result:@cached_object,
-        expires:Time.now + 30)
+        expires:Time.now + 30,
+        class_name:Person.name)
       Timecop.travel(Time.now + 60)
       expect_any_instance_of(CachingExampleCacheStore5).to receive(:read).once.with("Person:/").and_return(nil)
       expect_any_instance_of(Flexirest::Connection).to receive(:get).with("/", an_instance_of(Hash)).and_return(::FaradayResponseMock.new(OpenStruct.new(status:200, body:"{\"result\":true}", response_headers:{})))
@@ -189,7 +206,8 @@ describe Flexirest::Caching do
       cached_response = Flexirest::CachedResponse.new(
         status:200,
         result:@cached_object,
-        expires:Time.now + 30)
+        expires:Time.now + 30,
+        class_name:Person.name)
       expect_any_instance_of(CachingExampleCacheStore5).to receive(:read).once.with("Person:/").and_return(Marshal.dump(cached_response))
       expect_any_instance_of(Flexirest::Connection).not_to receive(:get)
       ret = Person.all
@@ -201,7 +219,8 @@ describe Flexirest::Caching do
       cached_response = Flexirest::CachedResponse.new(
         status:200,
         result:@cached_object,
-        expires:Time.now + 30)
+        expires:Time.now + 30,
+        class_name:Person.name)
       expect_any_instance_of(CachingExampleCacheStore5).to receive(:read).once.with("Person:/").and_return(Marshal.dump(cached_response))
       expect_any_instance_of(Flexirest::Connection).not_to receive(:get)
       p = Person.new(first_name:"Billy")
@@ -219,7 +238,8 @@ describe Flexirest::Caching do
         status:200,
         result:object,
         etag:etag,
-        expires:Time.now + 30)
+        expires:Time.now + 30,
+        class_name:Person.name)
       expect_any_instance_of(CachingExampleCacheStore5).to receive(:read).once.with("Person:/").and_return(Marshal.dump(cached_response))
       expect_any_instance_of(Flexirest::Connection).not_to receive(:get)
       ret = Person.all
@@ -237,7 +257,8 @@ describe Flexirest::Caching do
         status:200,
         result:object,
         etag:etag,
-        expires:Time.now + 30)
+        expires:Time.now + 30,
+        class_name:Person.name)
       Timecop.travel(Time.now + 60)
       expect_any_instance_of(CachingExampleCacheStore5).to receive(:read).once.with("Person:/").and_return(nil)
       expect_any_instance_of(Flexirest::Connection).to receive(:get).with("/", an_instance_of(Hash)).and_return(::FaradayResponseMock.new(OpenStruct.new(status:200, body:"[{\"first_name\":\"Billy\"}]", response_headers:{})))
@@ -247,6 +268,21 @@ describe Flexirest::Caching do
       Timecop.return
     end
 
+    it "should not write the response to the cache if it is a plain request" do
+      response_body = "This is another non-JSON string"
+      expect_any_instance_of(CachingExampleCacheStore5).to receive(:read).once.with("Person:/plain/1234").and_return(nil)
+      expect_any_instance_of(CachingExampleCacheStore5).to receive(:write).once.with("Person:/plain/1234", an_instance_of(String), hash_excluding(:etag))
+      expect_any_instance_of(Flexirest::Connection).to receive(:get).with(any_args).and_return(::FaradayResponseMock.new(OpenStruct.new(status:200, response_headers:{expires:(Time.now + 30).rfc822}, body:response_body)))
+      Person.plain(id:1234)
+    end
+
+    it "should write the response to the cache if response is a 204 with empty bodies and with expires set (or an etag)" do
+      expect_any_instance_of(CachingExampleCacheStore5).to receive(:read).once.with("Person:/").and_return(nil)
+      expect_any_instance_of(CachingExampleCacheStore5).to receive(:write).once.with("Person:/", an_instance_of(String), hash_excluding(:etag))
+      expect_any_instance_of(Flexirest::Connection).to receive(:get).with(any_args).and_return(::FaradayResponseMock.new(OpenStruct.new(status:204, response_headers:{expires:(Time.now + 30).rfc822}, body: nil)))
+      Person.all
+    end
+
     it "should not write the response to the cache unless it has caching headers" do
       expect_any_instance_of(CachingExampleCacheStore5).to receive(:read).once.with("Person:/").and_return(nil)
       expect_any_instance_of(CachingExampleCacheStore5).not_to receive(:write)

data/spec/lib/request_spec.rb

@@ -54,6 +54,7 @@ describe Flexirest::Request do
       put :conversion_child, "/put/:id", parse_fields: [:converted_child]
       delete :remove, "/remove/:id"
       delete :remove_body, "/remove/:id", send_delete_body: true
+      get :get_body, "/get-body", send_get_body: true
       get :hal, "/hal", fake:"{\"_links\":{\"child\": {\"href\": \"/child/1\"}, \"other\": {\"href\": \"/other/1\"}, \"cars\":[{\"href\": \"/car/1\", \"name\":\"car1\"}, {\"href\": \"/car/2\", \"name\":\"car2\"}, {\"href\": \"/car/not-embed\", \"name\":\"car_not_embed\"} ], \"lazy\": {\"href\": \"/lazy/load\"}, \"invalid\": [{\"href\": \"/invalid/1\"}]}, \"_embedded\":{\"other\":{\"name\":\"Jane\"},\"child\":{\"name\":\"Billy\"}, \"cars\":[{\"_links\": {\"self\": {\"href\": \"/car/1\"} }, \"make\": \"Bugatti\", \"model\": \"Veyron\"}, {\"_links\": {\"self\": {\"href\": \"/car/2\"} }, \"make\": \"Ferrari\", \"model\": \"F458 Italia\"} ], \"invalid\": [{\"present\":true, \"_links\": {} } ] } }", has_many:{other:ExampleOtherClient}
       get :fake_object, "/fake", fake:"{\"result\":true, \"list\":[1,2,3,{\"test\":true}], \"child\":{\"grandchild\":{\"test\":true}}}"
       get :fake_proc_object, "/fake", fake:->(request) { "{\"result\":#{request.get_params[:id]}}" }
@@ -451,6 +452,11 @@ describe Flexirest::Request do
     ExampleClient.all
   end
 
+  it "should get an HTTP connection when called and call get with a body if send_get_body is specified" do
+    expect_any_instance_of(Flexirest::Connection).to receive(:get).with("/get-body", "something=else", an_instance_of(Hash)).and_return(::FaradayResponseMock.new(OpenStruct.new(body:'{"result":true}', response_headers:{})))
+    ExampleClient.get_body(something: "else")
+  end
+
   it "should get an HTTP connection when called and call delete on it" 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:{})))
     ExampleClient.remove(id:1)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flexirest
 version: !ruby/object:Gem::Version
-  version: 1.12.3
+  version: 1.12.5
 platform: ruby
 authors:
 - Andy Jeffries
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-21 00:00:00.000000000 Z
+date: 2025-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -407,7 +407,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
+rubygems_version: 3.5.21
 signing_key:
 specification_version: 4
 summary: This gem is for accessing REST services in a flexible way.  ActiveResource