openreceive-rails 0.4.5 → 0.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c0caf7ce83354949800f2ccbc89f464ef29836d727119b597e171b229d55eae
-  data.tar.gz: 7f724089996083fa10d5f73482a832cea99b0a409feade661eb66e3837ecd950
+  metadata.gz: 2cd25ab457fdc7a54d989c2a490fa75d451362157618702bc3e101d461c450d4
+  data.tar.gz: c377fd378153bd78bb195000a74efd776587b40d1a8927a514aa7b9739da8986
 SHA512:
-  metadata.gz: 386c6e60be7d4dfb562b5b16f62792c46a8eee488e217174c85ce2a3daef49605b45221bd56d2d81f4ab72fd313243c97c53b362f7c835fe8fa9c06722bd61c6
-  data.tar.gz: 2dc97ae52f9d6d470384ccff786e8383619fc349abaf31e1365532f62721b3b6dcabb845b5774a4471c19a7fccc1cf8ecdff0c916cc53c6224c56810c4e17220
+  metadata.gz: 980779f4826ebc988f9d6b11a24004153477b84738ba26e5ad849658137b24edd8d5f3cded4d212ae6e17f4c69a6d02d3398cca5abc2417033d599f9c7665fb3
+  data.tar.gz: c48b85c8349b5bc27ae2c8f2b1dc9a9aa4f1f81640850368a4a411ca5035cdad5bd3e8d9f03298077516c8dbd163c82c42c60a448d43431f24dc8ddb494731e4

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # 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

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

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

@@ -1,6 +1,6 @@
 # OpenReceive agent directions (BTCPay Server)
 
-These directions describe OpenReceive 0.4.5.
+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.5.
+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.5.
+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.5.
+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.5.
+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.5.
+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.5.
+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.5.
+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.5.
+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

@@ -1,6 +1,6 @@
 # OpenReceive agent directions (WordPress + WooCommerce)
 
-These directions describe OpenReceive 0.4.5.
+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.
@@ -90,6 +90,29 @@ Requirements: WordPress 6.6+, WooCommerce 9+, 64-bit PHP 8.2+ with GMP and sodiu
 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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openreceive-rails
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.4.6
 platform: ruby
 authors:
 - OpenReceive
@@ -15,28 +15,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.4.5
+        version: 0.4.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.4.5
+        version: 0.4.6
 - !ruby/object:Gem::Dependency
   name: openreceive-server
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.4.5
+        version: 0.4.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.4.5
+        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: []
@@ -145,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:
@@ -163,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: []