⛔️ DEPRECATED / ARCHIVED ⛔️

This repository is now deprecated and has been archived.

The Milk Bottle API that this was a wrapper for has been removed.

See RURU-758 and this slack conversation for more details.

Milkbottle

A ruby gem to wrap the Milkbooks API.

The structure of this project is derived from github's octokit.rb project.

Installation

Add this line to your application's Gemfile:

gem 'milkbottle'

And then execute:

$ bundle

Or install it yourself as:

$ gem install milkbottle

Usage

TODO: Either configure by an initalizer:

Milkbottle.configure do |c|
  c.api_key              = 'API_KEY'
  c.external_auth_key    = 'AUTH_KEY'
  c.external_auth_issuer = Rails.env.production? ? PROD_URL : TEST_URL
end

or as a standalone client:

Milkbottle::Client.new(api_key: 'API-KEY')

Options

Option	Description	ENV equivalent	Default
api_key	The API Key perscribed by Milk Books	MILKBOTTLE_API_KEY	nil
api_endpoint	The endpoint this gem communicates with	MILKBOTTLE_API_ENDPOINT	https://api.staging.milkbooks.com

Contributing

1. Fork it ( https://github.com/storypark/milkbottle/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request