flexirest 1.12.3 → 1.12.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61eaaa77dfcbab57b714007844456fe903c759cbb981761a43b7eb4910da3463
-  data.tar.gz: 10e7bbe8cc3b35887eb34c32562af637ed8cd4aae34df0547c2e2cd52a730a7e
+  metadata.gz: 4b2b1b6afc271ee5ca051d711746396685574b2a7f18ca06919f48dbdd4bbafc
+  data.tar.gz: 10a84526cef840be253ff7fc36fc1571f7fbb463e11a900a11142b895cd8ebaa
 SHA512:
-  metadata.gz: 251b2a247480a4f7b3c46a70cd469c3ad24cbdb6c245703ec60658ae3429107a7a364eb12e8794c2e28729ebb58e7a17bc1d2fbeebf59a035d5f277032ba7d82
-  data.tar.gz: e4fb534d1775963465155761cd4e6b8a7f14e7c66b0f0406d48d39abe4810906c588a9f00fea1b9325b1ed6d1682c9224f47b07c0f75e51b48986d2be43f5e0c
+  metadata.gz: bb7b781df1bd6f64482c6b672ac397bef31b5a0717f677db8c03988aee79253b95962136e835131fc55794f48828df6f35b3d9b36f9156e7fce5d41d3af9098d
+  data.tar.gz: 586b813a1a098c15a7c0f56267c044ac46649c97cd0a933960bbcc19e3b27397083cd05802c30ca042d280417ff68d9dcae3eb8b152f9373afd712e794e863d4

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 1.12.4
+
+Bugfix:
+
+- 204 responses could not be read from Cache (thanks to rgisiger for the PR)
+
 ## 1.12.3
 
 Bugfix:

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/version.rb

@@ -1,3 +1,3 @@
 module Flexirest
-  VERSION = "1.12.3"
+  VERSION = "1.12.4"
 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)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flexirest
 version: !ruby/object:Gem::Version
-  version: 1.12.3
+  version: 1.12.4
 platform: ruby
 authors:
 - Andy Jeffries
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-21 00:00:00.000000000 Z
+date: 2024-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler