flexirest 1.11.0 → 1.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e3c99c9dcb4b2b2d6b4992a53d138877f251f0810bb94dc11faf9d9e1b89f9cb
-  data.tar.gz: 22554cafc10d12337c1511828ab27471dbadf36de4e211c5383eae96c4fb4c34
+  metadata.gz: '036069384b97e0fbcf4e73c9e75154569cffbb9cbfcb8dfcda4ccfc4ef75cca2'
+  data.tar.gz: 3099f07f5284601a68ebba405a60e485975635b5306b72f2ead2090509bdb901
 SHA512:
-  metadata.gz: 3cf855f9fbc7d4f213a19840e11cfa9b816de9b1a0750726538f288f559ec150c7a05a4ae8b63297e8aedcf8002103e2e4ae275cb497793144c83aebc7f7577e
-  data.tar.gz: e1a5b90ace51f341a340e5ed32f5c8afc30f2784a38cf7281c621157a8b1233da9b81180ed6a5dc0694f4ac72933793b9e47dcf01d9389583b02bdd7dc3aefbd
+  metadata.gz: 18d64a00ceea9f1a9ee61dcdaedf64dbcc8eae7b9f4f3d20943e7b9209dd7d98acd08138a9c149d0f7cb7aa03740131030580c45f4d153e2f47df999e6415a61
+  data.tar.gz: 026a430bdc41b68adc6e46c42dc69983fca9ef431fb3cc068c96fb3714c687209393d15e66879bb46c3f26ba3f9e38dd08b94620a7d8b2f20d392f08690031fd

data/.github/workflows/build.yml

@@ -24,10 +24,7 @@ jobs:
     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
+      uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby-version }}
         bundler-cache: true # runs 'bundle install' and caches installed gems automatically

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 1.11.1
+
+Enhancement:
+
+- Add automatic expiry of cached responses based on the Expires header if set (thanks to Romain Gisiger for the issue and PR)
+
 ## 1.11.0
 
 Major change:

data/flexirest.gemspec

@@ -36,6 +36,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'faraday-typhoeus'
   spec.add_development_dependency 'activemodel'
   spec.add_development_dependency 'rest-client'
+  spec.add_development_dependency 'timecop'
 
   spec.add_runtime_dependency "mime-types"
   spec.add_runtime_dependency "multi_json"

data/lib/flexirest/caching.rb

@@ -74,7 +74,14 @@ module Flexirest
           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
-            cache_store.write(key, Marshal.dump(cached_response), {})
+            options = {}
+            if cached_response.expires.present?
+              exp_in_seconds = cached_response.expires.utc - Time.now.utc
+              return unless exp_in_seconds.positive?
+
+              options[:expires_in] = exp_in_seconds
+            end
+            cache_store.write(key, Marshal.dump(cached_response), options)
           end
         end
       end

data/lib/flexirest/version.rb

@@ -1,3 +1,3 @@
 module Flexirest
-  VERSION = "1.11.0"
+  VERSION = "1.11.1"
 end

data/spec/lib/caching_spec.rb

@@ -72,28 +72,21 @@ describe Flexirest::Caching do
     end
 
     it "should use a custom cache store if a valid one is manually set" do
-      class CachingExampleCacheStore1
-        def read(key) ; end
-        def write(key, value, options={}) ; end
-        def fetch(key, &block) ; end
-      end
+      class CachingExampleCacheStore1 < ActiveSupport::Cache::MemoryStore; end
       cache_store = CachingExampleCacheStore1.new
       Flexirest::Base.cache_store = cache_store
       expect(Flexirest::Base.cache_store).to eq(cache_store)
     end
 
     it "should error if you try to use a custom cache store that doesn't match the required interface" do
-      class CachingExampleCacheStore2
-        def write(key, value, options={}) ; end
-        def fetch(key, &block) ; end
+      class CachingExampleCacheStore2 < ActiveSupport::Cache::MemoryStore
+        undef_method :read
       end
-      class CachingExampleCacheStore3
-        def read(key) ; end
-        def fetch(key, &block) ; end
+      class CachingExampleCacheStore3 < ActiveSupport::Cache::MemoryStore
+        undef_method :write
       end
-      class CachingExampleCacheStore4
-        def read(key) ; end
-        def write(key, value, options={}) ; end
+      class CachingExampleCacheStore4 < ActiveSupport::Cache::MemoryStore
+        undef_method :fetch
       end
 
       expect{ Flexirest::Base.cache_store = CachingExampleCacheStore2.new }.to raise_error(Flexirest::InvalidCacheStoreException)
@@ -109,11 +102,7 @@ describe Flexirest::Caching do
   context "Reading/writing to the cache" do
     before :each do
       Object.send(:remove_const, :CachingExampleCacheStore5) if defined?(CachingExampleCacheStore5)
-      class CachingExampleCacheStore5
-        def read(key) ; end
-        def write(key, value, options={}) ; end
-        def fetch(key, &block) ; end
-      end
+      class CachingExampleCacheStore5 < ActiveSupport::Cache::MemoryStore; end
 
       class Person < Flexirest::Base
         perform_caching true
@@ -122,7 +111,7 @@ describe Flexirest::Caching do
         put :save_all, "/"
       end
 
-      Person.cache_store = CachingExampleCacheStore5.new
+      Person.cache_store = CachingExampleCacheStore5.new({ expires_in: 1.day.to_i }) # default cache expiration
 
       @etag = "6527914a91e0c5769f6de281f25bd891"
       @cached_object = Person.new(first_name:"Johnny")
@@ -173,7 +162,7 @@ describe Flexirest::Caching do
       expect(result.first_name).to eq new_name
     end
 
-    it "should read from the cache store, and not call the server if there's a hard expiry" do
+    it "should read from the cache store, and not call the server if there's a hard expiry not passed yet" do
       cached_response = Flexirest::CachedResponse.new(
         status:200,
         result:@cached_object,
@@ -184,6 +173,18 @@ describe Flexirest::Caching do
       expect(ret.first_name).to eq("Johnny")
     end
 
+    it "should not read from the cache store, and call the server if there's a hard expiry already passed" do
+      cached_response = Flexirest::CachedResponse.new(
+        status:200,
+        result:@cached_object,
+        expires:Time.now + 30)
+      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:{})))
+      ret = Person.all
+      Timecop.return
+    end
+
     it "cache read objects shouldn't be marked as changed" do
       cached_response = Flexirest::CachedResponse.new(
         status:200,
@@ -208,7 +209,7 @@ describe Flexirest::Caching do
       expect(ret.first_name).to eq("Johnny")
     end
 
-    it "should restore a result iterator from the cache store, if there's a hard expiry" do
+    it "should restore a result iterator from the cache store, if there's a hard expiry not passed yet" do
       class CachingExample3 < Flexirest::Base ; end
       object = Flexirest::ResultIterator.new(double(status: 200))
       object << CachingExample3.new(first_name:"Johnny")
@@ -226,6 +227,26 @@ describe Flexirest::Caching do
       expect(ret._status).to eq(200)
     end
 
+    it "should not restore a result iterator from the cache store, if there's a hard expiry already passed" do
+      class CachingExample3 < Flexirest::Base ; end
+      object = Flexirest::ResultIterator.new(double(status: 200))
+      object << CachingExample3.new(first_name:"Johnny")
+      object << CachingExample3.new(first_name:"Billy")
+      etag = "6527914a91e0c5769f6de281f25bd891"
+      cached_response = Flexirest::CachedResponse.new(
+        status:200,
+        result:object,
+        etag:etag,
+        expires:Time.now + 30)
+      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:{})))
+      ret = Person.all
+      expect(ret.first.first_name).to eq("Billy")
+      expect(ret._status).to eq(200)
+      Timecop.return
+    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)
@@ -233,9 +254,9 @@ describe Flexirest::Caching do
       Person.all
     end
 
-    it "should write the response to the cache if there's an etag" do
+    it "should write the response to the cache without expires_in option if there's 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), {})
+      expect_any_instance_of(CachingExampleCacheStore5).to receive(:write).once.with("Person:/", an_instance_of(String), hash_excluding(:expires_in))
       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:{etag:"1234567890"})))
       Person.perform_caching true
       Person.all
@@ -264,14 +285,22 @@ describe Flexirest::Caching do
       end
     end
 
-    it "should write the response to the cache if there's a hard expiry" do
+    it "should write the response to the cache with expires_in option if there's a hard expiry in the future" 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), an_instance_of(Hash))
+      expect_any_instance_of(CachingExampleCacheStore5).to receive(:write).once.with("Person:/", an_instance_of(String), hash_including(:expires_in))
       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:{expires:(Time.now + 30).rfc822})))
       Person.perform_caching = true
       Person.all
     end
 
+    it "should not write the response to the cache if there's a hard expiry in the past" do
+      expect_any_instance_of(CachingExampleCacheStore5).to receive(:read).once.with("Person:/").and_return(nil)
+      expect_any_instance_of(CachingExampleCacheStore5).not_to receive(:write)
+      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:{expires:(Time.now - 10).rfc822})))
+      Person.perform_caching = true
+      Person.all
+    end
+
     it "should not write the response to the cache if there's an invalid expiry" do
       expect_any_instance_of(CachingExampleCacheStore5).to receive(:read).once.with("Person:/").and_return(nil)
       expect_any_instance_of(CachingExampleCacheStore5).to_not receive(:write).once.with("Person:/", an_instance_of(String), an_instance_of(Hash))

data/spec/spec_helper.rb

@@ -3,6 +3,7 @@ require 'simplecov'
 require 'flexirest'
 require "ostruct"
 require 'webmock/rspec'
+require 'timecop'
 
 if ENV["JENKINS"]
   require 'simplecov-rcov'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flexirest
 version: !ruby/object:Gem::Version
-  version: 1.11.0
+  version: 1.11.1
 platform: ruby
 authors:
 - Andy Jeffries
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-03 00:00:00.000000000 Z
+date: 2023-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -178,6 +178,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: mime-types
   requirement: !ruby/object:Gem::Requirement
@@ -393,7 +407,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
 summary: This gem is for accessing REST services in a flexible way.  ActiveResource