sleeping_kangaroo12 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b89369bac3beb3d85045ea6f94f2c0d995d4e72e04a1887f83818b308e4bae7
-  data.tar.gz: 464479f5b0d85d7d6c5453e208fc287b5637f1fcc99769101aeee75e9dd2ec58
+  metadata.gz: 7453def4dc8a8e3a1c2969eae931609fea5407fdba11a56e8e14fd5a09325b5f
+  data.tar.gz: ad708b12872beef715a367ba32ecefb0c869fb969a88df41a15fc3cac7379f43
 SHA512:
-  metadata.gz: 7514b62f2f38a373d055f71dd6acce85ab37554403bc3fb294e2b516e768133120134469d29d81b69be36f6804dd002439ce49e9208bf6831d7e99d359bee21a
-  data.tar.gz: 4a5dea0068e28db9180e65c3469863f9c6ada04948866999efe788c1ef941d7eebfdb6d1a18a816175b6dbd85d653d8f83bdd6613514c70e3c907245ee75911e
+  metadata.gz: 1ec13969d3b64f83c29a4b2b7653cc080f442b0818f9e5f818fd2c8ca139b658f9692832f9d9a046320cf16d5988240c06bddc5fd3de3ce0faa920b1af0abb56
+  data.tar.gz: 748c612b41ff1460dad89f1e122b466cb052089d95eb552557c6f0ef229ce74ad5d214e9f5d371464dc93aaa65db412af284dafbb83eb62d5bccab413943f84b

data/README.md

@@ -1,5 +1,8 @@
 # SleepingKangaroo12
 
+[![GitHub version](https://badge.fury.io/gh/the-cave%2Fsleeping-kangaroo12.svg)](https://badge.fury.io/gh/the-cave%2Fsleeping-kangaroo12)
+[![Gem Version](https://badge.fury.io/rb/sleeping_kangaroo12.svg)](https://badge.fury.io/rb/sleeping_kangaroo12)
+
 ## What is it?
 
 SleepingKangaroo12 is a Ruby binding of [KangarooTwelve](https://keccak.team/kangarootwelve.html), a fast cryptographic

data/lib/sleeping_kangaroo12/binding.rb

@@ -3,6 +3,7 @@
 require_relative 'build/loader'
 
 module SleepingKangaroo12
+  # @!visibility private
   module Binding
     extend ::FFI::Library
     ffi_lib Build::Loader.find('SleepingKangaroo12')

data/lib/sleeping_kangaroo12/build/loader.rb

@@ -5,6 +5,7 @@ require 'pathname'
 require_relative 'platform'
 
 module SleepingKangaroo12
+  # @!visibility private
   module Build
     # taken from:
     # https://github.com/ffi/ffi-compiler/blob/master/lib/ffi-compiler/loader.rb

data/lib/sleeping_kangaroo12/build/platform.rb

@@ -4,6 +4,7 @@ require 'ffi'
 require 'singleton'
 
 module SleepingKangaroo12
+  # @!visibility private
   module Build
     # mostly taken from:
     # https://github.com/ffi/ffi-compiler/blob/master/lib/ffi-compiler/platform.rb

data/lib/sleeping_kangaroo12/digest.rb

@@ -6,16 +6,30 @@ require 'objspace'
 require_relative 'binding'
 
 module SleepingKangaroo12
+  # @example basic usage
+  #   digest = ::SleepingKangaroo12::Digest.new(output_length: 10)
+  #   digest << 'some input'
+  #   digest << 'some more input'
+  #   digest.hexdigest
+  #   #=> "cbea8144fbbf6150ceaf"
+  # See {file:README.md README} for more usage examples
   class Digest
+    module Error
+    end
+
     class UpdatingFailed < ::StandardError
+      include Error
     end
 
     class FinalizationFailed < ::StandardError
+      include Error
     end
 
     class Finalized < ::StandardError
+      include Error
     end
 
+    # Create a new Digest
     def initialize(output_length: 32, key: nil)
       raise ::TypeError, 'Hash length is not an Integer' unless output_length.is_a?(::Integer)
       raise ::ArgumentError, 'Hash length out of range' unless (1...(1 << 20)).include?(output_length)
@@ -31,6 +45,7 @@ module SleepingKangaroo12
       @result = nil
     end
 
+    # Feed in the data
     def update(data)
       raise Finalized if @finalized
       data_size = data.bytesize
@@ -42,10 +57,12 @@ module SleepingKangaroo12
       self
     end
 
+    # Alias for {#update}
     def <<(*args, **kwargs)
       update(*args, **kwargs)
     end
 
+    # Finalize and output a binary hash
     def digest
       @finalized = true
       return @_digest if @_digest
@@ -65,30 +82,45 @@ module SleepingKangaroo12
       @_digest = data_buffer.get_bytes(0, @output_length)
     end
 
+    # Finalize and output a hexadecimal-encoded hash
     def hexdigest
       @_hexdigest ||= digest.unpack1('H*')
     end
 
+    # Finalize and output a Base64-encoded hash
     def base64digest
       @_base64digest ||= ::Base64.strict_encode64(digest)
     end
 
     class << self
+      # @!visibility private
       # https://www.mikeperham.com/2010/02/24/the-trouble-with-ruby-finalizers/
       def _create_finalizer(instance)
-        proc {
+        proc do
           Binding.destroy(instance)
-        }
+        end
       end
 
+      # Shortcut to calculate a raw digest
+      # @example basic usage
+      #   ::SleepingKangaroo12::Digest.digest('some input')
+      #   #=> "m\x9FJ\xDA\xE9\x96\xD1X\xC5K\xE83e(x\x8C\xD3o\xFBh\xB2\x17W ,\xD5\xED!\xE4D\xAF\xDD"
+      # @example with key (AKA: customization)
+      #   ::SleepingKangaroo12::Digest.digest('some input', key: 'secret')
+      #   #=> "\x96\xE2K\xC4\xCF\xFFGF\xE1\x05\xB9\xF6f\xF0-\xF8\x1F\a\n\xFC\xD7\xC9\x91\n\xFC\xFB\xA6hOx\x99<"
+      # @example controlled output length
+      #   ::SleepingKangaroo12::Digest.digest('some input', output_length: 5)
+      #   #=> "m\x9FJ\xDA\xE9"
       def digest(*args, **kwargs)
         _generic_digest(*args, **kwargs, &:digest)
       end
 
+      # Same as {.digest} but encode the output in hexadecimal format
       def hexdigest(*args, **kwargs)
         _generic_digest(*args, **kwargs, &:hexdigest)
       end
 
+      # Same as {.digest} but encode the output in Base64 format
       def base64digest(*args, **kwargs)
         _generic_digest(*args, **kwargs, &:base64digest)
       end

data/lib/sleeping_kangaroo12/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SleepingKangaroo12
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sleeping_kangaroo12
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Sarun Rattanasiri
@@ -16,46 +16,46 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.15.5
+        version: 1.15.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.15.5
+        version: 1.15.0
 - !ruby/object:Gem::Dependency
   name: posix-spawn
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.15
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.15
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.0.6
+        version: 13.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.0.6
-description: This gem brought the hash algorithm, KangarooTwelve, to Ruby. It uses
-  the official library, K12, maintained by the Keccak team themselves. The implementation
-  is highly optimized on popular hardware, including AVX512, AVX2, SSSE3 instruction
-  sets.
+        version: 13.0.0
+description: |-
+  KangarooTwelve binding for Ruby
+  The gem build on top of the official library, K12, maintained by the Keccak team themselves.
+  The implementation is highly optimized and supporting AVX512, AVX2, SSSE3 instruction sets.
 email: midnight_w@gmx.tw
 executables: []
 extensions:
@@ -107,7 +107,9 @@ licenses:
 - BSD-3-Clause
 metadata:
   homepage_uri: https://github.com/the-cave/sleeping-kangaroo12
-  source_code_uri: https://github.com/the-cave/sleeping-kangaroo12/tree/v0.0.4
+  source_code_uri: https://github.com/the-cave/sleeping-kangaroo12/tree/v0.0.5
+  documentation_uri: https://rubydoc.info/gems/sleeping_kangaroo12/0.0.5
+  bug_tracker_uri: https://github.com/the-cave/sleeping-kangaroo12/issues
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -126,5 +128,5 @@ requirements: []
 rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
-summary: A binding of the KangarooTwelve hash algorithm for Ruby
+summary: KangarooTwelve, the hash algorithm, native binding for Ruby
 test_files: []