nexus_mods 2.4.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a55e8c7bacc06ef260c5b4e6f0ac64d3e9391e39f7d1ebb00c74c110a6eae214
-  data.tar.gz: 9647e6745975eb0c8c0fe9023a2e66936773fd9389a5d5087511e8edb3e06876
+  metadata.gz: 6f6c2d6e72c966955e6153a3381458fba4f56c36deac811d125edc962046b5a0
+  data.tar.gz: d0a2ec92da860dbb53b608e1de22762b3562bac1d4fe1333066f868612983747
 SHA512:
-  metadata.gz: 29732e93998b9b8b88d66af4ebd67d37d8eaa51f8ab47b487bf0ce2aa3f81312aed8e1275e83a428e5cfa60a2330a7603a6c114f9bf8898593695b0df79603c3
-  data.tar.gz: 8b3542308bd2736695165a337cef28a2e8ea7e63bd7f67d55f74b4ec797edf556d92e4792e3ea7f83a3f7f56dd028b914bcfba8f713b96679687bb29ddac8a00
+  metadata.gz: d159a8824c0c6b723ec7f3361f1df52162cebf3d4f91833e072ceeb94089fb84d102d46d597d0ee24e92c6983e56ddcd87a95a6a4ffbb282331a7f3aae94cc84
+  data.tar.gz: 9dda81c7f0f593190547ed55aeff36a3040610d13ee59f7c5ff6ffed7df1d95d806685d9cf77e090e3a2410a24a516a32617b9fc047d59cb30f149607022aaba

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# [v2.5.0](https://github.com/Muriel-Salvan/nexus_mods/compare/v2.4.0...v2.5.0) (2023-04-12 19:15:44)
+
+### Features
+
+* [[Feature] Add links between resources](https://github.com/Muriel-Salvan/nexus_mods/commit/84c474b75f3ee1e4ac0c8bbda0d2ad25022f1f07)
+
 # [v2.4.0](https://github.com/Muriel-Salvan/nexus_mods/compare/v2.3.0...v2.4.0) (2023-04-12 17:23:29)
 
 ### Features

data/lib/nexus_mods/api/api_limits.rb

@@ -1,9 +1,11 @@
+require 'nexus_mods/api/resource'
+
 class NexusMods
 
   module Api
 
     # Object giving the NexusMods API limits
-    class ApiLimits
+    class ApiLimits < Resource
 
       attr_reader(
         *%i[
@@ -19,6 +21,7 @@ class NexusMods
       # Constructor
       #
       # Parameters::
+      # * *nexus_mods* (NexusMods): The NexusMods API instance that the resource can use to query for other resources
       # * *daily_limit* (Integer): The daily limit
       # * *daily_remaining* (Integer): The daily remaining
       # * *daily_reset* (Integer): The daily reset time
@@ -26,6 +29,7 @@ class NexusMods
       # * *hourly_remaining* (Integer): The hourly remaining
       # * *hourly_reset* (Integer): The hourly reset time
       def initialize(
+        nexus_mods:,
         daily_limit:,
         daily_remaining:,
         daily_reset:,
@@ -33,6 +37,7 @@ class NexusMods
         hourly_remaining:,
         hourly_reset:
       )
+        super(nexus_mods:)
         @daily_limit = daily_limit
         @daily_remaining = daily_remaining
         @daily_reset = daily_reset

data/lib/nexus_mods/api/category.rb

@@ -1,9 +1,11 @@
+require 'nexus_mods/api/resource'
+
 class NexusMods
 
   module Api
 
     # Categories defined for a game in NexusMods
-    class Category
+    class Category < Resource
 
       attr_reader(
         *%i[
@@ -21,14 +23,17 @@ class NexusMods
       # Constructor
       #
       # Parameters::
+      # * *nexus_mods* (NexusMods): The NexusMods API instance that the resource can use to query for other resources
       # *id* (Integer): The category id
       # *name* (String): The category id
       # *parent_category* (Category or nil): The parent category, or nil if none [default: nil]
       def initialize(
+        nexus_mods:,
         id:,
         name:,
         parent_category: nil
       )
+        super(nexus_mods:)
         @id = id
         @name = name
         @parent_category = parent_category

data/lib/nexus_mods/api/game.rb

@@ -1,3 +1,5 @@
+require 'nexus_mods/api/resource'
+
 class NexusMods
 
   module Api
@@ -5,7 +7,7 @@ class NexusMods
     # A NexusMods game.
     # Attributes info can be taken from there:
     # * https://github.com/Nexus-Mods/node-nexus-api/blob/master/docs/interfaces/_types_.igameinfo.md
-    class Game
+    class Game < Resource
 
       attr_reader(
         *%i[
@@ -29,6 +31,7 @@ class NexusMods
       # Constructor
       #
       # Parameters::
+      # * *nexus_mods* (NexusMods): The NexusMods API instance that the resource can use to query for other resources
       # * *id* (Integer): The game's id
       # * *name* (String): The game's name
       # * *forum_url* (String): The game's forum's URL
@@ -44,6 +47,7 @@ class NexusMods
       # * *mods_count* (Integer): The game's mods' count [default: 0]
       # * *categories* (Array<Category>): The list of game's categories [default: []]
       def initialize(
+        nexus_mods:,
         id:,
         name:,
         forum_url:,
@@ -59,6 +63,7 @@ class NexusMods
         mods_count: 0,
         categories: []
       )
+        super(nexus_mods:)
         @id = id
         @name = name
         @forum_url = forum_url

data/lib/nexus_mods/api/mod.rb

@@ -1,3 +1,5 @@
+require 'nexus_mods/api/resource'
+
 class NexusMods
 
   module Api
@@ -5,7 +7,7 @@ class NexusMods
     # A NexusMods mod.
     # Attributes info can be taken from there:
     # * https://github.com/Nexus-Mods/node-nexus-api/blob/master/docs/interfaces/_types_.imodinfo.md
-    class Mod
+    class Mod < Resource
 
       attr_reader(
         *%i[
@@ -36,6 +38,7 @@ class NexusMods
       # Constructor
       #
       # Parameters::
+      # * *nexus_mods* (NexusMods): The NexusMods API instance that the resource can use to query for other resources
       # * *uid* (Integer): The mod's uid
       # * *mod_id* (Integer): The mod's id
       # * *game_id* (Integer): The mod's game id
@@ -58,6 +61,7 @@ class NexusMods
       # * *unique_downloads_count* (Integer): The mod's unique downloads' count [default: 0]
       # * *endorsements_count* (Integer): The mod's endorsements' count [default: 0]
       def initialize(
+        nexus_mods:,
         uid:,
         mod_id:,
         game_id:,
@@ -80,6 +84,7 @@ class NexusMods
         unique_downloads_count: 0,
         endorsements_count: 0
       )
+        super(nexus_mods:)
         @uid = uid
         @mod_id = mod_id
         @game_id = game_id
@@ -134,6 +139,14 @@ class NexusMods
           @endorsements_count == other.endorsements_count
       end
 
+      # Get associated files information
+      #
+      # Result::
+      # * Array<ModFile>: The list of mod files information
+      def files
+        @nexus_mods.mod_files(game_domain_name: domain_name, mod_id:)
+      end
+
     end
 
   end

data/lib/nexus_mods/api/mod_file.rb

@@ -1,3 +1,5 @@
+require 'nexus_mods/api/resource'
+
 class NexusMods
 
   module Api
@@ -5,10 +7,12 @@ class NexusMods
     # A NexusMods file.
     # Attributes info can be taken from there:
     # * https://github.com/Nexus-Mods/node-nexus-api/blob/master/docs/interfaces/_types_.ifileinfo.md
-    class ModFile
+    class ModFile < Resource
 
       attr_reader(
         *%i[
+          game_domain_name
+          mod_id
           ids
           uid
           id
@@ -43,6 +47,9 @@ class NexusMods
       # Constructor
       #
       # Parameters::
+      # * *nexus_mods* (NexusMods): The NexusMods API instance that the resource can use to query for other resources
+      # * *game_domain_name* (String): The game this file belongs to
+      # * *mod_id* (Integer): The mod id this file belongs to
       # * *ids* (Array<Integer>): The file's list of IDs
       # * *uid* (Integer): The file's UID
       # * *id* (Integer): The file's main ID
@@ -60,6 +67,9 @@ class NexusMods
       # * *changelog_html* (String): The file's change log in HTML
       # * *content_preview_url* (String): URL to a JSON that gives info on the file's content
       def initialize(
+        nexus_mods:,
+        game_domain_name:,
+        mod_id:,
         ids:,
         uid:,
         id:,
@@ -77,6 +87,9 @@ class NexusMods
         changelog_html:,
         content_preview_url:
       )
+        super(nexus_mods:)
+        @game_domain_name = game_domain_name
+        @mod_id = mod_id
         @ids = ids
         @uid = uid
         @id = id
@@ -105,6 +118,8 @@ class NexusMods
       # * Boolean: Are objects equal?
       def ==(other)
         other.is_a?(ModFile) &&
+          @game_domain_name == other.game_domain_name &&
+          @mod_id == other.mod_id &&
           @ids == other.ids &&
           @uid == other.uid &&
           @id == other.id &&
@@ -123,6 +138,14 @@ class NexusMods
           @content_preview_url == other.content_preview_url
       end
 
+      # Get associated mod information
+      #
+      # Result::
+      # * Mod: The corresponding mod
+      def mod
+        @nexus_mods.mod(game_domain_name:, mod_id:)
+      end
+
     end
 
   end

data/lib/nexus_mods/api/mod_updates.rb

@@ -1,12 +1,15 @@
+require 'nexus_mods/api/resource'
+
 class NexusMods
 
   module Api
 
     # A NexusMods mod updates.
-    class ModUpdates
+    class ModUpdates < Resource
 
       attr_reader(
         *%i[
+          game_domain_name
           mod_id
           latest_file_update
           latest_mod_activity
@@ -16,14 +19,20 @@ class NexusMods
       # Constructor
       #
       # Parameters::
+      # * *nexus_mods* (NexusMods): The NexusMods API instance that the resource can use to query for other resources
+      # * *game_domain_name* (String): The game this file belongs to
       # * *mod_id* (Integer): The mod's id
       # * *latest_file_update* (Time): The mod's latest file update
       # * *latest_mod_activity* (Time): The mod's latest activity
       def initialize(
+        nexus_mods:,
+        game_domain_name:,
         mod_id:,
         latest_file_update:,
         latest_mod_activity:
       )
+        super(nexus_mods:)
+        @game_domain_name = game_domain_name
         @mod_id = mod_id
         @latest_file_update = latest_file_update
         @latest_mod_activity = latest_mod_activity
@@ -37,11 +46,28 @@ class NexusMods
       # * Boolean: Are objects equal?
       def ==(other)
         other.is_a?(ModUpdates) &&
+          @game_domain_name == game_domain_name &&
           @mod_id == other.mod_id &&
           @latest_file_update == other.latest_file_update &&
           @latest_mod_activity == other.latest_mod_activity
       end
 
+      # Get associated mod information
+      #
+      # Result::
+      # * Mod: The corresponding mod
+      def mod
+        @nexus_mods.mod(game_domain_name:, mod_id:)
+      end
+
+      # Get associated mod files information
+      #
+      # Result::
+      # * Array<ModFile>: The corresponding mod files
+      def mod_files
+        @nexus_mods.mod_files(game_domain_name:, mod_id:)
+      end
+
     end
 
   end

data/lib/nexus_mods/api/resource.rb

@@ -0,0 +1,20 @@
+class NexusMods
+
+  module Api
+
+    # Base class for any API resource
+    class Resource
+
+      # Constructor
+      #
+      # Parameters::
+      # * *nexus_mods* (NexusMods): The NexusMods API instance that the resource can use to query for other resources
+      def initialize(nexus_mods:)
+        @nexus_mods = nexus_mods
+      end
+
+    end
+
+  end
+
+end

data/lib/nexus_mods/api/user.rb

@@ -1,10 +1,12 @@
+require 'nexus_mods/api/resource'
+
 class NexusMods
 
   module Api
 
     # A user on NExusMods.
     # Mainly used for uploaders information.
-    class User
+    class User < Resource
 
       attr_reader(
         *%i[
@@ -18,16 +20,19 @@ class NexusMods
       # Constructor
       #
       # Parameters::
+      # * *nexus_mods* (NexusMods): The NexusMods API instance that the resource can use to query for other resources
       # * *member_id* (Integer): The user's member id
       # * *member_group_id* (Integer): The user's member group id
       # * *name* (String): The user's name
       # * *profile_url* (String): The user's profile URL
       def initialize(
+        nexus_mods:,
         member_id:,
         member_group_id:,
         name:,
         profile_url:
       )
+        super(nexus_mods:)
         @member_id = member_id
         @member_group_id = member_group_id
         @name = name

data/lib/nexus_mods/version.rb

@@ -1,5 +1,5 @@
 class NexusMods
 
-  VERSION = '2.4.0'
+  VERSION = '2.5.0'
 
 end

data/lib/nexus_mods.rb

@@ -88,6 +88,7 @@ class NexusMods
   def api_limits
     api_limits_headers = @api_client.http('users/validate').headers
     Api::ApiLimits.new(
+      nexus_mods: self,
       daily_limit: Integer(api_limits_headers['x-rl-daily-limit']),
       daily_remaining: Integer(api_limits_headers['x-rl-daily-remaining']),
       daily_reset: Time.parse(api_limits_headers['x-rl-daily-reset']).utc,
@@ -113,6 +114,7 @@ class NexusMods
           category_id,
           [
             Api::Category.new(
+              nexus_mods: self,
               id: category_id,
               name: category_json['name']
             ),
@@ -125,6 +127,7 @@ class NexusMods
         category.parent_category = categories[parent_category_id]&.first if parent_category_id
       end
       Api::Game.new(
+        nexus_mods: self,
         id: game_json['id'],
         name: game_json['name'],
         forum_url: game_json['forum_url'],
@@ -175,6 +178,7 @@ class NexusMods
     mod_cache_up_to_date?(game_domain_name:, mod_id:) if check_updates
     mod_json = @api_client.api("games/#{game_domain_name}/mods/#{mod_id}", clear_cache:)
     Api::Mod.new(
+      nexus_mods: self,
       uid: mod_json['uid'],
       mod_id: mod_json['mod_id'],
       game_id: mod_json['game_id'],
@@ -189,6 +193,7 @@ class NexusMods
       status: mod_json['status'],
       available: mod_json['available'],
       uploader: Api::User.new(
+        nexus_mods: self,
         member_id: mod_json['user']['member_id'],
         member_group_id: mod_json['user']['member_group_id'],
         name: mod_json['user']['name'],
@@ -241,6 +246,9 @@ class NexusMods
     mod_files_cache_up_to_date?(game_domain_name:, mod_id:) if check_updates
     @api_client.api("games/#{game_domain_name}/mods/#{mod_id}/files", clear_cache:)['files'].map do |file_json|
       Api::ModFile.new(
+        nexus_mods: self,
+        game_domain_name:,
+        mod_id:,
         ids: file_json['id'],
         uid: file_json['uid'],
         id: file_json['file_id'],
@@ -298,6 +306,8 @@ class NexusMods
   def updated_mods(game_domain_name: @game_domain_name, since: :one_day, clear_cache: false)
     @api_client.api("games/#{game_domain_name}/mods/updated", parameters: period_to_url_params(since), clear_cache:).map do |updated_mod_json|
       Api::ModUpdates.new(
+        nexus_mods: self,
+        game_domain_name:,
         mod_id: updated_mod_json['mod_id'],
         latest_file_update: Time.at(updated_mod_json['latest_file_update']).utc,
         latest_mod_activity: Time.at(updated_mod_json['latest_mod_activity']).utc

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

@@ -60,6 +60,14 @@ describe NexusMods::Api::ModFile do
         expect_mod_files_to_be_example(nexus_mods.mod_files(game_domain_name: 'skyrimspecialedition'))
       end
 
+      it 'returns the mod associated to the mod file' do
+        expect_http_call_to(
+          path: '/v1/games/skyrimspecialedition/mods/2014.json',
+          json: json_complete_mod
+        )
+        expect_mod_to_be_complete(nexus_mods.mod_files(game_domain_name: 'skyrimspecialedition', mod_id: 2014).first.mod)
+      end
+
     end
 
     it 'compares objects for equality' do
@@ -83,6 +91,7 @@ describe NexusMods::Api::ModFile do
       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',
@@ -119,6 +128,7 @@ describe NexusMods::Api::ModFile do
         expect(mod_file.category).to eq category
         expect(mod_file.category_id).to eq category_id
       end
+
     end
 
     context 'when checking cache data freshness' do

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

@@ -63,6 +63,14 @@ describe NexusMods::Api::Mod do
         expect(mod1).to eq mod2
       end
 
+      it 'returns the mod files associated to the mod' do
+        expect_http_call_to(
+          path: '/v1/games/skyrimspecialedition/mods/2014/files.json',
+          json: { 'files' => [json_mod_file2472] }
+        )
+        expect_mod_file_to_be2472(nexus_mods.mod(game_domain_name: 'skyrimspecialedition', mod_id: 2014).files.first)
+      end
+
     end
 
     context 'when checking cache data freshness' do

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

@@ -78,6 +78,34 @@ describe NexusMods::Api::ModUpdates do
           expect(mod_updates1).to eq mod_updates2
         end
 
+        it 'returns the mod associated to the mod updates' do
+          expect_http_call_to(
+            path: "/v1/games/skyrimspecialedition/mods/updated.json?#{since_config[:expected_url_params]}",
+            json: [
+              json_mod_updates2014
+            ]
+          )
+          expect_http_call_to(
+            path: '/v1/games/skyrimspecialedition/mods/2014.json',
+            json: json_complete_mod
+          )
+          expect_mod_to_be_complete(nexus_mods.updated_mods(game_domain_name: 'skyrimspecialedition', since: since_config[:since]).first.mod)
+        end
+
+        it 'returns the mod files associated to the mod updates' do
+          expect_http_call_to(
+            path: "/v1/games/skyrimspecialedition/mods/updated.json?#{since_config[:expected_url_params]}",
+            json: [
+              json_mod_updates2014
+            ]
+          )
+          expect_http_call_to(
+            path: '/v1/games/skyrimspecialedition/mods/2014/files.json',
+            json: { 'files' => [json_mod_file2472] }
+          )
+          expect_mod_file_to_be2472(nexus_mods.updated_mods(game_domain_name: 'skyrimspecialedition', since: since_config[:since]).first.mod_files.first)
+        end
+
       end
 
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nexus_mods
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Muriel Salvan
@@ -138,6 +138,7 @@ files:
 - lib/nexus_mods/api/mod.rb
 - lib/nexus_mods/api/mod_file.rb
 - lib/nexus_mods/api/mod_updates.rb
+- lib/nexus_mods/api/resource.rb
 - lib/nexus_mods/api/user.rb
 - lib/nexus_mods/api_client.rb
 - lib/nexus_mods/cacheable_api.rb