nexus_mods 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 758229de2b795e860d8b150e4bbc8a2d516f6e49c2773ac242c0b67472f6c157
-  data.tar.gz: 96e38216e7f54b9198c9362bb01b7ea0fdde2205e357a419123b3337c2791ee4
+  metadata.gz: 30a5d88705ee7a8d0198ee6bd944bcc8735468e162e8bf17877ecffa3a356d27
+  data.tar.gz: c622e319de62f51ee8dd8a8615187105dc8d246efe926933037315798e003ac0
 SHA512:
-  metadata.gz: 8c2fa3106f59e59472bcb39d107d28bba9ce394e9c7d2783d5b60e0074ea7070bfd175aaa1dd543397b057aaabd7bd0778f299609acbf30a706870f4460c95ab
-  data.tar.gz: f2f6994f254288a5c8b7ba806a3f0b9b18a044aacdf9b7edd381b629a6e97c9d49f881ba566437beb4739cf32a2a0b11575fd71f574210e62763fb5fcc86b8cb
+  metadata.gz: c43800296d117d5e07862753eb2325d86549550237ab66c7a8b50d22b16676821cedbb69deea59dbca947266f74c9ba513683cb5846a807fdb338c4468154c81
+  data.tar.gz: d172bd4112bfec791136a5f6b4e608871c92da6f6b3d025337dc767f64b712743173666458e767c57b308d328dbb91409eb7fc4261e92d42c048d9ed1b645eb3

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# [v0.5.1](https://github.com/Muriel-Salvan/nexus_mods/compare/v0.5.0...v0.5.1) (2023-04-10 17:19:39)
+
+### Patches
+
+* [Use more efficient API cache keys](https://github.com/Muriel-Salvan/nexus_mods/commit/3f09a08b815c71a0b0ec6694359c02fd8503bc90)
+
 # [v0.5.0](https://github.com/Muriel-Salvan/nexus_mods/compare/v0.4.0...v0.5.0) (2023-04-10 17:05:11)
 
 ### Features

data/lib/nexus_mods/api_client.rb

@@ -150,13 +150,16 @@ class NexusMods
     end
     cacheable_api(
       :cached_api,
+      key_format: proc do |_target, _method_name, method_args, method_kwargs|
+        "#{method_kwargs[:verb]}/#{method_args.first}"
+      end,
       expiry_from_key: proc do |key|
         # Example of keys:
-        # NexusMods::ApiClient/cached_api/games/verb:get
-        # NexusMods::ApiClient/cached_api/games/skyrimspecialedition/mods/2014/verb:get
-        # NexusMods::ApiClient/cached_api/games/skyrimspecialedition/mods/2014/files/verb:get
-        # NexusMods::ApiClient/cached_api/users/validate/verb:get
-        key_components = key.split('/')[2..-2]
+        # get/games
+        # get/games/skyrimspecialedition/mods/2014
+        # get/games/skyrimspecialedition/mods/2014/files
+        # get/users/validate
+        key_components = key.split('/')[1..]
         case key_components[0]
         when 'games'
           if key_components[1].nil?

data/lib/nexus_mods/cacheable_api.rb

@@ -29,10 +29,19 @@ class NexusMods
       #   * Result::
       #     * Integer: Corresponding expiry time
       # * *on_cache_update* (Proc): Proc called when the cache has been updated
-      def cacheable_api(*original_method_names, expiry_from_key:, on_cache_update:)
+      # * *key_format* (Proc or nil): Optional proc giving the key format from the target of cacheable [default: nil].
+      #   If nil then a default proc concatenating the target's class, method name and all arguments will be used.
+      #   * Parameters::
+      #     * *target* (Object): Object on which the method is cached
+      #     * *method_name* (Symbol): Method being cached
+      #     * *method_args* (Array<Object>): Method's arguments
+      #     * *method_kwargs* (Hash<Symbol,Object>): Method's kwargs
+      #   * Result::
+      #     * String: The corresponding key to be used for caching
+      def cacheable_api(*original_method_names, expiry_from_key:, on_cache_update:, key_format: nil)
         cacheable_with_expiry(
           *original_method_names,
-          key_format: lambda do |target, method_name, method_args, method_kwargs|
+          key_format: key_format || proc do |target, method_name, method_args, method_kwargs|
             (
               [
                 target.class,

data/lib/nexus_mods/version.rb

@@ -1,5 +1,5 @@
 class NexusMods
 
-  VERSION = '0.5.0'
+  VERSION = '0.5.1'
 
 end

data/lib/nexus_mods.rb

@@ -225,9 +225,4 @@ class NexusMods
     end
   end
 
-  # TODO: Check http cache usefulness and either test it or remove it
-  # TODO: Check if attr_reader of mod_id and game_id is needed and remove it if not
-  # TODO: Find better cache keys
-  # TODO: Documentation and examples
-
 end

metadata

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