openreceive-rails 0.2.1 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3709b7ea572da6d1a0a259c84f95ea3f5e41ec1fc7dc9dd067a8a77951bd0691
-  data.tar.gz: 0c42db53e3d8dff9c5796ebc53b15c87b02286c627250be6a2741327d3082403
+  metadata.gz: 4fd30ded365e254b6529fc4c006d8ec597a83f659cdf4b60b34127817d7fc995
+  data.tar.gz: b272234e0a5eadb74ac2c63a9df71d3af0cc62d290497005af206653a489743d
 SHA512:
-  metadata.gz: '0930dafa248e3f22fbc2297fac22a8d14b09ed407c49c08f01cd5de48cb7213f49370644233a74efd45782432a1629a12439a312c4c074f1a9401dcc8ccda51d'
-  data.tar.gz: 2990f0db5d68c3b8a0fa4c1bace12eb7708f1961894d6bd444cdd593f259aead0249b28ba127e2cc246903ec4517c6f8944ae3a7cde14d4bf58ea6dd7fa65e1f
+  metadata.gz: 85bdd9b23bc16d13d4e1b3e4d7bc788cf2987c44431a9c345c9a6f48c63aea11f27e8c8ab7d40b1343e787048a15768eed8baaf40bf60d2e6b6b27fedb1d5d47
+  data.tar.gz: 8ed6a9cd303864c971b5b8597e34cbe2e1e6b2cf9e5b1651a38f6183e43f4f69ab1a05af90c364f237b3698432c101c059eaf61bba9738cae692a4aea65ffb93

data/CHANGELOG.md

@@ -1,5 +1,48 @@
 # Changelog
 
+## 0.2.3 - 2026-08-25
+
+The Ruby gems release in lockstep with the npm workspace version. The full
+release narrative lives in the repository-root
+[CHANGELOG](https://github.com/openreceive/openreceive/blob/master/CHANGELOG.md);
+entries here are scoped to this gem.
+
+- The mounted engine inherits `openreceive-server`'s `POST /checkouts` change:
+  the response now carries `payment_methods` alongside `checkout` (HTTP
+  contract 0.4.1). No configuration change; hosts using `@openreceive/browser`
+  see no difference.
+
+## 0.2.2 - 2026-08-25
+
+The Ruby gems release in lockstep with the npm workspace version. The full
+release narrative lives in the repository-root
+[CHANGELOG](https://github.com/openreceive/openreceive/blob/master/CHANGELOG.md);
+entries here are scoped to this gem.
+
+- **Fixed: the generated migration would not load.** `openreceive:install` wrote
+  `class CreateOpenreceiveTables`, but the engine's own acronym inflection makes
+  Rails resolve the file name to `CreateOpenReceiveTables`, so
+  `bin/rails db:migrate` failed with `NameError` on every install. The template
+  declares the class Rails looks for, and a new generator test registers the
+  acronym and runs the migration for real.
+- **`nwc-ruby` is now a runtime dependency.** Building the client from `NWC_URI`
+  is this gem's DEFAULT wallet path, so installing only `openreceive-rails`
+  used to boot fine and then 500 on the first checkout with
+  `Install nwc-ruby or configure nwc_client.` `config.nwc_client` remains the
+  override for hosts bringing their own client.
+- **Fixed: the boot preflight failed `assets:precompile`.** An image build is a
+  production boot with no wallet secrets mounted, so the eager preflight failed
+  the build rather than the deploy. Asset builds are now detected
+  (`SECRET_KEY_BASE_DUMMY`, or an `assets:precompile`/`clean`/`clobber` rake
+  invocation) and skipped with a log line.
+- **Added `config.eager_preflight`** (default `true`) — the supported opt-out
+  for any other boot that must come up without wallet secrets. It disables the
+  BOOT check only; the wallet is still checked on the first request, and a real
+  production boot with no `NWC_URI` still fails closed.
+- The generated migration's `payment_hash` check constraint hoists its adapter
+  branch to a local, so the first file a developer opens after running the
+  generator reads as ordinary Ruby.
+
 ## 0.2.1 - 2026-08-24
 
 The Ruby gems release in lockstep with the npm workspace version. The full

data/lib/generators/openreceive/install/install_generator.rb

@@ -61,15 +61,19 @@ module OpenReceive
       # the app actually runs. MySQL's bare REGEXP follows the column's
       # case-insensitive collation, so its rendering pins case sensitivity
       # with REGEXP_LIKE's 'c' flag.
+      #
+      # Rendered as the right-hand side of `hash_check =` at method-body
+      # indentation, so the branch reads as ordinary Ruby in the file the
+      # developer opens right after running the generator.
       def payment_hash_check_sql
-        return %("REGEXP_LIKE(payment_hash, '^[0-9a-f]{64}$', 'c')") if mysql_adapter?
+        return %(      "REGEXP_LIKE(payment_hash, '^[0-9a-f]{64}$', 'c')") if mysql_adapter?
 
-        <<~RUBY.strip
+        <<~RUBY.chomp.gsub(/^/, "      ")
           if connection.adapter_name.downcase.include?("postgres")
-                           "payment_hash ~ '^[0-9a-f]{64}$'"
-                         else
-                           "length(payment_hash) = 64 AND payment_hash NOT GLOB '*[^0-9a-f]*'"
-                         end
+            "payment_hash ~ '^[0-9a-f]{64}$'"
+          else
+            "length(payment_hash) = 64 AND payment_hash NOT GLOB '*[^0-9a-f]*'"
+          end
         RUBY
       end
 

data/lib/generators/openreceive/install/templates/migration.rb

@@ -4,7 +4,7 @@
 # durable reconcile gate they share. Same host database, never a second one.
 #
 <%= fulfillment_note("# ") %>
-class CreateOpenreceiveTables < ActiveRecord::Migration[<%= migration_version %>]
+class CreateOpenReceiveTables < ActiveRecord::Migration[<%= migration_version %>]
   def change
     create_table :openreceive_payments do |t|
       # Your order id, as you passed it.
@@ -54,8 +54,9 @@ class CreateOpenreceiveTables < ActiveRecord::Migration[<%= migration_version %>
     add_check_constraint :openreceive_payments,
                          "status IN ('pending', 'settled', 'expired', 'failed', 'attention')",
                          name: "openreceive_payments_status_check"
-    add_check_constraint :openreceive_payments,
-                         <%= payment_hash_check_sql %>,
+    hash_check =
+<%= payment_hash_check_sql %>
+    add_check_constraint :openreceive_payments, hash_check,
                          name: "openreceive_payments_payment_hash_check"
 
     # Which schema generation is installed. The engine refuses to run against a

data/lib/openreceive/configuration.rb

@@ -36,7 +36,7 @@ module OpenReceive
                   :resolve_checkout, :on_checkout_created,
                   :rate_limit, :rate_limiting, :client_ip, :price_provider,
                   :swap_providers, :price_currencies, :allow_spend_capable_wallet,
-                  :opportunistic_reconcile
+                  :opportunistic_reconcile, :eager_preflight
 
     def initialize
       @parent_controller = "ActionController::Base"
@@ -78,6 +78,13 @@ module OpenReceive
       # `bin/rails openreceive:notifications` worker owns scanning), or a Hash
       # with min_interval_seconds to tune.
       @opportunistic_reconcile = true
+      # The production boot preflight (Engine's after_initialize): build the
+      # service, and with it the wallet check, so a missing NWC_URI or a
+      # spend-capable wallet stops a deploy instead of the first customer. ON by
+      # default. Asset builds are detected and skipped automatically (see
+      # OpenReceive.eager_preflight?); set false for any other boot that must
+      # come up without wallet secrets.
+      @eager_preflight = true
     end
 
     def service
@@ -353,6 +360,8 @@ module OpenReceive
     end
   end
 
+  # Rake tasks that are an ASSET BUILD, never a serving boot.
+  ASSET_BUILD_TASKS = %w[assets:precompile assets:clean assets:clobber].freeze
 
   class << self
     def configure
@@ -368,6 +377,45 @@ module OpenReceive
       @configured == true
     end
 
+    # Whether the engine's production boot preflight should run (see Engine).
+    #
+    # It must not run during `rails assets:precompile`. That is a production
+    # boot by RAILS_ENV, but it happens inside an image build where no wallet
+    # secrets are mounted — they arrive at deploy time — so the preflight would
+    # fail the BUILD, long before the deploy it exists to protect. Rails' own
+    # generated Dockerfile has exactly this shape.
+    def eager_preflight?
+      preflight_skip_reason.nil?
+    end
+
+    # nil when the boot preflight should run; otherwise the short reason the
+    # engine logs, so an operator who expected a fail-closed boot and did not
+    # get one can see why in the same log line.
+    def preflight_skip_reason
+      return "config.eager_preflight = false" unless config.eager_preflight
+      return "asset build" if asset_build?
+
+      nil
+    end
+
+    # An asset build, by the two signals that are actually reliable.
+    # `Rails.const_defined?(:Console)`-style sniffing is not: the console
+    # constant exists in a serving boot too.
+    def asset_build?
+      # Rails' own convention for "a production boot with a throwaway secret",
+      # set by its generated Dockerfile alongside `rails assets:precompile`.
+      return true unless ENV["SECRET_KEY_BASE_DUMMY"].to_s.empty?
+
+      # The honest test for older/hand-written build shapes: what was actually
+      # invoked. `SECRET_KEY_BASE=dummy rails assets:precompile` lands here.
+      return false unless defined?(::Rake)
+
+      ::Rake.application.top_level_tasks.any? { |task| ASSET_BUILD_TASKS.include?(task.to_s) }
+    rescue StandardError
+      # Rake present but without a usable application: not an asset build.
+      false
+    end
+
     def config
       @config ||= Configuration.new
     end

data/lib/openreceive/engine.rb

@@ -17,6 +17,13 @@ module OpenReceive
     # customer-facing 500s on the first checkout. Skipped when the host never
     # ran OpenReceive.configure (gem installed, installer not run yet), and
     # outside production so tests and consoles boot without a live wallet.
+    #
+    # `rails assets:precompile` is the one production boot that must NOT be
+    # preflighted: it runs inside an image build, before any wallet secret is
+    # mounted, so checking there fails the build rather than the deploy. It is
+    # detected and skipped automatically (OpenReceive.eager_preflight?), and
+    # `config.eager_preflight = false` is the explicit lever for any other
+    # secretless boot.
     config.after_initialize do
       if OpenReceive.configured?
         if OpenReceive.config.on_paid.equal?(OpenReceive::LOGGING_ON_PAID)
@@ -26,7 +33,17 @@ module OpenReceive
             "config/initializers/openreceive.rb."
           )
         end
-        OpenReceive.config.service if ::Rails.env.production?
+        if ::Rails.env.production?
+          skipped = OpenReceive.preflight_skip_reason
+          if skipped.nil?
+            OpenReceive.config.service
+          else
+            ::Rails.logger&.info(
+              "[openreceive] boot preflight skipped (#{skipped}) — the wallet is " \
+              "checked on the first request instead."
+            )
+          end
+        end
       end
     end
   end

data/lib/openreceive/rails/version.rb

@@ -5,6 +5,6 @@ module OpenReceive
   # top-level `::Rails` framework constant — engine code always references the framework as
   # `::Rails` to avoid shadowing.
   module Rails
-    VERSION = "0.2.1"
+    VERSION = "0.2.3"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openreceive-rails
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.3
 platform: ruby
 authors:
 - OpenReceive
@@ -15,28 +15,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.2.1
+        version: 0.2.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.2.1
+        version: 0.2.3
 - !ruby/object:Gem::Dependency
   name: openreceive-server
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.2.1
+        version: 0.2.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.2.1
+        version: 0.2.3
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -51,6 +51,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '8.0'
+- !ruby/object:Gem::Dependency
+  name: nwc-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.4
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement