spree_account_recurring 1.0.0

data/LICENSE

@@ -0,0 +1,26 @@
+Copyright (c) 2013 [name of plugin creator]
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+    * Neither the name Spree nor the names of its contributors may be used to
+      endorse or promote products derived from this software without specific
+      prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,108 @@
+Spree Account Recurring [![Code Climate](https://codeclimate.com/github/vinsol/spree-account-recurring.png)](https://codeclimate.com/github/vinsol/spree-account-recurring) [![Build Status](https://travis-ci.org/vinsol/spree-account-recurring.svg?branch=2-1-stable)](https://travis-ci.org/vinsol/spree-account-recurring)
+=========================
+
+Spree extension to manage recurring payments/subscriptions using [Stripe Payment Gateway](https://stripe.com/).
+
+All plans and subscription scenarios are been managed as per [Stripe Docs](https://stripe.com/docs/api)
+
+Installation
+------------
+
+Install `spree_account_recurring` by adding the following to your `Gemfile`:
+
+```ruby
+gem 'spree_account_recurring'
+```
+
+Bundle your dependencies and run the installation generator:
+
+```shell
+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](https://stripe.com/) 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.
+
+```shell
+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:
+
+```ruby
+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](http://vinsol.com/vin_logo.png "Ruby on Rails, iOS and Android developers")](http://vinsol.com)
+
+Copyright (c) 2014 [vinsol.com](http://vinsol.com "Ruby on Rails, iOS and Android developers"), released under the New MIT License

data/app/assets/javascripts/admin/spree_account_recurring.js

@@ -0,0 +1 @@
+//= require admin/spree_backend

data/app/assets/javascripts/store/spree_account_recurring.js

@@ -0,0 +1 @@
+//= require store/spree_frontend

data/app/assets/javascripts/store/stripe.js

@@ -0,0 +1,53 @@
+// Inspired by https://stripe.com/docs/stripe.js
+
+mapCC = function(ccType){
+  if(ccType == 'MasterCard'){
+    return 'mastercard';
+  } else if(ccType == 'Visa'){
+    return 'visa';
+  } else if(ccType == 'American Express'){
+    return 'amex';
+  } else if(ccType == 'Discover'){
+    return 'discover';
+  } else if(ccType == 'Diners Club'){
+    return 'dinersclub';
+  } else if(ccType == 'JCB'){
+    return 'jcb';
+  }
+}
+
+$(document).ready(function(){
+  // For errors that happen later.
+  Spree.stripePaymentMethod.prepend("<div id='stripeError' class='errorExplanation' style='display:none'></div>")
+
+  $('.continue').on('click', function(){
+    $('#stripeError').hide();
+    if(Spree.stripePaymentMethod.is(':visible')){
+      expiration = $('.cardExpiry:visible').payment('cardExpiryVal')
+      params = {
+          number: $('.cardNumber:visible').val(),
+          cvc: $('.cardCode:visible').val(),
+          exp_month: expiration.month || 0,
+          exp_year: expiration.year || 0
+        };
+
+      Stripe.card.createToken(params, stripeResponseHandler);
+      return false;
+    }
+  });
+});
+
+stripeResponseHandler = function(status, response){
+  if(response.error){
+    $('#stripeError').html(response.error.message);
+    $('#stripeError').show();
+  } else {
+    Spree.stripePaymentMethod.find('#card_number, #card_expiry, #card_code').prop("disabled" , true);
+    Spree.stripePaymentMethod.find(".ccType").prop("disabled", false);
+    Spree.stripePaymentMethod.find(".ccType").val(mapCC(response.card.type))
+    token = response['id'];
+    // insert the token into the form so it gets submitted to the server
+    Spree.stripePaymentMethod.append("<input type='hidden' class='stripeToken' name='subscription[card_token]' value='" + token + "'/>");
+    Spree.stripePaymentMethod.parents("form").get(0).submit();
+  }
+}

data/app/assets/stylesheets/admin/spree_account_recurring.css

@@ -0,0 +1,3 @@
+/*
+ *= require admin/spree_backend
+*/

data/app/assets/stylesheets/store/spree_account_recurring.css

@@ -0,0 +1,3 @@
+/*
+ *= require store/spree_frontend
+*/

data/app/controllers/concerns/spree/admin/ransack_date_search.rb

@@ -0,0 +1,47 @@
+module Spree
+  module Admin
+    module RansackDateSearch
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        def ransack_date_searchable(options={})
+          raise ArgumentError, "Hash expected, got #{options.class.name}" unless options.is_a?(Hash)
+          class_attribute :ransack_date_search_config, :ransack_date_search_col_ref, :ransack_date_search_param_gt, :ransack_date_search_param_lt
+          self.ransack_date_search_config = { date_col: "created_at" }.merge!(options)
+          # self.ransack_date_search_config[:before_action] = [ransack_date_search_config[:before_action]] unless ransack_date_search_config[:before_action].is_a?(Array)
+          self.ransack_date_search_col_ref = ransack_date_search_config[:date_col]
+          self.ransack_date_search_param_gt = "#{ransack_date_search_col_ref}_gt"
+          self.ransack_date_search_param_lt = "#{ransack_date_search_col_ref}_lt"
+        end
+      end
+
+      included do
+        before_action :parse_ransack_date_search_param!, only: 'index'
+      end
+      
+      private
+
+      def parse_ransack_date_search_param!
+        params[:q] = {} unless params[:q]
+        parse_ransack_date_search_param_gt!
+        parse_ransack_date_search_param_lt!
+        params[:q][:s] ||= "#{ransack_date_search_col_ref} desc"
+        params[:q].delete_if{ |k, v| v.blank? }
+      end
+
+      def parse_ransack_date_search_param_gt!
+        if params[:q][ransack_date_search_param_gt].blank?
+          params[:q][ransack_date_search_param_gt] = Time.current.beginning_of_month
+        else
+          params[:q][ransack_date_search_param_gt] = Time.zone.parse(params[:q][ransack_date_search_param_gt]).beginning_of_day rescue Time.current.beginning_of_month
+        end
+      end
+
+      def parse_ransack_date_search_param_lt!
+        if params[:q][ransack_date_search_param_lt].present?
+          params[:q][ransack_date_search_param_lt] = Time.zone.parse(params[:q][ransack_date_search_param_lt]).end_of_day rescue ""
+        end
+      end
+    end
+  end
+end

data/app/controllers/spree/admin/plans_controller.rb

@@ -0,0 +1,63 @@
+module Spree
+  module Admin
+    class PlansController < Spree::Admin::BaseController
+      before_action :load_recurring
+      before_action :find_plan, :only => [:edit, :destroy, :update]
+
+      def index
+        @plans = Spree::Plan.undeleted.order('id desc')
+      end
+
+      def new
+        @plan = @recurring.plans.build
+      end
+
+      def create
+        @plan = @recurring.plans.build(plan_params)
+        if @plan.save_and_manage_api
+          flash[:notice] = 'Plan created successfully.'
+          redirect_to edit_admin_recurring_plan_path(@recurring, @plan)
+        else
+          render :new
+        end
+      end
+
+      def update
+        if @plan.save_and_manage_api(plan_params(:update))
+          flash[:notice] = 'Plan updated successfully.'
+          redirect_to edit_admin_recurring_plan_path(@recurring, @plan)
+        else
+          render :edit
+        end
+      end
+      
+      def destroy
+        @plan.restrictive_destroy_with_api
+      end
+
+      private
+
+      def load_recurring
+        unless @recurring = Spree::Recurring.undeleted.where(id: params[:recurring_id]).first
+          flash[:error] = "Recurring not found."
+          redirect_to admin_recurrings_path
+        end
+      end
+
+      def plan_params(action=:create)
+        if action == :create
+          params.require(:plan).permit(:name, :trial_period_days, :interval, :currency, :amount, :active, :interval_count, :default)
+        else
+          params.require(:plan).permit(:name, :active, :default)
+        end
+      end
+
+      def find_plan
+        unless @plan = @recurring.plans.undeleted.where(id: params[:id]).first
+          flash[:error] = "Plan not found."
+          redirect_to admin_recurring_plans_path(@recurring)
+        end
+      end
+    end
+  end
+end

data/app/controllers/spree/admin/recurrings_controller.rb

@@ -0,0 +1,66 @@
+module Spree
+  module Admin
+    class RecurringsController < Spree::Admin::BaseController
+      before_action :find_recurring, :only => [:edit, :update, :destroy]
+      before_action :build_recurring, :only => :create
+
+      def index
+        @recurrings = Spree::Recurring.undeleted.order('id desc')
+      end
+
+      def new
+        @recurring = Spree::Recurring.new
+      end
+
+      def create
+        if @recurring.save
+          flash[:notice] = "Recurring created succesfully."
+          redirect_to edit_admin_recurring_url(@recurring)
+        else
+          render :new
+        end
+      end
+
+      def update
+        if @recurring.update_attributes(recurring_params(:update))
+          flash[:notice] = "Recurring updated succesfully."
+          redirect_to edit_admin_recurring_url(@recurring)
+        else
+          render :edit
+        end
+      end
+
+      def destroy
+        @recurring.restrictive_destroy
+      end
+
+      private
+
+      def find_recurring
+        unless @recurring = Spree::Recurring.undeleted.where(id: params[:id]).first
+          flash[:error] = "Recurring not found."
+          respond_to do |format|
+            format.html {redirect_to admin_recurrings_url}
+            format.js { }
+          end
+        end
+      end
+
+      def recurring_params(action=:create)
+        if action == :create
+          params.require(:recurring).permit(:name, :type, :description, :active)
+        else
+          params.require(:recurring).permit(:name, :description, :active).merge(preference_params)
+        end
+      end
+
+      def build_recurring
+        @recurring = recurring_params.delete(:type).constantize.new(recurring_params)
+      end
+
+      def preference_params
+        params[ActiveModel::Naming.param_key(@recurring)]
+      end
+    end
+  end
+end

data/app/controllers/spree/admin/subscription_events_controller.rb

@@ -0,0 +1,14 @@
+module Spree
+  module Admin
+    class SubscriptionEventsController < Spree::Admin::BaseController
+      include RansackDateSearch
+      ransack_date_searchable date_col: 'created_at'
+
+      def index
+        @search = Spree::SubscriptionEvent.ransack(params[:q])
+        @subscription_events = @search.result.includes(subscription: { plan: :recurring }).references(subscription: { plan: :recurring }).page(params[:page]).per(15)
+        respond_with(@subscription_events)
+      end
+    end
+  end
+end

data/app/controllers/spree/admin/subscriptions_controller.rb

@@ -0,0 +1,14 @@
+module Spree
+  module Admin
+    class SubscriptionsController < Spree::Admin::BaseController
+      include RansackDateSearch
+      ransack_date_searchable date_col: 'subscribed_at'
+
+      def index
+        @search = Spree::Subscription.ransack(params[:q])
+        @subscriptions = @search.result.includes(plan: :recurring).references(plan: :recurring).page(params[:page]).per(15)
+        respond_with(@subscriptions)
+      end
+    end
+  end
+end

data/app/controllers/spree/plans_controller.rb

@@ -0,0 +1,7 @@
+module Spree
+  class PlansController < StoreController
+    def index
+      @plans = Spree::Plan.visible.order('id desc')
+    end
+  end
+end

data/app/controllers/spree/recurring_hooks_controller.rb

@@ -0,0 +1,53 @@
+module Spree
+  class RecurringHooksController < BaseController
+    skip_before_filter :verify_authenticity_token
+    
+    before_action :authenticate_webhook
+    before_action :find_subscription
+
+    respond_to :json
+
+    def handler
+      @subscription_event = @subscription.events.build(subscription_event_params)
+      if @subscription_event.save
+        render_status_ok
+      else
+        render_status_failure
+      end
+    end
+
+    private
+
+    def event
+      @event ||= (Rails.env.production? ? params.deep_dup : params.deep_dup[:recurring_hook])
+    end
+    
+    def authenticate_webhook
+      render_status_ok if event.blank? || (event[:livemode] != Rails.env.production?) || (!Spree::Recurring::StripeRecurring::WEBHOOKS.include?(event[:type]))
+    end
+
+    def find_subscription
+      render_status_ok unless @subscription = Spree::User.find_by(stripe_customer_id: event[:data][:object][:customer]).subscription
+    end
+
+    def retrieve_api_event
+      @event = @subscription.provider.retrieve_event(event[:id])
+    end
+
+    def subscription_event_params
+      if retrieve_api_event && event.data.object.customer == @subscription.user.stripe_customer_id
+        { event_id: event.id, request_type: event.type, response: event.to_json }
+      else
+        {}
+      end
+    end
+
+    def render_status_ok
+      render text: '', status: 200
+    end
+
+    def render_status_failure
+      render text: '', status: 403
+    end
+  end
+end