Lotrb

This library provide a Ruby SDK to The One API, a rich API for fetching information about the Lord of the Rings books and movies.

Installation

Add this line to your application's Gemfile:

gem 'lotrb'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install lotrb

Usage

Before using this library, you'll need to provision an access token for The One API by signing up. Then, you will need to configure this library with your access token.

Set Lotrb.access_token to the value of your token:

require "lotrb"

Lotrb.access_token = "your_access_token_here"

# List all the movies
# This returns a `ListObject` containing an array of the corresponding resource objects along with the pagination fields
movies_response = Lotrb::Movie.list
movies_response.results
movies_response.pages 

# Fetch a specific movie
Lotrb::Movie.retrieve("5cd95395de30eff6ebccde5d")

# Fetch the chapters from a book
book = Lotrb::Book.list.results.last
book.list_chapters

# Pagination, sorting, and filtering all work by passing a hash of 
# params to any `list` or `list_blahs` call.
# These params map precisely to those described in [the API docs](https://the-one-api.dev/documentation)
#
# Paginate!
Lotrb::Quote.list({ limit: 5, page: 75 })

# Sort!
Lotrb::Book.list({ sort: "name:asc" })

# Filter!
Lotrb::Character.list({ race: "Hobbit,Human" })

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/danielmklein/lotrb. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the lotrb project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.