solidus_legacy_return_authorizations 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 18ac64c290153dc76aa973685a5dc58ea3190508
+  data.tar.gz: 539c2555b6e921869fee35ff7925b155446d3472
+SHA512:
+  metadata.gz: b3767c15416db0beb83c325f3a50557fd3ac98c222fa9f37ae490aa9598a74bbb046b05d5405921c60638e0635b3d63230a5b20a1276bedea2d94b5ea61b478e
+  data.tar.gz: 79ea178bd773d20e8bdd6741dd8f6c67afb7206948f51be81a82c631c215eaccf26195d3c2d2a7bf92329c19955fe507e3dfb4f17bd0d0264665340105348eb6

data/.gitignore

@@ -0,0 +1,15 @@
+\#*
+*~
+.#*
+.DS_Store
+.idea
+.project
+.sass-cache
+coverage
+Gemfile.lock
+tmp
+nbproject
+pkg
+*.swp
+spec/dummy
+.ruby-version

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+gem "solidus", github: "solidusio/solidus", branch: "master"
+gem "solidus_auth_devise", "~> 1.0"
+
+group :development, :test do
+  gem "pry-rails"
+end
+
+gemspec

data/LICENSE

@@ -0,0 +1,26 @@
+Copyright (c) 2014 Bonobos, Inc
+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,62 @@
+Solidus Legacy Return Authorizations
+====================================
+
+This is an extension for users migrating from legacy versions of Spree (2.3.x
+and prior) which had a different representation of and handling for return
+authorizations.
+
+When upgrading from a prior version of Spree to Solidus, simply include this
+extension in your application's Gemfile and your old data will be preserved in
+separate tables (e.g., `spree_legacy_return_authorizations`) and columns (e.g.
+`spree_inventory_units.legacy_return_authorization_id`).
+
+This extension maintains the legacy admin interfaces for viewing and closing
+out (receiving/canceling) any existing legacy return authorizations. It does
+not allow creating any new legacy return authorizations.  New return
+authorizations should be handled through the new returns system included in
+Solidus.
+
+If an order has existing legacy return authorizations then an additional admin
+menu item "Legacy Return Authorizations" will appear in the admin interface for
+that order (/admin/orders/XXX/edit).
+
+Installation
+------------
+
+Add solidus_legacy_return_authorizations to your Gemfile:
+
+```ruby
+gem "solidus_legacy_return_authorizations"
+```
+
+Bundle your dependencies and run the installation generator:
+
+```shell
+bundle
+bundle exec rails g solidus_legacy_return_authorizations:install
+```
+
+Authorization
+-------------
+
+For discrete authorization, two permission sets have been added to allow for granular display in the admin.
+
+`Spree::PermissionSets::LegacyReturnAuthorizationDisplay` and `Spree::PermissionSets::LegacyReturnAuthorizationManagement` have been added and can be assigned via [RoleConfiguration](http://docs.solidus.io/Spree/RoleConfiguration.html)
+
+
+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. 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 'spree_legacy_return_authorizations/factories'
+```

data/Rakefile

@@ -0,0 +1,21 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+require 'spree/testing_support/extension_rake'
+
+RSpec::Core::RakeTask.new
+
+task :default do
+  if Dir["spec/dummy"].empty?
+    Rake::Task[:test_app].invoke
+    Dir.chdir("../../")
+  end
+  Rake::Task[:spec].invoke
+end
+
+desc 'Generates a dummy app for testing'
+task :test_app do
+  ENV['LIB_NAME'] = 'solidus_legacy_return_authorizations'
+  Rake::Task['extension:test_app'].invoke
+end

data/app/assets/javascripts/spree/backend/solidus_legacy_return_authorizations.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/stylesheets/spree/backend/solidus_legacy_return_authorizations.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/controllers/spree/admin/legacy_return_authorizations_controller.rb

@@ -0,0 +1,25 @@
+module Spree
+  module Admin
+    class LegacyReturnAuthorizationsController < ResourceController
+      belongs_to 'spree/order', :find_by => :number
+
+      update.after :associate_inventory_units
+      create.after :associate_inventory_units
+
+      def fire
+        @legacy_return_authorization.send("#{params[:e]}!")
+        flash[:success] = Spree.t(:legacy_return_authorization_updated)
+        redirect_to :back
+      end
+
+      # We don't want to allow creating new legacy RMAs so remove the default methods provided by Admin::ResourceController
+      undef new
+      undef create
+
+      protected
+        def associate_inventory_units
+          (params[:return_quantity] || []).each { |variant_id, qty| @legacy_return_authorization.add_variant(variant_id.to_i, qty.to_i) }
+        end
+    end
+  end
+end

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

@@ -0,0 +1,74 @@
+module Spree
+  module Api
+    class LegacyReturnAuthorizationsController < Spree::Api::BaseController
+
+      def destroy
+        @legacy_return_authorization = order.legacy_return_authorizations.accessible_by(current_ability, :destroy).find(params[:id])
+        @legacy_return_authorization.destroy
+        respond_with(@legacy_return_authorization, status: 204)
+      end
+
+      def index
+        authorize! :admin, LegacyReturnAuthorization
+        @legacy_return_authorizations = order.legacy_return_authorizations.accessible_by(current_ability, :read).
+                                 ransack(params[:q]).result.
+                                 page(params[:page]).per(params[:per_page])
+        respond_with(@legacy_return_authorizations)
+      end
+
+      def show
+        authorize! :admin, LegacyReturnAuthorization
+        @legacy_return_authorization = order.legacy_return_authorizations.accessible_by(current_ability, :read).find(params[:id])
+        respond_with(@legacy_return_authorization)
+      end
+
+      def update
+        @legacy_return_authorization = order.legacy_return_authorizations.accessible_by(current_ability, :update).find(params[:id])
+        if @legacy_return_authorization.update_attributes(legacy_return_authorization_params)
+          respond_with(@legacy_return_authorization, default_template: :show)
+        else
+          invalid_resource!(@legacy_return_authorization)
+        end
+      end
+
+      def add
+        @legacy_return_authorization = order.legacy_return_authorizations.accessible_by(current_ability, :update).find(params[:id])
+        @legacy_return_authorization.add_variant params[:variant_id].to_i, params[:quantity].to_i
+        if @legacy_return_authorization.valid?
+          respond_with @legacy_return_authorization, default_template: :show
+        else
+          invalid_resource!(@legacy_return_authorization)
+        end
+      end
+
+      def receive
+        @legacy_return_authorization = order.legacy_return_authorizations.accessible_by(current_ability, :update).find(params[:id])
+        if @legacy_return_authorization.receive
+          respond_with @legacy_return_authorization, default_template: :show
+        else
+          invalid_resource!(@legacy_return_authorization)
+        end
+      end
+
+      def cancel
+        @legacy_return_authorization = order.legacy_return_authorizations.accessible_by(current_ability, :update).find(params[:id])
+        if @legacy_return_authorization.cancel
+          respond_with @legacy_return_authorization, default_template: :show
+        else
+          invalid_resource!(@legacy_return_authorization)
+        end
+      end
+
+      private
+
+      def order
+        @order ||= Spree::Order.find_by!(number: order_id)
+        authorize! :read, @order
+      end
+
+      def legacy_return_authorization_params
+        params.require(:legacy_return_authorization).permit(permitted_legacy_return_authorization_attributes)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+Spree::Admin::NavigationHelper.module_eval do
+  def tab_with_legacy_return_authorizations(*args)
+    if args.first == :orders
+      options = args.pop if args.last.is_a?(Hash)
+      args << :legacy_return_authorizations
+      args << options
+    end
+    tab_without_legacy_return_authorizations(*args)
+  end
+
+  alias_method_chain :tab, :legacy_return_authorizations
+end

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

@@ -0,0 +1,7 @@
+Spree::Api::ApiHelpers.module_eval do
+  def legacy_return_authorization_attributes
+    [:id, :number, :state, :amount, :order_id, :reason, :created_at, :updated_at]
+  end
+
+  self.inventory_unit_attributes << :legacy_return_authorization_id
+end

data/app/models/spree/adjustment_decorator.rb

@@ -0,0 +1,3 @@
+Spree::Adjustment.class_eval do
+  scope :legacy_return_authorization, -> { where(source_type: "Spree::LegacyReturnAuthorization") }
+end

data/app/models/spree/inventory_unit_decorator.rb

@@ -0,0 +1,3 @@
+Spree::InventoryUnit.class_eval do
+  belongs_to :legacy_return_authorization, class_name: "Spree::LegacyReturnAuthorization"
+end

data/app/models/spree/legacy_return_authorization.rb

@@ -0,0 +1,108 @@
+module Spree
+  class LegacyReturnAuthorization < ActiveRecord::Base
+    belongs_to :order, class_name: 'Spree::Order'
+
+    has_many :inventory_units, dependent: :nullify
+    belongs_to :stock_location
+    before_create :generate_number
+    before_save :force_positive_amount
+
+    validates :order, presence: true
+    validates :amount, numericality: true
+    validate :must_have_shipped_units
+
+    state_machine initial: :authorized do
+      after_transition to: :received, do: :process_return
+
+      event :receive do
+        transition to: :received, from: :authorized, if: :allow_receive?
+      end
+      event :cancel do
+        transition to: :canceled, from: :authorized
+      end
+    end
+
+    def currency
+      order.nil? ? Spree::Config[:currency] : order.currency
+    end
+
+    def display_amount
+      Spree::Money.new(amount, { currency: currency })
+    end
+
+    def add_variant(variant_id, quantity)
+      order_units = returnable_inventory.group_by(&:variant_id)
+      returned_units = inventory_units.group_by(&:variant_id)
+      return false if order_units.empty?
+
+      count = 0
+
+      if returned_units[variant_id].nil? || returned_units[variant_id].size < quantity
+        count = returned_units[variant_id].nil? ? 0 : returned_units[variant_id].size
+
+        order_units[variant_id].each do |inventory_unit|
+          next unless inventory_unit.legacy_return_authorization.nil? && count < quantity
+
+          inventory_unit.legacy_return_authorization = self
+          inventory_unit.save!
+
+          count += 1
+        end
+      elsif returned_units[variant_id].size > quantity
+        (returned_units[variant_id].size - quantity).times do |i|
+          returned_units[variant_id][i].legacy_return_authorization_id = nil
+          returned_units[variant_id][i].save!
+        end
+      end
+
+      order.authorize_return! if inventory_units.reload.size > 0 && !order.awaiting_return?
+    end
+
+    def returnable_inventory
+      order.shipped_shipments.collect{|s| s.inventory_units.to_a}.flatten
+    end
+
+    # Used when Adjustment#update! wants to update the related adjustmenrt
+    def compute_amount(*args)
+      amount.abs * -1
+    end
+
+    private
+
+      def must_have_shipped_units
+        errors.add(:order, Spree.t(:has_no_shipped_units)) if order.nil? || !order.shipped_shipments.any?
+      end
+
+      def generate_number
+        self.number ||= loop do
+          random = "RMA#{Array.new(9){rand(9)}.join}"
+          break random unless self.class.exists?(number: random)
+        end
+      end
+
+      def process_return
+        inventory_units(include: :variant).each do |iu|
+          iu.return!
+
+          if iu.variant.should_track_inventory?
+            if stock_item = Spree::StockItem.find_by(variant_id: iu.variant_id, stock_location_id: stock_location_id)
+              Spree::StockMovement.create!(stock_item_id: stock_item.id, quantity: 1)
+            end
+          end
+        end
+
+        Adjustment.create(adjustable: order, amount: compute_amount, label: Spree.t(:legacy_rma_credit), source: self)
+        order.update!
+
+        order.return if inventory_units.all?(&:returned?)
+      end
+
+      def allow_receive?
+        !inventory_units.empty?
+      end
+
+      def force_positive_amount
+        self.amount = amount.abs
+      end
+  end
+end

data/app/models/spree/order_decorator.rb

@@ -0,0 +1,3 @@
+Spree::Order.class_eval do
+  has_many :legacy_return_authorizations, dependent: :destroy
+end

data/app/models/spree/permission_sets/legacy_return_authorization_display.rb

@@ -0,0 +1,9 @@
+module Spree
+  module PermissionSets
+    class LegacyReturnAuthorizationDisplay < PermissionSets::Base
+      def activate!
+        can [:display, :admin], Spree::LegacyReturnAuthorization
+      end
+    end
+  end
+end

data/app/models/spree/permission_sets/legacy_return_authorization_management.rb

@@ -0,0 +1,9 @@
+module Spree
+  module PermissionSets
+    class LegacyReturnAuthorizationManagement < PermissionSets::Base
+      def activate!
+        can :manage, Spree::LegacyReturnAuthorization
+      end
+    end
+  end
+end

data/app/models/spree/strong_parameters_decorator.rb

@@ -0,0 +1,5 @@
+Spree::Core::ControllerHelpers::StrongParameters.module_eval do
+  def permitted_legacy_return_authorization_attributes
+    [:amount, :reason, :stock_location_id]
+  end
+end