ashpd 0.1.1

data/Cargo.toml

@@ -0,0 +1,7 @@
+# Workspace root. rb_sys / rake-compiler (and rb-sys-dock during
+# cross-compilation) run `cargo metadata` from the repository root, so the native
+# extension crate under ext/ must be declared here as a workspace member. The
+# resolved Cargo.lock also lives at the root for reproducible cross builds.
+[workspace]
+members = ["ext/ashpd"]
+resolver = "2"

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/NOTICE

@@ -0,0 +1,43 @@
+Ashpd for Ruby
+Copyright 2026 General Intelligence Systems
+
+This product includes software developed at The Matrix.org Foundation C.I.C.
+
+--------------------------------------------------------------------------------
+ashpd
+--------------------------------------------------------------------------------
+
+The native extension under ext/ashpd links ashpd, the Rust
+implementation of the Olm and Megolm cryptographic ratchets. This gem is
+bindings for it and nothing else: every class it defines wraps a type of that
+crate.
+
+  https://github.com/matrix-org/ashpd
+  Copyright 2021-2026 The Matrix.org Foundation C.I.C.
+  Licensed under the Apache License, Version 2.0
+
+--------------------------------------------------------------------------------
+matrix-rust-sdk
+--------------------------------------------------------------------------------
+
+matrix-rust-sdk is the reference for how these primitives are driven, and the
+primary consumer of ashpd. Where logic here is derived from it, the
+derivation is noted at the point it appears.
+
+  https://github.com/matrix-org/matrix-rust-sdk
+  Copyright 2020-2026 The Matrix.org Foundation C.I.C.
+  Licensed under the Apache License, Version 2.0
+
+matrix-rust-sdk carries no NOTICE file of its own, so there is nothing further
+to propagate under section 4(d) of the License.
+
+--------------------------------------------------------------------------------
+On Fractal
+--------------------------------------------------------------------------------
+
+Fractal is a GTK Matrix client which is useful to read for how a client drives
+encryption, and it appears in no part of this product. It is licensed
+GPL-3.0-or-later, which is incompatible with the Apache License this work is
+distributed under, so no code or comment may be copied from it. Reading it to
+learn which operations a flow needs is fine; carrying its expression across is
+not.

data/ext/ashpd/Cargo.toml

@@ -0,0 +1,45 @@
+# The package is named ashpd, which RbSys::ExtensionTask requires: it looks the
+# package up by the name the Rakefile gives it, and names the built object after
+# it. So the crate it binds is renamed to ashpd_core on the dependency instead,
+# which is how `use ashpd_core::desktop` refers to it throughout.
+#
+# Without the rename the two would collide: the extern prelude would hold the
+# dependency under the same name as this package.
+[package]
+name = "ashpd"
+version = "0.1.0"
+edition = "2021"
+publish = false
+
+[lib]
+name = "ashpd"
+crate-type = ["cdylib"]
+
+[dependencies]
+# magnus 0.9 for the same reasons as vodozemac-rb: 0.7 fails against Ruby 4.0,
+# and 0.9 is what cross-compiles for arm-linux-musl.
+magnus = "0.9"
+
+# ashpd drives every portal call as a future, so the extension owns a runtime
+# and blocks on it. Same shape as oo7-rb, and for the same reason: zbus spawns
+# its own socket reader task, so the runtime has to keep driving background work
+# while a call waits. Hence multi-thread with one worker rather than
+# current-thread.
+tokio = { version = "1", features = ["rt", "rt-multi-thread", "time", "net"] }
+
+# ashpd 0.13, MIT. It speaks the XDG Desktop Portal D-Bus interfaces through
+# zbus directly, so this binding loads no libportal and no libxdp -- the same
+# trade as oo7-rb makes against libsecret.
+#
+# Default features are `tokio`, which is the runtime above.
+#
+# Deliberately not enabled yet, each of which widens the build considerably:
+#   - `gtk4` (= gtk4_x11 + gtk4_wayland) pulls in the gtk4, gdk4x11 and
+#     gdk4wayland crates. It exists to turn a GTK window into a parent handle
+#     for a modal portal dialog, which is what the XdpGtk4 gap needs.
+#   - `pipewire` pulls in libpipewire, needed only to consume a screencast
+#     stream rather than to request one.
+[dependencies.ashpd_core]
+package = "ashpd"
+version = "0.13"
+features = ["location", "file_chooser", "notification", "open_uri", "screenshot", "settings", "trash", "camera", "background", "account"]

data/ext/ashpd/extconf.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+# Released under the Apache License, Version 2.0.
+# Copyright, 2026, by General Intelligence Systems.
+
+require "mkmf"
+require "rb_sys/mkmf"
+
+# Builds the Rust crate in this directory and produces ashpd.so.
+# The crate's #[magnus::init] defines the classes under Ashpd.
+create_rust_makefile("ashpd")

data/ext/ashpd/src/lib.rs

@@ -0,0 +1,230 @@
+//! Ruby bindings for ashpd, the Rust XDG Desktop Portal client, via magnus.
+//!
+//! The point of this binding is what it does *not* load. libportal reaches the
+//! portals through GIO and carries a GLib main loop with it. ashpd speaks the
+//! `org.freedesktop.portal.*` D-Bus interfaces itself through zbus, so neither
+//! libportal nor libxdp is in the address space -- the same trade oo7-rb makes
+//! against libsecret.
+//!
+//! Each portal is a module function or a class method under `Ashpd`, named for
+//! the interface it speaks to: `Ashpd::Screenshot`, `Ashpd::OpenUri`,
+//! `Ashpd::Trash`, `Ashpd::Settings`, `Ashpd::Camera`, `Ashpd::Account`.
+//!
+//! # Blocking
+//!
+//! Every method on the crate is async. Each binding drives it to completion on
+//! a Tokio runtime owned by this extension and returns the result, so the Ruby
+//! API is ordinary and synchronous. The calling thread is blocked while it waits
+//! and the GVL is held.
+//!
+//! That matters more here than it does for a keyring. A portal call shows the
+//! user a dialog and does not return until they answer it, so a call made on a
+//! GTK main loop freezes the window that the dialog is modal to. Put these on a
+//! Ruby thread.
+//!
+//! # Window identifiers
+//!
+//! A portal dialog wants a parent window to be modal to, which is what
+//! `WindowIdentifier` carries. Obtaining one from a live GTK window needs
+//! ashpd's `gtk4` feature, and that pulls the gtk4, gdk4x11 and gdk4wayland
+//! crates into the build. It is deliberately not enabled yet: every request
+//! here is sent without an identifier, so dialogs are parentless. Enabling it
+//! is what the XdpGtk4 gap needs.
+//!
+//! # Provenance
+//!
+//!   - <https://github.com/bilelmoussaoui/ashpd> (MIT)
+//!   - <https://flatpak.github.io/xdg-desktop-portal/docs/> (the interfaces)
+
+use std::fs::File;
+use std::future::Future;
+use std::sync::OnceLock;
+
+use magnus::{function, prelude::*, Error, RArray, RHash, Ruby};
+
+use ashpd_core::desktop::account::UserInformation;
+use ashpd_core::desktop::camera::Camera;
+use ashpd_core::desktop::open_uri::OpenFileRequest;
+use ashpd_core::desktop::screenshot::Screenshot;
+use ashpd_core::desktop::settings::{ColorScheme, Settings};
+use ashpd_core::desktop::trash;
+use ashpd_core::Uri;
+use tokio::runtime::{Builder, Runtime};
+
+// --- helpers ---------------------------------------------------------------
+
+fn rt_err<E: std::fmt::Display>(e: E) -> Error {
+    // Safe: every caller runs inside a Ruby method invocation (GVL held).
+    let ruby = Ruby::get().expect("rt_err called outside the Ruby VM");
+    Error::new(ruby.exception_runtime_error(), e.to_string())
+}
+
+/// One runtime for the whole extension, built on first use.
+///
+/// A current-thread runtime is not enough: zbus spawns its own socket reader
+/// task, so the runtime has to keep driving background work while a portal
+/// request waits for the user to answer a dialog. Hence the multi-thread
+/// flavour with one worker, as in oo7-rb.
+fn runtime() -> Result<&'static Runtime, Error> {
+    static RUNTIME: OnceLock<std::io::Result<Runtime>> = OnceLock::new();
+
+    RUNTIME
+        .get_or_init(|| Builder::new_multi_thread().worker_threads(1).enable_all().build())
+        .as_ref()
+        .map_err(rt_err)
+}
+
+fn block<F: Future>(future: F) -> Result<F::Output, Error> {
+    Ok(runtime()?.block_on(future))
+}
+
+/// A portal colour, which the interfaces give as three doubles in 0.0..=1.0.
+fn color_to(ruby: &Ruby, red: f64, green: f64, blue: f64) -> RArray {
+    let array = ruby.ary_new_capa(3);
+    let _ = array.push(red);
+    let _ = array.push(green);
+    let _ = array.push(blue);
+    array
+}
+
+fn uri_from(uri: &str) -> Result<Uri, Error> {
+    Uri::parse(uri).map_err(rt_err)
+}
+
+// --- org.freedesktop.portal.Screenshot -------------------------------------
+
+/// Take a screenshot, returning the URI of the file the portal wrote.
+///
+/// `interactive` lets the user choose the area and is what a user expects from a
+/// screenshot tool; without it the portal decides, which on GNOME means the
+/// whole screen after its own confirmation.
+fn screenshot(interactive: bool, modal: bool) -> Result<String, Error> {
+    let request = Screenshot::request().interactive(interactive).modal(modal);
+    let response = block(request.send())?.map_err(rt_err)?;
+
+    Ok(response.response().map_err(rt_err)?.uri().as_str().to_owned())
+}
+
+/// Pick one colour off the screen, as `[red, green, blue]` in 0.0..=1.0.
+fn pick_color(ruby: &Ruby) -> Result<RArray, Error> {
+    let proxy = block(ashpd_core::desktop::screenshot::ScreenshotProxy::new())?.map_err(rt_err)?;
+    let request = block(proxy.pick_color(None, Default::default()))?.map_err(rt_err)?;
+    let color = request.response().map_err(rt_err)?;
+
+    Ok(color_to(ruby, color.red(), color.green(), color.blue()))
+}
+
+// --- org.freedesktop.portal.OpenURI ----------------------------------------
+
+/// Hand a URI to whatever the user's desktop opens it with.
+///
+/// `ask` forces the application chooser even when a default is set.
+fn open_uri(uri: String, writeable: bool, ask: bool) -> Result<(), Error> {
+    let uri = uri_from(&uri)?;
+    let request = OpenFileRequest::default().writeable(writeable).ask(ask);
+
+    block(request.send_uri(&uri))?.map_err(rt_err)?;
+
+    Ok(())
+}
+
+// --- org.freedesktop.portal.Trash ------------------------------------------
+
+/// Move a path to the user's trash.
+///
+/// The interface takes a file descriptor rather than a path, so the file is
+/// opened here. It is opened read-only: the portal needs it only to identify
+/// what to move, and asking for write would fail on a file the user can trash
+/// but not modify.
+fn trash_file(path: String) -> Result<(), Error> {
+    let file = File::open(&path).map_err(rt_err)?;
+
+    block(trash::trash_file(&file))?.map_err(rt_err)?;
+
+    Ok(())
+}
+
+// --- org.freedesktop.portal.Settings ---------------------------------------
+
+/// The user's light/dark preference, as `"no_preference"`, `"prefer_dark"` or
+/// `"prefer_light"` -- the interface's own three values, not a boolean, because
+/// "no preference" is a distinct state an application is meant to handle.
+fn color_scheme() -> Result<String, Error> {
+    let settings = block(Settings::new())?.map_err(rt_err)?;
+    let scheme = block(settings.color_scheme())?.map_err(rt_err)?;
+
+    Ok(match scheme {
+        ColorScheme::NoPreference => "no_preference",
+        ColorScheme::PreferDark => "prefer_dark",
+        ColorScheme::PreferLight => "prefer_light",
+    }
+    .to_owned())
+}
+
+/// The user's accent colour, as `[red, green, blue]` in 0.0..=1.0.
+fn accent_color(ruby: &Ruby) -> Result<RArray, Error> {
+    let settings = block(Settings::new())?.map_err(rt_err)?;
+    let color = block(settings.accent_color())?.map_err(rt_err)?;
+
+    Ok(color_to(ruby, color.red(), color.green(), color.blue()))
+}
+
+// --- org.freedesktop.portal.Camera -----------------------------------------
+
+/// Whether the host has a camera at all.
+///
+/// This is a property read, not a request, so it shows the user nothing and is
+/// the right thing to branch a UI on before asking for access.
+fn camera_present() -> Result<bool, Error> {
+    let camera = block(Camera::new())?.map_err(rt_err)?;
+
+    block(camera.is_present())?.map_err(rt_err)
+}
+
+// --- org.freedesktop.portal.Account ----------------------------------------
+
+/// Ask the user to share their identity, as `{"id" =>, "name" =>, "image" =>}`.
+///
+/// `reason` is shown to the user in the dialog, so it should say what the
+/// application wants it for.
+fn user_information(ruby: &Ruby, reason: String) -> Result<RHash, Error> {
+    let request = UserInformation::request().reason(reason.as_str());
+    let response = block(request.send())?.map_err(rt_err)?;
+    let information = response.response().map_err(rt_err)?;
+
+    let hash = ruby.hash_new();
+    hash.aset("id", information.id())?;
+    hash.aset("name", information.name())?;
+    hash.aset("image", information.image().as_str())?;
+
+    Ok(hash)
+}
+
+// --- init ------------------------------------------------------------------
+
+#[magnus::init]
+fn init(ruby: &Ruby) -> Result<(), Error> {
+    let namespace = ruby.define_module("Ashpd")?;
+
+    let screenshot_module = namespace.define_module("Screenshot")?;
+    screenshot_module.define_singleton_method("capture", function!(screenshot, 2))?;
+    screenshot_module.define_singleton_method("pick_color", function!(pick_color, 0))?;
+
+    let open_uri_module = namespace.define_module("OpenUri")?;
+    open_uri_module.define_singleton_method("open", function!(open_uri, 3))?;
+
+    let trash_module = namespace.define_module("Trash")?;
+    trash_module.define_singleton_method("file", function!(trash_file, 1))?;
+
+    let settings_module = namespace.define_module("Settings")?;
+    settings_module.define_singleton_method("color_scheme", function!(color_scheme, 0))?;
+    settings_module.define_singleton_method("accent_color", function!(accent_color, 0))?;
+
+    let camera_module = namespace.define_module("Camera")?;
+    camera_module.define_singleton_method("present?", function!(camera_present, 0))?;
+
+    let account_module = namespace.define_module("Account")?;
+    account_module.define_singleton_method("user_information", function!(user_information, 1))?;
+
+    Ok(())
+}

data/lib/ashpd/version.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# Released under the Apache License, Version 2.0.
+# Copyright, 2026, by General Intelligence Systems.
+
+module Ashpd
+  VERSION = "0.1.1"
+end

data/lib/ashpd/version.rb.erb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# Released under the Apache License, Version 2.0.
+# Copyright, 2026, by General Intelligence Systems.
+
+module Ashpd
+  VERSION = "<%= version %>"
+end

data/lib/ashpd.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# Released under the Apache License, Version 2.0.
+# Copyright, 2026, by General Intelligence Systems.
+
+require_relative "ashpd/version"
+
+# The native extension, which is where every class in this module is defined.
+#
+# A precompiled platform gem carries one object per Ruby ABI, which rake-compiler puts under lib/ashpd/3.3, 3.4 and so on. The source gem compiles one object and installs it beside the library, which is also where `rake compile` puts it.
+begin
+  require_relative "ashpd/#{RUBY_VERSION[/\d+\.\d+/]}/ashpd"
+rescue LoadError
+  require_relative "ashpd/ashpd"
+end
+
+# Ruby bindings for ashpd, the Rust XDG Desktop Portal client.
+#
+# The portals are how a sandboxed application asks the user for something it cannot take: a screenshot, a file outside its sandbox, the camera, the trash. ashpd speaks the `org.freedesktop.portal.*` D-Bus interfaces through zbus and does not load libportal or libxdp, so neither is in this process.
+#
+# Each portal is a module named for its interface: {Screenshot}, {OpenUri}, {Trash}, {Settings}, {Camera}, {Account}.
+#
+# Every call is synchronous, and a portal call that shows a dialog does not return until the user answers it. On a GTK main loop that freezes the window the dialog is modal to, so put these on a Ruby thread.
+module Ashpd
+end