nexus_mods 1.0.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b99b3c80e3d45a5bde54394040517dc6e7c3cb803dfa4b3be263a0283bdf5606
-  data.tar.gz: cae008f32c14745db775d1791c631f15cab5071e3dcd0ac0d4d0c0ce5ba1a1c8
+  metadata.gz: 9fd9e01b4661eaa68f2a7fea3c52907b55f9bb7379f1e8f5423742f164784b95
+  data.tar.gz: 8a87ea1ba913a9f41303918a338649065eef99d5c3b8ec75b4fb4bbdbd782bcc
 SHA512:
-  metadata.gz: 8c0bf7800a21880cf748a0733d14483e3326d939671a5aa41b3e0076d3ef9ea46ff2e4d498078c95990a729542dd23ca15d229726e70b63eba139abd53ed828e
-  data.tar.gz: 754f2778855552657f7977d03fd8b84e58fc291b85b21f12dd6ee0d6a9baa6ade16670acc97244a043320f09d8b93e638b0ac4f680725b558b748c10bfcf99ba
+  metadata.gz: 382f42ee4d79d68ac34c6715fa3ad3f154a9376ff0b0b41b651804adaef512c681fa53a0d9112d1897757a8e77d3f8902bff468099fc78e48a97fc050f7d9bac
+  data.tar.gz: 6dd0631ddc2575c33da22390eeef859b3d01a1b805b566337add1eba2bb2fcd23925d250edde5b15d54a92cad5596125330645cff7f4a9eb13e3a2ef1be06f57

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+# [v1.1.1](https://github.com/Muriel-Salvan/nexus_mods/compare/v1.1.0...v1.1.1) (2023-04-10 19:39:28)
+
+### Patches
+
+* [Improved documentation and added examples](https://github.com/Muriel-Salvan/nexus_mods/commit/0eb3fd00e0d1ad34db04a30ab2043a49371dc64f)
+
+# [v1.1.0](https://github.com/Muriel-Salvan/nexus_mods/compare/v1.0.0...v1.1.0) (2023-04-10 19:19:16)
+
+### Features
+
+* [[Feature] Add log_level parameter while creating nexus_mods instance](https://github.com/Muriel-Salvan/nexus_mods/commit/1b6215be2d9b3a97076bb6b7bf665f8ec8e900ca)
+
 # [v1.0.0](https://github.com/Muriel-Salvan/nexus_mods/compare/v0.6.0...v1.0.0) (2023-04-10 19:03:51)
 
 ### Breaking changes

data/README.md

@@ -2,6 +2,17 @@
 
 Simple Ruby API letting you handle [NexusMods](https://www.nexusmods.com/) REST API.
 
+## Main features
+
+* Get the API **limits**.
+* Get the **games** information.
+* Get individual **mods** and **mod files** information.
+* Configurable **caching** with expiry times to save API calls to nexusmods.com.
+* All served in an object-oriented **API in full Ruby**.
+
+See the [examples](examples) for more details on how to use it.
+Those examples expect that you set a valid NexusMods API key in the `NEXUS_MODS_API_KEY` environment variable.
+
 ## Install
 
 Via gem
@@ -54,7 +65,7 @@ Any contribution is welcome:
 
 ## Credits
 
-- [Muriel Salvan][link-author]
+- [Muriel Salvan](https://x-aeon.com/muriel)
 
 ## License
 

data/examples/api_caching.rb

@@ -0,0 +1,41 @@
+require 'nexus_mods'
+require 'fileutils'
+
+# Make sure a previous file for caching was not here before
+test_api_cache_file = 'nexus_mods_test_api_cache.json'
+FileUtils.rm_f test_api_cache_file
+
+nexus_mods = NexusMods.new(
+  api_key: ENV.fetch('NEXUS_MODS_API_KEY'),
+  api_cache_file: test_api_cache_file
+)
+
+initial_remaining = nexus_mods.api_limits.daily_remaining
+puts "Before fetching anything, daily API remaining is #{initial_remaining}"
+
+puts 'Fetch the list of games (without using cache)...'
+puts "Fetched #{nexus_mods.games.size} games."
+
+puts "After fetching those games, daily API remaining is #{nexus_mods.api_limits.daily_remaining}"
+
+puts 'Now we fetch again the list of games (this should use the cache)...'
+puts "Fetched #{nexus_mods.games.size} games."
+
+puts "After fetching those games a second time, daily API remaining is #{nexus_mods.api_limits.daily_remaining}"
+
+puts 'Now we close the current NexusMods instance ad re-instantiate a new one from scratch using the same API cache file'
+
+new_nexus_mods = NexusMods.new(
+  api_key: ENV.fetch('NEXUS_MODS_API_KEY'),
+  api_cache_file: test_api_cache_file
+)
+
+puts "Before fetching anything from the new instance, daily API remaining is #{new_nexus_mods.api_limits.daily_remaining}"
+
+puts 'Now we fetch the list of games from the new instance (this should use the cache that was stored in the file)...'
+puts "Fetched #{new_nexus_mods.games.size} games."
+
+puts "After fetching those games from the new instance, daily API remaining is #{new_nexus_mods.api_limits.daily_remaining}"
+
+puts
+puts "As a conclusion, we used 2 instances of NexusMods that have fetched games 3 times, and it consumed #{initial_remaining - new_nexus_mods.api_limits.daily_remaining} real API call."

data/examples/api_limits.rb

@@ -0,0 +1,12 @@
+require 'nexus_mods'
+
+api_limits = NexusMods.new(api_key: ENV.fetch('NEXUS_MODS_API_KEY')).api_limits
+puts <<~EO_OUTPUT
+  API limits:
+    daily_limit: #{api_limits.daily_limit}
+    daily_remaining: #{api_limits.daily_remaining}
+    daily_reset: #{api_limits.daily_reset}
+    hourly_limit: #{api_limits.hourly_limit}
+    hourly_remaining: #{api_limits.hourly_remaining}
+    hourly_reset: #{api_limits.hourly_reset}
+EO_OUTPUT

data/examples/games.rb

@@ -0,0 +1,8 @@
+require 'nexus_mods'
+
+games = NexusMods.new(api_key: ENV.fetch('NEXUS_MODS_API_KEY')).games
+puts "Found a total of #{games.size} games."
+puts 'Here is the top 10 by number of downloads:'
+games.sort_by { |game| -game.downloads_count }[0..9].each do |game|
+  puts "* #{game.name} (#{game.mods_count} mods, #{game.downloads_count} downloads)"
+end

data/examples/log_debug.rb

@@ -0,0 +1,10 @@
+require 'nexus_mods'
+
+puts 'Example of fetching a mod with log debug activated, and without using the cache (so that we always see the query):'
+puts
+NexusMods.new(
+  api_key: ENV.fetch('NEXUS_MODS_API_KEY'),
+  log_level: :debug,
+  game_domain_name: 'skyrimspecialedition',
+  mod_id: 42_521
+).mod(clear_cache: true)

data/examples/mods.rb

@@ -0,0 +1,24 @@
+require 'nexus_mods'
+
+nexus_mods = NexusMods.new(
+  api_key: ENV.fetch('NEXUS_MODS_API_KEY'),
+  game_domain_name: 'skyrimspecialedition'
+)
+some_mod_ids = [
+  266,
+  2_347,
+  17_230,
+  42_521
+]
+puts 'Here are some details about a few mods for Skyrim Special Edition:'
+puts
+some_mod_ids.each do |mod_id|
+  mod = nexus_mods.mod(mod_id:)
+  mod_files = nexus_mods.mod_files(mod_id:)
+  puts <<~EO_OUTPUT
+    ===== #{mod.name} (v#{mod.version}) by #{mod.uploader.name} (#{mod.downloads_count} downloads)
+    #{mod.summary}
+    * Last 5 files: #{mod_files.reverse[0..4].map(&:file_name).join(', ')}
+
+  EO_OUTPUT
+end

data/lib/nexus_mods/version.rb

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

data/lib/nexus_mods.rb

@@ -46,6 +46,7 @@ class NexusMods
   #   * *mod_files*: Expiry associated to queries on mod files [default: 1 day]
   # * *api_cache_file* (String): File used to store the NexusMods API cache, or nil for no cache [default: "#{Dir.tmpdir}/nexus_mods_api_cache.json"]
   # * *logger* (Logger): The logger to be used for log messages [default: Logger.new(STDOUT)]
+  # * *log_level* (Symbol): The logger level to be set [default: :info]
   def initialize(
     api_key: nil,
     game_domain_name: 'skyrimspecialedition',
@@ -54,12 +55,14 @@ class NexusMods
     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)
+    logger: Logger.new($stdout),
+    log_level: :info
   )
     @game_domain_name = game_domain_name
     @mod_id = mod_id
     @file_id = file_id
     @logger = logger
+    @logger.level = log_level
     @premium = false
     @api_client = ApiClient.new(
       api_key:,

data/spec/nexus_mods_test/helpers.rb

@@ -66,12 +66,20 @@ module NexusModsTest
       @nexus_mods
     end
 
+    # Get NexusMods logs
+    #
+    # Result::
+    # * String: The NexusMods logs
+    def nexus_mods_logs
+      @nexus_mods_logger.string
+    end
+
     # Reset the NexusMods instance.
     # Dump the output if needed for debugging purposes.
     def reset_nexus_mods
       if @nexus_mods && test_debug?
         puts '===== NexusMods output BEGIN ====='
-        puts @nexus_mods_logger.string
+        puts nexus_mods_logs
         puts '===== NexusMods output END ====='
       end
       @nexus_mods = nil

data/spec/nexus_mods_test/scenarios/nexus_mods/api/mod_spec.rb

@@ -6,14 +6,6 @@ describe NexusMods::Api::Mod do
       expect_validate_user
     end
 
-    it 'returns the default game domain name' do
-      expect(nexus_mods(game_domain_name: 'skyrimspecialedition').game_domain_name).to eq 'skyrimspecialedition'
-    end
-
-    it 'returns the default game mod id' do
-      expect(nexus_mods(mod_id: 2014).mod_id).to eq 2014
-    end
-
     it 'returns a mod complete information' do
       expect_http_call_to(
         path: '/v1/games/skyrimspecialedition/mods/2014.json',

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

@@ -0,0 +1,32 @@
+describe NexusMods do
+
+  context 'when testing authentication and access' do
+
+    it 'returns the default game domain name' do
+      expect_validate_user
+      expect(nexus_mods(game_domain_name: 'skyrimspecialedition').game_domain_name).to eq 'skyrimspecialedition'
+    end
+
+    it 'returns the default game mod id' do
+      expect_validate_user
+      expect(nexus_mods(mod_id: 2014).mod_id).to eq 2014
+    end
+
+    it 'accepts the log level' do
+      expect_validate_user(times: 2)
+      expect_http_call_to(
+        path: '/v1/games.json',
+        json: [],
+        times: 2
+      )
+      nexus_mods(log_level: :debug).games
+      log_debug = nexus_mods_logs
+      reset_nexus_mods
+      nexus_mods(log_level: :info).games
+      log_info = nexus_mods_logs
+      expect(log_debug.size).to be > log_info.size
+    end
+
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nexus_mods
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Muriel Salvan
@@ -131,10 +131,20 @@ extra_rdoc_files:
 - CHANGELOG.md
 - LICENSE.md
 - README.md
+- examples/api_caching.rb
+- examples/api_limits.rb
+- examples/games.rb
+- examples/log_debug.rb
+- examples/mods.rb
 files:
 - CHANGELOG.md
 - LICENSE.md
 - README.md
+- examples/api_caching.rb
+- examples/api_limits.rb
+- examples/games.rb
+- examples/log_debug.rb
+- examples/mods.rb
 - lib/nexus_mods.rb
 - lib/nexus_mods/api/api_limits.rb
 - lib/nexus_mods/api/category.rb
@@ -157,8 +167,9 @@ files:
 - spec/nexus_mods_test/scenarios/nexus_mods/api/game_spec.rb
 - spec/nexus_mods_test/scenarios/nexus_mods/api/mod_file_spec.rb
 - spec/nexus_mods_test/scenarios/nexus_mods/api/mod_spec.rb
-- spec/nexus_mods_test/scenarios/nexus_mods_access_spec.rb
-- spec/nexus_mods_test/scenarios/nexus_mods_caching_spec.rb
+- spec/nexus_mods_test/scenarios/nexus_mods/nexus_mods_access_spec.rb
+- spec/nexus_mods_test/scenarios/nexus_mods/nexus_mods_caching_spec.rb
+- spec/nexus_mods_test/scenarios/nexus_mods/nexus_mods_common_spec.rb
 - spec/nexus_mods_test/scenarios/rubocop_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/Muriel-Salvan/nexus_mods