solidus_subscriptions 1.0.0.rc1

data/db/migrate/20160902220242_remove_state_from_solidus_susbscriptions_installment_details.rb

@@ -0,0 +1,5 @@
+class RemoveStateFromSolidusSusbscriptionsInstallmentDetails < SolidusSupport::Migration[4.2]
+  def change
+    remove_column :solidus_subscriptions_installment_details, :state, :string
+  end
+end

data/db/migrate/20160902220604_add_successful_to_solidus_subscriptions_installment_details.rb

@@ -0,0 +1,5 @@
+class AddSuccessfulToSolidusSubscriptionsInstallmentDetails < SolidusSupport::Migration[4.2]
+  def change
+    add_column :solidus_subscriptions_installment_details, :success, :boolean
+  end
+end

data/db/migrate/20160902221218_add_message_to_solidus_subscriptions_installment_details.rb

@@ -0,0 +1,5 @@
+class AddMessageToSolidusSubscriptionsInstallmentDetails < SolidusSupport::Migration[4.2]
+  def change
+    add_column :solidus_subscriptions_installment_details, :message, :string
+  end
+end

data/db/migrate/20160922164101_add_interval_length_and_units_to_subscription_line_items.rb

@@ -0,0 +1,8 @@
+class AddIntervalLengthAndUnitsToSubscriptionLineItems < SolidusSupport::Migration[4.2]
+  def change
+    add_column :solidus_subscriptions_line_items, :interval_units, :integer
+    add_column :solidus_subscriptions_line_items, :interval_length, :integer
+
+    remove_column :solidus_subscriptions_line_items, :interval
+  end
+end

data/db/migrate/20161006191003_add_skip_count_to_solidus_subscriptions_subscriptions.rb

@@ -0,0 +1,5 @@
+class AddSkipCountToSolidusSubscriptionsSubscriptions < SolidusSupport::Migration[4.2]
+  def change
+    add_column :solidus_subscriptions_subscriptions, :skip_count, :integer, default: 0, null: false
+  end
+end

data/db/migrate/20161006191127_add_successive_skip_count_to_solidus_subscriptions_subscriptions.rb

@@ -0,0 +1,5 @@
+class AddSuccessiveSkipCountToSolidusSubscriptionsSubscriptions < SolidusSupport::Migration[4.2]
+  def change
+    add_column :solidus_subscriptions_subscriptions, :successive_skip_count, :integer, default: 0, null: false
+  end
+end

data/db/migrate/20161014212649_allow_spree_line_item_id_to_be_null.rb

@@ -0,0 +1,5 @@
+class AllowSpreeLineItemIdToBeNull < SolidusSupport::Migration[4.2]
+  def change
+    change_column_null :solidus_subscriptions_line_items, :spree_line_item_id, true
+  end
+end

data/db/migrate/20161017155749_add_order_id_to_solidus_subscriptions_installment_details.rb

@@ -0,0 +1,6 @@
+class AddOrderIdToSolidusSubscriptionsInstallmentDetails < SolidusSupport::Migration[4.2]
+  def change
+    add_reference :solidus_subscriptions_installment_details, :order, index: true
+    add_foreign_key :solidus_subscriptions_installment_details, :spree_orders, column: :order_id
+  end
+end

data/db/migrate/20161017175509_remove_order_id_from_solidus_subscriptions_installments.rb

@@ -0,0 +1,5 @@
+class RemoveOrderIdFromSolidusSubscriptionsInstallments < SolidusSupport::Migration[4.2]
+  def change
+    remove_column :solidus_subscriptions_installments, :order_id, :integer
+  end
+end

data/db/migrate/20161017201944_add_subscription_order_to_spree_orders.rb

@@ -0,0 +1,5 @@
+class AddSubscriptionOrderToSpreeOrders < SolidusSupport::Migration[4.2]
+  def change
+    add_column :spree_orders, :subscription_order, :boolean, default: false, null: false
+  end
+end

data/db/migrate/20161221155142_add_store_to_solidus_subscriptions_subscriptions.rb

@@ -0,0 +1,6 @@
+class AddStoreToSolidusSubscriptionsSubscriptions < SolidusSupport::Migration[4.2]
+  def change
+    add_reference :solidus_subscriptions_subscriptions, :store, index: true
+    add_foreign_key :solidus_subscriptions_subscriptions, :spree_stores, column: :store_id
+  end
+end

data/db/migrate/20161223152905_add_address_id_to_solidus_subscriptions_subscriptions.rb

@@ -0,0 +1,7 @@
+class AddAddressIdToSolidusSubscriptionsSubscriptions < SolidusSupport::Migration[4.2]
+  def change
+    add_reference :solidus_subscriptions_subscriptions, :shipping_address
+    add_index :solidus_subscriptions_subscriptions, :shipping_address_id, name: :index_subscription_shipping_address_id
+    add_foreign_key :solidus_subscriptions_subscriptions, :spree_addresses, column: :shipping_address_id
+  end
+end

data/db/migrate/20170106224713_change_line_item_max_installments_to_end_date.rb

@@ -0,0 +1,6 @@
+class ChangeLineItemMaxInstallmentsToEndDate < SolidusSupport::Migration[4.2]
+  def change
+    remove_column :solidus_subscriptions_line_items, :max_installments
+    add_column :solidus_subscriptions_line_items, :end_date, :date
+  end
+end

data/db/migrate/20170111224458_change_subscription_actionable_date_to_datetime.rb

@@ -0,0 +1,5 @@
+class ChangeSubscriptionActionableDateToDatetime < SolidusSupport::Migration[4.2]
+  def change
+    change_column :solidus_subscriptions_subscriptions, :actionable_date, :datetime
+  end
+end

data/db/migrate/20170111232801_change_inteval_actionable_date_to_datetime.rb

@@ -0,0 +1,5 @@
+class ChangeIntevalActionableDateToDatetime < SolidusSupport::Migration[4.2]
+  def change
+    change_column :solidus_subscriptions_installments, :actionable_date, :datetime
+  end
+end

data/db/migrate/20170112012407_add_config_options_to_subscriptions.rb

@@ -0,0 +1,7 @@
+class AddConfigOptionsToSubscriptions < SolidusSupport::Migration[4.2]
+  def change
+    add_column :solidus_subscriptions_subscriptions, :interval_length, :integer
+    add_column :solidus_subscriptions_subscriptions, :interval_units, :integer
+    add_column :solidus_subscriptions_subscriptions, :end_date, :datetime
+  end
+end

data/db/migrate/20200617102749_add_billing_address_to_subscriptions.rb

@@ -0,0 +1,11 @@
+class AddBillingAddressToSubscriptions < ActiveRecord::Migration[5.2]
+  def change
+    add_reference(
+      :solidus_subscriptions_subscriptions,
+      :billing_address,
+      type: :integer,
+      index: { name: :index_subscription_billing_address_id },
+      foreign_key: { to_table: :spree_addresses }
+    )
+  end
+end

data/db/migrate/20200617155042_add_payment_source_to_subscriptions.rb

@@ -0,0 +1,6 @@
+class AddPaymentSourceToSubscriptions < ActiveRecord::Migration[5.2]
+  def change
+    add_column :solidus_subscriptions_subscriptions, :payment_source_type, :string
+    add_column :solidus_subscriptions_subscriptions, :payment_source_id, :integer
+  end
+end

data/db/migrate/20200618092951_add_payment_method_to_subscriptions.rb

@@ -0,0 +1,11 @@
+class AddPaymentMethodToSubscriptions < ActiveRecord::Migration[5.2]
+  def change
+    add_reference(
+      :solidus_subscriptions_subscriptions,
+      :payment_method,
+      type: :integer,
+      index: { name: :index_subscription_payment_method_id },
+      foreign_key: { to_table: :spree_payment_methods }
+    )
+  end
+end

data/db/migrate/20200730101242_create_solidus_subscriptions_subscription_events.rb

@@ -0,0 +1,22 @@
+class CreateSolidusSubscriptionsSubscriptionEvents < ActiveRecord::Migration[5.2]
+  def change
+    create_table :solidus_subscriptions_subscription_events do |t|
+      t.belongs_to(
+        :subscription,
+        null: false,
+        foreign_key: { to_table: :solidus_subscriptions_subscriptions },
+        index: { name: :idx_solidus_subscription_events_on_subscription_id },
+        type: :integer,
+      )
+      t.string :event_type, null: false
+
+      if t.respond_to?(:jsonb)
+        t.jsonb :details, null: false
+      else
+        t.json :details, null: false
+      end
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20200917072152_add_subscription_reference_to_orders.rb

@@ -0,0 +1,11 @@
+class AddSubscriptionReferenceToOrders < ActiveRecord::Migration[5.2]
+  def change
+    add_reference(
+      :spree_orders,
+      :subscription,
+      null: true,
+      type: :integer,
+      foreign_key: { to_table: :solidus_subscriptions_subscriptions }
+    )
+  end
+end

data/db/migrate/20201007140032_add_guest_token_to_subscriptions.rb

@@ -0,0 +1,6 @@
+class AddGuestTokenToSubscriptions < ActiveRecord::Migration[5.2]
+  def change
+    add_column :solidus_subscriptions_subscriptions, :guest_token, :string
+    add_index :solidus_subscriptions_subscriptions, :guest_token, unique: true
+  end
+end

data/db/migrate/20201123171026_change_actionable_date_to_date.rb

@@ -0,0 +1,15 @@
+class ChangeActionableDateToDate < ActiveRecord::Migration[5.2]
+  def change
+    reversible do |dir|
+      dir.up do
+        change_column :solidus_subscriptions_subscriptions, :actionable_date, :date
+        change_column :solidus_subscriptions_installments, :actionable_date, :date
+      end
+
+      dir.down do
+        change_column :solidus_subscriptions_subscriptions, :actionable_date, :datetime
+        change_column :solidus_subscriptions_installments, :actionable_date, :datetime
+      end
+    end
+  end
+end

data/db/migrate/20210205140422_add_currency_to_subscription.rb

@@ -0,0 +1,5 @@
+class AddCurrencyToSubscription < ActiveRecord::Migration[5.2]
+  def change
+    add_column :solidus_subscriptions_subscriptions, :currency, :string
+  end
+end

data/db/migrate/20210323165714_update_promotion_rule_names.rb

@@ -0,0 +1,22 @@
+class UpdatePromotionRuleNames < ActiveRecord::Migration[5.2]
+  TYPE_RENAMES = {
+    'SolidusSubscriptions::SubscriptionPromotionRule' => 'SolidusSubscriptions::Promotion::Rules::SubscriptionCreationOrder',
+    'SolidusSubscriptions::SubscriptionOrderPromotionRule' => 'SolidusSubscriptions::Promotion::Rules::SubscriptionInstallmentOrder',
+  }.freeze
+
+  def change
+    reversible do |dir|
+      dir.up do
+        TYPE_RENAMES.each do |old_type, new_type|
+          Spree::PromotionRule.where(type: old_type).update(type: new_type)
+        end
+      end
+
+      dir.down do
+        TYPE_RENAMES.each do |old_type, new_type|
+          Spree::PromotionRule.where(type: new_type).update(type: old_type)
+        end
+      end
+    end
+  end
+end

data/lib/generators/solidus_subscriptions/install/install_generator.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module SolidusSubscriptions
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('templates', __dir__)
+
+      class_option :auto_run_migrations, type: :boolean, default: false
+
+      def copy_initializer
+        template 'initializer.rb', 'config/initializers/solidus_subscriptions.rb'
+      end
+
+      def add_javascripts
+        append_file 'vendor/assets/javascripts/spree/backend/all.js', "//= require spree/backend/solidus_subscriptions\n"
+      end
+
+      def add_migrations
+        run 'bin/rails railties:install:migrations FROM=solidus_subscriptions'
+      end
+
+      def run_migrations
+        run_migrations = options[:auto_run_migrations] || ['', 'y', 'Y'].include?(ask('Would you like to run the migrations now? [Y/n]'))
+        if run_migrations
+          run 'bin/rails db:migrate'
+        else
+          puts 'Skipping bin/rails db:migrate, don\'t forget to run it!' # rubocop:disable Rails/Output
+        end
+      end
+    end
+  end
+end

data/lib/generators/solidus_subscriptions/install/templates/initializer.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+SolidusSubscriptions.configure do |config|
+  # ========================================= Basic config =========================================
+
+  # The ActiveRecord model users can subscribe to.
+  # config.subscribable_class = 'Spree::Variant'
+
+  # Which queue is responsible for processing subscription background jobs.
+  # config.processing_queue = :default
+
+  # Maximum number of times a user can skip their subscription before it must be processed.
+  # config.maximum_successive_skips = 1
+
+  # Maximum number of times a user can skip their subscription.
+  # config.maximum_total_skips = nil
+
+  # Minimum days between the current date and the next installment for the installment not to be
+  # processed after the user cancels their subscription.
+  # config.minimum_cancellation_notice = 1.day
+
+  # Time between an installment failing to be processed and the system retrying to fulfill it.
+  # config.reprocessing_interval = 1.day
+
+  # Maximum time that can pass after the last succesfull subscription installment to make a payment
+  # failure cancel the subscription.
+  # config.maximum_reprocessing_time = nil
+
+  # This custom error handler is called when a ProcessInstallmentJob `#perform` method fails.
+  # The rescued error can be managed as required via a Proc, such as one which logs the error
+  # on an error tracking system.
+  # Though not recommended due to the retry mechanisms built into this gem, the error can be
+  # re-raised if the default retry behaviour is required in ActiveJob.
+  # config.processing_error_handler = nil
+
+  # ========================================= Dispatchers ==========================================
+  #
+  # These dispatchers are pluggable. If you override any handlers, it is highly encouraged that you
+  # subclass from the the dispatcher you are replacing and call `super` from within `#dispatch`.
+
+  # This handler is called when a subscription order is successfully placed.
+  # config.success_dispatcher_class = 'SolidusSubscriptions::Dispatcher::SuccessDispatcher'
+
+  # This handler is called when a group of installments fails to be processed.
+  # config.failure_dispatcher_class = 'SolidusSubscriptions::Dispatcher::FailureDispatcher'
+
+  # This handler is called when a payment fails on a subscription order.
+  # config.payment_failed_dispatcher_class = 'SolidusSubscriptions::Dispatcher::PaymentFailedDispatcher'
+
+  # This handler is called when there isn't enough stock to fulfill an installment.
+  # config.out_of_stock_dispatcher = 'SolidusSubscriptions::Dispatcher::OutOfStockDispatcher'
+
+  # ===================================== Permitted attributes =====================================
+  #
+  # In this section, you can override the list of attributes the user can pass to the controllers.
+  #
+  # This is useful in the case where certain fields should not be allowed to be modified by the
+  # user, or if you add additional fields to the extension's model and you want the users to be able
+  # to set them.
+
+  # Attributes the user can specify for subscriptions.
+  # config.subscription_attributes = [
+  #   :interval_length,
+  #   :interval_units,
+  #   :end_date,
+  #   shipping_address_attributes: Spree::PermittedAttributes.address_attributes,
+  #   billing_address_attributes: Spree::PermittedAttributes.address_attributes,
+  # ]
+
+  # Attributes the user be specify for subscription line items.
+  # config.subscription_line_item_attributes = [
+  #   :quantity,
+  #   :subscribable_id,
+  #   :interval_length,
+  #   :interval_units,
+  #   :end_date,
+  # ]
+
+  # ========================================= Churn Buster =========================================
+  #
+  # This extension can integrate with Churn Buster for churn mitigation and failed payment recovery.
+  # If you want to integrate with Churn Buster, simply configure your credentials below.
+  #
+  # NOTE: If you integrate with Churn Buster and override any of the handlers, make sure to call
+  # `super` or copy-paste the original integration code or things won't work!
+
+  # Your Churn Buster account ID.
+  # config.churn_buster_account_id = 'YOUR_CHURN_BUSTER_ACCOUNT_ID'
+
+  # Your Churn Buster API key.
+  # config.churn_buster_api_key = 'YOUR_CHURN_BUSTER_API_KEY'
+
+  # =================================== Clear past installments ====================================
+  #
+  # This setting prevents the overlap of old failed installments (e.g. for an expired credit card)
+  # with new subscription cycles by clearing any past failed installment when a new one is created
+
+  # config.clear_past_installments = true
+end

data/lib/solidus_subscriptions.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'solidus_core'
+require 'solidus_support'
+
+require 'deface'
+require 'httparty'
+require 'state_machines'
+
+require 'solidus_subscriptions/configuration'
+require 'solidus_subscriptions/permission_sets/default_customer'
+require 'solidus_subscriptions/permission_sets/subscription_management'
+require 'solidus_subscriptions/version'
+require 'solidus_subscriptions/engine'
+require 'solidus_subscriptions/churn_buster/client'
+require 'solidus_subscriptions/churn_buster/serializer'
+require 'solidus_subscriptions/churn_buster/subscription_customer_serializer'
+require 'solidus_subscriptions/churn_buster/subscription_payment_method_serializer'
+require 'solidus_subscriptions/churn_buster/subscription_serializer'
+require 'solidus_subscriptions/churn_buster/order_serializer'
+require 'solidus_subscriptions/checkout'
+require 'solidus_subscriptions/subscription_generator'
+require 'solidus_subscriptions/subscription_line_item_builder'
+require 'solidus_subscriptions/dispatcher/base'
+require 'solidus_subscriptions/dispatcher/failure_dispatcher'
+require 'solidus_subscriptions/dispatcher/out_of_stock_dispatcher'
+require 'solidus_subscriptions/dispatcher/payment_failed_dispatcher'
+require 'solidus_subscriptions/dispatcher/success_dispatcher'
+
+module SolidusSubscriptions
+  class << self
+    def configure
+      yield configuration
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def churn_buster
+      return unless configuration.churn_buster?
+
+      @churn_buster ||= ChurnBuster::Client.new(
+        account_id: SolidusSubscriptions.configuration.churn_buster_account_id,
+        api_key: SolidusSubscriptions.configuration.churn_buster_api_key,
+      )
+    end
+  end
+end

data/lib/solidus_subscriptions/checkout.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module SolidusSubscriptions
+  class Checkout
+    attr_reader :installment
+
+    def initialize(installment)
+      @installment = installment
+    end
+
+    def process
+      order = create_order
+
+      begin
+        populate_order(order)
+        finalize_order(order)
+
+        SolidusSubscriptions.configuration.success_dispatcher_class.new(installment, order).dispatch
+      rescue StateMachines::InvalidTransition
+        if order.payments.any?(&:failed?)
+          SolidusSubscriptions.configuration.payment_failed_dispatcher_class.new(installment, order).dispatch
+        else
+          SolidusSubscriptions.configuration.failure_dispatcher_class.new(installment, order).dispatch
+        end
+      rescue ::Spree::Order::InsufficientStock
+        SolidusSubscriptions.configuration.out_of_stock_dispatcher_class.new(installment, order).dispatch
+      end
+
+      order
+    end
+
+    private
+
+    def create_order
+      ::Spree::Order.create(
+        user: installment.subscription.user,
+        email: installment.subscription.user.email,
+        store: installment.subscription.store || ::Spree::Store.default,
+        subscription_order: true,
+        subscription: installment.subscription,
+        currency: installment.subscription.currency
+      )
+    end
+
+    def populate_order(order)
+      installment.subscription.line_items.each do |line_item|
+        order.contents.add(line_item.subscribable, line_item.quantity)
+      end
+    end
+
+    def finalize_order(order)
+      ::Spree::PromotionHandler::Cart.new(order).activate
+      order.recalculate
+
+      order.checkout_steps[0...-1].each do
+        case order.state
+        when 'address'
+          order.ship_address = installment.subscription.shipping_address_to_use
+          order.bill_address = installment.subscription.billing_address_to_use
+        when 'payment'
+          order.payments.create(
+            payment_method: installment.subscription.payment_method_to_use,
+            source: installment.subscription.payment_source_to_use,
+            amount: order.total,
+          )
+        end
+
+        order.next!
+      end
+
+      order.complete!
+    end
+  end
+end