nexus_mods 0.6.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 81b66890f6e45e4f48b44fc3dbc2ce5f8ae7c3ee037960b95f4f269adb41ee77
-  data.tar.gz: 611d91825c05ba62fc6a6fcf16b62ba07cf284479e21e7bfb306b397ea910613
+  metadata.gz: a6490bd894c40f7806bb126cb70ade888ab5121499b86ff2cc959ee663dd223d
+  data.tar.gz: d9fdeb53c88c27ce9503e328a261ddb31a0facbbe0b6c35c304628c6e9580790
 SHA512:
-  metadata.gz: 6e53e797874ad30d2f6877202d0c926d21124b5208447e15d9af38d5ce6424b96d153d1c9c7ffafa8073d96ac9addcb5e0273438efb5899ef296d35355e2d889
-  data.tar.gz: cfa6d681a78c652108d70e605a951178b90e20a21a6477e7ef98c3822e00fdca50912973c675019dc69e5d69c7735025666252b82bbdc2761a038147c76c6fc0
+  metadata.gz: 7c8f9576edd38dab0076f24ad1d396973c9d1ab8542ff4eef548d9b49758f85b6da465465b10b1e53dbb2db6d8312f31e9b88649916f654e7b8c1a12092aaadb
+  data.tar.gz: 1b2d1e915594af39c9bd793a8f216fc2796024e2729a2b5596c35b546e04c8e2bb96dce77aa35e11f5d7a98fba1652c79f77f01648a363cfdf9b93ec40ee7602

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+# [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
+
+* [[Breaking] Keep category_id in mod files and use category for interpretation, including unknowns categories](https://github.com/Muriel-Salvan/nexus_mods/commit/a6b01df6d03d27ee880260e46884f09e6a497f1d)
+
 # [v0.6.0](https://github.com/Muriel-Salvan/nexus_mods/compare/v0.5.1...v0.6.0) (2023-04-10 17:30:40)
 
 ### Features

data/lib/nexus_mods/api/mod_file.rb

@@ -14,6 +14,7 @@ class NexusMods
           id
           name
           version
+          category
           category_id
           category_name
           is_primary
@@ -28,6 +29,17 @@ class NexusMods
         ]
       )
 
+      # Enum of file categories from the API
+      FILE_CATEGORIES = {
+        1 => :main,
+        2 => :patch,
+        3 => :optional,
+        4 => :old,
+        5 => :miscellaneous,
+        6 => :deleted,
+        7 => :archived
+      }
+
       # Constructor
       #
       # Parameters::
@@ -81,6 +93,8 @@ class NexusMods
         @description = description
         @changelog_html = changelog_html
         @content_preview_url = content_preview_url
+        # Extra fields for sugar
+        @category = FILE_CATEGORIES[category_id] || :unknown
       end
 
       # Equality operator

data/lib/nexus_mods/version.rb

@@ -1,5 +1,5 @@
 class NexusMods
 
-  VERSION = '0.6.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:,
@@ -182,15 +185,6 @@ class NexusMods
     )
   end
 
-  # Enum of file categories from the API
-  FILE_CATEGORIES = {
-    1 => :main,
-    2 => :patch,
-    3 => :optional,
-    4 => :old,
-    6 => :deleted
-  }
-
   # Get files belonging to a mod
   #
   # Parameters::
@@ -201,16 +195,13 @@ class NexusMods
   # * Array<ModFile>: List of mod's files
   def mod_files(game_domain_name: @game_domain_name, mod_id: @mod_id, clear_cache: false)
     @api_client.api("games/#{game_domain_name}/mods/#{mod_id}/files", clear_cache:)['files'].map do |file_json|
-      category_id = FILE_CATEGORIES[file_json['category_id']]
-      raise "Unknown file category: #{file_json['category_id']}" if category_id.nil?
-
       Api::ModFile.new(
         ids: file_json['id'],
         uid: file_json['uid'],
         id: file_json['file_id'],
         name: file_json['name'],
         version: file_json['version'],
-        category_id:,
+        category_id: file_json['category_id'],
         category_name: file_json['category_name'],
         is_primary: file_json['is_primary'],
         size: file_json['size_in_bytes'],

data/spec/nexus_mods_test/factories/mod_files.rb

@@ -70,7 +70,8 @@ module NexusModsTest
         expect(mod_file.id).to eq 2472
         expect(mod_file.name).to eq 'ApachiiSkyHair_v_1_6_Full'
         expect(mod_file.version).to eq '1.6.Full'
-        expect(mod_file.category_id).to eq :old
+        expect(mod_file.category).to eq :old
+        expect(mod_file.category_id).to eq 4
         expect(mod_file.category_name).to eq 'OLD_VERSION'
         expect(mod_file.is_primary).to be false
         expect(mod_file.size).to eq 309_251_227
@@ -93,7 +94,8 @@ module NexusModsTest
         expect(mod_file.id).to eq 2487
         expect(mod_file.name).to eq 'ApachiiSkyHairMale_v_1_2'
         expect(mod_file.version).to eq '1.2'
-        expect(mod_file.category_id).to eq :old
+        expect(mod_file.category).to eq :old
+        expect(mod_file.category_id).to eq 4
         expect(mod_file.category_name).to eq 'OLD_VERSION'
         expect(mod_file.is_primary).to be false
         expect(mod_file.size).to eq 209_251_227

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_file_spec.rb

@@ -49,6 +49,15 @@ describe NexusMods::Api::ModFile do
       expect_mod_files_to_be_example(nexus_mods(game_domain_name: 'skyrimspecialedition').mod_files(mod_id: 2014))
     end
 
+    it 'returns mod files list for the default game set using accessor' do
+      expect_http_call_to(
+        path: '/v1/games/skyrimspecialedition/mods/2014/files.json',
+        json: { files: json_example_mod_files }
+      )
+      nexus_mods.game_domain_name = 'skyrimspecialedition'
+      expect_mod_files_to_be_example(nexus_mods.mod_files(mod_id: 2014))
+    end
+
     it 'returns mod files list for the default game and mod' do
       expect_http_call_to(
         path: '/v1/games/skyrimspecialedition/mods/2014/files.json',
@@ -57,6 +66,15 @@ describe NexusMods::Api::ModFile do
       expect_mod_files_to_be_example(nexus_mods(game_domain_name: 'skyrimspecialedition', mod_id: 2014).mod_files)
     end
 
+    it 'returns mod files list for the default game and mod using accessor' do
+      expect_http_call_to(
+        path: '/v1/games/skyrimspecialedition/mods/2014/files.json',
+        json: { files: json_example_mod_files }
+      )
+      nexus_mods.mod_id = 2014
+      expect_mod_files_to_be_example(nexus_mods.mod_files(game_domain_name: 'skyrimspecialedition'))
+    end
+
     it 'compares objects for equality' do
       expect_http_call_to(
         path: '/v1/games/skyrimspecialedition/mods/2014/files.json',
@@ -68,6 +86,54 @@ describe NexusMods::Api::ModFile do
       expect(mod_file1).to eq mod_file2
     end
 
+    {
+      main: 1,
+      patch: 2,
+      optional: 3,
+      old: 4,
+      miscellaneous: 5,
+      deleted: 6,
+      archived: 7,
+      unknown: 100
+    }.each do |category, category_id|
+      it "accepts mod files having category #{category}" do
+        expect_http_call_to(
+          path: '/v1/games/skyrimspecialedition/mods/2014/files.json',
+          json: {
+            files: [
+              {
+                'id' => [
+                  2472,
+                  1704
+                ],
+                'uid' => 7_318_624_274_856,
+                'file_id' => 2472,
+                'name' => 'ApachiiSkyHair_v_1_6_Full',
+                'version' => '1.6.Full',
+                'category_id' => category_id,
+                'category_name' => 'OLD_VERSION',
+                'is_primary' => false,
+                'file_name' => 'ApachiiSkyHair_v_1_6_Full-2014-1-6-Full.7z',
+                'uploaded_timestamp' => 1_477_967_645,
+                'uploaded_time' => '2016-11-01T02:34:05.000+00:00',
+                'mod_version' => '1.6.Full',
+                'external_virus_scan_url' => 'https://www.virustotal.com/file/3dcc96dce0b846ea643d626c48bd6ad08752da8232f3d29be644d36e1fd627cf/analysis/1477978674/',
+                'description' => '[b][color=orange] NOT optimized meshes. Standalone. Adds 42 new hairstyles for females, 21 hair for males and 5 hairs for Female Khajiit- 2 hairs for Male Khajiit[/color][/b]  ',
+                'size' => 304_347,
+                'size_kb' => 304_347,
+                'size_in_bytes' => 309_251_227,
+                'changelog_html' => nil,
+                'content_preview_link' => 'https://file-metadata.nexusmods.com/file/nexus-files-meta/1704/2014/ApachiiSkyHair_v_1_6_Full-2014-1-6-Full.7z.json'
+              }
+            ]
+          }
+        )
+        mod_file = nexus_mods(game_domain_name: 'skyrimspecialedition', mod_id: 2014).mod_files.first
+        expect(mod_file.category).to eq category
+        expect(mod_file.category_id).to eq category_id
+      end
+    end
+
   end
 
 end

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: 0.6.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