iscc-lib 0.2.0-arm64-darwin

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fa67f56d86252e52a63a64db486e203f9ec6d3a184d9ab11f8b97ebb6bf94d5e
+  data.tar.gz: e4a0de83793db79bd41b641000ef80df879c1de503eed96f5f5a61eb89134a3e
+SHA512:
+  metadata.gz: 3fa5755bd86089d4cf98dc82d4e4d3486efb7dac701e7fa1b759567cb7874db2b62f8ce201e266bcc0fea35ef7c60b54f4e455f55c8eb6569202478ddc2f78e9
+  data.tar.gz: f7cf1c5c6645aaf67cd60edd0746df5fb42cdf450be7b8aa6742a7b405f9230450811ad847b61e5516697b7347dccb0b74e3c1afaac58d238c65ed609bafc72a

data/LICENSE

@@ -0,0 +1,190 @@
+                                 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
+
+   Copyright 2026 The Authors
+
+   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,93 @@
+# iscc-lib
+
+[![CI](https://github.com/iscc/iscc-lib/actions/workflows/ci.yml/badge.svg)](https://github.com/iscc/iscc-lib/actions/workflows/ci.yml)
+[![Gem Version](https://img.shields.io/gem/v/iscc-lib.svg)](https://rubygems.org/gems/iscc-lib)
+[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+
+High-performance Ruby bindings for [ISO 24138:2024](https://www.iso.org/standard/77899.html) —
+International Standard Content Code (ISCC). Built as a native Rust extension via
+[Magnus](https://github.com/matsadler/magnus) for speed, with an idiomatic Ruby API featuring
+keyword arguments and attribute-style result access.
+
+## What is ISCC
+
+The ISCC is a similarity-preserving fingerprint and identifier for digital media assets. ISCCs are
+generated algorithmically from digital content, just like cryptographic hashes. However, instead of
+using a single cryptographic hash function to identify data only, the ISCC uses various algorithms
+to create a composite identifier that exhibits similarity-preserving properties (soft hash).
+
+## Installation
+
+```bash
+gem install iscc-lib
+```
+
+Or add to your `Gemfile`:
+
+```ruby
+gem "iscc-lib"
+```
+
+Precompiled gems are available for common platforms. If no precompiled gem matches your platform,
+the gem builds from source (requires a Rust toolchain and `libclang-dev`).
+
+## Quick Start
+
+```ruby
+require "iscc_lib"
+
+# Generate a Meta-Code from content metadata
+result = IsccLib.gen_meta_code_v0("Hello World", description: "A greeting")
+puts result.iscc      # => "ISCC:..."
+puts result.name      # => "Hello World"
+puts result.metahash  # => "1e20..."
+
+# Streaming for large files
+hasher = IsccLib::DataHasher.new
+File.open("large_file.bin", "rb") do |f|
+  while (chunk = f.read(65_536))
+    hasher.update(chunk)
+  end
+end
+result = hasher.finalize
+puts result.iscc
+```
+
+## API Overview
+
+### Code Generators
+
+| Function               | Description                                  |
+| ---------------------- | -------------------------------------------- |
+| `gen_meta_code_v0`     | Generate a Meta-Code from metadata fields    |
+| `gen_text_code_v0`     | Generate a Text-Code from plain text         |
+| `gen_image_code_v0`    | Generate an Image-Code from pixel data       |
+| `gen_audio_code_v0`    | Generate an Audio-Code from Chromaprint data |
+| `gen_video_code_v0`    | Generate a Video-Code from frame signatures  |
+| `gen_mixed_code_v0`    | Generate a Mixed-Code from Content-Codes     |
+| `gen_data_code_v0`     | Generate a Data-Code from binary data        |
+| `gen_instance_code_v0` | Generate an Instance-Code from binary data   |
+| `gen_iscc_code_v0`     | Generate a composite ISCC-CODE               |
+| `gen_sum_code_v0`      | Generate an ISCC-SUM from a file path        |
+
+### Utilities
+
+- **Text processing:** `text_clean`, `text_remove_newlines`, `text_trim`, `text_collapse`
+- **Algorithm primitives:** `alg_simhash`, `alg_minhash_256`, `alg_cdc_chunks`, `sliding_window`
+- **Soft hashing:** `soft_hash_video_v0`
+- **Encoding:** `encode_base64`, `encode_component`
+- **Codec:** `iscc_decode`, `iscc_decompose`, `json_to_data_url`
+- **Streaming:** `DataHasher`, `InstanceHasher` for incremental processing
+- **Diagnostics:** `conformance_selftest`
+
+## Links
+
+- [Documentation](https://lib.iscc.codes)
+- [How-to Guide](https://lib.iscc.codes/howto/ruby/)
+- [Repository](https://github.com/iscc/iscc-lib)
+- [ISCC Specification (ISO 24138)](https://www.iso.org/standard/77899.html)
+- [ISCC Foundation](https://iscc.io)
+
+## License
+
+Apache-2.0

data/lib/iscc_lib/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# Version constant for the iscc-lib gem (synced from root Cargo.toml).
+module IsccLib
+  VERSION = "0.2.0"
+end

data/lib/iscc_lib.rb

@@ -0,0 +1,217 @@
+# frozen_string_literal: true
+
+# Ruby bindings for iscc-lib — ISO 24138:2024 (ISCC).
+#
+# This module provides the public API for generating ISCC codes from Ruby.
+# Result classes wrap the native Hash returns with attribute-style access.
+
+require_relative "iscc_lib/version"
+
+# Load native extension from version-specific subdirectory (precompiled gems)
+# or flat path (source-compiled).
+begin
+  RUBY_VERSION =~ /(\d+\.\d+)/
+  require_relative "iscc_lib/#{$1}/iscc_rb"
+rescue LoadError
+  require_relative "iscc_lib/iscc_rb"
+end
+
+module IsccLib
+  # Base result class providing both Hash-style and attribute-style access.
+  class Result < Hash
+    # Allow attribute-style access for hash keys (e.g., result.iscc).
+    def method_missing(name, *args)
+      key = name.to_s
+      return self[key] if key?(key)
+
+      super
+    end
+
+    # Support respond_to? for dynamic attribute access.
+    def respond_to_missing?(name, include_private = false)
+      key?(name.to_s) || super
+    end
+  end
+
+  # Result from gen_meta_code_v0.
+  class MetaCodeResult < Result; end
+
+  # Result from gen_text_code_v0.
+  class TextCodeResult < Result; end
+
+  # Result from gen_image_code_v0.
+  class ImageCodeResult < Result; end
+
+  # Result from gen_audio_code_v0.
+  class AudioCodeResult < Result; end
+
+  # Result from gen_video_code_v0.
+  class VideoCodeResult < Result; end
+
+  # Result from gen_mixed_code_v0.
+  class MixedCodeResult < Result; end
+
+  # Result from gen_data_code_v0.
+  class DataCodeResult < Result; end
+
+  # Result from gen_instance_code_v0.
+  class InstanceCodeResult < Result; end
+
+  # Result from gen_iscc_code_v0.
+  class IsccCodeResult < Result; end
+
+  # Result from gen_sum_code_v0.
+  class SumCodeResult < Result; end
+
+  # Generate a Meta-Code from name and optional metadata.
+  #
+  # @param name [String] content name (required, non-empty)
+  # @param description [String, nil] optional content description
+  # @param meta [String, nil] optional JSON metadata
+  # @param bits [Integer] bit length (default: 64)
+  # @return [MetaCodeResult] hash with iscc, name, metahash, and optionally description, meta
+  def self.gen_meta_code_v0(name, description: nil, meta: nil, bits: 64)
+    MetaCodeResult[_gen_meta_code_v0(name, description, meta, bits)]
+  end
+
+  # Generate a Text-Code from plain text content.
+  #
+  # @param text [String] plain text content
+  # @param bits [Integer] bit length (default: 64)
+  # @return [TextCodeResult] hash with iscc, characters
+  def self.gen_text_code_v0(text, bits: 64)
+    TextCodeResult[_gen_text_code_v0(text, bits)]
+  end
+
+  # Generate an Image-Code from pixel data.
+  #
+  # @param pixels [String] binary pixel data
+  # @param bits [Integer] bit length (default: 64)
+  # @return [ImageCodeResult] hash with iscc
+  def self.gen_image_code_v0(pixels, bits: 64)
+    ImageCodeResult[_gen_image_code_v0(pixels, bits)]
+  end
+
+  # Generate an Audio-Code from a Chromaprint feature vector.
+  #
+  # @param cv [Array<Integer>] Chromaprint fingerprint integers
+  # @param bits [Integer] bit length (default: 64)
+  # @return [AudioCodeResult] hash with iscc
+  def self.gen_audio_code_v0(cv, bits: 64)
+    AudioCodeResult[_gen_audio_code_v0(cv, bits)]
+  end
+
+  # Generate a Video-Code from frame signature vectors.
+  #
+  # @param frame_sigs [Array<Array<Integer>>] nested array of frame signatures
+  # @param bits [Integer] bit length (default: 64)
+  # @return [VideoCodeResult] hash with iscc
+  def self.gen_video_code_v0(frame_sigs, bits: 64)
+    VideoCodeResult[_gen_video_code_v0(frame_sigs, bits)]
+  end
+
+  # Generate a Mixed-Code from multiple ISCC content code strings.
+  #
+  # @param codes [Array<String>] ISCC unit strings
+  # @param bits [Integer] bit length (default: 64)
+  # @return [MixedCodeResult] hash with iscc, parts
+  def self.gen_mixed_code_v0(codes, bits: 64)
+    MixedCodeResult[_gen_mixed_code_v0(codes, bits)]
+  end
+
+  # Generate a Data-Code from binary data.
+  #
+  # @param data [String] binary data
+  # @param bits [Integer] bit length (default: 64)
+  # @return [DataCodeResult] hash with iscc
+  def self.gen_data_code_v0(data, bits: 64)
+    DataCodeResult[_gen_data_code_v0(data, bits)]
+  end
+
+  # Generate an Instance-Code from binary data.
+  #
+  # @param data [String] binary data
+  # @param bits [Integer] bit length (default: 64, accepted for API consistency)
+  # @return [InstanceCodeResult] hash with iscc, datahash, filesize
+  def self.gen_instance_code_v0(data, bits: 64)
+    InstanceCodeResult[_gen_instance_code_v0(data, bits)]
+  end
+
+  # Generate a composite ISCC-CODE from individual unit codes.
+  #
+  # @param codes [Array<String>] ISCC unit strings (Data-Code + Instance-Code, optional Content-Code)
+  # @param wide [Boolean] use 256-bit combination (default: false for 128-bit)
+  # @return [IsccCodeResult] hash with iscc
+  def self.gen_iscc_code_v0(codes, wide: false)
+    IsccCodeResult[_gen_iscc_code_v0(codes, wide)]
+  end
+
+  # Generate a composite ISCC-CODE from a file in a single pass.
+  #
+  # @param path [String] file path
+  # @param bits [Integer] bit length (default: 64)
+  # @param wide [Boolean] use 256-bit combination (default: false)
+  # @param add_units [Boolean] include individual unit codes (default: false)
+  # @return [SumCodeResult] hash with iscc, datahash, filesize, and optionally units
+  def self.gen_sum_code_v0(path, bits: 64, wide: false, add_units: false)
+    SumCodeResult[_gen_sum_code_v0(path, bits, wide, add_units)]
+  end
+
+  # Streaming Data-Code generator (reopens native class).
+  #
+  # Incrementally processes data with content-defined chunking and MinHash
+  # to produce results identical to gen_data_code_v0.
+  #
+  # @example
+  #   hasher = IsccLib::DataHasher.new
+  #   hasher.update(chunk1).update(chunk2)
+  #   result = hasher.finalize(bits: 64)
+  class DataHasher
+    # Push binary data into the hasher.
+    #
+    # @param data [String] binary data
+    # @return [self] for method chaining
+    def update(data)
+      _update(data)
+      self
+    end
+
+    # Consume the hasher and produce a Data-Code result.
+    #
+    # @param bits [Integer] bit length (default: 64)
+    # @return [DataCodeResult] hash with iscc
+    # @raise [RuntimeError] if called more than once
+    def finalize(bits: 64)
+      DataCodeResult[_finalize(bits)]
+    end
+  end
+
+  # Streaming Instance-Code generator (reopens native class).
+  #
+  # Incrementally hashes data with BLAKE3 to produce results identical
+  # to gen_instance_code_v0.
+  #
+  # @example
+  #   hasher = IsccLib::InstanceHasher.new
+  #   hasher.update(chunk1).update(chunk2)
+  #   result = hasher.finalize(bits: 64)
+  class InstanceHasher
+    # Push binary data into the hasher.
+    #
+    # @param data [String] binary data
+    # @return [self] for method chaining
+    def update(data)
+      _update(data)
+      self
+    end
+
+    # Consume the hasher and produce an Instance-Code result.
+    #
+    # @param bits [Integer] bit length (default: 64)
+    # @return [InstanceCodeResult] hash with iscc, datahash, filesize
+    # @raise [RuntimeError] if called more than once
+    def finalize(bits: 64)
+      InstanceCodeResult[_finalize(bits)]
+    end
+  end
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: iscc-lib
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: arm64-darwin
+authors:
+- Titusz Pan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2026-03-05 00:00:00.000000000 Z
+dependencies: []
+description: High-performance Ruby bindings for ISO 24138:2024 (ISCC). Native Rust
+  extension via Magnus for content identification and matching.
+email:
+- tp@py7.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/iscc_lib.rb
+- lib/iscc_lib/3.1/iscc_rb.bundle
+- lib/iscc_lib/3.2/iscc_rb.bundle
+- lib/iscc_lib/3.3/iscc_rb.bundle
+- lib/iscc_lib/version.rb
+homepage: https://github.com/iscc/iscc-lib
+licenses:
+- Apache-2.0
+metadata:
+  homepage_uri: https://github.com/iscc/iscc-lib
+  source_code_uri: https://github.com/iscc/iscc-lib
+  documentation_uri: https://lib.iscc.codes
+  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.1'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: 3.4.dev
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.23
+signing_key: 
+specification_version: 4
+summary: ISCC - International Standard Content Code (ISO 24138)
+test_files: []