Contents

= Peakium Ruby API Bindings

== About

This is an experimental release heavily inspired by (and stolen from) the {Stripe 
Ruby bindings}[https://github.com/stripe/stripe-ruby].

== Installation

  gem build peakium.gemspec
  gem install

== Example usage

Set API key:

  Peakium.api_key = "you_secret_api_key"

Retrieve a customer:

  customer = Peakium::Customer.retrieve("test_customer")

Create a submission form:

  submission_form = Peakium::SubmissionForm.build('create-subscription', args)

Cancel a subscription:

  customer.cancel_subscription("test_subscription")

== Errors

The library will raise exceptions when errors are encountered, e.g. if a resource doesn't exist.

== Requirements

* Ruby 1.8.7 or above. (Ruby 1.8.6 may work if you load
  ActiveSupport.)
* rest-client, multi_json

== Development

Test cases can be run with: `bundle exec rake test`

Version data entries

4 entries across 4 versions & 1 rubygems

Version	Path
peakium-0.1.4	README.rdoc
peakium-0.1.3	README.rdoc
peakium-0.1.2	README.rdoc
peakium-0.1.1	README.rdoc