Project

nexus_mods

0.0
No release in over a year
Access NexusMods REST API from Ruby
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
 Dependencies

Development

~> 3.12
~> 1.48
~> 3.18

Runtime

~> 2.0
~> 2.7
 Project Readme

nexus_mods

Simple Ruby API letting you handle NexusMods REST API.

Main features

  • Get the API limits.
  • Get the games information.
  • Get individual mods and mod files information.
  • Configurable caching with expiry times to save API calls to nexusmods.com.
  • All served in an object-oriented API in full Ruby.

See the examples for more details on how to use it. Those examples expect that you set a valid NexusMods API key in the NEXUS_MODS_API_KEY environment variable.

Install

Via gem

$ gem install nexus_mods

Via a Gemfile

$ gem 'nexus_mods'

Usage

require 'nexus_mods'

nexus_mods = NexusMods.new(api_key: 'sdflfkglkjewfmlkvweflkngvkndflvnelrjgn')
puts nexus_mods.mod(mod_id: 2014).name

Change log

Please see CHANGELOG for more information on what has changed recently.

Testing

Automated tests are done using rspec.

Do execute them, first install development dependencies:

bundle install

Then execute rspec

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

License

The BSD License. Please see License File for more information.