spree_komoju 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fab6019e2802d287ff898d2d70594e9f46a6fac3
-  data.tar.gz: 1ed0ae676b5a76cc97f46ae004f0ffaa56ea7789
+  metadata.gz: fb49e7926e73b422ef5265abb5fff354a2a9c4aa
+  data.tar.gz: cc33f0b3f7852687708ada96fb1d7c42fd8363f9
 SHA512:
-  metadata.gz: d7a6d1fc42a4bbd4aaee6824aa6fc2ba2a4e8ccc9f1331cdc4f420886ab4034e4c8c9f3570cb9b112fcd3804e983a97e8a44c3b7eb6a2c911ea5e5a01be8613d
-  data.tar.gz: 61c9167f7503d82ebad69619ad138af3a90728320e07628d82ca5ac3dcad350e1a4d17f2c32c375ba8229a244243840f7ced248e22418b33db6b85004fa68c58
+  metadata.gz: c9a991202fbd2c1c0ab2de087d2f9bb64d1fcf4acafd02850e552d0247328d9cc4f8b310f1dce7ea09a1213bd07b57c706510ac6756d5b2e919c49af53a3e090
+  data.tar.gz: b170a98fe37a3dad419ab1c058b13fc1ccc5e045e585a53cca48f0497bb33c496227dc8217ecbf9e4d3d6995c7bc70654f68106ac1f6b326560b441e0df93f0d

data/README.md

@@ -1,7 +1,7 @@
 SpreeKomoju
 ===========
 
-SpreeKomoju provides a comprehensive integration for all [Komoju](https://docs.komoju.com) payment methods with a single gem, including Credit Card, Konbini and Bank Transfer.
+SpreeKomoju provides a comprehensive integration for all [Komoju](https://docs.komoju.com) payment methods with a single gem, including Credit Card, Konbini, PayEasy, and Bank Transfer.
 
 Installation
 ------------
@@ -19,6 +19,21 @@ bundle
 bundle exec rails g spree_komoju:install
 ```
 
+Webhooks
+--------
+
+You will need to [setup a webhook](https://docs.komoju.com/api/webhooks) to complete non credit card
+payments options. This is because payment options like Konbini, Bank Transfer, etc. are completed offline.
+
+Adding spree_komoju will expose a new route `http://localhost:3000/komoju/callback` which expects
+a `payment.captured` webhook. You can configure a [secret token](https://docs.komoju.com/api/webhooks#secret_token)
+for your callback endpoint using the following configuration code:
+
+```ruby
+# config/initializers/spree_komoju.rb
+SpreeKomoju.komoju_webhook_secret_token = 'MY WEBHOOK SECRET'
+```
+
 Testing
 -------
 

data/app/assets/javascripts/spree/backend/spree_komoju.js

@@ -1,2 +0,0 @@
-// Placeholder manifest file.
-// the installer will append this file to the app vendored assets here: vendor/assets/javascripts/spree/backend/all.js'

data/app/assets/javascripts/spree/frontend/spree_komoju.js

@@ -1,2 +0,0 @@
-// Placeholder manifest file.
-// the installer will append this file to the app vendored assets here: vendor/assets/javascripts/spree/frontend/all.js'

data/app/assets/stylesheets/spree/frontend/spree_komoju.css

@@ -2,3 +2,26 @@
 Placeholder manifest file.
 the installer will append this file to the app vendored assets here: 'vendor/assets/stylesheets/spree/frontend/all.css'
 */
+
+.webmoney .multicard {
+  margin-top: 20px;
+  font-family: monospace;
+  font-size: 14px;
+}
+
+.webmoney .multicard th {
+  width: 200px;
+  font-weight: normal;
+}
+
+.webmoney .form-inline .form-control,
+.webmoney .form-inline .form-group {
+  display: inline;
+  width: auto;
+}
+
+@media screen and (max-width: 460px){
+  .webmoney .multicard span.points {
+    display: none;
+  }
+}

data/app/controllers/spree/admin/payments_controller_decorator.rb

@@ -0,0 +1,3 @@
+Spree::Admin::PaymentsController.class_eval do
+  include SpreeKomoju::ControllerHelpers
+end

data/app/controllers/spree/checkout_controller_decorator.rb

@@ -1,18 +1,3 @@
 Spree::CheckoutController.class_eval do
-  def permitted_source_attributes
-    super.push(permitted_komoju_konbini_attributes)
-    super.push(permitted_komoju_banktransfer_attributes)
-    super.flatten
-  end
-
-  private
-
-  def permitted_komoju_konbini_attributes
-    :convenience
-  end
-
-  def permitted_komoju_banktransfer_attributes
-    [:email, :phone, :family_name, :given_name, :family_name_kana, :given_name_kana]
-  end
+  include SpreeKomoju::ControllerHelpers
 end
-

data/app/controllers/spree/komoju_controller.rb

@@ -0,0 +1,34 @@
+module Spree
+  class KomojuController < ApplicationController
+    protect_from_forgery except: :callback
+
+    def callback
+      return head :unauthorized unless callback_verified?
+
+      case params[:type]
+      when "ping"
+        # do nothing
+      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?
+      else
+        return head :unauthorized
+      end
+
+      head 200
+    end
+
+    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)
+      Rack::Utils.secure_compare(signature, request.env["HTTP_X_KOMOJU_SIGNATURE"].to_s)
+    end
+  end
+end

data/app/models/spree/bank_transfer.rb

@@ -7,16 +7,7 @@ module Spree
     validates :email, :given_name, :family_name, :given_name_kana, :family_name_kana, presence: true
 
     def actions
-      %w{capture void}
-    end
-
-    def can_capture?(payment)
-      return false unless ['checkout', 'pending'].include?(payment.state)
-      payment.source.expires_at && (payment.source.expires_at > DateTime.current)
-    end
-
-    def can_void?(payment)
-      payment.state != 'void'
+      %w{}
     end
 
     def instructions_partial_path

data/app/models/spree/gateway/komoju_bank_transfer.rb

@@ -22,5 +22,9 @@ module Spree
       ) if response.success?
       response
     end
+
+    def reusable_sources(*args)
+      []
+    end
   end
 end

data/app/models/spree/gateway/komoju_konbini.rb

@@ -19,5 +19,9 @@ module Spree
       ) if response.success?
       response
     end
+
+    def reusable_sources(*args)
+      []
+    end
   end
 end

data/app/models/spree/gateway/komoju_pay_easy.rb

@@ -0,0 +1,28 @@
+module Spree
+  class Gateway::KomojuPayEasy < KomojuGateway
+    def authorize(money, source, options)
+      details = {
+        type:             "pay_easy",
+        email:            source.email,
+        phone:            source.phone,
+        given_name:       source.given_name,
+        family_name:      source.family_name,
+        given_name_kana:  source.given_name_kana,
+        family_name_kana: source.family_name_kana
+      }
+      options = change_options_to_dollar(options) if options[:currency] == "JPY"
+
+      response = provider.purchase(money - options[:tax], details, options)
+
+      source.update!(
+        expires_at:       response.params["payment_deadline"].to_time,
+        bank_id:          response.params["payment_details"]["bank_id"],
+        customer_id:      response.params["payment_details"]["customer_id"],
+        confirmation_id:  response.params["payment_details"]["confirmation_id"],
+        instructions_url: response.params["payment_details"]["instructions_url"]
+      ) if response.success?
+
+      response
+    end
+  end
+end

data/app/models/spree/gateway/komoju_web_money.rb

@@ -0,0 +1,57 @@
+module Spree
+  class Gateway::KomojuWebMoney < KomojuGateway
+    def auto_capture?
+      true
+    end
+
+    def purchase(money, source, options)
+      raise SpreeKomoju::Errors::UnsupportedCurrency if options[:currency] != "JPY"
+
+      details = {
+        type: "web_money",
+        email: source.email,
+        prepaid_number: source.prepaid_number
+      }
+      options = change_options_to_dollar(options)
+
+      if uuid = continue_uuid(options[:order_id])
+        response = provider.continue(uuid, details)
+      else
+        response = provider.purchase(money - options[:tax], details, options)
+      end
+
+      source.update!(
+        prepaid_cards: response.params["payment_details"]["prepaid_cards"],
+        short_amount: response.params["payment_details"]["short_amount"]
+      ) if response.success?
+
+      if response.params["status"] == "pending"
+        source.update!(payment_uuid: response.params["id"])
+        response = multi_card_response(response)
+      end
+
+      response
+    end
+
+    def reusable_sources(*args)
+      []
+    end
+
+    private
+
+    def multi_card_response(response)
+      response.instance_variable_set(:@success, false)
+      response.instance_variable_set(:@message, I18n.t('spree.komoju.web_money.insufficient_funds'))
+      response
+    end
+
+    def continue_uuid(current_order_id)
+      order = Spree::Order.find_by_number(current_order_id.split('-').first)
+      
+      # NOTE: Since the current payment is this payment, find the payment before
+      # and see if it was for a webmoney transaction. If it was check if it has a payment UUID
+      # to continue the transaction.
+      order.payments.last(2).first.try(:source).try(:payment_uuid)
+    end
+  end
+end

data/app/models/spree/konbini.rb

@@ -9,16 +9,7 @@ module Spree
     validates :convenience, presence: true
 
     def actions
-      %w{capture void}
-    end
-
-    def can_capture?(payment)
-      return false unless ['checkout', 'pending'].include?(payment.state)
-      payment.source.expires_at && (payment.source.expires_at > DateTime.current)
-    end
-
-    def can_void?(payment)
-      payment.state != 'void'
+      %w{}
     end
 
     def instructions_partial_path

data/app/models/spree/pay_easy.rb

@@ -0,0 +1,18 @@
+module Spree
+  class PayEasy < Spree::Base
+    belongs_to :payment_method
+    belongs_to :user, class_name: Spree.user_class, foreign_key: 'user_id'
+    has_many :payments, as: :source
+
+    validates :email, :given_name, :family_name, :given_name_kana, :family_name_kana, presence: true
+    validates :phone, numericality: true, allow_nil: true
+
+    def actions
+      %w{}
+    end
+
+    def instructions_partial_path
+      "spree/orders/pay_easy"
+    end
+  end
+end

data/app/models/spree/web_money.rb

@@ -0,0 +1,21 @@
+module Spree
+  class WebMoney < Spree::Base
+    belongs_to :payment_method
+    belongs_to :user, class_name: Spree.user_class, foreign_key: 'user_id'
+    has_many :payments, as: :source
+
+    serialize :prepaid_cards, Array
+
+    attr_accessor :prepaid_number
+    validates :email, presence: true
+    validates :prepaid_number, presence: true, on: :create
+
+    def actions
+      %w{}
+    end
+
+    def instructions_partial_path
+      "spree/orders/web_money"
+    end
+  end
+end

data/app/models/spree/web_money_decorator.rb

@@ -0,0 +1,15 @@
+module Spree
+  class WebMoneyDecorator
+    attr_reader :source
+    delegate :short_amount, :prepaid_cards, :payment_uuid, to: :source,
+      allow_nil: true
+
+    def initialize(source)
+      @source = if source.present? && source.brand == "web_moneys"
+                  source
+                else
+                  nil
+                end
+    end
+  end
+end

data/app/views/spree/admin/payments/source_forms/_komoju_bank_transfer.html.erb

@@ -0,0 +1 @@
+<%= render partial: "spree/checkout/payment/komoju_bank_transfer", locals: { payment_method: payment_method } %>

data/app/views/spree/admin/payments/source_forms/_komoju_credit_card.html.erb

@@ -0,0 +1 @@
+<%= render :partial => "spree/admin/payments/source_forms/gateway", locals: { payment_method: payment_method, previous_cards: previous_cards } %>

data/app/views/spree/admin/payments/source_forms/_komoju_konbini.html.erb

@@ -0,0 +1 @@
+<%= render partial: "spree/checkout/payment/komoju_konbini", locals: { payment_method: payment_method } %>

data/app/views/spree/admin/payments/source_forms/_komoju_pay_easy.html.erb

@@ -0,0 +1 @@
+<%= render partial: "spree/checkout/payment/komoju_pay_easy", locals: { payment_method: payment_method } %>

data/app/views/spree/admin/payments/source_forms/_komoju_web_money.html.erb

@@ -0,0 +1 @@
+<%= render partial: "spree/checkout/payment/komoju_web_money", locals: { payment_method: payment_method } %>

data/app/views/spree/admin/payments/source_views/_komoju_bank_transfer.html.erb

@@ -0,0 +1,13 @@
+<fieldset data-hook="bank-transfer">
+  <legend><%= Spree.t(:bank_tansfer) %></legend>
+  <table class="table table-condensed table-bordered">
+    <tr>
+      <th width="20%"><%= Spree::BankTransfer.human_attribute_name(:order_id) %>:</th>
+      <td><%= payment.source.order_id %></td>
+    </tr>
+    <tr>
+      <th><%= Spree::BankTransfer.human_attribute_name(:expires_at) %>:</th>
+      <td><%= payment.source.expires_at %></td>
+    </tr>
+  </table>
+</fieldset>

data/app/views/spree/admin/payments/source_views/_komoju_pay_easy.html.erb

@@ -0,0 +1,21 @@
+<fieldset data-hook="pay-easy">
+  <legend><%= Spree.t(:pay_easy) %></legend>
+  <table class="table table-condensed table-bordered">
+    <tr>
+      <th width="20%"><%= Spree::PayEasy.human_attribute_name(:bank_id) %>:</th>
+      <td><%= payment.source.bank_id %></td>
+    </tr>
+    <tr>
+      <th width="20%"><%= Spree::PayEasy.human_attribute_name(:customer_id) %>:</th>
+      <td><%= payment.source.customer_id %></td>
+    </tr>
+    <tr>
+      <th width="20%"><%= Spree::PayEasy.human_attribute_name(:confirmation_id) %>:</th>
+      <td><%= payment.source.confirmation_id %></td>
+    </tr>
+    <tr>
+      <th><%= Spree.t(:expires_at) %>:</th>
+      <td><%= payment.source.expires_at %></td>
+    </tr>
+  </table>
+</fieldset>

data/app/views/spree/admin/payments/source_views/_komoju_web_money.html.erb

@@ -0,0 +1,13 @@
+<fieldset data-hook="web-money">
+  <legend><%= Spree.t(:web_money) %></legend>
+  <table class="table table-condensed table-bordered">
+    <tr>
+      <th width="20%"><%= Spree::WebMoney.human_attribute_name(:prepaid_number) %>:</th>
+      <td>
+        <% payment.source.prepaid_cards.each do |card| %>
+          **** **** **** <%= card["last_four_digits"] %> / <%= card["points"] %> points<br/>
+        <% end %>
+      </td>
+    </tr>
+  </table>
+</fieldset>

data/app/views/spree/checkout/payment/_komoju_pay_easy.html.erb

@@ -0,0 +1,36 @@
+<div class="well clearfix">
+  <p><%= image_tag 'pay-easy.png' %></p>
+  <% param_prefix = "payment_source[#{payment_method.id}]" %>
+
+  <p class="field">
+    <%= label_tag "email", Spree.t(:email) %><span class="required">*</span><br />
+    <%= text_field_tag "#{param_prefix}[email]", @order.email, { id: "email", class: 'form-control required'} %>
+  </p>
+
+  <p class="field">
+    <%= label_tag "phone", Spree.t(:phone) %><span class="required">*</span><br />
+    <%= text_field_tag "#{param_prefix}[phone]", @order.billing_address.phone, { id: "phone", class: 'form-control required'} %>
+  </p>
+
+  <div class="row">
+    <div class="col-md-6 field">
+      <%= label_tag "family_name", Spree.t(:family_name) %><span class="required">*</span><br />
+      <%= text_field_tag "#{param_prefix}[family_name]", @order.billing_lastname, { id: "family_name", class: 'form-control required'} %>
+    </div>
+    <div class="col-md-6 field">
+      <%= label_tag "given_name", Spree.t(:given_name) %><span class="required">*</span><br />
+      <%= text_field_tag "#{param_prefix}[given_name]", @order.billing_firstname, { id: "given_name", class: 'form-control required'} %>
+    </div>
+  </div>
+
+  <div class="row">
+    <div class="col-md-6 field">
+      <%= label_tag "family_name_kana", Spree.t(:family_name_kana) %><span class="required">*</span><br />
+      <%= text_field_tag "#{param_prefix}[family_name_kana]", "", { id: "family_name_kana", class: 'form-control required'} %>
+    </div>
+    <div class="col-md-6 field">
+      <%= label_tag "given_name_kana", Spree.t(:given_name_kana) %><span class="required">*</span><br />
+      <%= text_field_tag "#{param_prefix}[given_name_kana]", "", { id: "given_name_kana", class: 'form-control required'} %>
+    </div>
+  </div>
+</div>

data/app/views/spree/checkout/payment/_komoju_web_money.html.erb

@@ -0,0 +1,74 @@
+<% @webmoney = Spree::WebMoneyDecorator.new(@order.payments.last.try(:source)) %>
+
+<div class="well webmoney clearfix">
+  <p><%= image_tag 'webmoney.png' %></p>
+  <% param_prefix = "payment_source[#{payment_method.id}]" %>
+
+  <p class="field">
+    <%= label_tag "email", Spree.t(:email) %><span class="required">*</span><br />
+    <%= text_field_tag "#{param_prefix}[email]", @order.email, { id: "email", class: 'form-control required'} %>
+  </p>
+
+  <%= hidden_field_tag "#{param_prefix}[prepaid_number]", "" %>
+
+  <div class="form-inline">
+    <%= label_tag "prepaid_number", Spree.t(:prepaid_number) %><span class="required">*</span><br />
+    <div class="form-group">
+      <%= text_field_tag nil, "", { id: "ppn1", class: 'form-control required webmoney_pin', size: 4, maxlength: 4 } %>
+    </div>
+    <div class="form-group">
+      <%= text_field_tag nil, "", { id: "ppn2", class: 'form-control required webmoney_pin', size: 4, maxlength: 4 } %>
+    </div>
+    <div class="form-group">
+      <%= text_field_tag nil, "", { id: "ppn3", class: 'form-control required webmoney_pin', size: 4, maxlength: 4 } %>
+    </div>
+    <div class="form-group">
+      <%= text_field_tag nil, "", { id: "ppn4", class: 'form-control required webmoney_pin', size: 4, maxlength: 4 } %>
+    </div>
+  </div>
+
+  <% if @webmoney.prepaid_cards.present? %>
+    <%= hidden_field_tag "#{param_prefix}[payment_uuid]", @webmoney.payment_uuid %>
+
+    <div class="well multicard">
+      <table>
+        <% @webmoney.prepaid_cards.each do |card| %>
+          <tr>
+            <th>**** **** **** <%= card["last_four_digits"] %></th>
+            <td><%= card["points"] %></td>
+          </tr>
+        <% end %>
+        <tr>
+          <th><%= t('spree.komoju.web_money.balance_remaining') %></th>
+          <td><%= @webmoney.short_amount %> <span class="points"><%= t('spree.komoju.web_money.points') %></td>
+        </tr>
+      </table>
+    </div>
+  <% end %>
+</div>
+
+<%=
+javascript_tag <<-JS
+  SpreeKomoju = {
+    addWebMoneyListener: function() {
+      $(".webmoney input.webmoney_pin").keyup(function() {
+        var length = $(this).val().length;
+        if (length == 4) {
+          $nextInput = $('input.webmoney_pin:eq(' + ($('input.webmoney_pin').index(this) + 1) + ')');
+          $nextInput.focus();
+        }
+      });
+
+      $(".webmoney").parents('form').has("input.webmoney_pin").submit(function() {
+        var prepaid_number = $("#ppn1").val() + $("#ppn2").val() + $("#ppn3").val() + $("#ppn4").val();
+        $(this).find("input[name*=prepaid_number]").val(prepaid_number)
+        $(this).find("input.webmoney_pin").prop('disabled', true)
+      })
+    }
+  }
+
+  $(document).ready(function() {
+    SpreeKomoju.addWebMoneyListener();
+  })
+JS
+%>

data/app/views/spree/orders/_pay_easy.html.erb

@@ -0,0 +1,24 @@
+<div>
+  <p>
+    Thank you for your order. Instructions have been sent to your e-mail address.<br/>
+    Please follow the link below to complete your purchase:
+  </p>
+
+  <%= link_to source.instructions_url do %>
+    How to pay with PayEasy
+  <% end %>
+</div>
+<br>
+
+<div class='alert alert-info' role='alert'>
+  <dl>
+    <dt>Bank Number</dt>
+    <dd><%= source.bank_id %></dd>
+    <dt>Customer Number</dt>
+    <dd><%= source.customer_id %></dd>
+    <dt>Confirmation Number</dt>
+    <dd><%= source.confirmation_id %></dd>
+    <dt>Expiry Date</dt>
+    <dd><%= l source.expires_at.in_time_zone("Tokyo"), format: :short %></dd>
+  </dl>
+</div>

data/bin/rails

@@ -1,7 +1,12 @@
-# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 4 gems installed from the root of your application.
 
 ENGINE_ROOT = File.expand_path('../..', __FILE__)
 ENGINE_PATH = File.expand_path('../../lib/spree_komoju/engine', __FILE__)
 
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
 require 'rails/all'
 require 'rails/engine/commands'

data/config/locales/en.yml

@@ -1,5 +1,8 @@
 en:
   spree:
+    pay_easy: Pay Easy
+    bank_transfer: Bank Transfer
+    web_money: WebMoney
     conveniences:
       lawson: Lawson
       family-mart: Family Mart
@@ -10,7 +13,32 @@ en:
       seven-eleven: Seven Eleven
     email: Email
     phone: Phone
-    given_name: Given Name
-    family_name: Family Name
-    given_name_kana: Given Name Kana
-    family_name_kana: Family Name Kana
+    given_name: First Name
+    family_name: Last Name
+    given_name_kana: First Name (Katakana)
+    family_name_kana: Last Name (Katakana)
+    prepaid_number: Prepaid Number
+    komoju:
+      attributes: &komoju-payment-details
+        email: Email
+        phone: Phone Number
+        given_name_kana: First Name (Katakana)
+        family_name_kana: Last Name (Katakana)
+        given_name: First Name
+        family_name: Last Name
+        instructions_url: Instructions URL
+        prepaid_number: Prepaid Number
+        order_id: Order ID
+        expires_at: Expiry Date
+        bank_id: Bank ID
+        customer_id: Customer ID
+        confirmation_id: Confirmation ID
+      web_money:
+        balance_remaining: "Balance Remaining"
+        points: "points"
+        insufficient_funds: Insufficient funds, please enter another card
+  activerecord:
+    attributes:
+      spree/pay_easy: *komoju-payment-details
+      spree/web_money: *komoju-payment-details
+      spree/bank_transfer: *komoju-payment-details

data/config/locales/ja.yml

@@ -0,0 +1,24 @@
+ja:
+  spree:
+    pay_easy: Pay Easy
+    conveniences:
+      lawson: ローソン
+      family-mart: ファミリーマート
+      sunkus: サンクス
+      circle-k: サークルK
+      ministop: ミニストップ
+      daily-yamazaki: デイリーヤマザキ
+      seven-eleven: セブンイレブン
+    email: メール
+    phone: 電話番号
+    given_name: 名
+    family_name: 姓
+    given_name_kana: 名 (カタカナ)
+    family_name_kana: 姓 (カタカナ)
+  activerecord:
+    attributes:
+      spree/pay_easy:
+        given_name_kana: 名 (カタカナ)
+        family_name_kana: 姓 (カタカナ)
+        given_name: 名
+        family_name: 姓

data/config/routes.rb

@@ -1,2 +1,3 @@
 Spree::Core::Engine.routes.draw do
+  post "komoju/callback" => "komoju#callback"
 end