Beeswaxapi

This gem is a wrapper for Beeswax Buzz API.

Installation

Add this line to your application's Gemfile:

gem 'beeswaxapi'

And then execute:

$ bundle

Or install it yourself as:

$ gem install beeswaxapi

Usage

To start work with Beeswaxapi you need setup your config.

Configuration

Available configs:

• auth_strategy: by default basic. Can be changed to cookies.
• cookie_file: path to file with cookies. Required for cookies auth_strategy.
• base_uri: uri to beeswax api endpoint. Should be with rest path
• user_name: email of user
• password: password of user
• logger: this option enable logging

Example configuration for basic auth authentication:

BeeswaxAPI::App.configure do |config|
  config.auth_strategy = 'basic'
  config.base_uri      = 'https://sandbox.api.beeswax.com/rest'
  config.user_name     = 'user@mail.com'
  config.password      = 'password'
end

Example configuration for cookies authentication:

BeeswaxAPI::App.configure do |config|
  config.auth_strategy = 'cookies'
  config.cookie_file   = '/path/to/cookies-file.txt'
  config.base_uri      = 'https://sandbox.api.beeswax.com/rest'
  config.user_name     = 'user@mail.com'
  config.password      = 'password'
end

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 tags, and push the .gem file to rubygems.org.

Sources

Beeswax Buzz API: [https://docs.beeswax.com/docs] (https://docs.beeswax.com/docs/getting-started)

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/beeswaxapi.

License

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