solidus-returnly 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b0f4def9162a15735d56d0e508c00f16b208d490
-  data.tar.gz: 4a4871b9e78dbbabaf7749a4e3367011567c46d9
+  metadata.gz: c766335abec60d67ec8b8cdd47f0f625298ccfc9
+  data.tar.gz: f10c5c2093ca06bba6968c36f95631805207fded
 SHA512:
-  metadata.gz: 5c8a78e67e2dbcd2ec8c42f451f0105c81f2b83d71b2b44935f995722c81dfc450a7876d9aaac786f23b9fabdd26c38525c98341adde5c3b8c6c250d54505d46
-  data.tar.gz: 31e5fcbcb4fa977710be28e31dea281c1554248390a142f8b52e0a47354d8fb117b2eb7dcd43c183d8fb4b111caef1c2f75c837f57d10f4ff1b9118234ff29ab
+  metadata.gz: 716c5b3aa3d8e4021f7df14f7bd8405b8fcee690324ce7b2c91f04a20b3d43e9620f0ed79761f870fd6f50f49a374d6bffdc8b01ab2aa284076437e587d5d7f9
+  data.tar.gz: 0dea426fb3dc4a023113a43506d9524326678234c807c6da8e3e9b5719194afe01019843d1f92a35d288617825f88a862df7577e2a66673f3d33f359f72f4d6b

data/app/controllers/spree/api/returnly/refunds_controller.rb

@@ -2,18 +2,20 @@ module Spree
   module Api
     module Returnly
       class RefundsController < ApiController
+        include Solidus::Returnly::RefundsConfiguration
+
         def estimate
           authorize! :create, Order
-          render json: Solidus::Returnly::Calculator.process(order, line_items_params)
+          render json: refund_calculator_class.process(order, line_items_params)
         end
 
         def create
           authorize! :create, Order
 
-          refunds = Solidus::Returnly::Refunds.new order: order,
-                                                   line_items: line_items_params,
-                                                   restock: refund_restock_param,
-                                                   transactions: transactions_params
+          refunds = refunder_class.new order: order,
+                                       line_items: line_items_params,
+                                       restock: refund_restock_param,
+                                       transactions: transactions_params
           render json: refunds.proceed!
         end
 

data/lib/solidus/returnly/engine.rb

@@ -1,5 +1,16 @@
 module Solidus
   module Returnly
+    class << self
+      mattr_accessor :return_item_amount_calculator,
+                     :return_item_restock_policy,
+                     :refunder,
+                     :refund_calculator
+    end
+
+    def self.configure(&block)
+      yield self if block
+    end
+
     class Engine < Rails::Engine
       require 'spree/core'
 

data/lib/solidus/returnly/refund/amount_calculator.rb

@@ -0,0 +1,17 @@
+module Solidus
+  module Returnly
+    module Refund
+      class AmountCalculator
+        attr_accessor :refund
+
+        def initialize(refund)
+          self.refund = refund
+        end
+
+        def return_item_refund_amount(return_item)
+          refund.refund_amount_per_item - Money.from_amount(return_item.total - return_item.pre_tax_amount)
+        end
+      end
+    end
+  end
+end

data/lib/solidus/returnly/refund/return_item_restock_policy.rb

@@ -0,0 +1,18 @@
+module Solidus
+  module Returnly
+    module Refund
+      class ReturnItemRestockPolicy
+        attr_accessor :refund
+
+        def initialize(refund)
+          self.refund = refund
+        end
+
+        #
+        def should_return_item?(_)
+          refund.restock
+        end
+      end
+    end
+  end
+end

data/lib/solidus/returnly/{calculator.rb → refund_calculator.rb}

@@ -1,10 +1,10 @@
 module Solidus
   module Returnly
-    class Calculator
+    class RefundCalculator
       attr_accessor :line_items, :order
 
       def self.process(order, line_items)
-        new(order, line_items).calculated_estimate
+        RefundPresenter.present_estimate new(order, line_items)
       end
 
       def initialize(order, line_items)
@@ -12,46 +12,6 @@ module Solidus
         self.order = order
       end
 
-      def calculated_estimate
-        total = 0.0
-        sub_total = 0.0
-
-        line_items_return_items.values.flatten.each do |return_item|
-          total += return_item.total
-          sub_total += return_item.pre_tax_amount
-        end
-
-        {
-            total_amount: total,
-            subtotal_amount: sub_total,
-            tax_amount: total - sub_total,
-            discount_amount: order.promo_total,
-            shipping_amount: order.shipment_total,
-            line_items: present_line_items
-        }
-      end
-
-      def present_line_items
-        line_items_return_items.values.map do |return_items|
-          line_item = return_items.first.inventory_unit.line_item
-
-          total_amount = 0.0
-          sub_total = 0.0
-
-          return_items.each do |return_item|
-            total_amount += return_item.total
-            sub_total += return_item.pre_tax_amount
-          end
-
-          {
-              order_line_item_id: line_item.id,
-              quantity: return_items.size,
-              total_amount: total_amount,
-              tax_amount: total_amount - sub_total
-          }
-        end
-      end
-
       def set_tax(return_item)
         percent_of_tax = (return_item.amount <= 0) ? 0 : return_item.amount /
           Spree::ReturnItem.refund_amount_calculator.new.compute(return_item)
@@ -69,20 +29,11 @@ module Solidus
         found_return_items = {}
 
         line_items.each do |line_item|
-          quantity = line_item[:quantity].to_i
+          with_available_inventory_units line_item do |inventory_unit, quantity|
+            next unless quantity > 0
 
-          next unless quantity > 0
-          available_inventory_units = line_item_inventory_unit(line_item).slice(0, quantity)
-
-          available_inventory_units.each do |inventory_unit|
             found_return_items[line_item[:order_line_item_id]] ||= []
-
-            return_item = Spree::ReturnItem.new({ amount: inventory_unit.line_item.price,
-                                                 acceptance_status: 'accepted',
-                                                 inventory_unit_id: inventory_unit.id,
-                                                 reception_status_event: 'receive'
-                                                })
-
+            return_item = create_return_item(inventory_unit)
             found_return_items[line_item[:order_line_item_id]] << set_tax(return_item)
           end
         end
@@ -111,6 +62,26 @@ module Solidus
       def requested_line_items
         line_items.map { |item| item[:order_line_item_id] }
       end
+
+
+      protected
+
+      def create_return_item(inventory_unit)
+        Spree::ReturnItem.new({ amount: inventory_unit.line_item.price,
+                                acceptance_status: 'accepted',
+                                inventory_unit_id: inventory_unit.id,
+                                reception_status_event: 'receive'
+                              })
+      end
+
+      def with_available_inventory_units(line_item)
+        quantity = line_item[:quantity].to_i
+
+        available_inventory_units = line_item_inventory_unit(line_item).slice(0, quantity)
+        available_inventory_units.each do |inventory_unit|
+          yield inventory_unit, quantity
+        end
+      end
     end
   end
 end

data/lib/solidus/returnly/refund_presenter.rb

@@ -0,0 +1,73 @@
+module Solidus
+  module Returnly
+    class RefundPresenter
+
+      def self.present_estimate(calculator)
+        total = Money.new 0
+        sub_total = Money.new 0
+
+        calculator.line_items_return_items.values.flatten.each do |return_item|
+          total += Money.from_amount return_item.total
+          sub_total += Money.from_amount return_item.pre_tax_amount
+        end
+
+        {
+            total_amount: total.to_f,
+            subtotal_amount: sub_total.to_f,
+            tax_amount: (total - sub_total).to_f,
+            discount_amount: calculator.order.promo_total.to_f,
+            shipping_amount: calculator.order.shipment_total.to_f,
+            line_items: present_line_items(calculator)
+        }
+      end
+
+
+      def self.present_line_items(calculator)
+        calculator.line_items_return_items.values.map do |return_items|
+          line_item = return_items.first.inventory_unit.line_item
+
+          total_amount = 0.0
+          sub_total = 0.0
+
+          return_items.each do |return_item|
+            total_amount += return_item.total
+            sub_total += return_item.pre_tax_amount
+          end
+
+          {
+              order_line_item_id: line_item.id,
+              quantity: return_items.size,
+              total_amount: total_amount.to_f,
+              tax_amount: (total_amount - sub_total).to_f
+          }
+        end
+      end
+
+
+      def self.present_refund(refunder)
+        customer_return = refunder.customer_return
+
+        {
+            refund_id: customer_return.number,
+            created_at: customer_return.created_at,
+            updated_at: customer_return.updated_at,
+            line_items: customer_return.return_items.group_by{ |ri| ri.inventory_unit.line_item.id }.map do |_, return_items|
+              first_return_item = return_items.first
+              {
+                  refund_line_item_id: first_return_item.id,
+                  order_line_item_id: first_return_item.inventory_unit.line_item.id,
+                  refunded_amount_per_item: first_return_item.amount.to_f,
+                  total_refunded_per_line_item: return_items.sum(&:amount).to_f,
+                  quantity: return_items.size
+              }
+            end,
+            transactions: [
+                id: refunder.reimbursement.id,
+                amount: refunder.reimbursement.total
+            ],
+            restock: refunder.restock
+        }
+      end
+    end
+  end
+end

data/lib/solidus/returnly/refunder.rb

@@ -0,0 +1,84 @@
+module Solidus
+  module Returnly
+    class Refunder
+      include Solidus::Returnly::RefundsConfiguration
+
+      attr_accessor :order,
+                    :line_items,
+                    :restock,
+                    :transactions,
+                    :customer_return,
+                    :return_item_amount_calculator,
+                    :return_item_restock_policy,
+                    :refund_calculator
+
+      def initialize(order:, line_items:, restock:, transactions:)
+        self.order = order
+        self.line_items = line_items
+        self.customer_return = Spree::CustomerReturn.new customer_return_params
+        self.transactions = transactions
+        self.restock = restock
+
+        configure
+      end
+
+      def process_return_items
+        each_return_item do |return_item|
+          return_item.amount = return_item_amount_calculator.return_item_refund_amount return_item
+          return_item.resellable = return_item_restock_policy.should_return_item? return_item
+        end
+      end
+
+      def proceed!
+        process_return_items
+
+        if customer_return.save!
+          perform_reimbursement
+          RefundPresenter.present_refund(self)
+        end
+      end
+
+      def refund_available_amount
+        @available_amount ||= transactions.sum { |t| Money.from_amount(t[:amount].to_f) }
+      end
+
+      def refund_amount_per_item
+        refund_available_amount / line_items.size
+      end
+
+      def reimbursement
+        @_reimbursement ||= Spree::Reimbursement.build_from_customer_return(customer_return)
+      end
+
+      private
+
+      def configure
+        self.return_item_amount_calculator = return_item_amount_calculator_class.new(self)
+        self.return_item_restock_policy = return_item_restock_policy_class.new(self)
+        self.refund_calculator = refund_calculator_class.new(order, line_items)
+      end
+
+      def perform_reimbursement
+        reimbursement.save!
+        reimbursement.perform!
+      end
+
+      def each_return_item
+        customer_return.return_items = refund_calculator.line_items_return_items.values.flatten
+        customer_return.return_items.each do |return_item|
+          yield return_item
+        end
+      end
+
+      def customer_return_params
+        {
+            stock_location_id: stock_location_id
+        }
+      end
+
+      def stock_location_id
+        order.shipments.last.stock_location.id
+      end
+    end
+  end
+end

data/lib/solidus/returnly/refunds_configuration.rb

@@ -0,0 +1,22 @@
+module Solidus
+  module Returnly
+    module RefundsConfiguration
+      def return_item_amount_calculator_class
+        Solidus::Returnly.return_item_amount_calculator || Solidus::Returnly::Refund::AmountCalculator
+      end
+
+      # return item qualifies to be restocked (after refund)
+      def return_item_restock_policy_class
+        Solidus::Returnly.return_item_restock_policy || Solidus::Returnly::Refund::ReturnItemRestockPolicy
+      end
+
+      def refunder_class
+        Solidus::Returnly.refunder || Solidus::Returnly::Refunder
+      end
+
+      def refund_calculator_class
+        Solidus::Returnly.refund_calculator || Solidus::Returnly::RefundCalculator
+      end
+    end
+  end
+end

data/lib/solidus/returnly/version.rb

@@ -1,5 +1,5 @@
 module Solidus
   module Returnly
-    VERSION = '0.3.0'
+    VERSION = '0.4.0'
   end
 end

data/lib/solidus-returnly.rb

@@ -1,5 +1,7 @@
 require 'solidus_core'
 
 require 'solidus/returnly/engine'
-require 'solidus/returnly/refunds'
-require 'solidus/returnly/calculator'
+require 'solidus/returnly/refunds_configuration'
+
+require 'solidus/returnly/refunder'
+require 'solidus/returnly/refund_calculator'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solidus-returnly
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Returnly Technologies, Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-25 00:00:00.000000000 Z
+date: 2017-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: solidus
@@ -248,6 +248,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Solidus API extensions for returnly
 email: support@returnly.com
 executables: []
@@ -264,10 +278,14 @@ files:
 - config/routes.rb
 - lib/generators/solidus_returnly/install/install_generator.rb
 - lib/solidus-returnly.rb
-- lib/solidus/returnly/calculator.rb
 - lib/solidus/returnly/engine.rb
 - lib/solidus/returnly/factories.rb
-- lib/solidus/returnly/refunds.rb
+- lib/solidus/returnly/refund/amount_calculator.rb
+- lib/solidus/returnly/refund/return_item_restock_policy.rb
+- lib/solidus/returnly/refund_calculator.rb
+- lib/solidus/returnly/refund_presenter.rb
+- lib/solidus/returnly/refunder.rb
+- lib/solidus/returnly/refunds_configuration.rb
 - lib/solidus/returnly/version.rb
 homepage: https://github.com/returnly/solidus-returnly
 licenses:

data/lib/solidus/returnly/refunds.rb

@@ -1,79 +0,0 @@
-module Solidus
-  module Returnly
-    class Refunds
-      attr_accessor :calculator, :order, :line_items, :restock, :transactions, :customer_return
-
-      def initialize(order:, line_items:, restock: true, transactions:)
-        self.order = order
-        self.line_items = line_items
-        self.calculator = Calculator.new order, line_items
-        self.restock = restock
-        self.transactions = transactions
-        self.customer_return = Spree::CustomerReturn.new customer_return_params
-      end
-
-      def proceed!
-        customer_return.return_items = calculator.line_items_return_items.values.flatten
-
-        customer_return.return_items.each do |return_item|
-          return_item.amount = refund_amount_per_item - Money.from_amount(return_item.total - return_item.pre_tax_amount)
-          return_item.resellable = restock
-        end
-
-        if customer_return.save!
-          perform_reimbursement
-          processed_customer_return(customer_return, reimbursement)
-        end
-      end
-
-      def processed_customer_return(customer_return, reimbursement)
-        {
-            refund_id: customer_return.number,
-            created_at: customer_return.created_at,
-            updated_at: customer_return.updated_at,
-            line_items: customer_return.return_items.group_by{ |ri| ri.inventory_unit.line_item.id }.map {|_, return_items|
-              {
-                  refund_line_item_id: return_items.first.id,
-                  order_line_item_id: return_items.first.inventory_unit.line_item.id,
-                  refunded_amount_per_item: return_items.first.amount.to_f,
-                  total_refunded_per_line_item: return_items.sum(&:amount).to_f,
-                  quantity: return_items.size
-              }
-            },
-            transactions: [
-                id: reimbursement.id,
-                amount: reimbursement.total
-            ],
-            restock: restock
-        }
-      end
-
-      def perform_reimbursement
-        reimbursement.save!
-        reimbursement.perform!
-      end
-
-      def reimbursement
-        @_reimbursement ||= Spree::Reimbursement.build_from_customer_return(customer_return)
-      end
-
-      def customer_return_params
-        {
-            stock_location_id: stock_location_id
-        }
-      end
-
-      def stock_location_id
-        order.shipments.last.stock_location.id
-      end
-
-      def refund_available_amount
-        @available_amount ||= transactions.sum { |t| Money.from_amount(t[:amount].to_f) }
-      end
-
-      def refund_amount_per_item
-        refund_available_amount / line_items.size
-      end
-    end
-  end
-end