pay 1.0.2 → 2.0.0

data/app/views/pay/payments/show.html.erb

@@ -0,0 +1,134 @@
+<div id="app" class="h-full md:flex md:justify-center md:items-center">
+  <div class="w-full max-w-lg">
+    <!-- Status Messages -->
+    <p class="flex items-center mb-4 bg-red-100 border border-red-200 px-5 py-2 rounded-lg text-red-500" v-if="errorMessage">
+      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" class="flex-shrink-0 w-6 h-6">
+        <path class="fill-current text-red-300" d="M12 2a10 10 0 1 1 0 20 10 10 0 0 1 0-20z"/>
+        <path class="fill-current text-red-500" d="M12 18a1.5 1.5 0 1 1 0-3 1.5 1.5 0 0 1 0 3zm1-5.9c-.13 1.2-1.88 1.2-2 0l-.5-5a1 1 0 0 1 1-1.1h1a1 1 0 0 1 1 1.1l-.5 5z"/>
+      </svg>
+
+      <span class="ml-3">{{ errorMessage }}</span>
+    </p>
+
+    <p class="flex items-center mb-4 bg-green-100 border border-green-200 px-5 py-4 rounded-lg text-green-700" v-if="paymentProcessed && successMessage">
+      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" class="flex-shrink-0 w-6 h-6">
+        <circle cx="12" cy="12" r="10" class="fill-current text-green-300"/>
+        <path class="fill-current text-green-500" d="M10 14.59l6.3-6.3a1 1 0 0 1 1.4 1.42l-7 7a1 1 0 0 1-1.4 0l-3-3a1 1 0 0 1 1.4-1.42l2.3 2.3z"/>
+      </svg>
+
+      <span class="ml-3">{{ successMessage }}</span>
+    </p>
+
+    <div class="bg-white rounded-lg shadow-xl p-4 sm:py-6 sm:px-10 mb-5">
+      <% if @payment.succeeded? %>
+        <h1 class="text-xl mt-2 mb-4 text-gray-700"><%=t "successful.header" %></h1>
+        <p class="mb-6"><%=t "successful.description" %></p>
+
+      <% elsif @payment.canceled? %>
+        <h1 class="text-xl mt-2 mb-4 text-gray-700"><%=t "cancelled.header" %></h1>
+        <p class="mb-6"><%=t "cancelled.description" %></p>
+
+      <% else %>
+        <div id="payment-elements" v-if="! paymentProcessed">
+          <!-- Instructions -->
+          <h1 class="text-xl mt-2 mb-4 text-gray-700"><%=t "requires_action.header", amount: number_to_currency(@payment.amount / 100.0) %></h1>
+          <p class="mb-6"><%=t "requires_action.description" %></p>
+
+          <div v-show="status == 'requires_payment_method'">
+            <!-- Name -->
+            <label for="cardholder-name" class="inline-block text-sm text-gray-700 font-semibold mb-2"><%=t "requires_action.full_name" %></label>
+            <input id="cardholder-name" type="text" placeholder="Jane Doe" required class="inline-block text-black bg-gray-200 border border-gray-400 rounded-lg w-full px-4 py-3 mb-3 focus:outline-none" v-model="name">
+
+            <!-- Card -->
+            <label for="card-element" class="inline-block text-sm text-gray-700 font-semibold mb-2"><%=t "requires_action.card" %></label>
+            <div id="card-element" class="bg-gray-200 border border-gray-400 rounded-lg p-4 mb-6"></div>
+          </div>
+
+          <!-- Pay Button -->
+          <button id="card-button" class="inline-block w-full px-4 py-3 mb-4 text-white rounded-lg bg-blue-400 hover:bg-blue-500" :class="{ 'bg-blue-400': paymentProcessing, 'bg-blue-600': ! paymentProcessing }" @click="confirmPayment" :disabled="paymentProcessing">
+            <%=t "requires_action.button", amount: number_to_currency(@payment.amount / 100.0) %>
+          </button>
+        </div>
+      <% end %>
+
+      <%= link_to t("back"), root_path, class: "inline-block w-full px-4 py-3 bg-gray-200 hover:bg-gray-300 text-center text-gray-700 rounded-lg" %>
+    </div>
+
+    <p class="text-center text-gray-500 text-sm">
+      © <%= Date.current.year %> <%= Pay.business_name %> <%=t "all_rights_reserved" %>
+    </p>
+  </div>
+</div>
+
+<script>
+  window.stripe = Stripe('<%= Pay::Stripe.public_key %>');
+  var app = new Vue({
+    el: '#app',
+    data: {
+      clientSecret: '<%= @payment.client_secret %>',
+      status: '<%= @payment.status %>',
+      name: '',
+      cardElement: null,
+      paymentProcessing: false,
+      paymentProcessed: false,
+      successMessage: '',
+      errorMessage: ''
+    },
+
+    mounted: function () {
+      if (this.status == "succeeded" || this.status == "canceled") {
+        return
+      }
+
+      // We can trigger SCA immediately if this payment requires action
+      // This makes sure a new SCA subscription doesn't have to put in their card twice
+      if (this.status == "requires_action") {
+        this.paymentProcessing = true
+        this.paymentProcessed = false
+        stripe.confirmCardPayment(this.clientSecret).then(this.handleConfirmResult.bind(this))
+      }
+
+      // Setup elements in case the authentication fails and user needs to put in a new card
+      const elements = stripe.elements();
+      this.cardElement = elements.create('card');
+      this.cardElement.mount('#card-element');
+    },
+
+    methods: {
+      confirmPayment: function () {
+        this.paymentProcessing = true
+        this.paymentProcessed = false
+        this.successMessage = ''
+        this.errorMessage = ''
+
+        stripe.confirmCardPayment(
+          this.clientSecret,
+          {
+            payment_method: {
+              card: this.cardElement,
+              billing_details: { name: this.name }
+            },
+            save_payment_method: true,
+            setup_future_usage: 'off_session',
+          }
+        ).then(this.handleConfirmResult.bind(this))
+      },
+
+      handleConfirmResult(result) {
+        this.paymentProcessing = false;
+        if (result.error) {
+          if (result.error.code === 'parameter_invalid_empty' &&
+            result.error.param === 'payment_method_data[billing_details][name]') {
+            this.errorMessage = '<%=t "requires_action.name_missing" %>'
+          } else {
+            this.errorMessage = result.error.message
+            this.status = result.error.payment_intent.status
+          }
+        } else {
+          this.paymentProcessed = true;
+          this.successMessage = '<%=t "requires_action.success" %>'
+        }
+      }
+    },
+  })
+</script>

data/app/views/pay/user_mailer/payment_action_required.html.erb

@@ -0,0 +1,6 @@
+<h3>Extra confirmation is needed to process your payment</h3>
+<p>Your <%= Pay.business_name %> subscription requires confirmation to process your payment to continue access.</p>
+
+<p>You may confirm your payment via your account. If you have any questions, please hit reply and let us know.</p>
+
+<p>- The <%= Pay.business_name %> Team</p>

data/config/locales/en.yml

@@ -0,0 +1,17 @@
+en:
+  successful:
+    header: Payment Successful
+    description: This payment was already successfully confirmed.
+  cancelled:
+    header: Payment Cancelled
+    description: This payment was cancelled.
+  requires_action:
+    header: Confirm your %{amount} payment
+    description: Extra confirmation is needed to process your payment. Please confirm your payment by filling out your payment details below.
+    full_name: Full name
+    card: Card
+    button: Pay %{amount}
+    name_missing: Please provide your name.
+    success: The payment was successful.
+  all_rights_reserved: All rights reserved.
+  back: Go back

data/config/routes.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 Pay::Engine.routes.draw do
-  post 'stripe',    to: 'stripe_event/webhook#event'
-  post 'braintree', to: 'pay/webhooks/braintree#create'
+  resources :payments, only: [:show], module: :pay
+  post "webhooks/stripe", to: "stripe_event/webhook#event"
+  post "webhooks/braintree", to: "pay/webhooks/braintree#create"
 end

data/db/migrate/20190816015720_add_status_to_subscriptions.rb

@@ -0,0 +1,14 @@
+class AddStatusToSubscriptions < ActiveRecord::Migration[5.2]
+  def self.up
+    add_column :pay_subscriptions, :status, :string
+
+    # Any existing subscriptions should be marked as 'active'
+    # This won't actually make them active if their ends_at column is expired
+    Pay::Subscription.reset_column_information
+    Pay::Subscription.update_all(status: :active)
+  end
+
+  def self.down
+    remove_column :pay_subscriptions, :status
+  end
+end

data/lib/generators/pay/email_views_generator.rb

@@ -1,4 +1,4 @@
-require 'rails/generators'
+require "rails/generators"
 
 module Pay
   module Generators
@@ -6,8 +6,8 @@ module Pay
       source_root File.expand_path("../../../..", __FILE__)
 
       def copy_views
-        directory 'app/views/pay/user_mailer', 'app/views/pay/user_mailer'
+        directory "app/views/pay/user_mailer", "app/views/pay/user_mailer"
       end
     end
   end
-end
+end

data/lib/generators/pay/views_generator.rb

@@ -0,0 +1,13 @@
+require "rails/generators"
+
+module Pay
+  module Generators
+    class ViewsGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../../..", __FILE__)
+
+      def copy_views
+        directory "app/views/pay", "app/views/pay"
+      end
+    end
+  end
+end

data/lib/pay/billable/sync_email.rb

@@ -15,12 +15,11 @@ module Pay
       extend ActiveSupport::Concern
 
       included do
-        after_update :enqeue_sync_email_job,
-                     if: :should_sync_email_with_processor?
+        after_update :enqeue_sync_email_job, if: :should_sync_email_with_processor?
       end
 
       def should_sync_email_with_processor?
-        respond_to? :saved_change_to_email?
+        try(:saved_change_to_email?)
       end
 
       def sync_email_with_processor
@@ -32,7 +31,7 @@ module Pay
       def enqeue_sync_email_job
         # Only update if the processor id is the same
         # This prevents duplicate API hits if this is their first time
-        if processor_id? && !processor_id_changed? && saved_change_to_email?
+        if processor_id? && !saved_change_to_processor_id? && saved_change_to_email?
           EmailSyncJob.perform_later(id)
         end
       end

data/lib/pay/billable.rb

@@ -1,4 +1,4 @@
-require 'pay/billable/sync_email'
+require "pay/billable/sync_email"
 
 module Pay
   module Billable
@@ -38,7 +38,7 @@ module Pay
       send("create_#{processor}_charge", amount_in_cents, options)
     end
 
-    def subscribe(name: 'default', plan: 'default', **options)
+    def subscribe(name: "default", plan: "default", **options)
       check_for_processor
       send("create_#{processor}_subscription", name, plan, options)
     end
@@ -49,25 +49,25 @@ module Pay
       send("update_#{processor}_card", token)
     end
 
-    def on_trial?(name: 'default', plan: nil)
+    def on_trial?(name: "default", plan: nil)
       return true if default_generic_trial?(name, plan)
 
       sub = subscription(name: name)
-      return sub && sub.on_trial? if plan.nil?
+      return sub&.on_trial? if plan.nil?
 
-      sub && sub.on_trial? && sub.processor_plan == plan
+      sub&.on_trial? && sub.processor_plan == plan
     end
 
     def on_generic_trial?
       trial_ends_at? && trial_ends_at > Time.zone.now
     end
 
-    def processor_subscription(subscription_id)
+    def processor_subscription(subscription_id, options = {})
       check_for_processor
-      send("#{processor}_subscription", subscription_id)
+      send("#{processor}_subscription", subscription_id, options)
     end
 
-    def subscribed?(name: 'default', processor_plan: nil)
+    def subscribed?(name: "default", processor_plan: nil)
       subscription = subscription(name: name)
 
       return false if subscription.nil?
@@ -76,17 +76,17 @@ module Pay
       subscription.active? && subscription.processor_plan == processor_plan
     end
 
-    def on_trial_or_subscribed?(name: 'default', processor_plan: nil)
+    def on_trial_or_subscribed?(name: "default", processor_plan: nil)
       on_trial?(name: name, plan: processor_plan) ||
         subscribed?(name: name, processor_plan: processor_plan)
     end
 
-    def subscription(name: 'default')
+    def subscription(name: "default")
       subscriptions.for_name(name).last
     end
 
-    def invoice!
-      send("#{processor}_invoice!")
+    def invoice!(options = {})
+      send("#{processor}_invoice!", options)
     end
 
     def upcoming_invoice
@@ -105,27 +105,34 @@ module Pay
       braintree? && card_type == "PayPal"
     end
 
+    def has_incomplete_payment?(name: "default")
+      subscription(name: name)&.has_incomplete_payment?
+    end
+
     private
 
     def check_for_processor
       raise StandardError, "No payment processor selected. Make sure to set the #{Pay.billable_class}'s `processor` attribute to either 'stripe' or 'braintree'." unless processor
     end
 
-    def create_subscription(subscription, processor, name, plan, qty = 1)
-      subscriptions.create!(
-        name: name || 'default',
+    # Used for creating a Pay::Subscription in the database
+    def create_subscription(subscription, processor, name, plan, options = {})
+      options[:quantity] ||= 1
+
+      options.merge!(
+        name: name || "default",
         processor: processor,
         processor_id: subscription.id,
         processor_plan: plan,
         trial_ends_at: send("#{processor}_trial_end_date", subscription),
-        quantity: qty,
-        ends_at: nil
+        ends_at: nil,
       )
+      subscriptions.create!(options)
     end
 
     def default_generic_trial?(name, plan)
       # Generic trials don't have plans or custom names
-      plan.nil? && name == 'default' && on_generic_trial?
+      plan.nil? && name == "default" && on_generic_trial?
     end
   end
 end

data/lib/pay/braintree/billable.rb

@@ -16,7 +16,7 @@ module Pay
           )
           raise Pay::Error.new(result.message) unless result.success?
 
-          update(processor: 'braintree', processor_id: result.customer.id)
+          update(processor: "braintree", processor_id: result.customer.id)
 
           if card_token.present?
             update_braintree_card_on_file result.customer.payment_methods.last
@@ -31,11 +31,11 @@ module Pay
       # Handles Billable#charge
       #
       # Returns a Pay::Charge
-      def create_braintree_charge(amount, options={})
+      def create_braintree_charge(amount, options = {})
         args = {
           amount: amount / 100.0,
           customer_id: customer.id,
-          options: { submit_for_settlement: true }
+          options: {submit_for_settlement: true},
         }.merge(options)
 
         result = gateway.transaction.sale(args)
@@ -47,10 +47,15 @@ module Pay
       # Handles Billable#subscribe
       #
       # Returns Pay::Subscription
-      def create_braintree_subscription(name, plan, options={})
+      def create_braintree_subscription(name, plan, options = {})
         token = customer.payment_methods.find(&:default?).try(:token)
         raise Pay::Error, "Customer has no default payment method" if token.nil?
 
+        # Standardize the trial period options
+        if (trial_period_days = options.delete(:trial_period_days)) && trial_period_days > 0
+          options.merge!(trial_period: true, trial_duration: trial_period_days, trial_duration_unit: :day)
+        end
+
         subscription_options = options.merge(
           payment_method_token: token,
           plan_id: plan
@@ -59,7 +64,7 @@ module Pay
         result = gateway.subscription.create(subscription_options)
         raise Pay::Error.new(result.message) unless result.success?
 
-        create_subscription(result.subscription, 'braintree', name, plan)
+        create_subscription(result.subscription, "braintree", name, plan, status: :active)
       rescue ::Braintree::BraintreeError => e
         raise Error, e.message
       end
@@ -73,7 +78,7 @@ module Pay
           payment_method_nonce: token,
           options: {
             make_default: true,
-            verify_card: true
+            verify_card: true,
           }
         )
         raise Pay::Error.new(result.message) unless result.success?
@@ -87,30 +92,31 @@ module Pay
 
       def update_braintree_email!
         braintree_customer.update(
-          email:      email,
+          email: email,
           first_name: try(:first_name),
-          last_name:  try(:last_name),
+          last_name: try(:last_name),
         )
       end
 
       def braintree_trial_end_date(subscription)
         return unless subscription.trial_period
-        Time.zone.parse(subscription.first_billing_date)
+        # Braintree returns dates without time zones, so we'll assume they're UTC
+        Time.parse(subscription.first_billing_date).end_of_day
       end
 
       def update_subscriptions_to_payment_method(token)
         subscriptions.each do |subscription|
           if subscription.active?
-            gateway.subscription.update(subscription.processor_id, { payment_method_token: token })
+            gateway.subscription.update(subscription.processor_id, {payment_method_token: token})
           end
         end
       end
 
-      def braintree_subscription(subscription_id)
+      def braintree_subscription(subscription_id, options = {})
         gateway.subscription.find(subscription_id)
       end
 
-      def braintree_invoice!
+      def braintree_invoice!(options = {})
         # pass
       end
 
@@ -120,7 +126,7 @@ module Pay
 
       def save_braintree_transaction(transaction)
         attrs = card_details_for_braintree_transaction(transaction)
-        attrs.merge!(amount: transaction.amount.to_f * 100)
+        attrs[:amount] = transaction.amount.to_f * 100
 
         charge = charges.find_or_initialize_by(
           processor: :braintree,
@@ -132,80 +138,80 @@ module Pay
 
       private
 
-        def gateway
-          Pay.braintree_gateway
-        end
+      def gateway
+        Pay.braintree_gateway
+      end
 
-        def update_braintree_card_on_file(payment_method)
-          case payment_method
-          when ::Braintree::CreditCard
-            update!(
-              card_type: payment_method.card_type,
-              card_last4: payment_method.last_4,
-              card_exp_month: payment_method.expiration_month,
-              card_exp_year: payment_method.expiration_year
-            )
-
-          when ::Braintree::PayPalAccount
-            update!(
-              card_type: "PayPal",
-              card_last4: payment_method.email
-            )
-          end
+      def update_braintree_card_on_file(payment_method)
+        case payment_method
+        when ::Braintree::CreditCard
+          update!(
+            card_type: payment_method.card_type,
+            card_last4: payment_method.last_4,
+            card_exp_month: payment_method.expiration_month,
+            card_exp_year: payment_method.expiration_year
+          )
 
-          # Clear the card token so we don't accidentally update twice
-          self.card_token = nil
+        when ::Braintree::PayPalAccount
+          update!(
+            card_type: "PayPal",
+            card_last4: payment_method.email
+          )
         end
 
-        def card_details_for_braintree_transaction(transaction)
-          case transaction.payment_instrument_type
-          when "credit_card", "samsung_pay_card", "masterpass_card", "samsung_pay_card", "visa_checkout_card"
-            payment_method = transaction.send("#{transaction.payment_instrument_type}_details")
-            {
-              card_type:      payment_method.card_type,
-              card_last4:     payment_method.last_4,
-              card_exp_month: payment_method.expiration_month,
-              card_exp_year:  payment_method.expiration_year,
-            }
-
-          when "paypal_account"
-            {
-              card_type: "PayPal",
-              card_last4: transaction.paypal_details.payer_email,
-              card_exp_month: nil,
-              card_exp_year: nil,
-            }
-
-          when "android_pay_card"
-            payment_method = transaction.android_pay_details
-            {
-              card_type:      payment_method.source_card_type,
-              card_last4:     payment_method.source_card_last_4,
-              card_exp_month: payment_method.expiration_month,
-              card_exp_year:  payment_method.expiration_year,
-            }
-
-          when "venmo_account"
-            {
-              card_type: "Venmo",
-              card_last4: transaction.venmo_account_details.username,
-              card_exp_month: nil,
-              card_exp_year: nil,
-            }
-
-          when "apple_pay_card"
-            payment_method = transaction.apple_pay_details
-            {
-              card_type:      payment_method.card_type,
-              card_last4:     payment_method.last_4,
-              card_exp_month: payment_method.expiration_month,
-              card_exp_year:  payment_method.expiration_year,
-            }
-
-          else
-            {}
-          end
+        # Clear the card token so we don't accidentally update twice
+        self.card_token = nil
+      end
+
+      def card_details_for_braintree_transaction(transaction)
+        case transaction.payment_instrument_type
+        when "credit_card", "samsung_pay_card", "masterpass_card", "samsung_pay_card", "visa_checkout_card"
+          payment_method = transaction.send("#{transaction.payment_instrument_type}_details")
+          {
+            card_type: payment_method.card_type,
+            card_last4: payment_method.last_4,
+            card_exp_month: payment_method.expiration_month,
+            card_exp_year: payment_method.expiration_year,
+          }
+
+        when "paypal_account"
+          {
+            card_type: "PayPal",
+            card_last4: transaction.paypal_details.payer_email,
+            card_exp_month: nil,
+            card_exp_year: nil,
+          }
+
+        when "android_pay_card"
+          payment_method = transaction.android_pay_details
+          {
+            card_type: payment_method.source_card_type,
+            card_last4: payment_method.source_card_last_4,
+            card_exp_month: payment_method.expiration_month,
+            card_exp_year: payment_method.expiration_year,
+          }
+
+        when "venmo_account"
+          {
+            card_type: "Venmo",
+            card_last4: transaction.venmo_account_details.username,
+            card_exp_month: nil,
+            card_exp_year: nil,
+          }
+
+        when "apple_pay_card"
+          payment_method = transaction.apple_pay_details
+          {
+            card_type: payment_method.card_type,
+            card_last4: payment_method.last_4,
+            card_exp_month: payment_method.expiration_month,
+            card_exp_year: payment_method.expiration_year,
+          }
+
+        else
+          {}
         end
+      end
     end
   end
 end

data/lib/pay/braintree/charge.rb

@@ -1,6 +1,5 @@
 module Pay
   module Braintree
-
     module Charge
       extend ActiveSupport::Concern
 
@@ -22,6 +21,5 @@ module Pay
         raise Error, e.message
       end
     end
-
   end
 end