ember-cli-recurly

This addon is a solution for integrating Recurly.js into your Ember.js web app.

Installation

ember install ember-cli-recurly

Usage

Create Recurly account: https://recurly.com/
Define your Recurly public key in config.

//config/environment.js
module.exports = function(environment) {
  var ENV = {
    //...
    recurly: {
      publicKey: '<your-public-key>'
    }
  };
//...

Inject the service where needed.

recurly: Ember.inject.service()

recurly

Service injection gives access to a global object recurly. Can Also be used to obtain a token using the service.

getToken()

getToken() makes a request to Recurly to retrieve a token using the passed in options token property on the service. Accepts billingInfo as an argument. Returns an Ember.RSVP.Promise which is either resolved with token containing token object or with err which explains why token request failed. It is used like this:

var billingInfo = {
  // required attributes
  first_name: 'John',
  last_name: 'Rambo',

  // optional attributes
  cvv: '123',
  address1: '123 Main St.',
  address2: 'Unit 1',
  city: 'Hope',
  state: 'WA',
  postal_code: '98552',
  country: 'US',
  vat_number: 'SE0000'
};

this.get('recurly').getToken(billingInfo).then(function(token) {
  // do anything with token here
});

token

token is an object which contains the id of the token that can be the used in a recurly transaction.

{
  id: '123abcdebfexample'
}

The object is also held in the service and can be retrieved like so:

let token = this.get('recurly.token')

payPal()

payPal() initiates a PayPal checkout with recurly. Accepts opts as options for the PayPal agreement flow. Returns an Ember.RSVP.Promise which is either resolved with token containing the token or with err which explains why the PayPal request failed. If request is successful the token attribute in the service will also be updated. For more information on how to configure PayPal with Recurly refer to Recurly documentation: https://docs.recurly.com/payment-gateways/paypal-payments It is used like this:

let opts = { descriptions: 'Bazooka Monthly' };

this.get('recurly').payPal(opts).then(function(token) {
  // do anything with token here
  })

getBankInfo()

getBankInfo() looks up additional bank information based from a given routing number. Accepts routingNumber as an argument. Returns an Ember.RSVP.Promise which is either resolved with bankInfo containing bank information or is rejected with err which explains why bank info request failed. It is used like this:

var routingNumber = '1234567';

this.get('recurly').getBankInfo(routingNumber).then(function(bankInfo) {
  // do anything bankInfo here
});

Example of bank information returned:

{
  bank_name: 'BANK OF RECURLY'
}

For more information and using the recurly object refer to Recurly.js docs: https://docs.recurly.com/js/#how-it-works

#TODO

recurly.pricing API
Write tests

Running Tests

ember test
ember test --server

Building

ember build

For more information on using ember-cli, visit http://www.ember-cli.com/.

dallasread/ember-cli-recurly