solidus-returnly 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c65b26145ed509d151c337ef349bb1573cba5703e80b646dfa874ac6566c66a2
-  data.tar.gz: ea4067aaaf9ebd7b97927c2e9c586f4398654e4388009f2c5f226ceaa9b70979
+  metadata.gz: 49a3132d794c84523c95f735e48248ec39f4df2ed08650dfdc4770897b7478e4
+  data.tar.gz: ed416b5e72b84d710baffc1bba8103282ed3637040ceb093622414f855c50fdc
 SHA512:
-  metadata.gz: 8be45554263a53fd0e88c8a9255d437861815e01cc174bc3f0d0b8476d71e4cca99068a493257b7e6297c60cd9319bc3488b1457d2d41d24cf2f57ec12940de8
-  data.tar.gz: b9322a7879716d05367cce5609737af8f628a43bb34412d0b9691ca3487ce2862a8aa95531b345d1db470616f6d262d627d6f5cd11a9323f6d68891f47bf34a5
+  metadata.gz: f73a7bcf01193de619aac70ded0b6d7b5ac85968d7e75de241d0e8d243922e1dddea96bc240207bfdee8a39ebd867291f8af176a191220348bc4deaa2e0990aa
+  data.tar.gz: 00fe2aac2e84fcd8f278547aadf930f112f1dc58ac20ee979c54dbe257553e58c12aa2d3602448054bfcc0af7ecdfa0fecb62630aab4a781faf7cafcfb72b2aa

data/README.md

@@ -101,11 +101,24 @@ Response:
   "refundable_shipping_amount": "{money}",
   "refundable_shipping_tax_amount": "{money}",
   "max_refundable_amount": "{money}",
-  "refunds_by_payment_method": [
+  "transactions": [
     {
-      "code": "Credit Card",
+      "id": "{refund tx id}",
       "amount": "{money}",
-      "original_transaction_id": 1
+      "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}"
     }
   ]
 }
@@ -148,12 +161,27 @@ Response:
       "units": 2 
     },  
   ],
-  "transactions": [ 
+  "transactions": [
     {
       "id": "{refund tx id}",
-      "amount": "{money}"
+      "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",
 }
 ```

data/app/services/refund_payments.rb

@@ -3,8 +3,9 @@ class RefundPayments
 
   include RefundMethods
 
-  def initialize(order)
+  def initialize(order, gift_card)
     @order = order
+    @gift_card = gift_card
   end
 
   def perform!(payment_amount)
@@ -17,9 +18,15 @@ class RefundPayments
       payment_amount -= allowed_amount
 
       payments << {
-        code:                    payment.source_type.constantize.model_name.human,
-        amount:                  allowed_amount.to_f,
-        original_transaction_id: ''
+        id: payment.id.to_s,
+        amount: allowed_amount.to_s,
+        status: 'PENDING',
+        type: 'REFUND',
+        gateway: payment.payment_method.type.demodulize,
+        is_online: true,
+        is_test: !Rails.env.match?(/production/),
+        payment_details: transaction_payment_details(payment),
+        created_at: Time.zone.now.iso8601(3)
       }
     end
   end
@@ -30,4 +37,23 @@ class RefundPayments
     payments = payments.select { |p| eligible_refund_methods.include? p.payment_method.class }
     payments.sort_by { |p| eligible_refund_methods.index(p.payment_method.class) }
   end
+
+  def transaction_payment_details(payment)
+    details = {}
+
+    details[:avs_result_code] = payment.avs_response if payment.avs_response.present?
+    details[:cvv_result_code] = payment.cvv_response_code if payment.cvv_response_code.present?
+
+    source = payment.source
+
+    if source.respond_to?(:number) || source.respond_to?(:last_digits)
+      details[:credit_card_number] = source.number || source.last_digits if source.number.present? || source.last_digits.present?
+      details[:credit_card_company] = source.brand if source.brand.present?
+    end
+
+    details[:gift_card_id] = @gift_card.id if @gift_card.id.present?
+    details[:gift_card_code] = @gift_card.code if @gift_card.code.present?
+
+    details
+  end
 end

data/lib/returnly.rb

@@ -9,6 +9,7 @@ require 'returnly/builders/return_item'
 require 'returnly/refund_calculator'
 
 require 'returnly/version'
+require 'returnly/gift_card'
 require 'returnly/refund/amount_calculator'
 require 'returnly/refund/return_item_restock_policy'
 require 'returnly/services/create_reimbursement'

data/lib/returnly/engine.rb

@@ -5,7 +5,9 @@ module Returnly
       :return_item_restock_policy,
       :refunder,
       :refund_calculator,
-      :refund_presenter
+      :refund_presenter,
+      :gift_card,
+      :git_card_estimate
   end
 
   def self.configure(&block)

data/lib/returnly/gift_card.rb

@@ -0,0 +1,21 @@
+module Returnly
+  NilGiftCard = Struct.new(:refund) do
+    def code
+      nil
+    end
+
+    def id
+      nil
+    end
+  end
+
+  NilGiftCardEstimate = Struct.new(:order) do
+    def code
+      nil
+    end
+
+    def id
+      nil
+    end
+  end
+end

data/lib/returnly/refund_calculator.rb

@@ -33,6 +33,10 @@ module Returnly
       order.all_adjustments.where(source_type: 'Spree::TaxRate', adjustable_type: 'Spree::Shipment').sum(&:amount).to_d.round(2, :down)
     end
 
+    def gift_card
+      @gift_card ||= self.class.gift_card_estimate_class.new(order)
+    end
+
     protected
 
     def available_return_items

data/lib/returnly/refund_presenter.rb

@@ -1,71 +1,115 @@
 module Returnly
   class RefundPresenter
+    class << self
+      def present_refund(refunder)
+        customer_return = refunder.customer_return
+        refund = refunder.order.reload.refunds.last
 
-    def self.present_estimate(calculator)
-      sub_total = Money.new 0
-      tax = Money.new 0
+        {
+          refund_id: refund.try(:id).try(:to_s),
+          user_id: refunder.order.user_id,
+          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.to_s,
+              order_line_item_id: first_return_item.inventory_unit.line_item.id.to_s,
+              units: return_items.size,
+              restock: first_return_item.resellable
+            }
+          end,
+          transactions: refunder.reimbursement.refunds.map do |refund|
+            {
+              id: refund.transaction_id,
+              amount: refund.amount.to_s,
+              status: transaction_status(refund.payment),
+              type: 'REFUND',
+              gateway: refund.payment.payment_method.type.demodulize,
+              is_online: true,
+              is_test: !Rails.env.match?(/production/),
+              payment_details: transaction_payment_details(refund.payment, refunder.gift_card_class.new(refund)),
+              created_at: refund.created_at.iso8601(3),
+              updated_at: refund.updated_at.iso8601(3)
+            }
+          end,
+          created_at: refund.try(:created_at).try(:iso8601, 3),
+          updated_at: refund.try(:updated_at).try(:iso8601, 3)
+        }
+      end
+
+      def present_estimate(calculator)
+        sub_total = Money.new 0
+        tax = Money.new 0
 
-      calculator.line_items_return_items.values.flatten.each do |return_item|
-        sub_total += Money.from_amount return_item.inventory_unit.line_item.price
-        tax += Money.from_amount calculator.line_item_tax(return_item.inventory_unit.line_item)
+        calculator.line_items_return_items.values.flatten.each do |return_item|
+          sub_total += Money.from_amount return_item.inventory_unit.line_item.price
+          tax += Money.from_amount calculator.line_item_tax(return_item.inventory_unit.line_item)
+        end
+
+        discount = Money.from_amount(calculator.discount)
+        total_refund_amount = sub_total + tax - (discount * -1) # discount is negative, so we multiply it by -1 to make it positive for subtraction
+        shipping_tax        = calculator.shipping_tax
+        {
+          product_amount: sub_total.to_s,
+          tax_amount: tax.to_s,
+          discount_amount: (discount * -1).to_s,
+          total_refund_amount: total_refund_amount.to_s,
+          refundable_shipping_amount: Money.from_amount(calculator.order.shipment_total).to_s,
+          refundable_shipping_tax_amount: Money.from_amount(shipping_tax).to_s,
+          max_refundable_amount: Money.from_amount(calculator.order.total - calculator.order.refunds.reload.sum(&:amount)).to_s,
+          transactions: transactions_for_estimate(
+            calculator.order,
+            calculator.gift_card,
+            total_refund_amount.to_d + calculator.order.shipment_total + shipping_tax
+          )
+        }
       end
 
-      discount = Money.from_amount(calculator.discount)
-      total_refund_amount = sub_total + tax - (discount * -1) # discount is negative, so we multiply it by -1 to make it positive for subtraction
-      shipping_tax        = calculator.shipping_tax
-      {
-        product_amount:                 sub_total.to_f,
-        tax_amount:                     tax.to_f,
-        discount_amount:                discount.to_f,
-        total_refund_amount:            total_refund_amount.to_f,
-        refundable_shipping_amount:     calculator.order.shipment_total.to_f,
-        refundable_shipping_tax_amount: shipping_tax.to_f,
-        max_refundable_amount:          (calculator.order.total - calculator.order.refunds.reload.sum(&:amount)).to_f,
-        refunds_by_payment_method:      refunds_by_payment(calculator.order, total_refund_amount.to_d + calculator.order.shipment_total + shipping_tax)
-      }
-    end
+      def present_refund_with_zero_amount(refunder)
+        {
+          refund_id: '1',
+          line_items: refunder.line_items.map do |line_item|
+            {
+              refund_line_item_id: '1',
+              order_line_item_id: line_item[:order_line_item_id].to_s,
+              units: line_item[:units].to_i,
+              restock: line_item[:restock].match?(/true/)
+            }
+          end,
+          transactions: [],
+          created_at: Time.zone.now.iso8601(3)
+        }
+      end
+
+      private
+
+      def transaction_status(payment)
+        return 'SUCCESS' if payment.completed?
+        return 'FAILURE' if payment.failed? || payment.invalid?
+        'PENDING'
+      end
 
-    def self.present_refund(refunder)
-      customer_return = refunder.customer_return
+      def transaction_payment_details(payment, gift_card)
+        details = {}
 
-      {
-        refund_id:    refunder.order.reload.refunds.last.try(:id).try(:to_s),
-        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.to_s,
-            order_line_item_id:  first_return_item.inventory_unit.line_item.id.to_s,
-            units:               return_items.size,
-            restock:             first_return_item.resellable
-          }
-        end,
-        transactions: refunder.reimbursement.refunds.map do |refund|
-          {
-            id: refund.transaction_id,
-            amount: refund.amount.to_f,
-            code: refund.payment.source_type.constantize.model_name.human
-          }
+        details[:avs_result_code] = payment.avs_response if payment.avs_response.present?
+        details[:cvv_result_code] = payment.cvv_response_code if payment.cvv_response_code.present?
+
+        source = payment.source
+
+        if source.respond_to?(:number) || source.respond_to?(:last_digits)
+          details[:credit_card_number] = source.number || source.last_digits if source.number.present? || source.last_digits.present?
+          details[:credit_card_company] = source.brand if source.brand.present?
         end
-      }
-    end
 
-    def self.present_refund_with_zero_amount(refunder)
-      {
-        refund_id: '',
-        line_items: refunder.line_items.map do |line_item|
-          {
-            refund_line_item_id: '',
-            order_line_item_id: line_item[:order_line_item_id].to_s,
-            units: line_item[:units].to_i,
-            restock: !!(line_item[:restock].to_s =~ /true/)
-          }
-        end,
-        transactions: []
-      }
-    end
+        details[:gift_card_id] = gift_card.id if gift_card.id.present?
+        details[:gift_card_code] = gift_card.code if gift_card.code.present?
 
-    private_class_method def self.refunds_by_payment(order, payment_amount)
-                           ::RefundPayments.new(order).perform!(payment_amount)
-                         end
+        details
+      end
+
+      def transactions_for_estimate(order, gift_card, payment_amount)
+        ::RefundPayments.new(order, gift_card).perform!(payment_amount)
+      end
+    end
   end
 end

data/lib/returnly/refunds_configuration.rb

@@ -24,5 +24,13 @@ module Returnly
     def refund_presenter_class
       Returnly.refund_presenter || Returnly::RefundPresenter
     end
+
+    def gift_card_class
+      Returnly.gift_card || Returnly::NilGiftCard
+    end
+
+    def gift_card_estimate_class
+      Returnly.git_card_estimate || Returnly::NilGiftCardEstimate
+    end
   end
 end

data/lib/returnly/version.rb

@@ -1,5 +1,5 @@
 module Returnly
-  VERSION = '0.12.0'
+  VERSION = '0.13.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.12.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Returnly Technologies, Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-13 00:00:00.000000000 Z
+date: 2019-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: solidus
@@ -387,6 +387,7 @@ files:
 - lib/returnly/discounts/order.rb
 - lib/returnly/engine.rb
 - lib/returnly/factories.rb
+- lib/returnly/gift_card.rb
 - lib/returnly/refund/amount_calculator.rb
 - lib/returnly/refund/return_item_restock_policy.rb
 - lib/returnly/refund_calculator.rb