solidus_subscriptions 1.0.0.rc1

data/lib/solidus_subscriptions/permitted_attributes.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# 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 subscription_line_item_attributes
+        [SolidusSubscriptions.configuration.subscription_line_item_attributes]
+      end
+
+      def subscription_attributes
+        SolidusSubscriptions.configuration.subscription_attributes | [
+          line_items_attributes: (subscription_line_item_attributes | [:id] - [:subscribable_id]),
+        ]
+      end
+    end
+  end
+end

data/lib/solidus_subscriptions/processor.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module SolidusSubscriptions
+  class Processor
+    class << self
+      def run
+        SolidusSubscriptions::Subscription
+          .where(installments: SolidusSubscriptions::Installment.actionable)
+          .or(SolidusSubscriptions::Subscription.actionable)
+          .distinct
+          .find_each do |subscription|
+            ProcessSubscriptionJob.perform_later(subscription)
+          end
+      end
+    end
+  end
+end

data/lib/solidus_subscriptions/subscription_generator.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+# This module is responsible for taking SolidusSubscriptions::LineItem
+# objects and creating SolidusSubscriptions::Subscription Objects
+module SolidusSubscriptions
+  module SubscriptionGenerator
+    extend self
+
+    SubscriptionConfiguration = Struct.new(:interval_length, :interval_units, :end_date)
+
+    # Create and persist a subscription for a collection of subscription
+    #   line items
+    #
+    # @param subscription_line_items [Array<SolidusSubscriptions::LineItem>] The
+    #   subscription_line_items to be activated
+    #
+    # @return [SolidusSubscriptions::Subscription]
+    def activate(subscription_line_items)
+      return if subscription_line_items.empty?
+
+      order = subscription_line_items.first.order
+      configuration = subscription_configuration(subscription_line_items.first)
+
+      subscription_attributes = {
+        user: order.user,
+        line_items: subscription_line_items,
+        store: order.store,
+        shipping_address: order.ship_address,
+        billing_address: order.bill_address,
+        payment_source: order.payments.valid.last&.payment_source,
+        payment_method: order.payments.valid.last&.payment_method,
+        currency: order.currency,
+        **configuration.to_h
+      }
+
+      Subscription.create!(subscription_attributes) do |sub|
+        sub.actionable_date = sub.next_actionable_date
+      end.tap do |_subscription|
+        cleanup_subscription_line_items(subscription_line_items)
+      end
+    end
+
+    # Group a collection of line items by common subscription configuration
+    # options. Grouped subscription_line_items can belong to a single
+    # subscription.
+    #
+    # @param subscription_line_items [Array<SolidusSubscriptions::LineItem>] The
+    #   subscription_line_items to be grouped.
+    #
+    # @return [Array<Array<SolidusSubscriptions::LineItem>>]
+    def group(subscription_line_items)
+      subscription_line_items.group_by do |li|
+        subscription_configuration(li)
+      end.
+        values
+    end
+
+    private
+
+    def cleanup_subscription_line_items(subscription_line_items)
+      ids = subscription_line_items.pluck :id
+      SolidusSubscriptions::LineItem.where(id: ids).update_all(
+        interval_length: nil,
+        interval_units: nil,
+        end_date: nil
+      )
+    end
+
+    def subscription_configuration(subscription_line_item)
+      SubscriptionConfiguration.new(
+        subscription_line_item.interval_length,
+        subscription_line_item.interval_units,
+        subscription_line_item.end_date
+      )
+    end
+  end
+end

data/lib/solidus_subscriptions/subscription_line_item_builder.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module SolidusSubscriptions
+  module SubscriptionLineItemBuilder
+    private
+
+    def create_subscription_line_item(line_item)
+      SolidusSubscriptions::LineItem.create!(
+        subscription_params.merge(spree_line_item: line_item)
+      )
+
+      # Rerun the promotion handler to pickup subscription promotions
+      ::Spree::PromotionHandler::Cart.new(line_item.order).activate
+      line_item.order.recalculate
+    end
+
+    def subscription_params
+      params.require(:subscription_line_item).permit(
+        SolidusSubscriptions.configuration.subscription_line_item_attributes
+      )
+    end
+  end
+end

data/lib/solidus_subscriptions/testing_support/factories/installment_detail_factory.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :installment_detail, class: 'SolidusSubscriptions::InstallmentDetail' do
+    installment
+
+    trait(:success) {
+      success { true }
+    }
+  end
+end

data/lib/solidus_subscriptions/testing_support/factories/installment_factory.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :installment, class: 'SolidusSubscriptions::Installment' do
+    transient {
+      subscription_traits { [] }
+    }
+    subscription { association(:subscription, :with_line_item, *subscription_traits) }
+
+    trait :failed do
+      actionable_date { Time.zone.yesterday }
+      details { [association(:installment_detail, installment: @instance)] }
+    end
+
+    trait :success do
+      transient do
+        order { create :completed_order_with_totals }
+      end
+
+      details do
+        [association(:installment_detail, :success, installment: @instance, order: order)]
+      end
+    end
+
+    trait :actionable do
+      actionable_date { Time.zone.now }
+    end
+  end
+end

data/lib/solidus_subscriptions/testing_support/factories/line_item_factory.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :subscription_line_item, class: 'SolidusSubscriptions::LineItem' do
+    subscribable_id { create(:variant, subscribable: true).id }
+    quantity { 1 }
+    interval_length { 1 }
+    interval_units { :month }
+
+    association :spree_line_item, factory: :line_item
+
+    trait :with_subscription do
+      transient do
+        subscription_traits { [] }
+      end
+
+      subscription { association :subscription, *subscription_traits }
+    end
+  end
+end

data/lib/solidus_subscriptions/testing_support/factories/spree/line_item_factory.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+FactoryBot.modify do
+  factory :line_item do
+    trait :with_subscription_line_items do
+      transient do
+        n_subscription_line_items { 1 }
+      end
+
+      subscription_line_items do
+        Array.new(n_subscription_line_items) do
+          association :subscription_line_item, spree_line_item: @instance
+        end
+      end
+    end
+  end
+end

data/lib/solidus_subscriptions/testing_support/factories/spree/order_factory.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+FactoryBot.modify do
+  factory :order do
+    trait :with_subscription_line_items do
+      transient do
+        n_line_items { 1 }
+      end
+
+      line_items do
+        Array.new(n_line_items) do
+          association :line_item, :with_subscription_line_items, order: @instance
+        end
+      end
+    end
+  end
+end

data/lib/solidus_subscriptions/testing_support/factories/spree_modification_factory.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+FactoryBot.modify do
+  factory :user do
+    trait :subscription_user do
+      bill_address
+      ship_address
+    end
+  end
+end

data/lib/solidus_subscriptions/testing_support/factories/subscription_event_factory.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :subscription_event, class: 'SolidusSubscriptions::SubscriptionEvent' do
+    subscription
+    event_type { 'test_event' }
+  end
+end

data/lib/solidus_subscriptions/testing_support/factories/subscription_factory.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :subscription, class: 'SolidusSubscriptions::Subscription' do
+    store
+    interval_length { 1 }
+    interval_units { :month }
+    currency { 'USD' }
+
+    user do
+      new_user = create(:user, :subscription_user)
+      card = create(:credit_card, gateway_customer_profile_id: 'BGS-123', user: new_user)
+      wallet_payment_source = new_user.wallet.add(card)
+      new_user.wallet.default_wallet_payment_source = wallet_payment_source
+      new_user
+    end
+
+    trait :with_line_item do
+      transient do
+        line_item_traits { [] }
+      end
+
+      line_items { [association(:subscription_line_item, *line_item_traits)] }
+    end
+
+    trait :with_shipping_address do
+      association :shipping_address, factory: :address
+    end
+
+    trait :with_billing_address do
+      association :billing_address, factory: :address
+    end
+
+    trait :actionable do
+      with_line_item
+      actionable_date { Time.zone.now.yesterday.beginning_of_minute }
+    end
+
+    trait :not_actionable do
+      with_line_item
+      actionable_date { Time.zone.now.tomorrow.beginning_of_minute }
+    end
+
+    trait(:pending_cancellation) do
+      actionable
+      state { 'pending_cancellation' }
+    end
+
+    trait(:canceled) {
+      state { 'canceled' }
+    }
+    trait(:inactive) {
+      state { 'inactive' }
+    }
+  end
+end

data/lib/solidus_subscriptions/version.rb

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

data/lib/tasks/process_subscriptions.rake

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+namespace :solidus_subscriptions do
+  desc 'Create orders for actionable subscriptions'
+  task process: :environment do
+    SolidusSubscriptions::Processor.run
+  end
+end

data/reference/solidus_subscriptions.v1.yaml

@@ -0,0 +1,290 @@
+openapi: 3.0.0
+info:
+  title: solidus_subscriptions
+  version: '1.0'
+servers:
+  - url: 'http://localhost:3000'
+paths:
+  '/api/orders/{order_id}/line_items':
+    parameters:
+      - schema:
+          type: string
+        name: order_id
+        in: path
+        required: true
+    post:
+      summary: Create Subscription Line Item
+      tags:
+        - Subscription Line Items
+      responses: {}
+      operationId: post-api-orders-order_id-line_items
+      requestBody:
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                subscription_line_item:
+                  $ref: '#/components/schemas/SubscriptionLineItem'
+  '/subscriptions/api/v1/line_items/{id}':
+    parameters:
+      - schema:
+          type: string
+        name: id
+        in: path
+        required: true
+    patch:
+      summary: Update Subscription Line Item
+      tags:
+        - Subscription Line Items
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/SubscriptionLineItemOutput'
+      operationId: patch-subscriptions-api-v1-line_item-id
+      requestBody:
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                subscription_line_item:
+                  $ref: '#/components/schemas/SubscriptionLineItem'
+    delete:
+      summary: Delete Subscription Line Item
+      operationId: delete-subscriptions-api-v1-line_item-id
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/SubscriptionLineItemOutput'
+      description: ''
+      tags:
+        - Subscription Line Items
+  '/subscriptions/api/v1/subscriptions/:id/skip':
+    post:
+      summary: Skip Subscription
+      tags:
+        - Subscriptions
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/SubscriptionOutput'
+      operationId: 'post-subscriptions-api-v1-subscriptions-:id-skip'
+  '/subscriptions/api/v1/subscriptions/{id}/cancel':
+    parameters:
+      - schema:
+          type: string
+        name: id
+        in: path
+        required: true
+    post:
+      summary: Cancel Subscription
+      tags:
+        - Subscriptions
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/SubscriptionOutput'
+      operationId: post-subscriptions-api-v1-subscriptions-id-cancel
+  '/subscriptions/api/v1/subscriptions/{id}':
+    parameters:
+      - schema:
+          type: string
+        name: id
+        in: path
+        required: true
+    patch:
+      summary: Update Subscription
+      tags:
+        - Subscriptions
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                allOf:
+                  - type: object
+                    properties:
+                      line_items:
+                        type: array
+                        items:
+                          $ref: '#/components/schemas/SubscriptionLineItemOutput'
+                      shipping_address:
+                        type: object
+                      billing_address:
+                        type: object
+                  - $ref: '#/components/schemas/SubscriptionOutput'
+      operationId: patch-subscriptions-api-v1-subscriptions-id
+      requestBody:
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                subscription:
+                  allOf:
+                    - type: object
+                      properties:
+                        line_items_attributes:
+                          type: array
+                          items:
+                            $ref: '#/components/schemas/SubscriptionLineItem'
+                        shipping_address_attributes:
+                          type: object
+                        billing_address_attributes:
+                          type: object
+                    - $ref: '#/components/schemas/Subscription'
+  '/subscriptions/api/v1/subscriptions/{id}/activate':
+    parameters:
+      - schema:
+          type: string
+        name: id
+        in: path
+        required: true
+    post:
+      summary: Activate Subscription
+      tags:
+        - Subscriptions
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/SubscriptionOutput'
+      operationId: post-subscriptions-api-v1-subscriptions-id-activate
+components:
+  schemas:
+    SubscriptionLineItem:
+      title: SubscriptionLineItem
+      type: object
+      properties:
+        quantity:
+          type: integer
+          minimum: 1
+        end_date:
+          type: string
+          format: date
+        interval_length:
+          type: integer
+          minimum: 1
+        interval_units:
+          type: string
+          enum:
+            - day
+            - week
+            - month
+            - year
+        subscribable_id:
+          type: integer
+      required:
+        - quantity
+        - end_date
+        - interval_length
+        - interval_units
+        - subscribable_id
+      x-tags:
+        - Models
+    SubscriptionLineItemOutput:
+      title: SubscriptionLineItemOutput
+      allOf:
+        - $ref: '#/components/schemas/SubscriptionLineItem'
+        - type: object
+          properties:
+            id:
+              type: integer
+            spree_line_item_id:
+              type: integer
+            subscription_id:
+              type: integer
+            created_at:
+              type: string
+              format: date-time
+            updated_at:
+              type: string
+              format: date-time
+          required:
+            - id
+            - spree_line_item_id
+            - subscription_id
+            - created_at
+            - updated_at
+      x-tags:
+        - Models
+    Subscription:
+      title: Subscription
+      type: object
+      x-tags:
+        - Models
+      properties:
+        actionable_date:
+          type: string
+          format: date
+        interval_units:
+          type: string
+          enum:
+            - day
+            - week
+            - month
+            - year
+        interval_length:
+          type: string
+        end_date:
+          type: string
+          format: date
+      required:
+        - actionable_date
+        - interval_units
+        - interval_length
+        - end_date
+    SubscriptionOutput:
+      title: SubscriptionOutput
+      allOf:
+        - $ref: '#/components/schemas/Subscription'
+        - type: object
+          properties:
+            id:
+              type: integer
+            created_at:
+              type: string
+              format: date-time
+            updated_at:
+              type: string
+              format: date-time
+            state:
+              type: string
+              enum:
+                - active
+                - canceled
+                - pending_cancellation
+                - inactive
+            user_id:
+              type: integer
+            processing_state:
+              type: string
+              enum:
+                - pending
+                - success
+                - failed
+          required:
+            - id
+            - created_at
+            - updated_at
+            - state
+            - user_id
+            - processing_state
+      x-tags:
+        - Models