Code Monkey home page Code Monkey logo

spree-account-recurring's Introduction

Spree Account Recurring Code Climate Build Status

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

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

Installation

Install spree_account_recurring by adding the following to your Gemfile:

gem 'spree_account_recurring'

For older version of Spree

# Spree 2.1.x
gem 'spree_account_recurring', '1.0.5'

Bundle your dependencies and run the installation generator:

bundle
bundle exec rails g spree_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 'spree_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

vinsol.com: Ruby on Rails, iOS and Android developers

Copyright (c) 2014 vinsol.com, released under the New MIT License

spree-account-recurring's People

Contributors

satish avatar

Watchers

James Cloos avatar Davis Sorenson avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.