async-matrix-bridge 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a39da8f7af838f517e3a60456691bf8dbcf5f69945a3f1f196bc2383ba5d3c07
+  data.tar.gz: fa6179dba22657736ba68f793838df46afcf72e861c25a9291e1677534910681
+SHA512:
+  metadata.gz: 730ea22e8169a98f4e7a60da0db81af72769253a7fa9d0d288d3f33303323e2c1a09f8a00b2ff3187e86dfe757fee4b5baaba637d6dbe5e7c8cde4f96997c4ac
+  data.tar.gz: 30aa42aeff5abcee92b2707538e081797f89a81bf5f2dea2188d9948d7dfc4774dcda309c6dc46f7a793e3e4bda33d446e5ec78bbebec69ee3f4eb2e30fe2e9d

data/LICENSE

@@ -0,0 +1,200 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. Please also get an
+      individualized contributor license agreement from each contributor.
+
+   Copyright 2026 General Intelligence Systems
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,195 @@
+# async-matrix-bridge
+
+[![Gem Version](https://img.shields.io/gem/v/async-matrix-bridge)](https://rubygems.org/gems/async-matrix-bridge)
+[![CI](https://github.com/general-intelligence-systems/async-matrix-bridge/actions/workflows/test.yaml/badge.svg)](https://github.com/general-intelligence-systems/async-matrix-bridge/actions/workflows/test.yaml)
+[![License](https://img.shields.io/github/license/general-intelligence-systems/async-matrix-bridge)](https://github.com/general-intelligence-systems/async-matrix-bridge/blob/main/LICENSE)
+[![Ruby](https://img.shields.io/badge/ruby-%3E%3D%203.3-red)](https://www.ruby-lang.org)
+
+Async-native [Matrix](https://matrix.org) Application Service SDK for Ruby -- the server side of a bridge or bot. Built on [async-matrix](https://github.com/general-intelligence-systems/async-matrix) and the [Socketry](https://github.com/socketry) ecosystem (`async`, `async-http`). No threads, no callbacks -- just fibers.
+
+Your homeserver `PUT`s transactions of events at your service; this gem authenticates them with a constant-time token compare, deduplicates them by transaction ID, and hands each event to a block you pattern match on -- concurrently, in its own fiber. Calls back to the homeserver go through async-matrix's `Client`.
+
+## Install
+
+```ruby
+gem "async-matrix-bridge"
+```
+
+An `Endpoint` is not a Rack app and needs no Rack server. Add one only if you
+want to run it in a Rack stack:
+
+```ruby
+gem "ratalada", "~> 4.0"
+gem "protocol-rack"
+```
+
+## Quick Start
+
+The whole protocol is one class, and the events reach a block you pattern match
+on. There is no handler to register, no filter DSL and no base class.
+
+```ruby
+require "async/matrix/bridge"
+require "ratalada/async"
+
+Bridge = Async::Matrix::Bridge
+
+config = Bridge::Registration.load("/config/registration.yaml",
+  homeserver: "http://synapse:8008", domain: "localhost")
+
+client = Async::Matrix::Client.new(config)
+store = Bridge::TransactionStore.new
+bot = config.bot_mxid
+
+Server.run(host: "0.0.0.0", port: 9000) do |request|
+  Bridge::Endpoint.new(request, config: config, store: store) do |message|
+    case message
+    in {type: "m.room.member", content: {membership: "invite"}, room_id:, state_key: ^bot}
+      client.join_room(room_id)
+    in {type: "m.room.message", content: {msgtype: "m.text", body:}, room_id:, sender:} if sender != bot
+      client.send_notice(room_id, "Echo: #{body}")
+    else
+      nil
+    end
+  end.response
+end
+```
+
+`Endpoint` also accepts a Rack env, so the same block works under any Rack
+server — pass `request.env` there instead.
+
+Working stacks with Synapse and Docker Compose live in
+[`examples/`](https://github.com/general-intelligence-systems/async-matrix-bridge/tree/main/examples).
+
+## Pattern matching
+
+The block is handed plain **symbol-keyed** Hashes. That is deliberate: Ruby's
+hash patterns match Symbol keys only, so `in {type: "m.room.message"}` would
+never match a `{"type" => ...}` parsed from JSON. Parsing with
+`symbolize_names` is what makes `case/in` destructure nested content with no
+`deconstruct_keys` on anything.
+
+The filters that used to be DSL options are now ordinary pattern syntax -- a
+pin for "addressed to me", a guard for "not from me":
+
+```ruby
+in {type: "m.room.member", content: {membership: "invite"}, state_key: ^bot}
+in {type: "m.room.message", content: {msgtype: "m.text", body:}, sender:} if sender != bot
+```
+
+Third-party protocol, location and user queries reach the same block as a
+`:query` Hash, so one `case` covers the whole protocol. Whatever it returns is
+the JSON body; `nil` is `M_NOT_FOUND`.
+
+```ruby
+in {query: :protocol, protocol:}
+  {instances: instances_for(protocol)}
+```
+
+## Without Rack
+
+`Endpoint` takes either a Rack env or a `Protocol::HTTP::Request`, and answers
+with whichever response type the source implies. So the same class drops into a
+bare `Async::HTTP::Server` with no Rack anywhere in the stack:
+
+```ruby
+server = Async::HTTP::Server.for(endpoint) do |request|
+  Bridge::Endpoint.new(request, config: config, store: store) do |message|
+    case message
+    in {type: "m.room.message", content: {body:}, room_id:}
+      client.send_notice(room_id, "Echo: #{body}")
+    else
+      nil
+    end
+  end.response
+end
+```
+
+Do not pin the server to HTTP/2: homeservers push transactions over HTTP/1.1
+and will not do h2c with prior knowledge, so a forced-HTTP2 listener never
+receives an event.
+
+## Your own routes
+
+An `Endpoint` answers `404` for any path outside `/_matrix/app/v1`, so it works
+as the fall-through of a router that matches its own routes first. Ask
+`handled?` if you would rather compose explicitly.
+
+```ruby
+Server.run do |request|
+  case request
+  in ["GET", "/healthz"] then "ok\n"
+  else Bridge::Endpoint.new(request, config: config, store: store) { |message| ... }.response
+  end
+end
+```
+
+## Concurrency and retries
+
+The events of a transaction are dispatched in their own fibers, bounded by
+`concurrency:` (default 8), and all of them are awaited before the response.
+
+If the block raises, the response is `500` and the transaction id is **not**
+recorded, so the homeserver retries it. Recording it and answering `200` would
+make a failed handler drop its events permanently, since the retry would be
+deduplicated away.
+
+## Configuration
+
+`Registration` reads the application service registration file -- the one your
+homeserver already loads -- and validates it against the Matrix spec's own
+schema, vendored verbatim from
+[matrix-org/matrix-spec](https://github.com/matrix-org/matrix-spec/tree/main/data/api/application-service/definitions).
+Nothing is restated: the tokens, the sender localpart and the namespaces are
+read from the file the homeserver reads.
+
+```yaml
+# registration.yaml -- give this to your homeserver
+id: agent
+url: "http://appservice:9000"
+as_token: "your-appservice-token"
+hs_token: "your-homeserver-token"
+sender_localpart: agent
+namespaces:
+  users:
+    - exclusive: false
+      regex: "@.*:localhost"
+  aliases: []
+  rooms: []
+```
+
+```ruby
+config = Bridge::Registration.load("registration.yaml",
+  homeserver: "http://synapse:8008", domain: "localhost")
+
+config.bot_mxid                              # => "@agent:localhost"
+config.covers?(:users, "@alice:localhost")   # => true
+config.exclusive?(:users, "@alice:localhost") # => false
+```
+
+`homeserver:` and `domain:` are separate arguments because a registration
+describes the service *to* the homeserver and so cannot carry the server's own
+address. `domain` is required rather than inferred from the URL: a
+`server_name` need not match the host it is served from, and a wrong guess
+yields plausible, broken MXIDs.
+
+## Development
+
+```bash
+bin/test      # scampi, co-located `__END__` specs
+bin/rubocop
+```
+
+async-matrix is an ordinary RubyGems dependency -- it resolves from RubyGems like any other gem, including inside the Nix devshell. To try a change to the core gem against this one, publish a prerelease of it, or `bundle config local` a git checkout; do not add a `path:` entry to the Gemfile. `bundlerEnv` cannot resolve a relative path source pointing outside the flake, so a path gem breaks `nix develop` outright.
+
+## Built With
+
+- [async-matrix](https://github.com/general-intelligence-systems/async-matrix) -- the Matrix protocol layer (client, events, media, E2EE)
+- [async](https://github.com/socketry/async) -- fiber-based concurrency framework
+- [protocol-http](https://github.com/socketry/protocol-http) -- the HTTP semantics `Endpoint` answers in
+- [json_schemer](https://github.com/davishmcclurg/json_schemer) -- JSON Schema validation
+- [scampi](https://github.com/general-intelligence-systems/scampi) -- inline co-located test framework
+
+## License
+
+Apache 2.0