Contents

Centro Ruby Client
==================

The Centro Ruby Client is used to interact with the Centro API from
Ruby.

For more about the Centro API see <http://api-docs.centro.net>.

Usage
-----

Start by creating a connection to Centro with your credentials:

    require 'centro-centro'

    centro = Centro::API.new(:api_key => API_KEY)

NOTE: You can leave out the `:api_key` if `ENV['CENTRO_API_KEY']` is set
instead.

Now you can make requests to the api.

Requests
--------

What follows is an overview of commands you can run for the client.

For additional details about any of the commands, see the [API
docs](http://api-docs.centro.net).

Mock
----

For practice or testing you can also use a simulated Centro:

    require 'centro-api'

    centro = Centro::API.new(:api_key => API_KEY, :mock => true)

After that commands should still behave the same, but they will only
modify some local data instead of updating the state of things on
Centro.

Tests
-----

To run tests, first set `ENV['CENTRO_API_KEY']` to your api key.  Then
use `bundle exec rake` to run mock tests or `MOCK=false bundle exec
rake` to run integration tests.

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
centro-client-0.0.1	README.md