Skip to content

Latest commit

 

History

History
107 lines (77 loc) · 3.21 KB

README.md

File metadata and controls

107 lines (77 loc) · 3.21 KB
Raw

Solidus Account Recurring Code Climate Build Status

Solidus extension to manage recurring payments/subscriptions using Stripe Payment Gateway.

All plans and subscription scenarios are been managed as per Stripe Docs

Installation

Install solidus_account_recurring by adding the following to your Gemfile:

# Solidus 1.2.0.alpha - currently master
gem 'solidus_account_recurring', github:'ridem/solidus-account-recurring'

Bundle your dependencies and run the installation generator:

bundle
bundle exec rails g solidus_account_recurring:install

Usage

At Admin end this will add a configuration tab as "Recurring".

  • Creating a Recurring Provider:

    • Create a recurring using Spree::Recurring::StripeRecurring Provider and save
    • Add secret key and public key provided by stripe to this recurring.

  • Creating Plans for Recurring Provider:

    • Go to "Manage Plans" from Recurring edit page.
    • Create a plan by specifying respective details. This will create the same plan on your stripe account.
    • Only name can be updated for a plan.

One Recurring Provider can have multiple plans.

At Front end you can view all plans here: http://your.domain.name/recurring/plans

  • Subscribe a plan:

    • Click subscribe for any plan.
    • Fill in credit card details and submit.
    • This will create a customer in Stripe for user and subscribe that user respective to plan.

  • Unsubscribe a plan:

    • In plans page subscribed plan will be listed and from there user can unsubscribe from plan.

At Admin, all subscriptions can be seen under "Reports" -> "Subscriptions".

Stripe Webhook

Create a webhook at stripe with url http://your.domain.name/recurring_hooks/handler which will receive below mentioned stripe event hooks.

Events:

  • customer.subscription.deleted
  • customer.subscription.created
  • customer.subscription.updated
  • invoice.payment_succeeded
  • invoice.payment_failed
  • charge.succeeded
  • charge.failed
  • charge.refunded
  • charge.captured
  • plan.created
  • plan.updated
  • plan.deleted

These events can be viewed at admin in "Reports" -> "Subscription Events"

Testing

Be sure to bundle your dependencies and then create a dummy test app for the specs to run against.

bundle
bundle exec rake test_app
bundle exec rspec spec

When testing your applications integration with this extension you may use it's factories. Simply add this require statement to your spec_helper:

require 'solidus_account_recurring/factories'

Contributing

  1. Fork the repo.
  2. Clone your repo.
  3. Run bundle install.
  4. Run bundle exec rake test_app to create the test application in spec/test_app.
  5. Make your changes.
  6. Ensure specs pass by running bundle exec rspec spec.
  7. Submit your pull request.

Credits

This project is a fork of spree-account-recurring.