solidus_paypal_commerce_platform 0.0.1

data/lib/solidus_paypal_commerce_platform/engine.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'deface'
+require 'spree/core'
+require 'solidus_paypal_commerce_platform'
+require 'solidus_webhooks'
+
+module SolidusPaypalCommercePlatform
+  class Engine < Rails::Engine
+    include SolidusSupport::EngineExtensions
+
+    isolate_namespace SolidusPaypalCommercePlatform
+
+    engine_name 'solidus_paypal_commerce_platform'
+
+    initializer "solidus_paypal_commerce_platform.add_payment_method", after: "spree.register.payment_methods" do |app|
+      app.config.spree.payment_methods << SolidusPaypalCommercePlatform::PaymentMethod
+      SolidusPaypalCommercePlatform::PaymentMethod.allowed_admin_form_preference_types << :paypal_select
+      Spree::PermittedAttributes.source_attributes.concat [:paypal_order_id, :authorization_id, :paypal_email]
+    end
+
+    initializer "solidus_paypal_commerce_platform.add_wizard", after: "spree.register.payment_methods" do |app|
+      # Adding the class set below - if this is ported to core, we can remove this line.
+      Spree::Core::Environment.add_class_set("payment_setup_wizards")
+      app.config.spree.payment_setup_wizards << "SolidusPaypalCommercePlatform::Wizard"
+    end
+
+    initializer "solidus_paypal_commerce_platform.set_pricing_options_class" do
+      def (Spree::Config).pricing_options_class
+        SolidusPaypalCommercePlatform::PricingOptions
+      end
+    end
+
+    initializer "solidus_paypal_commerce_platform.webhooks" do
+      SolidusWebhooks.config.register_webhook_handler :solidus_paypal_commerce_platform, ->(payload) {
+        SolidusPaypalCommercePlatform::WebhooksJob.perform_now(payload)
+      }
+    end
+
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+  end
+end

data/lib/solidus_paypal_commerce_platform/factories.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :paypal_payment_method, class: 'SolidusPaypalCommercePlatform::PaymentMethod' do
+    type { "SolidusPaypalCommercePlatform::PaymentMethod" }
+    name { "PayPal Payment Method" }
+    preferences {
+      {
+        client_id: SecureRandom.hex(8),
+        client_secret: SecureRandom.hex(10)
+      }
+    }
+  end
+end

data/lib/solidus_paypal_commerce_platform/fetch_merchant_credentials_request.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module SolidusPaypalCommercePlatform
+  # https://developer.paypal.com/docs/api/partner-referrals/v1/#merchant-integration_credentials
+  class FetchMerchantCredentialsRequest
+    attr_accessor :verb, :path, :headers, :body
+
+    def initialize(partner_merchant_id:, access_token:)
+      @verb = "GET"
+      @path = "/v1/customer/partners/#{partner_merchant_id}/merchant-integrations/credentials"
+      @headers = {
+        "Content-Type" => "application/json",
+        "Authorization" => "Bearer #{access_token}"
+      }
+    end
+  end
+end

data/lib/solidus_paypal_commerce_platform/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SolidusPaypalCommercePlatform
+  VERSION = '0.0.1'
+end

data/lib/views/api/spree/api/payments/source_views/_paypal_commerce_platform.json.jbuilder

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+json.call(payment_source, :id, :paypal_order_id, :created_at)

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

@@ -0,0 +1 @@
+<%= t('virtual_terminal_notice_html') %>

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

@@ -0,0 +1,18 @@
+<fieldset data-hook="credit_card">
+  <legend align="center"><%= SolidusPaypalCommercePlatform::PaymentMethod.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("paypal_capture_id") %>:</dt>
+        <dd><%= payment.source.capture_id %></dd>
+
+        <dt><%= I18n.t("paypal_email") %>:</dt>
+        <dd><%= payment.source.paypal_email %></dd>
+      </dl>
+    </div>
+  </div>
+</fieldset>

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

@@ -0,0 +1,13 @@
+<% label = local_assigns[:label].presence %>
+<% html_options = {class: 'custom-select fullwidth'}.update(local_assigns[:html_options] || {}) %>
+<% options = @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/frontend/solidus_paypal_commerce_platform/cart/_cart_buttons.html.erb

@@ -0,0 +1,3 @@
+<% Spree::PaymentMethod.available_to_users.select{ |payment_method| payment_method.try(:display_on_cart) }.each do |payment_method| %>
+  <%= render partial: "spree/orders/payment/#{payment_method.cart_partial_name}", locals: {payment_method: payment_method} %>
+<% end %>

data/lib/views/frontend/solidus_paypal_commerce_platform/payments/_payment.html.erb

@@ -0,0 +1,4 @@
+<% if payment.source.respond_to?(:paypal_email) %>
+  <br />
+  <%= t('payment_email', email: payment.source.paypal_email) %>
+<% end %>

data/lib/views/frontend/solidus_paypal_commerce_platform/product/_product_buttons.html.erb

@@ -0,0 +1,3 @@
+<% Spree::PaymentMethod.available_to_users.select{ |payment_method| payment_method.try(:display_on_product_page) }.each do |payment_method| %>
+  <%= render partial: "spree/products/payment/#{payment_method.product_page_partial_name}", locals: {payment_method: payment_method} %>
+<% end %>

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

@@ -0,0 +1,13 @@
+<script src="<%= payment_method.javascript_sdk_url(order: @order) %>"></script>
+
+<div id="paypal-button-container"></div>
+<input type="hidden" name="payment_source[<%= payment_method.id %>][paypal_order_id]" id="payments_source_paypal_order_id">
+<input type="hidden" name="payment_source[<%= payment_method.id %>][paypal_email]" id="payments_source_paypal_email">
+
+<script>
+  $( document ).ready(function() {
+    SolidusPaypalCommercePlatform.renderButton("<%= payment_method.id %>",<%= raw payment_method.button_style.to_json %>)
+  })
+</script>
+
+<div id="paypal_commerce_platform_overlay"></div>

data/lib/views/frontend/spree/orders/payment/_paypal_commerce_platform.html.erb

@@ -0,0 +1,17 @@
+<div style="margin-left:auto;margin-right:auto;width:50%;margin-top:20px;">
+  <script src="<%= payment_method.javascript_sdk_url(order: @order) %>">
+  </script>
+
+  <div id="paypal-button-container"></div>
+
+  <script>
+    Spree.current_order_id = "<%= @order.number %>"
+    Spree.current_order_token = "<%= @order.guest_token %>"
+    SolidusPaypalCommercePlatform.checkout_url = "<%= checkout_url %>"
+    $( document ).ready(function() {
+      SolidusPaypalCommercePlatform.renderCartButton("<%= payment_method.id %>",<%= raw payment_method.button_style.to_json %>)
+    })
+  </script>
+</div>
+
+<div id="paypal_commerce_platform_overlay"></div>

data/lib/views/frontend/spree/products/payment/_paypal_commerce_platform.html.erb

@@ -0,0 +1,15 @@
+<div style="margin-top:20px;">
+  <script src="<%= payment_method.javascript_sdk_url %>">
+  </script>
+
+  <div id="paypal-button-container"></div>
+
+  <script>
+    SolidusPaypalCommercePlatform.checkout_url = "<%= checkout_url %>"
+    $( document ).ready(function() {
+      SolidusPaypalCommercePlatform.renderProductButton("<%= payment_method.id %>",<%= raw payment_method.button_style.to_json %>)
+    })
+  </script>
+</div>
+
+<div id="paypal_commerce_platform_overlay"></div>

data/solidus_paypal_commerce_platform.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative 'lib/solidus_paypal_commerce_platform/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'solidus_paypal_commerce_platform'
+  spec.version = SolidusPaypalCommercePlatform::VERSION
+  spec.authors = ['Sean Denny', 'Elia Schito']
+  spec.email = 'contact@solidus.io'
+
+  spec.summary = 'Integrate Solidus with Paypal Commerce Platform'
+  spec.homepage = 'https://github.com/nebulab/solidus_paypal_commerce_platform#readme'
+  spec.license = 'BSD-3-Clause'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/nebulab/solidus_paypal_commerce_platform'
+  spec.metadata['changelog_uri'] = 'https://github.com/nebulab/solidus_paypal_commerce_platform/releases'
+
+  spec.required_ruby_version = Gem::Requirement.new('~> 2.5')
+
+  # 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 'deface', '~> 1.5'
+  spec.add_dependency 'solidus_core', ['>= 2.0.0', '< 3']
+  spec.add_dependency 'solidus_support', '~> 0.5'
+  spec.add_dependency 'solidus_webhooks', '~> 0.2.0'
+
+  spec.add_dependency 'paypal-checkout-sdk'
+
+  spec.add_development_dependency 'solidus_dev_support'
+end

data/spec/features/backend/new_payment_method_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+RSpec.describe "creating a new payment" do
+  stub_authorization!
+
+  it "displays PayPal Commerce Platform as an option" do
+    visit "/admin/payment_methods/new"
+    expect(page).to have_select('payment_method_type', options: [
+      "PayPal Commerce Platform",
+      "Bogus Credit Card Payments",
+      "Check Payments",
+      "Simple Bogus Credit Card Payments",
+      "Store Credit Payments",
+    ])
+    select "PayPal Commerce Platform", from: 'payment_method_type'
+    fill_in "Name", with: "PayPal!"
+    click_on "Create"
+    expect(page).to have_text("Payment Method has been successfully created!")
+
+    fill_in "Client", with: "cli-123"
+    fill_in "Client secret", with: "cli-sec-123"
+    click_on "Update"
+    expect(page).to have_text("Payment Method has been successfully updated!")
+  end
+
+  it "displays the onboarding button", :js do
+    visit "/admin/payment_methods"
+
+    # main_window = current_window
+
+    within ".setup-wizard" do
+      paypal_button = page.find("button")
+      expect(paypal_button.text).to eq("Setup PayPal Commerce Platform")
+      # TODO: make this more complete
+      # paypal_window = window_opened_by do
+      #   paypal_button.click
+      # end
+    end
+  end
+end

data/spec/features/frontend/cart_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+RSpec.describe "Cart page" do
+  describe "paypal payment method" do
+    let(:order) { Spree::TestingSupport::OrderWalkthrough.up_to(:address) }
+    let(:paypal_payment_method) { create(:paypal_payment_method) }
+
+    before do
+      user = create(:user)
+      order.user = user
+
+      paypal_payment_method
+      allow_any_instance_of(Spree::OrdersController).to receive_messages(
+        current_order: order,
+        try_spree_current_user: user
+      )
+    end
+
+    def paypal_script_options
+      script_tag_url = URI(page.find('script[src*="sdk/js?"]', visible: false)[:src])
+      script_tag_url.query.split('&')
+    end
+
+    it "generate a js file with the correct credentials and intent attached" do
+      visit '/cart'
+      expect(paypal_script_options).to include("client-id=#{paypal_payment_method.preferences[:client_id]}")
+    end
+
+    context "when auto-capture is set to true" do
+      it "generate a js file with intent capture" do
+        paypal_payment_method.update(auto_capture: true)
+        visit '/cart'
+        expect(paypal_script_options).to include("client-id=#{paypal_payment_method.preferences[:client_id]}")
+        expect(paypal_script_options).to include("intent=capture")
+      end
+    end
+  end
+end

data/spec/features/frontend/checkout_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+
+RSpec.describe "Checkout" do
+  describe "paypal payment method" do
+    let(:order) { Spree::TestingSupport::OrderWalkthrough.up_to(:payment) }
+    let(:paypal_payment_method) { create(:paypal_payment_method) }
+    let(:failed_response) { OpenStruct.new(status_code: 500) }
+
+    before do
+      user = create(:user)
+      order.user = user
+      order.recalculate
+
+      paypal_payment_method
+      allow_any_instance_of(Spree::CheckoutController).to receive_messages(
+        current_order: order, try_spree_current_user: user
+      )
+    end
+
+    def paypal_script_options
+      script_tag_url = URI(page.find('script[src*="sdk/js?"]', visible: false)[:src])
+      script_tag_url.query.split('&')
+    end
+
+    it "generates a js file with the correct credentials and intent attached" do
+      visit '/checkout/payment'
+      expect(paypal_script_options).to include("client-id=#{paypal_payment_method.preferences[:client_id]}")
+    end
+
+    context "when auto-capture is set to true" do
+      it "generates a js file with intent capture" do
+        paypal_payment_method.update(auto_capture: true)
+        visit '/checkout/payment'
+        expect(paypal_script_options).to include("client-id=#{paypal_payment_method.preferences[:client_id]}")
+        expect(paypal_script_options).to include("intent=capture")
+      end
+    end
+
+    context "when no payment has been made" do
+      it "fails to process" do
+        visit '/checkout/payment'
+        choose(option: paypal_payment_method.id)
+        click_button("Save and Continue")
+        expect(page).to have_content("Payments source PayPal order can't be blank")
+      end
+    end
+
+    context "when a payment has been made" do
+      it "proceeds to the next step" do
+        visit '/checkout/payment'
+        choose(option: paypal_payment_method.id)
+        find(:xpath, "//input[@id='payments_source_paypal_order_id']", visible: false).set SecureRandom.hex(8)
+        click_button("Save and Continue")
+        expect(page).to have_css(".current", text: "Confirm")
+      end
+
+      it "records the paypal email address" do
+        visit '/checkout/payment'
+        choose(option: paypal_payment_method.id)
+        find(:xpath, "//input[@id='payments_source_paypal_order_id']", visible: false).set SecureRandom.hex(8)
+        find(:xpath, "//input[@id='payments_source_paypal_email']", visible: false).set "fake@email.com"
+        click_button("Save and Continue")
+        expect(Spree::Payment.last.source.paypal_email).to eq "fake@email.com"
+      end
+    end
+
+    context "when a payment fails" do
+      before { allow_any_instance_of(PayPal::PayPalHttpClient).to receive(:execute) { failed_response } }
+
+      it "redirects the user back to the payments page" do
+        visit '/checkout/payment'
+        choose(option: paypal_payment_method.id)
+        find(:xpath, "//input[@id='payments_source_paypal_order_id']", visible: false).set SecureRandom.hex(8)
+        click_button("Save and Continue")
+        click_button("Place Order")
+        expect(page).to have_current_path("/checkout/payment")
+        expect(page).to have_content("Your payment was declined")
+      end
+    end
+  end
+end

data/spec/features/frontend/product_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+
+RSpec.describe "Product page", js: true do
+  describe "paypal button" do
+    let(:paypal_payment_method) { create(:paypal_payment_method) }
+    let(:product) { create(:product, variants: [variant, variant_two]) }
+    let(:store) { create(:store) }
+    let(:variant) { create(:variant) }
+    let(:variant_two) { create(:variant) }
+
+    before do
+      paypal_payment_method
+    end
+
+    def paypal_script_options
+      script_tag_url = URI(page.find('script[src*="sdk/js?"]', visible: false)[:src])
+      script_tag_url.query.split('&')
+    end
+
+    it "generates a js file with the correct credentials and intent attached" do
+      visit '/products/' + product.slug
+      expect(paypal_script_options).to include("client-id=#{paypal_payment_method.preferences[:client_id]}")
+    end
+
+    context "when auto-capture is set to true" do
+      it "generates a js file with intent capture" do
+        paypal_payment_method.update(auto_capture: true)
+        visit '/products/' + product.slug
+        expect(paypal_script_options).to include("client-id=#{paypal_payment_method.preferences[:client_id]}")
+        expect(paypal_script_options).to include("intent=capture")
+      end
+    end
+
+    describe "order creation" do
+      before do
+        allow_any_instance_of(Spree::Core::ControllerHelpers::Store).to receive(:current_store) { store }
+        visit '/products/' + product.slug
+
+        # Stubbing out paypal methods since their JS doesn't load in correctly on tests
+        page.execute_script("paypal = {}")
+        page.execute_script("paypal.render = function(){}")
+        page.execute_script("paypal.Buttons = function(){return paypal}")
+
+        # Waiting until the paypal button becomes available, because the SPCP namespace
+        # isn't immediately available
+        page.find("#paypal-button-container")
+      end
+
+      it "creates an order successfully" do
+        page.evaluate_script("SolidusPaypalCommercePlatform.createOrder()")
+
+        expect(Spree::Order.last).not_to be nil
+      end
+
+      it "sets the Spree number and token variables" do
+        page.evaluate_script("SolidusPaypalCommercePlatform.createOrder()")
+
+        expect(page.evaluate_script("Spree.current_order_id")).to eq Spree::Order.last.number
+        expect(page.evaluate_script("Spree.current_order_token")).to eq Spree::Order.last.guest_token
+      end
+
+      it "uses the specified quantity" do
+        quantity = 12
+        fill_in('quantity', with: quantity)
+
+        page.evaluate_script("SolidusPaypalCommercePlatform.createOrder()")
+
+        expect(Spree::Order.last.line_items.first.quantity).to eq quantity
+      end
+
+      it "uses the selected variant" do
+        page.choose("variant_id_#{variant_two.id}")
+        page.evaluate_script("SolidusPaypalCommercePlatform.createOrder()")
+
+        expect(Spree::Order.last.line_items.first.variant_id).to eq variant_two.id
+      end
+    end
+  end
+end