solidus-returnly 0.4.3 → 0.5.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 56f2b7c03fb59b4fb1f229ca1c9824d957edc6a2
-  data.tar.gz: cf3b33c27bdd470a760543664fc4da4cec015fc6
+  metadata.gz: 174cd758f9a9329da775abb30290df3a942f727f
+  data.tar.gz: c825cf7169dc8cc4b45d8c64248db506433a2b0f
 SHA512:
-  metadata.gz: c71b20d2958ef1b9a2fe8fb6aaf681d6a0aa074b30da7a862e59b4c53e5d9171f4bb8798059d8ecdebd8af0358d526ccbf27801f38decfdde7130a8713b3f0a5
-  data.tar.gz: cec89b1f3fba2e61007df085ce75d18847a7d89f50d6fe58868c3ee10556483cb66f08466cd4e90b7dc1e52c9114606769478147f326bfa1505ab439201c06df
+  metadata.gz: 32530c1a9fae7cc15034e47ee6af6c5ba21204c86a0bf29499587ebcf389932f75bfa846a93dca38df553984bf0c7dd84dffcc94e16e261ac96529a2b8774964
+  data.tar.gz: cd2c85551f5f9fbd4210bd47c655f1551386fdc8cb115aad79bec8958594aed748c3364834fcad882ee44add7d2e7412366447eabcec9458e776e013444ad0a1

data/README.md

@@ -3,6 +3,19 @@ Solidus Returnly
 
 This gem adds the required APIs to allow returnly obtain an estimate, process a return and apply a reimbursement
 
+
+Spree/Solidus
+-----
+This gem can be installed on spree and solidus, to release a new version to both registries you need to run 
+`bash
+$ rake both_releases
+`
+this will generate two packages, `solidus-returnly` and `spree-returnly`
+
+Current Compat Versions:
+ - Solidus : `~>2.0.0`
+ - Spree   : `~>3.0.1`
+
 Installation
 ------------
 
@@ -63,15 +76,15 @@ API
 
 To get an estimate of the return order and taxes
 
-`POST /api/returnly/refunds/:order_number/estimate`
+`POST /api/returnly/orders/:order_number/refund_estimate`
 
 Payload:
 ```json
 {
-  "line_items": [
+  "items": [
     { 
       "order_line_item_id": "{spree order line item id}", 
-      "quantity": 1
+      "units": 1
     }
   ]
 }
@@ -81,19 +94,18 @@ Response:
 
 ```json 
 {
-  "total_amount": "{money}",
-  "subtotal_amount": "{money}",
+  "product_amount": "{money}",
   "tax_amount": "{money}",
   "discount_amount": "{money}",
-  "shipping_amount": "{money}",
-  "line_items": [
+  "total_refund_amount": "{money}",
+  "refundable_shipping_amount": "{money}",
+  "refundable_shipping_tax_amount": "{money}",
+  "max_refundable_amount": "{money}",
+  "refunds_by_payment_method": [
     {
-      "order_line_item_id": "{x_order_line_item_id1}",
-      "quantity": 1,
-      "total_amount": "{money}",
-      "subtotal_amount": "{money}",
-      "tax_amount": "{money}",
-      "discount_amount": "{money}",
+      "code": "Credit Card",
+      "amount": "{money}",
+      "original_transaction_id": 1
     }
   ]
 }
@@ -103,24 +115,23 @@ To process the return and apply the reimbursement**immediately**
 you can pass the `restock` parameter on false to prevent the api
 to immediately change the stock in the default warehouse
 
-`POST /api/returnly/refunds/:order_number` 
+`POST /api/returnly/orders/:order_number/refund` 
 
 Payload:
 
 ```json
 {  
-  "line_items": [    
+  "items": [    
     { 
       "order_line_item_id": "{x_order_line_item_id1}",
-      "quantity": 2 
-    },  
+      "units": 2,
+      "restock": true
+    }  
   ],
-  "transactions": [{
-    "parent_id": "{parent (order) tx id}",
-    "amount": "{money}"
-  }],
-  "note": "comment text",
-  "restock": true
+  "notify_shopper": true,
+  "product_refund_amount": "{money}",
+  "shipping_refund_amount": "{money}",
+  "refund_note": "comment text"
 }
 ```
 
@@ -129,22 +140,21 @@ Response:
 ```json 
 {
   "refund_id": "{x_refund_id}",
-  "created_at": "{timestamp}",
-  "updated_at": "{timestamp}",
   "user_id": "{optional merchant user ID}",
   "line_items": [    
     { 
       "refund_line_item_id": "{x_refund_line_item_id1}",
       "order_line_item_id": "{x_order_line_item_id1}", 
-      "quantity": 2 
+      "units": 2 
     },  
   ],
-  "transactions": [
-    "id": "{refund tx id}",
-    "amount": "{money}"
+  "transactions": [ 
+    {
+      "id": "{refund tx id}",
+      "amount": "{money}"
+    }
   ],
-  "note": "comment text",
-  "restock": true
+  "refund_note": "comment text",
 }
 ```
 

data/Rakefile

@@ -1,6 +1,16 @@
+$:.push File.expand_path('../lib', __FILE__)
 require 'bundler'
 
-Bundler::GemHelper.install_tasks
+def load_library_env
+  lib_name =  ENV['SPREE_BUILD'] ? 'spree-returnly' : 'solidus-returnly'
+
+  puts "Loading #{lib_name}"
+
+  Bundler::GemHelper.install_tasks name: lib_name
+end
+
+
+load_library_env
 
 begin
   require 'spree/testing_support/extension_rake'
@@ -20,6 +30,15 @@ task :first_run do
   end
 end
 
+task :both_releases do
+  %w(spree-returnly solidus-returnly).each do |lib_name|
+    Bundler::GemHelper.install_tasks name: lib_name
+    Rake::Task[:release].invoke
+  end
+
+  load_library_env
+end
+
 desc 'Generates a dummy app for testing'
 task :test_app do
   ENV['LIB_NAME'] = 'solidus-returnly'

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

@@ -5,8 +5,8 @@ module Spree
         before_filter :set_headers
 
         def set_headers
-          response.headers['X-Returnly-Extension-Version'] = Solidus::Returnly::VERSION
-          response.headers['X-Returnly-Extension-Platform-Qualifier'] = Spree.solidus_version
+          response.headers['X-Returnly-Extension-Version'] = ::Returnly::VERSION
+          response.headers['X-Returnly-Extension-Platform-Qualifier'] = ::Returnly.platform_version
         end
       end
     end

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

@@ -2,7 +2,7 @@ module Spree
   module Api
     module Returnly
       class RefundsController < ApiController
-        include Solidus::Returnly::RefundsConfiguration
+        include ::Returnly::RefundsConfiguration
 
         def estimate
           authorize! :create, Order
@@ -14,23 +14,23 @@ module Spree
 
           refunds = refunder_class.new order: order,
                                        line_items: line_items_params,
-                                       restock: refund_restock_param,
-                                       transactions: transactions_params
+                                       product_refund_amount: product_refund_amount_param,
+                                       shipping_refund_amount: shipping_refund_amount_param
           render json: refunds.proceed!
         end
 
         private
 
         def line_items_params
-          params.require(:line_items)
+          params.require(:items)
         end
 
-        def transactions_params
-          params.require(:transactions)
+        def product_refund_amount_param
+          params.require(:product_refund_amount)
         end
 
-        def refund_restock_param
-          params.require(:restock)
+        def shipping_refund_amount_param
+          params.require(:shipping_refund_amount)
         end
 
         def order

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

@@ -4,8 +4,8 @@ module Spree
       class VersionController < ApiController
         def index
           render json: {
-              extension_version: Solidus::Returnly::VERSION,
-              platform_version: Spree.solidus_version
+              extension_version: ::Returnly::VERSION,
+              platform_version: ::Returnly.platform_version
           }
         end
       end

data/app/models/spree/return_item_decorator.rb

@@ -0,0 +1,14 @@
+Spree::ReturnItem.class_eval do
+  unless ::Returnly.is_solidus?
+    attr_accessor :amount
+
+    def amount
+      self.pre_tax_amount + self.included_tax_total
+    end
+
+
+    def amount=(amount)
+      self.pre_tax_amount  = amount - self.included_tax_total
+    end
+  end
+end

data/config/routes.rb

@@ -1,7 +1,8 @@
 Spree::Core::Engine.routes.draw do
   namespace :api, defaults: { format: 'json' } do
-    post '/returnly/refunds/:order_id/estimate', to: 'returnly/refunds#estimate'
-    post '/returnly/refunds/:order_id', to: 'returnly/refunds#create'
+    post '/returnly/orders/:order_id/refund_estimate', to: 'returnly/refunds#estimate'
+    post '/returnly/orders/:order_id/refund', to: 'returnly/refunds#create'
+
     get '/returnly/version', to: 'returnly/version#index'
   end
 end

data/lib/returnly.rb

@@ -0,0 +1,4 @@
+require 'returnly/engine'
+require 'returnly/refunds_configuration'
+require 'returnly/refunder'
+require 'returnly/refund_calculator'

data/lib/returnly/engine.rb

@@ -0,0 +1,65 @@
+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'
+
+    engine_name 'returnly'
+
+    config.autoload_paths += %W(#{config.root}/lib)
+
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+    def self.activate
+      Dir.glob(File.join(File.dirname(__FILE__), '../../app/**/*_decorator*.rb')) do |c|
+        Rails.configuration.cache_classes ? require(c) : load(c)
+      end
+    end
+
+    config.to_prepare(&method(:activate).to_proc)
+
+    rake_tasks do
+      namespace :returnly do
+        require 'securerandom'
+
+        desc "Creates an returnly user and prints the generated API key"
+        task install_user: :environment do
+
+          returnly_email = 'api@returnly.com'
+
+          password = SecureRandom.hex(24)
+
+          if (user = Spree::User.find_by email: returnly_email)
+            puts "The Returnly User is already generated"
+            puts "The Api key is:    #{user.spree_api_key}"
+          else
+            user = Spree::User.new email: returnly_email, password: password,
+                                   password_confirmation: password
+
+            user.generate_spree_api_key!
+
+            if user.save!
+              puts "****************************************************"
+              puts "Api key Generated #{user.spree_api_key}"
+              puts "Returnly User Password #{password}"
+              puts "Returnly User email #{returnly_email}"
+              puts "****************************************************"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/returnly/refund/amount_calculator.rb

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

data/lib/returnly/refund/return_item_restock_policy.rb

@@ -0,0 +1,15 @@
+module Returnly
+  module Refund
+    class ReturnItemRestockPolicy
+      attr_accessor :refund
+
+      def initialize(refund)
+        self.refund = refund
+      end
+
+      def should_return_item?(return_item)
+        return_item.resellable?
+      end
+    end
+  end
+end

data/lib/returnly/refund_calculator.rb

@@ -0,0 +1,91 @@
+module Returnly
+  class RefundCalculator
+    attr_accessor :line_items, :order
+
+    def self.process(order, line_items)
+      RefundPresenter.present_estimate new(order, line_items)
+    end
+
+    def initialize(order, line_items)
+      self.line_items = line_items
+      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 shipping_tax
+      order.all_adjustments.where(source_type: 'Spree::TaxRate', adjustable_type: 'Spree::Shipment').sum(&:amount)
+    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
+      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 is not "returned"')
+    end
+
+    def returnable_line_items
+      @_line_items ||= returnable_inventory_units.map(&:line_item)
+    end
+
+    def requested_line_items
+      line_items.map { |item| item[:order_line_item_id] }
+    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
+
+    def with_available_inventory_units(line_item)
+      quantity = line_item[:units].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

data/lib/returnly/refund_presenter.rb

@@ -0,0 +1,78 @@
+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
+
+      {
+        product_amount: sub_total.to_f,
+        tax_amount: (total - sub_total).to_f,
+        discount_amount: calculator.order.promo_total.to_f,
+        total_refund_amount: (total - calculator.order.promo_total).to_f,
+        refundable_shipping_amount: calculator.order.shipment_total.to_f,
+        refundable_shipping_tax_amount: calculator.shipping_tax.to_f,
+        max_refundable_amount: calculator.order.total.to_f,
+        refunds_by_payment_method: refunds_by_payment(calculator.order)
+      }
+    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,
+        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,
+            units:                    return_items.size
+          }
+        end,
+        transactions: [
+                        id:     refunder.reimbursement.id,
+                        amount: refunder.reimbursement.total
+                      ]
+      }
+    end
+
+    private_class_method def self.refunds_by_payment(order)
+                           order.payments.each_with_object([]) do |payment, payments|
+                             payments << {
+                               code:                    payment.source_type.constantize.model_name.human,
+                               amount:                  (order.item_total + order.adjustment_total).to_f,
+                               original_transaction_id: ''
+                             }
+                           end
+                         end
+  end
+end

data/lib/returnly/refunder.rb

@@ -0,0 +1,82 @@
+module Returnly
+  class Refunder
+    include Returnly::RefundsConfiguration
+
+    attr_accessor :order,
+                  :line_items,
+                  :product_refund_amount,
+                  :shipping_refund_amount,
+                  :customer_return,
+                  :return_item_amount_calculator,
+                  :return_item_restock_policy,
+                  :refund_calculator
+
+    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
+
+      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 ||= Money.from_amount(product_refund_amount.to_f + shipping_refund_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

data/lib/returnly/refunds_configuration.rb

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

data/lib/returnly/version.rb

@@ -0,0 +1,7 @@
+module Returnly
+  VERSION = '0.5.0.pre'
+
+  def platform_version
+    defined?(Solidus)
+  end
+end

data/lib/solidus-returnly.rb

@@ -1,12 +1,12 @@
-require 'solidus_core'
+require 'spree_core'
+require 'returnly'
 
-require 'solidus/returnly/engine'
-require 'solidus/returnly/version'
-require 'solidus/returnly/refunds_configuration'
+module Returnly
+  def self.is_solidus?
+    true
+  end
 
-require 'solidus/returnly/refund/amount_calculator'
-require 'solidus/returnly/refund/return_item_restock_policy'
-
-require 'solidus/returnly/refunder'
-require 'solidus/returnly/refund_calculator'
-require 'solidus/returnly/refund_presenter'
+  def self.platform_version
+    Spree.solidus_version
+  end
+end

data/lib/spree-returnly.rb

@@ -0,0 +1,12 @@
+require 'spree_core'
+require 'returnly'
+
+module Returnly
+  def self.is_solidus?
+    false
+  end
+
+  def self.platform_version
+    Spree.version
+  end
+end

metadata

@@ -1,57 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: solidus-returnly
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.5.0.pre
 platform: ruby
 authors:
 - Returnly Technologies, Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-22 00:00:00.000000000 Z
+date: 2017-08-24 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: solidus_auth_devise
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: solidus
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
 - !ruby/object:Gem::Dependency
   name: solidus_core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: solidus_api
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +94,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: erubis
+  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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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'
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement
@@ -274,19 +330,21 @@ files:
 - app/controllers/spree/api/returnly/api_controller.rb
 - app/controllers/spree/api/returnly/refunds_controller.rb
 - app/controllers/spree/api/returnly/version_controller.rb
+- app/models/spree/return_item_decorator.rb
 - config/locales/en.yml
 - config/routes.rb
-- lib/generators/solidus_returnly/install/install_generator.rb
+- lib/returnly.rb
+- lib/returnly/engine.rb
+- lib/returnly/factories.rb
+- lib/returnly/refund/amount_calculator.rb
+- lib/returnly/refund/return_item_restock_policy.rb
+- lib/returnly/refund_calculator.rb
+- lib/returnly/refund_presenter.rb
+- lib/returnly/refunder.rb
+- lib/returnly/refunds_configuration.rb
+- lib/returnly/version.rb
 - lib/solidus-returnly.rb
-- lib/solidus/returnly/engine.rb
-- lib/solidus/returnly/factories.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
+- lib/spree-returnly.rb
 homepage: https://github.com/returnly/solidus-returnly
 licenses:
 - MIT
@@ -302,9 +360,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.6.11

data/lib/generators/solidus_returnly/install/install_generator.rb

@@ -1,19 +0,0 @@
-module SolidusReturnly
-  module Generators
-    class InstallGenerator < Rails::Generators::Base
-      class_option :auto_run_migrations, type: :boolean, default: false
-
-      def add_javascripts
-      end
-
-      def add_stylesheets
-      end
-
-      def add_migrations
-      end
-
-      def run_migrations
-      end
-    end
-  end
-end

data/lib/solidus/returnly/engine.rb

@@ -1,67 +0,0 @@
-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'
-
-      engine_name 'returnly'
-
-      config.autoload_paths += %W(#{config.root}/lib)
-
-      # use rspec for tests
-      config.generators do |g|
-        g.test_framework :rspec
-      end
-
-      def self.activate
-        Dir.glob(File.join(File.dirname(__FILE__), '../../app/**/*_decorator*.rb')) do |c|
-          Rails.configuration.cache_classes ? require(c) : load(c)
-        end
-      end
-
-      config.to_prepare(&method(:activate).to_proc)
-
-      rake_tasks do
-        namespace :returnly do
-          require 'securerandom'
-
-          desc "Creates an returnly user and prints the generated API key"
-          task install_user: :environment do
-
-            returnly_email = 'api@returnly.com'
-
-            password = SecureRandom.hex(24)
-
-            if (user = Spree::User.find_by email: returnly_email)
-              puts "The Returnly User is already generated"
-              puts "The Api key is:    #{user.spree_api_key}"
-            else
-              user = Spree::User.new email: returnly_email, password: password,
-                                     password_confirmation: password
-
-              api_key = user.generate_spree_api_key
-
-              if user.save!
-                puts "****************************************************"
-                puts "Api key Generated #{api_key}"
-                puts "Returnly User Password #{password}"
-                puts "Returnly User email #{returnly_email}"
-                puts "****************************************************"
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,23 +0,0 @@
-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)
-          default_amount(return_item)
-        end
-
-        protected
-        def default_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

@@ -1,18 +0,0 @@
-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/refund_calculator.rb

@@ -1,87 +0,0 @@
-module Solidus
-  module Returnly
-    class RefundCalculator
-      attr_accessor :line_items, :order
-
-      def self.process(order, line_items)
-        RefundPresenter.present_estimate new(order, line_items)
-      end
-
-      def initialize(order, line_items)
-        self.line_items = line_items
-        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 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)
-            found_return_items[line_item[:order_line_item_id]] << set_tax(return_item)
-          end
-        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')
-      end
-
-      def returnable_line_items
-        @_line_items ||= returnable_inventory_units.map(&:line_item)
-      end
-
-      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

@@ -1,73 +0,0 @@
-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

@@ -1,84 +0,0 @@
-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

@@ -1,22 +0,0 @@
-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 +0,0 @@
-module Solidus
-  module Returnly
-    VERSION = '0.4.3'
-  end
-end