reji 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9ff3b5ea9665bfe6095a9ec7e30875db051e82db49173788d201257f8274212
-  data.tar.gz: 30e9965771a6c7d1c0bcd3f8171840ec7c884cdf77cbaa6804eee1c521883aa9
+  metadata.gz: d0fd54bad11be59354691fc0b267467a58817b3a45a1d1ff8a24ae373166bdb4
+  data.tar.gz: a42de1cba650a26285bd724cecb7eb45a8e8b26d9f0348e0c196714458df7abc
 SHA512:
-  metadata.gz: 4bd93a8d4f8ae5a2049e1ef62e8b0ddbb89773fb89725f7fc60f5194f33e4c6137a48dd989c6d8913fcb42e7d51545296f3ba269f9ba5218bce89f54eedb97e1
-  data.tar.gz: e22ad7b72c9d266da14d864921f4f1e4dff365b24d46490077e3af6153ffd08a8cde164d431bce0e948e7bb67720f3558bc31f6e0df8d379b625c3c0e198558b
+  metadata.gz: 1a9a5fa9844145bce066224e36ec817cea037a347816a1c87912b00ac75f32e8a19b186b5eb51cecfcf1673637fb8ce6d9a9a09102498b120fdea300f91dab86
+  data.tar.gz: ab820509b28366cf40545d2bc0ede969fef9f301e82e03fc49ec8c0c98e8b5014ab9bb2c254ecd01720e73c75f03969ee9e997c34dbbbff41ead1799c1d837e0

data/.gitignore

@@ -13,3 +13,4 @@ tmp/
 doc/
 .yardoc/
 coverage/
+Gemfile.lock

data/.rubocop.yml

@@ -0,0 +1,73 @@
+inherit_from: .rubocop_todo.yml
+
+require: rubocop-rails
+
+AllCops:
+  DisplayCopNames: true
+  TargetRubyVersion: 2.4
+
+Layout/CaseIndentation:
+  EnforcedStyle: end
+  IndentOneStep: true
+
+Layout/EmptyComment:
+  Enabled: false
+
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/LineLength:
+  Exclude:
+    - "spec/**/*.rb"
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Metrics/BlockLength:
+  Max: 40
+  Exclude:
+    # `context` in tests are blocks and get quite large, so exclude the test
+    # directory from having to adhere to this rule.
+    - "spec/**/*.rb"
+
+Metrics/ClassLength:
+  Exclude:
+    # Test classes get quite large, so exclude the test directory from having
+    # to adhere to this rule.
+    - "spec/**/*.rb"
+
+Metrics/MethodLength:
+  Max: 24
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Naming/AccessorMethodName:
+  Enabled: false
+
+Style/AccessModifierDeclarations:
+  EnforcedStyle: inline
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/NumericPredicate:
+  Enabled: false
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+
+Rails/ApplicationController:
+  Enabled: false
+
+Rails/ApplicationRecord:
+  Enabled: false
+
+Rails/ReflectionClassName:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,31 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2020-09-10 04:54:51 UTC using RuboCop version 0.90.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 6
+# Configuration parameters: IgnoredMethods.
+Metrics/AbcSize:
+  Max: 66
+
+# Offense count: 3
+# Configuration parameters: CountComments, CountAsOne.
+Metrics/ClassLength:
+  Max: 349
+
+# Offense count: 1
+# Configuration parameters: IgnoredMethods.
+Metrics/CyclomaticComplexity:
+  Max: 15
+
+# Offense count: 1
+# Configuration parameters: IgnoredMethods.
+Metrics/PerceivedComplexity:
+  Max: 16
+
+# Offense count: 30
+Style/Documentation:
+  Enabled: false

data/Appraisals

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 appraise 'rails_5.0' do
   gem 'railties', '~> 5.0'
   gem 'rspec-rails', '~> 3.1'

data/Gemfile

@@ -4,5 +4,5 @@ source 'https://rubygems.org'
 
 gemspec
 
-gem 'appraisal'
 gem 'pry', require: false
+gem 'rubocop-rails', require: false

data/README.md

@@ -95,6 +95,29 @@ rails db:migrate
 <a name="configuration"></a>
 ## Configuration
 
+All Reji configuration can be found in `config/initializers/reji.rb` file. You can change directly or update corresponding environment variables.
+
+```ruby
+Reji.configure do |config|
+  # Stripe Keys
+  config.key = ENV['STRIPE_KEY']
+  config.secret = ENV['STRIPE_SECRET']
+  
+  # Stripe Webhooks
+  config.webhook = {
+    secret: ENV['STRIPE_WEBHOOK_SECRET'],
+    tolerance: ENV['STRIPE_WEBHOOK_TOLERANCE'] || 300,
+  }
+  
+  # Reji Model
+  config.model = ENV['REJI_MODEL'] || 'User'
+  config.model_id = ENV['REJI_MODEL_ID'] || 'user_id'
+  
+  # Currency
+  config.currency = ENV['REJI_CURRENCY'] || 'usd'
+end
+```
+
 <a name="billable-model"></a>
 ### Billable Model
 
@@ -110,6 +133,7 @@ Reji assumes your Billable model will be the `User` class. If you wish to change
 
 ```sh
 REJI_MODEL=User
+REJI_MODEL_ID=user_id
 ```
 
 > If you're using a model other than `User` model, you'll need to publish and alter the [migrations](#installation) provided to match your alternative model's table name.
@@ -380,18 +404,18 @@ payment_method = user.find_payment_method(payment_method_id)
 <a name="check-for-a-payment-method"></a>
 ### Determining If A User Has A Payment Method
 
-To determine if a Billable model has a default payment method attached to their account, use the `has_default_payment_method` method:
+To determine if a Billable model has a default payment method attached to their account, use the `default_payment_method?` method:
 
 ```ruby
-if user.has_default_payment_method
+if user.default_payment_method?
   #
 end
 ```
 
-To determine if a Billable model has at least one payment method attached to their account, use the `has_payment_method` method:
+To determine if a Billable model has at least one payment method attached to their account, use the `payment_method?` method:
 
 ```ruby
-if user.has_payment_method
+if user.payment_method?
   #
 end
 ```
@@ -605,14 +629,14 @@ Reji::Subscription.recurring
 
 If a subscription requires a secondary payment action after creation the subscription will be marked as `incomplete`. Subscription statuses are stored in the `stripe_status` column of Reji's `subscriptions` database table.
 
-Similarly, if a secondary payment action is required when swapping plans the subscription will be marked as `past_due`. When your subscription is in either of these states it will not be active until the customer has confirmed their payment. Checking if a subscription has an incomplete payment can be done using the `has_incomplete_payment` method on the Billable model or a subscription instance:
+Similarly, if a secondary payment action is required when swapping plans the subscription will be marked as `past_due`. When your subscription is in either of these states it will not be active until the customer has confirmed their payment. Checking if a subscription has an incomplete payment can be done using the `incomplete_payment?` method on the Billable model or a subscription instance:
 
 ```ruby
-if user.has_incomplete_payment('default')
+if user.incomplete_payment?('default')
   #
 end
 
-if user.subscription('default').has_incomplete_payment
+if user.subscription('default').incomplete_payment?
   #
 end
 ```
@@ -846,9 +870,9 @@ The `tax_rates` method enables you to apply a tax rate on a model-by-model basis
 
 ```ruby
 def plan_tax_rates
-  [
+  {
     'plan-id' => ['tax-rate-id'],
-  ]
+  }
 end
 ```
 
@@ -866,12 +890,12 @@ This will also sync any subscription item tax rates so make sure you also proper
 
 #### Tax Exemption
 
-Reji also offers methods to determine if the customer is tax exempt by calling the Stripe API. The `is_not_tax_exempt`, `is_tax_exempt`, and `reverse_charge_applies` methods are available on the billable model:
+Reji also offers methods to determine if the customer is tax exempt by calling the Stripe API. The `not_tax_exempt?`, `tax_exempt?`, and `reverse_charge_applies` methods are available on the billable model:
 
 ```ruby
 user = User.find(1)
-user.is_tax_exempt
-user.is_not_tax_exempt
+user.tax_exempt?
+user.not_tax_exempt?
 user.reverse_charge_applies
 ```
 
@@ -885,7 +909,7 @@ By default, the billing cycle anchor is the date the subscription was created, o
 ```ruby
 user = User.find(1)
 
-anchor = Time.now.at_beginning_of_month.next_month
+anchor = Time.current.at_beginning_of_month.next_month
 
 user.new_subscription('default', 'price_premium')
   .anchor_billing_cycle_on(anchor.to_i)
@@ -953,7 +977,7 @@ The `trial_until` method allows you to provide a `Time` instance to specify when
 
 ```ruby
 user.new_subscription('default', 'price_monthly')
-  .trial_until(Time.now + 10.days)
+  .trial_until(Time.current + 10.days)
   .create(payment_method)
 ```
 
@@ -981,7 +1005,7 @@ If you would like to offer trial periods without collecting the user's payment m
 ```ruby
 user = User.create({
   # Populate other user properties...
-  :trial_ends_at => Time.now + 10.days,
+  :trial_ends_at => Time.current + 10.days,
 })
 ```
 
@@ -1016,12 +1040,12 @@ The `extend_trial` method allows you to extend the trial period of a subscriptio
 ```ruby
 # End the trial 7 days from now...
 subscription.extend_trial(
-  Time.now + 7.days
+  Time.current + 7.days
 )
 
 # Add an additional 5 days to the trial...
 subscription.extend_trial(
-  Time.at(subscription.trial_ends_at) + 5.days
+  Time.zone.at(subscription.trial_ends_at) + 5.days
 )
 ```
 

data/Rakefile

@@ -17,5 +17,11 @@ RSpec::Core::RakeTask.new('spec') do |task|
   task.verbose = false
 end
 
-desc 'Run the specs and acceptance tests'
-task default: %w(spec)
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new do |task|
+  task.requires << 'rubocop-rails'
+end
+
+desc 'Run the specs and rubocop'
+task default: %i[spec rubocop]

data/app/controllers/reji/payment_controller.rb

@@ -18,14 +18,14 @@ module Reji
       render template: 'payment'
     end
 
-    private
-
-    def verify_redirect_url
+    private def verify_redirect_url
       return if params[:redirect].blank?
 
       url = URI(params[:redirect])
 
-      raise ActionController::Forbidden.new('Redirect host mismatch.') if url.host.blank? || url.host != URI(request.original_url).host
+      return unless url.host.blank? || url.host != URI(request.original_url).host
+
+      raise ActionController::Forbidden, 'Redirect host mismatch.'
     end
   end
 end

data/app/controllers/reji/webhook_controller.rb

@@ -9,26 +9,23 @@ module Reji
 
       type = payload['type']
 
-      return self.missing_method if type.nil?
+      return missing_method if type.nil?
 
       method = "handle_#{payload['type'].gsub('.', '_')}"
 
-      self.respond_to?(method, true) ?
-        self.send(method, payload) :
-        self.missing_method
+      respond_to?(method, true) ? send(method, payload) : missing_method
     end
 
-    protected
-
     # Handle customer subscription updated.
-    def handle_customer_subscription_updated(payload)
-      user = self.get_user_by_stripe_id(payload.dig('data', 'object', 'customer'))
+    # rubocop:disable Metrics/MethodLength
+    protected def handle_customer_subscription_updated(payload)
+      user = get_user_by_stripe_id(payload.dig('data', 'object', 'customer'))
 
-      return self.success_method if user.nil?
+      return success_method if user.nil?
 
       data = payload.dig('data', 'object')
 
-      return self.success_method if data.nil?
+      return success_method if data.nil?
 
       user.subscriptions
         .select { |subscription| subscription.stripe_id == data['id'] }
@@ -37,7 +34,7 @@ module Reji
             subscription.items.destroy_all
             subscription.destroy
 
-            return self.success_method
+            return success_method
           end
 
           # Plan...
@@ -47,123 +44,115 @@ module Reji
           subscription.quantity = data['quantity']
 
           # Trial ending date...
-          unless data['trial_end'].nil?
+          if data['trial_end'].present?
             if subscription.trial_ends_at.nil? || subscription.trial_ends_at.to_i != data['trial_end']
-              subscription.trial_ends_at = Time.at(data['trial_end'])
+              subscription.trial_ends_at = Time.zone.at(data['trial_end'])
             end
           end
 
           # Cancellation date...
-          unless data['cancel_at_period_end'].nil?
-            if data['cancel_at_period_end']
-              subscription.ends_at = subscription.on_trial ?
-                subscription.trial_ends_at :
-                Time.at(data['cancel_at_period_end'])
+          subscription.ends_at =
+            if data['cancel_at_period_end'].blank?
+              nil
             else
-              subscription.ends_at = nil
+              (subscription.on_trial ? subscription.trial_ends_at : Time.zone.at(data['cancel_at_period_end']))
             end
-          end
 
           # Status...
-          unless data['status'].nil?
-            subscription.stripe_status = data['status']
-          end
+          subscription.stripe_status = data['status'] unless data['status'].nil?
 
           subscription.save
 
           # Update subscription items...
-          if data.key?('items')
-            plans = []
+          next unless data.key?('items')
 
-            items = data.dig('items', 'data')
+          plans = []
 
-            unless items.blank?
-              items.each do |item|
-                plans << item.dig('plan', 'id')
+          items = data.dig('items', 'data') || []
 
-                subscription_item = subscription.items.find_or_create_by({:stripe_id => item['id']}) do |subscription_item|
-                  subscription_item.stripe_plan = item.dig('plan', 'id')
-                  subscription_item.quantity = item['quantity']
-                end
-              end
-            end
+          items.each do |item|
+            plans << item.dig('plan', 'id')
 
-            # Delete items that aren't attached to the subscription anymore...
-            subscription.items.where('stripe_plan NOT IN (?)', plans).destroy_all
+            subscription.items.find_or_create_by({ stripe_id: item['id'] }) do |subscription_item|
+              subscription_item.stripe_plan = item.dig('plan', 'id')
+              subscription_item.quantity = item['quantity']
+            end
           end
+
+          # Delete items that aren't attached to the subscription anymore...
+          subscription.items.where('stripe_plan NOT IN (?)', plans).destroy_all
         end
 
-      self.success_method
+      success_method
     end
+    # rubocop:enable Metrics/MethodLength
 
     # Handle a cancelled customer from a Stripe subscription.
-    def handle_customer_subscription_deleted(payload)
-      user = self.get_user_by_stripe_id(payload.dig('data', 'object', 'customer'))
+    protected def handle_customer_subscription_deleted(payload)
+      user = get_user_by_stripe_id(payload.dig('data', 'object', 'customer'))
 
       unless user.nil?
         user.subscriptions
           .select { |subscription| subscription.stripe_id == payload.dig('data', 'object', 'id') }
-          .each { |subscription| subscription.mark_as_cancelled }
+          .each(&:mark_as_cancelled)
       end
 
-      self.success_method
+      success_method
     end
 
     # Handle customer updated.
-    def handle_customer_updated(payload)
-      user = self.get_user_by_stripe_id(payload.dig('data', 'object', 'id'))
+    protected def handle_customer_updated(payload)
+      user = get_user_by_stripe_id(payload.dig('data', 'object', 'id'))
 
-      user.update_default_payment_method_from_stripe unless user.nil?
+      user&.update_default_payment_method_from_stripe
 
-      self.success_method
+      success_method
     end
 
     # Handle deleted customer.
-    def handle_customer_deleted(payload)
-      user = self.get_user_by_stripe_id(payload.dig('data', 'object', 'id'))
+    protected def handle_customer_deleted(payload)
+      user = get_user_by_stripe_id(payload.dig('data', 'object', 'id'))
 
       unless user.nil?
         user.subscriptions.each { |subscription| subscription.skip_trial.mark_as_cancelled }
 
         user.update({
-          :stripe_id => nil,
-          :trial_ends_at => nil,
-          :card_brand => nil,
-          :card_last_four => nil,
+          stripe_id: nil,
+          trial_ends_at: nil,
+          card_brand: nil,
+          card_last_four: nil,
         })
       end
 
-      self.success_method
+      success_method
     end
 
     # Get the billable entity instance by Stripe ID.
-    def get_user_by_stripe_id(stripe_id)
+    protected def get_user_by_stripe_id(stripe_id)
       Reji.find_billable(stripe_id)
     end
 
     # Handle successful calls on the controller.
-    def success_method
-      render plain: 'Webhook Handled', status: 200
+    protected def success_method
+      render plain: 'Webhook Handled', status: :ok
     end
 
     # Handle calls to missing methods on the controller.
-    def missing_method
+    protected def missing_method
       head :ok
     end
 
-    private
-
-    def verify_webhook_signature
+    protected def verify_webhook_signature
       return if Reji.configuration.webhook[:secret].blank?
 
       begin
         Stripe::Webhook.construct_event(
           request.body.read,
           request.env['HTTP_STRIPE_SIGNATURE'],
-          Reji.configuration.webhook[:secret],
+          Reji.configuration.webhook[:secret]
         )
       rescue Stripe::SignatureVerificationError => e
-        raise AccessDeniedHttpError.new(e.message)
+        raise AccessDeniedHttpError, e.message
       end
     end
   end