solidus_subscriptions-alpha 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f0d10eb4c148ba35b53a03253ce3ee04e8a0e4ee
+  data.tar.gz: 1aaf99dda496e4de2eb61f8ab4df96d9bc663947
+SHA512:
+  metadata.gz: f055e7676ddb8241132a8e7a0189622a9a115e88b0d9e92b274d5d795fea4a69922074c2da45e251875a1e56ac8d17f18051b72680d3a66ab048f6de9e969cb0
+  data.tar.gz: b50200bee8ed2f9e36536bad5196ba265fa98479dc12b4c0f8d0575ea962cb4d98c4446e70ecc9030906bea64dc7b08ac85d89f2a3c2df4df7d37c83127102a7

data/LICENSE

@@ -0,0 +1,26 @@
+Copyright (c) 2016 [name of plugin creator]
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+    * Neither the name Spree nor the names of its contributors may be used to
+      endorse or promote products derived from this software without specific
+      prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,128 @@
+# SolidusSubscriptions
+
+A Solidus extension for subscriptions. **Important note**: this is
+**PRE-RELEASE** software and is currently a work-in-progress. There are **no
+guarantees** this will work for your store!
+
+Sponsored by [Goby](https://www.goby.co) - Electrify your routine!
+
+## Installation
+
+Add solidus_subscriptions to your Gemfile:
+
+```ruby
+gem 'solidus_subscriptions', github: 'solidusio-contrib/solidus_subscriptions'
+```
+
+Bundle your dependencies and run the installation generator:
+
+```shell
+bundle
+bundle exec rails g solidus_subscriptions:install
+```
+
+## Configuration
+This gem requires a gateway which supports credit cards in order to process
+subscription orders.
+
+Add this to specify the gateway used by the gem:
+an initializer.
+
+```ruby
+SolidusSubscriptions::Config.default_gateway { my_gateway }
+```
+
+## Usage
+
+### Purchasing Subscriptions
+By default only Spree::Variants can be subscribed to. To subscribe to a variant, it
+must have the `:subscribable` attribute set to true.
+
+To subscribe to a variant include the following parameters when posting to
+`/orders/populate` (The add to cart button on the product page):
+
+```js
+  {
+    // other add to cart params
+    subscription_line_item: {
+      quantity: 2,              // number of units in each subscription order.
+      subscribable_id: 1234,    // Which variant the subscription is for.
+      interval_length: 1,       // The time between subscription activations.
+      interval_units: "month", // A plural qualifier for length.
+                                // Can be one of "day", "week", "month", or "year".
+      end_date: '2011/12/13'     // Stop processing after this date
+                                // (use null to process the subscription ad nauseam)
+    }
+  }
+```
+
+This will associate a `SolidusSubscriptions::LineItem` to the line item
+being added to the cart.
+
+The customer will not be charged for the subscription until it is processed. The
+subscription line items should be shown to the user on the cart page by
+looping over `Spree::Order#subscription_line_items`.
+`SolidusSubscriptions::LineItem#dummy_line_item` may be useful to help you display
+the subscription line item with your existing cart infrastructure.
+
+When the order is finalized, a `SolidusSubscriptions::Subscription` will be
+created for each group of subscription line items which can be fulfilled by a single
+subscription.
+
+#### Example:
+
+An order is finalized and has following associated subscription line items:
+
+1. { subscribable_id: 1, interval_length: 1, interval_units: 'month'}
+2. { subscribable_id: 2, interval_length: 1, interval_units: 'month' }
+3. { subscribable_id: 1, interval_length: 2, interval_units: 'month' }
+
+This will generate 2 Subscriptions objects. The first related to
+subscription_line_items 1 & 2. The second  related to line item 3.
+
+### Processing Subscriptions
+
+To process actionable subscriptions simply run:
+
+`bundle exec rake solidus_subscriptions:process`
+
+To schedule this task we suggest using the [Whenever](https://github.com/javan/whenever) gem.
+
+This task creates ActiveJobs which can be fulfilled by the queue library of your
+choice.
+
+### Guest Checkout
+
+Subscriptions require a user to be present to allow them to be managed after
+they are purchased.
+
+Because of this you must  disabling guest checkout for orders
+which contain `subscription_line_items`.
+
+An example of this would be adding this to the registration page:
+
+```erb
+<%# spree/checkout/registration.html.erb %>
+<% if Spree::Config[:allow_guest_checkout] && current_order.subscription_line_items.empty? %>
+```
+
+This allows guests to add subscriptions to their carts as guests, but forces them
+to login or create an account before purchasing them.
+
+## Testing
+
+First bundle your dependencies, then run `rake`. `rake` will default to building the dummy app if it does not exist, then it will run specs, and [Rubocop](https://github.com/bbatsov/rubocop) static code analysis. The dummy app can be regenerated by using `rake test_app`.
+
+```shell
+bundle
+bundle exec rake
+```
+
+When testing your applications integration with this extension you may use it's factories.
+Simply add this require statement to your spec_helper:
+
+```ruby
+require 'solidus_subscriptions/testing_support/factories'
+```
+
+Copyright (c) 2016 Stembolt, released under the New BSD License

data/Rakefile

@@ -0,0 +1,28 @@
+require 'bundler'
+
+Bundler::GemHelper.install_tasks
+
+begin
+  require 'spree/testing_support/extension_rake'
+  require 'rubocop/rake_task'
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+
+  task default: %i(first_run spec)
+rescue LoadError
+  # no rspec available
+end
+
+task :first_run do
+  if Dir['spec/dummy'].empty?
+    Rake::Task[:test_app].invoke
+    Dir.chdir('../../')
+  end
+end
+
+desc 'Generates a dummy app for testing'
+task :test_app do
+  ENV['LIB_NAME'] = 'solidus_subscriptions'
+  Rake::Task['extension:test_app'].invoke
+end

data/app/assets/javascripts/spree/backend/solidus_subscriptions.js

@@ -0,0 +1,2 @@
+// Placeholder manifest file.
+// the installer will append this file to the app vendored assets here: vendor/assets/javascripts/spree/backend/all.js'

data/app/assets/javascripts/spree/frontend/solidus_subscriptions.js

@@ -0,0 +1,2 @@
+// Placeholder manifest file.
+// the installer will append this file to the app vendored assets here: vendor/assets/javascripts/spree/frontend/all.js'

data/app/assets/stylesheets/spree/backend/solidus_subscriptions.css

@@ -0,0 +1,4 @@
+/*
+Placeholder manifest file.
+the installer will append this file to the app vendored assets here: 'vendor/assets/stylesheets/spree/backend/all.css'
+*/

data/app/assets/stylesheets/spree/frontend/solidus_subscriptions.css

@@ -0,0 +1,4 @@
+/*
+Placeholder manifest file.
+the installer will append this file to the app vendored assets here: 'vendor/assets/stylesheets/spree/frontend/all.css'
+*/

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

@@ -0,0 +1,35 @@
+class SolidusSubscriptions::Api::V1::LineItemsController < Spree::Api::BaseController
+  before_action :load_line_item, only: [:update, :destroy]
+  wrap_parameters :subscription_line_item
+
+  def update
+    authorize! :crud, @line_item, @order
+    if @line_item.update(line_item_params)
+      render json: @line_item.to_json
+    else
+      render json: @line_item.errors.to_json, status: 422
+    end
+  end
+
+  def destroy
+    authorize! :crud, @line_item, @order
+    return render json: {}, status: 400 if @line_item.order.complete?
+
+    @line_item.destroy!
+    @line_item.order.update!
+
+    render json: @line_item.to_json
+  end
+
+  private
+
+  def line_item_params
+    params.require(:subscription_line_item).permit(
+      SolidusSubscriptions::PermittedAttributes.subscription_line_item_attributes - [:subscribable_id]
+    )
+  end
+
+  def load_line_item
+    @line_item = SolidusSubscriptions::LineItem.find(params[:id])
+  end
+end

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

@@ -0,0 +1,44 @@
+class SolidusSubscriptions::Api::V1::SubscriptionsController < Spree::Api::BaseController
+  before_action :load_subscription, only: [:cancel, :update, :skip]
+
+  def update
+    if @subscription.update(subscription_params)
+      render json: @subscription.to_json(include: [:line_items, :shipping_address])
+    else
+      render json: @subscription.errors.to_json, status: 422
+    end
+  end
+
+  def skip
+    if @subscription.skip
+      render json: @subscription.to_json
+    else
+      render json: @subscription.errors.to_json, status: 422
+    end
+  end
+
+  def cancel
+    if @subscription.cancel
+      render json: @subscription.to_json
+    else
+      render json: @subscription.errors.to_json, status: 422
+    end
+  end
+
+  private
+
+  def load_subscription
+    @subscription = current_api_user.subscriptions.find(params[:id])
+  end
+
+  def subscription_params
+    params.require(:subscription).permit(
+      line_items_attributes: line_item_attributes,
+      shipping_address_attributes: Spree::PermittedAttributes.address_attributes
+    )
+  end
+
+  def line_item_attributes
+    SolidusSubscriptions::Config.subscription_line_item_attributes - [:subscribable_id] + [:id]
+  end
+end

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

@@ -0,0 +1,66 @@
+module Spree
+  module Admin
+    class SubscriptionsController < ResourceController
+      skip_before_action :load_resource, only: :index
+
+      def index
+        @search = SolidusSubscriptions::Subscription.
+          accessible_by(current_ability, :index).ransack(params[:q])
+
+        @subscriptions = @search.result(distinct: true).
+          includes(:line_items, :user).
+          joins(:line_items, :user).
+          page(params[:page]).
+          per(params[:per_page] || Spree::Config[:orders_per_page])
+      end
+
+      def new
+        @subscription.line_items.new
+      end
+
+      def cancel
+        @subscription.transaction do
+          @subscription.actionable_date = nil
+          @subscription.cancel
+        end
+
+        if @subscription.errors.none?
+          notice = I18n.t('spree.admin.subscriptions.successfully_canceled')
+        else
+          notice = @subscription.errors.full_messages.to_sentence
+        end
+
+        redirect_to spree.admin_subscriptions_path, notice: notice
+      end
+
+      def activate
+        @subscription.activate
+
+        if @subscription.errors.none?
+          notice = I18n.t('spree.admin.subscriptions.successfully_activated')
+        else
+          notice = @subscription.errors.full_messages.to_sentence
+        end
+
+        redirect_to spree.admin_subscriptions_path, notice: notice
+      end
+
+      def skip
+        @subscription.advance_actionable_date
+
+        notice = I18n.t(
+          'spree.admin.subscriptions.successfully_skipped',
+          date: @subscription.actionable_date
+        )
+
+        redirect_to spree.admin_subscriptions_path, notice: notice
+      end
+
+      private
+
+      def model_class
+        ::SolidusSubscriptions::Subscription
+      end
+    end
+  end
+end

data/app/decorators/spree/controllers/api/line_items/create_subscription_line_items.rb

@@ -0,0 +1,28 @@
+# Create new subscription line items associated to the current order, when
+# a line item is added to the cart which includes subscription_line_item
+# params.
+#
+# The Subscriptions::LineItem acts as a line item place holder for a
+# Subscription, indicating that it has been added to the order, but not
+# yet purchased
+module Spree
+  module Controllers::Api::LineItems::CreateSubscriptionLineItems
+    include SolidusSubscriptions::SubscriptionLineItemBuilder
+
+    def self.prepended(base)
+      base.after_action(
+        :handle_subscription_line_items,
+        only: [:create, :update],
+        if: ->{ params[:subscription_line_item] }
+      )
+    end
+
+    private
+
+    def handle_subscription_line_items
+      create_subscription_line_item(@line_item)
+    end
+  end
+end
+
+Spree::Api::LineItemsController.prepend(Spree::Controllers::Api::LineItems::CreateSubscriptionLineItems)

data/app/decorators/spree/controllers/orders/create_subscription_line_items.rb

@@ -0,0 +1,33 @@
+# Create new subscription line items associated to the current order, when
+# a line item is added to the cart which includes subscription_line_item
+# params.
+#
+# The Subscriptions::LineItem acts as a line item place holder for a
+# Subscription, indicating that it has been added to the order, but not
+# yet purchased
+module Spree
+  module Controllers
+    module Orders
+      module CreateSubscriptionLineItems
+        include SolidusSubscriptions::SubscriptionLineItemBuilder
+
+        def self.prepended(base)
+          base.after_action(
+            :handle_subscription_line_items,
+            only: :populate,
+            if: ->{ params[:subscription_line_item] }
+          )
+        end
+
+        private
+
+        def handle_subscription_line_items
+          line_item = @current_order.line_items.find_by(variant_id: params[:variant_id])
+          create_subscription_line_item(line_item)
+        end
+      end
+    end
+  end
+end
+
+Spree::OrdersController.prepend(Spree::Controllers::Orders::CreateSubscriptionLineItems)

data/app/decorators/spree/line_items/subscription_line_items_association.rb

@@ -0,0 +1,22 @@
+# Each Spree::LineItem can have multiple subscription_line_items. This
+# allows a cart to represent multiple subscriptions to the same item in
+# the same order.
+module Spree
+  module LineItems
+    module SubscriptionLineItemsAssociation
+      def self.prepended(base)
+        base.has_many(
+          :subscription_line_items,
+          class_name: 'SolidusSubscriptions::LineItem',
+          foreign_key: :spree_line_item_id,
+          inverse_of: :spree_line_item,
+          dependent: :destroy
+        )
+
+        base.accepts_nested_attributes_for :subscription_line_items
+      end
+    end
+  end
+end
+
+Spree::LineItem.prepend Spree::LineItems::SubscriptionLineItemsAssociation