pay 3.0.6 → 3.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a5f1e8f94af3893db2d70bfd6f7b153213c0fc6bcc8c73b5d58465f94a35ea9
-  data.tar.gz: 14cc1b16d5a6cfc1ff4b220cef61c4910da17bd6e896719e8ecda7284894b848
+  metadata.gz: edebdc875241f0a8525f970b8fd93644ca0152ce823669de0a878f655c3c6696
+  data.tar.gz: a27d9b3cbbb313d0c8fdc796e4e9d2dc5e85c278761e476111415909597e883b
 SHA512:
-  metadata.gz: a2b2164b3af965a2598c1c9257ded5741c2e0631d08f36198b32a981b3a4e7edc0fb83e6dc7bc9de00c796a9dc8bdafab2a36f385e3bb47511aa7376924a5be3
-  data.tar.gz: 6550e82d22748167fa820dbfa48bf2db33e8f98369bb37ac654492a7ea37578b8d8ccd77ab93354e677f1ef94b788afb52f3d537e52dc7fd39084356fa2d3047
+  metadata.gz: 810759a42f2e49d64c4d5e98c8d41a40614fc993bd578621212701c86080fcc5fcecada3bb4ebc838877e81b07c1c23a52ce757a09ebadada8367eef296a7f3f
+  data.tar.gz: 56986f6e8a49477b60968f03dd0ccf426d9eb702a01a146954c3a99bf97f4d25556edacfb64eccd7728437b71c880fc34d00bef9cc59b9a13d3c993b9cee005d

data/app/models/pay/charge.rb

@@ -10,7 +10,6 @@ module Pay
     scope :sorted, -> { order(created_at: :desc) }
     scope :with_active_customer, -> { joins(:customer).merge(Customer.active) }
     scope :with_deleted_customer, -> { joins(:customer).merge(Customer.deleted) }
-    default_scope -> { sorted }
 
     # Validations
     validates :amount, presence: true
@@ -60,6 +59,18 @@ module Pay
       payment_processor.refund!(refund_amount)
     end
 
+    def refunded?
+      amount_refunded.to_i > 0
+    end
+
+    def full_refund?
+      refunded? && amount == amount_refunded
+    end
+
+    def partial_refund?
+      refunded? && !full_refund?
+    end
+
     def charged_to
       case payment_method_type
       when "card"

data/app/models/pay/customer.rb

@@ -65,7 +65,7 @@ module Pay
     end
 
     def customer_name
-      [owner.try(:first_name), owner.try(:last_name)].compact.join(" ")
+      owner.respond_to?(:name) ? owner.name : [owner.try(:first_name), owner.try(:last_name)].compact.join(" ")
     end
 
     def active?

data/app/models/pay/subscription.rb

@@ -4,7 +4,7 @@ module Pay
 
     # Associations
     belongs_to :customer
-    has_many :charges, class_name: "Pay::Charge", foreign_key: :pay_subscription_id
+    has_many :charges
 
     # Scopes
     scope :for_name, ->(name) { where(name: name) }

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

@@ -24,41 +24,41 @@
 
     <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>
+        <h1 class="text-xl mt-2 mb-4 text-gray-700"><%=t "pay.successful.header" %></h1>
+        <p class="mb-6"><%=t "pay.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>
+        <h1 class="text-xl mt-2 mb-4 text-gray-700"><%=t "pay.cancelled.header" %></h1>
+        <p class="mb-6"><%=t "pay.cancelled.description" %></p>
 
       <% else %>
         <div data-payment-intent-target="form" id="payment-elements">
           <!-- 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>
+          <h1 class="text-xl mt-2 mb-4 text-gray-700"><%=t "pay.requires_action.header", amount: number_to_currency(@payment.amount / 100.0) %></h1>
+          <p class="mb-6"><%=t "pay.requires_action.description" %></p>
 
           <div data-payment-intent-target="cardFields" class="hidden">
             <!-- Name -->
-            <label for="cardholder-name" class="inline-block text-sm text-gray-700 font-semibold mb-2"><%=t "requires_action.full_name" %></label>
+            <label for="cardholder-name" class="inline-block text-sm text-gray-700 font-semibold mb-2"><%=t "pay.requires_action.full_name" %></label>
             <input data-payment-intent-target="name" id="cardholder-name" type="text" placeholder="Jane Doe" required autofocus class="mt-1 mb-6 block w-full px-3 py-2 rounded-md border border-gray-300 shadow-sm focus:outline-none focus:border-blue-300 focus:ring focus:ring-blue-200 focus:ring-opacity-50">
 
             <!-- Card -->
-            <label for="card-element" class="inline-block text-sm text-gray-700 font-semibold mb-2"><%=t "requires_action.card" %></label>
+            <label for="card-element" class="inline-block text-sm text-gray-700 font-semibold mb-2"><%=t "pay.requires_action.card" %></label>
             <div data-payment-intent-target="card" id="card-element" class="mt-1 mb-6 block w-full px-3 py-4 rounded-md border border-gray-300 shadow-sm focus:outline-none focus:border-blue-300 focus:ring focus:ring-blue-200 focus:ring-opacity-50"></div>
           </div>
 
           <!-- Pay Button -->
           <button data-payment-intent-target="button" data-action="click->payment-intent#confirmPayment" class="inline-block w-full px-4 py-3 mb-4 text-white rounded-lg bg-blue-400 hover:bg-blue-500">
-            <%=t "requires_action.button", amount: number_to_currency(@payment.amount / 100.0) %>
+            <%=t "pay.requires_action.button", amount: number_to_currency(@payment.amount / 100.0) %>
           </button>
         </div>
       <% end %>
 
-      <%= link_to t("back"), @redirect_to, class: "inline-block w-full px-4 py-3 bg-gray-100 hover:bg-gray-200 text-center text-gray-600 rounded-lg" %>
+      <%= link_to t("pay.back"), @redirect_to, class: "inline-block w-full px-4 py-3 bg-gray-100 hover:bg-gray-200 text-center text-gray-600 rounded-lg" %>
     </div>
 
     <p class="text-center text-gray-500 text-sm">
-      © <%= Date.current.year %> <%= Pay.business_name %> <%=t "all_rights_reserved" %>
+      © <%= Date.current.year %> <%= Pay.business_name %> <%=t "pay.all_rights_reserved" %>
     </p>
   </div>
 </div>
@@ -119,14 +119,14 @@
       if (result.error) {
         if (result.error.code === 'parameter_invalid_empty' &&
           result.error.param === 'payment_method_data[billing_details][name]') {
-          this.errorMessageValue = '<%=t "requires_action.name_missing" %>'
+          this.errorMessageValue = '<%=t "pay.requires_action.name_missing" %>'
         } else {
           this.errorMessageValue = result.error.message
           this.statusValue = result.error.payment_intent.status
         }
       } else {
         this.completeValue = true;
-        this.successMessageValue = '<%=t "requires_action.success" %>'
+        this.successMessageValue = '<%=t "pay.requires_action.success" %>'
       }
     }
 

data/config/locales/en.yml

@@ -1,36 +1,44 @@
 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: Credit or debit card
-    button: Pay %{amount}
-    name_missing: Please provide your name.
-    success: The payment was successful.
-  all_rights_reserved: All rights reserved.
-  back: Go back
-  receipt:
-    date: Date
-    account_billed: Account Billed
-    product: Product
-    amount: Amount
-    charged_to: Charged to
-    additional_info: Additional Info
-  errors:
-    action_required: "This payment attempt failed because additional action is required before it can be completed."
-    invalid_payment: "This payment attempt failed because of an invalid payment method."
-    email_required: "Email is required to create a customer"
-    no_processor: "No payment processor selected. Make sure to set the %{class_name}'s `processor` attribute to either 'stripe' or 'braintree'."
-    braintree:
-      authorization: "Either the data you submitted is malformed and does not match the API or the API key you used may not be authorized to perform this action."
-
   pay:
+    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: Credit or debit card
+      button: Pay %{amount}
+      name_missing: Please provide your name.
+      success: The payment was successful.
+    all_rights_reserved: All rights reserved.
+    back: Go back
+    receipt:
+      date: Date
+      account_billed: Account Billed
+      product: Product
+      amount: Amount
+      charged_to: Charged to
+      additional_info: Additional Info
+      refunded: Refunded
+      paid: Paid
+    invoice:
+      amount: "Amount"
+      product: "Product"
+      quantity: "Quantity"
+      subtotal: "Subtotal"
+      total: "Total"
+      unit_price: "Unit Price"
+    errors:
+      action_required: "This payment attempt failed because additional action is required before it can be completed."
+      invalid_payment: "This payment attempt failed because of an invalid payment method."
+      email_required: "Email is required to create a customer"
+      no_processor: "No payment processor selected. Make sure to set the %{class_name}'s `processor` attribute to either 'stripe' or 'braintree'."
+      braintree:
+        authorization: "Either the data you submitted is malformed and does not match the API or the API key you used may not be authorized to perform this action."
     user_mailer:
       receipt:
         subject: "Payment receipt"

data/lib/pay/braintree/authorization_error.rb

@@ -2,7 +2,7 @@ module Pay
   module Braintree
     class AuthorizationError < Braintree::Error
       def message
-        I18n.t("errors.braintree.authorization")
+        I18n.t("pay.errors.braintree.authorization")
       end
     end
   end

data/lib/pay/errors.rb

@@ -13,13 +13,13 @@ module Pay
 
   class ActionRequired < PaymentError
     def message
-      I18n.t("errors.action_required")
+      I18n.t("pay.errors.action_required")
     end
   end
 
   class InvalidPaymentMethod < PaymentError
     def message
-      I18n.t("errors.invalid_payment")
+      I18n.t("pay.errors.invalid_payment")
     end
   end
 end

data/lib/pay/receipts.rb

@@ -1,5 +1,7 @@
 module Pay
   module Receipts
+    include ActionView::Helpers::NumberHelper
+
     def product
       Pay.application_name
     end
@@ -13,17 +15,30 @@ module Pay
       receipt_pdf.render
     end
 
-    def receipt_pdf
-      ::Receipts::Receipt.new(
+    def receipt_pdf(**options)
+      line_items = [
+        [I18n.t("pay.receipt.date"), I18n.l(created_at, format: :long)],
+        [I18n.t("pay.receipt.account_billed"), "#{customer.customer_name} (#{customer.email})"],
+        [I18n.t("pay.receipt.product"), product],
+        [I18n.t("pay.receipt.amount"), number_to_currency(amount / 100.0)],
+        [I18n.t("pay.receipt.charged_to"), charged_to]
+      ]
+      line_items << [I18n.t("pay.receipt.additional_info"), customer.owner.extra_billing_info] if customer.owner.extra_billing_info?
+      line_items << [I18n.t("pay.receipt.refunded"), number_to_currency(amount_refunded / 100.0)] if refunded?
+
+      defaults = {
         id: id,
         product: product,
         company: {
           name: Pay.business_name,
           address: Pay.business_address,
-          email: Pay.support_email
+          email: Pay.support_email,
+          logo: Pay.business_logo
         },
         line_items: line_items
-      )
+      }
+
+      ::Receipts::Receipt.new(defaults.deep_merge(options))
     end
 
     def invoice_filename
@@ -34,35 +49,40 @@ module Pay
       invoice_pdf.render
     end
 
-    def invoice_pdf
-      ::Receipts::Invoice.new(
+    def invoice_pdf(**options)
+      bill_to = [owner.name]
+      bill_to += [owner.extra_billing_info] if owner.extra_billing_info?
+      bill_to += [nil, owner.email]
+
+      total = ActionController::Base.helpers.number_to_currency(amount / 100.0)
+
+      line_items = [
+        ["<b>#{I18n.t("pay.invoice.product")}</b>", nil, "<b>#{I18n.t("pay.invoice.amount")}</b>"],
+        [product, nil, total],
+        [nil, I18n.t("pay.invoice.subtotal"), total],
+        [nil, I18n.t("pay.invoice.total"), total]
+      ]
+
+      defaults = {
         id: id,
-        issue_date: created_at,
-        due_date: created_at,
-        status: "<b><color rgb='#5eba7d'>PAID</color></b>",
-        bill_to: [
-          customer.customer_name,
-          customer.email
-        ].compact,
+        issue_date: I18n.l(created_at, format: :long),
+        due_date: I18n.l(created_at, format: :long),
+        status: "<b><color rgb='#5eba7d'>#{I18n.t("pay.receipt.paid").upcase}</color></b>",
+        bill_to: bill_to,
         product: product,
         company: {
           name: Pay.business_name,
           address: Pay.business_address,
-          email: Pay.support_email
+          email: Pay.support_email,
+          logo: Pay.business_logo
         },
         line_items: line_items
-      )
+      }
+
+      ::Receipts::Invoice.new(defaults.deep_merge(options))
     end
 
     def line_items
-      line_items = [
-        [I18n.t("receipt.date"), created_at.to_s],
-        [I18n.t("receipt.account_billed"), "#{customer.customer_name} (#{customer.email})"],
-        [I18n.t("receipt.product"), product],
-        [I18n.t("receipt.amount"), ActionController::Base.helpers.number_to_currency(amount / 100.0)],
-        [I18n.t("receipt.charged_to"), charged_to]
-      ]
-      line_items << [I18n.t("receipt.additional_info"), customer.owner.extra_billing_info] if customer.owner.extra_billing_info?
       line_items
     end
   end

data/lib/pay/version.rb

@@ -1,3 +1,3 @@
 module Pay
-  VERSION = "3.0.6"
+  VERSION = "3.0.10"
 end

data/lib/pay.rb

@@ -31,6 +31,7 @@ module Pay
   mattr_accessor :application_name
   mattr_accessor :business_address
   mattr_accessor :business_name
+  mattr_accessor :business_logo
   mattr_accessor :support_email
 
   # Email configuration

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pay
 version: !ruby/object:Gem::Version
-  version: 3.0.6
+  version: 3.0.10
 platform: ruby
 authors:
 - Jason Charnes
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-04 00:00:00.000000000 Z
+date: 2021-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails