bullet_train 1.2.23 → 1.2.24

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. checksums.yaml +4 -4
  2. data/docs/application-options.md +12 -26
  3. data/docs/billing/stripe.md +2 -0
  4. data/lib/bullet_train/version.rb +1 -1
  5. metadata +3 -3
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 8d9110b69050fc6e8801f6e37118a735e84978d0d67b28988b4fee47a68fc3b1
4
- data.tar.gz: 4bfc8a9ccb219b0fccf82fdc153c02a6076443cc29ed4e064a63bad97f8a2b40
3
+ metadata.gz: 876aa81bf9d9808e5c55e50f8e5635b88ffce376dff998bb66cdc7fb476ea5e9
4
+ data.tar.gz: 21f7f07532069387068ce8df909046bb372488f1b73d91203f6bfcf3337cfb20
5
5
  SHA512:
6
- metadata.gz: 9f43b9c8a0185d73c230fdad54405bb480219e04ca9917964d502f6db13ade9bf26d766ae4c7d0dc8926cfb66d5d745252775585fb1059fa35cac03d29e25033
7
- data.tar.gz: a0b31fd936cd59281d3012972b682bc932bb3c70f9a6f80bdcdc0d6d1735550bf6a183b3a46699003b8bfde819894b463539c3b2799daf1d04f1a8b7e440a9c9
6
+ metadata.gz: d5be8488eda4220db8882b295f9c6faae2e3b9b66fdf92aff410271c38af839bbc1937a24a402c8c318827c2012e19f5dbd626e2ee0c7e6f1db77062c0f06386
7
+ data.tar.gz: 8881f0466376167ad6d3b2f2346cb7ec69f4bb596db9622b45374ba8f3f363b69ce10403143d4d00a7625a36c56ffcb3de7bad4d16d310b3f70471a68f14950c
data/docs/application-options.md CHANGED
@@ -1,31 +1,17 @@
1
1
  # Application Options
2
2
 
3
- Bullet Train features a list of options available at your disposal to enable/disable functionalities that would otherwise take a significant amount of time to implement. Simply add any of the following environment variables to `config/application.yml` in your main Bullet Train application and restart your server for the options to apply.
3
+ The following configuration options are available for your Bullet Train application. For local development, you can set these values in `config/application.yml`. For hosting providers that we provide first-party support for, you can consult [Render's documentation](https://render.com/docs/environment-variables) and [Heroku's documentation](https://devcenter.heroku.com/articles/config-vars) for how to set these values.
4
4
 
5
- The helper methods below can also be directly invoked in your application if you wish to have parts of your code depend on the functionality in question.
6
-
7
- | Option | Type | Example | Helper Methods |
5
+ | Option | Purpose | Example Value <sup><a href="#footnote-1">1</a></sup> | Helper Methods |
8
6
  | --- | --- | --- | --- |
9
- | HIDE_THINGS | Boolean | `"true"` | `scaffolding_things_disabled?` |
10
- | HIDE_EXAMPLES | Boolean | `"true"` | `scaffolding_things_disabled?` |
11
- | STRIPE_CLIENT_ID | String | `"your_stripe_client_id"` | `stripe_enabled?` |
12
- | CLOUDINARY_URL | String | `"cloudinary://your_cloudinary_token_here"` | `cloudinary_enabled?` |
13
- | TWO_FACTOR_ENCRYPTION_KEY | String | `"your_encryption_key"` | `two_factor_enabled_authentication?` |
14
- | INVITATION_KEYS | String | `"ofr9h5h9ghzeodh, ofr9h5h9ghzeodi"` | `invitation_keys` `invitation_only?` |
15
- | FONTAWESOME_NPM_AUTH_TOKEN | String | `"your_font_awesome_token"` | `font_awesome?` |
16
- | SILENCE_LOGS | Boolean | `"true"` | `silence_logs?` |
17
- | TESTING_PROVISION_KEY | String | `"asdf123"` | N/A |
18
- | OPENAI_ACCESS_TOKEN | String |`your_openai_token`| `openai_enabled?` |
7
+ | `BASE_URL` | Specify the full URL where the application is hosted | `https://app.yourproduct.com` | |
8
+ | `HIDE_THINGS` | [Hide the "Creative Concept" demo model and "Tangible Thing" template model](/docs/super-scaffolding.md) | `true` | `scaffolding_things_disabled?` |
9
+ | `STRIPE_CLIENT_ID` | [Enable the example OAuth2 integration with Stripe Connect](/docs/oauth.md) | `ca_DBOenflO97IalW31IEvpvSKGHjOWhGzJ` | `stripe_enabled?` |
10
+ | `CLOUDINARY_URL` | Enable Cloudinary-powered image uploads, including profile photos | `cloudinary://9149...:3HSd...@hfytqhfzj` | `cloudinary_enabled?` |
11
+ | `INVITATION_KEYS` | [Restrict new sign-ups](/docs/authentication.md) | `89dshwxja, a9y29ihs1` | `invitation_keys` `invitation_only?` |
12
+ | `FONTAWESOME_NPM_AUTH_TOKEN` | [Enable Font Awesome Pro](/docs/font-awesome-pro.md) | `5DC62AA7-5741-4C45-874B-EA9CAA4EE085` | `font_awesome?` |
13
+ | `OPENAI_ACCESS_TOKEN` | Enable OpenAI-powered UX improvements | `sk-Tnko8PI15i6du03KkxVExTz3lbkFJV...` | `openai_enabled?` |
14
+ | `REDOCLY_ORGANIZATION_ID` | Enable Redocly-powered API documentation | `your-organization-name` | |
15
+ | `REDOCLY_API_KEY` | Enable Redocly-powered API documentation |`orgsk_lfyrXAAym8nbSrar9b8wvTN+...`| |
19
16
 
20
- | Option | Description |
21
- | --- | --- |
22
- | HIDE_THINGS | Hides Bullet Train demo models such as `CreativeConcept` and `TangibleThing`. |
23
- | HIDE_EXAMPLES | Hides base models such as `CreativeConcept` and `TangibleThing`.
24
- | STRIPE_CLIENT_ID | See [Bullet Train Billing for Stripe](/docs/billing/stripe.md) for more information and related environment variables. |
25
- | CLOUDINARY_URL | Enables use of Cloudinary for handling images. |
26
- | TWO_FACTOR_ENCRYPTION_KEY | Enables two-factor authentication through Devise. |
27
- | INVITATION_KEYS | See [Invitation Only](/docs/authentication.md) for more information. |
28
- | FONTAWESOME_NPM_AUTH_TOKEN | Enables use of Font Awesome. |
29
- | SILENCE_LOGS | Silences Super Scaffolding logs. |
30
- | TESTING_PROVISION_KEY | Creates a test `Platform::Application` by accessing `/testing/provision?key=your_provision_key` |
31
- | OPENAI_ACCESS_TOKEN | Enables use [OpenAI](https://openai.com/) with the [ruby-openai](https://github.com/alexrudall/ruby-openai) gem. |
17
+ <sup><a name="footnote-1"></a>1</sup> Any credentials listed here aren't real, but we wanted you to know what each looks like so you can recognize the correct value from each provider.
data/docs/billing/stripe.md CHANGED
@@ -38,6 +38,8 @@ cp `bundle show --paths | grep bullet_train-billing-stripe | sort | head -n 1`/d
38
38
 
39
39
  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.
40
40
 
41
+ <aside><small>TODO Let's create a `rake bullet_train:billing:stripe:install` task.</small></aside>
42
+
41
43
  ### 2.4. Run Migrations
42
44
 
43
45
  ```
data/lib/bullet_train/version.rb CHANGED
@@ -1,3 +1,3 @@
1
1
  module BulletTrain
2
- VERSION = "1.2.23"
2
+ VERSION = "1.2.24"
3
3
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: bullet_train
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.2.23
4
+ version: 1.2.24
5
5
  platform: ruby
6
6
  authors:
7
7
  - Andrew Culver
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-04-01 00:00:00.000000000 Z
11
+ date: 2023-04-03 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: standard
@@ -736,7 +736,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
736
736
  - !ruby/object:Gem::Version
737
737
  version: '0'
738
738
  requirements: []
739
- rubygems_version: 3.3.7
739
+ rubygems_version: 3.4.6
740
740
  signing_key:
741
741
  specification_version: 4
742
742
  summary: Bullet Train