spree_komoju 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 21abae67fb8b374366ad61cf72c45969898be777
-  data.tar.gz: 1923dec1e5eab2a456da1eba0b3ac96bdbb174ad
+  metadata.gz: f7784a1ce8862a8139658dc03f4f3eba3e788870
+  data.tar.gz: 07274b9b8e58ff08405341faf8dad83b697caa95
 SHA512:
-  metadata.gz: 309fecf25f6cbc7231af46ed1de8db34bcbdfc9744e998a01595d407ba40f6772f8d74c33a4324c220406f98aaca077eb9dc3dfeab78db27f1c6bc7bf027015e
-  data.tar.gz: 1757199d33f762c0cff7709edf50015c5af939789028a06401dc68c2c8f1cdbbd5a6bf60e49dfc1dcc936c30d5f963d358838d305ad5c09767d73bf38dc5f5ad
+  metadata.gz: e8e12916f9d44f2d40eab8e8629d48db94d37f14de5157816968605685c4a1c96f214c6a58afeb039407bd89f786b88e0d485acb18beddd3fd9ffda1df981f70
+  data.tar.gz: 54eb2fc4776fa52c987b507f89d0fd419a9973f922d66c21bce88bc6abcf8f2334b69d23b66ea842bddbe294b1c83fc6435f4c242556681187c2f91488ad04c5

data/app/controllers/spree/komoju_controller.rb

@@ -7,9 +7,9 @@ module Spree
 
       case params[:type]
       when "payment.captured"
-        order_number = extract_payment_number(params[:data][:external_order_num])
-        payment = Spree::Payment.find_by_number!(order_number)
-        payment.complete! unless payment.completed?
+        SpreeKomoju::Callbacks::Captured.new(params).process!
+      when "payment.refunded"
+        SpreeKomoju::Callbacks::Refunded.new(params).process!
       end
 
       head 200
@@ -17,10 +17,6 @@ module Spree
 
     private
 
-    def extract_payment_number(external_order_num)
-      external_order_num.split('-').try(:last)
-    end
-
     def callback_verified?
       request_body = request.body.read
       signature = OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha256'), SpreeKomoju.komoju_webhook_secret_token.to_s, request_body)

data/app/models/spree/payment/gateway_options_decorator.rb

@@ -0,0 +1,3 @@
+Spree::Payment::GatewayOptions.class_eval do
+  prepend SpreeKomoju::GatewayOptionsWithHeaders
+end

data/lib/spree_komoju.rb

@@ -2,6 +2,10 @@ require 'spree_core'
 require 'spree_komoju/engine'
 require 'spree_komoju/errors'
 require 'spree_komoju/controller_helpers'
+require 'spree_komoju/gateway_options_with_headers'
+require 'spree_komoju/callbacks/callback'
+require 'spree_komoju/callbacks/captured'
+require 'spree_komoju/callbacks/refunded'
 
 # This extension adds HTTP PATCH to ssl_request.
 # This is needed for WebMoney multi-card in Komoju.

data/lib/spree_komoju/callbacks/callback.rb

@@ -0,0 +1,29 @@
+module SpreeKomoju
+  module Callbacks
+    class Callback
+      attr_reader :params
+
+      def initialize(callback_params)
+        @params = callback_params
+      end
+
+      protected
+
+      def order_number
+        params[:data][:external_order_num].split("-").try(:first)
+      end
+
+      def payment_number
+        params[:data][:external_order_num].split("-").try(:last)
+      end
+
+      def order
+        @order ||= Spree::Order.find_by_number!(order_number)
+      end
+
+      def payment
+        @payment ||= order.payments.find_by_number!(payment_number)
+      end
+    end
+  end
+end

data/lib/spree_komoju/callbacks/captured.rb

@@ -0,0 +1,9 @@
+module SpreeKomoju
+  module Callbacks
+    class Captured < Callback
+      def process!
+        payment.complete! unless payment.completed?
+      end
+    end
+  end
+end

data/lib/spree_komoju/callbacks/refunded.rb

@@ -0,0 +1,32 @@
+module SpreeKomoju
+  module Callbacks
+    class Refunded < Callback
+      def process!
+        return unless payment.completed?
+
+        refunds.each do |refund_params|
+          process_refund!(refund_params)
+        end
+
+        order.updater.update
+      end
+
+      private
+
+      def process_refund!(refund_params)
+        raise SpreeKomoju::Errors::IncorrectCurrency.new unless refund_params[:currency] == payment.currency
+
+        refund_amount = ::Money.new(refund_params[:amount], refund_params[:currency]).to_f
+        return if refund_amount > payment.credit_allowed
+
+        refund_description = refund_params[:description].blank? ? "Komoju refund" : refund_params[:description]
+        reason = Spree::RefundReason.find_or_create_by!(name: refund_description)
+        payment.refunds.create!(amount: refund_amount, reason: reason, transaction_id: refund_params[:id])
+      end
+
+      def refunds
+        params[:data][:refunds]
+      end
+    end
+  end
+end

data/lib/spree_komoju/controller_helpers.rb

@@ -1,5 +1,11 @@
 module SpreeKomoju
   module ControllerHelpers
+    extend ActiveSupport::Concern
+
+    included do
+      before_action :add_request_env_to_payments, only: :update
+    end
+
     def permitted_source_attributes
       super.push(permitted_komoju_konbini_attributes)
       super.push(permitted_komoju_banktransfer_attributes)
@@ -25,5 +31,9 @@ module SpreeKomoju
     def permitted_komoju_web_money_attributes
       [:email, :prepaid_number]
     end
+
+    def add_request_env_to_payments
+      @order.payments.each {|payment| payment.request_env = request.headers.env }
+    end
   end
 end

data/lib/spree_komoju/errors.rb

@@ -1,5 +1,6 @@
 module SpreeKomoju
   module Errors
     class UnsupportedCurrency < StandardError; end
+    class IncorrectCurrency < StandardError; end
   end
 end

data/lib/spree_komoju/gateway_options_with_headers.rb

@@ -0,0 +1,16 @@
+module SpreeKomoju
+  module GatewayOptionsWithHeaders
+    def browser_language
+      @payment.request_env.nil? ? "" : @payment.request_env["HTTP_ACCEPT_LANGUAGE"]
+    end
+
+    def browser_user_agent
+      @payment.request_env.nil? ? "" : @payment.request_env["HTTP_USER_AGENT"]
+    end
+
+    # Prepended method
+    def hash_methods
+      super + [:browser_language, :browser_user_agent]
+    end
+  end
+end

data/spec/controllers/spree/komoju_controller_spec.rb

@@ -18,6 +18,101 @@ describe Spree::KomojuController, type: :controller do
         end
       end
 
+      context 'when type is payment.refunded' do
+        let(:payment) { order.payments.first! }
+        let(:refund_currency) { "USD" }
+
+        let(:refund_params) do
+          {
+            "type" => "payment.refunded",
+            "data" => {
+              "external_order_num" => "#{order.number}-#{payment.number}",
+              "refunds" => [{
+                "id" => "REFUND_ID",
+                "description" => "My description",
+                "amount" => 100*payment.amount, # cents
+                "currency" => refund_currency
+              }]
+            }
+          }
+        end
+
+        context 'when payment has not been completed yet' do
+          let(:order) { create :completed_order_with_pending_payment }
+
+          it 'does nothing' do
+            expect { post :callback, refund_params }.not_to change {payment.refunds.count}
+          end
+        end
+
+        context 'when payment has already been completed' do
+          let(:order) { create :order_ready_to_ship }
+
+          context 'incorrect currency' do
+            let(:refund_currency) { "CAD" }
+            it 'raises SpreeKomoju::Errors::IncorrectCurrency error' do
+              expect { post :callback, refund_params }.to raise_error(SpreeKomoju::Errors::IncorrectCurrency)
+            end
+          end
+
+          context 'single refund' do
+            it 'adds refund and updates order' do
+              expect(order.shipment_state).to eq "ready"
+              expect(order.payment_state).to eq "paid"
+
+              expect { post :callback, refund_params }.to change { payment.refunds.count }.from(0).to(1)
+              expect(response.status).to eq 200
+
+              order.reload
+              expect(order.shipment_state).to eq "pending"
+              expect(order.payment_state).to eq "balance_due"
+
+              refund = payment.refunds.first
+              expect(refund.amount).to eq payment.amount
+              expect(refund.reason.name).to eq "My description"
+              expect(payment.credit_allowed).to eq 0
+
+              # Does nothing anymore
+              expect { post :callback, refund_params }.not_to change { payment.refunds.count }
+            end
+          end
+
+          context 'multiple individual refunds' do
+            let(:refund_params) do
+              {
+                "type" => "payment.refunded",
+                "data" => {
+                  "external_order_num" => "#{order.number}-#{payment.number}",
+                  "refunds" => [
+                    {
+                      "id" => "REFUND_ID1",
+                      "amount" => 50*payment.amount,
+                      "currency" => "USD"
+                    },
+                    {
+                      "id" => "REFUND_ID2",
+                      "amount" => 50*payment.amount,
+                      "currency" => "USD"
+                    }
+                  ]
+                }
+              }
+            end
+
+            it 'adds refund and updates order' do
+              expect(order.shipment_state).to eq "ready"
+              expect(order.payment_state).to eq "paid"
+
+              expect { post :callback, refund_params }.to change { payment.refunds.count }.from(0).to(2)
+
+              order.reload
+              expect(order.shipment_state).to eq "pending"
+              expect(order.payment_state).to eq "balance_due"
+            end
+          end
+        end
+      end
+
       context 'when type is payment.captured' do
         let(:payment) { double Spree::Payment, complete!: true, completed?: completed }
         let(:capture_params) do
@@ -34,24 +129,24 @@ describe Spree::KomojuController, type: :controller do
             let(:completed) { true }
 
             it 'does nothing' do
-              allow(Spree::Payment).to receive(:find_by_number!) { payment }
+              allow_any_instance_of(SpreeKomoju::Callbacks::Captured).to receive(:payment) { payment }
 
               post :callback, capture_params
 
               expect(payment).to_not have_received(:complete!)
-            end 
+            end
           end
 
           context 'when payment has not been completed yet' do
             let(:completed) { false }
 
             it 'marks a payment as complete' do
-              allow(Spree::Payment).to receive(:find_by_number!) { payment }
+              allow_any_instance_of(SpreeKomoju::Callbacks::Captured).to receive(:payment) { payment }
 
               post :callback, capture_params
 
               expect(payment).to have_received(:complete!)
-            end 
+            end
           end
         end
 
@@ -60,23 +155,23 @@ describe Spree::KomojuController, type: :controller do
             expect {
               post :callback, capture_params
             }.to raise_error(ActiveRecord::RecordNotFound)
-          end    
+          end
         end
       end
 
       context 'when type is not recognized' do
         it 'returns an 200 status code' do
-          post :callback, {type: "bad_type"} 
+          post :callback, {type: "bad_type"}
           expect(response.status).to eq(200)
-        end 
+        end
       end
-    end  
+    end
 
     context 'when callback is unverified' do
       it 'returns head unauthorized' do
         post :callback
         expect(response.status).to eq(401)
-      end 
+      end
     end
   end
 end

data/spree_komoju.gemspec

@@ -2,7 +2,7 @@
 Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.name        = 'spree_komoju'
-  s.version     = '0.1.1'
+  s.version     = '0.1.2'
   s.summary     = 'Spree Komoju Payment Gateway'
   s.description = 'Spree Payment gateway for Komoju payment gateway'
   s.authors     = ['Masahiro Saito', 'Chris Salzberg', 'Richard Ramsden']

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spree_komoju
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Masahiro Saito
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-18 00:00:00.000000000 Z
+date: 2016-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: spree_core
@@ -195,6 +195,7 @@ files:
 - app/models/spree/komoju_gateway.rb
 - app/models/spree/konbini.rb
 - app/models/spree/pay_easy.rb
+- app/models/spree/payment/gateway_options_decorator.rb
 - app/models/spree/web_money.rb
 - app/models/spree/web_money_decorator.rb
 - app/overrides/add_instruction_to_order_show.rb
@@ -238,10 +239,14 @@ files:
 - lib/generators/spree_komoju/install/images/webmoney.png
 - lib/generators/spree_komoju/install/install_generator.rb
 - lib/spree_komoju.rb
+- lib/spree_komoju/callbacks/callback.rb
+- lib/spree_komoju/callbacks/captured.rb
+- lib/spree_komoju/callbacks/refunded.rb
 - lib/spree_komoju/controller_helpers.rb
 - lib/spree_komoju/engine.rb
 - lib/spree_komoju/errors.rb
 - lib/spree_komoju/factories.rb
+- lib/spree_komoju/gateway_options_with_headers.rb
 - spec/controllers/spree/checkout_controller_spec.rb
 - spec/controllers/spree/komoju_controller_spec.rb
 - spec/models/spree/bank_transfer_spec.rb