nexus_mods 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a25aa2568a5be1e1a8592196344fde1ca68bcf814b67a51cf6921f7ed64c0f70
-  data.tar.gz: cdb50c9b1394af620109ea82439a3254b96ad223286ae1f797fcbc37c32a1a58
+  metadata.gz: 0d5efb3b98f3d8b66565eff56b7b6360fc99bae69a256423e6eae391eb3cd676
+  data.tar.gz: 7091d96c8a79ec591e805bcc09958199187b5f0afd73de85b5da314c2e24381a
 SHA512:
-  metadata.gz: b7f49167041ee67f3855c0a474cdba90a744660f424356943516016628f1e65f37154c7c6b596eca2b7ac2430eae4b0726db6a45d3685b750bdf7a33e8674d2e
-  data.tar.gz: ce904391c82e93f029a41a47d3e7e391af8dac23625ac38eda01b2066ea9261ae3ff7bbea2aed23fbbba9b124846be80640bdbbf94ef98291b1b020824ec74df
+  metadata.gz: 1485e5270d8fcffb7a2ebfec15848f0f2af3a2575beef6b2d1c4746af682bd13142d15f140adae1c9e7c15d731d85d63d01ec135f28600e73d58249bc130990e
+  data.tar.gz: eccb9f4312f63a8c8fc459592c4c0c618378f59a69a261512981e890c0bfffa8c2044bafbcd16da9ec9c8d3b980a53a2e5322a89c5eece959240cafb7ac05e19

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# [v2.3.0](https://github.com/Muriel-Salvan/nexus_mods/compare/v2.2.0...v2.3.0) (2023-04-12 15:08:22)
+
+### Features
+
+* [[Feature] Add a way to set cache timestamps manually](https://github.com/Muriel-Salvan/nexus_mods/commit/7e5ac1d16d1d31f4aa33ebb9a748310e4572a06f)
+
 # [v2.2.0](https://github.com/Muriel-Salvan/nexus_mods/compare/v2.1.0...v2.2.0) (2023-04-12 12:56:31)
 
 ### Features

data/lib/nexus_mods/api_client.rb

@@ -76,6 +76,21 @@ class NexusMods
       str_time.nil? ? nil : Time.parse(str_time)
     end
 
+    # Set the timestamp of the cached data linked to a given API call.
+    # This should be used only to update the cache timestamp of a resource we know is still up-to-date without fetching the resource for real again.
+    #
+    # Parameters::
+    # * *path* (String): API path to contact (from v1/ and without .json)
+    # * *parameters* (Hash<Symbol,Object>): Optional parameters to add to the path [default: {}]
+    # * *verb* (Symbol): Verb to be used (:get, :post...) [default: :get]
+    # * *cache_timestamp* (Time): The cache timestamp to set for this resource
+    def set_api_cache_timestamp(path, cache_timestamp:, parameters: {}, verb: :get)
+      key = ApiClient.cache_key(path, parameters:, verb:)
+      Cacheable.cache_adapter.context[key] = {} unless Cacheable.cache_adapter.context.key?(key)
+      Cacheable.cache_adapter.context[key]['invalidate_time'] = cache_timestamp.utc.strftime('%FT%T.%9NUTC')
+      save_api_cache
+    end
+
     # Send an HTTP request to the API and get back the HTTP response
     #
     # Parameters::

data/lib/nexus_mods/version.rb

@@ -1,5 +1,5 @@
 class NexusMods
 
-  VERSION = '2.2.0'
+  VERSION = '2.3.0'
 
 end

data/lib/nexus_mods.rb

@@ -151,6 +151,15 @@ class NexusMods
     @api_client.api_cache_timestamp('games')
   end
 
+  # Set the cached timestamp of the list of games.
+  # This should be used only to update the cache timestamp of a resource we know is still up-to-date without fetching the resource for real again.
+  #
+  # Parameters::
+  # * *cache_timestamp* (Time): The cache timestamp to set for this resource
+  def set_games_cache_timestamp(cache_timestamp:)
+    @api_client.set_api_cache_timestamp('games', cache_timestamp:)
+  end
+
   # Get information about a mod
   #
   # Parameters::
@@ -202,6 +211,17 @@ class NexusMods
     @api_client.api_cache_timestamp("games/#{game_domain_name}/mods/#{mod_id}")
   end
 
+  # Set the cached timestamp of a mod information.
+  # This should be used only to update the cache timestamp of a resource we know is still up-to-date without fetching the resource for real again.
+  #
+  # Parameters::
+  # * *game_domain_name* (String): Game domain name to query by default [default: @game_domain_name]
+  # * *mod_id* (Integer): The mod ID [default: @mod_id]
+  # * *cache_timestamp* (Time): The cache timestamp to set for this resource
+  def set_mod_cache_timestamp(cache_timestamp:, game_domain_name: @game_domain_name, mod_id: @mod_id)
+    @api_client.set_api_cache_timestamp("games/#{game_domain_name}/mods/#{mod_id}", cache_timestamp:)
+  end
+
   # Get files belonging to a mod
   #
   # Parameters::
@@ -244,6 +264,17 @@ class NexusMods
     @api_client.api_cache_timestamp("games/#{game_domain_name}/mods/#{mod_id}/files")
   end
 
+  # Set the cached timestamp of a mod files information.
+  # This should be used only to update the cache timestamp of a resource we know is still up-to-date without fetching the resource for real again.
+  #
+  # Parameters::
+  # * *game_domain_name* (String): Game domain name to query by default [default: @game_domain_name]
+  # * *mod_id* (Integer): The mod ID [default: @mod_id]
+  # * *cache_timestamp* (Time): The cache timestamp to set for this resource
+  def set_mod_files_cache_timestamp(cache_timestamp:, game_domain_name: @game_domain_name, mod_id: @mod_id)
+    @api_client.set_api_cache_timestamp("games/#{game_domain_name}/mods/#{mod_id}/files", cache_timestamp:)
+  end
+
   # Get a list of updated mod ids since a given time
   #
   # Parameters::
@@ -266,7 +297,7 @@ class NexusMods
     end
   end
 
-  # Get the cached timestamp of a mod files information
+  # Get the cached timestamp of updated mod ids
   #
   # Parameters::
   # * *game_domain_name* (String): Game domain name to query by default [default: @game_domain_name]
@@ -281,6 +312,21 @@ class NexusMods
     @api_client.api_cache_timestamp("games/#{game_domain_name}/mods/updated", parameters: period_to_url_params(since))
   end
 
+  # Set the cached timestamp of updated mod ids.
+  # This should be used only to update the cache timestamp of a resource we know is still up-to-date without fetching the resource for real again.
+  #
+  # Parameters::
+  # * *game_domain_name* (String): Game domain name to query by default [default: @game_domain_name]
+  # * *since* (Symbol): The time from which we look for updated mods [default: :one_day]
+  #   Possible values are:
+  #   * *one_day*: Since 1 day
+  #   * *one_week*: Since 1 week
+  #   * *one_month*: Since 1 month
+  # * *cache_timestamp* (Time): The cache timestamp to set for this resource
+  def set_updated_mods_cache_timestamp(cache_timestamp:, game_domain_name: @game_domain_name, since: :one_day)
+    @api_client.set_api_cache_timestamp("games/#{game_domain_name}/mods/updated", parameters: period_to_url_params(since), cache_timestamp:)
+  end
+
   private
 
   # Get the URL parameters from the required period

data/spec/nexus_mods_test/scenarios/nexus_mods/nexus_mods_caching_spec.rb

@@ -20,6 +20,7 @@ describe NexusMods do
         query: proc { |nm| nm.games },
         query_without_cache: proc { |nm| nm.games(clear_cache: true) },
         get_cache_timestamp: proc { |nm| nm.games_cache_timestamp },
+        set_cache_timestamp: proc { |nm, ts| nm.set_games_cache_timestamp(cache_timestamp: ts) },
         expiry_cache_param: :games
       },
       'mods' => {
@@ -28,6 +29,7 @@ describe NexusMods do
         query: proc { |nm| nm.mod(game_domain_name: 'skyrimspecialedition', mod_id: 2014) },
         query_without_cache: proc { |nm| nm.mod(game_domain_name: 'skyrimspecialedition', mod_id: 2014, clear_cache: true) },
         get_cache_timestamp: proc { |nm| nm.mod_cache_timestamp(game_domain_name: 'skyrimspecialedition', mod_id: 2014) },
+        set_cache_timestamp: proc { |nm, ts| nm.set_mod_cache_timestamp(game_domain_name: 'skyrimspecialedition', mod_id: 2014, cache_timestamp: ts) },
         expiry_cache_param: :mod
       },
       'mod files' => {
@@ -41,6 +43,7 @@ describe NexusMods do
         query: proc { |nm| nm.mod_files(game_domain_name: 'skyrimspecialedition', mod_id: 2014) },
         query_without_cache: proc { |nm| nm.mod_files(game_domain_name: 'skyrimspecialedition', mod_id: 2014, clear_cache: true) },
         get_cache_timestamp: proc { |nm| nm.mod_files_cache_timestamp(game_domain_name: 'skyrimspecialedition', mod_id: 2014) },
+        set_cache_timestamp: proc { |nm, ts| nm.set_mod_files_cache_timestamp(game_domain_name: 'skyrimspecialedition', mod_id: 2014, cache_timestamp: ts) },
         expiry_cache_param: :mod_files
       }
     }.merge(
@@ -68,7 +71,8 @@ describe NexusMods do
             ],
             query: proc { |nm| nm.updated_mods(game_domain_name: 'skyrimspecialedition', since: since_config[:since]) },
             query_without_cache: proc { |nm| nm.updated_mods(game_domain_name: 'skyrimspecialedition', since: since_config[:since], clear_cache: true) },
-            get_cache_timestamp: proc { |nm| nm.updated_mods_cache_timestamp(game_domain_name: 'skyrimspecialedition', since: since_config[:since]) }
+            get_cache_timestamp: proc { |nm| nm.updated_mods_cache_timestamp(game_domain_name: 'skyrimspecialedition', since: since_config[:since]) },
+            set_cache_timestamp: proc { |nm, ts| nm.set_updated_mods_cache_timestamp(game_domain_name: 'skyrimspecialedition', since: since_config[:since], cache_timestamp: ts) }
           }
         ]
       end
@@ -131,6 +135,18 @@ describe NexusMods do
           expect(resource_config[:get_cache_timestamp].call(nexus_mods)).to be_between(before, after)
         end
 
+        it 'changes manually the timestamp of the data stored in the API cache' do
+          expect_validate_user
+          expect_http_call_to(
+            path: resource_config[:expected_api_path],
+            json: resource_config[:mocked_api_json]
+          )
+          resource_config[:query].call(nexus_mods)
+          new_cache_timestamp = Time.parse('2023-01-12 11:22:33 UTC')
+          resource_config[:set_cache_timestamp].call(nexus_mods, new_cache_timestamp)
+          expect(resource_config[:get_cache_timestamp].call(nexus_mods)).to eq new_cache_timestamp
+        end
+
         it 'retrieves the timestamp of the games data stored in the cache even after cache is used' do
           expect_validate_user
           expect_http_call_to(
@@ -159,7 +175,22 @@ describe NexusMods do
           end
         end
 
-        it 'updates the timestamp of the data stored in the API cache' do
+        it 'persists the cache timestamp that has been changed manually' do
+          with_api_cache_file do |api_cache_file|
+            expect_validate_user(times: 2)
+            expect_http_call_to(
+              path: resource_config[:expected_api_path],
+              json: resource_config[:mocked_api_json]
+            )
+            resource_config[:query].call(nexus_mods(api_cache_file:))
+            new_cache_timestamp = Time.parse('2023-01-12 11:22:33 UTC')
+            resource_config[:set_cache_timestamp].call(nexus_mods, new_cache_timestamp)
+            reset_nexus_mods
+            expect(resource_config[:get_cache_timestamp].call(nexus_mods(api_cache_file:))).to eq new_cache_timestamp
+          end
+        end
+
+        it 'updates the timestamp of the data stored in the API cache by forcing an API query' do
           expect_validate_user
           expect_http_call_to(
             path: resource_config[:expected_api_path],
@@ -174,6 +205,21 @@ describe NexusMods do
           expect(resource_config[:get_cache_timestamp].call(nexus_mods)).to be_between(before, after)
         end
 
+        it 'updates the timestamp of the data stored in the API cache by updating manually the cache timestamp' do
+          expect_validate_user
+          expect_http_call_to(
+            path: resource_config[:expected_api_path],
+            json: resource_config[:mocked_api_json],
+            times: 2
+          )
+          resource_config[:query].call(nexus_mods)
+          resource_config[:set_cache_timestamp].call(nexus_mods, Time.now.utc - (365 * 24 * 60 * 60))
+          before = Time.now
+          resource_config[:query].call(nexus_mods)
+          after = Time.now
+          expect(resource_config[:get_cache_timestamp].call(nexus_mods)).to be_between(before, after)
+        end
+
         context 'when testing cache persistence in files' do
 
           it 'persists API cache in a file' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nexus_mods
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Muriel Salvan