nexus_mods 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '09e5130895c6c436fd54ba6847b7c3cfd1e48183b03959c76797b1a469fd1685'
+  data.tar.gz: 747d004d98a01b1dc004e36fcf513524dd64ce0dc71b5b5bb62d536e113e5cce
+SHA512:
+  metadata.gz: c6d6cbc5d12223741f2d6a703796fffed51db61cfa1dd94fdfb71ed68cbdce12881441d3d4dae7fee7bd85f2ccc408c45b6d427d41862814f2cbab78d49e2daf
+  data.tar.gz: 707070691462d95c4245714cd92d959beecb86eee5ff87355a456efbed6b3a4100f06df1ee5eb0a48d83a3178abef76e1f7f4f937856180503f2f2097b06ed61

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+# [v0.1.0](https://github.com/Muriel-Salvan/nexus_mods/compare/v0.0.1...v0.1.0) (2023-03-26 17:37:15)
+
+### Patches
+
+* [Fix deployment](https://github.com/Muriel-Salvan/nexus_mods/commit/87cef38881b87b08af8c03773bcbda6235f9bbe9)
+
+### Features
+
+* [[Feature] Query games, mods and mod files](https://github.com/Muriel-Salvan/nexus_mods/commit/27bba8875a1f70d7256ce18359c02c08c8d78ab7)
+
+# 0.0.1
+
+* Initial version

data/LICENSE.md

@@ -0,0 +1,31 @@
+
+The license stated herein is a copy of the BSD License (modified on July 1999).
+The AUTHOR mentionned below refers to the list of people involved in the
+creation and modification of any file included in the delivered package.
+This list is found in the file named AUTHORS.
+The AUTHORS and LICENSE files have to be included in any release of software
+embedding source code of this package, or using it as a derivative software.
+
+Copyright (c) 2019 - 2023 Muriel Salvan (muriel@x-aeon.com)
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+   1. Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+   2. Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+   3. The name of the author may not be used to endorse or promote products
+      derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
+WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
+EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
+OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
+IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
+OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,61 @@
+# nexus_mods
+
+Simple Ruby API letting you handle [NexusMods](https://www.nexusmods.com/) REST API.
+
+## Install
+
+Via gem
+
+``` bash
+$ gem install nexus_mods
+```
+
+Via a Gemfile
+
+``` ruby
+$ gem 'nexus_mods'
+```
+
+## Usage
+
+``` ruby
+require 'nexus_mods'
+
+nexus_mods = NexusMods.new(api_key: 'sdflfkglkjewfmlkvweflkngvkndflvnelrjgn')
+puts nexus_mods.mod(mod_id: 2014).name
+```
+
+## Change log
+
+Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
+
+## Testing
+
+Automated tests are done using rspec.
+
+Do execute them, first install development dependencies:
+
+```bash
+bundle install
+```
+
+Then execute rspec
+
+```bash
+bundle exec rspec
+```
+
+## Contributing
+
+Any contribution is welcome:
+* Fork the github project and create pull requests.
+* Report bugs by creating tickets.
+* Suggest improvements and new features by creating tickets.
+
+## Credits
+
+- [Muriel Salvan][link-author]
+
+## License
+
+The BSD License. Please see [License File](LICENSE.md) for more information.

data/lib/nexus_mods/api_limits.rb

@@ -0,0 +1,44 @@
+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

@@ -0,0 +1,37 @@
+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

@@ -0,0 +1,78 @@
+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

@@ -0,0 +1,106 @@
+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

@@ -0,0 +1,86 @@
+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

@@ -0,0 +1,37 @@
+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/lib/nexus_mods/version.rb

@@ -0,0 +1,5 @@
+class NexusMods
+
+  VERSION = '0.1.0'
+
+end