asterism-zenoh 0.1.0

data/ext/asterism_zenoh/zenoh_c.rb

@@ -0,0 +1,175 @@
+# Finds the prebuilt zenoh-c release for this machine, downloads it and
+# checks it against ZENOH_C_PIN. Used by extconf.rb (at `gem install`) and by
+# the Rakefile (`rake zenoh_c:fetch`). Standard library only: net/http for
+# the download (redirects followed, proxies from the usual environment
+# variables), zlib for the zip archive (no unzip, curl or git needed).
+#
+# Environment:
+#   ZENOH_C_DIR             use this zenoh-c (include/ and lib/) instead
+#   ASTERISM_ZENOH_C_MIRROR download from this base instead of the GitHub
+#                           releases: <base>/<tag>/<asset>. An http(s) or
+#                           file:// URL, or a local directory.
+require "digest"
+require "fileutils"
+require "net/http"
+require "rbconfig"
+require "tmpdir"
+require "uri"
+require "zlib"
+
+module ZenohCFetch
+  class Error < StandardError; end
+
+  PIN_FILE = File.expand_path("../../ZENOH_C_PIN", __dir__)
+  MIRROR_ENV = "ASTERISM_ZENOH_C_MIRROR"
+  MAX_REDIRECTS = 10
+
+  module_function
+
+  def pin
+    @pin ||= File.readlines(PIN_FILE).each_with_object({}) do |l, h|
+      next if l.start_with?("#") || !l.include?(":")
+      k, v = l.split(":", 2)
+      h[k.strip] = v.strip
+    end
+  end
+
+  # The pinned machines, as the keys of ZENOH_C_PIN (asset.<key>).
+  def supported
+    pin.keys.grep(/\Aasset\./).map { |k| k.delete_prefix("asset.") }
+  end
+
+  # The key of this machine in ZENOH_C_PIN, or nil when it is not known.
+  def platform_key(cpu = RbConfig::CONFIG["host_cpu"], os = RbConfig::CONFIG["host_os"])
+    arch = case cpu
+           when /\A(x86_64|amd64|x64)\z/ then "x86_64"
+           when /\A(aarch64|arm64)\z/ then "aarch64"
+           end
+    return nil unless arch
+    case os
+    when /linux-musl/ then "#{arch}-linux-musl"
+    when /linux/ then "#{arch}-linux"
+    when /darwin/ then "#{arch}-darwin"
+    end
+  end
+
+  # The shared library's file name on this machine.
+  def lib_name(os = RbConfig::CONFIG["host_os"])
+    os =~ /darwin/ ? "libzenohc.dylib" : "libzenohc.so"
+  end
+
+  def help
+    "Point the build at a zenoh-c of your own (its include/ and lib/, release #{pin['tag']}):\n" \
+      "  ZENOH_C_DIR=/path/to/zenoh-c gem install asterism-zenoh\n" \
+      "  (or: gem install asterism-zenoh -- --with-zenoh-c-dir=/path/to/zenoh-c)\n" \
+      "Prebuilt zenoh-c releases: #{pin['repo']}/releases/tag/#{pin['tag']}\n" \
+      "To download from a mirror instead: #{MIRROR_ENV}=<base> (fetches <base>/#{pin['tag']}/<asset>)."
+  end
+
+  def url_for(asset)
+    base = ENV[MIRROR_ENV].to_s
+    base = "#{pin['repo']}/releases/download" if base.empty?
+    "#{base.chomp('/')}/#{pin['tag']}/#{asset}"
+  end
+
+  # Downloads the pinned release for `key`, checks its sha256 and unpacks
+  # include/ and the shared library into `dest`. Returns a description of
+  # what was fetched. Raises Error with a message for the user.
+  def fetch(dest, key = platform_key, log: $stdout)
+    unless key && pin["asset.#{key}"]
+      raise Error, "no prebuilt zenoh-c is pinned for this machine " \
+                   "(#{RbConfig::CONFIG['host_cpu']}-#{RbConfig::CONFIG['host_os']}); " \
+                   "pinned: #{supported.join(', ')}.\n#{help}"
+    end
+    asset = pin["asset.#{key}"]
+    sha = pin["sha256.#{key}"] or raise Error, "ZENOH_C_PIN has no sha256 for #{key}"
+    url = url_for(asset)
+    Dir.mktmpdir("zenoh-c") do |tmp|
+      zip = File.join(tmp, asset)
+      log&.puts "fetching zenoh-c #{pin['tag']} (#{key}): #{url}"
+      begin
+        download(url, zip)
+      rescue StandardError => e
+        raise Error, "cannot download #{url}: #{e.message} (#{e.class})\n#{help}"
+      end
+      got = Digest::SHA256.file(zip).hexdigest
+      unless got == sha
+        raise Error, "sha256 mismatch for #{asset}: got #{got}, pinned #{sha} (ZENOH_C_PIN). " \
+                     "Not using it.\n#{help}"
+      end
+      log&.puts "sha256 #{got} OK"
+      FileUtils.rm_rf(dest)
+      unzip(zip, dest) { |name| name.start_with?("include/") || name == "lib/#{lib_name}" }
+    end
+    %w[include/zenoh.h].push("lib/#{lib_name}").each do |f|
+      raise Error, "the archive #{asset} has no #{f}" unless File.file?(File.join(dest, f))
+    end
+    { "tag" => pin["tag"], "platform" => key, "asset" => asset, "sha256" => sha, "url" => url }
+  end
+
+  def download(url, path, redirects = MAX_REDIRECTS)
+    uri = URI(url)
+    if uri.scheme.nil? || uri.scheme == "file"
+      src = uri.scheme ? URI.decode_www_form_component(uri.path) : url
+      raise Error, "no such file: #{src}" unless File.file?(src)
+      return FileUtils.cp(src, path)
+    end
+    raise Error, "unsupported URL scheme: #{uri.scheme}" unless %w[http https].include?(uri.scheme)
+    Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == "https",
+                                        open_timeout: 30, read_timeout: 120) do |http|
+      http.request_get(uri.request_uri) do |res|
+        case res
+        when Net::HTTPRedirection
+          raise Error, "too many redirects" if redirects <= 0
+          loc = res["location"] or raise Error, "redirect without a location"
+          return download(URI.join(url, loc).to_s, path, redirects - 1)
+        when Net::HTTPSuccess
+          File.open(path, "wb") { |f| res.read_body { |chunk| f.write(chunk) } }
+        else
+          raise Error, "HTTP #{res.code} #{res.message}"
+        end
+      end
+    end
+  end
+
+  # Extracts the entries for which the block is true. Reads the central
+  # directory; stored and deflated entries; checks each entry's CRC-32.
+  def unzip(zip, dest)
+    File.open(zip, "rb") do |f|
+      size = f.size
+      tail = [size, 65_557].min
+      f.seek(size - tail)
+      buf = f.read(tail)
+      eocd = buf.rindex("PK\x05\x06".b) or raise Error, "not a zip archive: #{zip}"
+      count, cd_size, cd_off = buf[eocd + 10, 10].unpack("vVV")
+      raise Error, "zip64 archives are not supported" if cd_off == 0xFFFFFFFF
+      f.seek(cd_off)
+      cd = f.read(cd_size)
+      pos = 0
+      count.times do
+        raise Error, "bad zip central directory" unless cd[pos, 4] == "PK\x01\x02".b
+        method, _t, _d, crc, csize, usize, nlen, elen, clen = cd[pos + 10, 24].unpack("vvvVVVvvv")
+        local = cd[pos + 42, 4].unpack1("V")
+        name = cd[pos + 46, nlen]
+        pos += 46 + nlen + elen + clen
+        next if name.end_with?("/") || !yield(name)
+        raise Error, "unsafe path in zip: #{name}" if name.start_with?("/") || name.split("/").include?("..")
+        f.seek(local)
+        lh = f.read(30)
+        raise Error, "bad zip local header: #{name}" unless lh[0, 4] == "PK\x03\x04".b
+        f.seek(local + 30 + lh[26, 2].unpack1("v") + lh[28, 2].unpack1("v"))
+        data = f.read(csize)
+        data = case method
+               when 0 then data
+               when 8 then Zlib::Inflate.new(-Zlib::MAX_WBITS).inflate(data)
+               else raise Error, "zip entry #{name}: compression method #{method} is not supported"
+               end
+        raise Error, "zip entry #{name}: size mismatch" unless data.bytesize == usize
+        raise Error, "zip entry #{name}: CRC mismatch" unless Zlib.crc32(data) == crc
+        out = File.join(dest, name)
+        FileUtils.mkdir_p(File.dirname(out))
+        File.binwrite(out, data)
+      end
+    end
+  end
+end

data/lib/asterism/zenoh/global.rb

@@ -0,0 +1,5 @@
+# Optional short name: require "asterism/zenoh/global" to write Zenoh::Session.
+# Not defined by default (the top-level Zenoh is left to an official binding).
+require "asterism/zenoh"
+
+Zenoh = Asterism::Zenoh unless defined?(Zenoh)

data/lib/asterism/zenoh/version.rb

@@ -0,0 +1,6 @@
+module Asterism
+  module Zenoh
+    # The gem's version.
+    VERSION = "0.1.0"
+  end
+end

data/lib/asterism/zenoh.rb

@@ -0,0 +1,6 @@
+# Asterism::Zenoh for CRuby: the Zenoh binding of Asterism, over zenoh-c.
+# The same Ruby API as the mruby / PicoRuby gem (picoruby-asterism-zenoh):
+# see README.md. Receiving is polled (each_pending / each_reply) from the
+# application's own thread; nothing calls into Ruby behind its back.
+require_relative "zenoh/version"
+require_relative "asterism_zenoh"

data/licenses/zenoh-c/LICENSE-APACHE

@@ -0,0 +1,202 @@
+
+                                 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 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 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 those 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. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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/licenses/zenoh-c/NOTICE.md

@@ -0,0 +1,40 @@
+# Notices for Eclipse zenoh-c
+
+This content is produced and maintained by the Eclipse zenoh project.
+
+ * Project home: https://projects.eclipse.org/projects/iot.zenoh
+
+## Trademarks
+
+Eclipse zenoh is trademark of the Eclipse Foundation. 
+Eclipse, and the Eclipse Logo are registered trademarks of the Eclipse Foundation.
+
+## Copyright
+
+All content is the property of the respective authors or their employers.
+For more information regarding authorship of content, please consult the
+listed source code repository logs.
+
+## Declared Project Licenses
+
+This program and the accompanying materials are made available under the
+terms of the Eclipse Public License 2.0 which is available at
+http://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
+which is available at https://www.apache.org/licenses/LICENSE-2.0.
+
+SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
+
+## Source Code
+
+The project maintains the following source code repositories:
+
+ * https://github.com/eclipse-zenoh/zenoh.git
+ * https://github.com/eclipse-zenoh/zenoh-c.git
+ * https://github.com/eclipse-zenoh/zenoh-java.git
+ * https://github.com/eclipse-zenoh/zenoh-go.git
+ * https://github.com/eclipse-zenoh/zenoh-python.git
+
+## Third-party Content
+
+ *To be completed...*
+

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: asterism-zenoh
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Katsuhiko Kageyama
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2026-10-08 00:00:00.000000000 Z
+dependencies: []
+description: Sessions, put / subscribe, get / queryable, liveliness and attachments,
+  received by polling. The same Ruby API as Asterism's mruby / PicoRuby binding. The
+  C extension is compiled at install time against the official prebuilt zenoh-c release
+  for the machine, downloaded and checked against a pinned sha256.
+email: 
+executables: []
+extensions:
+- ext/asterism_zenoh/extconf.rb
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- ZENOH_C_PIN
+- ext/asterism_zenoh/extconf.rb
+- ext/asterism_zenoh/zenoh.c
+- ext/asterism_zenoh/zenoh_c.rb
+- lib/asterism/zenoh.rb
+- lib/asterism/zenoh/global.rb
+- lib/asterism/zenoh/version.rb
+- licenses/zenoh-c/LICENSE-APACHE
+- licenses/zenoh-c/NOTICE.md
+homepage: https://github.com/ruby-asterism/asterism-zenoh
+licenses:
+- MIT
+- Apache-2.0
+metadata:
+  homepage_uri: https://github.com/ruby-asterism/asterism-zenoh
+  source_code_uri: https://github.com/ruby-asterism/asterism-zenoh
+  bug_tracker_uri: https://github.com/ruby-asterism/asterism-zenoh/issues
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key: 
+specification_version: 4
+summary: 'Asterism::Zenoh: an unofficial Zenoh binding for Ruby (over zenoh-c)'
+test_files: []