plurall

Plurall

Fully Implements the Plurall API in Ruby

Installation

Add this line to your application's Gemfile:

gem "plurall"

And then execute:

$ bundle

Or install it yourself as:

$ gem install plurall

Be sure to define your Plurall credentials by setting up environment variables in your application appropriately. Refer to the .env.sample file for details.

PLURALL_CLIENT_ID:      "YOUR_PLURALL_CLIENT_ID"
PLURALL_CLIENT_SECRET:  "YOUR_PLURALL_CLIENT_SECRET"
PLURALL_ID_APPLICATION: "YOUR_PLURALL_APPLICATION_ID"

Usage

There are many primary APIs that are wrapped. Below you will see basic examples of how to use them. For more information about what optional query parameters are available, please consult the Plurall API Docs

Configuration

Place the following configuration in your apps initializer:

Plurall.configure do |config|
  config.client_id      = "YOUR_PLURALL_CLIENT_ID"
  config.client_secret  = "YOUR_PLURALL_CLIENT_SECRET"
  config.id_application = "YOUR_PLURALL_APPLICATION_ID"
end

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test 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 tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/beneggett/plurall. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant 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 Plurall` project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.