/optimizely-client

A simple wrapper for the Optimizely V2 REST API.

Primary LanguageRubyMIT LicenseMIT

Optimizely::Client

Optimizely::Client is a super simple wrapper for Optimizely's API.

Installation

Add this line to your application's Gemfile:

gem "optimizely-client"

And then execute:

$ bundle

Or install it yourself as:

$ gem install optimizely-client

Usage

Configure Your API Token

By default the client will look for an environment variable named OPTIMIZELY_API_TOKEN but you can also set it explicitly yourself:

Optimizely.api_token = "<your api token here>"

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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/chrisb/optimizely-client. 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 Optimizely::Client project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.