solidus_reserved_stock 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b2e6f8b25eafcc693df3c6a0265b6b77a1933f7b
+  data.tar.gz: 45d79df61fb6aa548b0de3aff91dd3b3ab4b73cb
+SHA512:
+  metadata.gz: a69bfc8336e4aec5044698ed7328a7ad9fe06b825b608729bf77db09125e3addf16aa7d041489e9b10f2fcffdcb53b6559f5d924bddd314dece262bd56a0df08
+  data.tar.gz: 7be1f324cd678cbcd0119c5f2e103c49cd7783c018807522821f1a4147f73f0ea75c0150b2d68fbda460b970724fe81a5976e32b786ce4990793c7ab20892454

data/.gitignore

@@ -0,0 +1,11 @@
+/_yardoc/
+/.bundle/
+/.gems
+/.yardoc
+/coverage/
+/doc/
+/Gemfile.lock
+/pkg/
+/spec/reports/
+/tmp/
+/spec/dummy/

data/.rspec

@@ -0,0 +1,3 @@
+--profile
+--color
+--format documentation

data/.rubocop.yml

@@ -0,0 +1,21 @@
+# This is the configuration used to check the rubocop source code.
+# See https://github.com/bbatsov/rubocop/blob/master/config/default.yml for info
+
+AllCops:
+  Exclude:
+    - 'vendor/**/*'
+    - 'spec/fixtures/**/*'
+  Rails:
+    Enabled: true
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+  SupportedStyles:
+    - single_quotes
+    - double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+  SupportedStyles:
+    - single_quotes
+    - double_quotes

data/.ruby-gemset

@@ -0,0 +1 @@
+.gems

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,21 @@
+source "https://rubygems.org"
+
+gem "solidus", github: "solidusio/solidus", branch: "v1.2"
+
+group :development do
+  gem "i18n-tasks"
+end
+
+group :test do
+  gem "database_cleaner"
+end
+
+gemspec
+
+if ENV["DB"] == "mysql"
+  gem "mysql2", "~> 0.3.20"
+elsif ENV["DB"] == "postgres"
+  gem "pg"
+else
+  gem "sqlite3", "~> 1.3.10"
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Isaac Freeman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,74 @@
+# SolidusReservedStock
+
+Allow stock to be reserved for a given user, so it can't be purchased by other users.
+
+When a customer reserves stock, it's moved from its normal stock location to a special reserved stock location. When a customer checks out, their reserved items will be used first to fulfill their order.
+
+Reserved stock can be restored to its original stock location at any time, and can be stored with an expiry date for the reservation.
+
+## How it works
+TODO
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'solidus_reserved_stock'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install solidus_reserved_stock
+
+## Usage
+
+<!-- TODO: Write usage instructions here -->
+
+### API Usage
+`GET    /api/v1/reserved_stock_items.json`
+Retrieve all reserved stock items
+
+`GET    /api/v1/user/:user_id/reserved_stock_items.json`
+Retrieve reserved stock items for a given user
+
+`POST   /api/v1/reserved_stock_items/reserve.json`
+Reserve stock for a given user.
+Parameters:
+- `variant_id` or `sku` to identify the variant (one of these is required)
+- `original_stock_location_id` to remove stock from (required)
+- `user_id` identifying the user the stock will be reserved for (required)
+- `quantity` of stock to reserve (required)
+- `expires_at` date when the reservation ends and stock can be returned to the original stock location (optional)
+
+`POST   /api/v1/reserved_stock_items/restock.json`
+Return reserved stock to its original stock location.
+Parameters:
+- `variant_id` or `sku` to identify the variant (one of these is required)
+- `user_id` identifying the user the stock was be reserved for (required)
+- `quantity` of stock to restore (optional – if not present, the full amount of reserved stock will be restored)
+
+`POST   /api/v1/reserved_stock_items/restock_expired.json`
+Restock all reserved items whose expiry date has passed.
+
+`GET    /api/stock_locations(.:format)`
+This is the same as the standard Solidus route, but the response is decorated to include a `reserved_items` parameter indicating whether the stock location is for reserved stock items.
+
+`GET    /api/variants/:id?user_id=:user_id`
+`GET    /api/products/:id?user_id=:user_id`
+Same as the standard Solidus routes, but accept an optional `user_id` parameter
+so that `total_on_hand` can include reserved stock for the user.
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/resolve/solidus_reserved_stock. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,26 @@
+require "bundler/gem_tasks"
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/packagetask'
+require 'rubygems/package_task'
+require 'rspec/core/rake_task'
+require 'spree/testing_support/common_rake'
+require 'solidus_reserved_stock'
+
+Bundler::GemHelper.install_tasks
+RSpec::Core::RakeTask.new
+
+task default: :spec
+
+spec = eval(File.read('solidus_reserved_stock.gemspec'))
+
+Gem::PackageTask.new(spec) do |p|
+  p.gem_spec = spec
+end
+
+desc 'Generates a dummy app for testing'
+task :test_app do
+  ENV['LIB_NAME'] = 'solidus_reserved_stock'
+  Rake::Task['common:test_app'].invoke
+end

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

@@ -0,0 +1,88 @@
+module Spree
+  module Admin
+    class ReservedStockItemsController < ResourceController
+      before_action :load_user, only: [:index, :create, :new, :restock]
+      before_action :load_variants, only: [:create, :new]
+      before_action :load_original_stock_locations, only: [:create, :new]
+
+      class_attribute :variant_display_attributes
+      self.variant_display_attributes = [
+        { translation_key: :sku, attr_name: :sku },
+        { translation_key: :name, attr_name: :name }
+      ]
+
+      def index
+        @reserved_stock_items = @user.reserved_stock_items
+        @variant_display_attributes = self.class.variant_display_attributes
+      end
+
+      def create
+        validator = Spree::Api::V1::Validators::ReserveStockParamsValidator.new(permitted_resource_params)
+
+        if validator.validate
+          variant = Spree::Variant.find(permitted_resource_params[:variant_id])
+          original_stock_location = Spree::StockLocation.find(permitted_resource_params[:original_stock_location_id])
+          @reserved_stock_item = Spree::Stock::Reserver.new.reserve(
+            variant,
+            original_stock_location,
+            @user,
+            permitted_resource_params[:quantity].to_i,
+            Time.zone.parse(permitted_resource_params[:expires_at])
+          )
+          flash[:success] = flash_message_for(@reserved_stock_item, :successfully_created)
+          redirect_to admin_user_reserved_stock_items_path(@user)
+        else
+          flash[:error] = "#{Spree.t("admin.reserved_stock_item.unable_to_create")}: #{validator.errors}"
+          render :new
+        end
+      rescue => e
+        flash[:error] = "#{Spree.t("admin.reserved_stock_item.unable_to_create")}: #{e.message}"
+        render :new
+      end
+
+      def restock
+        variant = Spree::ReservedStockItem.find(params[:id]).variant
+        Spree::Stock::Reserver.new.restock(variant, @user)
+        flash[:success] = flash_message_for(@reserved_stock_item, :successfully_restocked)
+        redirect_to admin_user_reserved_stock_items_path(@user)
+      rescue => e
+        flash[:error] = "#{Spree.t("admin.reserved_stock_item.unable_to_restock")}: #{e.message}"
+        redirect_to admin_user_reserved_stock_items_path(@user)
+      end
+
+      private
+
+      def location_after_destroy
+        :back
+      end
+
+      def location_after_save
+        :back
+      end
+
+      def collection
+        []
+      end
+
+      def permitted_resource_params
+        params.require(:reserved_stock_item).permit!.
+          merge(user_id: @user.id)
+      end
+
+
+      def load_user
+        @user = Spree.user_class.find(params[:user_id])
+      end
+
+      def load_original_stock_locations
+        @original_stock_locations = Spree::StockLocation.not_reserved_items.order_default
+      end
+
+      def load_variants
+        @variants = Spree::Variant
+                    .includes(option_values: :option_type)
+                    .order(id: :desc)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,7 @@
+module Spree
+  module Admin
+    StockItemsController.class_eval do
+      helper Spree::Admin::ReservedStockItemsHelper
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+module Spree
+  module Admin
+    UsersController.class_eval do
+      class_attribute :variant_display_attributes
+      self.variant_display_attributes = [
+        { translation_key: :sku, attr_name: :sku },
+        { translation_key: :name, attr_name: :name }
+      ]
+
+      def reserved_stock_items
+        @reserved_stock_items = @user.reserved_stock_items
+        @variant_display_attributes = self.class.variant_display_attributes
+      end
+    end
+  end
+end

data/app/controllers/spree/api/products_controller_decorator.rb

@@ -0,0 +1,12 @@
+Spree::Api::ProductsController.class_eval do
+  before_action :load_customer, only: :show
+
+  private
+
+  # Retrieve a customer so we can return stock information specific to that
+  # customer
+  def load_customer
+    user_id = params[:user_id]
+    @customer = user_id.present? ? Spree.user_class.find(user_id) : nil
+  end
+end

data/app/controllers/spree/api/v1/reserved_stock_items_controller.rb

@@ -0,0 +1,88 @@
+module Spree
+  module Api
+    module V1
+      # API Controller for reserving, restocking and expiring stock
+      class ReservedStockItemsController < Spree::Api::BaseController
+        before_action :authorize_reserving_stock
+
+        def index
+          @reserved_stock_items = scope.all.page(params[:page]).per(params[:per_page])
+          respond_with(@reserved_stock_items)
+        end
+
+        def reserve
+          render_reserve_param_errors(params); return if performed?
+          @reserved_stock_item = Spree::Stock::Reserver.new.reserve(
+            variant,
+            original_stock_location,
+            user,
+            params[:quantity],
+            params[:expires_at]
+          )
+          respond_with(@reserved_stock_item, status: :created, default_template: :show)
+        rescue => e
+          # TODO: Appropriate error if @reserved_stock_item not returned
+          invalid_resource!(@reserved_stock_item)
+        end
+
+        def restock
+          @reserved_stock_item = Spree::Stock::Reserver.new.restock(
+            variant, user, params[:quantity]
+          )
+          respond_with(@reserved_stock_item, status: :created, default_template: :show)
+        rescue => e
+          invalid_resource!(@reserved_stock_item)
+        end
+
+        def restock_expired
+          Spree::Stock::Reserver.new.restock_expired
+          head 204 # return success with no body
+        rescue => e
+          # TODO: error message
+        end
+
+        private
+
+        def authorize_reserving_stock
+          authorize! :manage, ReservedStockItem
+        end
+
+        def user
+          Spree.user_class.find(params[:user_id])
+        end
+
+        def variant
+          variant_id = params[:variant_id]
+          sku = params[:sku]
+          return Spree::Variant.find(variant_id) if variant_id.present?
+          return Spree::Variant.find_by(sku: sku) if sku.present?
+          nil
+        end
+
+        def original_stock_location
+          Spree::StockLocation.find(params[:original_stock_location_id])
+        end
+
+        def render_reserve_param_errors(params)
+          validator = Validators::ReserveStockParamsValidator.new(params)
+          render_errors(validator.errors) unless validator.validate
+        end
+
+        def render_errors(errors)
+          return if errors.blank?
+          Rails.logger.error errors
+          render json: {'errors': errors}.to_json, status: 422
+        end
+
+        def scope
+          base_scope = if params[:user_id].present?
+            user
+          else
+            Spree::StockLocation.reserved_items_location
+          end
+          base_scope.reserved_stock_items.accessible_by(current_ability, :read).includes(:variant)
+        end
+      end
+    end
+  end
+end

data/app/controllers/spree/api/v1/validators/reserve_stock_params_validator.rb

@@ -0,0 +1,37 @@
+module Spree
+  module Api
+    module V1
+      module Validators
+        # Generate useful error messages for API calls to ReservedStockItemsController#reserve
+        class ReserveStockParamsValidator
+          attr_reader :errors
+
+          def initialize(params)
+            @params = params
+            @errors = []
+          end
+
+          def validate
+            if @params[:variant_id].blank? && @params[:sku].blank?
+              @errors << { status: 422, detail: "Parameters must include either 'variant_id' or 'sku'"}
+            end
+
+            if @params[:original_stock_location_id].blank?
+              @errors << { status: 422, detail: "Parameters must include 'original_stock_location_id'"}
+            end
+
+            if @params[:user_id].blank?
+              @errors << { status: 422, detail: "Parameters must include 'user_id'"}
+            end
+
+            if @params[:quantity].blank?
+              @errors << { status: 422, detail: "Parameters must include 'quantity'"}
+            end
+
+            @errors.empty?
+          end
+        end
+      end
+    end
+  end
+end

data/app/controllers/spree/api/variants_controller_decorator.rb

@@ -0,0 +1,12 @@
+Spree::Api::VariantsController.class_eval do
+  before_action :load_customer, only: :show
+
+  private
+
+  # Retrieve a customer so we can return stock information specific to that
+  # customer
+  def load_customer
+    user_id = params[:user_id]
+    @customer = user_id.present? ? Spree.user_class.find(user_id) : nil
+  end
+end

data/app/helpers/spree/admin/reserved_stock_items_helper.rb

@@ -0,0 +1,13 @@
+module Spree
+  module Admin
+    module ReservedStockItemsHelper
+      def stock_location_name(stock_item)
+        stock_location = stock_item.stock_location
+        return stock_location.name unless stock_location.reserved_items?
+
+        user_link = link_to(stock_item.user.email, admin_user_path(stock_item.user))
+        "#{stock_location.name} (#{user_link})".html_safe
+      end
+    end
+  end
+end

data/app/helpers/spree/admin/stock_locations_helper_decorator.rb

@@ -0,0 +1,14 @@
+module Spree
+  module Admin
+    module StockLocationsHelper
+
+      alias_method :original_display_name, :display_name
+      def display_name(stock_location)
+        name = original_display_name(stock_location)
+        return name unless stock_location.reserved_items?
+        "#{name} (Reserved Items)"
+      end
+
+    end
+  end
+end

data/app/helpers/spree/api/api_helpers_decorator.rb

@@ -0,0 +1,7 @@
+Spree::Api::ApiHelpers.module_eval do
+  def stock_location_attributes_with_reserved_items_decoration
+    stock_location_attributes_without_reserved_items_decoration | [:reserved_items]
+  end
+
+  alias_method_chain :stock_location_attributes, :reserved_items_decoration
+end

data/app/models/spree/product_decorator.rb

@@ -0,0 +1,18 @@
+Spree::Product.class_eval do
+  # Don't count reserved stock, unless a user argument is given
+  def total_on_hand(user = nil)
+    if any_variants_not_track_inventory?
+      Float::INFINITY
+    else
+      unreserved_count = stock_items
+                         .where("type IS NULL OR type <> 'Spree::ReservedStockItem'")
+                         .sum(:count_on_hand)
+      return unreserved_count unless user.present?
+      reserved_count = stock_items
+                       .where("type = 'Spree::ReservedStockItem'")
+                       .where(user_id: user.id)
+                       .sum(:count_on_hand)
+      unreserved_count + reserved_count
+    end
+  end
+end

data/app/models/spree/reserved_stock_item.rb

@@ -0,0 +1,48 @@
+# Validates that the StockLocation is specifically for reserved stock
+class ReservedStockLocationValidator < ActiveModel::Validator
+  def validate(record)
+    return unless record.stock_location # Missing stock location should be caught by other validator
+    return if record.stock_location.reserved_items?
+    record.errors[:stock_location] << "StockLocation for ReservedStockItems must have reserved_items? == true"
+  end
+end
+
+# Validates that the reserved stock item is not backorderable
+class NotBackOrderableValidator < ActiveModel::Validator
+  def validate(record)
+    return unless record.backorderable?
+    record.errors[:backorderable] << "ReservedStockItems must not be backorderable"
+  end
+end
+
+module Spree
+  # A StockItem that's been reserved by a customer. It will be stored in a
+  # dedicated StockLocation, but rmembers the original StockLocation for the
+  # items, so the can be restored if the reservation expiresor is cancelled.
+  class ReservedStockItem < Spree::StockItem
+    include ActiveModel::Validations
+
+    belongs_to :user, class_name: Spree::UserClassHandle.new
+
+    belongs_to :original_stock_location, class_name: Spree::StockLocation
+
+    # Remove 'variant_id' attribute from its existing uniqueness validator
+    # (effectively disabling it) so we can add a new uniqueness validator that
+    # is scoped to user_id. We want multiple users to be able to reserve the
+    # same variant.
+    variant_id_uniqueness_validator = validators_on(:variant_id).detect do |validator|
+      validator.is_a? ActiveRecord::Validations::UniquenessValidator
+    end
+    variant_id_uniqueness_validator.attributes.delete(:variant_id) if variant_id_uniqueness_validator
+
+    validates_with ReservedStockLocationValidator
+    validates_with NotBackOrderableValidator
+    validates_uniqueness_of :variant_id,
+      scope: [
+        :stock_location_id,
+        :deleted_at,
+        :user_id
+      ]
+    validates :user_id, presence: true
+  end
+end

data/app/models/spree/stock/coordinator_decorator.rb

@@ -0,0 +1,28 @@
+Spree::Stock::Coordinator.class_eval do
+  private
+
+  # Overridden so that users only see their own reserved stock items, and not
+  # those reserved by other users
+  # TODO: PR into Solidus at https://github.com/solidusio/solidus/pull/1180
+  #       provides a better way to achieve this than overriding a private
+  #       method. If it's accepted, we should use that approach.
+  def stock_location_variant_ids
+    location_variant_ids = Spree::StockItem.
+      where(variant_id: unallocated_variant_ids).
+      where(user_id: [order.user_id, nil]).   # only change is adding this line
+      joins(:stock_location).
+      merge(Spree::StockLocation.active).
+      pluck(:stock_location_id, :variant_id)
+
+    location_lookup = Spree::StockLocation.
+      where(id: location_variant_ids.map(&:first).uniq).
+      map { |l| [l.id, l] }.
+      to_h
+    hash = location_variant_ids.each_with_object({}) do |(location_id, variant_id), hash|
+      location = location_lookup[location_id]
+      hash[location] ||= Set.new
+      hash[location] << variant_id
+    end
+    hash
+  end
+end

data/app/models/spree/stock/prioritizer_decorator.rb

@@ -0,0 +1,16 @@
+Spree::Stock::Prioritizer.class_eval do
+  private
+
+  # Use reserved_stock_location first
+  alias_method :original_sort_packages, :sort_packages
+  def sort_packages
+    original_sort_packages
+
+    reserved_stock_location = Spree::StockLocation.reserved_items_location
+    @packages = @packages
+                .partition do |package|
+                  package.stock_location == reserved_stock_location
+                end
+                .flatten
+  end
+end

data/app/models/spree/stock/quantifier_decorator.rb

@@ -0,0 +1,29 @@
+Spree::Stock::Quantifier.class_eval do
+  def initialize(variant, stock_location = nil, user = nil)
+    @variant = variant
+    where_args = { variant_id: @variant }
+    if stock_location
+      where_args.merge!(stock_location: stock_location)
+    else
+      where_args.merge!(
+        Spree::StockLocation.table_name => {
+          active: true,
+          reserved_items: false
+        }
+      )
+    end
+    @stock_items = Spree::StockItem.joins(:stock_location).where(where_args)
+
+    if user && user.reserved_stock_item(variant)
+      @stock_items.unshift user.reserved_stock_item(variant)
+    end
+  end
+
+  def total_on_hand
+    if @variant.should_track_inventory?
+      stock_items.to_a.sum(&:count_on_hand)
+    else
+      Float::INFINITY
+    end
+  end
+end