solidus_braintree 1.2.0 → 3.0.0

data/lib/solidus_braintree/engine.rb

@@ -1,24 +1,74 @@
+# frozen_string_literal: true
+
+require 'solidus_core'
+require 'solidus_support'
+
 module SolidusBraintree
   class Engine < Rails::Engine
+    include SolidusSupport::EngineExtensions
+
+    isolate_namespace SolidusBraintree
     engine_name 'solidus_braintree'
 
-    config.autoload_paths += %W(#{config.root}/lib)
-    config.assets.precompile += %w( spree/backend/braintree/solidus_braintree.js )
+    ActiveSupport::Inflector.inflections do |inflect|
+      inflect.acronym 'AVS'
+    end
+
+    initializer "register_solidus_braintree_gateway", after: "spree.register.payment_methods" do |app|
+      config.to_prepare do
+        app.config.spree.payment_methods << SolidusBraintree::Gateway
+        SolidusBraintree::Gateway.allowed_admin_form_preference_types.push(:preference_select).uniq!
 
-    initializer "spree.gateway.payment_methods", after: "spree.register.payment_methods" do |app|
-      app.config.spree.payment_methods << Solidus::Gateway::BraintreeGateway
+        ::Spree::PermittedAttributes.source_attributes.concat(
+          [:nonce, :payment_type, :paypal_funding_source, :device_data]
+        ).uniq!
+      end
     end
 
-    def self.activate
-      Rails.application.config.assets.precompile += [
-        'lib/assets/javascripts/spree/backend/solidus_braintree.js',
-      ]
+    initializer 'add_solidus_braintree_response_to_log_entry_permitted_classes' do
+      Spree.config do |config|
+        config.log_entry_permitted_classes << 'SolidusBraintree::Response'
+      end
+    end
 
-      Dir.glob(File.join(File.dirname(__FILE__), "../../app/**/*_decorator*.rb")) do |c|
-        Rails.configuration.cache_classes ? require(c) : load(c)
+    config.assets.precompile += [
+      'spree/frontend/solidus_braintree/checkout.js',
+      'solidus_braintree_manifest.js'
+    ]
+    paths["app/controllers"] << "lib/controllers/frontend"
+    paths["app/views"] << "lib/views/frontend"
+
+    if SolidusSupport.backend_available?
+      config.assets.precompile += ["spree/backend/solidus_braintree.js"]
+      paths["app/controllers"] << "lib/controllers/backend"
+
+      # We support Solidus v1.2, which requires some different markup in the
+      # source form partial. This will take precedence over lib/views/backend.
+      paths["app/views"] << "lib/views/backend_v1.2" if Spree.solidus_gem_version < Gem::Version.new('1.3')
+
+      # Solidus v2.4 introduced preference field partials but does not ship a hash field type.
+      # This is solved in Solidus v2.5.
+      if Spree.solidus_gem_version <= Gem::Version.new('2.5.0')
+        paths["app/views"] << "lib/views/backend_v2.4"
+      end
+
+      paths["app/views"] << "lib/views/backend"
+
+      initializer "solidus_braintree_admin_menu_item", after: "register_solidus_braintree_gateway" do
+        Spree::Backend::Config.configure do |config|
+          config.menu_items << config.class::MenuItem.new(
+            [:braintree],
+            'cc-paypal',
+            url: '/solidus_braintree/configurations/list',
+            condition: -> { can?(:list, SolidusBraintree::Configuration) }
+          )
+        end
       end
     end
 
-    config.to_prepare &method(:activate).to_proc
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    end
   end
 end

data/lib/solidus_braintree/extension_configuration.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module SolidusBraintree
+  # Deviating from the usual `Configuration` name proposed by
+  # `solidus_dev_support` because it's already taken by a model.
+  class ExtensionConfiguration
+    # Define here the settings for this extension, e.g.:
+    #
+    # attr_accessor :my_setting
+  end
+
+  class << self
+    def configuration
+      @configuration ||= ExtensionConfiguration.new
+    end
+
+    alias config configuration
+
+    def configure
+      yield configuration
+    end
+  end
+end

data/lib/solidus_braintree/request_protection.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'active_merchant/network_connection_retries'
+
+module SolidusBraintree
+  module RequestProtection
+    include ActiveMerchant::NetworkConnectionRetries
+
+    def protected_request(&block)
+      raise ArgumentError unless block_given?
+
+      options = {
+        connection_exceptions: {
+          Braintree::BraintreeError => 'Error while connecting to Braintree gateway'
+        },
+        logger: Rails.logger
+      }
+      retry_exceptions(options, &block)
+    end
+  end
+end

data/lib/solidus_braintree/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SolidusBraintree
-  VERSION = "1.2.0"
+  VERSION = '3.0.0'
 end

data/lib/solidus_braintree.rb

@@ -1,4 +1,16 @@
-require "solidus_core"
+# frozen_string_literal: true
+
+require 'solidus_core'
 require 'solidus_support'
-require "solidus_braintree/version"
+
+require 'solidus_braintree/country_mapper'
+require 'solidus_braintree/request_protection'
+require 'solidus_braintree/extension_configuration'
+require 'solidus_braintree/version'
 require 'solidus_braintree/engine'
+
+module SolidusBraintree
+  def self.table_name_prefix
+    'solidus_paypal_braintree_'
+  end
+end

data/lib/solidus_paypal_braintree.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require 'solidus_braintree'
+
+SolidusPaypalBraintree =
+  ActiveSupport::Deprecation::DeprecatedConstantProxy.new('SolidusPaypalBraintree', 'SolidusBraintree')

data/lib/views/backend/solidus_braintree/configurations/list.html.erb

@@ -0,0 +1,63 @@
+<% content_for :page_title do %>
+  <%= t(:title, scope: 'solidus_braintree.configurations') %>
+<% end %>
+
+<%= form_for :configurations, url: solidus_braintree.configurations_path do |f| %>
+  <% @configurations.each do |config| %>
+    <div class="row">
+      <fieldset>
+        <legend><%= config.store.name %></legend>
+
+        <%= f.fields_for 'configuration_fields[]', config do |c| %>
+          <div class="field">
+            <%= c.check_box :paypal %>
+            <%= c.label :paypal do %>
+              <%= tag.i class: 'fa fa-paypal' %>
+              <%= c.object.class.human_attribute_name(:paypal) %>
+            <% end %>
+          </div>
+
+          <div class="field">
+            <%= c.check_box :apple_pay %>
+            <%= c.label :apple_pay do %>
+              <%= tag.i class: 'fa fa-apple' %>
+              <%= c.object.class.human_attribute_name(:apple_pay) %>
+            <% end %>
+          </div>
+
+          <div class="field">
+            <%= c.check_box :venmo %>
+            <%= c.label :venmo do %>
+              <%= tag.i class: 'fa fa-mobile' %>
+              <%= c.object.class.human_attribute_name(:venmo) %>
+            <% end %>
+          </div>
+
+          <div class="field">
+            <%= c.check_box :credit_card %>
+            <%= c.label :credit_card do %>
+              <%= tag.i class: 'fa fa-credit-card' %>
+              <%= c.object.class.human_attribute_name(:credit_card) %>
+            <% end %>
+            +
+            <%= c.check_box :three_d_secure %>
+            <%= c.label :three_d_secure do %>
+              <%= tag.i class: 'fa fa-shield' %>
+              <%= c.object.class.human_attribute_name(:three_d_secure) %>
+            <% end %>
+          </div>
+
+          <% config.admin_form_preference_names.each do |name| %>
+            <%= render "spree/admin/shared/preference_fields/#{config.preference_type(name)}",
+                       form: c, attribute: "preferred_#{name}",
+                       label: t(name, scope: 'spree', default: name.to_s.humanize) %>
+          <% end %>
+        <% end %>
+      </fieldset>
+    </div>
+  <% end %>
+
+  <div class="form-buttons filter-actions actions">
+    <%= submit_tag "Update", class: 'btn btn-primary' %>
+  </div>
+<% end %>

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

@@ -0,0 +1,16 @@
+<% id = payment_method.id %>
+
+<fieldset class="no-border-bottom braintree-hosted-fields" data-braintree-hosted-fields data-id="<%= id %>" data-payment-method-id="<%= id %>">
+  <div class="field" data-hook="previous_cards">
+    <% if previous_cards.any? %>
+      <% previous_cards.each do |card| %>
+        <label><%= radio_button_tag :card, card.id, card == previous_cards.first %> <%= card.display_number %><br /></label>
+      <% end %>
+      <label><%= radio_button_tag :card, "new", false, { id: "card_new#{id}" } %> <%= I18n.t("spree.use_new_cc") %></label>
+    <% end %>
+  </div>
+
+  <div id="card_form<%= id %>" data-hook style="display: none;">
+    <%= render partial: "spree/shared/braintree_hosted_fields", locals: { payment_method: payment_method } %>
+  </div>
+</fieldset>

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

@@ -0,0 +1,39 @@
+<fieldset data-hook="credit_card">
+  <legend align="center"><%= SolidusBraintree::Gateway.model_name.human %></legend>
+
+  <div class="row">
+    <div class="alpha six columns">
+      <dl>
+        <dt><%= I18n.t("spree.identifier") %>:</dt>
+        <dd><%= payment.number %></dd>
+
+        <dt><%= I18n.t("spree.response_code") %>:</dt>
+        <dd><%= braintree_transaction_link(payment) %></dd>
+
+        <% if payment.source.token.present? %>
+          <dt><%= t('solidus_braintree.token') %>:</dt>
+          <dd><%= payment.source.token %></dd>
+        <% else %>
+          <dt><%= t('solidus_braintree.nonce') %>:</dt>
+          <dd><%= payment.source.nonce %></dd>
+        <% end %>
+
+        <dt><%= t('solidus_braintree.payment_type.label') %>:</dt>
+        <dd><%= payment.source.friendly_payment_type %></dd>
+
+        <% if payment.source.credit_card? %>
+          <dt><%= Spree::CreditCard.human_attribute_name(:card_type) %>:</dt>
+          <dd><%= payment.source.card_type %></dd>
+
+          <dt><%= Spree::CreditCard.human_attribute_name(:last_digits) %>:</dt>
+          <dd><%= payment.source.last_digits %></dd>
+        <% end %>
+
+        <% if payment.source.paypal? %>
+          <dt><%= I18n.t('spree.paypal_funding_source') %>:</dt>
+          <dd><%= payment.source.display_paypal_funding_source %></dd>
+        <% end %>
+      </dl>
+    </div>
+  </div>
+</fieldset>

data/lib/views/backend/spree/admin/shared/preference_fields/_preference_select.html.erb

@@ -0,0 +1,13 @@
+<% label = local_assigns[:label].presence %>
+<% html_options = {class: 'custom-select fullwidth'}.update(local_assigns[:html_options] || {}) %>
+<% options = form.object.send("#{attribute}_options") %>
+
+<div class="field">
+  <% if local_assigns[:form] %>
+    <%= form.label attribute, label %>
+    <%= form.select attribute, options, {}, html_options %>
+  <% else %>
+    <%= label_tag name, label %>
+    <%= select_tag name, value, html_options %>
+  <% end %>
+</div>

data/lib/views/backend_v1.2/spree/admin/payments/source_forms/_braintree.html.erb

@@ -0,0 +1,16 @@
+<% id = payment_method.id %>
+
+<fieldset class="no-border-bottom braintree-hosted-fields" data-braintree-hosted-fields data-id="braintree" data-payment-method-id="<%= id %>">
+  <div class="field" data-hook="previous_cards">
+    <% if previous_cards.any? %>
+      <% previous_cards.each do |card| %>
+        <label><%= radio_button_tag :card, card.id, card == previous_cards.first %> <%= card.display_number %><br /></label>
+      <% end %>
+      <label><%= radio_button_tag :card, "new", false, { id: "card_new#{id}" } %> <%= I18n.t("spree.use_new_cc") %></label>
+    <% end %>
+  </div>
+
+  <div id="card_form<%= id %>" data-hook style="display: none;">
+    <%= render partial: "spree/shared/braintree_hosted_fields", locals: { payment_method: payment_method } %>
+  </div>
+</fieldset>

data/lib/views/backend_v2.4/spree/admin/shared/preference_fields/_hash.html.erb

@@ -0,0 +1,12 @@
+<% label = local_assigns[:label].presence %>
+<% html_options = {class: 'input_hash fullwidth'}.update(local_assigns[:html_options] || {}) %>
+
+<div class="field">
+  <% if local_assigns[:form] %>
+    <%= form.label attribute, label %>
+    <%= form.text_area attribute, html_options %>
+  <% else %>
+    <%= label_tag name, label %>
+    <%= text_area_tag name, value, html_options %>
+  <% end %>
+</div>

data/solidus_braintree.gemspec

@@ -1,43 +1,42 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'solidus_braintree/version'
+# frozen_string_literal: true
+
+require_relative 'lib/solidus_braintree/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "solidus_braintree"
-  spec.version       = SolidusBraintree::VERSION
-  spec.authors       = ["Solidus Team"]
-  spec.email         = ["contact@solidus.io"]
-
-  spec.summary       = %q{Adds Solidus support for Braintree v.zero Gateway.}
-  spec.description   = %q{Adds Solidus support for Braintree v.zero Gateway.}
-  spec.homepage      = "https://solidus.io"
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.name = 'solidus_braintree'
+  spec.version = SolidusBraintree::VERSION
+  spec.authors = ['Stembolt']
+  spec.email = 'braintree+gemfile@stembolt.com'
+
+  spec.summary = 'Officially supported Braintree extension'
+  spec.description = 'Uses the javascript API for seamless braintree payments'
+  spec.homepage = 'https://github.com/solidusio/solidus_braintree'
+  spec.license = 'BSD-3-Clause'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/solidusio/solidus_braintree'
+  spec.metadata['changelog_uri'] = 'https://github.com/solidusio/solidus_braintree/blob/master/CHANGELOG.md'
+
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.7', '< 4')
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  files = Dir.chdir(__dir__) { `git ls-files -z`.split("\x0") }
+
+  spec.files = files.grep_v(%r{^(test|spec|features)/})
+  spec.test_files = files.grep(%r{^(test|spec|features)/})
+  spec.bindir = "exe"
+  spec.executables = files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "solidus_api", [">= 1.0.0", "< 3"]
-  spec.add_dependency "solidus_core", [">= 1.0.0", "< 3"]
-  spec.add_dependency "solidus_support"
-  spec.add_dependency "braintree", "~> 2.46"
-
-  spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency 'factory_bot', '~> 4.4'
-  spec.add_development_dependency 'rspec-rails'
-  spec.add_development_dependency 'capybara', '~> 2.18'
-  spec.add_development_dependency 'capybara-screenshot'
-  spec.add_development_dependency 'poltergeist', '~> 1.9'
-  spec.add_development_dependency 'ffaker'
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "pry"
-  spec.add_development_dependency "byebug"
-  spec.add_development_dependency 'sqlite3'
-  spec.add_development_dependency 'database_cleaner', '~> 1.2'
-  spec.add_development_dependency "vcr", '~> 3.0'
-  spec.add_development_dependency "webmock"
-  spec.add_development_dependency 'simplecov'
+  spec.add_dependency 'activemerchant', '~> 1.48'
+  spec.add_dependency 'braintree', '~> 3.4'
+  spec.add_dependency 'solidus_api', ['>= 3.4.0.dev', '< 4']
+  spec.add_dependency 'solidus_core', ['>= 3.4.0.dev', '< 4']
+  spec.add_dependency 'solidus_support', ['>= 0.8.1', '< 1']
+
+  spec.add_development_dependency 'rails-controller-testing'
+  spec.add_development_dependency 'solidus_dev_support', '~> 2.5'
+
+  spec.post_install_message = "If you're upgrading to v2.0.0, please see the README for upgrade instructions."
 end

data/spec/controllers/solidus_braintree/checkouts_controller_spec.rb

@@ -0,0 +1,99 @@
+require 'solidus_braintree_helper'
+require 'support/solidus_braintree/order_ready_for_payment'
+
+RSpec.describe SolidusBraintree::CheckoutsController, type: :controller do
+  routes { SolidusBraintree::Engine.routes }
+
+  include_context 'when order is ready for payment'
+
+  describe 'PATCH update' do
+    subject(:patch_update) { patch :update, params: params }
+
+    let(:params) do
+      {
+        "state" => "payment",
+        "order" => {
+          "payments_attributes" => [
+            {
+              "payment_method_id" => payment_method.id,
+              "source_attributes" => {
+                "nonce" => "fake-paypal-billing-agreement-nonce",
+                "payment_type" => SolidusBraintree::Source::PAYPAL
+              }
+            }
+          ],
+          "use_billing" => "1",
+          "use_postmates_shipping" => "0"
+        },
+        "reuse_credit" => "1",
+        "order_bill_address" => "",
+        "reuse_bill_address" => "1"
+      }
+    end
+
+    let!(:payment_method) do
+      create_gateway
+    end
+
+    before do
+      allow(controller).to receive(:try_spree_current_user) { user }
+      allow(controller).to receive(:spree_current_user) { user }
+      allow(controller).to receive(:current_order) { order }
+    end
+
+    context "when a payment is created successfully", vcr: {
+      cassette_name: 'checkout/update',
+      match_requests_on: [:braintree_uri]
+    } do
+      it 'creates a payment' do
+        expect { patch_update }.
+          to change { order.payments.count }.
+          from(0).
+          to(1)
+      end
+
+      it 'creates a payment source' do
+        expect { patch_update }.
+          to change(SolidusBraintree::Source, :count).
+          from(0).
+          to(1)
+      end
+
+      it 'assigns @order' do
+        patch_update
+        expect(assigns(:order)).to eq order
+      end
+
+      it "is successful" do
+        expect(patch_update).to be_successful
+      end
+
+      it "renders 'ok'" do
+        expect(patch_update.body).to eql("ok")
+      end
+    end
+
+    context "when a payment is not created successfully" do
+      before do
+        allow_any_instance_of(::Spree::Payment).to receive(:save).and_return(false)
+      end
+
+      # No idea why this is the case, but I'm just adding the tests here
+      it "is successful" do
+        expect(patch_update).to be_successful
+      end
+
+      it "renders 'not-ok'" do
+        expect(patch_update.body).to eq('not-ok')
+      end
+
+      it "does not change the number of payments in the system" do
+        expect{ patch_update }.not_to(change(::Spree::Payment, :count))
+      end
+
+      it "does not change the number of sources in the system" do
+        expect{ patch_update }.not_to(change(SolidusBraintree::Source, :count))
+      end
+    end
+  end
+end

data/spec/controllers/solidus_braintree/client_tokens_controller_spec.rb

@@ -0,0 +1,55 @@
+require 'solidus_braintree_helper'
+
+RSpec.describe SolidusBraintree::ClientTokensController do
+  routes { SolidusBraintree::Engine.routes }
+
+  cassette_options = { cassette_name: "braintree/token" }
+  describe "POST create", vcr: cassette_options do
+    let!(:gateway) { create_gateway }
+    let(:user) { create(:user) }
+    let(:json) { JSON.parse(response.body) }
+
+    before { user.generate_spree_api_key! }
+
+    context 'without a payment method id' do
+      subject(:response) do
+        post :create, params: { token: user.spree_api_key }
+      end
+
+      it "returns a client token", aggregate_failures: true do
+        expect(response).to have_http_status(:success)
+        expect(response.content_type).to include 'application/json'
+        expect(json["client_token"]).to be_present
+        expect(json["client_token"]).to be_a String
+        expect(json["payment_method_id"]).to eq gateway.id
+      end
+
+      context "when there's two gateway's for different stores" do
+        let!(:store1) { create(:store, code: 'store_1') }
+        let!(:store2) { create(:store, code: 'store_2') }
+        let!(:gateway_for_store1) { create_gateway.tap{ |gw| store1.payment_methods << gw } }
+        let!(:gateway_for_store2) { create_gateway.tap{ |gw| store2.payment_methods << gw } }
+
+        it "returns the correct gateway for store1" do
+          allow_any_instance_of(described_class).to receive(:current_store).and_return store1
+          expect(json["payment_method_id"]).to eq gateway_for_store1.id
+        end
+
+        it "returns the correct gateway for store2" do
+          allow_any_instance_of(described_class).to receive(:current_store).and_return store2
+          expect(json["payment_method_id"]).to eq gateway_for_store2.id
+        end
+      end
+    end
+
+    context 'with a payment method id' do
+      subject(:response) do
+        post :create, params: { token: user.spree_api_key, payment_method_id: gateway.id }
+      end
+
+      it 'uses the selected gateway' do
+        expect(json["payment_method_id"]).to eq gateway.id
+      end
+    end
+  end
+end

data/spec/controllers/solidus_braintree/configurations_controller_spec.rb

@@ -0,0 +1,73 @@
+require 'solidus_braintree_helper'
+
+RSpec.describe SolidusBraintree::ConfigurationsController, type: :controller do
+  routes { SolidusBraintree::Engine.routes }
+
+  let!(:store_1) { create :store }
+  let!(:store_2) { create :store }
+
+  stub_authorization!
+
+  describe "GET #list" do
+    subject { get :list }
+
+    it "assigns all store's configurations as @configurations" do
+      subject
+      expect(assigns(:configurations)).
+        to eq [store_1.braintree_configuration, store_2.braintree_configuration]
+    end
+
+    it "renders the correct view" do
+      expect(subject).to render_template :list
+    end
+  end
+
+  describe "POST #update" do
+    subject { post :update, params: configurations_params }
+
+    let(:paypal_button_color) { 'blue' }
+    let(:configurations_params) do
+      {
+        configurations: {
+          configuration_fields: {
+            store_1.braintree_configuration.id.to_s => { paypal: true, apple_pay: true },
+            store_2.braintree_configuration.id.to_s => {
+              paypal: true,
+              apple_pay: false,
+              preferred_paypal_button_color: paypal_button_color
+            }
+          }
+        }
+      }
+    end
+
+    context "with valid parameters" do
+      it "updates the configuration" do
+        expect { subject }.to change { store_1.braintree_configuration.reload.paypal }.
+          from(false).to(true)
+      end
+
+      it "displays a success message to the user" do
+        subject
+        expect(flash[:success]).to eq "Successfully updated Braintree configurations."
+      end
+
+      it "displays all configurations" do
+        expect(subject).to redirect_to action: :list
+      end
+    end
+
+    context "with invalid parameters" do
+      let(:paypal_button_color) { 'invalid-color' }
+
+      it "displays an error message to the user" do
+        subject
+        expect(flash[:error]).to eq "An error occurred while updating Braintree configurations."
+      end
+
+      it "returns the user to the edit page" do
+        expect(subject).to redirect_to action: :list
+      end
+    end
+  end
+end