spree_stripe_subscriptions 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9085cdba71a500882f7360cb06f86ef9d9ee5617c52440e6c02c57e8a04218d6
+  data.tar.gz: d4891c7b4184367479b884b3cb740273b62d5fbcb1a18de4e3eb5ebeb81953db
+SHA512:
+  metadata.gz: 693ad9f3a7739fdd12d52410ec29ecc0036106cea56e4ee2edef986ff53e64ec5ddfc40184c03f9945eabe15c112f0aa5e2ddd252a2f351f2fe2861eaecfbecd
+  data.tar.gz: 5f4d4c7ba7b99676bd735834178a6aaf4f28f7793d13eaa465d2dd9fe3b7daa15b8fa5ae158fdd3659f1c1917e9fe4345baaef8948f74c7d9e02033b4969c91a

data/.gitignore

@@ -0,0 +1,91 @@
+*.rbc
+capybara-*.html
+.rspec
+/db/*.sqlite3
+/db/*.sqlite3-journal
+/db/*.sqlite3-[0-9]*
+/public/system
+/coverage/
+/spec/tmp
+*.orig
+rerun.txt
+pickle-email-*.html
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+
+# TODO Comment out this rule if you are OK with secrets being uploaded to the repo
+config/initializers/secret_token.rb
+config/master.key
+
+# Only include if you have production secrets in this file, which is no longer a Rails default
+# config/secrets.yml
+
+# dotenv
+# TODO Comment out this rule if environment variables can be committed
+.env
+
+## Environment normalization:
+/.bundle
+/vendor/bundle
+
+# these should all be checked in to normalize the environment:
+# Gemfile.lock, .ruby-version, .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# if using bower-rails ignore default bower_components path bower.json files
+/vendor/assets/bower_components
+*.bowerrc
+bower.json
+
+# Ignore pow environment settings
+.powenv
+
+# Ignore Byebug command history file.
+.byebug_history
+
+# Ignore node_modules
+node_modules/
+
+# Ignore precompiled javascript packs
+/public/packs
+/public/packs-test
+/public/assets
+
+# Ignore yarn files
+/yarn-error.log
+yarn-debug.log*
+.yarn-integrity
+
+# Ignore uploaded files in development
+/storage/*
+!/storage/.keep
+
+# From Spree Extension
+\#*
+*~
+.#*
+.DS_Store
+.idea
+.localeapp/locales
+.project
+.vscode
+coverage
+default
+Gemfile.lock
+tmp
+nbproject
+pkg
+*.sw?
+spec/dummy
+.sass-cache
+public/spree
+.ruby-version
+.ruby-gemset
+*.gem
+*/*.gem

data/.rubocop.yml

@@ -0,0 +1,26 @@
+require: rubocop-rails
+
+AllCops:
+  DisplayCopNames: true
+  TargetRubyVersion: 2.5
+  Include:
+    - '**/Gemfile'
+    - '**/Rakefile'
+    - '**/Appraisals'
+  Exclude:
+    - 'spec/dummy/**/*'
+    - 'lib/generators/**/*'
+
+Rails:
+  Enabled: true
+
+Layout/LineLength:
+  Max: 150
+
+# DISABLED
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,37 @@
+os: linux
+dist: bionic
+
+addons:
+  apt:
+    sources:
+      - google-chrome
+    packages:
+      - google-chrome-stable
+
+services:
+  - mysql
+  - postgresql
+
+language: ruby
+
+rvm:
+  - 2.7
+  - 3.0
+
+env:
+  - DB=mysql
+  - DB=postgres
+
+before_install:
+  - mysql -u root -e "GRANT ALL ON *.* TO 'travis'@'%';"
+
+before_script:
+  - CHROME_MAIN_VERSION=`google-chrome-stable --version | sed -E 's/(^Google Chrome |\.[0-9]+ )//g'`
+  - CHROMEDRIVER_VERSION=`curl -s "https://chromedriver.storage.googleapis.com/LATEST_RELEASE_$CHROME_MAIN_VERSION"`
+  - curl "https://chromedriver.storage.googleapis.com/${CHROMEDRIVER_VERSION}/chromedriver_linux64.zip" -O
+  - unzip chromedriver_linux64.zip -d ~/bin
+  - nvm install 16
+
+script:
+  - bundle exec rake test_app
+  - bundle exec rspec

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+git_source(:github) do |repo_name|
+  repo_name = "#{repo_name}/#{repo_name}" unless repo_name.include?('/')
+  "https://github.com/#{repo_name}.git"
+end
+
+# gem 'spree', github: 'spree/spree', branch: 'main'
+# gem 'spree_backend', github: 'spree/spree', branch: 'main'
+gem 'rails-controller-testing'
+
+gemspec

data/LICENSE

@@ -0,0 +1,26 @@
+Copyright (c) 2022 [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,72 @@
+# SpreeStripeSubscriptions
+
+Spree extension to manage stripe subscriptions using Stripe Checkout Session.
+
+## Installation
+
+1. Add this extension to your Gemfile with this line:
+
+    ```ruby
+    gem 'spree_stripe_subscriptions'
+    ```
+
+2. Install the gem using Bundler
+
+    ```ruby
+    bundle install
+    ```
+
+3. Copy & run migrations
+
+    ```ruby
+    bundle exec rails g spree_stripe_subscriptions:install
+    ```
+
+4. Restart your server
+
+  If your server was running, restart it so that it can find the assets properly.
+
+## Configurations
+
+### Customise Stripe Plans URL
+
+To use customise URls, you can set the following configurations:
+
+```ruby
+# In initializers/spree_stripe_subscriptions.rb
+SpreeStripeSubscriptions::Config.stripe_plans_path = 'pricing' # Default url is 'stripe_plans'
+SpreeStripeSubscriptions::Config.stripe_webhooks_path = 'webhook' # Default url is 'stripe_webhooks'
+```
+
+## Testing
+
+First bundle your dependencies, then run `rake`. `rake` will default to building the dummy app if it does not exist, then it will run specs. The dummy app can be regenerated by using `rake test_app`.
+
+```shell
+bundle update
+bundle exec rake
+```
+
+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_stripe_subscriptions/factories'
+```
+
+## Releasing
+
+```shell
+bundle exec gem bump -p -t
+bundle exec gem release
+```
+
+For more options please see [gem-release REAMDE](https://github.com/svenfuchs/gem-release)
+
+## Contributing
+
+If you'd like to contribute, please take a look at the
+[instructions](CONTRIBUTING.md) for installing dependencies and crafting a good
+pull request.
+
+Copyright (c) 2022 [name of extension creator], released under the New BSD License

data/Rakefile

@@ -0,0 +1,21 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+require 'spree/testing_support/extension_rake'
+
+RSpec::Core::RakeTask.new
+
+task :default do
+  if Dir['spec/dummy'].empty?
+    Rake::Task[:test_app].invoke
+    Dir.chdir('../../')
+  end
+  Rake::Task[:spec].invoke
+end
+
+desc 'Generates a dummy app for testing'
+task :test_app do
+  ENV['LIB_NAME'] = 'spree_stripe_subscriptions'
+  Rake::Task['extension:test_app'].invoke
+end

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

@@ -0,0 +1,6 @@
+module Spree
+  module Admin
+    class StripeConfigurationsController < Spree::Admin::ResourceController
+    end
+  end
+end

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

@@ -0,0 +1,6 @@
+module Spree
+  module Admin
+    class StripeCustomersController < Spree::Admin::ResourceController
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+module Spree
+  module Admin
+    class StripePlansController < Spree::Admin::ResourceController
+      before_action :load_strip_configuration
+
+      def new
+        @stripe_plan = @stripe_configuration.stripe_plans.build
+      end
+
+      def collection
+        super.reorder(:weightage)
+      end
+
+      def collection_url
+        spree.admin_stripe_configuration_stripe_plans_url(@stripe_configuration)
+      end
+
+      def new_object_url
+        spree.new_admin_stripe_configuration_stripe_plan_url(@stripe_configuration)
+      end
+
+      private
+
+      def stripe_configuration
+        @stripe_configuration ||= Spree::StripeConfiguration.where(id: params[:stripe_configuration_id]).first
+      end
+
+      def load_strip_configuration
+        return if stripe_configuration
+
+        flash[:error] = I18n.t('spree_stripe_subscriptions.errors.stripe_configuration_doesnt_exist')
+        redirect_to admin_stripe_configurations_path
+      end
+    end
+  end
+end

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

@@ -0,0 +1,6 @@
+module Spree
+  module Admin
+    class StripeSubscriptionEventsController < Spree::Admin::ResourceController
+    end
+  end
+end

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

@@ -0,0 +1,6 @@
+module Spree
+  module Admin
+    class StripeSubscriptionsController < Spree::Admin::ResourceController
+    end
+  end
+end

data/app/controllers/spree/stripe_plans_controller.rb

@@ -0,0 +1,20 @@
+module Spree
+  class StripePlansController < StoreController
+    before_action :load_active_plans, only: :index
+    before_action :load_user_subscriptions, only: :index
+
+    def index; end
+
+    private
+
+    def load_active_plans
+      @stripe_plans = Spree::StripePlan.active.order(:weightage)
+    end
+
+    def load_user_subscriptions
+      @active_subscription = if spree_current_user.present?
+                               spree_current_user.stripe_subscriptions.active.last
+                             end
+    end
+  end
+end

data/app/controllers/spree/stripe_subscriptions_controller.rb

@@ -0,0 +1,166 @@
+module Spree
+  class StripeSubscriptionsController < StoreController
+    before_action :login_required
+    before_action :load_stripe_plan
+    before_action :load_stripe_configuration
+    before_action :ensure_stripe_plan_exist
+    before_action :ensure_stripe_customer_exist
+    before_action :load_stripe_subscription, only: [:update, :destroy, :change_payment_details, :update_payment_details]
+    before_action :ensure_active_subscription, only: :downgrade
+
+    def create
+      checkout_session = Stripe::Checkout::Session.create(
+        mode: 'subscription',
+        customer: @stripe_customer.id,
+        customer_update: { address: 'auto', name: 'auto' },
+        client_reference_id: spree_current_user.id,
+        line_items: [
+          {
+            'price': @stripe_plan.id,
+            'quantity': 1
+          }
+        ],
+        automatic_tax: { enabled: @configuration.automatic_tax },
+        tax_id_collection: { enabled: @configuration.tax_id_collection },
+        billing_address_collection: @configuration.billing_address_collection,
+        success_url: stripe_plans_url,
+        cancel_url: stripe_plans_url
+      )
+      redirect_to checkout_session.url
+    rescue StandardError => e
+      Rails.logger.error e.message
+      flash[:error] = e.message
+      redirect_to stripe_plans_path
+    end
+
+    def update
+      @subscription.cancel_renewal
+      flash[:success] = I18n.t('spree_stripe_subscriptions.messages.success.successfully_canceled_renewal')
+      redirect_to stripe_plans_path
+    end
+
+    def change_payment_details
+      checkout_session = Stripe::Checkout::Session.create(
+        payment_method_types: ['card'],
+        mode: 'setup',
+        customer: @stripe_customer.id,
+        setup_intent_data: {
+          metadata: {
+            subscription_id: @subscription.stripe_subscription_id
+          }
+        },
+        success_url: "#{update_payment_details_stripe_plan_stripe_subscription_url(@plan, @subscription)}?session_id={CHECKOUT_SESSION_ID}",
+        cancel_url: stripe_plans_url
+      )
+      redirect_to checkout_session.url
+    rescue StandardError => e
+      Rails.logger.error e.message
+      flash[:error] = e.message
+      redirect_to stripe_plans_path
+    end
+
+    def update_payment_details
+      return unless (session_id = params[:session_id])
+
+      checkout_session = Stripe::Checkout::Session.retrieve(session_id)
+      setup_intent = Stripe::SetupIntent.retrieve(checkout_session.setup_intent)
+
+      # Set invoice_settings.default_payment_method on the Customer
+      Stripe::Customer.update(
+        @stripe_customer.id,
+        { invoice_settings: { default_payment_method: setup_intent.payment_method } }
+      )
+
+      # Set default_payment_method on the Subscription
+      Stripe::Subscription.update(
+        @subscription.stripe_subscription_id,
+        {
+          default_payment_method: setup_intent.payment_method
+        }
+      )
+
+      flash[:success] = I18n.t('spree_stripe_subscriptions.messages.success.successfully_updated')
+      redirect_to stripe_plans_path
+    rescue StandardError => e
+      Rails.logger.error e.message
+      flash[:error] = e.message
+      redirect_to stripe_plans_path
+    end
+
+    def downgrade
+      active_subscription = spree_current_user.stripe_subscriptions.active.find(params[:id])
+      destination_plan = Spree::StripePlan.active.find(params[:stripe_plan_id])
+
+      subscription_schedule = active_subscription.stripe_subscription_schedule
+
+      if subscription_schedule.present?
+        Stripe::SubscriptionSchedule.update(
+          subscription_schedule.id,
+          {
+            phases: [
+              {
+                items: [
+                  { price: active_subscription.plan.stripe_plan_id, quantity: 1 }
+                ],
+                start_date: active_subscription.current_period_start.to_i,
+                end_date: active_subscription.current_period_end.to_i
+              },
+              {
+                items: [
+                  { price: destination_plan.stripe_plan_id, quantity: 1 }
+                ],
+                start_date: active_subscription.current_period_end.to_i,
+                # end_date: active_subscription.current_period_end.to_i + 1.month.to_i
+              }
+            ]
+          }
+        )
+        flash[:success] = I18n.t('spree_stripe_subscriptions.messages.success.successfully_downgraded')
+        redirect_to stripe_plans_path
+      else
+        flash[:alert] = I18n.t('spree_stripe_subscriptions.messages.errors.cannot_process_request')
+        redirect_to stripe_plans_path
+      end
+    end
+
+    def destroy
+      @subscription.unsubscribe
+      flash[:success] = I18n.t('spree_stripe_subscriptions.messages.success.successfully_unsubscribed')
+      redirect_to stripe_plans_path
+    end
+
+    private
+
+    def login_required
+      raise CanCan::AccessDenied if spree_current_user.blank?
+    end
+
+    def load_stripe_plan
+      @plan = Spree::StripePlan.active.find(params[:stripe_plan_id])
+    end
+
+    def load_stripe_configuration
+      @configuration = @plan.configuration
+    end
+
+    def ensure_active_subscription
+      return if spree_current_user.stripe_subscriptions.active.exists?
+
+      flash[:alert] = I18n.t('spree_stripe_subscriptions.messages.errors.no_active_subscription')
+      redirect_to stripe_plans_path
+    end
+
+    def ensure_stripe_customer_exist
+      @stripe_customer = spree_current_user.find_or_create_stripe_customer
+    end
+
+    def ensure_stripe_plan_exist
+      @stripe_plan = @plan.find_or_create_stripe_plan
+      raise CanCan::AccessDenied if @stripe_plan.nil?
+    end
+
+    def load_stripe_subscription
+      @subscription = @plan.stripe_subscriptions.find(params[:id])
+    end
+  end
+end

data/app/controllers/spree/stripe_webhooks_controller.rb

@@ -0,0 +1,56 @@
+# Ref: https://github.com/stripe-samples/checkout-foundations-ruby/blob/main/server.rb
+
+module Spree
+  class StripeWebhooksController < BaseController
+    skip_before_action :verify_authenticity_token
+
+    before_action :load_stripe_configuration
+
+    respond_to :json
+
+    def handler
+      sig_header = request.env['HTTP_STRIPE_SIGNATURE']
+      payload = request.body.read
+
+      event = Stripe::Webhook.construct_event(
+        payload, sig_header, @stripe_configuration.preferred_webhook_secret
+      )
+
+      if event.present? && (%w[customer.subscription.updated customer.subscription.deleted].include? event.type)
+        subscription = Spree::StripeSubscription.create_or_update_subscription(event)
+        subscription.register_webhook_event(event)
+      elsif event.present? && (%w[subscription_schedule.updated].include? event.type)
+        subscription = Spree::StripeSubscription.update_subscription_schedule(event)
+        subscription.register_webhook_event(event) if subscription.present?
+      elsif event.present? && (%w[invoice.paid].include? event.type)
+        subscription = Spree::StripeSubscription.create_or_update_invoice(event)
+        subscription.register_webhook_event(event) if subscription.present?
+      else
+        Rails.logger.warn "Unhandled event type: #{event&.type}"
+      end
+
+      render json: { success: true }, status: :ok
+    rescue JSON::ParserError => e
+      # Invalid payload
+      Rails.logger.error e
+      render json: { success: false }, status: :not_found
+    rescue Stripe::SignatureVerificationError => e
+      # invalid signature
+      Rails.logger.error e
+      render json: { success: false }, status: :not_found
+    rescue ActiveRecord::RecordNotFound => e
+      # Either StripeCustomer or StripePlan doesn't exist in our records
+      Rails.logger.error e
+      render json: { success: false }, status: :ok
+    end
+
+    private
+
+    def load_stripe_configuration
+      @stripe_configuration = Spree::StripeConfiguration.active.last
+      return if @stripe_configuration.present? && @stripe_configuration.preferred_keys_available?
+
+      render json: { success: false }, status: :not_found
+    end
+  end
+end

data/app/models/spree/stripe_configuration.rb

@@ -0,0 +1,28 @@
+module Spree
+  class StripeConfiguration < Spree::Base
+    acts_as_paranoid
+
+    preference :secret_key, :string
+    preference :public_key, :string
+    preference :webhook_secret, :string
+
+    ADDRESS_COLLECTION_OPTIONS = {
+      'auto' => 'auto',
+      'required' => 'required'
+    }.freeze
+
+    validates :billing_address_collection, inclusion: { in: ADDRESS_COLLECTION_OPTIONS.keys }
+
+    has_many :stripe_plans,
+             class_name: 'Spree::StripePlan',
+             foreign_key: :configuration_id,
+             inverse_of: :configuration,
+             dependent: :restrict_with_error
+
+    scope :active, -> { where(active: true) }
+
+    def preferred_keys_available?
+      preferred_secret_key.present? && preferred_public_key.present? && preferred_webhook_secret.present?
+    end
+  end
+end

data/app/models/spree/stripe_customer.rb

@@ -0,0 +1,30 @@
+module Spree
+  class StripeCustomer < Spree::Base
+    acts_as_paranoid
+
+    belongs_to :user, class_name: Spree.user_class.to_s
+
+    has_many :stripe_subscriptions,
+             class_name: 'Spree::StripeSubscription',
+             foreign_key: :customer_id,
+             inverse_of: :customer,
+             dependent: :restrict_with_error
+    has_many :stripe_invoices,
+             class_name: 'Spree::StripeInvoice',
+             foreign_key: :customer_id,
+             inverse_of: :customer,
+             dependent: :restrict_with_error
+
+    def stripe_customer
+      stripe_customer = nil
+      return nil if deleted_at.present?
+
+      stripe_customer = Stripe::Customer.retrieve(stripe_customer_id)
+    rescue StandardError
+      destroy
+      stripe_customer = nil
+    ensure
+      stripe_customer
+    end
+  end
+end