solidus_stripe 1.0.0

data/lib/views/backend/spree/admin/log_entries/_stripe.html.erb

@@ -0,0 +1,28 @@
+<tr>
+  <td><%= t(:message, :scope => [:spree, :log_entry, :stripe]) %></td>
+  <td><%= entry.parsed_details.message %></td>
+</tr>
+<tr>
+  <td><%= t(:charge_id, :scope => [:spree, :log_entry, :stripe]) %></td>
+  <td><%= entry.parsed_details.params['id'] %></td>
+</tr>
+<% if card = entry.parsed_details.params['card'] %>
+  <tr>
+    <td><%= t(:card_id, :scope => [:spree, :log_entry, :stripe]) %></td>
+    <td><%= card['id'] %></td>
+  </tr>
+
+  <tr>
+    <td><%= t(:cvc_check, :scope => [:spree, :log_entry, :stripe]) %></td>
+    <td><%= card['cvc_check'] %></td>
+  </tr>
+
+  <tr>
+    <td><%= t(:address_zip_check, :scope => [:spree, :log_entry, :stripe]) %></td>
+    <td><%= card['address_zip_check'] %></td>
+  </tr>
+<% end %>
+<tr>
+  <td><%= t(:cvv_result, :scope => [:spree, :log_entry, :stripe]) %></td>
+  <td><%= entry.parsed_details.cvv_result['message'].to_s %></td>
+</tr>

data/lib/views/backend/spree/admin/payments/source_forms/_stripe.html.erb

@@ -0,0 +1 @@
+<%= render "spree/admin/payments/source_forms/gateway", payment_method: payment_method, previous_cards: payment_method.reusable_sources(@order) %>

data/lib/views/backend/spree/admin/payments/source_views/_stripe.html.erb

@@ -0,0 +1 @@
+<%= render "spree/admin/payments/source_views/gateway", payment: payment %>

data/lib/views/frontend/spree/checkout/existing_payment/_stripe.html.erb

@@ -0,0 +1 @@
+<%= render partial: "spree/checkout/existing_payment/gateway", locals: { wallet_payment_source: wallet_payment_source, default: default } %>

data/lib/views/frontend/spree/checkout/payment/_stripe.html.erb

@@ -0,0 +1,6 @@
+<% if payment_method.v3_elements? %>
+  <%= render 'spree/checkout/payment/v3/stripe', payment_method: payment_method %>
+<% else %>
+  <%= render "spree/checkout/payment/gateway", payment_method: payment_method %>
+  <%= render 'spree/checkout/payment/v2/javascript', payment_method: payment_method %>
+<% end %>

data/lib/views/frontend/spree/checkout/payment/v2/_javascript.html.erb

@@ -0,0 +1,77 @@
+<script type="text/javascript" src="https://js.stripe.com/v2/"></script>
+<script type="text/javascript">
+  Stripe.setPublishableKey("<%= payment_method.preferred_publishable_key %>");
+</script>
+
+<script>
+  Spree.stripePaymentMethod = $('#payment_method_' + <%= payment_method.id %>);
+  var mapCC, stripeResponseHandler;
+
+  mapCC = function(ccType) {
+    if (ccType === 'MasterCard') {
+      return 'mastercard';
+    } else if (ccType === 'Visa') {
+      return 'visa';
+    } else if (ccType === 'American Express') {
+      return 'amex';
+    } else if (ccType === 'Discover') {
+      return 'discover';
+    } else if (ccType === 'Diners Club') {
+      return 'dinersclub';
+    } else if (ccType === 'JCB') {
+      return 'jcb';
+    }
+  };
+
+  stripeResponseHandler = function(status, response) {
+    var paymentMethodId, token;
+    if (response.error) {
+      $('#stripeError').html(response.error.message);
+      return $('#stripeError').show();
+    } else {
+      Spree.stripePaymentMethod.find('#card_number, #card_expiry, #card_code').prop("disabled", true);
+      Spree.stripePaymentMethod.find(".ccType").prop("disabled", false);
+      Spree.stripePaymentMethod.find(".ccType").val(mapCC(response.card.brand));
+      token = response['id'];
+      paymentMethodId = Spree.stripePaymentMethod.prop('id').split("_")[2];
+      Spree.stripePaymentMethod.append("<input type='hidden' class='stripeToken' name='payment_source[" + paymentMethodId + "][gateway_payment_profile_id]' value='" + token + "'/>");
+      Spree.stripePaymentMethod.append("<input type='hidden' class='stripeToken' name='payment_source[" + paymentMethodId + "][last_digits]' value='" + response.card.last4 + "'/>");
+      Spree.stripePaymentMethod.append("<input type='hidden' class='stripeToken' name='payment_source[" + paymentMethodId + "][month]' value='" + response.card.exp_month + "'/>");
+      Spree.stripePaymentMethod.append("<input type='hidden' class='stripeToken' name='payment_source[" + paymentMethodId + "][year]' value='" + response.card.exp_year + "'/>");
+      return Spree.stripePaymentMethod.parents("form").get(0).submit();
+    }
+  };
+
+  $(document).ready(function() {
+    Spree.stripePaymentMethod.prepend("<div id='stripeError' class='errorExplanation' style='display:none'></div>");
+    return $('#checkout_form_payment [data-hook=buttons]').click(function() {
+      var expiration, params;
+      $('#stripeError').hide();
+      if (Spree.stripePaymentMethod.is(':visible')) {
+        expiration = $('.cardExpiry:visible').payment('cardExpiryVal');
+        params = $.extend({
+          number: $('.cardNumber:visible').val(),
+          cvc: $('.cardCode:visible').val(),
+          exp_month: expiration.month || 0,
+          exp_year: expiration.year || 0
+        }, Spree.stripeAdditionalInfo);
+        Stripe.card.createToken(params, stripeResponseHandler);
+        return false;
+      }
+    });
+  });
+</script>
+
+<%- if @order.has_checkout_step?('address') -%>
+  <script>
+    Spree.stripeAdditionalInfo = {
+      name: "<%= @order.bill_address.full_name %>",
+      address_line1: "<%= @order.bill_address.address1 %>",
+      address_line2: "<%= @order.bill_address.address2 %>",
+      address_city: "<%= @order.bill_address.city %>",
+      address_state: "<%= @order.bill_address.state_text %>",
+      address_zip: "<%= @order.bill_address.zipcode %>",
+      address_country: "<%= @order.bill_address.country %>"
+    }
+  </script>
+<%- end -%>

data/lib/views/frontend/spree/checkout/payment/v3/_stripe.html.erb

@@ -0,0 +1,133 @@
+<%= image_tag 'credit_cards/credit_card.gif', id: 'credit-card-image' %>
+<% param_prefix = "payment_source[#{payment_method.id}]" %>
+
+<div class="field field-required">
+  <%= label_tag "name_on_card_#{payment_method.id}", t('spree.name_on_card') %>
+  <%= text_field_tag "#{param_prefix}[name]", "#{@order.billing_firstname} #{@order.billing_lastname}", { id: "name_on_card_#{payment_method.id}", autocomplete: "cc-name" } %>
+</div>
+
+<div class="field field-required" data-hook="card_number">
+  <%= label_tag "card_number", t('spree.card_number') %>
+  <div id="card_number"></div>
+  <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" data-hook="card_expiration">
+  <%= label_tag "card_expiry", t('spree.expiration') %>
+  <div id="card_expiry"></div>
+</div>
+
+<div class="field field-required" data-hook="card_code">
+  <%= label_tag "card_cvc", t('spree.card_code') %>
+  <div id="card_cvc"></div>
+  <%= link_to "(#{t('spree.what_is_this')})", spree.cvv_path, target: '_blank', "data-hook" => "cvv_link", id: "cvv_link" %>
+</div>
+
+<div id="card-errors" class='errorExplanation' role="alert" style="display: none"></div>
+
+<% if @order.bill_address %>
+  <%= fields_for "#{param_prefix}[address_attributes]", @order.bill_address do |f| %>
+    <%= render partial: 'spree/address/form_hidden', locals: { form: f } %>
+  <% end %>
+<% end %>
+
+<%= hidden_field_tag "#{param_prefix}[cc_type]", '', id: "cc_type", class: 'ccType' %>
+
+<script src="https://js.stripe.com/v3/"></script>
+
+<script>
+  Spree.stripePaymentMethod = $('#payment_method_' + <%= payment_method.id %>);
+
+  var stripe = Stripe("<%= payment_method.preferred_publishable_key %>");
+
+  var elements = stripe.elements({locale: 'en'});
+
+  var style = {
+    base: {
+      color: 'black',
+      fontFamily: '"Helvetica Neue", Helvetica, sans-serif',
+      fontSmoothing: 'antialiased',
+      fontSize: '14px',
+      '::placeholder': {
+        color: 'silver'
+      }
+    },
+    invalid: {
+      color: 'red',
+      iconColor: 'red'
+    }
+  };
+
+  var cardNumber = elements.create('cardNumber', {style: style});
+  var cardExpiry = elements.create('cardExpiry', {style: style});
+  var cardCvc = elements.create('cardCvc', {style: style});
+
+  cardNumber.mount('#card_number');
+  cardExpiry.mount('#card_expiry');
+  cardCvc.mount('#card_cvc');
+
+  $(function() {
+    var form = Spree.stripePaymentMethod.parents('form');
+    var submitButton = form.find('input[type="submit"]');
+    var errorElement = form.find('#card-errors');
+    var cardType = form.find('input#cc_type');
+
+    cardNumber.addEventListener('change', function(event) {
+      if (event.error) {
+        errorElement.text(event.error.message).show();
+      } else {
+        errorElement.hide().text('');
+      }
+    });
+
+    form.bind('submit', function(event) {
+      if (Spree.stripePaymentMethod.is(':visible')) {
+        event.preventDefault();
+
+        stripe.createToken(cardNumber).then(function(result) {
+          if (result.error) {
+            errorElement.text(result.error.message).show();
+            setTimeout(function() {
+              $.rails.enableElement(submitButton[0]);
+              submitButton.removeAttr('disabled').removeClass('disabled');
+            }, 100);
+          } else {
+            stripeTokenHandler(result.token);
+          }
+        });
+      }
+    });
+
+    function stripeTokenHandler(token) {
+      var paymentMethodId = Spree.stripePaymentMethod.prop('id').split("_")[2];
+      var baseSelector = `<input type='hidden' class='stripeToken' name='payment_source[${paymentMethodId}]`;
+
+      Spree.stripePaymentMethod.append(`${baseSelector}[gateway_payment_profile_id]' value='${token.id}'/>`);
+      Spree.stripePaymentMethod.append(`${baseSelector}[last_digits]' value='${token.card.last4}'/>`);
+      Spree.stripePaymentMethod.append(`${baseSelector}[month]' value='${token.card.exp_month}'/>`);
+      Spree.stripePaymentMethod.append(`${baseSelector}[year]' value='${token.card.exp_year}'/>`);
+      cardType.val(mapCC(token.card.type));
+      form[0].submit();
+    };
+
+    function mapCC(ccType) {
+      if (ccType === 'MasterCard') {
+        return 'mastercard';
+      } else if (ccType === 'Visa') {
+        return 'visa';
+      } else if (ccType === 'American Express') {
+        return 'amex';
+      } else if (ccType === 'Discover') {
+        return 'discover';
+      } else if (ccType === 'Diners Club') {
+        return 'dinersclub';
+      } else if (ccType === 'JCB') {
+        return 'jcb';
+      }
+    };
+  })
+</script>

data/solidus_stripe.gemspec

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'solidus_stripe/version'
+
+# encoding: UTF-8
+
+Gem::Specification.new do |s|
+  s.platform    = Gem::Platform::RUBY
+  s.name        = "solidus_stripe"
+  s.version     = SolidusStripe::VERSION
+  s.summary     = "Stripe Payment Method for Solidus"
+  s.description = s.summary
+  s.required_ruby_version = ">= 2.2"
+
+  s.author       = "Solidus Team"
+  s.email        = "contact@solidus.io"
+  s.homepage     = "https://solidus.io"
+  s.license      = 'BSD-3'
+
+  s.files        = `git ls-files`.split("\n")
+  s.test_files   = `git ls-files -- spec/*`.split("\n")
+  s.require_path = "lib"
+  s.requirements << "none"
+
+  s.add_dependency "solidus_core", [">= 2.3", "< 3"]
+  s.add_dependency "solidus_support", ">= 0.3.1"
+
+  # ActiveMerchant v1.58 through v1.59 introduced a breaking change
+  # to the stripe gateway.
+  #
+  # This was resolved in v1.60, but we still need to skip 1.58 & 1.59.
+  s.add_dependency "activemerchant", "~> 1.48", "!= 1.58.0", "!= 1.59.0"
+
+  s.add_development_dependency "capybara"
+  s.add_development_dependency "capybara-screenshot"
+  s.add_development_dependency "database_cleaner", "~> 1.5"
+  s.add_development_dependency "factory_bot", "~> 4.4"
+  s.add_development_dependency "gem-release", "~> 2.0"
+  s.add_development_dependency "rspec-rails", "~> 3.2"
+  s.add_development_dependency 'selenium-webdriver', '~> 3.142'
+  s.add_development_dependency "simplecov"
+  s.add_development_dependency "sqlite3"
+end

data/spec/features/stripe_checkout_spec.rb

@@ -0,0 +1,279 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe "Stripe checkout", type: :feature do
+  let(:zone) { FactoryBot.create(:zone) }
+  let(:country) { FactoryBot.create(:country) }
+
+  before do
+    FactoryBot.create(:store)
+    zone.members << Spree::ZoneMember.create!(zoneable: country)
+    FactoryBot.create(:free_shipping_method)
+
+    Spree::PaymentMethod::StripeCreditCard.create!(
+      name: "Stripe",
+      preferred_secret_key: "sk_test_VCZnDv3GLU15TRvn8i2EsaAN",
+      preferred_publishable_key: "pk_test_Cuf0PNtiAkkMpTVC2gwYDMIg",
+      preferred_v3_elements: preferred_v3_elements
+    )
+
+    FactoryBot.create(:product, name: "DL-44")
+
+    visit spree.root_path
+    click_link "DL-44"
+    click_button "Add To Cart"
+
+    expect(page).to have_current_path("/cart")
+    click_button "Checkout"
+
+    expect(page).to have_current_path("/checkout/registration")
+    click_link "Create a new account"
+    within("#new_spree_user") do
+      fill_in "Email", with: "mary@example.com"
+      fill_in "Password", with: "superStrongPassword"
+      fill_in "Password Confirmation", with: "superStrongPassword"
+    end
+    click_button "Create"
+
+    # Address
+    expect(page).to have_current_path("/checkout/address")
+
+    within("#billing") do
+      fill_in "First Name", with: "Han"
+      fill_in "Last Name", with: "Solo"
+      fill_in "Street Address", with: "YT-1300"
+      fill_in "City", with: "Mos Eisley"
+      select "United States of America", from: "Country"
+      select country.states.first.name, from: "order_bill_address_attributes_state_id"
+      fill_in "Zip", with: "12010"
+      fill_in "Phone", with: "(555) 555-5555"
+    end
+    click_on "Save and Continue"
+
+    # Delivery
+    expect(page).to have_current_path("/checkout/delivery")
+    expect(page).to have_content("UPS Ground")
+  end
+
+  # This will fetch a token from Stripe.com and then pass that to the webserver.
+  # The server then processes the payment using that token.
+
+  context 'when using Stripe V2 API library' do
+    let(:preferred_v3_elements) { false }
+
+    before do
+      click_on "Save and Continue"
+      expect(page).to have_current_path("/checkout/payment")
+    end
+
+    it "can process a valid payment", js: true do
+      fill_in "Card Number", with: "4242 4242 4242 4242"
+      fill_in "Card Code", with: "123"
+      fill_in "Expiration", with: "01 / #{Time.now.year + 1}"
+      click_button "Save and Continue"
+      expect(page).to have_current_path("/checkout/confirm")
+      click_button "Place Order"
+      expect(page).to have_content("Your order has been processed successfully")
+    end
+
+    it "can re-use saved cards", js: true do
+      fill_in "Card Number", with: "4242 4242 4242 4242"
+      fill_in "Card Code", with: "123"
+      fill_in "Expiration", with: "01 / #{Time.now.year + 1}"
+      click_button "Save and Continue"
+
+      expect(page).to have_current_path("/checkout/confirm")
+      click_button "Place Order"
+      expect(page).to have_content("Your order has been processed successfully")
+
+      visit spree.root_path
+      click_link "DL-44"
+      click_button "Add To Cart"
+
+      expect(page).to have_current_path("/cart")
+      click_button "Checkout"
+
+      # Address
+      expect(page).to have_current_path("/checkout/address")
+
+      within("#billing") do
+        fill_in "First Name", with: "Han"
+        fill_in "Last Name", with: "Solo"
+        fill_in "Street Address", with: "YT-1300"
+        fill_in "City", with: "Mos Eisley"
+        select "United States of America", from: "Country"
+        select country.states.first.name, from: "order_bill_address_attributes_state_id"
+        fill_in "Zip", with: "12010"
+        fill_in "Phone", with: "(555) 555-5555"
+      end
+      click_on "Save and Continue"
+
+      # Delivery
+      expect(page).to have_current_path("/checkout/delivery")
+      expect(page).to have_content("UPS Ground")
+      click_on "Save and Continue"
+
+      # Payment
+      expect(page).to have_current_path("/checkout/payment")
+      choose "Use an existing card on file"
+      click_button "Save and Continue"
+
+      # Confirm
+      expect(page).to have_current_path("/checkout/confirm")
+      click_button "Place Order"
+      expect(page).to have_content("Your order has been processed successfully")
+    end
+
+    it "shows an error with a missing credit card number", js: true do
+      fill_in "Expiration", with: "01 / #{Time.now.year + 1}"
+      click_button "Save and Continue"
+      expect(page).to have_content("Could not find payment information")
+    end
+
+    it "shows an error with a missing expiration date", js: true do
+      fill_in "Card Number", with: "4242 4242 4242 4242"
+      click_button "Save and Continue"
+      expect(page).to have_content("Your card's expiration year is invalid.")
+    end
+
+    it "shows an error with an invalid credit card number", js: true do
+      fill_in "Card Number", with: "1111 1111 1111 1111"
+      fill_in "Expiration", with: "01 / #{Time.now.year + 1}"
+      click_button "Save and Continue"
+      expect(page).to have_content("Your card number is incorrect.")
+    end
+
+    it "shows an error with invalid security fields", js: true do
+      fill_in "Card Number", with: "4242 4242 4242 4242"
+      fill_in "Expiration", with: "01 / #{Time.now.year + 1}"
+      fill_in "Card Code", with: "12"
+      click_button "Save and Continue"
+      expect(page).to have_content("Your card's security code is invalid.")
+    end
+
+    it "shows an error with invalid expiry fields", js: true do
+      fill_in "Card Number", with: "4242 4242 4242 4242"
+      fill_in "Expiration", with: "00 / #{Time.now.year + 1}"
+      fill_in "Card Code", with: "123"
+      click_button "Save and Continue"
+      expect(page).to have_content("Your card's expiration month is invalid.")
+    end
+  end
+
+  context 'when using Stripe V3 API libarary with Elements' do
+    let(:preferred_v3_elements) { true }
+
+    before do
+      click_on "Save and Continue"
+      expect(page).to have_current_path("/checkout/payment")
+    end
+
+    it "can process a valid payment", js: true do
+      within_frame find('#card_number iframe') do
+        '4242 4242 4242 4242'.split('').each { |n| find_field('cardnumber').native.send_keys(n) }
+      end
+      within_frame(find '#card_cvc iframe') { fill_in 'cvc', with: '123' }
+      within_frame(find '#card_expiry iframe') { fill_in 'exp-date', with: "0132" }
+      click_button "Save and Continue"
+      expect(page).to have_current_path("/checkout/confirm")
+      click_button "Place Order"
+      expect(page).to have_content("Your order has been processed successfully")
+    end
+
+    it "can re-use saved cards", js: true do
+      within_frame find('#card_number iframe') do
+        '4242 4242 4242 4242'.split('').each { |n| find_field('cardnumber').native.send_keys(n) }
+      end
+      within_frame(find '#card_cvc iframe') { fill_in 'cvc', with: '123' }
+      within_frame(find '#card_expiry iframe') { fill_in 'exp-date', with: "0132" }
+      click_button "Save and Continue"
+      expect(page).to have_current_path("/checkout/confirm")
+      click_button "Place Order"
+      expect(page).to have_content("Your order has been processed successfully")
+
+      visit spree.root_path
+      click_link "DL-44"
+      click_button "Add To Cart"
+
+      expect(page).to have_current_path("/cart")
+      click_button "Checkout"
+
+      # Address
+      expect(page).to have_current_path("/checkout/address")
+
+      within("#billing") do
+        fill_in "First Name", with: "Han"
+        fill_in "Last Name", with: "Solo"
+        fill_in "Street Address", with: "YT-1300"
+        fill_in "City", with: "Mos Eisley"
+        select "United States of America", from: "Country"
+        select country.states.first.name, from: "order_bill_address_attributes_state_id"
+        fill_in "Zip", with: "12010"
+        fill_in "Phone", with: "(555) 555-5555"
+      end
+      click_on "Save and Continue"
+
+      # Delivery
+      expect(page).to have_current_path("/checkout/delivery")
+      expect(page).to have_content("UPS Ground")
+      click_on "Save and Continue"
+
+      # Payment
+      expect(page).to have_current_path("/checkout/payment")
+      choose "Use an existing card on file"
+      click_button "Save and Continue"
+
+      # Confirm
+      expect(page).to have_current_path("/checkout/confirm")
+      click_button "Place Order"
+      expect(page).to have_content("Your order has been processed successfully")
+    end
+
+    it "shows an error with a missing credit card number", js: true do
+      within_frame(find '#card_cvc iframe') { fill_in 'cvc', with: '123' }
+      within_frame(find '#card_expiry iframe') { fill_in 'exp-date', with: "0132" }
+      click_button "Save and Continue"
+      expect(page).to have_content("Your card number is incomplete.")
+    end
+
+    it "shows an error with a missing expiration date", js: true do
+      within_frame find('#card_number iframe') do
+        '4242 4242 4242 4242'.split('').each { |n| find_field('cardnumber').native.send_keys(n) }
+      end
+      within_frame(find '#card_cvc iframe') { fill_in 'cvc', with: '123' }
+      click_button "Save and Continue"
+      expect(page).to have_content("Your card's expiration date is incomplete.")
+    end
+
+    it "shows an error with an invalid credit card number", js: true do
+      within_frame find('#card_number iframe') do
+        '1111 1111 1111 1111'.split('').each { |n| find_field('cardnumber').native.send_keys(n) }
+      end
+      within_frame(find '#card_cvc iframe') { fill_in 'cvc', with: '123' }
+      within_frame(find '#card_expiry iframe') { fill_in 'exp-date', with: "0132" }
+      click_button "Save and Continue"
+      expect(page).to have_content("Your card number is invalid.")
+    end
+
+    it "shows an error with invalid security fields", js: true do
+      within_frame find('#card_number iframe') do
+        '4242 4242 4242 4242'.split('').each { |n| find_field('cardnumber').native.send_keys(n) }
+      end
+      within_frame(find '#card_cvc iframe') { fill_in 'cvc', with: '12' }
+      within_frame(find '#card_expiry iframe') { fill_in 'exp-date', with: "0132" }
+      click_button "Save and Continue"
+      expect(page).to have_content("Your card's security code is incomplete.")
+    end
+
+    it "shows an error with invalid expiry fields", js: true do
+      within_frame find('#card_number iframe') do
+        '4242 4242 4242 4242'.split('').each { |n| find_field('cardnumber').native.send_keys(n) }
+      end
+      within_frame(find '#card_cvc iframe') { fill_in 'cvc', with: '123' }
+      within_frame(find '#card_expiry iframe') { fill_in 'exp-date', with: "013" }
+      click_button "Save and Continue"
+      expect(page).to have_content("Your card's expiration date is incomplete.")
+    end
+  end
+end