bullet_train 1.0.81 → 1.0.86

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e07a863ffd021a1e4da0bf8e18e68fb9e357d90264d5a0d0d92770363f48390c
-  data.tar.gz: be20709eb91a25d64c9ef4371326cb56cc9b938b34bbb2e80db8ad21396d085c
+  metadata.gz: 849a48985baf2ad6e8e2fec56d4fabaad5bf1218012ee46c3af717b6c2328a61
+  data.tar.gz: ca355a5d67e5caf57159e4dcf9592b375bd492d96e53783c753a75d1230c0dc7
 SHA512:
-  metadata.gz: 1f887941fdeb2c3cb567b7011a1ff7edbf47558bc362d4b714c8a0d6ea6d4da922ac4d3eccc16c01c384ed9773eacc3f1b84ed3aadcf41adc7fd5d692b9ff0b4
-  data.tar.gz: bd70518110d78e2c7d455fa314a70a874fc6d82b109c28188098b7ef91701af31c85ae9eb7be5f1dbff67b95e8c91005c4babb89179b2cbbc2bda7a0bd38254a
+  metadata.gz: b9be5e8da59d9d4a95a03d369500ebda69b40d2344f5a73015a77cd1fc29eeafc3a5c34f39086dc8af2b647093d17f9aea84b9f8c963b168b465d96ef1d17eab
+  data.tar.gz: e1d61f2ab4e6836e7fdb07c9fc79a3303a1a103ca8846cf630008718b6d7b7e1b93367e6a55f9949c2c9c731d0e69602c821f3449c1a35de3346bf4c3a3f996e

data/app/assets/javascripts/bullet-train.js

@@ -0,0 +1,2 @@
+import{Controller as e}from"@hotwired/stimulus";function t(e){const t=(e.match(/^(?:\.\/)?(.+)(?:[_-]controller\..+?)$/)||[])[1];if(t)return t.replace(/_/g,"-").replace(/\//g,"--")}class i extends e{copy(){this.inputTarget.value=this.sourceTarget.innerText,this.inputTarget.select(),document.execCommand("copy"),this.buttonTarget.innerHTML='<i id="copied" class="fas fa-check w-4 h-4 block text-green-600"></i>',setTimeout(function(){document.getElementById("copied").innerHTML='<i class="far fa-copy w-4 h-4 block text-gray-600"></i>'},1500)}}i.targets=["source","input","button"];class r extends e{constructor(){super(...arguments),this.removeTrailingNewlines=e=>{e.element.innerHTML.match(/<br><\/div>$/)&&(e.element.innerHTML=e.element.innerHTML.slice(0,-10)+"</div>",this.removeTrailingNewlines(e))},this.removeTrailingWhitespace=e=>{e.element.innerHTML.match(/&nbsp;<\/div>$/)?(e.element.innerHTML=e.element.innerHTML.slice(0,-12)+"</div>",this.removeTrailingWhitespace(e)):e.element.innerHTML.match(/&nbsp; <\/div>$/)&&(e.element.innerHTML=e.element.innerHTML.slice(0,-13)+"</div>",this.removeTrailingWhitespace(e))}}resetOnSuccess(e){e.detail.success&&e.target.reset()}stripTrix(){this.trixFieldTargets.forEach(e=>{this.removeTrailingNewlines(e.editor),this.removeTrailingWhitespace(e.editor),e.parentElement.querySelector("input").value=e.innerHTML})}submitOnReturn(e){if((e.metaKey||e.ctrlKey)&&13==e.keyCode){e.preventDefault();let t=e.target.closest("form");this.submitForm(t)}}submitForm(e){e.requestSubmit?e.requestSubmit():e.querySelector("[type=submit]").click()}}r.targets=["trixField","scroll"];class s extends e{toggle(){const e=this.isWrapperHidden?this.showEventNameValue:this.hideEventNameValue;this.isWrapperHidden&&this.showWrapper(),this.wrapperTarget.dispatchEvent(new CustomEvent(e))}get isWrapperHidden(){return this.wrapperTarget.classList.contains(this.hiddenClass)}showWrapper(){this.wrapperTarget.classList.remove(this.hiddenClass)}hideWrapper(){this.wrapperTarget.classList.add(this.hiddenClass)}}s.targets=["wrapper"],s.classes=["hidden"],s.values={showEventName:String,hideEventName:String};const n=[[i,"clipboard_controller.js"],[r,"form_controller.js"],[s,"mobile_menu_controller.js"]].map(function(e){const i=e[0];return{identifier:t(e[1]),controllerConstructor:i}});document.addEventListener("turbo:load",()=>{navigator.userAgent.toLocaleLowerCase().includes("electron")&&document.body.classList.add("electron")});export{n as controllerDefinitions};
+//# sourceMappingURL=bullet-train.js.map

data/app/assets/javascripts/bullet-train.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bullet-train.js","sources":["../../../node_modules/@hotwired/stimulus-webpack-helpers/dist/stimulus-webpack-helpers.js","../../javascript/controllers/clipboard_controller.js","../../javascript/controllers/form_controller.js","../../javascript/controllers/mobile_menu_controller.js","../../javascript/controllers/index.js","../../javascript/electron/index.js"],"sourcesContent":["/*\nStimulus Webpack Helpers 1.0.0\nCopyright © 2021 Basecamp, LLC\n */\nfunction definitionsFromContext(context) {\n    return context.keys()\n        .map((key) => definitionForModuleWithContextAndKey(context, key))\n        .filter((value) => value);\n}\nfunction definitionForModuleWithContextAndKey(context, key) {\n    const identifier = identifierForContextKey(key);\n    if (identifier) {\n        return definitionForModuleAndIdentifier(context(key), identifier);\n    }\n}\nfunction definitionForModuleAndIdentifier(module, identifier) {\n    const controllerConstructor = module.default;\n    if (typeof controllerConstructor == \"function\") {\n        return { identifier, controllerConstructor };\n    }\n}\nfunction identifierForContextKey(key) {\n    const logicalName = (key.match(/^(?:\\.\\/)?(.+)(?:[_-]controller\\..+?)$/) || [])[1];\n    if (logicalName) {\n        return logicalName.replace(/_/g, \"-\").replace(/\\//g, \"--\");\n    }\n}\n\nexport { definitionForModuleAndIdentifier, definitionForModuleWithContextAndKey, definitionsFromContext, identifierForContextKey };\n","import { Controller } from \"@hotwired/stimulus\"\n\nexport default class extends Controller {\n  static targets = ['source', 'input', 'button']\n\n  copy() {\n    this.inputTarget.value = this.sourceTarget.innerText\n    this.inputTarget.select()\n    document.execCommand('copy')\n    this.buttonTarget.innerHTML = '<i id=\"copied\" class=\"fas fa-check w-4 h-4 block text-green-600\"></i>'\n    setTimeout(function () {\n      document.getElementById('copied').innerHTML = '<i class=\"far fa-copy w-4 h-4 block text-gray-600\"></i>'\n    }, 1500)\n  }\n}\n","import { Controller } from \"@hotwired/stimulus\"\n\n// TODO Some of this feels really specific to the conversation messages form. Should we rename this controller?\nexport default class extends Controller {\n  static targets = ['trixField', 'scroll']\n\n  resetOnSuccess(e){\n    if(e.detail.success) {\n      e.target.reset();\n    }\n  }\n\n  stripTrix(){\n    this.trixFieldTargets.forEach(element => {\n      this.removeTrailingNewlines(element.editor)\n      this.removeTrailingWhitespace(element.editor)\n      // When doing this as part of the form submission, Trix does not update the input element's value attribute fast enough.\n      // In order to submit the stripped value, we manually update it here to fix the race condition\n      element.parentElement.querySelector(\"input\").value = element.innerHTML\n    })\n  }\n\n  submitOnReturn(e) {\n    if((e.metaKey || e.ctrlKey) &&  e.keyCode == 13) {\n      e.preventDefault();\n      let form = e.target.closest(\"form\")\n      this.submitForm(form)\n    }\n  }\n\n  removeTrailingNewlines = (trixEditor) => {\n    if (trixEditor.element.innerHTML.match(/<br><\\/div>$/)) {\n      trixEditor.element.innerHTML = trixEditor.element.innerHTML.slice(0, -10) + \"</div>\"\n      this.removeTrailingNewlines(trixEditor)\n    }\n  }\n\n  removeTrailingWhitespace = (trixEditor) => {\n    if (trixEditor.element.innerHTML.match(/&nbsp;<\\/div>$/)) {\n      trixEditor.element.innerHTML = trixEditor.element.innerHTML.slice(0, -12) + \"</div>\"\n      this.removeTrailingWhitespace(trixEditor)\n    } else if (trixEditor.element.innerHTML.match(/&nbsp; <\\/div>$/)) {\n      trixEditor.element.innerHTML = trixEditor.element.innerHTML.slice(0, -13) + \"</div>\"\n      this.removeTrailingWhitespace(trixEditor)\n    }\n  }\n\n  submitForm(form) {\n    // Right now, Safari and IE don't support the requestSubmit method which is required for Turbo\n    // Doing form.submit() doesn't actually fire the submit event which Turbo needs\n    if (form.requestSubmit) {\n      form.requestSubmit()\n    } else {\n      form.querySelector(\"[type=submit]\").click()\n    }\n  }\n}\n","import { Controller } from \"@hotwired/stimulus\"\n\nexport default class extends Controller {\n  static targets = [ \"wrapper\"]\n  static classes = [ \"hidden\" ] // necessary because stimulus-reveal will mess with the [hidden] attribute on the wrapper\n  static values = {\n    showEventName: String,\n    hideEventName: String,\n  }\n\n  toggle() {\n    const eventName = this.isWrapperHidden? this.showEventNameValue: this.hideEventNameValue\n    if (this.isWrapperHidden) {\n      this.showWrapper()\n    }\n    \n    this.wrapperTarget.dispatchEvent(new CustomEvent(eventName))\n  }\n  \n  get isWrapperHidden() {\n    return this.wrapperTarget.classList.contains(this.hiddenClass)\n  }\n  \n  showWrapper() {\n    this.wrapperTarget.classList.remove(this.hiddenClass)\n  }\n  \n  hideWrapper() {\n    this.wrapperTarget.classList.add(this.hiddenClass)\n  }\n}","import { identifierForContextKey } from \"@hotwired/stimulus-webpack-helpers\"\n\nimport ClipboardController from './clipboard_controller'\nimport FormController from './form_controller'\nimport MobileMenuController from './mobile_menu_controller'\n\nexport const controllerDefinitions = [\n  [ClipboardController, 'clipboard_controller.js'],\n  [FormController, 'form_controller.js'],\n  [MobileMenuController, 'mobile_menu_controller.js'],\n].map(function(d) {\n  const key = d[1]\n  const controller = d[0]\n  return {\n    identifier: identifierForContextKey(key),\n    controllerConstructor: controller\n  }\n})\n","document.addEventListener(\"turbo:load\", () => {\n  if (navigator.userAgent.toLocaleLowerCase().includes('electron')) {\n    document.body.classList.add('electron')\n  }\n})"],"names":["identifierForContextKey","key","logicalName","match","replace","Controller","copy","this","inputTarget","value","sourceTarget","innerText","select","document","execCommand","buttonTarget","innerHTML","setTimeout","getElementById","targets","removeTrailingNewlines","trixEditor","element","slice","removeTrailingWhitespace","resetOnSuccess","e","detail","success","target","reset","stripTrix","trixFieldTargets","forEach","editor","parentElement","querySelector","submitOnReturn","metaKey","ctrlKey","keyCode","preventDefault","form","closest","submitForm","requestSubmit","click","toggle","eventName","isWrapperHidden","showEventNameValue","hideEventNameValue","showWrapper","wrapperTarget","dispatchEvent","CustomEvent","classList","contains","hiddenClass","remove","hideWrapper","add","classes","values","showEventName","String","hideEventName","controllerDefinitions","ClipboardController","FormController","MobileMenuController","map","d","controller","identifier","controllerConstructor","addEventListener","navigator","userAgent","toLocaleLowerCase","includes","body"],"mappings":"gDAqBA,SAASA,EAAwBC,GAC7B,MAAMC,GAAeD,EAAIE,MAAM,2CAA6C,IAAI,GAChF,GAAID,EACA,OAAOA,EAAYE,QAAQ,KAAM,KAAKA,QAAQ,MAAO,sBCtBhCC,EAG3BC,OACEC,KAAKC,YAAYC,MAAQF,KAAKG,aAAaC,UAC3CJ,KAAKC,YAAYI,SACjBC,SAASC,YAAY,QACrBP,KAAKQ,aAAaC,UAAY,wEAC9BC,WAAW,WACTJ,SAASK,eAAe,UAAUF,UAAY,2DAC7C,SATEG,QAAU,CAAC,SAAU,QAAS,0BCAVd,yCA2B3Be,uBAA0BC,IACpBA,EAAWC,QAAQN,UAAUb,MAAM,kBACrCkB,EAAWC,QAAQN,UAAYK,EAAWC,QAAQN,UAAUO,MAAM,GAAI,IAAM,SAC5EhB,KAAKa,uBAAuBC,UAIhCG,yBAA4BH,IACtBA,EAAWC,QAAQN,UAAUb,MAAM,mBACrCkB,EAAWC,QAAQN,UAAYK,EAAWC,QAAQN,UAAUO,MAAM,GAAI,IAAM,SAC5EhB,KAAKiB,yBAAyBH,IACrBA,EAAWC,QAAQN,UAAUb,MAAM,qBAC5CkB,EAAWC,QAAQN,UAAYK,EAAWC,QAAQN,UAAUO,MAAM,GAAI,IAAM,SAC5EhB,KAAKiB,yBAAyBH,KArClCI,eAAeC,GACVA,EAAEC,OAAOC,SACVF,EAAEG,OAAOC,QAIbC,YACExB,KAAKyB,iBAAiBC,QAAQX,IAC5Bf,KAAKa,uBAAuBE,EAAQY,QACpC3B,KAAKiB,yBAAyBF,EAAQY,QAGtCZ,EAAQa,cAAcC,cAAc,SAAS3B,MAAQa,EAAQN,YAIjEqB,eAAeX,GACb,IAAIA,EAAEY,SAAWZ,EAAEa,UAA0B,IAAbb,EAAEc,QAAe,CAC/Cd,EAAEe,iBACF,IAAIC,EAAOhB,EAAEG,OAAOc,QAAQ,QAC5BpC,KAAKqC,WAAWF,IAqBpBE,WAAWF,GAGLA,EAAKG,cACPH,EAAKG,gBAELH,EAAKN,cAAc,iBAAiBU,WAjDjC3B,QAAU,CAAC,YAAa,0BCFJd,EAQ3B0C,SACE,MAAMC,EAAYzC,KAAK0C,gBAAiB1C,KAAK2C,mBAAoB3C,KAAK4C,mBAClE5C,KAAK0C,iBACP1C,KAAK6C,cAGP7C,KAAK8C,cAAcC,cAAc,IAAIC,YAAYP,IAG/CC,sBACF,YAAYI,cAAcG,UAAUC,SAASlD,KAAKmD,aAGpDN,cACE7C,KAAK8C,cAAcG,UAAUG,OAAOpD,KAAKmD,aAG3CE,cACErD,KAAK8C,cAAcG,UAAUK,IAAItD,KAAKmD,gBAzBjCvC,QAAU,CAAE,aACZ2C,QAAU,CAAE,YACZC,OAAS,CACdC,cAAeC,OACfC,cAAeD,QCDNE,MAAAA,EAAwB,CACnC,CAACC,EAAqB,2BACtB,CAACC,EAAgB,sBACjB,CAACC,EAAsB,8BACvBC,IAAI,SAASC,GACb,MACMC,EAAaD,EAAE,GACrB,MAAO,CACLE,WAAY1E,EAHFwE,EAAE,IAIZG,sBAAuBF,KCf3B5D,SAAS+D,iBAAiB,aAAc,KAClCC,UAAUC,UAAUC,oBAAoBC,SAAS,aACnDnE,SAASoE,KAAKzB,UAAUK,IAAI"}

data/app/controllers/concerns/account/controllers/base.rb

@@ -5,6 +5,10 @@ module Account::Controllers::Base
     include LoadsAndAuthorizesResource
     include Fields::ControllerSupport
 
+    if billing_enabled?
+      include Billing::ControllerSupport
+    end
+
     before_action :set_last_seen_at, if: proc {
       user_signed_in? && (current_user.last_seen_at.nil? || current_user.last_seen_at < 1.minute.ago)
     }
@@ -106,6 +110,11 @@ module Account::Controllers::Base
         end
       end
 
+      # TODO Maybe in this context we should check whether `Billing::ControllerSupport` is included instead of just defined?
+      if defined?(Billing::ControllerSupport)
+        enforce_billing_requirements
+        # See `app/controllers/concerns/billing_support.rb` for details.
+      end
     end
 
     true

data/app/helpers/base_helper.rb

@@ -1,6 +1,10 @@
 module BaseHelper
   # TODO This is for the billing package to override, but I feel like there has got to be a better way to do this.
   def hide_team_resource_menus?
-    false
+    if billing_enabled?
+      current_team.needs_billing_subscription?
+    else
+      false
+    end
   end
 end

data/app/models/concerns/memberships/base.rb

@@ -29,6 +29,11 @@ module Memberships::Base
     scope :current_and_invited, -> { includes(:invitation).where("user_id IS NOT NULL OR invitations.id IS NOT NULL").references(:invitation) }
     scope :current, -> { where("user_id IS NOT NULL") }
     scope :tombstones, -> { includes(:invitation).where("user_id IS NULL AND invitations.id IS NULL").references(:invitation) }
+
+    # TODO Probably we can provide a way for gem packages to define these kinds of extensions.
+    if billing_enabled?
+      scope :billable, -> { current }
+    end
   end
 
   def name

data/app/models/concerns/records/base.rb

@@ -28,6 +28,14 @@ module Records::Base
     scope :newest_updated, -> { order("updated_at DESC") }
     scope :oldest_updated, -> { order("updated_at ASC") }
 
+    # TODO Probably we can provide a way for gem packages to define these kinds of extensions.
+    if billing_enabled?
+      # By default, any model in a collection is considered active for billing purposes.
+      # This can be overloaded in the child model class to specify more specific criteria for billing.
+      # See `app/models/concerns/memberships/base.rb` for an example.
+      scope :billable, -> { order("TRUE") }
+    end
+
     # Microscope adds useful scopes targeting ActiveRecord `boolean`, `date` and `datetime` attributes.
     # https://github.com/mirego/microscope
     acts_as_microscope

data/app/models/concerns/teams/base.rb

@@ -18,6 +18,17 @@ module Teams::Base
     # integrations
     has_many :integrations_stripe_installations, class_name: "Integrations::StripeInstallation", dependent: :destroy if stripe_enabled?
 
+    # TODO Probably we can provide a way for gem packages to define these kinds of extensions.
+    if billing_enabled?
+      # subscriptions
+      has_many :billing_subscriptions, class_name: "Billing::Subscription", dependent: :destroy, foreign_key: :team_id
+
+      # TODO We need a way for `bullet_train-billing-stripe` to define these.
+      if defined?(Billing::Stripe::Subscription)
+        has_many :billing_stripe_subscriptions, class_name: "Billing::Stripe::Subscription", dependent: :destroy, foreign_key: :team_id
+      end
+    end
+
     # validations
     validates :name, presence: true
     validates :time_zone, inclusion: {in: ActiveSupport::TimeZone.all.map(&:name)}, allow_nil: true
@@ -48,4 +59,12 @@ module Teams::Base
     # generic functions need to function for a team model as well, so we do this.
     self
   end
+
+  # TODO Probably we can provide a way for gem packages to define these kinds of extensions.
+  if billing_enabled?
+    def needs_billing_subscription?
+      return false if freemium_enabled?
+      billing_subscriptions.active.empty?
+    end
+  end
 end

data/app/views/layouts/docs.html.erb

@@ -32,7 +32,7 @@
     <meta property="og:url" content="<%= request.base_url + request.path %>" />
     <meta property="og:description" content="<%= description.truncate(200) %>" />
   </head>
-  <body class="bg-light-blue-gradient text-gray-700 text-sm font-normal dark:bg-dark-blue-gradient dark:text-sealBlue-900">
+  <body class="bg-light-gradient text-gray-700 text-sm font-normal dark:bg-dark-gradient dark:text-darkPrimary-300">
     <div class="md:p-5">
       <div class="h-screen md:h-auto overflow-hidden md:rounded-lg flex shadow"
         data-controller="mobile-menu"
@@ -295,7 +295,7 @@
               data-transition-leave-start="translate-x-0"
               data-transition-leave-end="-translate-x-full"
 
-              class="relative flex-1 flex flex-col max-w-xs w-full shadow-xl bg-gradient-to-b from-vividBlue-700 to-vividBlue-800 dark:from-sealBlue-200 dark:to-sealBlue-200"
+              class="relative flex-1 flex flex-col max-w-xs w-full pb-4 bg-dark-gradient shadow-xl"
             >
               <%= menu %>
             </div>
@@ -303,13 +303,13 @@
           </div>
         </div>
 
-        <div class="hidden lg:flex lg:flex-shrink-0 bg-gradient-to-b from-vividBlue-700 to-vividBlue-800 dark:from-sealBlue-200 dark:to-sealBlue-200">
+        <div class="hidden lg:flex lg:flex-shrink-0 overflow-y-auto bg-gradient-to-b from-primary-700 to-primary-800 dark:from-darkPrimary-800 dark:to-darkPrimary-800">
           <div class="w-64">
             <%= menu %>
           </div>
         </div>
 
-        <div class="flex flex-col w-0 flex-1 overflow-hidden bg-gray-100 dark:bg-sealBlue-200 lg:border-l dark:border-gray-500">
+        <div class="flex flex-col w-0 flex-1 overflow-y-auto bg-gray-100 dark:bg-darkPrimary-800 lg:border-l dark:border-gray-500">
           <main class="flex-1 relative z-0 overflow-y-auto focus:outline-none" tabindex="0">
 
             <button class="lg:hidden h-12 w-12 ml-1 flex-none inline-flex items-center justify-center rounded-md text-gray-500 hover:text-gray-900 focus:outline-none focus:ring-2 focus:ring-inset focus:ring-blue"

data/config/locales/en/billing/products.en.yml

@@ -0,0 +1,17 @@
+en:
+  billing/products:
+    free:
+      name: Free
+    basic:
+      name: Basic
+      description: This is an example plan that includes a free trial when paid for monthly.
+      features:
+        - Demonstrates pricing per team member.
+        - Allows creation of up to fifty "Creative Concepts".
+        - Soft enforcement that limit.
+    pro:
+      name: Pro
+      description: An improved example plan that demonstrates different features.
+      features:
+        - Demonstrates a fixed price for up to ten team members.
+        - Allows creation of an unlimited number of "Creative Concepts".

data/docs/billing/stripe.md

@@ -1,81 +1,122 @@
-# Enabling Stripe Subscriptions
+# Bullet Train Billing for Stripe
 
-Bullet Train provides a base billing package and a Stripe-specific package with support for Stripe Checkout, Stripe Billing's customer portal, and incoming Stripe webhooks.
+When you're ready to start billing customers for the product you've created with Bullet Train, you can take advantage of our streamlined, commercial billing package that includes a traditional SaaS pricing page powered by Yaml configuration for products and prices.
 
-## 1. Add the `bullet_train-billing-stripe` Ruby gem.
+We also provide a Stripe-specific adapter package with support for auto-configuring those products and prices in your Stripe account. It also takes advantage of completely modern Stripe workflows, like allowing customers to purchase your product with Stripe Checkout and later manage their subscription using Stripe Billing's customer portal. It also automatically handles incoming Stripe webhooks as well, to keep subscription state in your application up-to-date with activity that has happened on Stripe's platform.
 
-> TODO Add instructions about subscribing to Bullet Train Pro.
+## 1. Purchase Bullet Train Billing for Stripe
 
-## 2. Migrate the Database
+First, [purchase Bullet Train Billing for Stripe](https://buy.stripe.com/28o8zg4dBbrd59u7sM). Once you've completed this process, you'll be issued a private token for the Bullet Train Pro package server. (This process is currently completed manually, so please be patient.)
+
+## 2. Install the Package
+
+### 2.1. Add the Private Ruby Gems
+
+You'll need to specify both Ruby gems in your `Gemfile`, since we have to specify a private source for both:
+
+```
+source "https://YOUR_TOKEN_HERE@gem.fury.io/bullettrain" do
+  gem "bullet_train-billing"
+  gem "bullet_train-billing-stripe"
+end
+```
+
+### 2.2. Bundle Install
+
+```
+bundle install
+```
+
+### 2.3. Copy Database Migrations
+
+Use the following two commands on your shell to copy the required migrations into your local project:
+
+```
+cp `bundle show --paths | grep bullet_train-billing | sort | head -n 1`/db/migrate/* db/migrate
+cp `bundle show --paths | grep bullet_train-billing-stripe | sort | head -n 1`/db/migrate/* db/migrate
+```
+
+Note this is different than how many Rails engines ask you to install migrations. This is intentional, as we want to maintain the original timestamps associated with these migrations.
+
+### 2.4. Run Migrations
 
 ```
 rake db:migrate
 ```
 
-## 3. Create API Keys with Stripe
+## 3. Configure Your Products
+
+Bullet Train defines subscription plans and pricing options in `config/models/billing/products.yml` and defines the translatable elements of these plans in `config/locales/en/billing/products.en.yml`. We recommend just getting started with these plans to ensure your setup is working before customizing the attributes of these plans.
+
+## 4. Configure Stripe
+
+### 4.1. Create API Keys with Stripe
 
  - Create a Stripe account if you don't already have one.
- - Visit https://dashboard.stripe.com/apikeys.
- - For your development environment, make sure you toggle the "test mode" flag to "on" in the top-right corner.
+ - Visit https://dashboard.stripe.com/test/apikeys.
  - Create a new secret key.
 
-## 4. Configure Stripe API Keys Locally
+**Note:** By default we're linking to the "test mode" page for API keys so you can get up and running in development. When you're ready to deploy to production, you'll have to repeat this step and toggle the "test mode" option off to provision real API keys for live payments.
 
-Edit `config/application.yml` and add your Stripe publishable key and new secret key to the file, and also tell the system to use Stripe subscriptions by default:
+### 4.2. Configure Stripe API Keys Locally
+
+Edit `config/application.yml` and add your new Stripe secret key to the file:
 
 ```
-BILLING_DEFAULT_SUBSCRIPTION: "Billing::Stripe::Subscription"
-STRIPE_PUBLISHABLE_KEY: pk_0CJwz5wHlKBXxDA4VO1uEoipxQob0
 STRIPE_SECRET_KEY: sk_0CJw2Iu5wwIKXUDdqphrt2zFZyOCH
 ```
 
-## 5. Populate Stripe with Locally Configured Products
-
-Bullet Train defines subscription plans and other purchasable add-ons in `config/models/billing/products.yml` and comes preconfigured with some example plans. We recommend just getting started with these plans to ensure your setup is working before customizing the attributes of these plans.
+### 4.3. Populate Stripe with Locally Configured Products
 
-Before you can use Stripe Checkout or Stripe Billing's customer portal, these products will have to be defined on Stripe as well. You can have all locally defined products automatically created on Stripe by running the following:
+Before you can use Stripe Checkout or Stripe Billing's customer portal, your locally configured products will have to be created on Stripe as well. To accomplish this, you can have all locally defined products automatically created on Stripe via API by running the following:
 
 ```
 rake billing:stripe:populate_products_in_stripe
 ```
 
-## 6. Import Additional Environment Variables
+### 4.4. Add Additional Environment Variables
 
 The script in the previous step will output some additional environment variables you need to copy into `config/application.yml`.
 
-## 7. Restart Rails
 
-We've modified a bunch of environment variables, so you'll have to have to restart your Rails server before you see the results in your browser.
+## 5. Wire Up Webhooks
 
-```
-rails restart
-```
+Basic subscription creation will work without receiving and processing Stripe's webhooks. However, advanced payment workflows like SCA payments and customer portal cancelations and plan changes require receiving webhooks and processing them.
 
-## 8. Test Creating a Subscription
+### 5.1. Ensure HTTP Tunneling is Enabled
 
-Bullet Train comes preconfigured with a "freemium" plan, so new and existing accounts will continue to work as normal. A new "billing" menu item will appear and you can test subscription creation by clicking "upgrade" and selecting one of the two plans presented.
+Although Stripe provides free tooling for receiving webhooks in your local environment, the officially supported mechanism for doing so in Bullet Train is using [HTTP Tunneling with ngrok](/docs/tunneling.md). This is because we provide support for many types of webhooks across different platforms and packages, so we already need to have ngrok in play.
 
-You should be in "test mode" on Stripe, so when prompted for a credit card number, you can enter `4242 4242 4242 4242`.
+Ensure you've completed the steps from [HTTP Tunneling with ngrok](/docs/tunneling.md), including updating `BASE_URL` in `config/application.yml` and restarting your Rails server.
 
-## 9. Configuring Webhooks
+### 5.2. Enable Stripe Webhooks
 
-Basic subscription creation will work without receiving and processing Stripe's webhooks. However, advanced payment workflows like SCA payments and customer portal cancelations and plan changes require receiving webhooks and processing them.
-
- - Stripe can't deliver webhooks to `http://localhost:3000`, so you'll need to [get an HTTP tunnel up and running](/docs/tunneling.md). For this example, we'll assume you're using ngrok.
  - Visit https://dashboard.stripe.com/test/webhooks/create.
- - Configure the "endpoint URL" to be `https://your-tunnel.ngrok.io/webhooks/incoming/stripe_webhooks`, replacing `your-tunnel` with whatever the subdomain of your tunnel is.
- - When configuring which events to receive, just "select all events" for simplicity. This ensures that any webhooks Bullet Train might add support for in the future will be properly handled when you upgrade.
- - Add the endpoint.
- - On the page for the webhook endpoint you've just configured with Stripe, click on "reveal" under the heading "signing secret". This is a secret token that is required to authenticate that webhooks your application is receiving are actually coming from Stripe. Copy this into your `config/application.yml` like so:
+ - Use the default "add an endpoint" form.
+ - Set "endpoint URL" to `https://YOUR-SUBDOMAIN.ngrok.io/webhooks/incoming/stripe_webhooks`.
+ - Under "select events to listen to" choose "select all events" and click "add events".
+ - Finalize the creation of the endpoint by clicking "add endpoint".
+
+### 5.3. Configure Stripe Webhooks Signing Secret
+
+After creating the webhook endpoint, click "reveal" under the heading "signing secret". Copy the `whsec_...` value into your `config/application.yml` like so:
+
+```
+STRIPE_WEBHOOKS_ENDPOINT_SECRET: whsec_vchvkw3hrLK7SmUiEenExipUcsCgahf9
+```
 
- ```
- STRIPE_WEBHOOKS_ENDPOINT_SECRET: whsec_VsM3c2zeZyqAddkaPaXzf1wJsYp2fRKR
- ```
+### 5.4. Test Sample Webhook Delivery
 
  - Restart your Rails server with `rails restart`.
  - Trigger a test webhook just to ensure it's resulting in an HTTP status code of 201.
 
-## 10. Configure Stripe Billing's Customer Portal
+## 6. Test Creating a Subscription
+
+Bullet Train comes preconfigured with a "freemium" plan, so new and existing accounts will continue to work as normal. A new "billing" menu item will appear and you can test subscription creation by clicking "upgrade" and selecting one of the two plans presented.
+
+You should be in "test mode" on Stripe, so when prompted for a credit card number, you can enter `4242 4242 4242 4242`.
+
+## 7. Configure Stripe Billing's Customer Portal
 
   - Visit https://dashboard.stripe.com/test/settings/billing/portal.
   - Complete all required fields.
@@ -83,8 +124,23 @@ Basic subscription creation will work without receiving and processing Stripe's
 
 This "products" list is what Stripe will display to users as upgrade and downgrade options in the customer portal. You shouldn't list any products here that aren't properly configured in your Rails app, otherwise the resulting webhook will fail to process. If you want to stop offering a plan, you should remove it from this list as well.
 
-## 11. Test Webhooks by Managing a Subscription
+## 8. Finalize Webhooks Testing by Managing a Subscription
 
 In the same account where you created your first test subscription, go into the "billing" menu and click "manage" on that subscription. This will take you to the Stripe Billing customer portal.
 
 Once you're in the customer portal, you should test upgrading, downgrading, and canceling your subscription and clicking "⬅ Return to {Your Application Name}" in between each step to ensure that each change you're making is properly reflected in your Bullet Train application. This will let you know that webhooks are being properly delivered and processed and all the products in both systems are properly mapped in both directions.
+
+## 9. Rinse and Repeat Configuration Steps for Production
+
+As mentioned earlier, all of the links we provided for configuration steps on Stripe were linked to the "test mode" on your Stripe account. When you're ready to launch payments in production, you will need to:
+
+ - Complete all configuration steps again in the live version of your Stripe account. You can do this by following all the links in the steps above and toggling the "test mode" switch to visit the live mode version of each page.
+ - After creating a live API key, configure `STRIPE_SECRET_KEY` in your production environment.
+ - Run `STRIPE_SECRET_KEY=... rake billing:stripe:populate_products_in_stripe` (where `...` is your live secret key) in order to create live versions of your products and prices.
+ - Copy the environment variables output by that rake task into your production environment.
+ - Configure a live version of your webhooks endpoint for the production environment by following the same steps as before, but replacing the ngrok host with your production host in the endpoint URL.
+ - After creating the live webhooks endpoint, configure the corresponding signing secret as the `STRIPE_WEBHOOKS_ENDPOINT_SECRET` enviornment variable in your production environment.
+
+## 10. You should be done!
+
+[Let us know on Discord](http://discord.gg/bullettrain) if any part of this guide was not clear or could be improved!

data/docs/index.md

@@ -1,6 +1,6 @@
 # Bullet Train Developer Documentation
 
-> This release of Bullet Train is still a pre-release, so please pardon the dust while we work to complete the documentation for certain topics.
+> Some of the open-source Bullet Train packages are considered pre-release, so please pardon the dust while we work to complete the documentation for certain topics.
 
 ## Introduction
  - [What is Bullet Train?](https://bullettrain.co) <i class="ti ti-new-window ml-2"></i>

data/docs/tunneling.md

@@ -4,14 +4,14 @@ Before your application can take advantage of features that depend on incoming w
 
 ## Use a Paid Plan
 
-You should specifically sign up for a paid account. Although ngrok offers a free plan, their $5/month paid plan will allow you to reserve a custom subdomain for reuse each time you spin up your tunnel. This is a critical productivity improvement, because in practice you'll end up configuring your tunnel URL in a bunch of different places like `config/application.yml` but also in external systems like when you [configure payment providers to deliver webhooks to you](docs/billing/stripe.md).
+You should specifically sign up for a paid account. Although ngrok offers a free plan, their $25/month paid plan will allow you to reserve a custom subdomain for reuse each time you spin up your tunnel. This is a critical productivity improvement, because in practice you'll end up configuring your tunnel URL in a bunch of different places like `config/application.yml` but also in external systems like when you [configure payment providers to deliver webhooks to you](docs/billing/stripe.md).
 
 ## Usage
 
-Once you have ngrok installed, you can start your tunnel like so, replacing `your-subdomain` with whatever subdomain you reserved in your ngrok account:
+Once you have ngrok installed, you can start your tunnel like so, replacing `YOUR-SUBDOMAIN` with whatever subdomain you reserved in your ngrok account:
 
 ```
-ngrok http 3000 -subdomain=your-subdomain
+ngrok http 3000 -subdomain=YOUR-SUBDOMAIN
 ```
 
 ## Updating Your Configuration
@@ -19,7 +19,7 @@ ngrok http 3000 -subdomain=your-subdomain
 Before your Rails application will accept connections on your tunnel hostname, you need to update `config/application.yml` with:
 
 ```
-BASE_URL: https://your-subdomain.ngrok.io
+BASE_URL: https://YOUR-SUBDOMAIN.ngrok.io
 ```
 
 You'll also need to restart your Rails server:

data/lib/bullet_train/version.rb

@@ -1,3 +1,3 @@
 module BulletTrain
-  VERSION = "1.0.81"
+  VERSION = "1.0.86"
 end

data/lib/bullet_train.rb

@@ -61,7 +61,12 @@ def inbound_email_enabled?
   ENV["INBOUND_EMAIL_DOMAIN"].present?
 end
 
-def subscriptions_enabled?
+def billing_enabled?
+  defined?(BulletTrain::Billing)
+end
+
+# TODO This should be in an initializer or something.
+def billing_subscription_creation_disabled?
   false
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bullet_train
 version: !ruby/object:Gem::Version
-  version: 1.0.81
+  version: 1.0.86
 platform: ruby
 authors:
 - Andrew Culver
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-16 00:00:00.000000000 Z
+date: 2022-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: standard
@@ -428,6 +428,8 @@ files:
 - README.md
 - Rakefile
 - app/assets/config/bullet_train_manifest.js
+- app/assets/javascripts/bullet-train.js
+- app/assets/javascripts/bullet-train.js.map
 - app/controllers/account/invitations_controller.rb
 - app/controllers/account/memberships_controller.rb
 - app/controllers/account/onboarding/user_details_controller.rb
@@ -556,6 +558,7 @@ files:
 - config/initializers/concerns/inflections_base.rb
 - config/initializers/concerns/turbo_failure_app.rb
 - config/locales/en/base.yml
+- config/locales/en/billing/products.en.yml
 - config/locales/en/devise.en.yml
 - config/locales/en/doorkeeper.en.yml
 - config/locales/en/invitations.en.yml
@@ -665,7 +668,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Bullet Train