nexus_mods 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c443ff1432283f58fd5928a67607934721bd733dd07dc5297451c990cf72ae7f
-  data.tar.gz: 1f29640cabaa7e862a119cb9116d1f15049af67d7eaaa51d1707e8aa99c2cdd6
+  metadata.gz: efdb25aee2a65f563017933ab77b1360d3ab04d26abf3f945cd9c1cf3d0a1a0d
+  data.tar.gz: dc538a350901669fbca2e6cbc299daf091bcf0779f82c3e9b718398b5f61e877
 SHA512:
-  metadata.gz: 6d94ec311b0e8174052e6c7c352e868928d243c7206ffb97206e7ddf273fbb7e417b29acbc02bc0ec72b7ce1d8bc8d2622a398b8e054423f5669d5700b0a063d
-  data.tar.gz: 8ed74a2422c6e1109a90859bd5a66b5c440ce9cab86f17aaa2d52821bd1715040aab4031f9a4b879031fae7c03b449515ecdb1ea35683f293ee867252426ded7
+  metadata.gz: 6e2f2ee9025ab0650fc96ad4d10ff41e8375caa8c6ab51e64ceec5527630e97806bfdbce74d2db2ba63bc58a45371392c98d4fb20ccbd7399b2711123fce125f
+  data.tar.gz: a6519240cb31bc1cf25a5f0b7001be67e91b41588817739f50a8c8b4d1558a2129ecb43ba6239454717fe47d6aea47f152eeb08c374bce18c83fe84003a378fd

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# [v0.2.0](https://github.com/Muriel-Salvan/nexus_mods/compare/v0.1.1...v0.2.0) (2023-04-10 08:45:44)
+
+### Features
+
+* [[Feature] Make objects API comparable correctly](https://github.com/Muriel-Salvan/nexus_mods/commit/ff219c7050aa8421095c666fe2394c621f317e43)
+
 # [v0.1.1](https://github.com/Muriel-Salvan/nexus_mods/compare/v0.1.0...v0.1.1) (2023-03-27 19:57:47)
 
 ### Patches

data/lib/nexus_mods/api/api_limits.rb

@@ -0,0 +1,64 @@
+class NexusMods
+
+  module Api
+
+    # 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
+
+      # Equality operator
+      #
+      # Parameters::
+      # * *other* (Object): Other object to compare with
+      # Result::
+      # * Boolean: Are objects equal?
+      def ==(other)
+        other.is_a?(ApiLimits) &&
+          @daily_limit == other.daily_limit &&
+          @daily_remaining == other.daily_remaining &&
+          @daily_reset == other.daily_reset &&
+          @hourly_limit == other.hourly_limit &&
+          @hourly_remaining == other.hourly_remaining &&
+          @hourly_reset == other.hourly_reset
+      end
+
+    end
+
+  end
+
+end

data/lib/nexus_mods/api/category.rb

@@ -0,0 +1,54 @@
+class NexusMods
+
+  module Api
+
+    # 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
+
+      # Equality operator
+      #
+      # Parameters::
+      # * *other* (Object): Other object to compare with
+      # Result::
+      # * Boolean: Are objects equal?
+      def ==(other)
+        other.is_a?(Category) &&
+          @id == other.id &&
+          @name == other.name &&
+          @parent_category == other.parent_category
+      end
+
+    end
+
+  end
+
+end

data/lib/nexus_mods/api/game.rb

@@ -0,0 +1,106 @@
+class NexusMods
+
+  module Api
+
+    # 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
+
+      # Equality operator
+      #
+      # Parameters::
+      # * *other* (Object): Other object to compare with
+      # Result::
+      # * Boolean: Are objects equal?
+      def ==(other)
+        other.is_a?(Game) &&
+          @id == other.id &&
+          @name == other.name &&
+          @forum_url == other.forum_url &&
+          @nexusmods_url == other.nexusmods_url &&
+          @genre == other.genre &&
+          @domain_name == other.domain_name &&
+          @approved_date == other.approved_date &&
+          @files_count == other.files_count &&
+          @files_views == other.files_views &&
+          @files_endorsements == other.files_endorsements &&
+          @downloads_count == other.downloads_count &&
+          @authors_count == other.authors_count &&
+          @mods_count == other.mods_count &&
+          @categories == other.categories
+      end
+
+    end
+
+  end
+
+end

data/lib/nexus_mods/api/mod.rb

@@ -0,0 +1,141 @@
+class NexusMods
+
+  module Api
+
+    # 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
+
+      # Equality operator
+      #
+      # Parameters::
+      # * *other* (Object): Other object to compare with
+      # Result::
+      # * Boolean: Are objects equal?
+      def ==(other)
+        other.is_a?(Mod) &&
+          @uid == other.uid &&
+          @mod_id == other.mod_id &&
+          @game_id == other.game_id &&
+          @allow_rating == other.allow_rating &&
+          @domain_name == other.domain_name &&
+          @category_id == other.category_id &&
+          @version == other.version &&
+          @created_time == other.created_time &&
+          @updated_time == other.updated_time &&
+          @author == other.author &&
+          @contains_adult_content == other.contains_adult_content &&
+          @status == other.status &&
+          @available == other.available &&
+          @uploader == other.uploader &&
+          @name == other.name &&
+          @summary == other.summary &&
+          @description == other.description &&
+          @picture_url == other.picture_url &&
+          @downloads_count == other.downloads_count &&
+          @unique_downloads_count == other.unique_downloads_count &&
+          @endorsements_count == other.endorsements_count
+      end
+
+    end
+
+  end
+
+end

data/lib/nexus_mods/api/mod_file.rb

@@ -0,0 +1,116 @@
+class NexusMods
+
+  module Api
+
+    # 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
+
+      # Equality operator
+      #
+      # Parameters::
+      # * *other* (Object): Other object to compare with
+      # Result::
+      # * Boolean: Are objects equal?
+      def ==(other)
+        other.is_a?(ModFile) &&
+          @ids == other.ids &&
+          @uid == other.uid &&
+          @id == other.id &&
+          @name == other.name &&
+          @version == other.version &&
+          @category_id == other.category_id &&
+          @category_name == other.category_name &&
+          @is_primary == other.is_primary &&
+          @size == other.size &&
+          @file_name == other.file_name &&
+          @uploaded_time == other.uploaded_time &&
+          @mod_version == other.mod_version &&
+          @external_virus_scan_url == other.external_virus_scan_url &&
+          @description == other.description &&
+          @changelog_html == other.changelog_html &&
+          @content_preview_url == other.content_preview_url
+      end
+
+    end
+
+  end
+
+end

data/lib/nexus_mods/api/user.rb

@@ -0,0 +1,55 @@
+class NexusMods
+
+  module Api
+
+    # 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
+
+      # Equality operator
+      #
+      # Parameters::
+      # * *other* (Object): Other object to compare with
+      # Result::
+      # * Boolean: Are objects equal?
+      def ==(other)
+        other.is_a?(User) &&
+          @member_id == other.member_id &&
+          @member_group_id == other.member_group_id &&
+          @name == other.name &&
+          @profile_url == other.profile_url
+      end
+
+    end
+
+  end
+
+end

data/lib/nexus_mods/version.rb

@@ -1,5 +1,5 @@
 class NexusMods
 
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 
 end

data/lib/nexus_mods.rb

@@ -3,12 +3,12 @@ require 'json'
 require 'time'
 require 'tmpdir'
 require 'faraday'
-require 'nexus_mods/api_limits'
-require 'nexus_mods/category'
-require 'nexus_mods/game'
-require 'nexus_mods/user'
-require 'nexus_mods/mod'
-require 'nexus_mods/mod_file'
+require 'nexus_mods/api/api_limits'
+require 'nexus_mods/api/category'
+require 'nexus_mods/api/game'
+require 'nexus_mods/api/user'
+require 'nexus_mods/api/mod'
+require 'nexus_mods/api/mod_file'
 
 # Ruby API to access NexusMods REST API
 class NexusMods
@@ -75,7 +75,7 @@ class NexusMods
   # * ApiLimits: API calls limits
   def api_limits
     api_limits_headers = http('users/validate').headers
-    ApiLimits.new(
+    Api::ApiLimits.new(
       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,
@@ -98,7 +98,7 @@ class NexusMods
         [
           category_id,
           [
-            Category.new(
+            Api::Category.new(
               id: category_id,
               name: category_json['name']
             ),
@@ -110,7 +110,7 @@ class NexusMods
         # Ignore missing parent categories: this situation happens.
         category.parent_category = categories[parent_category_id]&.first if parent_category_id
       end
-      Game.new(
+      Api::Game.new(
         id: game_json['id'],
         name: game_json['name'],
         forum_url: game_json['forum_url'],
@@ -138,7 +138,7 @@ class NexusMods
   # * Mod: Mod information
   def mod(game_domain_name: @game_domain_name, mod_id: @mod_id)
     mod_json = api "games/#{game_domain_name}/mods/#{mod_id}"
-    Mod.new(
+    Api::Mod.new(
       uid: mod_json['uid'],
       mod_id: mod_json['mod_id'],
       game_id: mod_json['game_id'],
@@ -152,7 +152,7 @@ class NexusMods
       contains_adult_content: mod_json['contains_adult_content'],
       status: mod_json['status'],
       available: mod_json['available'],
-      uploader: User.new(
+      uploader: Api::User.new(
         member_id: mod_json['user']['member_id'],
         member_group_id: mod_json['user']['member_group_id'],
         name: mod_json['user']['name'],
@@ -189,7 +189,7 @@ class NexusMods
       category_id = FILE_CATEGORIES[file_json['category_id']]
       raise "Unknown file category: #{file_json['category_id']}" if category_id.nil?
 
-      ModFile.new(
+      Api::ModFile.new(
         ids: file_json['id'],
         uid: file_json['uid'],
         id: file_json['file_id'],