solidus_subscriptions 1.0.0 → 1.0.1

data/README.md

@@ -1,7 +1,7 @@
 # solidus_subscriptions
 
-[![CircleCI](https://circleci.com/gh/solidusio-contrib/solidus_subscriptions.svg?style=shield)](https://circleci.com/gh/solidusio-contrib/solidus_subscriptions)
-[![codecov](https://codecov.io/gh/solidusio-contrib/solidus_subscriptions/branch/master/graph/badge.svg)](https://codecov.io/gh/solidusio-contrib/solidus_subscriptions)
+[![CircleCI](https://circleci.com/gh/solidusio/solidus_subscriptions.svg?style=shield)](https://circleci.com/gh/solidusio/solidus_subscriptions)
+[![codecov](https://codecov.io/gh/solidusio/solidus_subscriptions/branch/master/graph/badge.svg)](https://codecov.io/gh/solidusio/solidus_subscriptions)
 
 A Solidus extension to add subscriptions to your store.
 
@@ -10,13 +10,26 @@ A Solidus extension to add subscriptions to your store.
 Add solidus_subscriptions to your Gemfile:
 
 ```ruby
-gem 'solidus_subscriptions', github: 'solidusio-contrib/solidus_subscriptions'
+gem 'solidus_subscriptions', github: 'solidusio/solidus_subscriptions'
 ```
 
 Bundle your dependencies and run the installation generator:
 
 ```shell
 $ bundle
+$ bin/rails generate solidus_subscriptions:install --frontend=starter
+```
+
+Please, be aware that the starter installation only works with the default
+implementation of the starter frontend. Any customization to the files that
+will be modified by the installer might break the installation procedure.
+If that happens, try to adapt the installed code on top of the customizations
+of the store.
+
+
+If you are using the legacy `solidus_frontend` gem, please run this command instead:
+
+```shell
 $ bin/rails generate solidus_subscriptions:install
 ```
 
@@ -91,14 +104,11 @@ The task creates ActiveJob jobs which can be fulfilled by your queue library of
 We suggest using the [Whenever](https://github.com/javan/whenever) gem to schedule the task.
 
 ### Promotion rules
+
 This extensions adds the following [Promotion rules](https://guides.solidus.io/developers/promotions/promotion-rules.html):
 * `SolidusSubscriptions::Promotion::Rules::SubscriptionCreationOrder` which applies if the order is creating a subscription;
 * `SolidusSubscriptions::Promotion::Rules::SubscriptionInstallmentOrder` which applies if the order is an installment of a subscription.
 
-### API documentation
-
-You can find the API documentation [here](https://stoplight.io/p/docs/gh/solidusio-contrib/solidus_subscriptions?group=master).
-
 ### Churn Buster integration
 
 This extension optionally integrates with [Churn Buster](https://churnbuster.io) for failed payment

data/app/controllers/solidus_subscriptions/api/v1/subscriptions_controller.rb

@@ -56,6 +56,26 @@ module SolidusSubscriptions
           end
         end
 
+        def pause
+          load_subscription
+
+          if @subscription.pause(actionable_date: actionable_date_param)
+            render json: @subscription.to_json
+          else
+            render json: @subscription.errors.to_json, status: :unprocessable_entity
+          end
+        end
+
+        def resume
+          load_subscription
+
+          if @subscription.resume(actionable_date: actionable_date_param)
+            render json: @subscription.to_json
+          else
+            render json: @subscription.errors.to_json, status: :unprocessable_entity
+          end
+        end
+
         private
 
         def load_subscription
@@ -77,6 +97,10 @@ module SolidusSubscriptions
           ])
         end
 
+        def actionable_date_param
+          params[:subscription].try(:[], :actionable_date)&.presence
+        end
+
         def line_item_attributes
           SolidusSubscriptions.configuration.subscription_line_item_attributes
         end

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

@@ -68,10 +68,38 @@ module Spree
       def skip
         @subscription.skip(check_skip_limits: false)
 
-        notice = I18n.t(
-          'spree.admin.subscriptions.successfully_skipped',
-          date: @subscription.actionable_date
-        )
+        notice = if @subscription.errors.none?
+                   I18n.t(
+                     'spree.admin.subscriptions.successfully_skipped',
+                     date: @subscription.actionable_date
+                   )
+                 else
+                   @subscription.errors.full_messages.to_sentence
+                 end
+
+        redirect_back(fallback_location: spree.admin_subscriptions_path, notice: notice)
+      end
+
+      def pause
+        @subscription.pause(actionable_date: nil)
+
+        notice = if @subscription.errors.none?
+                   I18n.t('spree.admin.subscriptions.successfully_paused')
+                 else
+                   @subscription.errors.full_messages.to_sentence
+                 end
+
+        redirect_back(fallback_location: spree.admin_subscriptions_path, notice: notice)
+      end
+
+      def resume
+        @subscription.resume(actionable_date: nil)
+
+        notice = if @subscription.errors.none?
+                   I18n.t('spree.admin.subscriptions.successfully_resumed')
+                 else
+                   @subscription.errors.full_messages.to_sentence
+                 end
 
         redirect_back(fallback_location: spree.admin_subscriptions_path, notice: notice)
       end

data/app/decorators/models/solidus_subscriptions/spree/wallet_payment_source/report_default_change_to_subscriptions.rb

@@ -14,8 +14,8 @@ module SolidusSubscriptions
           return if !previous_changes.key?('default') || !default?
 
           user.subscriptions.with_default_payment_source.each do |subscription|
-            ::Spree::Event.fire(
-              'solidus_subscriptions.subscription_payment_method_changed',
+            ::SolidusSupport::LegacyEventCompat::Bus.publish(
+              :'solidus_subscriptions.subscription_payment_method_changed',
               subscription: subscription,
             )
           end

data/app/jobs/solidus_subscriptions/create_subscription_job.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module SolidusSubscriptions
+  class CreateSubscriptionJob < ApplicationJob
+    queue_as { SolidusSubscriptions.configuration.processing_queue }
+
+    def perform(order)
+      SolidusSubscriptions.configuration.subscription_generator_class.call(order)
+    end
+  end
+end

data/app/jobs/solidus_subscriptions/process_installment_job.rb

@@ -7,7 +7,7 @@ module SolidusSubscriptions
     def perform(installment)
       Checkout.new(installment).process
     rescue StandardError => e
-      SolidusSubscriptions.configuration.processing_error_handler&.call(e)
+      SolidusSubscriptions.configuration.processing_error_handler&.call(e, installment)
     end
   end
 end

data/app/models/solidus_subscriptions/subscription.rb

@@ -38,7 +38,7 @@ module SolidusSubscriptions
     before_validation :set_currency
     before_create :generate_guest_token
     after_create :emit_event_for_creation
-    before_update :update_actionable_date_if_interval_changed
+    before_update :update_actionable_date_if_interval_changed, unless: :paused_changed?
     after_update :emit_events_for_update
 
     # Find all subscriptions that are "actionable"; that is, ones that have an
@@ -83,8 +83,13 @@ module SolidusSubscriptions
       where(payment_method: nil, payment_source: nil)
     end)
 
+    # Scope for finding subscription with a specific item
+    scope :with_subscribable, (lambda do |id|
+      joins(line_items: :subscribable).where(spree_variants: { id: id })
+    end)
+
     def self.ransackable_scopes(_auth_object = nil)
-      [:in_processing_state]
+      [:in_processing_state, :with_subscribable]
     end
 
     def self.processing_states
@@ -107,7 +112,7 @@ module SolidusSubscriptions
     state_machine :state, initial: :active do
       event :cancel do
         transition [:active, :pending_cancellation] => :canceled,
-                   if: ->(subscription) { subscription.can_be_canceled? }
+          if: ->(subscription) { subscription.can_be_canceled? }
 
         transition active: :pending_cancellation
       end
@@ -122,7 +127,7 @@ module SolidusSubscriptions
 
       event :deactivate do
         transition active: :inactive,
-                   if: ->(subscription) { subscription.can_be_deactivated? }
+          if: ->(subscription) { subscription.can_be_deactivated? }
       end
 
       event :activate do
@@ -159,19 +164,21 @@ module SolidusSubscriptions
     end
 
     def skip(check_skip_limits: true)
+      check_invalid_skip_states
+
       if check_skip_limits
         check_successive_skips_exceeded
         check_total_skips_exceeded
-
-        return if errors.any?
       end
 
+      return if errors.any?
+
       increment(:skip_count)
       increment(:successive_skip_count)
       save!
 
       advance_actionable_date.tap do
-        events.create!(event_type: 'subscription_skipped')
+        create_and_emit_event(type: 'subscription_skipped')
       end
     end
 
@@ -206,11 +213,37 @@ module SolidusSubscriptions
     # @return [Date] The next date after the current actionable_date this
     # subscription will be eligible to be processed.
     def advance_actionable_date
-      update! actionable_date: next_actionable_date
+      create_and_emit_event(type: 'subscription_resumed') if paused?
+
+      update! actionable_date: next_actionable_date, paused: false
 
       actionable_date
     end
 
+    def pause(actionable_date: nil)
+      check_invalid_pause_states
+      return false if errors.any?
+      return true if paused?
+
+      result = update! paused: true, actionable_date: actionable_date && tomorrow_or_after(actionable_date)
+      create_and_emit_event(type: 'subscription_paused') if result
+      result
+    end
+
+    def resume(actionable_date: nil)
+      check_invalid_resume_states
+      return false if errors.any?
+      return true unless paused?
+
+      result = update! paused: false, actionable_date: tomorrow_or_after(actionable_date)
+      create_and_emit_event(type: 'subscription_resumed') if result
+      result
+    end
+
+    def state_with_pause
+      active? && paused? ? 'paused' : state
+    end
+
     # The state of the last attempt to process an installment associated to
     # this subscription
     #
@@ -300,6 +333,23 @@ module SolidusSubscriptions
       end
     end
 
+    def check_invalid_skip_states
+      errors.add(:paused, :cannot_skip) if paused?
+      errors.add(:state, :cannot_skip) if canceled? || inactive?
+    end
+
+    def check_invalid_pause_states
+      errors.add(:paused, :not_active) unless active?
+    end
+
+    alias check_invalid_resume_states check_invalid_pause_states
+
+    def tomorrow_or_after(date)
+      [date.try(:to_date), Time.zone.tomorrow].compact.max
+    rescue ::Date::Error
+      Time.zone.tomorrow
+    end
+
     def update_actionable_date_if_interval_changed
       if persisted? && (interval_length_previously_changed? || interval_units_previously_changed?)
         base_date = if installments.any?
@@ -338,13 +388,22 @@ module SolidusSubscriptions
       end
     end
 
-    def emit_event_for_creation
-      ::Spree::Event.fire(
-        'solidus_subscriptions.subscription_created',
+    def emit_event(type:)
+      ::SolidusSupport::LegacyEventCompat::Bus.publish(
+        :"solidus_subscriptions.#{type}",
         subscription: self,
       )
     end
 
+    def create_and_emit_event(type:)
+      events.create!(event_type: type)
+      emit_event(type: type)
+    end
+
+    def emit_event_for_creation
+      emit_event(type: 'subscription_created')
+    end
+
     def emit_event_for_transition
       event_type = {
         active: 'subscription_activated',
@@ -353,39 +412,24 @@ module SolidusSubscriptions
         inactive: 'subscription_ended',
       }[state.to_sym]
 
-      ::Spree::Event.fire(
-        "solidus_subscriptions.#{event_type}",
-        subscription: self,
-      )
+      emit_event(type: event_type)
     end
 
     def emit_events_for_update
       if previous_changes.key?('interval_length') || previous_changes.key?('interval_units')
-        ::Spree::Event.fire(
-          'solidus_subscriptions.subscription_frequency_changed',
-          subscription: self,
-        )
+        emit_event(type: 'subscription_frequency_changed')
       end
 
       if previous_changes.key?('shipping_address_id')
-        ::Spree::Event.fire(
-          'solidus_subscriptions.subscription_shipping_address_changed',
-          subscription: self,
-        )
+        emit_event(type: 'subscription_shipping_address_changed')
       end
 
       if previous_changes.key?('billing_address_id')
-        ::Spree::Event.fire(
-          'solidus_subscriptions.subscription_billing_address_changed',
-          subscription: self,
-        )
+        emit_event(type: 'subscription_billing_address_changed')
       end
 
       if previous_changes.key?('payment_source_id') || previous_changes.key?('payment_source_type') || previous_changes.key?('payment_method_id')
-        ::Spree::Event.fire(
-          'solidus_subscriptions.subscription_payment_method_changed',
-          subscription: self,
-        )
+        emit_event(type: 'subscription_payment_method_changed')
       end
     end
   end

data/app/subscribers/solidus_subscriptions/churn_buster_subscriber.rb

@@ -3,6 +3,7 @@
 module SolidusSubscriptions
   module ChurnBusterSubscriber
     include ::Spree::Event::Subscriber
+    include ::SolidusSupport::LegacyEventCompat::Subscriber
 
     event_action :report_subscription_cancellation, event_name: 'solidus_subscriptions.subscription_canceled'
     event_action :report_subscription_ending, event_name: 'solidus_subscriptions.subscription_ended'

data/app/subscribers/solidus_subscriptions/event_storage_subscriber.rb

@@ -3,6 +3,7 @@
 module SolidusSubscriptions
   module EventStorageSubscriber
     include ::Spree::Event::Subscriber
+    include ::SolidusSupport::LegacyEventCompat::Subscriber
 
     event_action :track_subscription_created, event_name: 'solidus_subscriptions.subscription_created'
     event_action :track_subscription_activated, event_name: 'solidus_subscriptions.subscription_activated'

data/app/subscribers/solidus_subscriptions/order_subscriber.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module SolidusSubscriptions
+  module OrderSubscriber
+    include ::Spree::Event::Subscriber
+    include ::SolidusSupport::LegacyEventCompat::Subscriber
+
+    event_action :create_subscription, event_name: 'order_finalized'
+
+    private
+
+    def create_subscription(event)
+      SolidusSubscriptions::CreateSubscriptionJob.perform_later(event.payload[:order])
+    end
+  end
+end

data/app/views/spree/admin/shared/_subscription_actions.html.erb

@@ -23,13 +23,32 @@
   <% end %>
 
   <% if subscription.active? %>
-    <%=
-      link_to(
-          t('spree.admin.subscriptions.actions.skip'),
-          spree.skip_admin_subscription_path(subscription),
-          method: :post,
-          class: 'btn btn-default',
-      )
-    %>
+    <% if subscription.paused? %>
+      <%=
+        link_to(
+            t('spree.admin.subscriptions.actions.resume'),
+            spree.resume_admin_subscription_path(subscription),
+            method: :post,
+            class: 'btn btn-default',
+        )
+      %>
+    <% else %>
+      <%=
+        link_to(
+            t('spree.admin.subscriptions.actions.pause'),
+            spree.pause_admin_subscription_path(subscription),
+            method: :post,
+            class: 'btn btn-default',
+        )
+      %>
+      <%=
+        link_to(
+            t('spree.admin.subscriptions.actions.skip'),
+            spree.skip_admin_subscription_path(subscription),
+            method: :post,
+            class: 'btn btn-default',
+        )
+      %>
+    <% end %>
   <% end %>
 <% end %>

data/app/views/spree/admin/shared/_subscription_sidebar.html.erb

@@ -6,6 +6,8 @@
   <nav class="menu">
     <fieldset class="no-border-top no-border-bottom" data-hook="admin_user_lifetime_stats">
       <dl id="user-lifetime-stats">
+        <dt><%= SolidusSubscriptions::Subscription.human_attribute_name(:user) %>:</dt>
+        <dd><%= link_to(subscription.user.email, admin_user_path(subscription.user)) %></dd>
         <dt><%= SolidusSubscriptions::Subscription.human_attribute_name(:created_at) %>:</dt>
         <dd><%= l(subscription.created_at.to_date) %></dd>
         <dt><%= SolidusSubscriptions::Subscription.human_attribute_name(:state) %>:</dt>

data/app/views/spree/admin/subscriptions/_state_pill.html.erb

@@ -3,8 +3,9 @@
     canceled: 'error',
     pending_cancellation: 'warning',
     inactive: 'inactive',
-}[subscription.state.to_sym] %>
+    paused: 'pending'
+}[subscription.state_with_pause.to_sym] %>
 
 <span class="pill pill-<%= state_class %>">
-  <%= subscription.human_state_name %>
+  <%= subscription.state_with_pause.humanize %>
 </span>

data/app/views/spree/admin/subscriptions/index.html.erb

@@ -48,21 +48,21 @@
       </div>
 
       <div class="row">
-        <div class="field-block col-4">
+        <div class="field-block col-3">
           <div class="field">
             <%= label_tag :q_user_email_cont, Spree.user_class.human_attribute_name(:email) %>
             <%= f.text_field :user_email_cont, size: 25 %>
           </div>
         </div>
 
-        <div class="field-block col-4">
+        <div class="field-block col-3">
           <div class="field">
             <%= label_tag :q_state_eq, SolidusSubscriptions::Subscription.human_attribute_name(:state) %>
             <%= f.select :state_eq, SolidusSubscriptions::Subscription.state_machines[:state].states.map {|s| [s.human_name, s.value]}, {include_blank: true}, class: 'select2 fullwidth' %>
           </div>
         </div>
 
-        <div class="field-block col-4">
+        <div class="field-block col-3">
           <div class="field">
             <%= label_tag :q_processing_state_eq, SolidusSubscriptions::Subscription.human_attribute_name(:processing_state) %>
 
@@ -85,10 +85,23 @@
             %>
           </div>
         </div>
+        <div class="field-block col-3">
+          <div class="field">
+            <%= label_tag :q_with_subscribable_eq, SolidusSubscriptions::Subscription.human_attribute_name(:with_subscribable) %>
+
+            <%=
+              f.select(
+                :with_subscribable,
+                options_for_select(::Spree::Variant.includes(:product).where(id: ::SolidusSubscriptions::LineItem.distinct.pluck(:subscribable_id)).map { |subscribable| [ subscribable.name, subscribable.id ]}, params.dig(:q, :with_subscribable)),
+                { include_blank: true },
+                class: 'select2 fullwidth'
+              )
+            %>
+          </div>
+        </div>
       </div>
 
       <div class="clearfix"></div>
-
       <div class="actions filter-actions">
         <div data-hook="admin_subscriptions_index_search_buttons">
           <%= button_tag I18n.t('spree.filter_results'), class: 'btn btn-primary' %>
@@ -110,6 +123,7 @@
         <th><%= sort_link(@search, :line_item_interval_length, SolidusSubscriptions::Subscription.human_attribute_name(:interval)) %></th>
         <th><%= sort_link(@search, :state, [:state, 'id asc'], SolidusSubscriptions::Subscription.human_attribute_name(:state)) %></th>
         <th><%= sort_link(@search, :processing_state, [:processing_state, 'id asc'], SolidusSubscriptions::Subscription.human_attribute_name(:processing_state)) %></th>
+        <th><%= SolidusSubscriptions::Subscription.human_attribute_name(:line_items) %></th>
         <th data-hook="admin_subscriptions_index_header_actions" class="actions"></th>
       </tr>
     </thead>
@@ -123,6 +137,7 @@
           <td><%= subscription.interval.inspect %></td>
           <td><%= render 'state_pill', subscription: subscription %></td>
           <td><%= render 'processing_state_pill', subscription: subscription %></td>
+          <td><%= subscription.line_items.includes(subscribable: :product).map { |line_item| line_item.subscribable&.name }.join(", ") %></td>
           <td class="actions">
             <% if subscription.state_events.include?(:cancel) %>
               <%=
@@ -150,18 +165,40 @@
             <% end %>
 
             <% if subscription.active? %>
-              <%=
-                link_to_with_icon(
-                    :'fast-forward',
-                    t('spree.admin.subscriptions.actions.skip'),
-                    spree.skip_admin_subscription_path(subscription),
-                    no_text: true,
-                    method: :post
-                )
-              %>
+              <% if subscription.paused? %>
+                <%=
+                  link_to_with_icon(
+                      :'play-circle',
+                      t('spree.admin.subscriptions.actions.resume'),
+                      spree.resume_admin_subscription_path(subscription),
+                      no_text: true,
+                      method: :post
+                  )
+                %>
+              <% else %>
+                <%=
+                  link_to_with_icon(
+                      :'pause-circle',
+                      t('spree.admin.subscriptions.actions.pause'),
+                      spree.pause_admin_subscription_path(subscription),
+                      no_text: true,
+                      method: :post
+                  )
+                %>
+                <%=
+                  link_to_with_icon(
+                      :'fast-forward',
+                      t('spree.admin.subscriptions.actions.skip'),
+                      spree.skip_admin_subscription_path(subscription),
+                      no_text: true,
+                      method: :post
+                  )
+                %>
+              <% end %>
             <% end %>
 
             <%= link_to_edit(subscription, no_text: true) %>
+
           </td>
         </tr>
       <% end %>

data/bin/sandbox

@@ -50,7 +50,6 @@ fi
 cd ./sandbox
 cat <<RUBY >> Gemfile
 gem 'solidus', github: 'solidusio/solidus', branch: '$BRANCH'
-gem 'solidus_auth_devise', '>= 2.1.0'
 gem 'rails-i18n'
 gem 'solidus_i18n'
 
@@ -69,14 +68,10 @@ unbundled bundle exec rake db:drop db:create
 
 unbundled bundle exec rails generate solidus:install \
   --auto-accept \
-  --user_class=Spree::User \
-  --enforce_available_locales=true \
-  --with-authentication=false \
   --payment-method=none \
   $@
 
-unbundled bundle exec rails generate solidus:auth:install
-unbundled bundle exec rails generate ${extension_name}:install
+unbundled bundle exec rails generate ${extension_name}:install --frontend=starter --auto-run-migrations=true
 
 echo
 echo "🚀 Sandbox app successfully created for $extension_name!"

data/config/locales/en.yml

@@ -17,6 +17,13 @@ en:
       failed: This installment could not be processed
       payment_failed: The payment for this installment failed
 
+  cart_line_items:
+    subscription_fields:
+      quantity: I want
+      quantity_suffix: items
+      interval_length: every
+      subscription_fields: Subscription Settings
+
   spree:
     new_subscription: New Subscription
     admin:
@@ -24,11 +31,15 @@ en:
         successfully_canceled: Subscription Canceled!
         successfully_activated: Subscription Activated!
         successfully_skipped: Subscription delayed until %{date}
+        successfully_paused: Subscription Paused
+        successfully_resumed: Subscription Resumed
         actions:
           cancel: Cancel
           cancel_alert: "Are you sure you want to cancel this subscription?"
           activate: Activate
           skip: Skip One
+          pause: Pause
+          resume: Resume
         index:
           new_subscription: New Subscription
         edit:
@@ -127,3 +138,8 @@ en:
               inclusion: "is not a valid currency code"
             payment_source:
               not_owned_by_user: "does not belong to the user associated with the subscription"
+            paused:
+              cannot_skip: "cannot skip a subscription which is paused"
+              not_active: "cannot pause/resume a subscription which is not active"
+            state:
+              cannot_skip: cannot skip a subscription which is canceled or inactive

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