stripe_model_callbacks 0.1.2 → 0.1.3

data/app/services/stripe_model_callbacks/sync_from_stripe.rb

@@ -0,0 +1,29 @@
+class StripeModelCallbacks::SyncFromStripe < StripeModelCallbacks::BaseService
+  attr_reader :stripe_object
+
+  def initialize(stripe_object:)
+    @stripe_object = stripe_object
+  end
+
+  def perform
+    model = model_class.find_by(stripe_id: stripe_object.id)
+
+    if model
+      model.stripe_object = stripe_object
+      model.assign_from_stripe(stripe_object)
+      model.save! if model.changed?
+    else
+      model = model_class.create_from_stripe!(stripe_object)
+    end
+
+    succeed!(model: model)
+  end
+
+  def model_class_name
+    @model_class_name ||= stripe_object.class.name.gsub("::", "")
+  end
+
+  def model_class
+    @model_class ||= model_class_name.safe_constantize
+  end
+end

data/app/services/stripe_model_callbacks/tax_rate/updated_service.rb

@@ -0,0 +1,27 @@
+class StripeModelCallbacks::TaxRate::UpdatedService < StripeModelCallbacks::BaseEventService
+  def perform
+    tax_rate.assign_from_stripe(object)
+
+    if tax_rate.save
+      create_activity if event
+      succeed! tax_rate
+    else
+      fail! tax_rate.errors.full_messages
+    end
+  end
+
+private
+
+  def create_activity
+    case event.type
+    when "tax_rate.created"
+      tax_rate.create_activity :created
+    when "tax_rate.updated"
+      tax_rate.create_activity :updated
+    end
+  end
+
+  def tax_rate
+    @tax_rate ||= StripeTaxRate.find_or_initialize_by(stripe_id: object.id)
+  end
+end

data/app/services/stripe_model_callbacks/transfer/updated_service.rb

@@ -1,5 +1,5 @@
 class StripeModelCallbacks::Transfer::UpdatedService < StripeModelCallbacks::BaseEventService
-  def execute
+  def perform
     transfer.assign_from_stripe(object)
 
     if transfer.save

data/db/migrate/20200317160513_add_auto_advance_and_billing_reason_to_stripe_invoices.rb

@@ -0,0 +1,6 @@
+class AddAutoAdvanceAndBillingReasonToStripeInvoices < ActiveRecord::Migration[5.2]
+  def change
+    add_column :stripe_invoices, :auto_advance, :boolean, default: false
+    add_column :stripe_invoices, :billing_reason, :string
+  end
+end

data/db/migrate/20200317160602_add_status_and_status_transitions_to_stripe_invoices.rb

@@ -0,0 +1,10 @@
+class AddStatusAndStatusTransitionsToStripeInvoices < ActiveRecord::Migration[5.2]
+  def change
+    add_column :stripe_invoices, :status, :string, default: "draft", nil: false
+
+    add_column :stripe_invoices, :finalized_at, :datetime
+    add_column :stripe_invoices, :marked_uncollectible_at, :datetime
+    add_column :stripe_invoices, :paid_at, :datetime
+    add_column :stripe_invoices, :voided_at, :datetime
+  end
+end

data/db/migrate/20200317180115_add_product_type_to_products.rb

@@ -0,0 +1,5 @@
+class AddProductTypeToProducts < ActiveRecord::Migration[6.0]
+  def change
+    add_column :stripe_products, :product_type, :string
+  end
+end

data/db/migrate/20200317181224_rename_stripe_invoices_application_fee_to_application_fee_amount.rb

@@ -0,0 +1,6 @@
+class RenameStripeInvoicesApplicationFeeToApplicationFeeAmount < ActiveRecord::Migration[6.0]
+  def change
+    rename_column :stripe_invoices, :application_fee_cents, :application_fee_amount_cents
+    rename_column :stripe_invoices, :application_fee_currency, :application_fee_amount_currency
+  end
+end

data/db/migrate/20200320105158_make_stripe_invoices_forgive_optional.rb

@@ -0,0 +1,5 @@
+class MakeStripeInvoicesForgiveOptional < ActiveRecord::Migration[6.0]
+  def change
+    change_column_null :stripe_invoices, :forgiven, true
+  end
+end

data/db/migrate/20200320114859_make_stripe_invoice_closed_optional.rb

@@ -0,0 +1,5 @@
+class MakeStripeInvoiceClosedOptional < ActiveRecord::Migration[6.0]
+  def change
+    change_column_null :stripe_invoices, :closed, true
+  end
+end

data/db/migrate/20200323143634_add_amount_paid_and_remaining_and_invoice_url_and_pdf.rb

@@ -0,0 +1,11 @@
+class AddAmountPaidAndRemainingAndInvoiceUrlAndPdf < ActiveRecord::Migration[6.0]
+  def change
+    add_column :stripe_invoices, :amount_paid_cents, :integer
+    add_column :stripe_invoices, :amount_paid_currency, :string
+    add_column :stripe_invoices, :amount_remaining_cents, :integer
+    add_column :stripe_invoices, :amount_remaining_currency, :string
+    add_column :stripe_invoices, :collection_method, :string
+    add_column :stripe_invoices, :hosted_invoice_url, :string
+    add_column :stripe_invoices, :invoice_pdf, :string
+  end
+end

data/db/migrate/20200331074940_add_unit_label_to_stripe_products.rb

@@ -0,0 +1,5 @@
+class AddUnitLabelToStripeProducts < ActiveRecord::Migration[6.0]
+  def change
+    add_column :stripe_products, :unit_label, :string
+  end
+end

data/db/migrate/20200331075241_add_metered_info_to_stripe_plans.rb

@@ -0,0 +1,9 @@
+class AddMeteredInfoToStripePlans < ActiveRecord::Migration[6.0]
+  def change
+    add_column :stripe_plans, :active, :boolean
+    add_column :stripe_plans, :aggregate_usage, :string
+    add_column :stripe_plans, :amount_decimal, :string
+    add_column :stripe_plans, :billing_scheme, :string
+    add_column :stripe_plans, :usage_type, :string
+  end
+end

data/db/migrate/20200513131105_create_stripe_subscription_schedules.rb

@@ -0,0 +1,31 @@
+class CreateStripeSubscriptionSchedules < ActiveRecord::Migration[6.0]
+  def change # rubocop:disable Metrics/AbcSize
+    create_table :stripe_subscription_schedules do |t|
+      t.string :stripe_id, index: {unique: true}, null: false
+      t.string :billing
+      t.integer :billing_thresholds_amount_gte
+      t.boolean :billing_thresholds_reset_billing_cycle_anchor
+      t.timestamp :canceled_at
+      t.string :collection_method
+      t.timestamp :completed_at
+      t.datetime :created
+      t.datetime :current_phase_start_date
+      t.datetime :current_phase_end_date
+      t.string :stripe_customer_id, index: true
+      t.string :default_payment_method
+      t.string :default_source
+      t.string :end_behavior
+      t.integer :invoice_settings_days_until_due
+      t.boolean :livemode
+      t.text :metadata
+      t.datetime :released_at
+      t.string :released_stripe_subscription_id
+      t.string :renewal_behavior
+      t.string :renewal_interval
+      t.string :status
+      t.string :stripe_subscription_id, index: true
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20200513131120_create_stripe_subscription_schedule_phases.rb

@@ -0,0 +1,21 @@
+class CreateStripeSubscriptionSchedulePhases < ActiveRecord::Migration[6.0]
+  def change
+    create_table :stripe_subscription_schedule_phases do |t|
+      t.string :stripe_subscription_schedule_id, index: {name: "index_subscription_schedule_phases_on_subscription_schedule_id"}, null: false
+      t.integer :application_fee_percent
+      t.integer :billing_thresholds_amount_gte
+      t.boolean :billing_thresholds_reset_billing_cycle_anchor
+      t.string :collection_method
+      t.string :stripe_coupon_id, index: true
+      t.string :default_payment_method
+      t.datetime :end_date
+      t.integer :invoice_settings_days_until_due
+      t.boolean :prorate
+      t.string :proration_behavior
+      t.datetime :start_date
+      t.datetime :trial_end
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20200513131640_create_stripe_subscription_schedule_phase_plans.rb

@@ -0,0 +1,13 @@
+class CreateStripeSubscriptionSchedulePhasePlans < ActiveRecord::Migration[6.0]
+  def change
+    create_table :stripe_subscription_schedule_phase_plans do |t|
+      t.string :stripe_subscription_schedule_phase_id, index: {name: "index_subscription_schedule_phase_plans_on_schedule_phase_id"}, null: false
+      t.integer :billing_thresholds_usage_gte
+      t.string :stripe_plan_id, index: {name: "index_subscription_schedule_phase_plans_on_stripe_plan_id"}
+      t.string :stripe_price_id, index: {name: "index_subscription_schedule_phase_plans_on_stripe_price_id"}
+      t.integer :quantity
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20200514132247_add_stripe_id_uniq_to_stripe_invoices.rb

@@ -0,0 +1,8 @@
+class AddStripeIdUniqToStripeInvoices < ActiveRecord::Migration[6.0]
+  disable_ddl_transaction!
+
+  def change
+    remove_index(:stripe_invoices, :stripe_id)
+    add_index(:stripe_invoices, :stripe_id, unique: true)
+  end
+end

data/db/migrate/20200520152604_change_stripe_subscription_schedule_phase_id_to_bigint.rb

@@ -0,0 +1,27 @@
+class ChangeStripeSubscriptionSchedulePhaseIdToBigint < ActiveRecord::Migration[6.0]
+  def change
+    if postgres?
+      change_column(
+        :stripe_subscription_schedule_phase_plans,
+        :stripe_subscription_schedule_phase_id,
+        "bigint USING stripe_subscription_schedule_phase_id::bigint"
+      )
+    elsif mysql?
+      change_column(
+        :stripe_subscription_schedule_phase_plans,
+        :stripe_subscription_schedule_phase_id,
+        "bigint USING CAST(stripe_subscription_schedule_phase_id AS bigint"
+      )
+    else
+      change_column :stripe_subscription_schedule_phase_plans, :stripe_subscription_schedule_phase_id, :bigint
+    end
+  end
+
+  def mysql?
+    ActiveRecord::Base.connection.adapter_name.downcase.include?("mysql")
+  end
+
+  def postgres?
+    %w[PostGIS Postgres].include?(ActiveRecord::Base.connection.adapter_name)
+  end
+end

data/db/migrate/20200529144649_add_latest_invoice_id_to_stripe_subscription.rb

@@ -0,0 +1,5 @@
+class AddLatestInvoiceIdToStripeSubscription < ActiveRecord::Migration[6.0]
+  def change
+    add_reference :stripe_subscriptions, :latest_stripe_invoice, type: :string, index: true
+  end
+end

data/db/migrate/20201223173035_rename_stripe_subscriptions_start_to_start_date.rb

@@ -0,0 +1,5 @@
+class RenameStripeSubscriptionsStartToStartDate < ActiveRecord::Migration[6.0]
+  def change
+    rename_column :stripe_subscriptions, :start, :start_date
+  end
+end

data/db/migrate/20201223202117_create_stripe_tax_rates.rb

@@ -0,0 +1,15 @@
+class CreateStripeTaxRates < ActiveRecord::Migration[6.0]
+  def change
+    create_table :stripe_tax_rates do |t|
+      t.string :stripe_id, index: true, null: false
+      t.string :display_name
+      t.text :description
+      t.string :jurisdiction
+      t.float :percentage
+      t.boolean :inclusive
+      t.boolean :active
+      t.timestamp :created
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20201224120534_create_stripe_subscription_default_tax_rates.rb

@@ -0,0 +1,9 @@
+class CreateStripeSubscriptionDefaultTaxRates < ActiveRecord::Migration[6.0]
+  def change
+    create_table :stripe_subscription_default_tax_rates do |t|
+      t.references :stripe_subscription, foreign_key: true, index: {name: "index_on_subscription"}, null: false
+      t.references :stripe_tax_rate, foreign_key: true, index: {name: "index_on_tax_rate"}, null: false
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20201224122058_create_stripe_prices.rb

@@ -0,0 +1,26 @@
+class CreateStripePrices < ActiveRecord::Migration[6.0]
+  def change
+    create_table :stripe_prices do |t|
+      t.string :stripe_id, index: true, null: false
+      t.datetime :deleted_at
+      t.boolean :active
+      t.string :billing_scheme
+      t.datetime :created
+      t.string :currency
+      t.string :lookup_key
+      t.jsonb :metadata
+      t.string :nickname
+      t.string :stripe_product_id, index: true
+      t.boolean :recurring_aggregate_usage
+      t.string :recurring_interval
+      t.integer :recurring_interval_count
+      t.string :recurring_usage_type
+      t.string :tiers_mode
+      t.integer :transform_quantity_divide_by
+      t.string :transform_quantity_round
+      t.string :price_type
+      t.integer :unit_amount
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20201224123838_add_stripe_price_to_stripe_subscription_items.rb

@@ -0,0 +1,6 @@
+class AddStripePriceToStripeSubscriptionItems < ActiveRecord::Migration[6.0]
+  def change
+    add_column :stripe_subscription_items, :stripe_price_id, :string
+    add_index :stripe_subscription_items, :stripe_price_id
+  end
+end

data/lib/stripe_model_callbacks/configuration.rb

@@ -1,6 +1,6 @@
 class StripeModelCallbacks::Configuration
   def self.current
-    @current ||= StripeModelCallbacks::Configuration.new
+    @current ||= new
   end
 
   def initialize

data/lib/stripe_model_callbacks/factories/stripe_coupons.rb

@@ -1,5 +1,21 @@
 FactoryBot.define do
   factory :stripe_coupon do
     sequence(:stripe_id) { |n| "stripe-coupon-#{n}" }
+
+    trait :with_stripe_mock do
+      duration { "repeating" }
+      duration_in_months { 1 }
+
+      after :create do |stripe_coupon|
+        mock_coupon = Stripe::Coupon.create(
+          duration: stripe_coupon.duration,
+          duration_in_months: stripe_coupon.duration_in_months,
+          id: stripe_coupon.stripe_id,
+          percent_off: stripe_coupon.percent_off
+        )
+        stripe_coupon.assign_from_stripe(mock_coupon)
+        stripe_coupon.save!
+      end
+    end
   end
 end

data/lib/stripe_model_callbacks/factories/stripe_plans.rb

@@ -4,12 +4,14 @@ FactoryBot.define do
     amount_cents { 10_000 }
     amount_currency { "USD" }
     currency { "usd" }
-    interval { "months" }
+    interval { "month" }
     interval_count { 1 }
     livemode { false }
     stripe_product
 
     trait :with_stripe_mock do
+      association :stripe_product, factory: [:stripe_product, :with_stripe_mock]
+
       after :create do |stripe_plan|
         mock_plan = Stripe::Plan.create(
           id: stripe_plan.stripe_id,

data/lib/stripe_model_callbacks/factories/stripe_prices.rb

@@ -0,0 +1,3 @@
+FactoryBot.define do
+  factory :stripe_price
+end

data/lib/stripe_model_callbacks/factories/stripe_products.rb

@@ -1,5 +1,18 @@
 FactoryBot.define do
   factory :stripe_product do
+    sequence(:name) { |n| "Stripe product #{n}" }
     sequence(:stripe_id) { |n| "stripe-product-#{n}" }
+
+    trait :with_stripe_mock do
+      after :create do |stripe_product|
+        mock_product = Stripe::Product.create(
+          id: stripe_product.stripe_id,
+          name: stripe_product.name,
+          type: "service"
+        )
+        stripe_product.assign_from_stripe(mock_product)
+        stripe_product.save!
+      end
+    end
   end
 end

data/lib/stripe_model_callbacks/factories/stripe_subscription_default_tax_rates.rb

@@ -0,0 +1,6 @@
+FactoryBot.define do
+  factory :stripe_subscription_default_tax_rate do
+    stripe_subscription
+    stripe_tax_rate
+  end
+end

data/lib/stripe_model_callbacks/factories/stripe_subscription_schedule.rb.rb

@@ -0,0 +1,5 @@
+FactoryBot.define do
+  factory :stripe_subscription_schedule do
+    sequence(:stripe_id) { |n| "stripe-subscription-schedule-#{n}" }
+  end
+end

data/lib/stripe_model_callbacks/factories/stripe_subscription_schedule_phase_plan.rb

@@ -0,0 +1,5 @@
+FactoryBot.define do
+  factory :stripe_subscription_schedule_phase_plan do
+    stripe_subscription_schedule_phase
+  end
+end

data/lib/stripe_model_callbacks/factories/stripe_subscription_schedule_phases.rb

@@ -0,0 +1,5 @@
+FactoryBot.define do
+  factory :stripe_subscription_schedule_phase do
+    stripe_subscription_schedule
+  end
+end

data/lib/stripe_model_callbacks/factories/stripe_subscriptions.rb

@@ -9,7 +9,7 @@ FactoryBot.define do
     stripe_customer
     livemode { false }
     stripe_plan
-    start { 1.month.ago.beginning_of_month }
+    start_date { 1.month.ago.beginning_of_month }
 
     trait :active do
       status { "active" }

data/lib/stripe_model_callbacks/factories/stripe_tax_rates.rb

@@ -0,0 +1,5 @@
+FactoryBot.define do
+  factory :stripe_tax_rate do
+    sequence(:stripe_id) { |n| "stripe-tax-rate-#{n}" }
+  end
+end

data/lib/stripe_model_callbacks/fixtures/stripe_events/customer/customer.subscription.created.2020-12-24.json

@@ -0,0 +1,112 @@
+{
+  "created": 1326853478,
+  "livemode": false,
+  "id": "evt_00000000000000",
+  "type": "customer.subscription.created",
+  "object": "event",
+  "request": null,
+  "pending_webhooks": 1,
+  "api_version": "2018-02-06",
+  "data": {
+    "object": {
+      "id": "sub_00000000000000",
+      "object": "subscription",
+      "application_fee_percent": null,
+      "billing": "charge_automatically",
+      "billing_cycle_anchor": 1517764446,
+      "billing_thresholds": null,
+      "cancel_at": null,
+      "cancel_at_period_end": false,
+      "canceled_at": 1517764476,
+      "collection_method": "charge_automatically",
+      "created": 1517764446,
+      "current_period_end": 1520183646,
+      "current_period_start": 1517764446,
+      "customer": "cus_00000000000000",
+      "days_until_due": null,
+      "default_payment_method": null,
+      "default_source": null,
+      "default_tax_rates": [
+        {
+          "id": "txr_1I1qD2AT5SYrvIfd69tAvJe2",
+          "object": "tax_rate",
+          "active": true,
+          "created": 1608802452,
+          "description": null,
+          "display_name": "VAT DK",
+          "inclusive": false,
+          "jurisdiction": null,
+          "livemode": false,
+          "metadata": {},
+          "percentage": 25.0
+        }
+      ],
+      "discount": null,
+      "ended_at": 1517764476,
+      "invoice_customer_balance_settings": {
+        "consume_applied_balance_on_void": true
+      },
+      "items": {
+        "object": "list",
+        "data": [
+          {
+            "id": "si_00000000000000",
+            "object": "subscription_item",
+            "billing_thresholds": null,
+            "created": 1517764446,
+            "metadata": {
+            },
+            "price": {
+              "id": "large_00000000000000",
+              "object": "price",
+              "active": true,
+              "billing_scheme": "per_unit",
+              "created": 1517762943,
+              "currency": "dkk",
+              "livemode": false,
+              "lookup_key": null,
+              "metadata": {
+              },
+              "nickname": null,
+              "product": "prod_00000000000000",
+              "recurring": {
+                "aggregate_usage": null,
+                "interval": "month",
+                "interval_count": 1,
+                "usage_type": "licensed"
+              },
+              "tiers_mode": null,
+              "transform_quantity": null,
+              "type": "recurring",
+              "unit_amount": 10000,
+              "unit_amount_decimal": "10000"
+            },
+            "quantity": 1,
+            "subscription": "sub_00000000000000",
+            "tax_rates": [
+            ]
+          }
+        ],
+        "has_more": false,
+        "url": "/v1/subscription_items?subscription=sub_CGNpFmtIMKpiIN"
+      },
+      "latest_invoice": "in_1GoYq1J3a8kmO8fmMn28KIy2",
+      "livemode": false,
+      "metadata": {
+      },
+      "next_pending_invoice_item_invoice": null,
+      "pause_collection": null,
+      "pending_invoice_item_interval": null,
+      "pending_setup_intent": null,
+      "pending_update": null,
+      "schedule": null,
+      "start": 1517764446,
+      "start_date": 1517764446,
+      "status": "canceled",
+      "tax_percent": null,
+      "transfer_data": null,
+      "trial_end": null,
+      "trial_start": null
+    }
+  }
+}

data/lib/stripe_model_callbacks/fixtures/stripe_events/customer/customer.subscription.created.json

@@ -54,6 +54,7 @@
         "total_count": 1,
         "url": "/v1/subscription_items?subscription=sub_CGPXJjUMVXBLSx"
       },
+      "latest_invoice": "in_1GoYq1J3a8kmO8fmMn28KIy2",
       "livemode": false,
       "metadata": {
       },

data/lib/stripe_model_callbacks/fixtures/stripe_events/customer/customer.subscription.deleted.json

@@ -47,7 +47,7 @@
               "trial_period_days": null
             },
             "quantity": 1,
-            "subscription": "sub_CGPlqkdRaAAkq4"
+            "subscription": "sub_00000000000000"
           }
         ],
         "has_more": false,
@@ -58,7 +58,7 @@
       "metadata": {
       },
       "plan": {
-        "id": "silver-express-898_00000000000000",
+        "id": "silver-express-898",
         "object": "plan",
         "amount": 999,
         "created": 1506381458,

data/lib/stripe_model_callbacks/fixtures/stripe_events/customer/customer.subscription.updated.json

@@ -73,7 +73,7 @@
         "trial_period_days": null
       },
       "quantity": 1,
-      "start": 1517772172,
+      "start_date": 1517772172,
       "status": "active",
       "tax_percent": null,
       "trial_end": null,

data/lib/stripe_model_callbacks/fixtures/stripe_events/customer/customer.updated.json

@@ -14,7 +14,7 @@
       "account_balance": 0,
       "created": 1517772278,
       "currency": "usd",
-      "default_source": null,
+      "default_source": "card_000000000",
       "delinquent": false,
       "description": null,
       "discount": null,

data/lib/stripe_model_callbacks/fixtures/stripe_events/invoice/invoice.created.json

@@ -12,12 +12,16 @@
       "id": "in_00000000000000",
       "object": "invoice",
       "amount_due": 3500,
-      "application_fee": null,
+      "amount_paid": 3500,
+      "amount_remaining": 0,
+      "application_fee_amount": null,
       "attempt_count": 1,
       "attempted": false,
+      "auto_advance": false,
       "billing": "charge_automatically",
+      "billing_reason": "subscription_create",
       "charge": "ch_00000000000000",
-      "closed": true,
+      "collection_method": "charge_automatically",
       "currency": "dkk",
       "customer": "cus_00000000000000",
       "date": 1517763745,
@@ -25,7 +29,6 @@
       "discount": null,
       "due_date": null,
       "ending_balance": 0,
-      "forgiven": false,
       "lines": {
         "data": [
           {
@@ -79,6 +82,13 @@
       "receipt_number": null,
       "starting_balance": 0,
       "statement_descriptor": null,
+      "status": "draft",
+      "status_transitions": {
+        "finalized_at": null,
+        "marked_uncollectible_at": null,
+        "paid_at": null,
+        "voided_at": null
+      },
       "subscription": "sub_00000000000000",
       "subtotal": 3500,
       "tax": null,