spree-returnly 0.13.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: abacb9ca4551621d1cecf6e0c51003b692606e7b58f6d8a235f586aec75f216a
+  data.tar.gz: 6be91cd2cd61ef37257e433b5ebdf81aa7adc5e8e761ff40b2a602cab9722f10
+SHA512:
+  metadata.gz: 3491d355992e2084e9a47acf969a2106251528da9e8398dc06e9df17f43e24f75381d8a29b626062b657ceb2a7f138020a083a41ff60b38ba723a223722f5eed
+  data.tar.gz: 67426fe2170d1bbd41b13ecbdbd59020865b5cb6fb42b2c096b83a36a9d7d98aad06df15e4ccf8f880a5bb291ee6b0f4009292849d5457b8965c6e22e4b25bad

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2017 Returnly Technologies, Inc.
+
+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,230 @@
+Solidus Returnly
+===============
+
+This gem adds the required APIs to allow Returnly to 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.4.0`
+ - Spree   : `~> 3.1.0`
+
+Installation
+------------
+
+Add solidus_returnly to your Gemfile:
+
+```ruby
+gem 'solidus-returnly'
+```
+
+Bundle your dependencies and run the installation generator:
+
+```shell
+bundle
+bundle exec rails g solidus_returnly:install
+```
+
+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, and [Rubocop](https://github.com/bbatsov/rubocop) static code analysis. 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 'solidus/returnly/factories'
+```
+
+Solidus/Spree Sandbox 
+---------------------
+
+You can create a sandbox spree installationm
+```shell
+git clone git@github.com:solidusio/solidus.git
+cd solidus
+git co v2.0
+bundle install
+rake sandbox
+cd sandbox
+rake spree_auth:admin:create
+```
+
+default admin credentials:
+```
+Email [admin@example.com]
+Password [test123]
+```
+
+this will create a pristine solidus installation you can add the `solidus_returnly` gem and test the endpoints live  
+
+API 
+---
+
+To get an estimate of the return order and taxes
+
+`POST /api/returnly/orders/:order_number/refund_estimate`
+
+Payload:
+```json
+{
+  "items": [
+    { 
+      "order_line_item_id": "{spree order line item id}", 
+      "units": 1
+    }
+  ]
+}
+```
+
+Response:
+
+```json 
+{
+  "product_amount": "{money}",
+  "tax_amount": "{money}",
+  "discount_amount": "{money}",
+  "total_refund_amount": "{money}",
+  "refundable_shipping_amount": "{money}",
+  "refundable_shipping_tax_amount": "{money}",
+  "max_refundable_amount": "{money}",
+  "transactions": [
+    {
+      "id": "{refund tx id}",
+      "amount": "{money}",
+      "status": "PENDING",
+      "type": "REFUND",
+      "gateway": "{gateway}",
+      "is_online": true,
+      "is_test": true,
+      "payment_details": {
+        "avs_result_code": "{code}",
+        "cvv_result_code": "{code}",
+        "credit_card_number": "{number}",
+        "credit_card_company": "visa",
+        "gift_card_id": "{voucher_id}",
+        "gift_card_code": "{voucher_code}"
+      },
+      "created_at": "{date}"
+    }
+  ]
+}
+```
+
+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/orders/:order_number/refund` 
+
+Payload:
+
+```json
+{  
+  "items": [    
+    { 
+      "order_line_item_id": "{x_order_line_item_id1}",
+      "units": 2,
+      "restock": true
+    }  
+  ],
+  "notify_shopper": true,
+  "product_refund_amount": "{money}",
+  "shipping_refund_amount": "{money}",
+  "refund_note": "comment text"
+}
+```
+
+Response:
+
+```json 
+{
+  "refund_id": "{x_refund_id}",
+  "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}", 
+      "units": 2 
+    },  
+  ],
+  "transactions": [
+    {
+      "id": "{refund tx id}",
+      "amount": "{money}",
+      "status": "PENDING",
+      "type": "REFUND",
+      "gateway": "{gateway}",
+      "is_online": true,
+      "is_test": true,
+      "payment_details": {
+        "avs_result_code": "{code}",
+        "cvv_result_code": "{code}",
+        "credit_card_number": "{number}",
+        "credit_card_company": "visa",
+        "gift_card_id": "{voucher_id}",
+        "gift_card_code": "{voucher_code}"
+      }
+    }
+  ],
+  "created_at": "{date}",
+  "updated_at": "{date}",
+  "refund_note": "comment text",
+}
+```
+
+
+Overriding Refund Logic
+--------------
+
+Is possible to override the default behavior of the Refund Gem by extending the following classes
+
+`lib/returnly/refund/return_item_restock_policy.rb`
+
+```ruby
+class CustomReturnItemRestockPolicy < ReturnItemRestockPolicy
+  def should_return_item?(return_item)
+    return_item.cost > 1 
+  end
+end
+```
+
+`lib/returnly/refund/amount_calculator.rb`
+
+```ruby 
+class CustomAmountCalculator < AmountCalculator
+  def return_item_refund_amount(return_item)
+    default_amount(return_item) - 5.0
+  end
+end
+```
+
+to set your custom classes to the returns process just 
+add an initializer file: `cofnig/initializers/returnly.rb`
+
+```ruby 
+Returnly.configure do |config|
+  config.return_item_amount_calculator = CustomAmountCalculator
+  config.return_item_restock_policy = CustomReturnItemRestockPolicy
+  config.refunder = CustomRefunder
+  config.refund_calculator = CustomRefunderCalculator
+  config.reimbursement_type_no_items = CustomOriginalPaymentNoItems
+  config.refund_presenter = CustomRefundPresenter
+  config.return_item_builder = CustomReturnItemBuilder
+end
+```
+
+Copyright (c) 2017 Returnly Technologies, Inc

data/Rakefile

@@ -0,0 +1,46 @@
+$:.push File.expand_path('../lib', __FILE__)
+require 'bundler'
+
+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'
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+
+  task default: %i(first_run spec)
+rescue LoadError
+  # no rspec available
+end
+
+task :first_run do
+  if Dir['spec/dummy'].empty?
+    Rake::Task[:test_app].invoke
+    Dir.chdir('../../')
+  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'
+  Rake::Task['extension:test_app'].invoke
+end

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

@@ -0,0 +1,14 @@
+module Spree
+  module Api
+    module Returnly
+      class ApiController < Spree::Api::BaseController
+        before_action :set_headers
+
+        def set_headers
+          response.headers['X-Returnly-Extension-Version'] = ::Returnly::VERSION
+          response.headers['X-Returnly-Extension-Platform-Qualifier'] = ::Returnly.platform_version
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+module Spree
+  module Api
+    module Returnly
+      class RefundsController < ApiController
+        include ::Returnly::RefundsConfiguration
+
+        def estimate
+          authorize! :create, Order
+          render json: refund_calculator_class.process(order, line_items_params)
+        end
+
+        def create
+          authorize! :create, Order
+
+          refunds = refunder_class.new order: order,
+                                       line_items: line_items_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
+          return [] if params[:items].blank?
+          params.require(:items)
+        end
+
+        def product_refund_amount_param
+          params.require(:product_refund_amount)
+        end
+
+        def shipping_refund_amount_param
+          params.require(:shipping_refund_amount)
+        end
+
+        def order
+          @order ||= Spree::Order.find_by!(number: params[:order_id])
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module Spree
+  module Api
+    module Returnly
+      class VersionController < ApiController
+        def index
+          render json: {
+              extension_version: ::Returnly::VERSION,
+              platform_version: ::Returnly.platform_version
+          }
+        end
+      end
+    end
+  end
+end

data/app/models/reimbursement_shipping.rb

@@ -0,0 +1,61 @@
+class ReimbursementShipping
+  attr_accessor :reimbursement
+  attr_reader :order
+
+  include Spree::ReimbursementType::ReimbursementHelpers
+
+  def initialize(reimbursement)
+    @order         = reimbursement.order
+    @reimbursement = reimbursement
+  end
+
+  def update!(shipping_amount)
+    reimbursement.update!(total: calculated_amount(shipping_amount))
+    create_refund_payment!(shipping_amount)
+  end
+
+  private
+
+  def calculate_shipping_amount(shipping_amount)
+    [shipping_amount, available_shipment_amount].min
+  end
+
+  def calculated_amount(shipping_amount)
+    calculate_shipping_amount(shipping_amount) + reimbursement.total
+  end
+
+  def available_shipment_amount
+    order.shipment_total + order_shipping_tax - refunded_shipping
+  end
+
+  def refunded_shipping
+    order.refunds.where(refund_reason_id: refund_reason.id).sum(&:amount)
+  end
+
+  def create_refund_payment!(shipping_amount)
+    create_refunds(reimbursement, payments, calculate_shipping_amount(shipping_amount), false)
+  end
+
+  def order_shipping_tax
+    order.all_adjustments.where(source_type: 'Spree::TaxRate', adjustable_type: 'Spree::Shipment').sum(&:amount)
+  end
+
+  def payments
+    reimbursement.order.payments.completed
+  end
+
+  def create_refund(reimbursement, payment, amount, simulate)
+    refund = reimbursement.refunds.build({
+                                           payment: payment,
+                                           amount:  amount,
+                                           reason:  refund_reason
+                                         })
+
+    simulate ? refund.readonly! : refund.save!
+    refund
+  end
+
+  def refund_reason
+    @refund_reason ||= Spree::RefundReason.find_or_create_by!(name: 'Returnly Shipping Refund')
+  end
+end

data/app/models/reimbursement_type/original_payment_no_items.rb

@@ -0,0 +1,17 @@
+module ReimbursementType
+  class OriginalPaymentNoItems < Spree::ReimbursementType
+    extend Spree::ReimbursementType::ReimbursementHelpers
+
+    class << self
+      def reimburse(reimbursement, _return_items, simulate)
+        unpaid_amount = reimbursement.total.round(2, :down)
+        payments = reimbursement.order.payments.completed
+
+        refund_list, _unpaid_amount = create_refunds(reimbursement, payments, unpaid_amount, simulate)
+        reimbursement.update(total: refund_list.sum(&:amount))
+        refund_list
+      end
+    end
+  end
+
+end