librest 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 718fb5e1a819a0110b77dad789a267059afc57f5b5540de75f4a4866a6120a30
+  data.tar.gz: daa3b27e0445ae3352718ef269968ddf5ed50104639364aa80a4e1c2f786f0ac
+SHA512:
+  metadata.gz: 269008f7bb5c791f818dc5e39b4034e44a2f491b55ef36a8be793f109afc0cf4537c284a3ed69a84a6eae54933a4d66d2abc502c1d305933b1be54e36ba59090
+  data.tar.gz: c149f14fcdc5cb8152d63da12b561818b4840a64cf9927af87e5700f60646cbde8c83f45fd4722965fc612b240f26bf03e0ee09e6aa2ef6350a6a2cf8aab5edf

data/CHANGELOG.md

@@ -0,0 +1,32 @@
+# Changelog
+
+All notable changes to this project are documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.0.0] - 2026-11-03
+
+### Added
+
+- `Rest`, defined from the `Rest-1.0.typelib` GObject Introspection typelib at require
+  time, giving librest, calling RESTful web services -- including the OAuth and PKCE signing soup3 does not do. `Rest::Loader` is a `GObjectIntrospection::Loader`
+  subclass, so the binding is the whole namespace rather than a hand-written
+  subset, and it does not drift as the library gains API. The typelib version
+  is `1.0`, read off the package rather than inferred -- these are not
+  guessable, and guessing is how a loader silently fails.
+- A dev shell (`flake.nix`) pinning the library and everything its typelib
+  declares from one nixpkgs, and CI that runs the suite inside it. The
+  environment is the hard part of an introspection binding: a typelib built
+  against a different glib than the `gobject-introspection` gem registers GIO
+  twice in the process and fails with
+  `cannot register existing type 'GTlsCertificate'`.
+- A README naming the distribution package that carries the typelib, and a
+  worked `flake.nix` listing every nix dependency. That list is the gem's own
+  search path, so it cannot drift from what the dev shell uses.
+- Pure Ruby: no extension, no Cargo workspace, no per-platform gem. Installing
+  does still compile C, because `glib2` and `gobject-introspection` are native
+  extensions built against glib, but this gem adds no build step of its own and
+  those two are what every ruby-gnome application already has via `gtk4`.

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 @@
+Librest for Ruby
+Copyright 2026 General Intelligence Systems
+
+This product includes software developed at The Matrix.org Foundation C.I.C.
+
+--------------------------------------------------------------------------------
+librest
+--------------------------------------------------------------------------------
+
+The native extension under ext/librest links librest, 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/librest
+  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 librest. 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/README.md

@@ -0,0 +1,130 @@
+# librest
+
+Ruby bindings for librest, calling RESTful web services -- including the OAuth and PKCE signing soup3 does not do.
+
+```ruby
+require "librest"
+
+Rest.constants.size  # the whole namespace, from the typelib
+```
+
+## How this works, and why there is nothing to compile
+
+librest ships a GObject Introspection typelib that describes every class,
+method, property and signal it has. `Rest::Loader` — twenty lines — hands that
+typelib to ruby-gnome's `GObjectIntrospection::Loader`, which defines the Ruby
+classes from it at `require` time.
+
+So this gem is pure Ruby: no extension of its own, no Cargo workspace, no
+per-platform binary. You get the whole library rather than the subset somebody
+got round to wrapping by hand, and it does not drift when librest gains API.
+
+It is worth being precise about what that does and does not buy you at install
+time. `gem install librest` still compiles C, because `gobject-introspection` and
+`glib2` are themselves native extensions built against glib — so a compiler and
+glib's development headers are needed. What this gem adds on top of that is
+nothing: those two are what every ruby-gnome application already has, since
+`gtk4` depends on them. If you are writing a Ruby GTK app, librest costs you no
+build step you were not already paying.
+
+This is how [ruby-gnome](https://github.com/ruby-gnome/ruby-gnome) itself ships
+gtksourceview5, libsecret and the rest.
+
+## The one thing you must install
+
+The typelib is a C-library artefact, so it belongs to your distribution and
+this gem cannot install it:
+
+| | |
+|---|---|
+| Debian / Ubuntu | `gir1.2-rest-1.0` |
+| Fedora | `rest` |
+| Arch | `librest` |
+| nix | `pkgs.librest` |
+
+If it is not in the default search path, point `GI_TYPELIB_PATH` at the
+directory holding `Rest-1.0.typelib`. The dev shell in `flake.nix` does this.
+
+**One trap worth knowing.** The typelib must come from the same glib build as
+the `gobject-introspection` gem. Mixing two registers GIO twice in one process
+and fails with `cannot register existing type 'GTlsCertificate'`. Under nix,
+take both from one nixpkgs — and note that glib's typelibs are in its `out`
+output, not the default `bin` one.
+
+## Using it from a flake
+
+The gem needs `Rest-1.0.typelib` and everything that typelib declares, resolved
+transitively by the loader at `require` time. A missing one surfaces as
+`Typelib file for namespace 'X' not found`, one at a time, so the whole chain
+is listed here rather than discovered by repeated failure:
+
+- `pkgs.librest` — its typelib, which is where `Rest-1.0.typelib` lives
+- `pkgs.glib` — GLib-2.0, GObject-2.0 and Gio-2.0, which nearly every GNOME typelib declares
+
+Note the `.out`: a package's default output is often `bin`, which carries no
+typelibs. `makeSearchPath` takes the first output, so it has to be asked for
+`out` explicitly — this is the single most common way to get a search path that
+looks right and finds nothing.
+
+```nix
+{
+  inputs.nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
+
+  outputs = { nixpkgs, ... }:
+    let
+      system = "x86_64-linux";
+      pkgs = nixpkgs.legacyPackages.${system};
+
+      typelibPath = pkgs.lib.makeSearchPath "lib/girepository-1.0"
+        (map (drv: drv.out or drv) [ pkgs.librest pkgs.glib ]);
+    in
+    {
+      devShells.${system}.default = pkgs.mkShell {
+        packages = [ pkgs.ruby_3_4 pkgs.bundler ] ++ [ pkgs.librest pkgs.glib ];
+
+        shellHook = ''
+          export GI_TYPELIB_PATH="${typelibPath}''${GI_TYPELIB_PATH:+:$GI_TYPELIB_PATH}"
+        '';
+      };
+    };
+}
+```
+
+Everything must come from **one** nixpkgs. A typelib built against a different
+glib than the `gobject-introspection` gem registers GIO twice in the process
+and fails with `cannot register existing type 'GTlsCertificate'`.
+
+If you are packaging an application rather than entering a shell, the same
+`typelibPath` goes on the wrapper:
+
+```nix
+makeWrapper ${ruby}/bin/ruby $out/bin/my-app \
+  --set GI_TYPELIB_PATH "${typelibPath}"
+```
+
+## Development
+
+```sh
+nix develop
+bin/test
+```
+
+## Releasing
+
+```sh
+gem kit release
+```
+
+That is the whole thing. It gates on the changelog having an entry for this
+version, on no deprecation deadline coming due, and on a clean working tree;
+then builds, pushes and tags.
+
+There is nothing to wait for in CI. This gem is pure Ruby, so `gem build`
+produces one `librest-X.Y.Z.gem` that is the same artefact wherever it is built —
+no extension, no per-platform gems, nothing for a workflow to hand back.
+
+
+## Licence
+
+Apache-2.0. librest itself is LGPL-2.1-or-later; this gem links nothing and
+copies no librest code — it reads a description of it at runtime.

data/lib/librest/loader.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# Released under the Apache License, Version 2.0.
+# Copyright, 2026, by General Intelligence Systems.
+
+module Rest
+  # Defines everything in the Rest namespace from `Rest-1.0.typelib`.
+  #
+  # Modelled on ruby-gnome's own loaders -- see
+  # gtksourceview5/lib/gtksourceview5/loader.rb for one that has to call the
+  # library's init function before anything works, and
+  # libsecret/lib/libsecret/loader.rb for one that does not.
+  #
+  # The version string is the typelib's, which is not always the library's
+  # release number and is not guessable: this one is "1.0", read off
+  # `Rest-1.0.typelib` rather than inferred.
+  class Loader < GObjectIntrospection::Loader
+    def load
+      self.version = "1.0"
+      super("Rest")
+    end
+
+    private
+
+    def post_load(repository, namespace)
+      require_libraries
+    end
+
+    def require_libraries
+      # Nothing yet. Hand-written Ruby that improves on what the typelib gives
+      # -- an each that yields, a to_s, a keyword-argument constructor -- goes
+      # in files required from here, which is the convention ruby-gnome uses
+      # for exactly that purpose.
+    end
+  end
+end

data/lib/librest/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 Librest
+  VERSION = "1.0.0"
+end

data/lib/librest/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 Librest
+  VERSION = "<%= version %>"
+end

data/lib/librest.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# Released under the Apache License, Version 2.0.
+# Copyright, 2026, by General Intelligence Systems.
+
+require "gobject-introspection"
+
+require_relative "librest/version"
+require_relative "librest/loader"
+
+# Ruby bindings for librest, calling RESTful web services -- including the OAuth and PKCE signing soup3 does not do.
+#
+# Nothing here wraps a C function by hand. The library ships a GObject
+# Introspection typelib, `Rest-1.0.typelib`, describing every class, method, property
+# and signal it has, and ruby-gnome's GObjectIntrospection::Loader reads that at
+# require time and defines the Ruby classes from it. {Rest::Loader} is about
+# twenty lines; what you get is the whole library, and it does not drift when
+# the library gains API.
+#
+# This is how ruby-gnome itself ships gtksourceview5, libsecret and the rest.
+#
+# The typelib has to be findable at require time, which means the library's
+# `girepository-1.0` directory on `GI_TYPELIB_PATH` or in the system default.
+# This gem cannot install it -- it is a C library artefact and belongs to the
+# distribution. See the README; `flake.nix` wires up a dev shell that has it.
+#
+# One trap, paid for already: the typelib must come from the same glib build as
+# the `gobject-introspection` gem. Mix two and GIO is registered twice in one
+# process, which fails as `cannot register existing type 'GTlsCertificate'`.
+module Rest
+  LOG_DOMAIN = "Rest"
+  GLib::Log.set_log_domain(LOG_DOMAIN)
+
+  class Error < StandardError
+  end
+
+  loader = Loader.new(self)
+  loader.load
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: librest
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Nathan Kidd
+bindir: bin
+cert_chain: []
+date: 1980-01-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gem_kit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: gobject-introspection
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+- !ruby/object:Gem::Dependency
+  name: lefthook
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+description: Librest, calling RESTful web services -- including the OAuth and PKCE
+  signing soup3 does not do, for Ruby. Defined from its GObject Introspection typelib
+  at require time rather than wrapped by hand, so the binding is the whole namespace
+  and does not drift as the library gains API.
+email:
+- nathankidd@hey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- NOTICE
+- README.md
+- lib/librest.rb
+- lib/librest/loader.rb
+- lib/librest/version.rb
+- lib/librest/version.rb.erb
+homepage: https://github.com/n-at-han-k/librest-rb
+licenses:
+- Apache-2.0
+metadata:
+  source_code_uri: https://github.com/n-at-han-k/librest-rb
+  documentation_uri: https://n-at-han-k.github.io/librest-rb/
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.7.2
+specification_version: 4
+summary: Ruby bindings for librest, calling RESTful web services -- including the
+  OAuth and PKCE signing soup3 does not do.
+test_files: []