paddle_rails 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e582d1858144111153c25ef93bd2e879139574ad812c22f91f5f2bc57ecc7b68
-  data.tar.gz: a2df8aae57a9ca5b48e0aea05254b225d45d3e373bdf01cbc55a7cc08475f35a
+  metadata.gz: 4cbe24ab68c00936c543e5688bf224bb8b0b861997bea786a2b074aa6c8d9a66
+  data.tar.gz: 1bce594d47a17288fae08c785fcc60dcdce5cd294a8ae9f6c609fc7f0ea07caa
 SHA512:
-  metadata.gz: f2a9b2b04f3e4f53f48cda7fbe01c9d659267a31ab1782ecc49360ace956bf499e10c712f2c6c1ae2b2e26e29fa605e26bc810d4f5b601f48d8b1122e2ab196c
-  data.tar.gz: 986d887b59ff62eec3bea43271c38e34cafc33865d223b8d3090cf2c564cd4619169adcdff316911e32a27b370ae5e4d23bd940c41837495576a2c8bb42a64d2
+  metadata.gz: 1d8050efe17de87fa937aec3087541f33c7739ff1116d88e0b0cf4c8868d3918b3340b1d3319235ce4a3ceab92738b52fe8e908fe97997b36a21c0164ed1e728
+  data.tar.gz: 41426d179a13fc3162923acdce3ef4e19ab4dde783efc3b34aa4e94157e3332fd99b754c0f13fa967b9bd057dd9f1538bf45a40156264e1a16000eabb220ee7f

data/README.md

@@ -33,17 +33,16 @@ gem "paddle_rails"
 
 ```bash
 $ bundle install
-```
-
-Install the migrations to create the necessary tables:
-
-```bash
-$ bin/rails paddle_rails:install:migrations
+$ bin/rails generate paddle_rails:install
 $ bin/rails db:migrate
 ```
 
 ### 2. Configure Paddle credentials
 
+PaddleRails looks for credentials in this order: **environment variables → Rails credentials → nil**. You only need to configure one source.
+
+**Option A: Environment variables** (recommended for containers, CI, local dev with dotenv)
+
 ```bash
 # .env or environment variables
 PADDLE_API_KEY=your_api_key
@@ -52,6 +51,20 @@ PADDLE_ENVIRONMENT=sandbox  # or "production"
 PADDLE_WEBHOOK_SECRET=your_webhook_secret
 ```
 
+**Option B: Rails credentials** (recommended for production secrets)
+
+```bash
+$ bin/rails credentials:edit
+```
+
+```yaml
+paddle:
+  api_key: your_api_key
+  public_token: your_public_token
+  environment: sandbox
+  webhook_secret: your_webhook_secret
+```
+
 ### 3. Mount the billing portal
 
 Add this to your `config/routes.rb`:
@@ -119,20 +132,22 @@ The billing portal is designed to be clean and professional out of the box. It u
 
 ## Configuration
 
+Credentials are automatically loaded from environment variables or Rails credentials (see [Quick Start](#2-configure-paddle-credentials)). You only need an initializer if you want to override defaults or customize the authenticator:
+
 ```ruby
 # config/initializers/paddle_rails.rb
 PaddleRails.configure do |config|
-  # Paddle API credentials
-  config.api_key = ENV["PADDLE_API_KEY"]
-  config.public_token = ENV["PADDLE_PUBLIC_TOKEN"]
-  config.environment = ENV["PADDLE_ENVIRONMENT"]  # "sandbox" or "production"
-  config.webhook_secret = ENV["PADDLE_WEBHOOK_SECRET"]
-  
+  # Override credentials (optional — env vars and Rails credentials are used by default)
+  # config.api_key = "your_api_key"
+  # config.public_token = "your_public_token"
+  # config.environment = "sandbox"  # or "production" (defaults to "sandbox")
+  # config.webhook_secret = "your_webhook_secret"
+
   # How to identify the subscription owner in the billing portal
   config.subscription_owner_authenticator do
     current_user || warden.authenticate!(scope: :user)
   end
-  
+
   # Where the "Back" link goes in the portal
   config.customer_portal_back_path do
     main_app.root_path
@@ -140,6 +155,15 @@ PaddleRails.configure do |config|
 end
 ```
 
+### Credential Lookup Order
+
+Each credential is resolved in this order:
+
+1. **Explicit config** — value set in the initializer block
+2. **Environment variable** — `PADDLE_API_KEY`, `PADDLE_PUBLIC_TOKEN`, `PADDLE_ENVIRONMENT`, `PADDLE_WEBHOOK_SECRET`
+3. **Rails credentials** — `rails credentials:edit` under the `paddle:` key
+4. **Default** — `"sandbox"` for environment, `nil` for everything else
+
 ### Paddle Dashboard Settings
 
 #### Default Payment Link