nexus_mods 0.1.0 → 0.2.0

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

@@ -0,0 +1,73 @@
+describe NexusMods::Api::ModFile do
+
+  context 'when testing mod files' do
+
+    before do
+      expect_validate_user
+    end
+
+    # Example of JSON object returned by the API for a mod files list
+    let(:json_example_mod_files) do
+      [
+        json_mod_file2472,
+        json_mod_file2487
+      ]
+    end
+
+    # Expect a mod's files to be the example ones
+    #
+    # Parameters::
+    # * *mod_files* (Array<NexusMods::Api::File>): List of files to validate
+    def expect_mod_files_to_be_example(mod_files)
+      expect(mod_files.size).to eq 2
+      sorted_mod_files = mod_files.sort_by(&:id)
+      expect_mod_file_to_be2472(sorted_mod_files.first)
+      expect_mod_file_to_be2487(sorted_mod_files[1])
+    end
+
+    it 'returns a mod files list' do
+      expect_http_call_to(
+        path: '/v1/games/skyrimspecialedition/mods/2014/files.json',
+        json: { files: json_example_mod_files }
+      )
+      expect_mod_files_to_be_example(nexus_mods.mod_files(game_domain_name: 'skyrimspecialedition', mod_id: 2014))
+    end
+
+    it 'returns the default mod files list' do
+      expect_http_call_to(
+        path: '/v1/games/skyrimspecialedition/mods/2014/files.json',
+        json: { files: json_example_mod_files }
+      )
+      expect_mod_files_to_be_example(nexus_mods(mod_id: 2014).mod_files(game_domain_name: 'skyrimspecialedition'))
+    end
+
+    it 'returns mod files list for the default game' do
+      expect_http_call_to(
+        path: '/v1/games/skyrimspecialedition/mods/2014/files.json',
+        json: { files: json_example_mod_files }
+      )
+      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 and mod' do
+      expect_http_call_to(
+        path: '/v1/games/skyrimspecialedition/mods/2014/files.json',
+        json: { files: json_example_mod_files }
+      )
+      expect_mod_files_to_be_example(nexus_mods(game_domain_name: 'skyrimspecialedition', mod_id: 2014).mod_files)
+    end
+
+    it 'compares objects for equality' do
+      expect_http_call_to(
+        path: '/v1/games/skyrimspecialedition/mods/2014/files.json',
+        json: { files: [json_mod_file2472] }
+      )
+      mod_file1 = nexus_mods(game_domain_name: 'skyrimspecialedition', mod_id: 2014).mod_files.first
+      mod_file2 = nexus_mods(game_domain_name: 'skyrimspecialedition', mod_id: 2014).mod_files.first
+      expect(mod_file1.object_id).not_to eq mod_file2.object_id
+      expect(mod_file1).to eq mod_file2
+    end
+
+  end
+
+end

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

@@ -0,0 +1,62 @@
+describe NexusMods::Api::Mod do
+
+  context 'when testing mods' do
+
+    before do
+      expect_validate_user
+    end
+
+    it 'returns a mod complete information' do
+      expect_http_call_to(
+        path: '/v1/games/skyrimspecialedition/mods/2014.json',
+        json: json_complete_mod
+      )
+      expect_mod_to_be_complete(nexus_mods.mod(game_domain_name: 'skyrimspecialedition', mod_id: 2014))
+    end
+
+    it 'returns a mod partial information' do
+      expect_http_call_to(
+        path: '/v1/games/skyrimspecialedition/mods/2014.json',
+        json: json_partial_mod
+      )
+      expect_mod_to_be_partial(nexus_mods.mod(game_domain_name: 'skyrimspecialedition', mod_id: 2014))
+    end
+
+    it 'returns the default mod information' do
+      expect_http_call_to(
+        path: '/v1/games/skyrimspecialedition/mods/2014.json',
+        json: json_complete_mod
+      )
+      expect_mod_to_be_complete(nexus_mods(mod_id: 2014).mod(game_domain_name: 'skyrimspecialedition'))
+    end
+
+    it 'returns mod information for the default game' do
+      expect_http_call_to(
+        path: '/v1/games/skyrimspecialedition/mods/2014.json',
+        json: json_complete_mod
+      )
+      expect_mod_to_be_complete(nexus_mods(game_domain_name: 'skyrimspecialedition').mod(mod_id: 2014))
+    end
+
+    it 'returns mod information for the default game and mod' do
+      expect_http_call_to(
+        path: '/v1/games/skyrimspecialedition/mods/2014.json',
+        json: json_complete_mod
+      )
+      expect_mod_to_be_complete(nexus_mods(game_domain_name: 'skyrimspecialedition', mod_id: 2014).mod)
+    end
+
+    it 'compares objects for equality' do
+      expect_http_call_to(
+        path: '/v1/games/skyrimspecialedition/mods/2014.json',
+        json: json_complete_mod
+      )
+      mod1 = nexus_mods.mod(game_domain_name: 'skyrimspecialedition', mod_id: 2014)
+      mod2 = nexus_mods.mod(game_domain_name: 'skyrimspecialedition', mod_id: 2014)
+      expect(mod1.object_id).not_to eq mod2.object_id
+      expect(mod1).to eq mod2
+    end
+
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nexus_mods
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Muriel Salvan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-26 00:00:00.000000000 Z
+date: 2023-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -122,18 +122,21 @@ files:
 - LICENSE.md
 - README.md
 - lib/nexus_mods.rb
-- lib/nexus_mods/api_limits.rb
-- lib/nexus_mods/category.rb
-- lib/nexus_mods/game.rb
-- lib/nexus_mods/mod.rb
-- lib/nexus_mods/mod_file.rb
-- lib/nexus_mods/user.rb
+- lib/nexus_mods/api/api_limits.rb
+- lib/nexus_mods/api/category.rb
+- lib/nexus_mods/api/game.rb
+- lib/nexus_mods/api/mod.rb
+- lib/nexus_mods/api/mod_file.rb
+- lib/nexus_mods/api/user.rb
 - lib/nexus_mods/version.rb
+- spec/nexus_mods_test/factories/games.rb
+- spec/nexus_mods_test/factories/mod_files.rb
+- spec/nexus_mods_test/factories/mods.rb
 - spec/nexus_mods_test/helpers.rb
-- spec/nexus_mods_test/scenarios/nexus_mods/api_limits_spec.rb
-- spec/nexus_mods_test/scenarios/nexus_mods/game_spec.rb
-- spec/nexus_mods_test/scenarios/nexus_mods/mod_file_spec.rb
-- spec/nexus_mods_test/scenarios/nexus_mods/mod_spec.rb
+- spec/nexus_mods_test/scenarios/nexus_mods/api/api_limits_spec.rb
+- 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/rubocop_spec.rb
 - spec/spec_helper.rb
@@ -158,7 +161,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
 summary: Access NexusMods REST API from Ruby

data/lib/nexus_mods/api_limits.rb

@@ -1,44 +0,0 @@
-class NexusMods
-
-  # Object giving the NexusMods API limits
-  class ApiLimits
-
-    attr_reader(
-      *%i[
-        daily_limit
-        daily_remaining
-        daily_reset
-        hourly_limit
-        hourly_remaining
-        hourly_reset
-      ]
-    )
-
-    # Constructor
-    #
-    # Parameters::
-    # * *daily_limit* (Integer): The daily limit
-    # * *daily_remaining* (Integer): The daily remaining
-    # * *daily_reset* (Integer): The daily reset time
-    # * *hourly_limit* (Integer): The hourly limit
-    # * *hourly_remaining* (Integer): The hourly remaining
-    # * *hourly_reset* (Integer): The hourly reset time
-    def initialize(
-      daily_limit:,
-      daily_remaining:,
-      daily_reset:,
-      hourly_limit:,
-      hourly_remaining:,
-      hourly_reset:
-    )
-      @daily_limit = daily_limit
-      @daily_remaining = daily_remaining
-      @daily_reset = daily_reset
-      @hourly_limit = hourly_limit
-      @hourly_remaining = hourly_remaining
-      @hourly_reset = hourly_reset
-    end
-
-  end
-
-end

data/lib/nexus_mods/category.rb

@@ -1,37 +0,0 @@
-class NexusMods
-
-  # Categories defined for a game in NexusMods
-  class Category
-
-    attr_reader(
-      *%i[
-        id
-        name
-      ]
-    )
-
-    attr_accessor(
-      *%i[
-        parent_category
-      ]
-    )
-
-    # Constructor
-    #
-    # Parameters::
-    # *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(
-      id:,
-      name:,
-      parent_category: nil
-    )
-      @id = id
-      @name = name
-      @parent_category = parent_category
-    end
-
-  end
-
-end

data/lib/nexus_mods/game.rb

@@ -1,78 +0,0 @@
-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
-
-    attr_reader(
-      *%i[
-        id
-        name
-        forum_url
-        nexusmods_url
-        genre
-        domain_name
-        approved_date
-        files_count
-        files_views
-        files_endorsements
-        downloads_count
-        authors_count
-        mods_count
-        categories
-      ]
-    )
-
-    # Constructor
-    #
-    # Parameters::
-    # * *id* (Integer): The game's id
-    # * *name* (String): The game's name
-    # * *forum_url* (String): The game's forum's URL
-    # * *nexusmods_url* (String): The game's NexusMods' URL
-    # * *genre* (String): The game's genre
-    # * *domain_name* (String): The game's domain's name
-    # * *approved_date* (Time): The game's approved date (time when the game was added)
-    # * *files_count* (Integer): The game's files' count [default: 0]
-    # * *files_views* (Integer): The game's files' views [default: 0]
-    # * *files_endorsements* (Integer): The game's files' endorsements [default: 0]
-    # * *downloads_count* (Integer): The game's downloads' count [default: 0]
-    # * *authors_count* (Integer): The game's authors's count [default: 0]
-    # * *mods_count* (Integer): The game's mods' count [default: 0]
-    # * *categories* (Array<Category>): The list of game's categories [default: []]
-    def initialize(
-      id:,
-      name:,
-      forum_url:,
-      nexusmods_url:,
-      genre:,
-      domain_name:,
-      approved_date:,
-      files_count: 0,
-      files_views: 0,
-      files_endorsements: 0,
-      downloads_count: 0,
-      authors_count: 0,
-      mods_count: 0,
-      categories: []
-    )
-      @id = id
-      @name = name
-      @forum_url = forum_url
-      @nexusmods_url = nexusmods_url
-      @genre = genre
-      @domain_name = domain_name
-      @approved_date = approved_date
-      @files_count = files_count
-      @files_views = files_views
-      @files_endorsements = files_endorsements
-      @downloads_count = downloads_count
-      @authors_count = authors_count
-      @mods_count = mods_count
-      @categories = categories
-    end
-
-  end
-
-end

data/lib/nexus_mods/mod.rb

@@ -1,106 +0,0 @@
-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
-
-    attr_reader(
-      *%i[
-        uid
-        mod_id
-        game_id
-        allow_rating
-        domain_name
-        category_id
-        version
-        created_time
-        updated_time
-        author
-        contains_adult_content
-        status
-        available
-        uploader
-        name
-        summary
-        description
-        picture_url
-        downloads_count
-        unique_downloads_count
-        endorsements_count
-      ]
-    )
-
-    # Constructor
-    #
-    # Parameters::
-    # * *uid* (Integer): The mod's uid
-    # * *mod_id* (Integer): The mod's id
-    # * *game_id* (Integer): The mod's game id
-    # * *allow_rating* (Boolean): Does this mod allow endorsements?
-    # * *domain_name* (String): The mod's domain name
-    # * *category_id* (String): The mod's category id
-    # * *version* (String): The mod's version
-    # * *created_time* (Time): The mod's creation time
-    # * *updated_time* (Time): The mod's update time
-    # * *author* (String): The mod's author
-    # * *contains_adult_content* (Boolean): Does this mod contain adult content?
-    # * *status* (String): The mod's status
-    # * *available* (Boolean): Is the mod publicly available?
-    # * *uploader* (User): The mod's uploader information
-    # * *name* (String or nil): The mod's name, or nil if under moderation [default: nil]
-    # * *summary* (String or nil): The mod's summary, or nil if none [default: nil]
-    # * *description* (String or nil): The mod's description, or nil if none [default: nil]
-    # * *picture_url* (String): The mod's picture_url [default: nil]
-    # * *downloads_count* (Integer): The mod's downloads' count [default: 0]
-    # * *unique_downloads_count* (Integer): The mod's unique downloads' count [default: 0]
-    # * *endorsements_count* (Integer): The mod's endorsements' count [default: 0]
-    def initialize(
-      uid:,
-      mod_id:,
-      game_id:,
-      allow_rating:,
-      domain_name:,
-      category_id:,
-      version:,
-      created_time:,
-      updated_time:,
-      author:,
-      contains_adult_content:,
-      status:,
-      available:,
-      uploader:,
-      name: nil,
-      summary: nil,
-      description: nil,
-      picture_url: nil,
-      downloads_count: 0,
-      unique_downloads_count: 0,
-      endorsements_count: 0
-    )
-      @uid = uid
-      @mod_id = mod_id
-      @game_id = game_id
-      @allow_rating = allow_rating
-      @domain_name = domain_name
-      @category_id = category_id
-      @version = version
-      @created_time = created_time
-      @updated_time = updated_time
-      @author = author
-      @contains_adult_content = contains_adult_content
-      @status = status
-      @available = available
-      @uploader = uploader
-      @name = name
-      @summary = summary
-      @description = description
-      @picture_url = picture_url
-      @downloads_count = downloads_count
-      @unique_downloads_count = unique_downloads_count
-      @endorsements_count = endorsements_count
-    end
-
-  end
-
-end

data/lib/nexus_mods/mod_file.rb

@@ -1,86 +0,0 @@
-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
-
-    attr_reader(
-      *%i[
-        ids
-        uid
-        id
-        name
-        version
-        category_id
-        category_name
-        is_primary
-        size
-        file_name
-        uploaded_time
-        mod_version
-        external_virus_scan_url
-        description
-        changelog_html
-        content_preview_url
-      ]
-    )
-
-    # Constructor
-    #
-    # Parameters::
-    # * *ids* (Array<Integer>): The file's list of IDs
-    # * *uid* (Integer): The file's UID
-    # * *id* (Integer): The file's main ID
-    # * *name* (String): The file's name
-    # * *version* (String): The file's version
-    # * *category_id* (Symbol): The file's category's ID
-    # * *category_name* (String): The file's category_name
-    # * *is_primary* (String): Is this file the primary download one?
-    # * *size* (Integer): The file's size (in bytes)
-    # * *file_name* (String): The file's exact file name
-    # * *uploaded_time* (Time): The file's uploaded time
-    # * *mod_version* (String): The file's mod version
-    # * *external_virus_scan_url* (String): The URL of virus scan for this file
-    # * *description* (String): The file's description
-    # * *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(
-      ids:,
-      uid:,
-      id:,
-      name:,
-      version:,
-      category_id:,
-      category_name:,
-      is_primary:,
-      size:,
-      file_name:,
-      uploaded_time:,
-      mod_version:,
-      external_virus_scan_url:,
-      description:,
-      changelog_html:,
-      content_preview_url:
-    )
-      @ids = ids
-      @uid = uid
-      @id = id
-      @name = name
-      @version = version
-      @category_id = category_id
-      @category_name = category_name
-      @is_primary = is_primary
-      @size = size
-      @file_name = file_name
-      @uploaded_time = uploaded_time
-      @mod_version = mod_version
-      @external_virus_scan_url = external_virus_scan_url
-      @description = description
-      @changelog_html = changelog_html
-      @content_preview_url = content_preview_url
-    end
-
-  end
-
-end

data/lib/nexus_mods/user.rb

@@ -1,37 +0,0 @@
-class NexusMods
-
-  # A user on NExusMods.
-  # Mainly used for uploaders information.
-  class User
-
-    attr_reader(
-      *%i[
-        member_id
-        member_group_id
-        name
-        profile_url
-      ]
-    )
-
-    # Constructor
-    #
-    # Parameters::
-    # * *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(
-      member_id:,
-      member_group_id:,
-      name:,
-      profile_url:
-    )
-      @member_id = member_id
-      @member_group_id = member_group_id
-      @name = name
-      @profile_url = profile_url
-    end
-
-  end
-
-end