solidus-returnly 0.8.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3a68dddf53275a4a8d9a815ecb84153ac0992163
-  data.tar.gz: 66e1b0e6ff2c68a00186243fd5c75a09351e32f7
+  metadata.gz: 47ed17c5959d2c1e1f2210d1881f1322627cd2eb
+  data.tar.gz: fdccd81627f2e2f086fe2e797d99759328212b1a
 SHA512:
-  metadata.gz: 0d73382881e2a144f1404457833901e2c900daaf29ca96ca609588c125cbb06d4f55a952d5eb4f3b4b1c175d20ccf385814301308d41537fefd25a0b358fbbf8
-  data.tar.gz: 589bae74172827ed883ac463b5af2d33bb18ce43c257edc9c6f7f5edaac0bf84e9d3260a4ab4b03abf2350a38ea576243d06d5cbfde2e756507fe8841a92f14e
+  metadata.gz: b683d9cd40b4104862c419964f11d09998bf3ba5e7a174fa667ca9e3e53a2b2eec3dae27b78016a5195f4565a1d8f4b50434a976f3dfad311cf90f9f357307ca
+  data.tar.gz: c606673074120c983143a2118bf2f1e6971443a210df6d617da78e4da0b41f6545dfdfd6a9f317a52e6731083ac78afe75c89d033bdb1d14ed4b16beb669f2e6

data/README.md

@@ -195,6 +195,7 @@ Returnly.configure do |config|
   config.refund_calculator = CustomRefunderCalculator
   config.reimbursement_type_no_items = CustomOriginalPaymentNoItems
   config.refund_presenter = CustomRefundPresenter
+  config.return_item_builder = CustomReturnItemBuilder
 end
 ```
 

data/lib/returnly.rb

@@ -4,6 +4,8 @@ require 'returnly/refunder'
 require 'returnly/discounts/order'
 require 'returnly/discounts/line_item'
 require 'returnly/discount_calculator'
+require 'returnly/builders/customer_return'
+require 'returnly/builders/return_item'
 require 'returnly/refund_calculator'
 
 require 'returnly/version'

data/lib/returnly/builders/customer_return.rb

@@ -0,0 +1,28 @@
+module Returnly
+  module Builders
+    class CustomerReturn
+      class << self
+        def build_by_return_items(return_items)
+          Spree::CustomerReturn.create(
+            return_items: return_items,
+            stock_location_id: stock_location_id(return_items.first)
+          )
+        end
+
+        def build_by_stock_location(stock_location)
+          Spree::CustomerReturn.new(stock_location: stock_location)
+        end
+
+        private
+
+        def stock_location_id(return_item)
+          return_item_order(return_item).shipments.last.stock_location_id
+        end
+
+        def return_item_order(return_item)
+          return_item.inventory_unit.order
+        end
+      end
+    end
+  end
+end

data/lib/returnly/builders/return_item.rb

@@ -0,0 +1,42 @@
+module Returnly
+  module Builders
+    class ReturnItem
+      attr_accessor :order
+
+      def initialize(order)
+        @order = order
+      end
+
+      def build_by_requested_line_items(requested_line_items)
+        requested_line_items.each_with_object([]) do |request_line_item, return_items|
+          quantity = request_line_item[:units].to_i
+          next return_items unless quantity > 0
+
+          inventory_units_by(request_line_item[:order_line_item_id]).take(quantity).each do |inventory_unit|
+            return_items << build_by_inventory_unit(inventory_unit, request_line_item)
+          end
+
+          return_items
+        end
+      end
+
+      def build_by_inventory_unit(inventory_unit, options = {})
+        Spree::ReturnItem.new(
+          amount: inventory_unit.line_item.price,
+          acceptance_status: 'accepted',
+          inventory_unit_id: inventory_unit.id,
+          reception_status_event: 'receive',
+          resellable: options[:restock]
+        )
+      end
+
+      private
+
+      def inventory_units_by(line_item_ids)
+        order.inventory_units.includes(:line_item)
+          .where(line_item_id: line_item_ids)
+          .where.not(state: 'returned')
+      end
+    end
+  end
+end

data/lib/returnly/engine.rb

@@ -1,10 +1,11 @@
 module Returnly
   class << self
     mattr_accessor :return_item_amount_calculator,
-                   :return_item_restock_policy,
-                   :refunder,
-                   :refund_calculator,
-                   :refund_presenter
+      :return_item_builder,
+      :return_item_restock_policy,
+      :refunder,
+      :refund_calculator,
+      :refund_presenter
   end
 
   def self.configure(&block)

data/lib/returnly/refund_calculator.rb

@@ -12,89 +12,47 @@ module Returnly
       self.order = order
     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)
-
-      additional_tax_total = percent_of_tax * return_item.inventory_unit.additional_tax_total
-      included_tax_total   = percent_of_tax * return_item.inventory_unit.included_tax_total
-
-      return_item.additional_tax_total = additional_tax_total
-      return_item.included_tax_total = included_tax_total
-
-      return_item
-    end
-
     def discount
       Returnly::DiscountCalculator.new(order).calculate(line_items)
     end
 
-    def shipping_tax
-      order.all_adjustments.where(source_type: 'Spree::TaxRate', adjustable_type: 'Spree::Shipment').sum(&:amount).to_d.round(2, :down)
-    end
-
     def line_item_tax(line_item)
       (line_item.adjustments.tax.sum(&:amount).to_d / line_item.quantity).round(2, :down)
     end
 
     def line_items_return_items
-      found_return_items = {}
-
-      line_items.each do |line_item|
-        with_available_inventory_units line_item do |inventory_unit, quantity|
-          next unless quantity > 0
-
-          found_return_items[line_item[:order_line_item_id]] ||= []
-          return_item = create_return_item(inventory_unit, restock: line_item[:restock])
-          found_return_items[line_item[:order_line_item_id]] << set_tax(return_item)
-        end
+      available_return_items.each_with_object({}) do |return_item, return_items|
+        line_item_id = return_item.inventory_unit.line_item_id
+        return_items[line_item_id] ||= []
+        return_items[line_item_id] << set_tax(return_item)
+        return_items
       end
-
-      found_return_items
     end
 
-    def line_item_inventory_unit(line_item)
-      returnable_inventory_units.select { |iu| iu.line_item_id == line_item[:order_line_item_id].to_i }
-    end
-
-    def line_item(id)
-      returnable_line_items.find { |i| i.id == id.to_i }
-    end
-
-    def returnable_inventory_units
-      @_inventory_units ||= order.inventory_units.includes(:line_item)
-                                .where(line_item_id: requested_line_items)
-                                .where('state != ?', 'returned')
+    def shipping_tax
+      order.all_adjustments.where(source_type: 'Spree::TaxRate', adjustable_type: 'Spree::Shipment').sum(&:amount).to_d.round(2, :down)
     end
 
-    def returnable_line_items
-      @_line_items ||= returnable_inventory_units.map(&:line_item)
-    end
+    protected
 
-    def requested_line_items
-      line_items.map { |item| item[:order_line_item_id] }
+    def available_return_items
+      self.class.return_item_builder_class.new(order).build_by_requested_line_items(line_items)
     end
 
+    def set_tax(return_item)
+      percent_of_tax = if return_item.amount <= 0
+                         0
+                       else
+                         return_item.amount / Spree::ReturnItem.refund_amount_calculator.new.compute(return_item)
+                       end
 
-    protected
-
-    def create_return_item(inventory_unit, restock: false)
-      Spree::ReturnItem.new(
-        amount:                 inventory_unit.line_item.price,
-        acceptance_status:      'accepted',
-        inventory_unit_id:      inventory_unit.id,
-        reception_status_event: 'receive',
-        resellable:             restock
-      )
-    end
+      additional_tax_total = percent_of_tax * return_item.inventory_unit.additional_tax_total
+      included_tax_total = percent_of_tax * return_item.inventory_unit.included_tax_total
 
-    def with_available_inventory_units(line_item)
-      quantity = line_item[:units].to_i
+      return_item.additional_tax_total = additional_tax_total
+      return_item.included_tax_total = included_tax_total
 
-      available_inventory_units = line_item_inventory_unit(line_item).slice(0, quantity)
-      available_inventory_units.each do |inventory_unit|
-        yield inventory_unit, quantity
-      end
+      return_item
     end
   end
 end

data/lib/returnly/refund_presenter.rb

@@ -25,28 +25,6 @@ module Returnly
       }
     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
 

data/lib/returnly/refunder.rb

@@ -14,7 +14,6 @@ module Returnly
     def initialize(order:, line_items:, product_refund_amount:, shipping_refund_amount:)
       self.order = order
       self.line_items = line_items
-      self.customer_return = Spree::CustomerReturn.new customer_return_params
       self.product_refund_amount = product_refund_amount
       self.shipping_refund_amount = shipping_refund_amount
 
@@ -70,6 +69,7 @@ module Returnly
     end
 
     def proceed_without_line_items
+      self.customer_return = Returnly::Builders::CustomerReturn.build_by_stock_location(stock_location)
       reimburse_without_items!
       RefundPresenter.present_refund(self)
     end
@@ -95,20 +95,16 @@ module Returnly
     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|
+      return_items = refund_calculator.line_items_return_items.values.flatten
+      self.customer_return = Returnly::Builders::CustomerReturn.build_by_return_items(return_items)
+
+      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
+    def stock_location
+      order.shipments.last.stock_location
     end
   end
 end

data/lib/returnly/refunds_configuration.rb

@@ -4,6 +4,10 @@ module Returnly
       Returnly.return_item_amount_calculator || Returnly::Refund::AmountCalculator
     end
 
+    def return_item_builder_class
+      Returnly.return_item_builder || Returnly::Builders::ReturnItem
+    end
+
     # return item qualifies to be restocked (after refund)
     def return_item_restock_policy_class
       Returnly.return_item_restock_policy || Returnly::Refund::ReturnItemRestockPolicy

data/lib/returnly/version.rb

@@ -1,5 +1,5 @@
 module Returnly
-  VERSION = '0.8.1'
+  VERSION = '0.9.0'
 
   def platform_version
     defined?(Solidus)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solidus-returnly
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.0
 platform: ruby
 authors:
 - Returnly Technologies, Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-15 00:00:00.000000000 Z
+date: 2017-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: solidus
@@ -338,6 +338,8 @@ files:
 - config/locales/en.yml
 - config/routes.rb
 - lib/returnly.rb
+- lib/returnly/builders/customer_return.rb
+- lib/returnly/builders/return_item.rb
 - lib/returnly/discount_calculator.rb
 - lib/returnly/discounts/line_item.rb
 - lib/returnly/discounts/order.rb