StripeFire
A Node.js module that handles Stripe API calls for Firebase references.
StripeFire uses the following APIs:
Getting Started
Install the module: npm install stripe-fire
Require in Node.js file:
var stripeFire = "your Stripe private key";
API Reference
A StripeFire
object is used to store Firebase references for Stripe API objects for a specific Stripe account. The Stripe account is identified by the private key.
Each object accepts ref
, callback
, accessToken
, and alterRequest
parameters.
ref
(required): an instance of a Firebase object or a string that points to a Firebase referencecallback
(optional): a function which is called after a child is added to the specified reference and the API request is sent to Stripe; the function accepts two parameters: an error object and the Stripe object if the request is successfulaccessToken
(optional): a string or function which returns an access token to be sent with the Stripe API request (used for Stripe Connect); the function accepts one parameter: the data set in the Firebase childalterRequest
(optional): a function which is called before a request is sent to Stripe; the function accepts one parameter: the data set in the Firebase child
The reference should contain children which are all similar Stripe objects. Note the children names can be anything so long as they exist in parent objects.
For example, a refund child named order1234
should have a corresponding charge child named order1234
. This allows StripeFire to be agnostic about Stripe object ids.
After the API request is sent to Stripe the full Stripe object is stored at the same location where it was created (or an error object if an error occured). For child objects i.e. refunds, cards, subscriptions, etc., the reference is deleted after a successful response from Stripe and the parent object i.e. charges, customers, etc. is updated.
The callback
, accessToken
, and alterRequest
functions may be called with the this
variable set with the following properties:
accessToken
: the access token used in the requestaction
: create/delete/update as appropriatechildSnapshot
: the Firebase DataSnapshot used to generate the request
StripeFire(key)
Creates a StripeFire
object which can be used to store references.
Example:
//sk_test_BQokikJOvBiI2HlWgH4olfQ2 is the example Stripe private keyvar stripeFire = "sk_test_BQokikJOvBiI2HlWgH4olfQ2";
StripeFire.charges(ref, [callback], [accessToken], [alterRequest])
Initializes and returns a Charges
object.
Example:
var charges = stripeFire;
Sample Client-Side Usage:
var chargesRef = "https://stripe-fire.firebaseio.com/charges"; // Create a chargechargesRef; // Update a chargechargesRef;
Charges.refunds(ref, [callback], [accessToken], [alterRequest])
Initializes a Refunds
object which is a descendant of the Charges
object. The charge with the same name as the refund will be retrieved from Stripe and saved under the Charges
object reference.
Example:
charges;
Sample Client-Side Usage:
var refundsRef = "https://stripe-fire.firebaseio.com/refunds";//"ChargeName" should exist as a child in the charges referencerefundsRef;
StripeFire.coupons(ref, [callback], [accessToken], [alterRequest])
Initializes a Coupons
object.
Example:
stripeFire;
Sample Client-Side Usage:
var couponsRef = "https://stripe-fire.firebaseio.com/coupons"; // Create a couponcouponsRef; // Update a couponcouponsRef;
StripeFire.customers(ref, [callback], [accessToken], [alterRequest])
Initializes and returns a Customers
object.
Example:
var customers = stripeFire;
Sample Client-Side Usage:
var customersRef = "https://stripe-fire.firebaseio.com/customers"; // Create a customercustomersRef; // Update a customercustomersRef;
Customers.cards(ref, [callback], [accessToken], [alterRequest])
Initializes a Cards
object which is a descendant of the Customers
object. The customer with the same name as the card's parent will be retrieved from Stripe and saved under the Customers
object reference.
Example:
customers;
Sample Client-Side Usage:
var cardsRef = "https://stripe-fire.firebaseio.com/cards";//"CustomerName" should exist as a child in the customers referencecardsRef;
Customers.subscriptions(ref, [callback], [accessToken], [alterRequest])
Initializes a Subscriptions
object which is a descendant of the Customers
object. The customer with the same name as the subscription's parent will be retrieved from Stripe and saved under the Customers
object reference.
Example:
customers;
Sample Client-Side Usage:
var subscriptionsRef = "https://stripe-fire.firebaseio.com/subscriptions";//"CustomerName" should exist as a child in the customers referencesubscriptionsRef;
StripeFire.plans(ref, [callback], [accessToken], [alterRequest])
Initializes a Plans
object.
Example:
stripeFire;
Sample Client-Side Usage:
var plansRef = "https://stripe-fire.firebaseio.com/plans"; // Create a planplansRef; // Update a planplansRef;
Security Reference
Make sure to secure Firebase with the proper rules to protect the Stripe data. Checkout the Firebase Security API for more details.
To easily get started building Firebase rules you can use the Blaze Security Compiler.
Install the Blaze Security Compiler with: npm install -g blaze_compiler
A sample rules.yml file has been provided as a boilerplate.
Contributing
In lieu of a formal style guide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.
License
Copyright (c) 2014 David Caseria Licensed under the MIT license.