reji 1.0.0

data/lib/reji/subscription_builder.rb

@@ -0,0 +1,206 @@
+# frozen_string_literal: true
+
+module Reji
+  class SubscriptionBuilder
+    include Reji::InteractsWithPaymentBehavior
+    include Reji::Prorates
+
+    # Create a new subscription builder instance.
+    def initialize(owner, name, plans = [])
+      @owner = owner
+      @name = name
+      @trial_expires # 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.
+      @items = {}
+
+      plans = [plans] unless plans.instance_of? Array
+
+      plans.each { |plan| self.plan(plan) }
+    end
+
+    # Set a plan on the subscription builder.
+    def plan(plan, quantity = 1)
+      options = {
+        :plan => plan,
+        :quantity => quantity
+      }
+
+      tax_rates = self.get_plan_tax_rates_for_payload(plan)
+
+      options[:tax_rates] = tax_rates if tax_rates
+
+      @items[plan] = options
+
+      self
+    end
+
+    # 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
+
+        plan = @items.values[0][:plan]
+      end
+
+      self.plan(plan, quantity)
+    end
+
+    # Specify the number of days of the trial.
+    def trial_days(trial_days)
+      @trial_expires = Time.now + trial_days.days
+
+      self
+    end
+
+    # Specify the ending date of the trial.
+    def trial_until(trial_until)
+      @trial_expires = trial_until
+
+      self
+    end
+
+    # Force the trial to end immediately.
+    def skip_trial
+      @skip_trial = true
+
+      self
+    end
+
+    # Change the billing cycle anchor on a plan creation.
+    def anchor_billing_cycle_on(date)
+      @billing_cycle_anchor = date
+
+      self
+    end
+
+    # The coupon to apply to a new subscription.
+    def with_coupon(coupon)
+      @coupon = coupon
+
+      self
+    end
+
+    # The metadata to apply to a new subscription.
+    def with_metadata(metadata)
+      @metadata = metadata
+
+      self
+    end
+
+    # Add a new Stripe subscription to the Stripe model.
+    def add(customer_options = {}, subscription_options = {})
+      self.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)
+
+      payload = {:customer => customer.id}
+        .merge(self.build_payload)
+        .merge(subscription_options)
+
+      stripe_subscription = Stripe::Subscription.create(
+        payload,
+        @owner.stripe_options
+      )
+
+      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,
+      })
+
+      stripe_subscription.items.each do |item|
+        subscription.items.create({
+          :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
+
+      subscription
+    end
+
+    protected
+
+    # Get the Stripe customer instance for the current user and payment method.
+    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
+
+      customer
+    end
+
+    # Build the payload for subscription creation.
+    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,
+      }
+
+      tax_rates = self.get_tax_rates_for_payload
+
+      if tax_rates
+        payload[:default_tax_rates] = tax_rates
+
+        return payload
+      end
+
+      tax_percentage = self.get_tax_percentage_for_payload
+
+      payload[:tax_percent] = tax_percentage if tax_percentage
+
+      payload
+    end
+
+    # Get the trial ending date for the Stripe payload.
+    def get_trial_end_for_payload
+      return 'now' if @skip_trial
+
+      @trial_expires.to_i if @trial_expires
+    end
+
+    # Get the tax percentage for the Stripe payload.
+    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
+      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)
+      tax_rates = @owner.plan_tax_rates
+
+      unless tax_rates.empty?
+        tax_rates[plan] || nil
+      end
+    end
+  end
+end

data/lib/reji/subscription_item.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module Reji
+  class SubscriptionItem < ActiveRecord::Base
+    include Reji::InteractsWithPaymentBehavior
+    include Reji::Prorates
+
+    belongs_to :subscription
+
+    # Increment the quantity of the subscription item.
+    def increment_quantity(count = 1)
+      self.update_quantity(self.quantity + count)
+
+      self
+    end
+
+    # Increment the quantity of the subscription item, and invoice immediately.
+    def increment_and_invoice(count = 1)
+      self.always_invoice
+
+      self.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)
+
+      self
+    end
+
+    # Update the quantity of the subscription item.
+    def update_quantity(quantity)
+      self.subscription.guard_against_incomplete
+
+      stripe_subscription_item = self.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.save
+
+      self.update(quantity: quantity)
+
+      self.subscription.update(quantity: quantity) if self.subscription.has_single_plan
+
+      self
+    end
+
+    # Swap the subscription item to a new Stripe plan.
+    def swap(plan, options = {})
+      self.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)
+      }.merge(options)
+
+      item = Stripe::SubscriptionItem::update(
+        self.stripe_id,
+        options,
+        self.subscription.owner.stripe_options
+      )
+
+      self.update(stripe_plan: plan, quantity: item.quantity)
+
+      self.subscription.update(stripe_plan: plan, quantity: item.quantity) if self.subscription.has_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
+
+      self.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
+      )
+    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
+      )
+    end
+  end
+end

data/lib/reji/tax.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Reji
+  class Tax
+    def initialize(amount, currency, tax_rate)
+      @amount = amount
+      @currency = currency
+      @tax_rate = tax_rate
+    end
+
+    # Get the applied currency.
+    def currency
+      @currency
+    end
+
+    # Get the total tax that was paid (or will be paid).
+    def amount
+      self.format_amount(@amount)
+    end
+
+    # Get the raw total tax that was paid (or will be paid).
+    def raw_amount
+      @amount
+    end
+
+    # Determine if the tax is inclusive or not.
+    def is_inclusive
+      @tax_rate.inclusive
+    end
+
+    # Stripe::TaxRate
+    def tax_rate
+      @tax_rate
+    end
+
+    # Dynamically get values from the Stripe TaxRate.
+    def method_missing(key)
+      @tax_rate[key]
+    end
+
+    protected
+
+    # Format the given amount into a displayable currency.
+    def format_amount(amount)
+      Reji.format_amount(amount, @currency)
+    end
+  end
+end

data/lib/reji/version.rb

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

data/reji.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+$:.push File.expand_path('lib', __dir__)
+
+require 'reji/version'
+
+Gem::Specification.new do |s|
+  s.name = 'reji'
+  s.version = Reji::VERSION
+  s.author = ['Cuong Giang']
+  s.email = ['thaicuong.giang@gmail.com']
+  s.homepage = 'https://github.com/cuonggt/reji'
+  s.summary = "Reji provides an expressive, fluent interface to Stripe's subscription billing services."
+  s.description = "Reji provides an expressive, fluent interface to Stripe's subscription billing services."
+  s.license = 'MIT'
+
+  s.required_ruby_version = Gem::Requirement.new('>= 2.4.0')
+
+  s.files = `git ls-files`.split("\n")
+  s.require_paths = ['lib']
+  s.test_files = `git ls-files -- {spec}/*`.split("\n")
+
+  s.add_dependency 'stripe', '>= 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 'wicked_pdf'
+  s.add_dependency 'wkhtmltopdf-binary'
+  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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+class User < ActiveRecord::Base
+  include Reji::Billable
+
+  def tax_rates
+    @tax_rates || {}
+  end
+
+  def plan_tax_rates
+    @plan_tax_rates || {}
+  end
+
+  def plan_tax_rates=(value)
+    @plan_tax_rates = value
+  end
+
+  def tax_rates=(value)
+    @tax_rates = value
+  end
+end

data/spec/dummy/application.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'rails/all'
+require 'reji'
+
+module Dummy
+  APP_ROOT = File.expand_path('..', __FILE__).freeze
+
+  I18n.enforce_available_locales = true
+
+  class Application < Rails::Application
+    config.action_controller.allow_forgery_protection = false
+    config.action_controller.perform_caching = false
+    config.action_dispatch.show_exceptions = false
+    config.action_mailer.default_url_options = { host: 'dummy.example.com' }
+    config.action_mailer.delivery_method = :test
+    config.active_support.deprecation = :stderr
+    config.active_support.test_order = :random
+    config.cache_classes = true
+    config.consider_all_requests_local = true
+    config.eager_load = false
+    config.encoding = 'utf-8'
+    config.paths['app/controllers'] << "#{APP_ROOT}/app/controllers"
+    config.paths['app/models'] << "#{APP_ROOT}/app/models"
+    config.paths['app/views'] << "#{APP_ROOT}/app/views"
+    config.paths['config/database'] = "#{APP_ROOT}/config/database.yml"
+    config.paths['log'] = 'tmp/log/development.log'
+
+    config.paths.add 'config/routes.rb', with: "#{APP_ROOT}/config/routes.rb"
+    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
+    end
+
+    if Rails::VERSION::MAJOR >= 6
+      config.action_mailer.delivery_job = 'ActionMailer::MailDeliveryJob'
+    end
+
+    config.active_job.queue_adapter = :inline
+
+    def require_environment!
+      initialize!
+    end
+
+    def initialize!(&block)
+      FileUtils.mkdir_p(Rails.root.join('db').to_s)
+      super unless @initialized
+    end
+  end
+end