A Ruby API wrapper for Recurly. Super Simple Subscription billing.
Ruby
Switch branches/tags
Nothing to show
Clone or download
Pull request Compare This branch is 15 commits ahead, 680 commits behind recurly:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
test
.gitignore
LICENSE
README.md
Rakefile
init.rb

README.md

Recurly Ruby Client

The Recurly Ruby Client library is an open source library to interact with Recurly's subscription management from your Ruby on Rails website. The library interacts with Recurly's REST API.

Usage

Please see the documentation and support forums for more information.

Installation

This library can be installed as a gem or a plugin. Your choice.

Gem Installation:

gem install recurly --source=http://gemcutter.org

Plugin Installation:

script/plugin install git@github.com:recurly/recurly-client-ruby.git

Authentication

The Recurly Ruby Client requires a username and password to connect. We recommend creating a user just for your API. Please see the Authentication documentation for more information.

Create a file in your Rails app at /config/initializers/recurly_config.rb with contents like:

Recurly.configure do |c|
  c.username = 'api@yourcompany.com'
  c.password = 'super_secret_password'
end

Demo Application

Recurly Ruby Demo App

Examples

All the functionality is demonstrated by the unit tests in the test directory.

To run the tests, you'll need to create a file /test/config.yml. See /test/config.example.yml for details.

API Documentation

Please see the Recurly API for more information.