solidus_open_pay 1.0.0

data/app/models/solidus_open_pay/gateway.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require 'openpay'
+
+module SolidusOpenPay
+  class Gateway
+    attr_reader :client
+
+    def initialize(options)
+      @client = OpenpayApi.new(
+        options.fetch(:merchant_id, nil),
+        options.fetch(:private_key, nil),
+        options.fetch(:country, nil).presence || !options.fetch(:test_mode, nil)
+      )
+      @options = options
+    end
+
+    def authorize(amount_in_cents, source, options = {})
+      resource_builder = ::SolidusOpenPay::Builders::Charge.new(
+        source: source,
+        amount: amount_in_cents,
+        options: options
+      )
+
+      response = client.create(:charges).create(
+        resource_builder.payload
+      )
+
+      source&.update(
+        authorization_id: response.try(:[], 'id')
+      )
+
+      SolidusOpenPay::Response.build(response)
+    rescue ::OpenpayTransactionException,
+           ::OpenpayException,
+           ::OpenpayConnectionException => e
+      SolidusOpenPay::Response.build(e)
+    end
+
+    def capture(_amount_in_cents, authorization_id, options = {})
+      response = client.create(:charges).capture(
+        authorization_id
+      )
+
+      json_response = JSON.parse(response.body)
+      source = options[:originator].try(:source)
+
+      source&.update(
+        capture_id: json_response.try(:[], 'id'),
+        authorization_id: json_response.try(:[], 'authorization')
+      )
+
+      SolidusOpenPay::Response.build(json_response)
+    rescue ::OpenpayTransactionException,
+           ::OpenpayException,
+           ::OpenpayConnectionException => e
+      SolidusOpenPay::Response.build(e)
+    end
+
+    def purchase(amount_in_cents, source, options = {})
+      resource_builder = ::SolidusOpenPay::Builders::Charge.new(
+        source: source,
+        amount: amount_in_cents,
+        options: options.merge({ capture: true })
+      )
+
+      response = client.create(:charges).create(
+        resource_builder.payload
+      )
+
+      source&.update(
+        capture_id: response.try(:[], 'id'),
+        authorization_id: response.try(:[], 'authorization')
+      )
+
+      SolidusOpenPay::Response.build(response)
+    rescue ::OpenpayTransactionException,
+           ::OpenpayException,
+           ::OpenpayConnectionException => e
+      SolidusOpenPay::Response.build(e)
+    end
+
+    def void(authorization_id, _options = {})
+      response = client.create(:charges).refund(
+        authorization_id,
+        {}
+      )
+
+      SolidusOpenPay::Response.build(response)
+    rescue ::OpenpayTransactionException,
+           ::OpenpayException,
+           ::OpenpayConnectionException => e
+      SolidusOpenPay::Response.build(e)
+    end
+
+    alias_method :credit, :void
+  end
+end

data/app/models/solidus_open_pay/payment_method.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module SolidusOpenPay
+  class PaymentMethod < ::Spree::PaymentMethod
+    preference :merchant_id, :string
+    preference :private_key, :string
+    preference :public_key, :string
+    preference :country, :string
+
+    def partial_name
+      'open_pay'
+    end
+
+    def source_required?
+      true
+    end
+
+    def payment_source_class
+      PaymentSource
+    end
+
+    def gateway_class
+      Gateway
+    end
+
+    def payment_profiles_supported?
+      false
+    end
+  end
+end

data/app/models/solidus_open_pay/payment_source.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module SolidusOpenPay
+  class PaymentSource < ::Spree::PaymentSource
+    include ::SolidusOpenPay::AttributesAccess
+
+    self.table_name = 'open_pay_sources'
+
+    def actions
+      %w[capture void credit]
+    end
+
+    def can_capture?(payment)
+      payment.pending? || payment.checkout?
+    end
+
+    def can_void?(payment)
+      can_capture?(payment)
+    end
+
+    def can_credit?(payment)
+      payment.completed? && payment.credit_allowed.positive?
+    end
+  end
+end

data/app/models/solidus_open_pay/response.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'active_merchant/billing/response'
+
+module SolidusOpenPay
+  class Response < ::ActiveMerchant::Billing::Response
+    class << self
+      private :new
+
+      def build(result)
+        if success?(result)
+          build_success(result)
+        else
+          build_failure(result)
+        end
+      end
+
+      private
+
+      def success?(result)
+        result.try(:[], 'id').present? &&
+          result.try(:[], 'error_message').blank?
+      end
+
+      def build_success(result)
+        new(
+          true,
+          result['description'],
+          result,
+          authorization: result['id']
+        )
+      end
+
+      def build_failure(result)
+        response = JSON.parse(result.json_body)
+
+        new(
+          false,
+          error_message(response),
+          response,
+          {}
+        )
+      end
+
+      def error_message(result)
+        error_message = transaction_error_message(result['error_code'])
+
+        [
+          error_message.to_s,
+          "(#{result['error_code']})"
+        ].join(' ')
+      end
+
+      def transaction_error_message(error_code)
+        I18n.t(
+          error_code,
+          scope: 'solidus_open_pay.gateway_rejection_reasons',
+          default: 'Error'
+        )
+      end
+    end
+  end
+end

data/app/views/checkouts/payment/_open_pay.html.erb

@@ -0,0 +1,171 @@
+<div class="gateway-payment-method flex flex-col gap-y-6 w-full">
+  <% param_prefix = "payment_source[#{payment_method.id}]" %>
+
+  <%= hidden_field_tag :token_id,
+                       '',
+                       id: 'token_id',
+                       name: "payment_source[#{payment_method.id}][token_id]",
+                       'data-openpay-card': 'token_id' %>
+
+  <div class='text-input' data-hook='card_name'>
+    <%= label_tag "name_on_card_#{payment_method.id}",
+                  t('spree.name_on_card') %>
+    <%= text_field_tag "#{param_prefix}[name]",
+                       '',
+                       {
+                         id: "name_on_card_#{payment_method.id}",
+                         autocomplete: 'cc-name',
+                         class: 'cardName',
+                         placeholder: I18n.t('solidus_open_pay.form.placeholder.card_name'),
+                         'data-openpay-card': 'holder_name'
+                        } %>
+  </div>
+
+  <div class='text-input card_number' data-hook='card_number'>
+    <%= label_tag 'card_number',
+              t('spree.card_number') %>
+    <%= text_field_tag "#{param_prefix}[number]",
+                       '',
+                       {
+                         id: 'card_number',
+                         class: 'required',
+                          size: 19,
+                          maxlength: 19,
+                          autocomplete: 'cc-number',
+                          type: 'tel',
+                          placeholder: I18n.t('solidus_open_pay.form.placeholder.card_number'),
+                          'data-openpay-card': 'card_number'
+                        } %>
+
+    <span id='card_type' style='display:none;'>
+      ( <span id='looks_like' ><%= t('spree.card_type_is') %> <span id='type'></span></span>
+        <span id='unrecognized'><%= t('spree.unrecognized_card_type') %></span>
+      )
+    </span>
+  </div>
+
+  <div class='flex flex-col gap-6 sm:flex-row'>
+    <div class='text-input w-full card_expiration' data-hook='card_expiration'>
+      <%= label_tag 'card_expiry',
+                    t('spree.expiration') %>
+      <%= text_field_tag "#{param_prefix}[expiration_month]",
+                         '',
+                         id: 'card-expiry-month',
+                         class: 'w-auto required text-center',
+                         placeholder: 'MM',
+                         maxlength: 2,
+                         type: 'tel',
+                         data: { 'openpay-card': 'expiration_month' } %>
+      <span> / </span>
+      <%= text_field_tag "#{param_prefix}[expiration_year]",
+                         '',
+                         id: 'card-expiry-year',
+                         class: 'w-auto required text-center',
+                         placeholder: 'YY',
+                         maxlength: 2,
+                         type: 'tel',
+                         data: { 'openpay-card': 'expiration_year' } %>
+    </div>
+
+    <div class='text-input w-full card_code' data-hook='card_code'>
+      <%= label_tag 'card_code',
+                    t('spree.card_code') %>
+      <%= text_field_tag "#{param_prefix}[verification_value]",
+                         '',
+                         {
+                           id: 'card_code',
+                           class: 'required cardCode',
+                           size: 5,
+                           type: 'tel',
+                           autocomplete: 'off',
+                           placeholder: I18n.t('solidus_open_pay.form.placeholder.card_code'),
+                           'data-openpay-card': 'cvv2'
+                         } %>
+    </div>
+  </div>
+</div>
+
+<%= hidden_field_tag :device_session_id,
+                     '',
+                     id: 'device-session-id',
+                     name: "payment_source[#{payment_method.id}][device_session_id]" %>
+
+<%= hidden_field_tag :cc_brand,
+                     '',
+                     id: 'cc-brand',
+                     name: "payment_source[#{payment_method.id}][brand]" %>
+
+<%= hidden_field_tag :cc_points_card,
+                     '',
+                     id: 'cc-points-card',
+                     name: "payment_source[#{payment_method.id}][points_card]" %>
+
+<%= hidden_field_tag :cc_points_type,
+                     '',
+                     id: 'cc-points-type',
+                     name: "payment_source[#{payment_method.id}][points_type]" %>
+
+<script type='text/javascript'
+        src='https://ajax.googleapis.com/ajax/libs/jquery/1.11.0/jquery.min.js'></script>
+<script type='text/javascript'
+        src='https://openpay.s3.amazonaws.com/openpay.v1.min.js'></script>
+<script type='text/javascript'
+        src='https://openpay.s3.amazonaws.com/openpay-data.v1.min.js'></script>
+
+<script type='text/javascript'>
+  $(document).ready(function() {
+    // Initialize OpenPay
+    OpenPay.setId('<%= payment_method.preferred_merchant_id %>');
+    OpenPay.setApiKey('<%= payment_method.preferred_public_key %>');
+    OpenPay.setSandboxMode('<%= payment_method.preferred_test_mode %>');
+
+    var paymentForm = document.getElementById('checkout_form_payment');
+    var submitButton = document.querySelector('.button-primary');
+
+    submitButton.addEventListener('click', function(event) {
+      event.preventDefault();
+
+      // Disable submit button
+      submitButton.disabled = true;
+
+      // Set values
+      var deviceDataId = OpenPay.deviceData.setup(
+        paymentForm,
+        'deviceIdField'
+      );
+
+      document.getElementById('device-session-id').value = deviceDataId;
+
+      OpenPay.token.extractFormAndCreate(
+        paymentForm,
+        sucess_callbak,
+        error_callbak,
+        OpenPay.getId()
+      );
+    });
+
+    var sucess_callbak = function(response) {
+      var data = response.data
+      var token_id = data.id;
+
+      document.getElementById('token_id').value = token_id;
+      document.getElementById('cc-brand').value = data.card.brand;
+      document.getElementById('cc-points-card').value = data.card.points_card;
+      document.getElementById('cc-points-type').value = data.card.points_type;
+      document.getElementById('checkout_form_payment').submit();
+    };
+
+    var error_callbak = function(response) {
+      var desc = '';
+
+      if (response.data.description != undefined) {
+        desc = response.data.description
+      } else {
+        desc = response.message;
+      };
+
+      alert('ERROR [' + response.status + '] ' + desc);
+      submitButton.disabled = false;
+    };
+  })
+ </script>

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

@@ -0,0 +1,21 @@
+<fieldset data-hook='credit_card'>
+  <legend align='center'><%= I18n.t('spree.credit_card') %></legend>
+
+  <div class='row'>
+    <div class='alpha six columns'>
+      <dl>
+        <dt><%= I18n.t('solidus_open_pay.admin.card.brand') %>:</dt>
+        <dd><%= payment.source.brand.capitalize %></dd>
+
+        <dt><%= I18n.t('solidus_open_pay.admin.card.card_number') %>:</dt>
+        <dd><%= payment.source.display_number %></dd>
+
+        <dt><%= I18n.t('solidus_open_pay.admin.card.token_id') %>:</dt>
+        <dd><%= payment.source.token_id %></dd>
+
+        <dt><%= I18n.t('solidus_open_pay.admin.card.device_session_id') %>:</dt>
+        <dd><%= payment.source.device_session_id %></dd>
+      </dl>
+    </div>
+  </div>
+</fieldset>

data/app/views/spree/api/payments/source_views/_open_pay.json.jbuilder

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+json.call(payment_source, :token_id, :brand, :device_session_id)

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

@@ -0,0 +1,183 @@
+<%= image_tag 'credit_cards/credit_card.gif', id: 'credit-card-image' %>
+<% param_prefix = "payment_source[#{payment_method.id}]" %>
+
+<%= hidden_field_tag :token_id,
+                     '',
+                     id: 'token_id',
+                     name: "payment_source[#{payment_method.id}][token_id]",
+                     'data-openpay-card': 'token_id' %>
+
+<div class='field field-required card_name' data-hook='card_name'>
+  <%= label_tag "name_on_card_#{payment_method.id}",
+                t('spree.name_on_card') %>
+  <%= text_field_tag "#{param_prefix}[name]",
+                     '',
+                     {
+                       id: "name_on_card_#{payment_method.id}",
+                       autocomplete: 'cc-name',
+                       class: 'cardName',
+                       placeholder: I18n.t('solidus_open_pay.form.placeholder.card_name'),
+                       'data-openpay-card': 'holder_name'
+                      } %>
+</div>
+
+<div class='field field-required card_number' data-hook='card_number'>
+  <%= label_tag 'card_number',
+            t('spree.card_number') %>
+  <%= text_field_tag "#{param_prefix}[number]",
+                     '',
+                     {
+                       id: 'card_number',
+                       class: 'required',
+                        size: 19,
+                        maxlength: 19,
+                        autocomplete: 'cc-number',
+                        type: 'tel',
+                        placeholder: I18n.t('solidus_open_pay.form.placeholder.card_number'),
+                        'data-openpay-card': 'card_number'
+                      } %>
+
+  <span id='card_type' style='display:none;'>
+    ( <span id='looks_like' ><%= t('spree.card_type_is') %> <span id='type'></span></span>
+      <span id='unrecognized'><%= t('spree.unrecognized_card_type') %></span>
+    )
+  </span>
+</div>
+
+<div class='field field-required card_expiration' data-hook='card_expiration'>
+  <%= label_tag 'card_expiry',
+                t('spree.expiration') %>
+  <%= text_field_tag "#{param_prefix}[expiration_month]",
+                     '',
+                     id: 'card-expiry-month',
+                     class: 'required text-center',
+                     placeholder: 'MM',
+                     maxlength: 2,
+                     type: 'tel',
+                     data: { 'openpay-card': 'expiration_month' } %>
+  <span> / </span>
+  <%= text_field_tag "#{param_prefix}[expiration_year]",
+                     '',
+                     id: 'card-expiry-year',
+                     class: 'required text-center',
+                     placeholder: 'YY',
+                     maxlength: 2,
+                     type: 'tel',
+                     data: { 'openpay-card': 'expiration_year' } %>
+</div>
+
+<div class='field field-required card_code' data-hook='card_code'>
+  <%= label_tag 'card_code',
+                t('spree.card_code') %>
+  <%= text_field_tag "#{param_prefix}[verification_value]",
+                     '',
+                     {
+                       id: 'card_code',
+                       class: 'required cardCode',
+                       size: 5,
+                       type: 'tel',
+                       autocomplete: 'off',
+                       placeholder: I18n.t('solidus_open_pay.form.placeholder.card_code'),
+                       'data-openpay-card': 'cvv2'
+                     } %>
+  <%= link_to "(#{t('spree.what_is_this')})",
+              spree.cvv_path,
+              target: '_blank',
+              'data-hook': 'cvv_link',
+              id: 'cvv_link' %>
+</div>
+
+<%= hidden_field_tag :device_session_id,
+                     '',
+                     id: 'device-session-id',
+                     name: "payment_source[#{payment_method.id}][device_session_id]" %>
+
+<%= hidden_field_tag :cc_brand,
+                     '',
+                     id: 'cc-brand',
+                     name: "payment_source[#{payment_method.id}][brand]" %>
+
+<%= hidden_field_tag :cc_points_card,
+                     '',
+                     id: 'cc-points-card',
+                     name: "payment_source[#{payment_method.id}][points_card]" %>
+
+<%= hidden_field_tag :cc_points_type,
+                     '',
+                     id: 'cc-points-type',
+                     name: "payment_source[#{payment_method.id}][points_type]" %>
+
+<br class='space' />
+
+<div class='form-buttons' data-hook='buttons'>
+  <%= submit_tag I18n.t('spree.save_and_continue'),
+                 class: 'continue button primary',
+                 id: 'pay-button' %>
+</div>
+
+<script type='text/javascript'
+        src='https://ajax.googleapis.com/ajax/libs/jquery/1.11.0/jquery.min.js'></script>
+<script type='text/javascript'
+        src='https://openpay.s3.amazonaws.com/openpay.v1.min.js'></script>
+<script type='text/javascript'
+        src='https://openpay.s3.amazonaws.com/openpay-data.v1.min.js'></script>
+
+<script type='text/javascript'>
+  $(document).ready(function() {
+    Spree.disableSaveOnClick();
+
+    // Initialize OpenPay
+    OpenPay.setId('<%= payment_method.preferred_merchant_id %>');
+    OpenPay.setApiKey('<%= payment_method.preferred_public_key %>');
+    OpenPay.setSandboxMode('<%= payment_method.preferred_test_mode %>');
+
+    var paymentForm = document.getElementById('checkout_form_payment');
+    var submitButton = document.getElementById('pay-button');
+
+    submitButton.addEventListener('click', function(event) {
+      event.preventDefault();
+
+      // Disable submit button
+      document.getElementById('pay-button').disabled = true;
+
+      // Set values
+      var deviceDataId = OpenPay.deviceData.setup(
+        paymentForm,
+        'deviceIdField'
+      );
+
+      document.getElementById('device-session-id').value = deviceDataId;
+
+      OpenPay.token.extractFormAndCreate(
+        paymentForm,
+        sucess_callbak,
+        error_callbak,
+        OpenPay.getId()
+      );
+    });
+
+    var sucess_callbak = function(response) {
+      var data = response.data
+      var token_id = data.id;
+
+      document.getElementById('token_id').value = token_id;
+      document.getElementById('cc-brand').value = data.card.brand;
+      document.getElementById('cc-points-card').value = data.card.points_card;
+      document.getElementById('cc-points-type').value = data.card.points_type;
+      document.getElementById('checkout_form_payment').submit();
+    };
+
+    var error_callbak = function(response) {
+      var desc = '';
+
+      if (response.data.description != undefined) {
+        desc = response.data.description
+      } else {
+        desc = response.message;
+      };
+
+      alert('ERROR [' + response.status + '] ' + desc);
+      document.getElementById('pay-button').disabled = false;
+    };
+  })
+ </script>

data/bin/console

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "solidus_open_pay"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+$LOAD_PATH.unshift(*Dir["#{__dir__}/../app/*"])
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/rails

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+if %w[g generate].include? ARGV.first
+  exec "#{__dir__}/rails-engine", *ARGV
+else
+  exec "#{__dir__}/rails-sandbox", *ARGV
+end

data/bin/rails-engine

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

data/bin/rails-sandbox

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+app_root = 'sandbox'
+
+unless File.exist? "#{app_root}/bin/rails"
+  warn 'Creating the sandbox app...'
+  Dir.chdir "#{__dir__}/.." do
+    system "#{__dir__}/sandbox" or begin
+      warn 'Automatic creation of the sandbox app failed'
+      exit 1
+    end
+  end
+end
+
+Dir.chdir app_root
+exec 'bin/rails', *ARGV

data/bin/rake

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")