solidus_subscriptions 1.0.0.rc1 → 1.0.1

data/config/routes.rb

@@ -8,6 +8,8 @@ SolidusSubscriptions::Engine.routes.draw do
         member do
           post :cancel
           post :skip
+          post :pause
+          post :resume
         end
       end
     end
@@ -19,9 +21,13 @@ Spree::Core::Engine.routes.draw do
 
   namespace :admin do
     resources :subscriptions, only: [:index, :new, :create, :edit, :update] do
-      delete :cancel, on: :member
-      post :activate, on: :member
-      post :skip, on: :member
+      member do
+        delete :cancel
+        post :activate
+        post :skip
+        post :pause
+        post :resume
+      end
       resources :installments, only: [:index, :show]
       resources :subscription_events, only: :index
       resources :subscription_orders, path: :orders, only: :index

data/db/migrate/20210905145955_add_paused_to_subscriptions.rb

@@ -0,0 +1,5 @@
+class AddPausedToSubscriptions < ActiveRecord::Migration[5.2]
+  def change
+    add_column :solidus_subscriptions_subscriptions, :paused, :boolean, default: false
+  end
+end

data/{app/decorators → lib/decorators/api}/controllers/solidus_subscriptions/spree/api/line_items_controller/create_subscription_line_items.rb

@@ -27,6 +27,20 @@ module SolidusSubscriptions
           def handle_subscription_line_items
             create_subscription_line_item(@line_item)
           end
+
+          def line_items_attributes
+            super.tap do |attrs|
+              if params[:subscription_line_items_attributes]
+                attrs[:line_items_attributes].merge!(
+                  subscription_line_items_attributes: subscription_line_item_params
+                )
+              end
+            end
+          end
+
+          def subscription_line_item_params
+            params[:subscription_line_items_attributes].permit(SolidusSubscriptions::PermittedAttributes.subscription_line_item_attributes)
+          end
         end
       end
     end

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

@@ -6,6 +6,7 @@ module SolidusSubscriptions
       source_root File.expand_path('templates', __dir__)
 
       class_option :auto_run_migrations, type: :boolean, default: false
+      class_option :frontend, type: :string, default: 'classic'
 
       def copy_initializer
         template 'initializer.rb', 'config/initializers/solidus_subscriptions.rb'
@@ -15,6 +16,21 @@ module SolidusSubscriptions
         append_file 'vendor/assets/javascripts/spree/backend/all.js', "//= require spree/backend/solidus_subscriptions\n"
       end
 
+      def copy_starter_frontend_files
+        return if options[:frontend] != 'starter'
+
+        copy_file 'app/views/cart_line_items/_subscription_fields.html.erb'
+        prepend_to_file 'app/views/cart_line_items/_product_submit.html.erb', "<%= render 'cart_line_items/subscription_fields' %>\n"
+
+        copy_file 'app/controllers/concerns/create_subscription.rb'
+        insert_into_file 'app/controllers/cart_line_items_controller.rb', after: "class CartLineItemsController < StoreController\n" do
+          <<~RUBY.indent(2)
+            include CreateSubscription
+
+          RUBY
+        end
+      end
+
       def add_migrations
         run 'bin/rails railties:install:migrations FROM=solidus_subscriptions'
       end

data/lib/generators/solidus_subscriptions/install/templates/app/controllers/concerns/create_subscription.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module CreateSubscription
+  extend ActiveSupport::Concern
+  include SolidusSubscriptions::SubscriptionLineItemBuilder
+
+  included do
+    after_action :handle_subscription_line_items, only: :create, if: ->{ params[:subscription_line_item] }
+  end
+
+  private
+
+  def handle_subscription_line_items
+    line_item = @current_order.line_items.find_by(variant_id: params[:variant_id])
+    create_subscription_line_item(line_item)
+  end
+end

data/lib/generators/solidus_subscriptions/install/templates/app/views/cart_line_items/_subscription_fields.html.erb

@@ -0,0 +1,30 @@
+<%= content_tag :h3, t('.subscription_fields') %>
+<%= fields_for :'subscription_line_item', SolidusSubscriptions::LineItem.new do |ff| %>
+  <div>
+    <%= ff.label :quantity, t('.quantity') %>
+    <%= ff.number_field :quantity %>
+    <%= ff.label :quantity, t('.quantity_suffix') %>
+  </div>
+
+  <div>
+    <%= ff.label :interval_length, t('.interval_length') %>
+    <%= ff.number_field :interval_length %>
+
+    <%= ff.collection_radio_buttons :interval_units, SolidusSubscriptions::LineItem.interval_units.to_a, :first, :first %>
+  </div>
+
+  <%= ff.hidden_field :subscribable_id %>
+<% end %>
+
+<script>
+  document.addEventListener("DOMContentLoaded", function(e) {
+    var cartForm = document.querySelector('.product-page__info form');
+    cartForm.addEventListener('submit', function(e) {
+      var quantityInput = e.target.querySelector('[name*="quantity"]');
+      var subscriptionQuantityInput = e.target.querySelector('[name*="subscribable_id"]');
+
+      subscriptionQuantityInput.value = quantityInput.value;
+      return true;
+    });
+  });
+</script>

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

@@ -31,7 +31,9 @@ SolidusSubscriptions.configure do |config|
   # 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
+  #
+  # By default, it only logs the error message using Rails.logger.error.
+  # config.processing_error_handler = SolidusSubscriptions::ProcessingErrorHandlers::RailsLogger
 
   # ========================================= Dispatchers ==========================================
   #
@@ -96,4 +98,17 @@ SolidusSubscriptions.configure do |config|
   # with new subscription cycles by clearing any past failed installment when a new one is created
 
   # config.clear_past_installments = true
+
+  # ==================================== Custom Order Creation =====================================
+  #
+  # This settings allows the customization of the creation of each Installment Order by means of
+  # providing a class that can be switched / inherited
+  #
+  #
+  # the order_creator_class is initialized and called on the creation of the Order for each Subscription
+  # Installment.
+  # If you want to add simple extra attributes to the Order (such as a channel), that can be done by
+  # overriding the `extra_attributes` method on a subclass
+  #
+  # config.order_creator_class = 'SolidusSubscriptions::OrderCreator'
 end

data/lib/solidus_subscriptions/checkout.rb

@@ -32,14 +32,7 @@ module SolidusSubscriptions
     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
-      )
+      SolidusSubscriptions.configuration.order_creator_class.new(installment).call
     end
 
     def populate_order(order)
@@ -61,7 +54,7 @@ module SolidusSubscriptions
           order.payments.create(
             payment_method: installment.subscription.payment_method_to_use,
             source: installment.subscription.payment_source_to_use,
-            amount: order.total,
+            amount: order.total
           )
         end
 

data/lib/solidus_subscriptions/configuration.rb

@@ -3,17 +3,35 @@
 module SolidusSubscriptions
   class Configuration
     attr_accessor(
-      :maximum_total_skips, :maximum_reprocessing_time, :churn_buster_account_id,
-      :churn_buster_api_key, :clear_past_installments, :processing_error_handler,
+      :churn_buster_account_id,
+      :churn_buster_api_key,
+      :clear_past_installments,
+      :maximum_reprocessing_time,
+      :maximum_total_skips,
     )
 
     attr_writer(
-      :success_dispatcher_class, :failure_dispatcher_class, :payment_failed_dispatcher_class,
-      :out_of_stock_dispatcher, :maximum_successive_skips, :reprocessing_interval,
-      :minimum_cancellation_notice, :processing_queue, :subscription_line_item_attributes,
-      :subscription_attributes, :subscribable_class,
+      :failure_dispatcher_class,
+      :maximum_successive_skips,
+      :minimum_cancellation_notice,
+      :order_creator_class,
+      :out_of_stock_dispatcher,
+      :payment_failed_dispatcher_class,
+      :processing_error_handler,
+      :processing_queue,
+      :reprocessing_interval,
+      :subscribable_class,
+      :subscription_attributes,
+      :subscription_generator_class,
+      :subscription_line_item_attributes,
+      :success_dispatcher_class,
     )
 
+    def subscription_generator_class
+      @subscription_generator_class ||= 'SolidusSubscriptions::SubscriptionGenerator'
+      @subscription_generator_class.constantize
+    end
+
     def success_dispatcher_class
       @success_dispatcher_class ||= 'SolidusSubscriptions::Dispatcher::SuccessDispatcher'
       @success_dispatcher_class.constantize
@@ -34,6 +52,11 @@ module SolidusSubscriptions
       @out_of_stock_dispatcher_class.constantize
     end
 
+    def processing_error_handler
+      @processing_error_handler ||= 'SolidusSubscriptions::ProcessingErrorHandlers::RailsLogger'
+      @processing_error_handler.constantize
+    end
+
     def maximum_successive_skips
       @maximum_successive_skips ||= 1
     end
@@ -52,11 +75,12 @@ module SolidusSubscriptions
 
     def subscription_line_item_attributes
       @subscription_line_item_attributes ||= [
+        :id,
         :quantity,
         :subscribable_id,
         :interval_length,
         :interval_units,
-        :end_date,
+        :end_date
       ]
     end
 
@@ -68,7 +92,7 @@ module SolidusSubscriptions
         {
           shipping_address_attributes: Spree::PermittedAttributes.address_attributes,
           billing_address_attributes: Spree::PermittedAttributes.address_attributes
-        },
+        }
       ]
     end
 
@@ -80,5 +104,10 @@ module SolidusSubscriptions
     def churn_buster?
       churn_buster_account_id.present? && churn_buster_api_key.present?
     end
+
+    def order_creator_class
+      @order_creator_class ||= 'SolidusSubscriptions::OrderCreator'
+      @order_creator_class.constantize
+    end
   end
 end

data/lib/solidus_subscriptions/dispatcher/payment_failed_dispatcher.rb

@@ -8,8 +8,8 @@ module SolidusSubscriptions
         order.cancel
         installment.payment_failed!(order)
 
-        ::Spree::Event.fire(
-          'solidus_subscriptions.installment_failed_payment',
+        ::SolidusSupport::LegacyEventCompat::Bus.publish(
+          :'solidus_subscriptions.installment_failed_payment',
           installment: installment,
           order: order,
         )

data/lib/solidus_subscriptions/dispatcher/success_dispatcher.rb

@@ -6,8 +6,8 @@ module SolidusSubscriptions
       def dispatch
         installment.success!(order)
 
-        ::Spree::Event.fire(
-          'solidus_subscriptions.installment_succeeded',
+        ::SolidusSupport::LegacyEventCompat::Bus.publish(
+          :'solidus_subscriptions.installment_succeeded',
           installment: installment,
           order: order,
         )

data/lib/solidus_subscriptions/engine.rb

@@ -6,6 +6,7 @@ require 'solidus_subscriptions'
 require 'solidus_subscriptions/permitted_attributes'
 require 'solidus_subscriptions/configuration'
 require 'solidus_subscriptions/processor'
+require 'solidus_subscriptions/processing_error_handlers/rails_logger'
 
 module SolidusSubscriptions
   class Engine < Rails::Engine
@@ -48,6 +49,33 @@ module SolidusSubscriptions
         )
       end
     end
+
+    initializer 'solidus_subscriptions.pub_sub' do |app|
+      unless SolidusSupport::LegacyEventCompat.using_legacy?
+        app.reloader.to_prepare do
+          %i[
+            subscription_created
+            subscription_activated
+            subscription_canceled
+            subscription_ended
+            subscription_skipped
+            subscription_resumed
+            subscription_paused
+            subscription_frequency_changed
+            subscription_shipping_address_changed
+            subscription_billing_address_changed
+            installment_succeeded
+            installment_failed_payment
+            subscription_payment_method_changed
+          ].each do |event_name|
+            ::Spree::Bus.register(:"solidus_subscriptions.#{event_name}")
+          end
+          SolidusSubscriptions::ChurnBusterSubscriber.omnes_subscriber.subscribe_to(::Spree::Bus)
+          SolidusSubscriptions::EventStorageSubscriber.omnes_subscriber.subscribe_to(::Spree::Bus)
+          SolidusSubscriptions::OrderSubscriber.omnes_subscriber.subscribe_to(::Spree::Bus)
+        end
+      end
+    end
   end
 
   def self.table_name_prefix

data/lib/solidus_subscriptions/order_creator.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module SolidusSubscriptions
+  class OrderCreator
+    def initialize(installment)
+      @installment = installment
+    end
+
+    def call
+      ::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,
+        **extra_attributes
+      )
+    end
+
+    private
+
+    def extra_attributes
+      {}
+    end
+
+    attr_reader :installment
+  end
+end

data/lib/solidus_subscriptions/permission_sets/default_customer.rb

@@ -4,7 +4,7 @@ module SolidusSubscriptions
   module PermissionSets
     class DefaultCustomer < ::Spree::PermissionSets::Base
       def activate!
-        can [:show, :display, :update, :skip, :cancel], Subscription, ['user_id = ?', user.id] do |subscription, guest_token|
+        can [:show, :display, :update, :skip, :cancel, :pause, :resume], Subscription, ['user_id = ?', user.id] do |subscription, guest_token|
           (subscription.guest_token.present? && subscription.guest_token == guest_token) ||
             (subscription.user && subscription.user == user)
         end

data/lib/solidus_subscriptions/processing_error_handlers/rails_logger.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module SolidusSubscriptions
+  module ProcessingErrorHandlers
+    class RailsLogger
+      def self.call(exception, installment = nil)
+        new(exception, installment).call
+      end
+
+      def initialize(exception, installment = nil)
+        @exception = exception
+        @installment = installment
+      end
+
+      def call
+        Rails.logger.error("Error processing installment with ID=#{installment.id}:") if installment
+        Rails.logger.error(exception.message)
+      end
+
+      private
+
+      attr_reader :exception, :installment
+    end
+  end
+end

data/lib/solidus_subscriptions/subscription_generator.rb

@@ -8,6 +8,12 @@ module SolidusSubscriptions
 
     SubscriptionConfiguration = Struct.new(:interval_length, :interval_units, :end_date)
 
+    def call(order)
+      group(order.subscription_line_items).each { |line_items| activate(line_items) }
+
+      order.reload
+    end
+
     # Create and persist a subscription for a collection of subscription
     #   line items
     #

data/lib/solidus_subscriptions/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SolidusSubscriptions
-  VERSION = '1.0.0.rc1'
+  VERSION = '1.0.1'
 end

data/lib/solidus_subscriptions.rb

@@ -26,6 +26,7 @@ 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'
+require 'solidus_subscriptions/order_creator'
 
 module SolidusSubscriptions
   class << self

data/solidus_subscriptions.gemspec

@@ -10,14 +10,14 @@ Gem::Specification.new do |spec|
 
   spec.summary = 'Add subscription support to Solidus'
   spec.description = 'Add subscription support to Solidus'
-  spec.homepage = 'https://github.com/solidusio-contrib/solidus_subscriptions'
+  spec.homepage = 'https://github.com/solidusio/solidus_subscriptions'
   spec.license = 'BSD-3-Clause'
 
   spec.metadata['homepage_uri'] = spec.homepage
-  spec.metadata['source_code_uri'] = 'https://github.com/solidusio-contrib/solidus_subscriptions'
-  spec.metadata['changelog_uri'] = 'https://github.com/solidusio-contrib/solidus_subscriptions/blob/master/CHANGELOG.md'
+  spec.metadata['source_code_uri'] = 'https://github.com/solidusio/solidus_subscriptions'
+  spec.metadata['changelog_uri'] = 'https://github.com/solidusio/solidus_subscriptions/blob/master/CHANGELOG.md'
 
-  spec.required_ruby_version = Gem::Requirement.new('~> 2.5')
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5')
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -32,8 +32,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'deface'
   spec.add_dependency 'httparty', '~> 0.18'
   spec.add_dependency 'i18n'
-  spec.add_dependency 'solidus_core', ['>= 2.0.0', '< 3']
-  spec.add_dependency 'solidus_support', '~> 0.7'
+  spec.add_dependency 'solidus_core', '>= 2.11', '< 4'
+  spec.add_dependency 'solidus_support', '~> 0.9'
   spec.add_dependency 'state_machines'
 
   spec.add_development_dependency 'rspec-activemodel-mocks'

data/spec/controllers/spree/api/line_items_controller_spec.rb

@@ -31,7 +31,7 @@ RSpec.describe Spree::Api::LineItemsController, type: :controller do
 
       it 'creates a line item' do
         expect { post_create }.
-          to change { Spree::LineItem.count }.
+          to change(Spree::LineItem, :count).
           from(0).to(1)
       end
     end
@@ -54,7 +54,7 @@ RSpec.describe Spree::Api::LineItemsController, type: :controller do
 
       it 'creates a new subscription line item' do
         expect { post_create }.
-          to change { SolidusSubscriptions::LineItem.count }.
+          to change(SolidusSubscriptions::LineItem, :count).
           from(0).to(1)
       end
     end
@@ -65,39 +65,74 @@ RSpec.describe Spree::Api::LineItemsController, type: :controller do
   end
 
   describe 'patch :update' do
-    subject(:patch_create) { patch :create, params: params }
+    subject(:patch_update) { patch :update, params: params }
 
     let(:params) { line_item_params }
-    let!(:variant) { create :variant }
-    let!(:order) { create :order }
-    let!(:line_item) { create :line_item, order: order, variant: variant }
 
-    let(:line_item_params) do
-      {
-        id: line_item.id,
-        order_id: order.number,
-        order_token: order.guest_token,
-        format: 'json',
-        line_item: {
-          quantity: 1,
-          variant_id: variant.id
-        },
-        subscription_line_item: {
-          quantity: 2,
-          end_date: '1990/10/12',
-          subscribable_id: variant.id,
-          interval_length: 30,
-          interval_units: "day"
+    context 'when adding subscription information' do
+      let(:variant) { create :variant }
+      let(:order) { create :order }
+      let(:line_item) { create :line_item, order: order, variant: variant }
+      let(:line_item_params) do
+        {
+          id: line_item.id,
+          order_id: order.number,
+          order_token: order.guest_token,
+          format: 'json',
+          line_item: {
+            quantity: 1,
+            variant_id: variant.id
+          },
+          subscription_line_item: {
+            quantity: 2,
+            end_date: '1990/10/12',
+            subscribable_id: variant.id,
+            interval_length: 30,
+            interval_units: "day"
+          }
         }
-      }
+      end
+
+      it { is_expected.to be_successful }
+
+      it 'creates a new subscription line item' do
+        expect { patch_update }.
+          to change(SolidusSubscriptions::LineItem, :count).
+          from(0).to(1)
+      end
     end
 
-    it { is_expected.to be_successful }
+    context 'when updating subscription information' do
+      let!(:line_item) { create :subscription_line_item, interval_length: 30 }
+      let(:variant) { line_item.spree_line_item.variant }
+      let(:order) { line_item.spree_line_item.order }
+      let(:line_item_params) do
+        {
+          id: line_item.spree_line_item.id,
+          order_id: order.number,
+          order_token: order.guest_token,
+          format: 'json',
+          line_item: {
+            quantity: 1,
+          },
+          subscription_line_items_attributes: {
+            id: line_item.id,
+            interval_length: 15,
+          }
+        }
+      end
 
-    it 'creates a new subscription line item' do
-      expect { patch_create }.
-        to change { SolidusSubscriptions::LineItem.count }.
-        from(0).to(1)
+      it { is_expected.to be_successful }
+
+      it 'does not create a new subscription line item' do
+        expect { patch_update }.
+          not_to change(SolidusSubscriptions::LineItem, :count)
+      end
+
+      it 'updates a new subscription line item' do
+        expect { patch_update }.
+          to change { line_item.reload.interval_length }.from(30).to(15)
+      end
     end
   end
 end

data/spec/controllers/spree/api/users_controller_spec.rb

@@ -39,6 +39,9 @@ RSpec.describe Spree::Api::UsersController, type: :controller do
     end
 
     it 'updates the subscription line items' do
+      allow(::Spree::Deprecation).to receive(:warn).with(a_string_matching(
+        'Creating or updating subscriptions through Spree::User nested attributes is deprecated'
+      ))
       update_user
       line_item = subscription.line_items.reload.first
 

data/spec/decorators/controllers/solidus_subscriptions/spree/orders_controller/create_subscription_line_items_spec.rb

@@ -9,7 +9,7 @@ RSpec.describe SolidusSubscriptions::Spree::OrdersController::CreateSubscription
   let!(:user) { create :user }
 
   before do
-    allow(controller).to receive_messages(try_spree_current_user: user)
+    allow(controller).to receive_messages(spree_current_user: user)
     create :store
   end
 
@@ -30,13 +30,13 @@ RSpec.describe SolidusSubscriptions::Spree::OrdersController::CreateSubscription
 
       it 'creates an order' do
         expect { populate }.
-          to change { Spree::Order.count }.
+          to change(Spree::Order, :count).
           from(0).to(1)
       end
 
       it 'creates a line item' do
         expect { populate }.
-          to change { Spree::LineItem.count }.
+          to change(Spree::LineItem, :count).
           from(0).to(1)
       end
     end
@@ -59,7 +59,7 @@ RSpec.describe SolidusSubscriptions::Spree::OrdersController::CreateSubscription
 
       it 'creates a new subscription line item' do
         expect { populate }.
-          to change { SolidusSubscriptions::LineItem.count }.
+          to change(SolidusSubscriptions::LineItem, :count).
           from(0).to(1)
       end
 

data/spec/decorators/models/solidus_subscriptions/spree/variant/auto_delete_from_subscriptions_spec.rb

@@ -10,7 +10,7 @@ RSpec.describe SolidusSubscriptions::Spree::Variant::AutoDeleteFromSubscriptions
       subscription = create(:subscription)
       create(:subscription_line_item, subscription: subscription, subscribable: subject)
 
-      expect { subject.discard }.to change { SolidusSubscriptions::LineItem.count }.by(-1)
+      expect { subject.discard }.to change(SolidusSubscriptions::LineItem, :count).by(-1)
     end
   end
 
@@ -19,7 +19,7 @@ RSpec.describe SolidusSubscriptions::Spree::Variant::AutoDeleteFromSubscriptions
       subscription = create(:subscription)
       create(:subscription_line_item, subscription: subscription, subscribable: subject)
 
-      expect { subject.destroy }.to change { SolidusSubscriptions::LineItem.count }.by(-1)
+      expect { subject.destroy }.to change(SolidusSubscriptions::LineItem, :count).by(-1)
     end
   end
 end