nexus_mods 0.1.1 → 0.3.0

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

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

@@ -1,180 +0,0 @@
-describe NexusMods::Game do
-
-  context 'when testing games' do
-
-    it 'returns the games list' do
-      expect_validate_user
-      expect_http_call_to(
-        path: '/v1/games.json',
-        json: [
-          {
-            'id' => 100,
-            'name' => 'Morrowind',
-            'forum_url' => 'https://forums.nexusmods.com/index.php?/forum/111-morrowind/',
-            'nexusmods_url' => 'http://www.nexusmods.com/morrowind',
-            'genre' => 'RPG',
-            'file_count' => 14_143,
-            'downloads' => 20_414_985,
-            'domain_name' => 'morrowind',
-            'approved_date' => 1,
-            'file_views' => 100_014_750,
-            'authors' => 2062,
-            'file_endorsements' => 719_262,
-            'mods' => 6080,
-            'categories' => [
-              {
-                'category_id' => 1,
-                'name' => 'Morrowind',
-                'parent_category' => false
-              },
-              {
-                'category_id' => 2,
-                'name' => 'Buildings',
-                'parent_category' => 1
-              }
-            ]
-          },
-          {
-            'id' => 101,
-            'name' => 'Oblivion',
-            'forum_url' => 'https://forums.nexusmods.com/index.php?/forum/131-oblivion/',
-            'nexusmods_url' => 'http://www.nexusmods.com/oblivion',
-            'genre' => 'RPG',
-            'file_count' => 52_775,
-            'downloads' => 187_758_634,
-            'domain_name' => 'oblivion',
-            'approved_date' => 1,
-            'file_views' => 880_508_188,
-            'authors' => 10_673,
-            'file_endorsements' => 4_104_067,
-            'mods' => 29_220,
-            'categories' => [
-              {
-                'category_id' => 20,
-                'name' => 'Oblivion',
-                'parent_category' => false
-              },
-              {
-                'category_id' => 22,
-                'name' => 'New structures - Buildings',
-                'parent_category' => 20
-              }
-            ]
-          }
-        ]
-      )
-      games = nexus_mods.games.sort_by(&:id)
-      expect(games.size).to eq 2
-      first_game = games.first
-      expect(first_game.id).to eq 100
-      expect(first_game.name).to eq 'Morrowind'
-      expect(first_game.forum_url).to eq 'https://forums.nexusmods.com/index.php?/forum/111-morrowind/'
-      expect(first_game.nexusmods_url).to eq 'http://www.nexusmods.com/morrowind'
-      expect(first_game.genre).to eq 'RPG'
-      expect(first_game.files_count).to eq 14_143
-      expect(first_game.downloads_count).to eq 20_414_985
-      expect(first_game.domain_name).to eq 'morrowind'
-      expect(first_game.approved_date).to eq Time.parse('1970-01-01 00:00:01 +0000')
-      expect(first_game.files_views).to eq 100_014_750
-      expect(first_game.authors_count).to eq 2062
-      expect(first_game.files_endorsements).to eq 719_262
-      expect(first_game.mods_count).to eq 6080
-      first_game_categories = first_game.categories
-      expect(first_game_categories.size).to eq 2
-      expect(first_game_categories.first.id).to eq 1
-      expect(first_game_categories.first.name).to eq 'Morrowind'
-      expect(first_game_categories.first.parent_category).to be_nil
-      expect(first_game_categories[1].id).to eq 2
-      expect(first_game_categories[1].name).to eq 'Buildings'
-      expect(first_game_categories[1].parent_category).not_to be_nil
-      expect(first_game_categories[1].parent_category.id).to eq 1
-      expect(first_game_categories[1].parent_category.name).to eq 'Morrowind'
-      expect(first_game_categories[1].parent_category.parent_category).to be_nil
-      second_game = games[1]
-      expect(second_game.id).to eq 101
-      expect(second_game.name).to eq 'Oblivion'
-      expect(second_game.forum_url).to eq 'https://forums.nexusmods.com/index.php?/forum/131-oblivion/'
-      expect(second_game.nexusmods_url).to eq 'http://www.nexusmods.com/oblivion'
-      expect(second_game.genre).to eq 'RPG'
-      expect(second_game.files_count).to eq 52_775
-      expect(second_game.downloads_count).to eq 187_758_634
-      expect(second_game.domain_name).to eq 'oblivion'
-      expect(second_game.approved_date).to eq Time.parse('1970-01-01 00:00:01 +0000')
-      expect(second_game.files_views).to eq 880_508_188
-      expect(second_game.authors_count).to eq 10_673
-      expect(second_game.files_endorsements).to eq 4_104_067
-      expect(second_game.mods_count).to eq 29_220
-      second_game_categories = second_game.categories
-      expect(second_game_categories.size).to eq 2
-      expect(second_game_categories.first.id).to eq 20
-      expect(second_game_categories.first.name).to eq 'Oblivion'
-      expect(second_game_categories.first.parent_category).to be_nil
-      expect(second_game_categories[1].id).to eq 22
-      expect(second_game_categories[1].name).to eq 'New structures - Buildings'
-      expect(second_game_categories[1].parent_category).not_to be_nil
-      expect(second_game_categories[1].parent_category.id).to eq 20
-      expect(second_game_categories[1].parent_category.name).to eq 'Oblivion'
-      expect(second_game_categories[1].parent_category.parent_category).to be_nil
-    end
-
-    it 'returns a game having missing parent category' do
-      expect_validate_user
-      expect_http_call_to(
-        path: '/v1/games.json',
-        json: [
-          {
-            'id' => 100,
-            'name' => 'Morrowind',
-            'forum_url' => 'https://forums.nexusmods.com/index.php?/forum/111-morrowind/',
-            'nexusmods_url' => 'http://www.nexusmods.com/morrowind',
-            'genre' => 'RPG',
-            'file_count' => 14_143,
-            'downloads' => 20_414_985,
-            'domain_name' => 'morrowind',
-            'approved_date' => 1,
-            'file_views' => 100_014_750,
-            'authors' => 2062,
-            'file_endorsements' => 719_262,
-            'mods' => 6080,
-            'categories' => [
-              {
-                'category_id' => 1,
-                'name' => 'Morrowind',
-                'parent_category' => false
-              },
-              {
-                'category_id' => 2,
-                'name' => 'Buildings',
-                'parent_category' => 3
-              }
-            ]
-          }
-        ]
-      )
-      game = nexus_mods.games.first
-      expect(game.id).to eq 100
-      expect(game.name).to eq 'Morrowind'
-      expect(game.forum_url).to eq 'https://forums.nexusmods.com/index.php?/forum/111-morrowind/'
-      expect(game.nexusmods_url).to eq 'http://www.nexusmods.com/morrowind'
-      expect(game.genre).to eq 'RPG'
-      expect(game.files_count).to eq 14_143
-      expect(game.downloads_count).to eq 20_414_985
-      expect(game.domain_name).to eq 'morrowind'
-      expect(game.approved_date).to eq Time.parse('1970-01-01 00:00:01 +0000')
-      expect(game.files_views).to eq 100_014_750
-      expect(game.authors_count).to eq 2062
-      expect(game.files_endorsements).to eq 719_262
-      expect(game.mods_count).to eq 6080
-      game_categories = game.categories
-      expect(game_categories.size).to eq 2
-      expect(game_categories.first.id).to eq 1
-      expect(game_categories.first.name).to eq 'Morrowind'
-      expect(game_categories.first.parent_category).to be_nil
-      expect(game_categories[1].id).to eq 2
-      expect(game_categories[1].name).to eq 'Buildings'
-      expect(game_categories[1].parent_category).to be_nil
-    end
-
-  end
-
-end

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

@@ -1,140 +0,0 @@
-describe NexusMods::ModFile do
-
-  context 'when testing mod files' do
-
-    # Example of JSON object returned by the API for a mod files list
-    let(:json_example_mod_files) do
-      [
-        {
-          'id' => [
-            2472,
-            1704
-          ],
-          'uid' => 7_318_624_274_856,
-          'file_id' => 2472,
-          'name' => 'ApachiiSkyHair_v_1_6_Full',
-          'version' => '1.6.Full',
-          'category_id' => 4,
-          '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'
-        },
-        {
-          'id' => [
-            2487,
-            1705
-          ],
-          'uid' => 7_318_624_274_857,
-          'file_id' => 2487,
-          'name' => 'ApachiiSkyHairMale_v_1_2',
-          'version' => '1.2',
-          'category_id' => 4,
-          'category_name' => 'OLD_VERSION',
-          'is_primary' => false,
-          'file_name' => 'ApachiiSkyHairMale_v_1_2-2014-1-2.7z',
-          'uploaded_timestamp' => 1_477_968_373,
-          'uploaded_time' => '2016-11-01T02:46:13.000+00:00',
-          'mod_version' => '1.2',
-          'external_virus_scan_url' => 'https://www.virustotal.com/file/3e86106233499ac43383c32ce4a2d8e162dc6e940b4d228f649a701b71ee5676/analysis/1477979366/',
-          'description' => 'NOT optimezed meshes. Standalone 55 Male hairs -  Not included in ApachiiSkyHair v_1_6_Full ',
-          'size' => 204_347,
-          'size_kb' => 204_347,
-          'size_in_bytes' => 209_251_227,
-          'changelog_html' => nil,
-          'content_preview_link' => 'https://file-metadata.nexusmods.com/file/nexus-files-meta/1704/2014/ApachiiSkyHairMale_v_1_2-2014-1-2.7z.json'
-        }
-      ]
-    end
-
-    # Expect a mod's files to be the example ones
-    #
-    # Parameters::
-    # * *mod_files* (Array<NexusMods::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)
-      first_mod_file = sorted_mod_files.first
-      expect(first_mod_file.ids).to eq [2472, 1704]
-      expect(first_mod_file.uid).to eq 7_318_624_274_856
-      expect(first_mod_file.id).to eq 2472
-      expect(first_mod_file.name).to eq 'ApachiiSkyHair_v_1_6_Full'
-      expect(first_mod_file.version).to eq '1.6.Full'
-      expect(first_mod_file.category_id).to eq :old
-      expect(first_mod_file.category_name).to eq 'OLD_VERSION'
-      expect(first_mod_file.is_primary).to be false
-      expect(first_mod_file.size).to eq 309_251_227
-      expect(first_mod_file.file_name).to eq 'ApachiiSkyHair_v_1_6_Full-2014-1-6-Full.7z'
-      expect(first_mod_file.uploaded_time).to eq Time.parse('2016-11-01T02:34:05.000+00:00')
-      expect(first_mod_file.mod_version).to eq '1.6.Full'
-      expect(first_mod_file.external_virus_scan_url).to eq 'https://www.virustotal.com/file/3dcc96dce0b846ea643d626c48bd6ad08752da8232f3d29be644d36e1fd627cf/analysis/1477978674/'
-      expect(first_mod_file.description).to eq '[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]  '
-      expect(first_mod_file.changelog_html).to be_nil
-      expect(first_mod_file.content_preview_url).to eq 'https://file-metadata.nexusmods.com/file/nexus-files-meta/1704/2014/ApachiiSkyHair_v_1_6_Full-2014-1-6-Full.7z.json'
-      second_mod_file = sorted_mod_files[1]
-      expect(second_mod_file.ids).to eq [2487, 1705]
-      expect(second_mod_file.uid).to eq 7_318_624_274_857
-      expect(second_mod_file.id).to eq 2487
-      expect(second_mod_file.name).to eq 'ApachiiSkyHairMale_v_1_2'
-      expect(second_mod_file.version).to eq '1.2'
-      expect(second_mod_file.category_id).to eq :old
-      expect(second_mod_file.category_name).to eq 'OLD_VERSION'
-      expect(second_mod_file.is_primary).to be false
-      expect(second_mod_file.size).to eq 209_251_227
-      expect(second_mod_file.file_name).to eq 'ApachiiSkyHairMale_v_1_2-2014-1-2.7z'
-      expect(second_mod_file.uploaded_time).to eq Time.parse('2016-11-01T02:46:13.000+00:00')
-      expect(second_mod_file.mod_version).to eq '1.2'
-      expect(second_mod_file.external_virus_scan_url).to eq 'https://www.virustotal.com/file/3e86106233499ac43383c32ce4a2d8e162dc6e940b4d228f649a701b71ee5676/analysis/1477979366/'
-      expect(second_mod_file.description).to eq 'NOT optimezed meshes. Standalone 55 Male hairs -  Not included in ApachiiSkyHair v_1_6_Full '
-      expect(second_mod_file.changelog_html).to be_nil
-      expect(second_mod_file.content_preview_url).to eq 'https://file-metadata.nexusmods.com/file/nexus-files-meta/1704/2014/ApachiiSkyHairMale_v_1_2-2014-1-2.7z.json'
-    end
-
-    it 'returns a mod files list' do
-      expect_validate_user
-      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_validate_user
-      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_validate_user
-      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_validate_user
-      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
-
-  end
-
-end