openreceive-rails 0.4.4 → 0.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0e01e9b76a2a924c07b7403a1a103e5db904147fcd8a44f385cf42ba616b97c
-  data.tar.gz: 59c7558cd8a72dc905517c8812750c1ed53f56495797ccc40b4eca5924eb2cb5
+  metadata.gz: 2cd25ab457fdc7a54d989c2a490fa75d451362157618702bc3e101d461c450d4
+  data.tar.gz: c377fd378153bd78bb195000a74efd776587b40d1a8927a514aa7b9739da8986
 SHA512:
-  metadata.gz: 636b758e07b9bdce4155984fc29629b2ac7b90aee6302605836513595900f837933fba80df7b3ec06e0f40537dc6c8f223b0ffcdeeb5dd5eef25111e390006fd
-  data.tar.gz: c591cacae9e9e4adedd2aa633fdaa6b2e375829d11f3746c94a01dd56abb930a5c135c7f7d0a304d3a38dd5542d9a5e7ce480dc50d013e2752721cb00ba924e8
+  metadata.gz: 980779f4826ebc988f9d6b11a24004153477b84738ba26e5ad849658137b24edd8d5f3cded4d212ae6e17f4c69a6d02d3398cca5abc2417033d599f9c7665fb3
+  data.tar.gz: c48b85c8349b5bc27ae2c8f2b1dc9a9aa4f1f81640850368a4a411ca5035cdad5bd3e8d9f03298077516c8dbd163c82c42c60a448d43431f24dc8ddb494731e4

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## 0.4.6 - 2026-09-11
+
+Refresh installation and quickstart documentation and package metadata.
+The Rails demo places the order id and return link below payment choices and
+the Lightning wallet list on mobile, while keeping the desktop sidebar.
+Release in lockstep with openreceive 0.4.6 and its live-price request fix;
+no Rails engine API change.
+
+## 0.4.5 - 2026-09-07
+
+Release in lockstep with the Python/PHP publishing workflow fixes and complete
+WooCommerce integration documentation. Shared HTTP golden fixtures now use
+the canonical placeholder definitions. No Ruby public API change.
+
 ## 0.4.4 - 2026-09-07
 
 Version lockstep with the 0.4.4 npm release (every checkout image now ships

data/README.md

@@ -1,17 +1,55 @@
 # openreceive-rails
 
-Mountable receive-only OpenReceive engine. The engine owns the
-`OpenReceivePayment` attempt model (statuses `pending`, `settled`, `expired`,
-`failed`, `attention`), its per-reference commit locking, settlement write-once, and
-the reconciliation state machine. The install generator mounts the routes and
-emits the initializer plus one migration creating both engine tables
-(`openreceive_payments` and the `openreceive_meta` reconcile gate):
+**Accept Bitcoin Lightning payments in Rails. Your app, your wallet.**
+
+[OpenReceive](https://openreceive.org) adds Lightning checkout to your Rails app
+and sends payments directly to a wallet you control. Mount the engine, connect
+a receive-only Nostr Wallet Connect (NWC) wallet, and connect three hooks:
+authorize a request, look up the order amount, and handle a settled payment.
+
+OpenReceive supports optional swaps from **USDT, USDC, SOL, and ETH** through
+a configured swap provider. The provider converts the payment to **BTC over
+Lightning**, which settles into the merchant's connected wallet. Available
+assets and networks depend on the provider; swaps are optional.
+
+- **Fits your app:** keep your orders, users, prices, and fulfillment in Rails.
+- **Uses your database:** payment attempts and reconciliation live alongside
+  your application data, with PostgreSQL, SQLite, and MySQL support.
+- **Handles the payment lifecycle:** invoice creation, payment checks, retry
+  coordination, and settlement reconciliation are built in.
+- **Keeps operations simple:** no separate OpenReceive database, Redis, or
+  payment service to deploy. Wallet notifications can run in an optional worker.
+
+## Get started
+
+Requires Ruby 3.2 or later and Rails 8.0 or later. Add to your Gemfile:
+
+```ruby
+gem "openreceive-rails"
+```
+
+Run `bundle install`, then install the engine:
 
 ```sh
 bin/rails generate openreceive:install
 bin/rails db:migrate
 ```
 
+The core, server, and default NWC client gems are included as dependencies.
+Follow the [Rails quickstart](https://github.com/OpenReceive/openreceive/blob/master/docs/guides/quickstart-rails.md) for native
+build prerequisites, wallet configuration, the three hooks, and the checkout UI.
+The generator creates the initializer, migration, and route mount; configure
+the wallet and hooks before accepting payments.
+
+## How it fits into Rails
+
+The engine owns the
+`OpenReceivePayment` attempt model (statuses `pending`, `settled`, `expired`,
+`failed`, `attention`), its per-reference commit locking, settlement write-once, and
+the reconciliation state machine. The install generator mounts the routes and
+emits the initializer plus one migration creating both engine tables
+(`openreceive_payments` and the `openreceive_meta` reconcile gate).
+
 The generated migration supports PostgreSQL, SQLite, and MySQL, and seeds the
 shared `schema_version`; on its first database touch the engine refuses to
 operate a database whose stored schema version is newer than the gem.
@@ -50,3 +88,13 @@ application refuses to start when the connection advertises spend methods unless
 `config.allow_spend_capable_wallet` or `OPENRECEIVE_ALLOW_SPEND_CAPABLE_NWC`
 overrides it. Keep ordinary settings such as `config.price_currencies` in
 `config/initializers/openreceive.rb`.
+
+## Links
+
+- Rails quickstart: [Connect your first checkout](https://github.com/OpenReceive/openreceive/blob/master/docs/guides/quickstart-rails.md)
+- API reference: [Configuration, hooks, and reconciliation](https://github.com/OpenReceive/openreceive/blob/master/docs/guides/api-reference.md)
+- Host testing: [Test your integration without a wallet](https://github.com/OpenReceive/openreceive/blob/master/docs/guides/host-testing.md)
+- Source and issues: <https://github.com/openreceive/openreceive>
+- Changelog: [CHANGELOG.md](CHANGELOG.md)
+
+MIT license.

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.4.4"
+    VERSION = "0.4.6"
   end
 end

data/skills/integrate-openreceive/SKILL.md

@@ -30,6 +30,7 @@ code** (`NWC_URI`).
    - Rails: [references/rails.md](references/rails.md)
    - Django: [references/django.md](references/django.md)
    - Laravel: [references/laravel.md](references/laravel.md)
+   - WordPress + WooCommerce: [references/woocommerce.md](references/woocommerce.md) — the packaged gateway and merchant settings.
    - BTCPay Server: [references/btcpay.md](references/btcpay.md) — a plugin,
      configured in BTCPay's store UI or Greenfield API; no application code,
      no npm packages, no gem. The rest of this file is about the library.

data/skills/integrate-openreceive/references/btcpay.md

@@ -1,6 +1,6 @@
 # OpenReceive agent directions (BTCPay Server)
 
-These directions describe OpenReceive 0.4.4.
+These directions describe OpenReceive 0.4.6.
 
 Connect a BTCPay Server store to a receive-only NWC wallet with the OpenReceive
 plugin, and optionally let payers pay BTCPay invoices with USDT, USDC, ETH or

data/skills/integrate-openreceive/references/django.md

@@ -1,6 +1,6 @@
 # OpenReceive agent directions (Django)
 
-These directions describe OpenReceive 0.4.4.
+These directions describe OpenReceive 0.4.6.
 
 Add OpenReceive to a Django project — the app you are already working in. You
 do not need a copy of the OpenReceive source: the Python package is on PyPI

data/skills/integrate-openreceive/references/fastapi.md

@@ -1,6 +1,6 @@
 # OpenReceive agent directions (FastAPI)
 
-These directions describe OpenReceive 0.4.4.
+These directions describe OpenReceive 0.4.6.
 
 Add OpenReceive to a FastAPI application — the app you are already working in.
 You do not need a copy of the OpenReceive source: the engine is on PyPI

data/skills/integrate-openreceive/references/fastify.md

@@ -1,6 +1,6 @@
 # OpenReceive agent directions (Fastify)
 
-These directions describe OpenReceive 0.4.4.
+These directions describe OpenReceive 0.4.6.
 
 Add OpenReceive to a Fastify application — the app you are already working in.
 You do not need a copy of the OpenReceive source: the packages are on npm, and

data/skills/integrate-openreceive/references/laravel.md

@@ -1,6 +1,6 @@
 # OpenReceive agent directions (Laravel)
 
-These directions describe OpenReceive 0.4.4.
+These directions describe OpenReceive 0.4.6.
 
 Add OpenReceive to a Laravel application — the app you are already working in.
 You do not need a copy of the OpenReceive source: the package is on Packagist

data/skills/integrate-openreceive/references/next.md

@@ -1,6 +1,6 @@
 # OpenReceive agent directions (Next.js)
 
-These directions describe OpenReceive 0.4.4.
+These directions describe OpenReceive 0.4.6.
 
 Add OpenReceive to a Next.js App Router application — the app you are already
 working in. You do not need a copy of the OpenReceive source: the packages are

data/skills/integrate-openreceive/references/node.md

@@ -1,6 +1,6 @@
 # OpenReceive agent directions (Node.js)
 
-These directions describe OpenReceive 0.4.4.
+These directions describe OpenReceive 0.4.6.
 
 Add OpenReceive to a Node application — the app you are already working in. You
 do not need a copy of the OpenReceive source: the packages are on npm, and the

data/skills/integrate-openreceive/references/php.md

@@ -1,6 +1,6 @@
 # OpenReceive agent directions (PHP)
 
-These directions describe OpenReceive 0.4.4.
+These directions describe OpenReceive 0.4.6.
 
 Add OpenReceive to a PHP application — the app you are already working in. You
 do not need a copy of the OpenReceive source: the engine is on Packagist

data/skills/integrate-openreceive/references/rails.md

@@ -1,6 +1,6 @@
 # OpenReceive agent directions (Rails)
 
-These directions describe OpenReceive 0.4.4.
+These directions describe OpenReceive 0.4.6.
 
 Add OpenReceive to a Rails application — the app you are already working in. You
 do not need a copy of the OpenReceive source: the gem is on RubyGems, the

data/skills/integrate-openreceive/references/woocommerce.md

@@ -0,0 +1,176 @@
+# OpenReceive agent directions (WordPress + WooCommerce)
+
+These directions describe OpenReceive 0.4.6.
+
+Install and configure the OpenReceive gateway in the existing WooCommerce
+store. Preserve its theme, checkout, customer accounts, order model and prices.
+The plugin bundles the PHP engine and checkout assets; the merchant does not
+install npm or Composer packages on the WordPress server.
+
+## Step 0 — inspect configuration
+
+Check WordPress, WooCommerce and PHP versions, GMP and sodium availability,
+whether the plugin is installed, and whether the Doctor panel reports the
+receive-only NWC credential as set. Never display its value. For a real store,
+ask the merchant to configure a receive-only wallet if none is available.
+For repository development, use the Docker demo's explicit testkit override.
+
+Upload a built plugin archive, not a zip of the source directory. The plugin
+has not yet been accepted into the WordPress.org directory. Configuration and
+the complete quickstart follow below.
+
+The plugin owns only its payment-attempt tables in the WordPress database.
+WooCommerce owns orders, totals, stock and email. Do not add an external
+idempotency store, payment database, browser wallet credentials or custom
+fulfillment implementation. Guest return links use WooCommerce's order key;
+the plugin verifies it before issuing an expiring order-bound cookie.
+
+Run `wp openreceive doctor` after configuration. Use the documented scheduled
+reconciliation or optional notifications command for offline settlement.
+Manual merchant refunds and provider-managed payer swap refunds are separate
+flows; a receive-only NWC wallet cannot send payments.
+
+## Further reading
+
+- [Express Quickstart (Node)](https://openreceive.org/guides/quickstart-node.md)
+- [Fastify Quickstart](https://openreceive.org/guides/quickstart-fastify.md)
+- [FastAPI Quickstart](https://openreceive.org/guides/quickstart-fastapi.md)
+- [Django Quickstart](https://openreceive.org/guides/quickstart-django.md)
+- [Next.js Quickstart](https://openreceive.org/guides/quickstart-next.md)
+- [Rails Quickstart](https://openreceive.org/guides/quickstart-rails.md)
+- [PHP Quickstart (plain PHP)](https://openreceive.org/guides/quickstart-php.md)
+- [Laravel Quickstart](https://openreceive.org/guides/quickstart-laravel.md)
+- [BTCPay Server Quickstart](https://openreceive.org/guides/quickstart-btcpay.md)
+- [BTCPay Plugin Reference](https://openreceive.org/guides/btcpay-reference.md)
+- [Node ORM Recipes](https://openreceive.org/guides/node-orms.md)
+- [Authorization](https://openreceive.org/guides/authorization.md)
+- [Rate Limiting](https://openreceive.org/guides/rate-limiting.md)
+- [Frontend Checkout](https://openreceive.org/guides/frontend-checkout.md)
+- [Checkout UX](https://openreceive.org/guides/checkout-ux.md)
+- [Headless Checkout](https://openreceive.org/guides/headless-checkout.md)
+- [Automated Swaps](https://openreceive.org/guides/automated-swaps.md)
+- [Swap Refunds](https://openreceive.org/guides/swap-refunds.md)
+- [Lightning Swap Connect URI](https://openreceive.org/guides/lightning-swap-connect.md)
+- [Environment Variables](https://openreceive.org/guides/environment-variables.md)
+- [Payment Storage](https://openreceive.org/guides/storage.md)
+- [Deploying OpenReceive](https://openreceive.org/guides/deploying.md)
+- [Testing Your OpenReceive Integration](https://openreceive.org/guides/host-testing.md)
+- [API Reference](https://openreceive.org/guides/api-reference.md)
+- [Security](https://openreceive.org/guides/security.md)
+- [Provider Registry](https://openreceive.org/guides/provider-registry.md)
+- [Price Feeds](https://openreceive.org/guides/price-feeds.md)
+- [React Material UI Recipe](https://openreceive.org/guides/react-material-ui-recipe.md)
+- [Flask Recipe](https://openreceive.org/guides/flask-recipe.md)
+- [Writing Your Own Checkout Route](https://openreceive.org/guides/custom-checkout-route.md)
+- [Agent Directions: Node.js](https://openreceive.org/guides/agent-directions-node.md)
+- [Agent Directions: Fastify](https://openreceive.org/guides/agent-directions-fastify.md)
+- [Agent Directions: FastAPI](https://openreceive.org/guides/agent-directions-fastapi.md)
+- [Agent Directions: Django](https://openreceive.org/guides/agent-directions-django.md)
+- [Agent Directions: Next.js](https://openreceive.org/guides/agent-directions-next.md)
+- [Agent Directions: Rails](https://openreceive.org/guides/agent-directions-rails.md)
+- [Agent Directions: PHP](https://openreceive.org/guides/agent-directions-php.md)
+- [Agent Directions: Laravel](https://openreceive.org/guides/agent-directions-laravel.md)
+- [Agent Directions: BTCPay Server](https://openreceive.org/guides/agent-directions-btcpay.md)
+- [WordPress + WooCommerce Quickstart](https://openreceive.org/guides/quickstart-woocommerce.md)
+
+---
+
+## The quickstart, in full
+
+Inlined verbatim so this file needs no network access — follow it once Step 0
+passes. The page it comes from is https://openreceive.org/guides/quickstart-woocommerce.
+
+## WordPress + WooCommerce quickstart
+
+Install the built OpenReceive plugin zip through **Plugins → Add New → Upload
+Plugin**, with WooCommerce already active. The source directory needs a build;
+it cannot be uploaded as-is. WordPress.org submission is still pending.
+
+Requirements: WordPress 6.6+, WooCommerce 9+, 64-bit PHP 8.2+ with GMP and sodium,
+and MySQL 8 or MariaDB 10.5+. Activation creates payment-attempt tables in the
+existing WordPress database. No separate database or application is required.
+
+### Get the installable archive
+
+Use `openreceive-wordpress-<version>.zip` from the selected
+[OpenReceive GitHub release](https://github.com/OpenReceive/openreceive/releases)
+when that asset is listed. A GitHub source-code zip is not the plugin archive.
+If the release does not yet provide a built zip, build it on a development
+machine with Node 22+, PHP 8.2+, Composer and WP-CLI:
+
+```sh
+git clone https://github.com/OpenReceive/openreceive.git
+cd openreceive
+git checkout <release-tag>
+npm ci
+npm run build:packages
+composer install --working-dir=packages/php/wordpress
+npm run release:wordpress:build
+```
+
+Upload the resulting `dist/openreceive-wordpress-<version>.zip`. WP-CLI must be
+on `PATH`, or set `OPENRECEIVE_WP_CLI` to the absolute path of its phar. The
+WordPress server needs neither Node nor Composer: dependencies and checkout
+assets are bundled inside the built plugin.
+
+### Configure the wallet
+
+Open **WooCommerce → Settings → Payments → OpenReceive**. Enter a receive-only
+NWC code, save, then enable the gateway. Saving verifies receive permissions
+and fails closed on a spend-capable wallet unless the explicit override is set.
+The password fields never show saved credentials. Values are encrypted using
+keys derived from WordPress's authentication keys; re-enter them after rotating
+those keys.
+
+For managed deployments, configure `OPENRECEIVE_NWC_URI` in `wp-config.php` from
+your server's secret environment. It takes precedence over the settings field.
+Optional `OPENRECEIVE_LSC_URI_PRIMARY` and `OPENRECEIVE_LSC_URI_BACKUP` constants
+configure swap providers. Never put these values in browser code or logs.
+
+### Checkout and settlement
+
+Both WooCommerce checkout blocks and classic checkout redirect to the order-pay
+page. The plugin reads the amount from `WC_Order`, serves the bundled checkout,
+and authorizes the customer through their account, checkout session or an
+expiring signed cookie issued after verifying the order-pay key. Keep that
+order-pay URL available to customers returning to a pending payment or swap
+refund. The plugin verifies that each requested payment hash belongs to the order.
+
+Payment attempts persist before invoice instructions appear. Settlement commits
+once in the payment transaction. WooCommerce's `payment_complete` then handles
+status, stock and emails. A durable order marker lets subsequent requests and
+scheduled passes repair an interruption between settlement and order completion.
+
+The checkout polling drives opportunistic reconciliation through the PHP
+engine's shared database gate. Action Scheduler adds a recurring one-minute
+safety net. Configure a system cron to run WordPress scheduled work on stores
+with little traffic; no page visits means WP-Cron alone cannot guarantee prompt
+settlement. Optional process-manager commands:
+
+```sh
+wp openreceive doctor
+wp openreceive reconcile
+wp openreceive notifications
+```
+
+The notifications command runs as a separate process. The Doctor panel in the
+gateway settings reports schema, credential presence, scheduling and attention
+orders. A currency without a usable price feed makes the gateway unavailable.
+
+### Refunds and removal
+
+The receive-only wallet cannot send merchant refunds. Make those manually from
+your wallet. Payer swap refunds use the configured provider through the same
+authorized order-pay page; enabling LSC payments commits the shop to keeping
+that recovery path available. See [swap refunds](https://openreceive.org/guides/swap-refunds.md).
+
+Deactivation preserves payment records. Deleting the plugin drops its two
+tables only if **Remove data on uninstall** was enabled. WooCommerce orders are
+retained.
+
+### Local example
+
+The repository's `examples/wordpress` Docker stack builds the plugin and seeds
+WooCommerce from the shared button catalog. Run `npm run demo wordpress` for
+the real-wallet mode, or use its documented `compose.testkit.yml` override for
+a disposable fake-wallet shop. No testkit routes are registered by default.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openreceive-rails
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.4.6
 platform: ruby
 authors:
 - OpenReceive
@@ -15,28 +15,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.4.4
+        version: 0.4.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.4.4
+        version: 0.4.6
 - !ruby/object:Gem::Dependency
   name: openreceive-server
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.4.4
+        version: 0.4.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.4.4
+        version: 0.4.6
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -85,16 +85,21 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '2.1'
-description: 'A mountable Rails engine that ships OpenReceive''s receive-only checkout
-  routes into a Rails app. Engine controllers inherit from the host''s ApplicationController
-  (keeping its authentication, current_user, and forgery protection; the shared handler
-  adds JSON-only and same-site gates), delegate to the openreceive-server Service,
-  and obey host-supplied authorization, amount-resolution, and settlement hooks. The
-  engine owns the OpenReceivePayment attempt model, its status state machine, settlement
-  write-once, and reconciliation (OpenReceive.reconcile!, OpenReceive::ReconcileJob,
-  rake openreceive:reconcile); its install generator emits only the migration, initializer,
-  and route mount. Receive-only: it never exposes a spend path, and boot fails closed
-  on spend-capable NWC codes.'
+description: |
+  Add Bitcoin Lightning checkout to your Rails app and receive payments directly
+  into a wallet you control. Mount the engine, connect a receive-only Nostr Wallet
+  Connect (NWC) wallet, and wire up three hooks for authorization, order amounts,
+  and fulfillment.
+
+  Optional swaps let customers pay with USDT, USDC, SOL, and ETH through a
+  configured provider; you receive BTC over Lightning in your wallet. Available
+  assets and networks depend on the provider.
+
+  OpenReceive handles invoices, payment attempts, and settlement reconciliation
+  using your existing application database. Keep your orders,
+  users, prices, and fulfillment in your app, with no separate OpenReceive database,
+  Redis, or payment service to deploy. Includes an install generator, PostgreSQL,
+  SQLite, and MySQL support, plus an optional wallet-notifications worker.
 email:
 - info@openreceive.org
 executables: []
@@ -136,6 +141,7 @@ files:
 - skills/integrate-openreceive/references/node.md
 - skills/integrate-openreceive/references/php.md
 - skills/integrate-openreceive/references/rails.md
+- skills/integrate-openreceive/references/woocommerce.md
 homepage: https://openreceive.org
 licenses:
 - MIT
@@ -144,7 +150,7 @@ metadata:
   source_code_uri: https://github.com/openreceive/openreceive
   changelog_uri: https://github.com/openreceive/openreceive/blob/master/packages/ruby/openreceive-rails/CHANGELOG.md
   bug_tracker_uri: https://github.com/openreceive/openreceive/issues
-  documentation_uri: https://rubydoc.info/gems/openreceive-rails
+  documentation_uri: https://github.com/openreceive/openreceive/blob/master/docs/guides/quickstart-rails.md
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
@@ -162,6 +168,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.9
 specification_version: 4
-summary: OpenReceive mountable Rails engine with engine-owned payment attempts in
-  the host database.
+summary: Accept Bitcoin Lightning payments in Rails. Your app, your wallet.
 test_files: []