reji 1.0.0 → 1.1.0

data/lib/reji/subscription_builder.rb

@@ -9,11 +9,11 @@ module Reji
     def initialize(owner, name, plans = [])
       @owner = owner
       @name = name
-      @trial_expires # The date and time the trial will expire.
+      @trial_expires = nil # The date and time the trial will expire.
       @skip_trial = false # Indicates that the trial should end immediately.
       @billing_cycle_anchor = nil # The date on which the billing cycle should be anchored.
-      @coupon # The coupon code being applied to the customer.
-      @metadata # The metadata to apply to the subscription.
+      @coupon = nil # The coupon code being applied to the customer.
+      @metadata = nil # The metadata to apply to the subscription.
       @items = {}
 
       plans = [plans] unless plans.instance_of? Array
@@ -24,11 +24,11 @@ module Reji
     # Set a plan on the subscription builder.
     def plan(plan, quantity = 1)
       options = {
-        :plan => plan,
-        :quantity => quantity
+        plan: plan,
+        quantity: quantity,
       }
 
-      tax_rates = self.get_plan_tax_rates_for_payload(plan)
+      tax_rates = get_plan_tax_rates_for_payload(plan)
 
       options[:tax_rates] = tax_rates if tax_rates
 
@@ -40,7 +40,7 @@ module Reji
     # Specify the quantity of a subscription item.
     def quantity(quantity, plan = nil)
       if plan.nil?
-        raise ArgumentError.new('Plan is required when creating multi-plan subscriptions.') if @items.length > 1
+        raise ArgumentError, 'Plan is required when creating multi-plan subscriptions.' if @items.length > 1
 
         plan = @items.values[0][:plan]
       end
@@ -50,7 +50,7 @@ module Reji
 
     # Specify the number of days of the trial.
     def trial_days(trial_days)
-      @trial_expires = Time.now + trial_days.days
+      @trial_expires = Time.current + trial_days.days
 
       self
     end
@@ -92,16 +92,14 @@ module Reji
 
     # Add a new Stripe subscription to the Stripe model.
     def add(customer_options = {}, subscription_options = {})
-      self.create(nil, customer_options, subscription_options)
+      create(nil, customer_options, subscription_options)
     end
 
     # Create a new Stripe subscription.
     def create(payment_method = nil, customer_options = {}, subscription_options = {})
-      customer = self.get_stripe_customer(payment_method, customer_options)
+      customer = get_stripe_customer(payment_method, customer_options)
 
-      payload = {:customer => customer.id}
-        .merge(self.build_payload)
-        .merge(subscription_options)
+      payload = { customer: customer.id }.merge(build_payload).merge(subscription_options)
 
       stripe_subscription = Stripe::Subscription.create(
         payload,
@@ -109,34 +107,30 @@ module Reji
       )
 
       subscription = @owner.subscriptions.create({
-        :name => @name,
-        :stripe_id => stripe_subscription.id,
-        :stripe_status => stripe_subscription.status,
-        :stripe_plan => stripe_subscription.plan ? stripe_subscription.plan.id : nil,
-        :quantity => stripe_subscription.quantity,
-        :trial_ends_at => @skip_trial ? nil : @trial_expires,
-        :ends_at => nil,
+        name: @name,
+        stripe_id: stripe_subscription.id,
+        stripe_status: stripe_subscription.status,
+        stripe_plan: stripe_subscription.plan ? stripe_subscription.plan.id : nil,
+        quantity: stripe_subscription.quantity,
+        trial_ends_at: @skip_trial ? nil : @trial_expires,
+        ends_at: nil,
       })
 
       stripe_subscription.items.each do |item|
         subscription.items.create({
-          :stripe_id => item.id,
-          :stripe_plan => item.plan.id,
-          :quantity => item.quantity,
+          stripe_id: item.id,
+          stripe_plan: item.plan.id,
+          quantity: item.quantity,
         })
       end
 
-      if subscription.has_incomplete_payment
-        Payment.new(stripe_subscription.latest_invoice.payment_intent).validate
-      end
+      Payment.new(stripe_subscription.latest_invoice.payment_intent).validate if subscription.incomplete_payment?
 
       subscription
     end
 
-    protected
-
     # Get the Stripe customer instance for the current user and payment method.
-    def get_stripe_customer(payment_method = nil, options = {})
+    protected def get_stripe_customer(payment_method = nil, options = {})
       customer = @owner.create_or_get_stripe_customer(options)
 
       @owner.update_default_payment_method(payment_method) if payment_method
@@ -145,20 +139,20 @@ module Reji
     end
 
     # Build the payload for subscription creation.
-    def build_payload
+    protected def build_payload
       payload = {
-        :billing_cycle_anchor => @billing_cycle_anchor,
-        :coupon => @coupon,
-        :expand => ['latest_invoice.payment_intent'],
-        :metadata => @metadata,
-        :items => @items.values,
-        :payment_behavior => self.payment_behavior,
-        :proration_behavior => self.prorate_behavior,
-        :trial_end => self.get_trial_end_for_payload,
-        :off_session => true,
+        billing_cycle_anchor: @billing_cycle_anchor,
+        coupon: @coupon,
+        expand: ['latest_invoice.payment_intent'],
+        metadata: @metadata,
+        items: @items.values,
+        payment_behavior: payment_behavior,
+        proration_behavior: proration_behavior,
+        trial_end: get_trial_end_for_payload,
+        off_session: true,
       }
 
-      tax_rates = self.get_tax_rates_for_payload
+      tax_rates = get_tax_rates_for_payload
 
       if tax_rates
         payload[:default_tax_rates] = tax_rates
@@ -166,7 +160,7 @@ module Reji
         return payload
       end
 
-      tax_percentage = self.get_tax_percentage_for_payload
+      tax_percentage = get_tax_percentage_for_payload
 
       payload[:tax_percent] = tax_percentage if tax_percentage
 
@@ -174,33 +168,31 @@ module Reji
     end
 
     # Get the trial ending date for the Stripe payload.
-    def get_trial_end_for_payload
+    protected def get_trial_end_for_payload
       return 'now' if @skip_trial
 
-      @trial_expires.to_i if @trial_expires
+      @trial_expires&.to_i
     end
 
     # Get the tax percentage for the Stripe payload.
-    def get_tax_percentage_for_payload
+    protected def get_tax_percentage_for_payload
       tax_percentage = @owner.tax_percentage
 
       tax_percentage if tax_percentage > 0
     end
 
     # Get the tax rates for the Stripe payload.
-    def get_tax_rates_for_payload
+    protected def get_tax_rates_for_payload
       tax_rates = @owner.tax_rates
 
       tax_rates unless tax_rates.empty?
     end
 
     # Get the plan tax rates for the Stripe payload.
-    def get_plan_tax_rates_for_payload(plan)
+    protected def get_plan_tax_rates_for_payload(plan)
       tax_rates = @owner.plan_tax_rates
 
-      unless tax_rates.empty?
-        tax_rates[plan] || nil
-      end
+      tax_rates[plan] || nil unless tax_rates.empty?
     end
   end
 end

data/lib/reji/subscription_item.rb

@@ -9,88 +9,88 @@ module Reji
 
     # Increment the quantity of the subscription item.
     def increment_quantity(count = 1)
-      self.update_quantity(self.quantity + count)
+      update_quantity(quantity + count)
 
       self
     end
 
     # Increment the quantity of the subscription item, and invoice immediately.
     def increment_and_invoice(count = 1)
-      self.always_invoice
+      always_invoice
 
-      self.increment_quantity(count)
+      increment_quantity(count)
 
       self
     end
 
     # Decrement the quantity of the subscription item.
     def decrement_quantity(count = 1)
-      self.update_quantity([1, self.quantity - count].max)
+      update_quantity([1, quantity - count].max)
 
       self
     end
 
     # Update the quantity of the subscription item.
     def update_quantity(quantity)
-      self.subscription.guard_against_incomplete
+      subscription.guard_against_incomplete
 
-      stripe_subscription_item = self.as_stripe_subscription_item
+      stripe_subscription_item = as_stripe_subscription_item
       stripe_subscription_item.quantity = quantity
-      stripe_subscription_item.payment_behavior = self.payment_behavior
-      stripe_subscription_item.proration_behavior = self.prorate_behavior
+      stripe_subscription_item.payment_behavior = payment_behavior
+      stripe_subscription_item.proration_behavior = proration_behavior
       stripe_subscription_item.save
 
-      self.update(quantity: quantity)
+      update(quantity: quantity)
 
-      self.subscription.update(quantity: quantity) if self.subscription.has_single_plan
+      subscription.update(quantity: quantity) if subscription.single_plan?
 
       self
     end
 
     # Swap the subscription item to a new Stripe plan.
     def swap(plan, options = {})
-      self.subscription.guard_against_incomplete
+      subscription.guard_against_incomplete
 
       options = {
-        :plan => plan,
-        :quantity => self.quantity,
-        :payment_behavior => self.payment_behavior,
-        :proration_behavior => self.prorate_behavior,
-        :tax_rates => self.subscription.get_plan_tax_rates_for_payload(plan)
+        plan: plan,
+        quantity: quantity,
+        payment_behavior: payment_behavior,
+        proration_behavior: proration_behavior,
+        tax_rates: subscription.get_plan_tax_rates_for_payload(plan),
       }.merge(options)
 
-      item = Stripe::SubscriptionItem::update(
-        self.stripe_id,
+      item = Stripe::SubscriptionItem.update(
+        stripe_id,
         options,
-        self.subscription.owner.stripe_options
+        subscription.owner.stripe_options
       )
 
-      self.update(stripe_plan: plan, quantity: item.quantity)
+      update(stripe_plan: plan, quantity: item.quantity)
 
-      self.subscription.update(stripe_plan: plan, quantity: item.quantity) if self.subscription.has_single_plan
+      subscription.update(stripe_plan: plan, quantity: item.quantity) if subscription.single_plan?
 
       self
     end
 
     # Swap the subscription item to a new Stripe plan, and invoice immediately.
     def swap_and_invoice(plan, options = {})
-      self.always_invoice
+      always_invoice
 
-      self.swap(plan, options)
+      swap(plan, options)
     end
 
     # Update the underlying Stripe subscription item information for the model.
     def update_stripe_subscription_item(options = {})
       Stripe::SubscriptionItem.update(
-        self.stripe_id, options, self.subscription.owner.stripe_options
+        stripe_id, options, subscription.owner.stripe_options
       )
     end
 
     # Get the subscription as a Stripe subscription item object.
     def as_stripe_subscription_item(expand = {})
       Stripe::SubscriptionItem.retrieve(
-        {:id => self.stripe_id, :expand => expand},
-        self.subscription.owner.stripe_options
+        { id: stripe_id, expand: expand },
+        subscription.owner.stripe_options
       )
     end
   end

data/lib/reji/tax.rb

@@ -9,13 +9,11 @@ module Reji
     end
 
     # Get the applied currency.
-    def currency
-      @currency
-    end
+    attr_reader :currency
 
     # Get the total tax that was paid (or will be paid).
     def amount
-      self.format_amount(@amount)
+      format_amount(@amount)
     end
 
     # Get the raw total tax that was paid (or will be paid).
@@ -24,24 +22,24 @@ module Reji
     end
 
     # Determine if the tax is inclusive or not.
-    def is_inclusive
+    def inclusive?
       @tax_rate.inclusive
     end
 
     # Stripe::TaxRate
-    def tax_rate
-      @tax_rate
-    end
+    attr_reader :tax_rate
 
     # Dynamically get values from the Stripe TaxRate.
     def method_missing(key)
       @tax_rate[key]
     end
 
-    protected
+    def respond_to_missing?(method_name, include_private = false)
+      super
+    end
 
     # Format the given amount into a displayable currency.
-    def format_amount(amount)
+    protected def format_amount(amount)
       Reji.format_amount(amount, @currency)
     end
   end

data/lib/reji/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Reji
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/reji.gemspec

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-$:.push File.expand_path('lib', __dir__)
+$LOAD_PATH.push File.expand_path('lib', __dir__)
 
 require 'reji/version'
 
@@ -20,13 +20,14 @@ Gem::Specification.new do |s|
   s.require_paths = ['lib']
   s.test_files = `git ls-files -- {spec}/*`.split("\n")
 
-  s.add_dependency 'stripe', '>= 5.0'
+  s.add_dependency 'actionmailer', '>= 5.0'
+  s.add_dependency 'activerecord', '>= 5.0'
   s.add_dependency 'money', '>= 6.0'
   s.add_dependency 'railties', '>= 5.0'
-  s.add_dependency 'activerecord', '>= 5.0'
-  s.add_dependency 'actionmailer', '>= 5.0'
+  s.add_dependency 'stripe', '>= 5.0'
   s.add_dependency 'wicked_pdf'
   s.add_dependency 'wkhtmltopdf-binary'
+  s.add_development_dependency 'appraisal'
   s.add_development_dependency 'rspec-rails', '~> 4.0.1'
   s.add_development_dependency 'sqlite3', '~> 1.4.2'
 end

data/spec/dummy/app/models/user.rb

@@ -4,18 +4,14 @@ class User < ActiveRecord::Base
   include Reji::Billable
 
   def tax_rates
-    @tax_rates || {}
+    @tax_rates || []
   end
 
   def plan_tax_rates
     @plan_tax_rates || {}
   end
 
-  def plan_tax_rates=(value)
-    @plan_tax_rates = value
-  end
+  attr_writer :plan_tax_rates
 
-  def tax_rates=(value)
-    @tax_rates = value
-  end
+  attr_writer :tax_rates
 end

data/spec/dummy/application.rb

@@ -4,7 +4,7 @@ require 'rails/all'
 require 'reji'
 
 module Dummy
-  APP_ROOT = File.expand_path('..', __FILE__).freeze
+  APP_ROOT = File.expand_path(__dir__).freeze
 
   I18n.enforce_available_locales = true
 
@@ -30,14 +30,10 @@ module Dummy
     config.secret_key_base = 'SECRET_KEY_BASE'
 
     if config.active_record.sqlite3.respond_to?(:represent_boolean_as_integer)
-      if Rails::VERSION::MAJOR < 6
-        config.active_record.sqlite3.represent_boolean_as_integer = true
-      end
+      config.active_record.sqlite3.represent_boolean_as_integer = true if Rails::VERSION::MAJOR < 6
     end
 
-    if Rails::VERSION::MAJOR >= 6
-      config.action_mailer.delivery_job = 'ActionMailer::MailDeliveryJob'
-    end
+    config.action_mailer.delivery_job = 'ActionMailer::MailDeliveryJob' if Rails::VERSION::MAJOR >= 6
 
     config.active_job.queue_adapter = :inline
 

data/spec/dummy/db/schema.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-ActiveRecord::Schema.define(version: 2020_01_01_00_00_00) do
+ActiveRecord::Schema.define do
   create_table 'subscription_items', force: true do |t|
     t.bigint 'subscription_id', null: false
     t.string 'stripe_id', null: false
@@ -9,7 +9,7 @@ ActiveRecord::Schema.define(version: 2020_01_01_00_00_00) do
     t.datetime 'created_at', precision: 6, null: false
     t.datetime 'updated_at', precision: 6, null: false
     t.index ['stripe_id'], name: 'index_subscription_items_on_stripe_id'
-    t.index ['subscription_id', 'stripe_plan'], name: 'index_subscription_items_on_subscription_id_and_stripe_plan', unique: true
+    t.index %w[subscription_id stripe_plan], name: 'index_subscription_items_on_subscription_id_and_stripe_plan', unique: true
   end
 
   create_table 'subscriptions', force: true do |t|
@@ -23,7 +23,7 @@ ActiveRecord::Schema.define(version: 2020_01_01_00_00_00) do
     t.timestamp 'ends_at'
     t.datetime 'created_at', precision: 6, null: false
     t.datetime 'updated_at', precision: 6, null: false
-    t.index ['user_id', 'stripe_status'], name: 'index_subscriptions_on_user_id_and_stripe_status'
+    t.index %w[user_id stripe_status], name: 'index_subscriptions_on_user_id_and_stripe_status'
   end
 
   create_table 'users', force: true do |t|
@@ -37,4 +37,3 @@ ActiveRecord::Schema.define(version: 2020_01_01_00_00_00) do
     t.index ['email'], name: 'index_users_on_email', unique: true
   end
 end
-