liblab_the_one

Liblab

This gem is an API wrapper for (the one api)[https://the-one-api.dev/].

Installation

Install ruby and bundler

Add the following environment variables. You can request an access_token at https://the-one-api.dev/.

  LIBLAB_ACCESS_TOKEN=

Add this line to your application's Gemfile if using Ruby on Rails:

gem 'liblab_the_one'

And then execute:

$ bundle install

Or install it yourself in a ruby environment as:

$ gem install pex_api

After installing you can test by running irb, then require "liblab" and then running Liblab::Movie::List.call() This should return a list of movies.

Usage

Liblab::Movie::List.call() will get a list of movies

Liblab::Movie::List.call() will retrieve a single movie

Liblab::Movie::Get.call(movie_id) will get quotes for a single movie

Liblab::Quote::List.call() will get a list of quotes

Liblab::Quote::List.call({ limit: 5, page: 2, offset: 1}) will get a list but with pagination

Liblab::Quote::Get.call(quote_id) will retrieve an individual quote

Bonus Game: Guess the quote!

Help test and build your Lord of The Rings knowledge.

Use Liblab::Quote::GuessTheQuote.call() to return a random quote with a movie name.

You can tell people the quote and they have to guess the movie.

Example response is {:quote=>"Your bodyguard?", :movie_name=>"The Two Towers"}

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rspec 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/givesafe/pex_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the (code of conduct)[https://github.com/mlennie/montgomery-sdk/blob/master/CODE_OF_CONDUCT.md].

License

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

Code of Conduct

Everyone interacting in the PexApi project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the (code of conduct)[https://github.com/mlennie/montgomery-sdk/blob/master/CODE_OF_CONDUCT.md].