solidus_subscriptions 1.0.0.rc1

data/lib/solidus_subscriptions/churn_buster/client.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module SolidusSubscriptions
+  module ChurnBuster
+    class Client
+      BASE_API_URL = 'https://api.churnbuster.io/v1'
+
+      attr_reader :account_id, :api_key
+
+      def initialize(account_id:, api_key:)
+        @account_id = account_id
+        @api_key = api_key
+      end
+
+      def report_failed_payment(order)
+        post('/failed_payments', OrderSerializer.serialize(order))
+      end
+
+      def report_successful_payment(order)
+        post('/successful_payments', OrderSerializer.serialize(order))
+      end
+
+      def report_subscription_cancellation(subscription)
+        post('/cancellations', SubscriptionSerializer.serialize(subscription))
+      end
+
+      def report_payment_method_change(subscription)
+        post('/payment_methods', SubscriptionPaymentMethodSerializer.serialize(subscription))
+      end
+
+      private
+
+      def post(path, body)
+        HTTParty.post(
+          "#{BASE_API_URL}#{path}",
+          body: body.to_json,
+          headers: {
+            'Content-Type' => 'application/json',
+          },
+          basic_auth: {
+            username: account_id,
+            password: api_key,
+          },
+        )
+      end
+    end
+  end
+end

data/lib/solidus_subscriptions/churn_buster/order_serializer.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module SolidusSubscriptions
+  module ChurnBuster
+    class OrderSerializer < Serializer
+      def to_h
+        {
+          payment: {
+            source: 'in_house',
+            source_id: object.number,
+            amount_in_cents: object.display_total.cents,
+            currency: object.currency,
+          },
+          customer: SubscriptionCustomerSerializer.serialize(object.subscription),
+        }
+      end
+    end
+  end
+end

data/lib/solidus_subscriptions/churn_buster/serializer.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module SolidusSubscriptions
+  module ChurnBuster
+    class Serializer
+      attr_reader :object
+
+      class << self
+        def serialize(object)
+          new(object).to_h
+        end
+      end
+
+      def initialize(object)
+        @object = object
+      end
+
+      def to_h
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/solidus_subscriptions/churn_buster/subscription_customer_serializer.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module SolidusSubscriptions
+  module ChurnBuster
+    class SubscriptionCustomerSerializer < Serializer
+      def to_h
+        {
+          source: 'in_house',
+          source_id: object.id,
+          email: object.user.email,
+          properties: {
+            name: name
+          },
+        }
+      end
+
+      private
+
+      def name
+        if ::Spree.solidus_gem_version < Gem::Version.new('2.11.0')
+          "#{object.shipping_address_to_use.first_name} #{object.shipping_address_to_use.last_name}"
+        else
+          object.shipping_address_to_use.name
+        end
+      end
+    end
+  end
+end

data/lib/solidus_subscriptions/churn_buster/subscription_payment_method_serializer.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module SolidusSubscriptions
+  module ChurnBuster
+    class SubscriptionPaymentMethodSerializer < Serializer
+      def to_h
+        {
+          payment_method: {
+            source: 'in_house',
+            source_id: [
+              object.payment_method_to_use&.id,
+              object.payment_source_to_use&.id
+            ].compact.join('-'),
+            type: 'card',
+            properties: payment_source_properties,
+          },
+          customer: SubscriptionCustomerSerializer.serialize(object),
+        }
+      end
+
+      private
+
+      def payment_source_properties
+        if object.payment_source.is_a?(::Spree::CreditCard)
+          {
+            brand: object.payment_source.cc_type,
+            last4: object.payment_source.last_digits,
+            exp_month: object.payment_source.month,
+            exp_year: object.payment_source.year,
+          }
+        else
+          {}
+        end
+      end
+    end
+  end
+end

data/lib/solidus_subscriptions/churn_buster/subscription_serializer.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module SolidusSubscriptions
+  module ChurnBuster
+    class SubscriptionSerializer < Serializer
+      def to_h
+        {
+          subscription: {
+            source: 'in_house',
+            source_id: object.id
+          },
+          customer: SubscriptionCustomerSerializer.serialize(object),
+        }
+      end
+    end
+  end
+end

data/lib/solidus_subscriptions/configuration.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+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,
+    )
+
+    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,
+    )
+
+    def success_dispatcher_class
+      @success_dispatcher_class ||= 'SolidusSubscriptions::Dispatcher::SuccessDispatcher'
+      @success_dispatcher_class.constantize
+    end
+
+    def failure_dispatcher_class
+      @failure_dispatcher_class ||= 'SolidusSubscriptions::Dispatcher::FailureDispatcher'
+      @failure_dispatcher_class.constantize
+    end
+
+    def payment_failed_dispatcher_class
+      @payment_failed_dispatcher_class ||= 'SolidusSubscriptions::Dispatcher::PaymentFailedDispatcher'
+      @payment_failed_dispatcher_class.constantize
+    end
+
+    def out_of_stock_dispatcher_class
+      @out_of_stock_dispatcher_class ||= 'SolidusSubscriptions::Dispatcher::OutOfStockDispatcher'
+      @out_of_stock_dispatcher_class.constantize
+    end
+
+    def maximum_successive_skips
+      @maximum_successive_skips ||= 1
+    end
+
+    def reprocessing_interval
+      @reprocessing_interval ||= 1.day
+    end
+
+    def minimum_cancellation_notice
+      @minimum_cancellation_notice ||= 0.days
+    end
+
+    def processing_queue
+      @processing_queue ||= :default
+    end
+
+    def subscription_line_item_attributes
+      @subscription_line_item_attributes ||= [
+        :quantity,
+        :subscribable_id,
+        :interval_length,
+        :interval_units,
+        :end_date,
+      ]
+    end
+
+    def subscription_attributes
+      @subscription_attributes ||= [
+        :interval_length,
+        :interval_units,
+        :end_date,
+        {
+          shipping_address_attributes: Spree::PermittedAttributes.address_attributes,
+          billing_address_attributes: Spree::PermittedAttributes.address_attributes
+        },
+      ]
+    end
+
+    def subscribable_class
+      @subscribable_class ||= 'Spree::Variant'
+      @subscribable_class.constantize
+    end
+
+    def churn_buster?
+      churn_buster_account_id.present? && churn_buster_api_key.present?
+    end
+  end
+end

data/lib/solidus_subscriptions/dispatcher/base.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module SolidusSubscriptions
+  module Dispatcher
+    class Base
+      attr_reader :installment, :order
+
+      def initialize(installment, order)
+        @installment = installment
+        @order = order
+      end
+
+      def dispatch
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/solidus_subscriptions/dispatcher/failure_dispatcher.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module SolidusSubscriptions
+  module Dispatcher
+    class FailureDispatcher < Base
+      def dispatch
+        order.touch(:completed_at)
+        order.cancel
+        installment.failed!(order)
+      end
+    end
+  end
+end

data/lib/solidus_subscriptions/dispatcher/out_of_stock_dispatcher.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module SolidusSubscriptions
+  module Dispatcher
+    class OutOfStockDispatcher < Base
+      def dispatch
+        installment.out_of_stock
+      end
+    end
+  end
+end

data/lib/solidus_subscriptions/dispatcher/payment_failed_dispatcher.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module SolidusSubscriptions
+  module Dispatcher
+    class PaymentFailedDispatcher < Base
+      def dispatch
+        order.touch(:completed_at)
+        order.cancel
+        installment.payment_failed!(order)
+
+        ::Spree::Event.fire(
+          'solidus_subscriptions.installment_failed_payment',
+          installment: installment,
+          order: order,
+        )
+      end
+    end
+  end
+end

data/lib/solidus_subscriptions/dispatcher/success_dispatcher.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module SolidusSubscriptions
+  module Dispatcher
+    class SuccessDispatcher < Base
+      def dispatch
+        installment.success!(order)
+
+        ::Spree::Event.fire(
+          'solidus_subscriptions.installment_succeeded',
+          installment: installment,
+          order: order,
+        )
+      end
+    end
+  end
+end

data/lib/solidus_subscriptions/engine.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'spree/core'
+
+require 'solidus_subscriptions'
+require 'solidus_subscriptions/permitted_attributes'
+require 'solidus_subscriptions/configuration'
+require 'solidus_subscriptions/processor'
+
+module SolidusSubscriptions
+  class Engine < Rails::Engine
+    include SolidusSupport::EngineExtensions
+
+    isolate_namespace SolidusSubscriptions
+
+    engine_name 'solidus_subscriptions'
+
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+    initializer 'solidus_subscriptions.update_permitted_attributes' do
+      ::Spree::PermittedAttributes.line_item_attributes << {
+        subscription_line_items_attributes: PermittedAttributes.subscription_line_item_attributes | [:id],
+      }
+
+      ::Spree::PermittedAttributes.user_attributes << {
+        subscriptions_attributes: PermittedAttributes.subscription_attributes | [:id],
+      }
+    end
+
+    initializer 'solidus_subscriptions.register_promotion_rules', after: 'spree.promo.register.promotion.rules' do |app|
+      app.config.spree.promotions.rules << 'SolidusSubscriptions::Promotion::Rules::SubscriptionCreationOrder'
+      app.config.spree.promotions.rules << 'SolidusSubscriptions::Promotion::Rules::SubscriptionInstallmentOrder'
+    end
+
+    initializer 'solidus_subscriptions.configure_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) },
+          match_path: '/subscriptions'
+        )
+      end
+    end
+  end
+
+  def self.table_name_prefix
+    'solidus_subscriptions_'
+  end
+end

data/lib/solidus_subscriptions/permission_sets/default_customer.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+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|
+          (subscription.guest_token.present? && subscription.guest_token == guest_token) ||
+            (subscription.user && subscription.user == user)
+        end
+
+        can [:show, :display, :update, :destroy], LineItem do |line_item, guest_token|
+          (line_item.subscription&.guest_token.present? && line_item.subscription.guest_token == guest_token) ||
+            (line_item.subscription&.user && line_item.subscription.user == user)
+        end
+      end
+    end
+  end
+end

data/lib/solidus_subscriptions/permission_sets/subscription_management.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module SolidusSubscriptions
+  module PermissionSets
+    class SubscriptionManagement < ::Spree::PermissionSets::Base
+      def activate!
+        can :manage, Subscription
+        can :manage, LineItem
+      end
+    end
+  end
+end