reji 1.0.0 → 1.1.0

data/lib/reji/concerns/performs_charges.rb

@@ -7,17 +7,17 @@ module Reji
     # Make a "one off" charge on the customer for the given amount.
     def charge(amount, payment_method, options = {})
       options = {
-        :confirmation_method => 'automatic',
-        :confirm => true,
-        :currency => self.preferred_currency,
+        confirmation_method: 'automatic',
+        confirm: true,
+        currency: preferred_currency,
       }.merge(options)
 
       options[:amount] = amount
       options[:payment_method] = payment_method
-      options[:customer] = self.stripe_id if self.has_stripe_id
+      options[:customer] = stripe_id if stripe_id?
 
       payment = Payment.new(
-        Stripe::PaymentIntent.create(options, self.stripe_options)
+        Stripe::PaymentIntent.create(options, stripe_options)
       )
 
       payment.validate
@@ -28,8 +28,8 @@ module Reji
     # Refund a customer for a charge.
     def refund(payment_intent, options = {})
       Stripe::Refund.create(
-        {:payment_intent => payment_intent}.merge(options),
-        self.stripe_options
+        { payment_intent: payment_intent }.merge(options),
+        stripe_options
       )
     end
   end

data/lib/reji/concerns/prorates.rb

@@ -31,7 +31,7 @@ module Reji
     end
 
     # Determine the prorating behavior when updating the subscription.
-    def prorate_behavior
+    def proration_behavior
       @proration_behavior ||= 'create_prorations'
     end
   end

data/lib/reji/configuration.rb

@@ -36,8 +36,8 @@ module Reji
       @key = ENV['STRIPE_KEY']
       @secret = ENV['STRIPE_SECRET']
       @webhook = {
-        :secret => ENV['STRIPE_WEBHOOK_SECRET'],
-        :tolerance => ENV['STRIPE_WEBHOOK_TOLERANCE'] || 300,
+        secret: ENV['STRIPE_WEBHOOK_SECRET'],
+        tolerance: ENV['STRIPE_WEBHOOK_TOLERANCE'] || 300,
       }
       @model = ENV['REJI_MODEL'] || 'User'
       @model_id = ENV['REJI_MODEL_ID'] || 'user_id'

data/lib/reji/engine.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Reji
   class Engine < ::Rails::Engine
   end

data/lib/reji/errors.rb

@@ -13,51 +13,51 @@ module Reji
 
   class PaymentActionRequiredError < IncompletePaymentError
     def self.incomplete(payment)
-      self.new(payment, 'The payment attempt failed because additional action is required before it can be completed.')
+      new(payment, 'The payment attempt failed because additional action is required before it can be completed.')
     end
   end
 
   class PaymentFailureError < IncompletePaymentError
     def self.invalid_payment_method(payment)
-      self.new(payment, 'The payment attempt failed because of an invalid payment method.')
+      new(payment, 'The payment attempt failed because of an invalid payment method.')
     end
   end
 
   class CustomerAlreadyCreatedError < StandardError
     def self.exists(owner)
-      self.new("#{owner.class.name} is already a Stripe customer with ID #{owner.stripe_id}.")
+      new("#{owner.class.name} is already a Stripe customer with ID #{owner.stripe_id}.")
     end
   end
 
   class InvalidCustomerError < StandardError
     def self.not_yet_created(owner)
-      self.new("#{owner.class.name} is not a Stripe customer yet. See the create_as_stripe_customer method.")
+      new("#{owner.class.name} is not a Stripe customer yet. See the create_as_stripe_customer method.")
     end
   end
 
   class InvalidPaymentMethodError < StandardError
     def self.invalid_owner(payment_method, owner)
-      self.new("The payment method `#{payment_method.id}` does not belong to this customer `#{owner.stripe_id}`.")
+      new("The payment method `#{payment_method.id}` does not belong to this customer `#{owner.stripe_id}`.")
     end
   end
 
   class InvalidInvoiceError < StandardError
     def self.invalid_owner(invoice, owner)
-      self.new("The invoice `#{invoice.id}` does not belong to this customer `#{owner.stripe_id}`.")
+      new("The invoice `#{invoice.id}` does not belong to this customer `#{owner.stripe_id}`.")
     end
   end
 
   class SubscriptionUpdateFailureError < StandardError
     def self.incomplete_subscription(subscription)
-      self.new("The subscription \"#{subscription.stripe_id}\" cannot be updated because its payment is incomplete.")
+      new("The subscription \"#{subscription.stripe_id}\" cannot be updated because its payment is incomplete.")
     end
 
     def self.duplicate_plan(subscription, plan)
-      self.new("The plan \"#{plan}\" is already attached to subscription \"#{subscription.stripe_id}\".")
+      new("The plan \"#{plan}\" is already attached to subscription \"#{subscription.stripe_id}\".")
     end
 
     def self.cannot_delete_last_plan(subscription)
-      self.new("The plan on subscription \"#{subscription.stripe_id}\" cannot be removed because it is the last one.")
+      new("The plan on subscription \"#{subscription.stripe_id}\" cannot be removed because it is the last one.")
     end
   end
 

data/lib/reji/invoice.rb

@@ -15,17 +15,17 @@ module Reji
 
     # Get a date for the invoice.
     def date
-      Time.at(@invoice.created ? @invoice.created : @invoice.date)
+      Time.zone.at(@invoice.created || @invoice.date)
     end
 
     # Get the total amount that was paid (or will be paid).
     def total
-      Reji.format_amount(self.raw_total)
+      Reji.format_amount(raw_total)
     end
 
     # Get the raw total amount that was paid (or will be paid).
     def raw_total
-      @invoice.total + self.raw_starting_balance
+      @invoice.total + raw_starting_balance
     end
 
     # Get the total of the invoice (before discounts).
@@ -34,37 +34,37 @@ module Reji
     end
 
     # Determine if the account had a starting balance.
-    def has_starting_balance
-      self.raw_starting_balance < 0
+    def starting_balance?
+      raw_starting_balance < 0
     end
 
     # Get the starting balance for the invoice.
     def starting_balance
-      Reji.format_amount(self.raw_starting_balance)
+      Reji.format_amount(raw_starting_balance)
     end
 
     # Get the raw starting balance for the invoice.
     def raw_starting_balance
-      @invoice[:starting_balance] ? @invoice[:starting_balance] : 0
+      @invoice[:starting_balance] || 0
     end
 
     # Determine if the invoice has a discount.
-    def has_discount
-      self.raw_discount > 0
+    def discount?
+      raw_discount > 0
     end
 
     # Get the discount amount.
     def discount
-      self.format_amount(self.raw_discount)
+      format_amount(raw_discount)
     end
 
     # Get the raw discount amount.
     def raw_discount
       return 0 unless @invoice.discount
 
-      return (@invoice.subtotal * (self.percent_off / 100)).round.to_i if self.discount_is_percentage
+      return (@invoice.subtotal * (percent_off / 100)).round.to_i if discount_is_percentage
 
-      self.raw_amount_off
+      raw_amount_off
     end
 
     # Get the coupon code applied to the invoice.
@@ -76,43 +76,43 @@ module Reji
     def discount_is_percentage
       return false unless @invoice[:discount]
 
-      !! @invoice[:discount][:coupon][:percent_off]
+      !!@invoice[:discount][:coupon][:percent_off]
     end
 
     # Get the discount percentage for the invoice.
     def percent_off
-      self.coupon ? @invoice[:discount][:coupon][:percent_off] : 0
+      coupon ? @invoice[:discount][:coupon][:percent_off] : 0
     end
 
     # Get the discount amount for the invoice.
     def amount_off
-      self.format_amount(self.raw_amount_off)
+      format_amount(raw_amount_off)
     end
 
     # Get the raw discount amount for the invoice.
     def raw_amount_off
       amount_off = @invoice[:discount][:coupon][:amount_off]
 
-      amount_off ? amount_off : 0
+      amount_off || 0
     end
 
     # Get the total tax amount.
     def tax
-      self.format_amount(@invoice.tax)
+      format_amount(@invoice.tax)
     end
 
     # Determine if the invoice has tax applied.
-    def has_tax
-      line_items = self.invoice_items + self.subscriptions
+    def tax?
+      line_items = invoice_items + subscriptions
 
-      line_items.any? { |item| item.has_tax_rates }
+      line_items.any?(&:tax_rates?)
     end
 
     # Get the taxes applied to the invoice.
     def taxes
       return @taxes unless @taxes.nil?
 
-      self.refresh_with_expanded_tax_rates
+      refresh_with_expanded_tax_rates
 
       @taxes = @invoice.total_tax_amounts
         .sort_by(&:inclusive)
@@ -123,12 +123,12 @@ module Reji
     end
 
     # Determine if the customer is not exempted from taxes.
-    def is_not_tax_exempt
+    def not_tax_exempt?
       @invoice[:customer_tax_exempt] == 'none'
     end
 
     # Determine if the customer is exempted from taxes.
-    def is_tax_exempt
+    def tax_exempt?
       @invoice[:customer_tax_exempt] == 'exempt'
     end
 
@@ -139,18 +139,18 @@ module Reji
 
     # Get all of the "invoice item" line items.
     def invoice_items
-      self.invoice_line_items_by_type('invoiceitem')
+      invoice_line_items_by_type('invoiceitem')
     end
 
     # Get all of the "subscription" line items.
     def subscriptions
-      self.invoice_line_items_by_type('subscription')
+      invoice_line_items_by_type('subscription')
     end
 
     # Get all of the invoice items by a given type.
     def invoice_line_items_by_type(type)
       if @items.nil?
-        self.refresh_with_expanded_tax_rates
+        refresh_with_expanded_tax_rates
 
         @items = @invoice.lines.auto_paging_each
       end
@@ -166,27 +166,27 @@ module Reji
         template: 'receipt',
         locals: data.merge({
           invoice: self,
-          owner: self.owner,
-          user: self.owner,
+          owner: owner,
+          user: owner,
         })
       )
     end
 
     # Capture the invoice as a PDF and return the raw bytes.
     def pdf(data)
-      WickedPdf.new.pdf_from_string(self.view(data))
+      WickedPdf.new.pdf_from_string(view(data))
     end
 
     # Create an invoice download response.
     def download(data)
-      filename = "#{data[:product]}_#{self.date.month}_#{self.date.year}"
+      filename = "#{data[:product]}_#{date.month}_#{date.year}"
 
-      self.download_as(filename, data)
+      download_as(filename, data)
     end
 
     # Create an invoice download response with a specific filename.
     def download_as(filename, data)
-      {:data => self.pdf(data), :filename => filename}
+      { data: pdf(data), filename: filename }
     end
 
     # Void the Stripe invoice.
@@ -197,9 +197,7 @@ module Reji
     end
 
     # Get the Stripe model instance.
-    def owner
-      @owner
-    end
+    attr_reader :owner
 
     # Get the Stripe invoice instance.
     def as_stripe_invoice
@@ -211,32 +209,35 @@ module Reji
       @invoice[key]
     end
 
-    protected
+    def respond_to_missing?(method_name, include_private = false)
+      super
+    end
 
     # Refresh the invoice with expanded TaxRate objects.
-    def refresh_with_expanded_tax_rates
-      if @invoice.id
-        @invoice = Stripe::Invoice.retrieve({
-          :id => @invoice.id,
-          :expand => [
-            'lines.data.tax_amounts.tax_rate',
-            'total_tax_amounts.tax_rate',
-          ],
-        }, @owner.stripe_options)
-      else
-        # If no invoice ID is present then assume this is the customer's upcoming invoice...
-        @invoice = Stripe::Invoice.upcoming({
-          :customer => @owner.stripe_id,
-          :expand => [
-            'lines.data.tax_amounts.tax_rate',
-            'total_tax_amounts.tax_rate',
-          ],
-        }, @owner.stripe_options)
-      end
+    protected def refresh_with_expanded_tax_rates
+      @invoice =
+        if @invoice.id
+          Stripe::Invoice.retrieve({
+            id: @invoice.id,
+            expand: [
+              'lines.data.tax_amounts.tax_rate',
+              'total_tax_amounts.tax_rate',
+            ],
+          }, @owner.stripe_options)
+        else
+          # If no invoice ID is present then assume this is the customer's upcoming invoice...
+          Stripe::Invoice.upcoming({
+            customer: @owner.stripe_id,
+            expand: [
+              'lines.data.tax_amounts.tax_rate',
+              'total_tax_amounts.tax_rate',
+            ],
+          }, @owner.stripe_options)
+        end
     end
 
     # Format the given amount into a displayable currency.
-    def format_amount(amount)
+    protected def format_amount(amount)
       Reji.format_amount(amount, @invoice.currency)
     end
   end

data/lib/reji/invoice_line_item.rb

@@ -9,54 +9,50 @@ module Reji
 
     # Get the total for the invoice line item.
     def total
-      self.format_amount(@item.amount)
+      format_amount(@item.amount)
     end
 
     # Determine if the line item has both inclusive and exclusive tax.
-    def has_both_inclusive_and_exclusive_tax
-      self.inclusive_tax_percentage > 0 && self.exclusive_tax_percentage > 0
+    def both_inclusive_and_exclusive_tax?
+      inclusive_tax_percentage > 0 && exclusive_tax_percentage > 0
     end
 
     # Get the total percentage of the default inclusive tax for the invoice line item.
     def inclusive_tax_percentage
-      @invoice.is_not_tax_exempt ?
-        self.calculate_tax_percentage_by_tax_amount(true) :
-        self.calculate_tax_percentage_by_tax_rate(true)
+      return calculate_tax_percentage_by_tax_amount(true) if @invoice.not_tax_exempt?
+
+      calculate_tax_percentage_by_tax_rate(true)
     end
 
     # Get the total percentage of the default exclusive tax for the invoice line item.
     def exclusive_tax_percentage
-      @invoice.is_not_tax_exempt ?
-        self.calculate_tax_percentage_by_tax_amount(false) :
-        self.calculate_tax_percentage_by_tax_rate(false)
+      return calculate_tax_percentage_by_tax_amount(false) if @invoice.not_tax_exempt?
+
+      calculate_tax_percentage_by_tax_rate(false)
     end
 
     # Determine if the invoice line item has tax rates.
-    def has_tax_rates
-      @invoice.is_not_tax_exempt ?
-        ! @item.tax_amounts.empty? :
-        ! @item.tax_rates.empty?
+    def tax_rates?
+      @invoice.not_tax_exempt? ? !@item.tax_amounts.empty? : !@item.tax_rates.empty?
     end
 
     # Get a human readable date for the start date.
     def start_date
-      self.is_subscription ? Time.at(@item.period.start).strftime('%b %d, %Y') : nil
+      subscription? ? Time.zone.at(@item.period.start).strftime('%b %d, %Y') : nil
     end
 
     # Get a human readable date for the end date.
     def end_date
-      self.is_subscription ? Time.at(@item.period.end).strftime('%b %d, %Y') : nil
+      subscription? ? Time.zone.at(@item.period.end).strftime('%b %d, %Y') : nil
     end
 
     # Determine if the invoice line item is for a subscription.
-    def is_subscription
+    def subscription?
       @item.type == 'subscription'
     end
 
     # Get the Stripe model instance.
-    def invoice
-      @invoice
-    end
+    attr_reader :invoice
 
     # Get the underlying Stripe invoice line item.
     def as_stripe_invoice_line_item
@@ -68,10 +64,12 @@ module Reji
       @item[key]
     end
 
-    protected
+    def respond_to_missing?(method_name, include_private = false)
+      super
+    end
 
     # Calculate the total tax percentage for either the inclusive or exclusive tax by tax rate.
-    def calculate_tax_percentage_by_tax_rate(inclusive)
+    protected def calculate_tax_percentage_by_tax_rate(inclusive)
       return 0 if @item[:tax_rates].empty?
 
       @item.tax_rates
@@ -81,7 +79,7 @@ module Reji
     end
 
     # Calculate the total tax percentage for either the inclusive or exclusive tax by tax amount.
-    def calculate_tax_percentage_by_tax_amount(inclusive)
+    protected def calculate_tax_percentage_by_tax_amount(inclusive)
       return 0 if @item[:tax_amounts].blank?
 
       @item.tax_amounts
@@ -91,7 +89,7 @@ module Reji
     end
 
     # Format the given amount into a displayable currency.
-    def format_amount(amount)
+    protected def format_amount(amount)
       Reji.format_amount(amount, @item.currency)
     end
   end