nexus_mods 1.1.1 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9fd9e01b4661eaa68f2a7fea3c52907b55f9bb7379f1e8f5423742f164784b95
-  data.tar.gz: 8a87ea1ba913a9f41303918a338649065eef99d5c3b8ec75b4fb4bbdbd782bcc
+  metadata.gz: 3aa5f91eb62460b72b2f0f31434cc1d3741c70970b3e4db5f22b57e95bbe6b4c
+  data.tar.gz: 31cdf30406cbed8fa23a432cc7b916ed8223c9344a3d07379adb5cff19f4bfea
 SHA512:
-  metadata.gz: 382f42ee4d79d68ac34c6715fa3ad3f154a9376ff0b0b41b651804adaef512c681fa53a0d9112d1897757a8e77d3f8902bff468099fc78e48a97fc050f7d9bac
-  data.tar.gz: 6dd0631ddc2575c33da22390eeef859b3d01a1b805b566337add1eba2bb2fcd23925d250edde5b15d54a92cad5596125330645cff7f4a9eb13e3a2ef1be06f57
+  metadata.gz: 03a0ddca6e1d752aee0cb6ec887067340d3f31546cb6212da7c01082327fd47f898aa176f0c24175483db6657a8ff54d00bedd71411c37a00141b26e5c68b09c
+  data.tar.gz: ffd3177a8b3dcee3f1c96eeb03e5a9526c5bbcf967ae81c6d926a0f7158eeccae5b7214b4e8c0d769e98f6d5d2058135d8cab5e27436c1ae3df890378c6bca1e

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+# [v2.0.1](https://github.com/Muriel-Salvan/nexus_mods/compare/v2.0.0...v2.0.1) (2023-04-11 10:22:54)
+
+### Patches
+
+* [Added NexusMods version in the user agent](https://github.com/Muriel-Salvan/nexus_mods/commit/41092e06db91d1dc3e3badb66aeccf85d62a2d00)
+
+# [v2.0.0](https://github.com/Muriel-Salvan/nexus_mods/compare/v1.1.1...v2.0.0) (2023-04-11 10:15:58)
+
+### Breaking changes
+
+* [[Breaking] Remove http cache file and useless support for etags as the API does not cache at http level](https://github.com/Muriel-Salvan/nexus_mods/commit/e157524e17ef0ed1a7013f14b15eaa35bb309592)
+
 # [v1.1.1](https://github.com/Muriel-Salvan/nexus_mods/compare/v1.1.0...v1.1.1) (2023-04-10 19:39:28)
 
 ### Patches

data/lib/nexus_mods/api_client.rb

@@ -1,7 +1,6 @@
 require 'fileutils'
 require 'faraday'
-require 'faraday-http-cache'
-require 'nexus_mods/file_cache'
+require 'nexus_mods/version'
 require 'nexus_mods/cacheable_api'
 
 class NexusMods
@@ -23,7 +22,6 @@ class NexusMods
     #
     # Parameters::
     # * *api_key* (String or nil): The API key to be used, or nil for another authentication [default: nil]
-    # * *http_cache_file* (String): File used to store the HTTP cache, or nil for no cache [default: "#{Dir.tmpdir}/nexus_mods_http_cache.json"]
     # * *api_cache_expiry* (Hash<Symbol,Integer>): Expiry times in seconds, per expiry key. Possible keys are:
     #   * *games*: Expiry associated to queries on games [default: 1 day]
     #   * *mod*: Expiry associated to queries on mod [default: 1 day]
@@ -32,7 +30,6 @@ class NexusMods
     # * *logger* (Logger): The logger to be used for log messages [default: Logger.new(STDOUT)]
     def initialize(
       api_key: nil,
-      http_cache_file: "#{Dir.tmpdir}/nexus_mods_http_cache.json",
       api_cache_expiry: DEFAULT_API_CACHE_EXPIRY,
       api_cache_file: "#{Dir.tmpdir}/nexus_mods_api_cache.json",
       logger: Logger.new($stdout)
@@ -43,16 +40,7 @@ class NexusMods
       ApiClient.api_client = self
       @logger = logger
       # Initialize our HTTP client
-      @http_cache = http_cache_file.nil? ? nil : FileCache.new(http_cache_file)
-      @http_client = Faraday.new do |builder|
-        # Indicate that the cache is not shared, meaning that private resources (depending on the session) can be cached as we consider only 1 user is using it for a given file cache.
-        # Use Marshal serializer as some URLs can't get decoded correctly due to UTF-8 issues
-        builder.use :http_cache,
-                    store: @http_cache,
-                    shared_cache: false,
-                    serializer: Marshal
-        builder.adapter Faraday.default_adapter
-      end
+      @http_client = Faraday.new
       Cacheable.cache_adapter = :persistent_json
       load_api_cache
     end
@@ -82,7 +70,7 @@ class NexusMods
       @http_client.send(verb) do |req|
         req.url api_uri(path)
         req.headers['apikey'] = @api_key
-        req.headers['User-Agent'] = "nexus_mods (#{RUBY_PLATFORM}) Ruby/#{RUBY_VERSION}"
+        req.headers['User-Agent'] = "nexus_mods/#{NexusMods::VERSION} (#{RUBY_PLATFORM}) Ruby/#{RUBY_VERSION}"
       end
     end
 

data/lib/nexus_mods/version.rb

@@ -1,5 +1,5 @@
 class NexusMods
 
-  VERSION = '1.1.1'
+  VERSION = '2.0.1'
 
 end

data/lib/nexus_mods.rb

@@ -39,7 +39,6 @@ class NexusMods
   # * *game_domain_name* (String): Game domain name to query by default [default: 'skyrimspecialedition']
   # * *mod_id* (Integer): Mod to query by default [default: 1]
   # * *file_id* (Integer): File to query by default [default: 1]
-  # * *http_cache_file* (String): File used to store the HTTP cache, or nil for no cache [default: "#{Dir.tmpdir}/nexus_mods_http_cache.json"]
   # * *api_cache_expiry* (Hash<Symbol,Integer>): Expiry times in seconds, per expiry key. Possible keys are:
   #   * *games*: Expiry associated to queries on games [default: 1 day]
   #   * *mod*: Expiry associated to queries on mod [default: 1 day]
@@ -52,7 +51,6 @@ class NexusMods
     game_domain_name: 'skyrimspecialedition',
     mod_id: 1,
     file_id: 1,
-    http_cache_file: "#{Dir.tmpdir}/nexus_mods_http_cache.json",
     api_cache_expiry: {},
     api_cache_file: "#{Dir.tmpdir}/nexus_mods_api_cache.json",
     logger: Logger.new($stdout),
@@ -66,7 +64,6 @@ class NexusMods
     @premium = false
     @api_client = ApiClient.new(
       api_key:,
-      http_cache_file:,
       api_cache_expiry:,
       api_cache_file:,
       logger:

data/spec/nexus_mods_test/helpers.rb

@@ -56,7 +56,6 @@ module NexusModsTest
       if @nexus_mods.nil?
         args[:api_key] = MOCKED_API_KEY unless args.key?(:api_key)
         # By default running tests should not persistent cache files
-        args[:http_cache_file] = nil unless args.key?(:http_cache_file)
         args[:api_cache_file] = nil unless args.key?(:api_cache_file)
         # Redirect any log into a string so that they don't pollute the tests output and they could be asserted.
         @nexus_mods_logger = StringIO.new
@@ -112,14 +111,9 @@ module NexusModsTest
       json_as_str = json.to_json
       mocked_etag = "W/\"#{Digest::MD5.hexdigest("#{path}|#{json_as_str}")}\""
       expected_request_headers = {
-        'User-Agent' => "nexus_mods (#{RUBY_PLATFORM}) Ruby/#{RUBY_VERSION}",
+        'User-Agent' => "nexus_mods/#{NexusMods::VERSION} (#{RUBY_PLATFORM}) Ruby/#{RUBY_VERSION}",
         'apikey' => api_key
       }
-      if @expected_returned_etags.include? mocked_etag
-        expected_request_headers['If-None-Match'] = mocked_etag
-      else
-        @expected_returned_etags << mocked_etag
-      end
       @expected_stubs << [
         stub_request(http_method, "https://#{host}#{path}").with(headers: expected_request_headers).to_return(
           status: [code, message],
@@ -190,9 +184,6 @@ RSpec.configure do |config|
     @nexus_mods = nil
     # Reload the ApiClient as it stores caches at class level
     NexusMods::ApiClient.clear_cacheable_expiry_caches
-    # Keep a list of the etags we should have returned, so that we know when queries should contain them
-    # Array<String>
-    @expected_returned_etags = []
     # List of expected stubs and the number of times they were supposed to mock
     # Array< [ WebMock::RequestStub, Integer ] >
     @expected_stubs = []
@@ -205,6 +196,7 @@ RSpec.configure do |config|
   config.around do |example|
     example.call
   ensure
+    # This would dump the logs in case of debug mode
     reset_nexus_mods
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nexus_mods
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 2.0.1
 platform: ruby
 authors:
 - Muriel Salvan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-10 00:00:00.000000000 Z
+date: 2023-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -24,20 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.7'
-- !ruby/object:Gem::Dependency
-  name: faraday-http-cache
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.4'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: cacheable
   requirement: !ruby/object:Gem::Requirement
@@ -157,7 +143,6 @@ files:
 - lib/nexus_mods/cacheable_with_expiry.rb
 - lib/nexus_mods/core_extensions/cacheable/cache_adapters/persistent_json_adapter.rb
 - lib/nexus_mods/core_extensions/cacheable/method_generator.rb
-- lib/nexus_mods/file_cache.rb
 - lib/nexus_mods/version.rb
 - spec/nexus_mods_test/factories/games.rb
 - spec/nexus_mods_test/factories/mod_files.rb

data/lib/nexus_mods/file_cache.rb

@@ -1,71 +0,0 @@
-class NexusMods
-
-  # Simple key/value file cache
-  class FileCache
-
-    # Constructor
-    #
-    # Parameters::
-    # * *file* (String): File to use as a cache
-    def initialize(file)
-      @file = file
-      @cache_content = File.exist?(file) ? JSON.parse(File.read(file)) : {}
-    end
-
-    # Dump the cache in file
-    def dump
-      File.write(@file, @cache_content.to_json)
-    end
-
-    # Get the cache content as a Hash
-    #
-    # Result::
-    # * Hash<String, Object>: Cache content
-    def to_h
-      @cache_content
-    end
-
-    # Is a given key present in the cache?
-    #
-    # Parameters::
-    # * *key* (String): The key
-    # Result::
-    # * Boolean: Is a given key present in the cache?
-    def key?(key)
-      @cache_content.key?(key)
-    end
-
-    # Read a key from the cache
-    #
-    # Parameters:
-    # * *key* (String): The cache key
-    # Result::
-    # * Object or nil: JSON-serializable object storing the value, or nil in case of cache-miss
-    def read(key)
-      @cache_content.key?(key) ? @cache_content[key] : nil
-    end
-
-    alias [] read
-
-    # Write a key/value in the cache
-    #
-    # Parameters:
-    # * *key* (String): The key
-    # * *value* (Object): JSON-serializable object storing the value
-    def write(key, value)
-      @cache_content[key] = value
-    end
-
-    alias []= write
-
-    # Delete a key in the cache
-    #
-    # Parameters:
-    # * *key* (String): The key
-    def delete(key)
-      @cache_content.delete(key)
-    end
-
-  end
-
-end