Optimizely
===========

The unofficial (basic) Ruby gem to communicate with the Optimizely Experiment API (http://developers.optimizely.com/rest/).
The Experiment API lets you create and manage Optimizely projects and experiments.

To start using the Optimizely Experiment API you need an API Token, you can request one via: developers@optimizely.com

# Quick start

## Installation

Add Optimizely to your Gemfile

    gem 'optimizely'

Don't forget to bundle install:

    $ bundle install

# General usage

### Create your Optimizely object

    optimizely = Optimizely.new({ api_token: 'abcdefghijklmnopqrstuvwxyz:123456' })

## Projects

The fields that are available for a project: project_name, project_status, id and account_id.

	Retrieve all projects:
		projects = optimizely.projects

	Retrieve a specific project:
		project = optimizely.project(12345)

## Experiments

The fields that are available for an experiment: id, project_id, variation_ids, edit_url and status.
	
	Retrieve all experiments for a project:
		experiments = optimizely.experiments(12345)

	Retrieve a specific experiment:
		experiment = optimizely.experiment(12345)

## Variations

The fields that are available for a varation: is_paused, description, weight, created, variation_id, section_id, js_component, experiment_id, project_id and id.

	Retrieve all variations for an experiment:
		variations = optimizely.variations(12345)

	Retrieve a specific variation:
		variation = optimizely.variation(12345)

## Audiences

The fields that are available for an audience: id, name, project_id and description.

	Retrieve all audiences for an project:
		audiences = optimizely.audiences(12345)

	Retrieve a specific audience:
		audience = optimizely.audience(12345)

# Information

### Changelog

#### 1.2.0
* Provide users with a method to delete audiences, experiments, variations and projects.

#### 1.1.3
* Add methods for put, post and delete requests.
* Refactor the way we check response codes to make it available to the put, post and delete methods.

#### 1.1.2
* Write tests to check what happens if data is not available.

#### 1.1.1
* Return a hash object for the data you've just requested.

#### 1.1
* Fix some typos in the errors for having no variable in a function and added extra documentation.
* Add support for reading specific projects, experiments, variations and audiences.

#### 1.0
* Add all basic features for the Optimizely Experiment API for listing projects, experiments, variations and audiences.

### Bug reports

If you discover any bugs, feel free to create an issue on GitHub. Please add as much information as
possible to help us fixing the possible bug. We also encourage you to help even more by forking and
sending us a pull request.

https://github.com/martijnsch/optimizely-gem/issues

### Contributing

1. Fork it
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