nexus_mods 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b99b3c80e3d45a5bde54394040517dc6e7c3cb803dfa4b3be263a0283bdf5606
-  data.tar.gz: cae008f32c14745db775d1791c631f15cab5071e3dcd0ac0d4d0c0ce5ba1a1c8
+  metadata.gz: a6490bd894c40f7806bb126cb70ade888ab5121499b86ff2cc959ee663dd223d
+  data.tar.gz: d9fdeb53c88c27ce9503e328a261ddb31a0facbbe0b6c35c304628c6e9580790
 SHA512:
-  metadata.gz: 8c0bf7800a21880cf748a0733d14483e3326d939671a5aa41b3e0076d3ef9ea46ff2e4d498078c95990a729542dd23ca15d229726e70b63eba139abd53ed828e
-  data.tar.gz: 754f2778855552657f7977d03fd8b84e58fc291b85b21f12dd6ee0d6a9baa6ade16670acc97244a043320f09d8b93e638b0ac4f680725b558b748c10bfcf99ba
+  metadata.gz: 7c8f9576edd38dab0076f24ad1d396973c9d1ab8542ff4eef548d9b49758f85b6da465465b10b1e53dbb2db6d8312f31e9b88649916f654e7b8c1a12092aaadb
+  data.tar.gz: 1b2d1e915594af39c9bd793a8f216fc2796024e2729a2b5596c35b546e04c8e2bb96dce77aa35e11f5d7a98fba1652c79f77f01648a363cfdf9b93ec40ee7602

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# [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/lib/nexus_mods/version.rb

@@ -1,5 +1,5 @@
 class NexusMods
 
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 
 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.0
 platform: ruby
 authors:
 - Muriel Salvan
@@ -157,8 +157,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