solidus_subscriptions-alpha 0.0.4 → 0.0.5

data/lib/solidus_subscriptions.rb

@@ -1,6 +1,6 @@
-require 'solidus'
-require 'solidus_support'
-require "solidus_subscriptions/ability"
-require 'solidus_subscriptions/engine'
-require 'deface'
-require 'state_machines'
+require 'solidus'
+require 'solidus_support'
+require "solidus_subscriptions/ability"
+require 'solidus_subscriptions/engine'
+require 'deface'
+require 'state_machines'

data/lib/solidus_subscriptions/ability.rb

@@ -1,19 +1,19 @@
-module SolidusSubscriptions
-  class Ability
-    include CanCan::Ability
-
-    def initialize(user)
-      alias_action :create, :read, :update, :destroy, to: :crud
-
-      if user.has_spree_role?('admin')
-        can(:manage, LineItem)
-        can(:manage, Subscription)
-      else
-        can([:crud, :skip, :cancel], Subscription, user_id: user.id)
-        can(:crud, LineItem) do |li, order|
-          li.order.user == user || li.order == order
-        end
-      end
-    end
-  end
-end
+module SolidusSubscriptions
+  class Ability
+    include CanCan::Ability
+
+    def initialize(user)
+      alias_action :create, :read, :update, :destroy, to: :crud
+
+      if user.has_spree_role?('admin')
+        can(:manage, LineItem)
+        can(:manage, Subscription)
+      else
+        can([:crud, :skip, :cancel], Subscription, user_id: user.id)
+        can(:crud, LineItem) do |li, order|
+          li.order.user == user || li.order == order
+        end
+      end
+    end
+  end
+end

data/lib/solidus_subscriptions/config.rb

@@ -1,97 +1,97 @@
-module SolidusSubscriptions
-  module Config
-    class << self
-      # Processing Event handlers
-      # These handlers are pluggable, however it is highly encouraged that you
-      # subclass from the the dispatcher you are replacing, and call super
-      # from within the #dispatch method (if you override it)
-      #
-      # This handler is called when a susbcription order is successfully placed.
-      attr_writer :success_dispatcher_class
-      def success_dispatcher_class
-        @success_dispatcher_class ||= ::SolidusSubscriptions::SuccessDispatcher
-      end
-
-      # This handler is called when an order cant be placed for a group of
-      # installments
-      attr_writer :failure_dispatcher_class
-      def failure_dispatcher_class
-        @failure_dispatcher_class ||= ::SolidusSubscriptions::FailureDispatcher
-      end
-
-      # This handler is called when a payment fails on a subscription order
-      attr_writer :payment_failed_dispatcher_class
-      def payment_failed_dispatcher_class
-        @payment_failed_dispatcher_class ||= ::SolidusSubscriptions::PaymentFailedDispatcher
-      end
-
-      # This handler is called when installemnts cannot be fulfilled due to lack
-      # of stock
-      attr_writer :out_of_stock_dispatcher
-      def out_of_stock_dispatcher_class
-        @out_of_stock_dispatcher_class ||= ::SolidusSubscriptions::OutOfStockDispatcher
-      end
-
-      def default_gateway(&block)
-        return @gateway.call unless block_given?
-        @gateway = block
-      end
-    end
-
-    # Maximum number of times a user can skip their subscription before it
-    # must be processed
-    mattr_accessor(:maximum_successive_skips) { 1 }
-
-    # Limit on the number of times a user can skip thier subscription. Once
-    # this limit is reached, no skips are permitted
-    mattr_accessor(:maximum_total_skips) { nil }
-
-    # Time between an installment failing to be processed and the system
-    # retrying to fulfil it
-    mattr_accessor(:reprocessing_interval) { 1.day }
-
-    mattr_accessor(:minimum_cancellation_notice) { 1.day }
-
-    # Which queue is responsible for processing subscriptions
-    mattr_accessor(:processing_queue) { :default }
-
-    # SolidusSubscriptions::LineItem attributes which are allowed to
-    # be updated from user data
-    #
-    # This is useful in the case where certain fields should not be allowed to
-    # be modified by the user. This locks these attributes from being passed
-    # in to the orders controller (or the api controller).
-
-    # Ie. if a store does not want to allow users to configure the end date of
-    # a subscription. Add this to an initializer:
-
-    # ```
-    # SolidusSubscriptions::Config.subscription_line_item_attributes = [
-    #   :quantity,
-    #   :interval_length,
-    #   :interval_units,
-    #   :subscribable_id
-    # ]
-    # ```
-    # This configuration also easily allows the gem to be customized to track
-    # more information on the subcriptions line items.
-    mattr_accessor(:subscription_line_item_attributes) do
-      [
-        :quantity,
-        :subscribable_id,
-        :interval_length,
-        :interval_units,
-        :end_date
-      ]
-    end
-
-    # SolidusSubscriptions::Subscription attributes which are allowed to
-    # be updated from user data
-    mattr_accessor(:subscription_attributes) do
-      [
-        :actionable_date,
-        shipping_address_attributes: Spree::PermittedAttributes.address_attributes
-      ]
-    end
-  end
-end
+module SolidusSubscriptions
+  module Config
+    class << self
+      # Processing Event handlers
+      # These handlers are pluggable, however it is highly encouraged that you
+      # subclass from the the dispatcher you are replacing, and call super
+      # from within the #dispatch method (if you override it)
+      #
+      # This handler is called when a susbcription order is successfully placed.
+      attr_writer :success_dispatcher_class
+      def success_dispatcher_class
+        @success_dispatcher_class ||= ::SolidusSubscriptions::SuccessDispatcher
+      end
+
+      # This handler is called when an order cant be placed for a group of
+      # installments
+      attr_writer :failure_dispatcher_class
+      def failure_dispatcher_class
+        @failure_dispatcher_class ||= ::SolidusSubscriptions::FailureDispatcher
+      end
+
+      # This handler is called when a payment fails on a subscription order
+      attr_writer :payment_failed_dispatcher_class
+      def payment_failed_dispatcher_class
+        @payment_failed_dispatcher_class ||= ::SolidusSubscriptions::PaymentFailedDispatcher
+      end
+
+      # This handler is called when installemnts cannot be fulfilled due to lack
+      # of stock
+      attr_writer :out_of_stock_dispatcher
+      def out_of_stock_dispatcher_class
+        @out_of_stock_dispatcher_class ||= ::SolidusSubscriptions::OutOfStockDispatcher
+      end
+
+      def default_gateway(&block)
+        return @gateway.call unless block_given?
+        @gateway = block
+      end
+    end
+
+    # Maximum number of times a user can skip their subscription before it
+    # must be processed
+    mattr_accessor(:maximum_successive_skips) { 1 }
+
+    # Limit on the number of times a user can skip thier subscription. Once
+    # this limit is reached, no skips are permitted
+    mattr_accessor(:maximum_total_skips) { nil }
+
+    # Time between an installment failing to be processed and the system
+    # retrying to fulfil it
+    mattr_accessor(:reprocessing_interval) { 1.day }
+
+    mattr_accessor(:minimum_cancellation_notice) { 1.day }
+
+    # Which queue is responsible for processing subscriptions
+    mattr_accessor(:processing_queue) { :default }
+
+    # SolidusSubscriptions::LineItem attributes which are allowed to
+    # be updated from user data
+    #
+    # This is useful in the case where certain fields should not be allowed to
+    # be modified by the user. This locks these attributes from being passed
+    # in to the orders controller (or the api controller).
+
+    # Ie. if a store does not want to allow users to configure the end date of
+    # a subscription. Add this to an initializer:
+
+    # ```
+    # SolidusSubscriptions::Config.subscription_line_item_attributes = [
+    #   :quantity,
+    #   :interval_length,
+    #   :interval_units,
+    #   :subscribable_id
+    # ]
+    # ```
+    # This configuration also easily allows the gem to be customized to track
+    # more information on the subcriptions line items.
+    mattr_accessor(:subscription_line_item_attributes) do
+      [
+        :quantity,
+        :subscribable_id,
+        :interval_length,
+        :interval_units,
+        :end_date
+      ]
+    end
+
+    # SolidusSubscriptions::Subscription attributes which are allowed to
+    # be updated from user data
+    mattr_accessor(:subscription_attributes) do
+      [
+        :actionable_date,
+        shipping_address_attributes: Spree::PermittedAttributes.address_attributes
+      ]
+    end
+  end
+end

data/lib/solidus_subscriptions/engine.rb

@@ -1,56 +1,56 @@
-module SolidusSubscriptions
-  class Engine < Rails::Engine
-    require 'spree/core'
-    require 'solidus_subscriptions/permitted_attributes'
-    require 'solidus_subscriptions/config'
-    require 'solidus_subscriptions/processor'
-
-    isolate_namespace SolidusSubscriptions
-    engine_name 'solidus_subscriptions'
-
-    # use rspec for tests
-    config.generators do |g|
-      g.test_framework :rspec
-    end
-
-    config.autoload_paths << config.root.join('app', 'jobs')
-
-    initializer 'configure spree subcription permitted attributes', after: 'require subscription lib helpers' do
-      PermittedAttributes.update_spree_permiteed_attributes
-    end
-
-    initializer 'solidus_subscriptions.configs', before: "require subscription lib helpers" do
-    end
-
-    initializer 'register_subscription_promotion_rule', after: 'spree.promo.register.promotion.rules' do |app|
-      app.config.spree.promotions.rules << 'SolidusSubscriptions::SubscriptionPromotionRule'
-      app.config.spree.promotions.rules << 'SolidusSubscriptions::SubscriptionOrderPromotionRule'
-    end
-
-    initializer 'subscriptions_backend' do
-      next unless Spree::Backend::Config.respond_to?(:menu_items)
-      Spree::Backend::Config.configure do |config|
-        config.menu_items << config.class::MenuItem.new(
-          [:subscriptions],
-          'repeat',
-          url: :admin_subscriptions_path,
-          condition: ->{ can?(:admin, SolidusSubscriptions::Subscription) }
-        )
-      end
-    end
-
-    def self.activate
-      Dir.glob(File.join(File.dirname(__FILE__), '../../app/decorators/**/*.rb')) do |c|
-        Rails.configuration.cache_classes ? require(c) : load(c)
-      end
-
-      Spree::Ability.register_ability(SolidusSubscriptions::Ability)
-    end
-
-    config.to_prepare(&method(:activate).to_proc)
-  end
-
-  def self.table_name_prefix
-    'solidus_subscriptions_'
-  end
-end
+module SolidusSubscriptions
+  class Engine < Rails::Engine
+    require 'spree/core'
+    require 'solidus_subscriptions/permitted_attributes'
+    require 'solidus_subscriptions/config'
+    require 'solidus_subscriptions/processor'
+
+    isolate_namespace SolidusSubscriptions
+    engine_name 'solidus_subscriptions'
+
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+    config.autoload_paths << config.root.join('app', 'jobs')
+
+    initializer 'configure spree subcription permitted attributes', after: 'require subscription lib helpers' do
+      PermittedAttributes.update_spree_permiteed_attributes
+    end
+
+    initializer 'solidus_subscriptions.configs', before: "require subscription lib helpers" do
+    end
+
+    initializer 'register_subscription_promotion_rule', after: 'spree.promo.register.promotion.rules' do |app|
+      app.config.spree.promotions.rules << 'SolidusSubscriptions::SubscriptionPromotionRule'
+      app.config.spree.promotions.rules << 'SolidusSubscriptions::SubscriptionOrderPromotionRule'
+    end
+
+    initializer 'subscriptions_backend' do
+      next unless Spree::Backend::Config.respond_to?(:menu_items)
+      Spree::Backend::Config.configure do |config|
+        config.menu_items << config.class::MenuItem.new(
+          [:subscriptions],
+          'repeat',
+          url: :admin_subscriptions_path,
+          condition: ->{ can?(:admin, SolidusSubscriptions::Subscription) }
+        )
+      end
+    end
+
+    def self.activate
+      Dir.glob(File.join(File.dirname(__FILE__), '../../app/decorators/**/*.rb')) do |c|
+        Rails.configuration.cache_classes ? require(c) : load(c)
+      end
+
+      Spree::Ability.register_ability(SolidusSubscriptions::Ability)
+    end
+
+    config.to_prepare(&method(:activate).to_proc)
+  end
+
+  def self.table_name_prefix
+    'solidus_subscriptions_'
+  end
+end

data/lib/solidus_subscriptions/permitted_attributes.rb

@@ -1,36 +1,36 @@
-# This module is responsible for managing what attributes can be updated
-# through the api. It also overrides Spree::Permitted attributes to allow the
-# solidus api to accept nested params for subscription models as well
-module SolidusSubscriptions
-  module PermittedAttributes
-    class << self
-      def update_spree_permiteed_attributes
-        Spree::PermittedAttributes.line_item_attributes << {
-          subscription_line_items_attributes: nested(
-            subscription_line_item_attributes
-          )
-        }
-
-        Spree::PermittedAttributes.user_attributes << {
-          subscriptions_attributes: nested(subscription_attributes)
-        }
-      end
-
-      def subscription_line_item_attributes
-        [Config.subscription_line_item_attributes]
-      end
-
-      def subscription_attributes
-        Config.subscription_attributes | [
-          { line_items_attributes: nested(subscription_line_item_attributes) - [:subscribable_id] }
-        ]
-      end
-
-      private
-
-      def nested(attributes)
-        attributes | [:id]
-      end
-    end
-  end
-end
+# This module is responsible for managing what attributes can be updated
+# through the api. It also overrides Spree::Permitted attributes to allow the
+# solidus api to accept nested params for subscription models as well
+module SolidusSubscriptions
+  module PermittedAttributes
+    class << self
+      def update_spree_permiteed_attributes
+        Spree::PermittedAttributes.line_item_attributes << {
+          subscription_line_items_attributes: nested(
+            subscription_line_item_attributes
+          )
+        }
+
+        Spree::PermittedAttributes.user_attributes << {
+          subscriptions_attributes: nested(subscription_attributes)
+        }
+      end
+
+      def subscription_line_item_attributes
+        [Config.subscription_line_item_attributes]
+      end
+
+      def subscription_attributes
+        Config.subscription_attributes | [
+          { line_items_attributes: nested(subscription_line_item_attributes) - [:subscribable_id] }
+        ]
+      end
+
+      private
+
+      def nested(attributes)
+        attributes | [:id]
+      end
+    end
+  end
+end

data/lib/solidus_subscriptions/processor.rb

@@ -1,108 +1,108 @@
-# This class is responsible for finding subscriptions and installments
-# which need to be processed. It will group them together by user and attempts
-# to process them together. Subscriptions will also be grouped by their
-# shiping address id.
-#
-# This class passes the reponsibility of actually creating the order off onto
-# the consolidated installment class.
-#
-# This class generates `ProcessInstallmentsJob`s
-module SolidusSubscriptions
-  class Processor
-    class << self
-      # Find all actionable subscriptions and intallments, group them together
-      # by user, and schedule a processing job for the group as a batch
-      def run
-        batched_users_to_be_processed.each { |batch| new(batch).build_jobs }
-      end
-
-      private
-
-      def batched_users_to_be_processed
-        subscriptions = SolidusSubscriptions::Subscription.arel_table
-        installments = SolidusSubscriptions::Installment.arel_table
-
-        Spree::User.
-          joins(:subscriptions).
-          joins(
-            subscriptions.
-              join(installments, Arel::Nodes::OuterJoin).
-              on(subscriptions[:id].eq(installments[:subscription_id])).
-              join_sources
-          ).
-          where(
-            SolidusSubscriptions::Subscription.actionable.arel.constraints.reduce(:and).
-              or(SolidusSubscriptions::Installment.actionable.arel.constraints.reduce(:and))
-          ).
-          distinct.
-          find_in_batches
-      end
-    end
-
-    # @return [Array<Spree.user_class>]
-    attr_reader :users
-
-    # Get a new instance of the SolidusSubscriptions::Processor
-    #
-    # @param users [Array<Spree.user_class>] A list of users with actionable
-    #   subscriptions or installments
-    #
-    # @return [SolidusSubscriptions::Processor]
-    def initialize(users)
-      @users = users
-      @installments = {}
-    end
-
-    # Create `ProcessInstallmentsJob`s for the users used to initalize the
-    # instance
-    def build_jobs
-      users.map do |user|
-        installemts_by_address_and_user = installments(user).group_by do |i|
-          i.subscription.shipping_address_id
-        end
-
-        installemts_by_address_and_user.values.each do |grouped_installments|
-          ProcessInstallmentsJob.perform_later grouped_installments.map(&:id)
-        end
-      end
-    end
-
-    private
-
-    def subscriptions_by_id
-      @subscriptions_by_id ||= Subscription.
-        actionable.
-        includes(:line_items, :user).
-        where(user_id: user_ids).
-        group_by(&:user_id)
-    end
-
-    def retry_installments
-      @failed_installments ||= Installment.
-        actionable.
-        includes(:subscription).
-        where(solidus_subscriptions_subscriptions: { user_id: user_ids }).
-        group_by { |i| i.subscription.user_id }
-    end
-
-    def installments(user)
-      @installments[user.id] ||= retry_installments.fetch(user.id, []) + new_installments(user)
-    end
-
-    def new_installments(user)
-      ActiveRecord::Base.transaction do
-        subscriptions_by_id.fetch(user.id, []).map do |sub|
-          sub.successive_skip_count = 0
-          sub.advance_actionable_date
-          sub.cancel! if sub.pending_cancellation?
-          sub.deactivate! if sub.can_be_deactivated?
-          sub.installments.create!
-        end
-      end
-    end
-
-    def user_ids
-      @user_ids ||= users.map(&:id)
-    end
-  end
-end
+# This class is responsible for finding subscriptions and installments
+# which need to be processed. It will group them together by user and attempts
+# to process them together. Subscriptions will also be grouped by their
+# shiping address id.
+#
+# This class passes the reponsibility of actually creating the order off onto
+# the consolidated installment class.
+#
+# This class generates `ProcessInstallmentsJob`s
+module SolidusSubscriptions
+  class Processor
+    class << self
+      # Find all actionable subscriptions and intallments, group them together
+      # by user, and schedule a processing job for the group as a batch
+      def run
+        batched_users_to_be_processed.each { |batch| new(batch).build_jobs }
+      end
+
+      private
+
+      def batched_users_to_be_processed
+        subscriptions = SolidusSubscriptions::Subscription.arel_table
+        installments = SolidusSubscriptions::Installment.arel_table
+
+        Spree::User.
+          joins(:subscriptions).
+          joins(
+            subscriptions.
+              join(installments, Arel::Nodes::OuterJoin).
+              on(subscriptions[:id].eq(installments[:subscription_id])).
+              join_sources
+          ).
+          where(
+            SolidusSubscriptions::Subscription.actionable.arel.constraints.reduce(:and).
+              or(SolidusSubscriptions::Installment.actionable.arel.constraints.reduce(:and))
+          ).
+          distinct.
+          find_in_batches
+      end
+    end
+
+    # @return [Array<Spree.user_class>]
+    attr_reader :users
+
+    # Get a new instance of the SolidusSubscriptions::Processor
+    #
+    # @param users [Array<Spree.user_class>] A list of users with actionable
+    #   subscriptions or installments
+    #
+    # @return [SolidusSubscriptions::Processor]
+    def initialize(users)
+      @users = users
+      @installments = {}
+    end
+
+    # Create `ProcessInstallmentsJob`s for the users used to initalize the
+    # instance
+    def build_jobs
+      users.map do |user|
+        installemts_by_address_and_user = installments(user).group_by do |i|
+          i.subscription.shipping_address_id
+        end
+
+        installemts_by_address_and_user.values.each do |grouped_installments|
+          ProcessInstallmentsJob.perform_later grouped_installments.map(&:id)
+        end
+      end
+    end
+
+    private
+
+    def subscriptions_by_id
+      @subscriptions_by_id ||= Subscription.
+        actionable.
+        includes(:line_items, :user).
+        where(user_id: user_ids).
+        group_by(&:user_id)
+    end
+
+    def retry_installments
+      @failed_installments ||= Installment.
+        actionable.
+        includes(:subscription).
+        where(solidus_subscriptions_subscriptions: { user_id: user_ids }).
+        group_by { |i| i.subscription.user_id }
+    end
+
+    def installments(user)
+      @installments[user.id] ||= retry_installments.fetch(user.id, []) + new_installments(user)
+    end
+
+    def new_installments(user)
+      ActiveRecord::Base.transaction do
+        subscriptions_by_id.fetch(user.id, []).map do |sub|
+          sub.successive_skip_count = 0
+          sub.advance_actionable_date
+          sub.cancel! if sub.pending_cancellation?
+          sub.deactivate! if sub.can_be_deactivated?
+          sub.installments.create!
+        end
+      end
+    end
+
+    def user_ids
+      @user_ids ||= users.map(&:id)
+    end
+  end
+end