bullet_train 1.2.6 → 1.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f272526d56b142f946f7a0b4ebdbb8537120199a0f78be7cad85ba7265003b6
-  data.tar.gz: 1e50a2ae1848bd7613f8ce2ece37de6bb2fb85c485207226cad6b39e5d7ed908
+  metadata.gz: 3e370599c0e8d8825f71a0c14e4560b02499292700d50b4ca511761ccbaa4a8c
+  data.tar.gz: 9dca4541087a40cd7b7161169f8df6d846ecd94a01589f6405d19a441d6dd1c3
 SHA512:
-  metadata.gz: 34c1d594e23e6ba2e11dc06b69f012cb118d8901bc47d08e697f26ecd5081228e02bfeb923746906730ee2f4e5ec8a8338da11234b828feca22c5d2cf1090e87
-  data.tar.gz: 538ac4bb1e3723f929059c382c642b00e9e30ddaee8f2d68880ac75a83e197fa9d7d0463e951f21d41123cce765622b16a6ff52696d75ee8944b5e08b91e231e
+  metadata.gz: '0328773920ee63acc58bae967e4dacd74185055feda7e377c73dd22bbf488a7dfbb3927f92400353e0367e323cb0f45bfa1a7fbfb934f7f0bac222a286f49f2e'
+  data.tar.gz: 7ddab29c7bf02600c498125ea326ca051440b6df5153a08d70793b60fcc43e52c3f0b9b61b83eea5f966feab820535111b479a1136b6ab16eeb8ce74f29b035c

data/app/controllers/concerns/documentation_support.rb

@@ -3,8 +3,14 @@ module DocumentationSupport
 
   def docs
     target = params[:page].presence || "index"
-    all_paths = ([Rails.root.to_s] + `bundle show --paths`.lines.map(&:chomp))
-    @path = all_paths.map { |path| path + "/docs/#{target}.md" }.detect { |path| File.exist?(path) }
+
+    # TODO For some reason this didn't work on Heroku.
+    # all_paths = ([Rails.root.to_s] + `bundle show --paths`.lines.map(&:chomp))
+    # @path = all_paths.map { |path| path + "/docs/#{target}.md" }.detect { |path| File.exist?(path) }
+
+    # TODO Trying to just brute force this for now.
+    @path = `bundle show bullet_train`.chomp + "/docs/#{target}.md"
+
     render :docs, layout: "docs"
   end
 end

data/docs/application-options.md

@@ -23,7 +23,7 @@ The helper methods below can also be directly invoked in your application if you
 | STRIPE_CLIENT_ID | See [Bullet Train Billing for Stripe](/docs/billing/stripe.md) for more information and related environment variables. |
 | CLOUDINARY_URL | Enables use of Cloudinary for handling images. |
 | TWO_FACTOR_ENCRYPTION_KEY | Enables two-factor authentication through Devise. |
-| INVITATION_KEYS | See more [Invitation Only](/docs/invitation_only.md) for more information. |
+| INVITATION_KEYS | See more [Invitation Only](/docs/authentication.md) for more information. |
 | FONTAWESOME_NPM_AUTH_TOKEN | Enables use of Font Awesome. |
 | SILENCE_LOGS | Silences Super Scaffolding logs. |
 | TESTING_PROVISION_KEY | Creates a test `Platform::Application` by accessing `/testing/provision?key=your_provision_key` |

data/docs/authentication.md

@@ -12,11 +12,20 @@ bin/resolve SessionsController --eject --open
 ## Customizing Views
 You can customize Devise views using the same workflow you would use to customize any other Bullet Train views.
 
-## Disabling Registration
+## Invite-Only Mode and Disabling Registration
+If you would like to stop users from signing up for your application without an invitation code or without an invitation to an existing team, set `INVITATION_KEYS` to one or more comma-delimited values in `config/application.yml` (or however you configure your environment values in production.) Once invitation keys are configured, you can invite people to sign up with one of your keys at the following URL:
 
-Registration is enabled by default. You can disable registration, allowing signups via an invite code only, by using [Invitation Only Mode](/docs/invitation_only.md)
+```
+https://example.com/invitation?key=ONE_OF_YOUR_KEYS
+```
+
+If you want to disable new registrations completely, put an unguessable value into `INVITATION_KEYS` and keep it secret.
 
-## Two factor authentication
+Note that in both of these scenarios that existing users will still be able to invite new collaborators to their teams and those collaborators will have the option of creating a new account, but no users in the application will be allowed to create a new team without an invitation code and following the above URL.
 
-This feature allows users to add two factor authentication.
-It requires some setup - [Two Factor Authentication](/docs/two-factor-authentication.md)
+## Enabling Two-Factor Authentication (2FA)
+Two-factor authentication is enabled by default in Bullet Train, but you must have Rails built-in encrypted secrets and Active Record Encryption configured. To do this, just run:
+
+```
+bin/secrets
+```

data/docs/index.md

@@ -29,7 +29,6 @@
  - [Roles and Permissions](/docs/permissions.md)
  - [Onboarding](/docs/onboarding.md)
  - [Namespacing](/docs/namespacing.md)
- - [Invitation Only Mode](/docs/invitation_only.md)
 
 ## UI
  - [Field Partials](/docs/field-partials.md)

data/docs/oauth.md

@@ -3,8 +3,6 @@ Bullet Train includes [Omniauth](https://github.com/omniauth/omniauth) by defaul
 
 For specific instructions on adding new OAuth providers, run the following on your shell:
 
-> TODO This scaffolder still needs to be updated to support the new way we distribute the Stripe Connect example via Ruby gem.
-
 ```
 bin/super-scaffold oauth-provider
 ```

data/docs/webhooks/outgoing.md

@@ -1,3 +1,32 @@
 # Outgoing Webhooks
 
-> TODO This section needs to be written and should probably delegate a lot of details to the README of the [Bullet Train Outgoing Webhooks repository](https://github.com/bullet-train-co/bullet_train-outgoing_webhooks).
+## Introduction
+Webhooks allow for users to be notified via HTTP request when activity takes place on their team in your application. Bullet Train applications include an entire user-facing UI that allows them not only to subscribe to webhooks, but also see a history of their attempted deliveries and debug delivery issues.
+
+## Default Event Types
+Bullet Train can deliver webhooks for any model you've added under `Team`. We call the model a webhook is being issued for the "subject". 
+
+An "event type" is a subject plus an action. By default, every model includes `created`, `updated`, and `destroyed` event types. These are easy for us to implement automatically because of [Active Record Callbacks](https://guides.rubyonrails.org/active_record_callbacks.html).
+
+## Custom Event Types
+You can make custom event types available for subscription by adding them to `config/models/webhooks/outgoing/event_types.yml`. For example:
+
+```yaml
+payment:
+  - attempting
+  - succeeded
+  - failed
+```
+
+Once the event type is configured, you can make your code actually issue the webhook like so:
+
+```ruby
+payment.generate_webhook(:succeeded)
+```
+
+## Delivery
+Webhooks are delivered asyncronously in a background job by default. If the resulting HTTP request results in a status code other than those in the 2XX series, it will be considered a failed attempt and delivery will be reattempted a number of times.
+
+## Future Plans
+ - Allow users to filter webhooks to be generated by a given parent model. For example, they should be able to subscribe to `post.created`, but only for `Post` objects created within a certain `Project`.
+ - Integrate [Hammerstone Refine](https://hammerstone.dev) to allow even greater configurability for filtering webhooks.

data/docs/zapier.md

@@ -2,7 +2,7 @@
 Bullet Train provides out-of-the-box support for Zapier. New Bullet Train projects include a preconfigured Zapier CLI project that is ready to `zapier deploy`.
 
 ## Background
-Zapier was designed to take advantage of an application's existing [REST API](/docs/api.md), [outgoing webhook capabilities](/docs/webhooks/outgoing.md), and OAuth2 authorization workflows. Thankfully for us, Bullet Train provides the first two and pre-configures Doorkeeper to provide the latter. We also have an smooth OAuth2 connection workflow that accounts for the mismatch between the user-based OAuth2 standard and team-based multitenancy.
+Zapier was designed to take advantage of an application's existing [REST API](/docs/api.md), [outgoing webhook capabilities](/docs/webhooks/outgoing.md), and OAuth2 authorization workflows. Thankfully for us, Bullet Train provides the first two and pre-configures Doorkeeper to provide the latter. We also have a smooth OAuth2 connection workflow that accounts for the mismatch between user-based OAuth2 and team-based multitenancy.
 
 ## Prerequitesites
  - You must be developing in an environment with [tunneling enabled](/docs/tunneling.md).

data/lib/bullet_train/version.rb

@@ -1,3 +1,3 @@
 module BulletTrain
-  VERSION = "1.2.6"
+  VERSION = "1.2.8"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bullet_train
 version: !ruby/object:Gem::Version
-  version: 1.2.6
+  version: 1.2.8
 platform: ruby
 authors:
 - Andrew Culver
@@ -643,7 +643,6 @@ files:
 - docs/i18n.md
 - docs/index.md
 - docs/indirection.md
-- docs/invitation_only.md
 - docs/javascript.md
 - docs/modeling.md
 - docs/namespacing.md
@@ -660,7 +659,6 @@ files:
 - docs/themes.md
 - docs/trademark.md
 - docs/tunneling.md
-- docs/two-factor-authentication.md
 - docs/upgrades.md
 - docs/webhooks/incoming.md
 - docs/webhooks/outgoing.md

data/docs/invitation_only.md

@@ -1,13 +0,0 @@
-# Invitation Only Mode
-
-By providing a randomized string to `ENV["INVITATION_KEYS"]`, you can enable invitation only mode on your Bullet Train application. This will set up your app so that users cannot register to your website unless they have access to a specific link, or if they are invited via email.
-
-`config/application.yml`:
-```ruby
-INVITATION_KEYS: ofr9h5h9ghzeodh
-```
-
-In this case, the user will be able to register their own account by accessing the following link:
-```
-http://localhost:3000/invitation?key=ofr9h5h9ghzeodh
-```

data/docs/two-factor-authentication.md

@@ -1,16 +0,0 @@
-# Two Factor Authentication
-
-## Setup
-
-run `bin/rails db:encryption:init` and use `bin/rails credentials:edit` to add the resulting keys to your `secrets.yml`
-
-Add the following gems to your `Gemfile` and run `bundle install`
-
-```ruby
-gem "devise-two-factor"
-gem "rqrcode"
-```
-
-If you haven't already done so, set the environment variable `RAILS_MASTER_KEY` with the contents of `config/master.key`. Note, this file should not be committed to git, and you should keep it in a safe place.
-
-Now in the user's Account Details page there will be an option to enable two factor, and when enabled the two factor code will be required at login.