solidus_subscriptions-alpha 0.0.3 → 0.0.4

data/app/models/solidus_subscriptions/dispatcher.rb

@@ -1,32 +1,32 @@
-module SolidusSubscriptions
-  class Dispatcher
-    attr_reader :installments, :order
-
-    # Get a new instance of the FailureDispatcher
-    #
-    # @param installments [Array<SolidusSubscriptions::Installment>] The
-    #   installments which have failed to be fulfilled
-    #
-    # @return [SolidusSubscriptions::FailureDispatcher]
-    def initialize(installments, order = nil)
-      @installments = installments
-      @order = order
-    end
-
-    def dispatch
-      notify
-    end
-
-    private
-
-    def notify
-      Rails.logger.tagged('Event') do
-        Rails.logger.info message.squish.tr("\n", ' ')
-      end
-    end
-
-    def message
-      raise 'A message should be set in subclasses of Dispatcher'
-    end
-  end
-end
+module SolidusSubscriptions
+  class Dispatcher
+    attr_reader :installments, :order
+
+    # Get a new instance of the FailureDispatcher
+    #
+    # @param installments [Array<SolidusSubscriptions::Installment>] The
+    #   installments which have failed to be fulfilled
+    #
+    # @return [SolidusSubscriptions::FailureDispatcher]
+    def initialize(installments, order = nil)
+      @installments = installments
+      @order = order
+    end
+
+    def dispatch
+      notify
+    end
+
+    private
+
+    def notify
+      Rails.logger.tagged('Event') do
+        Rails.logger.info message.squish.tr("\n", ' ')
+      end
+    end
+
+    def message
+      raise 'A message should be set in subclasses of Dispatcher'
+    end
+  end
+end

data/app/models/solidus_subscriptions/failure_dispatcher.rb

@@ -1,19 +1,19 @@
-# A handler for behaviour that should happen after installments are marked as
-# failures
-module SolidusSubscriptions
-  class FailureDispatcher < Dispatcher
-    def dispatch
-      order.touch :completed_at
-      order.cancel!
-      installments.each { |i| i.failed!(order) }
-      super
-    end
-
-    def message
-      "
-      Something went wrong processing installments: #{installments.map(&:id).join(', ')}.
-      They have been marked for reprocessing.
-      "
-    end
-  end
-end
+# A handler for behaviour that should happen after installments are marked as
+# failures
+module SolidusSubscriptions
+  class FailureDispatcher < Dispatcher
+    def dispatch
+      order.touch :completed_at
+      order.cancel!
+      installments.each { |i| i.failed!(order) }
+      super
+    end
+
+    def message
+      "
+      Something went wrong processing installments: #{installments.map(&:id).join(', ')}.
+      They have been marked for reprocessing.
+      "
+    end
+  end
+end

data/app/models/solidus_subscriptions/installment.rb

@@ -1,126 +1,126 @@
-# This class represents a single iteration of a subscription. It is fulfulled
-# by a conmpleted order and maintains an association which tracks all attempts
-# successful or othewise at fulfulling this installment
-module SolidusSubscriptions
-  class Installment < ActiveRecord::Base
-    has_many :details, class_name: 'SolidusSubscriptions::InstallmentDetail'
-    belongs_to(
-      :subscription,
-      class_name: 'SolidusSubscriptions::Subscription',
-      inverse_of: :installments
-    )
-
-    validates :subscription, presence: true
-
-    scope :fulfilled, (lambda do
-      joins(:details).where(InstallmentDetail.table_name => { success: true }).distinct
-    end)
-
-    scope :unfulfilled, (lambda do
-      fulfilled_ids = fulfilled.pluck(:id)
-      where.not(id: fulfilled_ids).distinct
-    end)
-
-    scope :actionable, (lambda do
-      unfulfilled.where("#{table_name}.actionable_date <= ?", Time.zone.now)
-    end)
-
-    # Get the builder for the subscription_line_item. This will be an
-    # object that can generate the appropriate line item for the subscribable
-    # object
-    #
-    # @return [SolidusSubscriptions::LineItemBuilder]
-    def line_item_builder
-      subscription.line_item_builder
-    end
-
-    # Mark this installment as out of stock.
-    #
-    # @return [SolidusSubscriptions::InstallmentDetail] The record of the failed
-    #   processing attempt
-    def out_of_stock
-      advance_actionable_date!
-
-      details.create!(
-        success: false,
-        message: I18n.t('solidus_subscriptions.installment_details.out_of_stock')
-      )
-    end
-
-    # Mark this installment as a success
-    #
-    # @param order [Spree::Order] The order generated for this processing
-    #   attempt
-    #
-    # @return [SolidusSubscriptions::InstallmentDetail] The record of the
-    #   successful processing attempt
-    def success!(order)
-      update!(actionable_date: nil)
-
-      details.create!(
-        success: true,
-        order: order,
-        message: I18n.t('solidus_subscriptions.installment_details.success')
-      )
-    end
-
-    # Mark this installment as a failure
-    #
-    # @param order [Spree::Order] The order generated for this processing
-    #   attempt
-    #
-    # @return [SolidusSubscriptions::InstallmentDetail] The record of the
-    #   failed processing attempt
-    def failed!(order)
-      advance_actionable_date!
-
-      details.create!(
-        success: false,
-        order: order,
-        message: I18n.t('solidus_subscriptions.installment_details.failed')
-      )
-    end
-
-    # Does this installment still need to be fulfilled by a completed order
-    #
-    # @return [Boolean]
-    def unfulfilled?
-      !fulfilled?
-    end
-
-    # Had this installment been fulfilled by a completed order
-    #
-    # @return [Boolean]
-    def fulfilled?
-      details.where(success: true).exists?
-    end
-
-    # Mark this installment as having a failed payment
-    #
-    # @param order [Spree::Order] The order generated for this processing
-    #   attempt
-    #
-    # @return [SolidusSubscriptions::InstallmentDetail] The record of the
-    #   failed processing attempt
-    def payment_failed!(order)
-      advance_actionable_date!
-
-      details.create!(
-        success: false,
-        order: order,
-        message: I18n.t('solidus_subscriptions.installment_details.payment_failed')
-      )
-    end
-
-    private
-
-    def advance_actionable_date!
-      update!(actionable_date: next_actionable_date)
-    end
-
-    def next_actionable_date
-      return if Config.reprocessing_interval.nil?
-      (DateTime.current + Config.reprocessing_interval).beginning_of_minute
-    end
-  end
-end
+# This class represents a single iteration of a subscription. It is fulfulled
+# by a conmpleted order and maintains an association which tracks all attempts
+# successful or othewise at fulfulling this installment
+module SolidusSubscriptions
+  class Installment < ActiveRecord::Base
+    has_many :details, class_name: 'SolidusSubscriptions::InstallmentDetail'
+    belongs_to(
+      :subscription,
+      class_name: 'SolidusSubscriptions::Subscription',
+      inverse_of: :installments
+    )
+
+    validates :subscription, presence: true
+
+    scope :fulfilled, (lambda do
+      joins(:details).where(InstallmentDetail.table_name => { success: true }).distinct
+    end)
+
+    scope :unfulfilled, (lambda do
+      fulfilled_ids = fulfilled.pluck(:id)
+      where.not(id: fulfilled_ids).distinct
+    end)
+
+    scope :actionable, (lambda do
+      unfulfilled.where("#{table_name}.actionable_date <= ?", Time.zone.now)
+    end)
+
+    # Get the builder for the subscription_line_item. This will be an
+    # object that can generate the appropriate line item for the subscribable
+    # object
+    #
+    # @return [SolidusSubscriptions::LineItemBuilder]
+    def line_item_builder
+      subscription.line_item_builder
+    end
+
+    # Mark this installment as out of stock.
+    #
+    # @return [SolidusSubscriptions::InstallmentDetail] The record of the failed
+    #   processing attempt
+    def out_of_stock
+      advance_actionable_date!
+
+      details.create!(
+        success: false,
+        message: I18n.t('solidus_subscriptions.installment_details.out_of_stock')
+      )
+    end
+
+    # Mark this installment as a success
+    #
+    # @param order [Spree::Order] The order generated for this processing
+    #   attempt
+    #
+    # @return [SolidusSubscriptions::InstallmentDetail] The record of the
+    #   successful processing attempt
+    def success!(order)
+      update!(actionable_date: nil)
+
+      details.create!(
+        success: true,
+        order: order,
+        message: I18n.t('solidus_subscriptions.installment_details.success')
+      )
+    end
+
+    # Mark this installment as a failure
+    #
+    # @param order [Spree::Order] The order generated for this processing
+    #   attempt
+    #
+    # @return [SolidusSubscriptions::InstallmentDetail] The record of the
+    #   failed processing attempt
+    def failed!(order)
+      advance_actionable_date!
+
+      details.create!(
+        success: false,
+        order: order,
+        message: I18n.t('solidus_subscriptions.installment_details.failed')
+      )
+    end
+
+    # Does this installment still need to be fulfilled by a completed order
+    #
+    # @return [Boolean]
+    def unfulfilled?
+      !fulfilled?
+    end
+
+    # Had this installment been fulfilled by a completed order
+    #
+    # @return [Boolean]
+    def fulfilled?
+      details.where(success: true).exists?
+    end
+
+    # Mark this installment as having a failed payment
+    #
+    # @param order [Spree::Order] The order generated for this processing
+    #   attempt
+    #
+    # @return [SolidusSubscriptions::InstallmentDetail] The record of the
+    #   failed processing attempt
+    def payment_failed!(order)
+      advance_actionable_date!
+
+      details.create!(
+        success: false,
+        order: order,
+        message: I18n.t('solidus_subscriptions.installment_details.payment_failed')
+      )
+    end
+
+    private
+
+    def advance_actionable_date!
+      update!(actionable_date: next_actionable_date)
+    end
+
+    def next_actionable_date
+      return if Config.reprocessing_interval.nil?
+      (DateTime.current + Config.reprocessing_interval).beginning_of_minute
+    end
+  end
+end

data/app/models/solidus_subscriptions/installment_detail.rb

@@ -1,23 +1,23 @@
-# This class represents a single attempt to fulfill an installment. It will
-# indicate the result of that attept.
-module SolidusSubscriptions
-  class InstallmentDetail < ActiveRecord::Base
-    belongs_to(
-      :installment,
-      class_name: 'SolidusSubscriptions::Installment',
-      inverse_of: :details
-    )
-
-    belongs_to(:order, class_name: 'Spree::Order')
-
-    validates :installment, presence: true
-    alias_attribute :successful, :success
-
-    # Was the attempt at fulfilling this installment a failure?
-    #
-    # @return [Boolean]
-    def failed?
-      !success
-    end
-  end
-end
+# This class represents a single attempt to fulfill an installment. It will
+# indicate the result of that attept.
+module SolidusSubscriptions
+  class InstallmentDetail < ActiveRecord::Base
+    belongs_to(
+      :installment,
+      class_name: 'SolidusSubscriptions::Installment',
+      inverse_of: :details
+    )
+
+    belongs_to(:order, class_name: 'Spree::Order')
+
+    validates :installment, presence: true
+    alias_attribute :successful, :success
+
+    # Was the attempt at fulfilling this installment a failure?
+    #
+    # @return [Boolean]
+    def failed?
+      !success
+    end
+  end
+end

data/app/models/solidus_subscriptions/interval.rb

@@ -1,24 +1,24 @@
-# This module is intended to be included into any active record
-# modle which needs to be aware of how intervals and stored and
-# calculated in the db.
-#
-# Base models must have the following fields: interval_length (integer) and interval_units (integer)
-module SolidusSubscriptions
-  module Interval
-    def self.included(base)
-      base.enum interval_units: {
-        day: 0,
-        week: 1,
-        month: 2,
-        year: 3
-      }
-    end
-
-    # Calculates the number of seconds in the interval.
-    #
-    # @return [Integer] The number of seconds.
-    def interval
-      ActiveSupport::Duration.new(interval_length, { interval_units.pluralize.to_sym => interval_length })
-    end
-  end
-end
+# This module is intended to be included into any active record
+# modle which needs to be aware of how intervals and stored and
+# calculated in the db.
+#
+# Base models must have the following fields: interval_length (integer) and interval_units (integer)
+module SolidusSubscriptions
+  module Interval
+    def self.included(base)
+      base.enum interval_units: {
+        day: 0,
+        week: 1,
+        month: 2,
+        year: 3
+      }
+    end
+
+    # Calculates the number of seconds in the interval.
+    #
+    # @return [Integer] The number of seconds.
+    def interval
+      ActiveSupport::Duration.new(interval_length, { interval_units.pluralize.to_sym => interval_length })
+    end
+  end
+end