lantern-rails 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a5fdbde387cd09fe7c9e6f17e138cca601992cd3fd77050374092c4dff9763b
-  data.tar.gz: f791841bba4a6769aea4a52c83ac82f36b98953d199b27c4fba433c6cc8088f4
+  metadata.gz: 9e80b02c09f20e01a8a0b0f4f502708feba44f3d8bffaa9cf0bbded0ee2bf079
+  data.tar.gz: 4dba6effb791874dbd11fe35d125b6637668b75792f3fd3c0efe9bf1069e9fcc
 SHA512:
-  metadata.gz: 3b7d257ee5709b5787d984c7f066b87b7a0c925ac215dc672ab5952b41e9b1eb438855c4d1b97cef405f70926d3b36d8461758f09c97eaf40aa4e364f8db38b4
-  data.tar.gz: 40fd4b31b93888afbfa79efe01e0fcc7e7f382bc04d477ca3625730e21f408486dd0cdeab63852efaa9cbd87676498ae72e34cb63df8f5766cfe2432ae770186
+  metadata.gz: 0feab9b70da80d79b7455d28703ce83cc252520ca75988976751efea292d4bd201b8ecd25e133f4050f9a7be32f96a1b54b2fade5539eed629b16299fbe15f2d
+  data.tar.gz: 20c7cc314a052d6bc9d12de1b4175bc5b83b8f0670cb06ba4c20505f577bb6837d3c61c43c86f14ef10f7e4e68cf4b3acd4eda3548ec5e41b692780beb125f0c

data/README.md

@@ -16,50 +16,24 @@ Then run:
 bundle install
 ```
 
-## Setup
+## Quick start
 
-1. Generate an API key at [uselantern.dev](https://uselantern.dev)
-2. Store the key using one of the options below
-3. Create an initializer
-
-### Store your API key
-
-**Option A: Environment variable**
+1. Sign up for a free API key at [uselantern.dev](https://uselantern.dev)
+2. Run the installer:
 
 ```
-LANTERN_API_KEY=lnt_your_key_here
+rails generate lantern:install
 ```
 
-**Option B: Rails credentials**
+3. Add your API key to the generated initializer (`config/initializers/lantern.rb`) via environment variable or Rails credentials:
 
 ```
-bin/rails credentials:edit
-```
-
-Flat:
-```yaml
-lantern_api_key: lnt_your_key_here
-```
-
-Or nested:
-```yaml
-lantern:
-  api_key: lnt_your_key_here
+LANTERN_API_KEY=lnt_your_key_here
 ```
 
-### Create the initializer
-
-```ruby
-# config/initializers/lantern.rb
-Lantern::Rails.configure do |config|
-  # Match how you stored the key above:
-  config.api_key = ENV["LANTERN_API_KEY"]
-  # Or: config.api_key = Rails.application.credentials.lantern_api_key
-  # Or: config.api_key = Rails.application.credentials.dig(:lantern, :api_key)
-end
-```
+4. Deploy — Lantern starts collecting automatically.
 
-That's it. The collector starts automatically when your Rails app boots in production.
+That's it. Open [uselantern.dev](https://uselantern.dev) to see your dashboard.
 
 ## Configuration
 

data/lib/generators/lantern/install_generator.rb

@@ -0,0 +1,23 @@
+module Lantern
+  class InstallGenerator < ::Rails::Generators::Base
+    source_root File.expand_path("templates", __dir__)
+
+    desc "Creates a Lantern initializer with your API key."
+
+    def copy_initializer
+      template "lantern.rb.tt", "config/initializers/lantern.rb"
+    end
+
+    def print_next_steps
+      say ""
+      say "Lantern installed!", :green
+      say ""
+      say "Next steps:"
+      say "  1. Add your API key to config/initializers/lantern.rb"
+      say "     Get your free key at: https://uselantern.dev"
+      say "  2. Deploy your app — Lantern starts collecting automatically"
+      say "  3. Open https://uselantern.dev to see your dashboard"
+      say ""
+    end
+  end
+end

data/lib/generators/lantern/templates/lantern.rb.tt

@@ -0,0 +1,11 @@
+Lantern::Rails.configure do |config|
+  # Your API key from https://uselantern.dev
+  # Sign up for free, add a database, and copy the key here.
+  config.api_key = Rails.application.credentials.dig(:lantern, :api_key) || ENV["LANTERN_API_KEY"]
+
+  # Collection interval in seconds (default: 300 = 5 minutes)
+  # config.interval = 300
+
+  # Environments to collect in (default: production and staging)
+  # config.collect_in_environments = %w[production staging]
+end

data/lib/lantern/rails/railtie.rb

@@ -1,13 +1,34 @@
 module Lantern
   module Rails
     class Railtie < ::Rails::Railtie
-      config.after_initialize do |app|
+      initializer "lantern.request_tracker" do |app|
+        # Insert middleware unconditionally — it checks config at runtime
+        # and no-ops if Lantern isn't configured. This avoids the frozen
+        # middleware stack issue in Rails 8.1 while ensuring the API key
+        # (set in app initializers) is available when requests arrive.
+        app.middleware.use Lantern::Rails::RequestTracker, Lantern::Rails.query_aggregator
+      end
+
+      config.after_initialize do
         config = Lantern::Rails.configuration
-        next unless config.valid?
-        next unless config.enabled
-        next unless config.collect_in_environments.include?(::Rails.env.to_s)
 
-        app.middleware.use Lantern::Rails::RequestTracker, Lantern::Rails.query_aggregator
+        unless config.valid?
+          ::Rails.logger.info(
+            "[Lantern] No API key configured. Get your free key at https://uselantern.dev " \
+            "then run: rails generate lantern:install"
+          )
+          next
+        end
+
+        unless config.enabled
+          ::Rails.logger.info("[Lantern] Disabled via configuration.")
+          next
+        end
+
+        unless config.collect_in_environments.include?(::Rails.env.to_s)
+          ::Rails.logger.info("[Lantern] Skipping collection in #{::Rails.env} environment.")
+          next
+        end
 
         runner = Lantern::Rails::Runner.new(config)
 

data/lib/lantern/rails/request_tracker.rb

@@ -10,6 +10,9 @@ module Lantern
       end
 
       def call(env)
+        # No-op if Lantern isn't configured or not enabled for this environment
+        return @app.call(env) unless enabled?
+
         # Only track actual controller requests, skip assets/healthchecks
         return @app.call(env) unless trackable_request?(env)
 
@@ -49,6 +52,14 @@ module Lantern
 
       private
 
+      def enabled?
+        return @enabled if defined?(@enabled)
+
+        config = Lantern::Rails.configuration
+        @enabled = config.valid? && config.enabled &&
+                   config.collect_in_environments.include?(::Rails.env.to_s)
+      end
+
       def trackable_request?(env)
         # Skip asset pipeline, action cable, health checks
         path = env["PATH_INFO"].to_s

data/lib/lantern/rails/version.rb

@@ -1,5 +1,5 @@
 module Lantern
   module Rails
-    VERSION = "0.2.1"
+    VERSION = "0.3.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lantern-rails
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Eric Mumbower
@@ -29,6 +29,8 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
+- lib/generators/lantern/install_generator.rb
+- lib/generators/lantern/templates/lantern.rb.tt
 - lib/lantern-rails.rb
 - lib/lantern/rails/collector.rb
 - lib/lantern/rails/configuration.rb