blake3-rb 0.1.0.pre10-x86_64-linux

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fc9909be51de511c42d9939fdae449eb24008fa77a86bc407363a56765c6caad
+  data.tar.gz: 9f07739d2aa51141723bf65c5fb9fd07992d84c55862e0772b492e35e964eb42
+SHA512:
+  metadata.gz: abf803873ce5d36e8d82435dc9a526efc581e74d728283e626032170aa3c5b8d150397e250763f36fb59c202132d941d241f9800c4edc75f668f907c61f1d226
+  data.tar.gz: fae7d07ad43dabd28918a11583079269214c0189acfd6283151377a1f87aaa3ea26b7b1080795b0d26d7bdf4f1dd261c4e3c74b8bb8877577a6f2223de5fe75b

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Shopify, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,139 @@
+# `blake3-rb`
+
+![Build Status](https://github.com/Shopify/blake3-ruby/workflows/CI/badge.svg)
+
+Blake3 is a Ruby gem that provides a simple and efficient way to compute the Blake3 cryptographic hash function. This gem is designed to be easy to use and integrate into your Ruby projects using the Ruby [`digest` framework](https://github.com/ruby/digest).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "blake3-rb", github: "Shopify/blake3-rb"
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+## Usage
+
+Here's a simple usage example:
+
+```ruby
+require "digest/blake3"
+
+result = Digest::Blake3.hexdigest("your data here")
+```
+
+If you need to stream data:
+
+```ruby
+require "digest/blake3"
+
+hasher = Digest::Blake3.new
+hasher.update("your data here")
+result = hasher.hexdigest
+```
+
+Or use the `<<` operator:
+
+```ruby
+require "digest/blake3"
+
+hasher = Digest::Blake3.new
+hasher << "part1" << "part2"
+result = hasher.hexdigest
+```
+
+### Base64 Digest
+
+You can compute the Base64 digest of your data:
+
+```ruby
+require "digest/blake3"
+
+result = Digest::Blake3.base64digest("your data here")
+```
+
+### Equality
+
+You can compare two digests for equality:
+
+```ruby
+require "digest/blake3"
+
+digest_one = Digest::Blake3.new
+digest_two = Digest::Blake3.new
+
+digest_one.update("your data here")
+digest_two.update("your data here")
+
+if digest_one == digest_two
+  puts "Digests are equal"
+else
+  puts "Digests are not equal"
+end
+```
+
+You can compute the hash of a file:
+
+```ruby
+require "digest/blake3"
+
+result = Digest::Blake3.file("path/to/your/file")
+```
+
+## Benchmarks
+
+Here are some benchmarks comparing this gem with other digests on `x86_64-linux`:
+
+```bash
+$ ruby bench/string.rb
+...
+Warming up --------------------------------------
+        Digest::SHA1    61.000  i/100ms
+      Digest::SHA256    21.000  i/100ms
+         Digest::MD5    58.000  i/100ms
+      Digest::Blake3   560.000  i/100ms
+Calculating -------------------------------------
+        Digest::SHA1    612.174  (± 0.3%) i/s -      3.111k in   5.081922s
+      Digest::SHA256    215.281  (± 0.0%) i/s -      1.092k in   5.072453s
+         Digest::MD5    586.009  (± 0.3%) i/s -      2.958k in   5.047759s
+      Digest::Blake3      5.698k (± 0.6%) i/s -     28.560k in   5.012308s
+
+Comparison:
+      Digest::Blake3:     5698.2 i/s
+        Digest::SHA1:      612.2 i/s - 9.31x  slower
+         Digest::MD5:      586.0 i/s - 9.72x  slower
+      Digest::SHA256:      215.3 i/s - 26.47x  slower
+
+```
+
+## Testing
+
+First, make sure your development environment is setup:
+
+```bash
+$ bin/setup
+```
+
+To run the tests, execute:
+
+```bash
+$ bundle exec rake test
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Shopify/blake3-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/Shopify/blake3-ruby/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Blake3 project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/Shopify/blake3-ruby/blob/main/CODE_OF_CONDUCT.md).

data/lib/blake3-rb.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "digest/blake3"

data/lib/digest/blake3.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+# Tries to require the precompiled extension for the given Ruby version first
+begin
+  RUBY_VERSION =~ /(\d+\.\d+)/
+  require "digest/blake3/#{Regexp.last_match(1)}/blake3_ext"
+rescue LoadError
+  require_relative "blake3/blake3_ext"
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: blake3-rb
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre10
+platform: x86_64-linux
+authors:
+- Ian Ker-Seymer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-10-17 00:00:00.000000000 Z
+dependencies: []
+description: Provides native bindings to the Blake3 hash function for Ruby.
+email:
+- ian.kerseymer@shopify.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/blake3-rb.rb
+- lib/digest/blake3.rb
+- lib/digest/blake3/3.0/blake3_ext.so
+- lib/digest/blake3/3.1/blake3_ext.so
+- lib/digest/blake3/3.2/blake3_ext.so
+homepage: https://github.com/Shopify/blake3-ruby
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/Shopify/blake3-ruby
+  source_code_uri: https://github.com/Shopify/blake3-ruby
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: 3.3.dev
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.4.4
+signing_key: 
+specification_version: 4
+summary: Blake3 hash function bindings for Ruby.
+test_files: []