foxify 0.9.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5e8da54e157337458828306835a65bfbcb181af66075d09932127ca411a8320a
+  data.tar.gz: caf2d236c36f6937402b1172ef092d4dbe18105657a4cd7a4aef770a4f2acd6e
+SHA512:
+  metadata.gz: 87abb84bb4ed756f8c78cc12077819b1e0f680b3c30aae08e2d213675ea3a79228c96ef3d1766d91a209319f3161b833da66778b78965ec86e37ef703d44c682
+  data.tar.gz: '09b84594260f403bd94234c0d1422eba51dd6fd6cc427f5239a44bc9ccd40c48046cf8a3eb99b5da8d9e08b0e440e61e29f7d5f9557353966af79f427c1a1211'

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,14 @@
+AllCops:
+  TargetRubyVersion: 3.3
+  NewCops: enable
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Metrics/BlockLength:
+  Exclude:
+    - "./spec/**/*"
+    - "foxify.gemspec"

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## [0.9.1] - 2025-01-12
+
+- Fix gemspec allowed_push_host
+
+## [0.9.0] - 2025-01-12
+
+- Initial release of Foxify::ResumableSHA256 and Foxify::ResumableSHA1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Oli Kessler
+
+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,96 @@
+[![Test](https://github.com/orlon-pro/foxify/actions/workflows/main.yml/badge.svg)](https://github.com/orlon-pro/foxify/actions/workflows/main.yml)
+
+# Foxify
+
+`foxify` is a gem which provides resumable digest implementations in ruby by
+leveraging the power of [Go](https://go.dev/)
+
+The classes `Foxify::ResumableSHA256` and `Foxify::ResumableSHA1` can be safely
+serialized and restored at any point in time and digest calculation can be resumed.
+This is an advantage in stateless application servers where i.e. large files are
+uploaded in chunks and you want to resume digest calculation in each request.
+
+## Requirements
+
+* Ruby 3.3+
+* Go 1.23+
+
+## Installation
+
+Add the foxify gem to your Gemfile:
+
+```text
+gem "foxify"
+```
+
+Update your bundle:
+
+```sh
+bundle install
+```
+
+**NOTE**: You need a go-lang compiler version 1.23+ in your environment to compile the native part of this gem.
+
+## Usage
+
+### Foxify::ResumableSHA256
+
+Simple usage without serializing:
+
+```ruby
+require 'foxify'
+
+digest = Foxify::ResumableSHA256.new
+digest.update("The quick brown fox jumps over the lazy dog")
+digest.hexdigest # returns "d7a8fbb307d7809469ca9abcb0082e4f8d5651e46d3cdb762d02d0bf37c9e592"
+```
+
+Usage with serializing and resuming later on:
+
+```ruby
+require 'foxify'
+
+digest = Foxify::ResumableSHA256.new
+digest.update("The quick brown fox ")
+data = digest.to_msgpack
+
+# store data somewhere and later reload it
+restored = Foxify::ResumableSHA256.from_msgpack(data)
+restored.update("jumps over the lazy dog")
+restored.hexdigest # returns "d7a8fbb307d7809469ca9abcb0082e4f8d5651e46d3cdb762d02d0bf37c9e592"
+```
+
+### Foxify::ResumableSHA1
+
+Simple usage without serializing:
+
+```ruby
+require 'foxify'
+
+digest = Foxify::ResumableSHA1.new
+digest.update("The quick brown fox jumps over the lazy dog")
+digest.hexdigest # returns "2fd4e1c67a2d28fced849ee1bb76e7391b93eb12"
+```
+
+Usage with serializing and resuming later on:
+
+```ruby
+require 'foxify'
+
+digest = Foxify::ResumableSHA1.new
+digest.update("The quick brown fox ")
+data = digest.to_msgpack
+
+# store data somewhere and later reload it
+restored = Foxify::ResumableSHA1.from_msgpack(data)
+restored.update("jumps over the lazy dog")
+restored.hexdigest # returns "2fd4e1c67a2d28fced849ee1bb76e7391b93eb12"
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/orlon-pro/foxify.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+require "rake/extensiontask"
+
+task build: :compile
+
+GEMSPEC = Gem::Specification.load("foxify.gemspec")
+
+Rake::ExtensionTask.new("foxify", GEMSPEC) do |ext|
+  ext.lib_dir = "lib/foxify"
+end
+
+task default: %i[clobber compile spec rubocop]

data/ext/foxify/extconf.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "mkmf"
+require "go_gem/mkmf"
+
+# Makes all symbols private by default to avoid unintended conflict
+# with other gems. To explicitly export symbols you can use RUBY_FUNC_EXPORTED
+# selectively, or entirely remove this flag.
+append_cflags("-fvisibility=hidden")
+
+create_go_makefile("foxify/foxify")

data/ext/foxify/foxify.c

@@ -0,0 +1,2 @@
+#include "foxify.h"
+#include "_cgo_export.h"

data/ext/foxify/foxify.go

@@ -0,0 +1,137 @@
+package main
+
+/*
+#include "foxify.h"
+
+VALUE rb_foxify_resumable_sha256_init(VALUE self);
+VALUE rb_foxify_resumable_sha256_update(VALUE self, VALUE state, VALUE data);
+VALUE rb_foxify_resumable_sha256_finalize(VALUE self, VALUE state);
+VALUE rb_foxify_resumable_sha1_init(VALUE self);
+VALUE rb_foxify_resumable_sha1_update(VALUE self, VALUE state, VALUE data);
+VALUE rb_foxify_resumable_sha1_finalize(VALUE self, VALUE state);
+*/
+import "C"
+
+import (
+	"crypto/sha1"
+	"crypto/sha256"
+	"encoding"
+	"encoding/base64"
+	"encoding/hex"
+	"log"
+
+	"github.com/ruby-go-gem/go-gem-wrapper/ruby"
+)
+
+//export rb_foxify_resumable_sha256_init
+func rb_foxify_resumable_sha256_init(_ C.VALUE) C.VALUE {
+	h := sha256.New()
+
+	marshaler := h.(encoding.BinaryMarshaler)
+	state, err := marshaler.MarshalBinary()
+	if err != nil {
+		log.Fatal("Unable to marshal hash:", err)
+	}
+
+	enc := base64.StdEncoding.EncodeToString(state)
+	return C.VALUE(ruby.String2Value(enc))
+}
+
+//export rb_foxify_resumable_sha1_init
+func rb_foxify_resumable_sha1_init(_ C.VALUE) C.VALUE {
+	h := sha1.New()
+
+	marshaler := h.(encoding.BinaryMarshaler)
+	state, err := marshaler.MarshalBinary()
+	if err != nil {
+		log.Fatal("Unable to marshal hash:", err)
+	}
+
+	enc := base64.StdEncoding.EncodeToString(state)
+	return C.VALUE(ruby.String2Value(enc))
+}
+
+//export rb_foxify_resumable_sha256_update
+func rb_foxify_resumable_sha256_update(_ C.VALUE, state C.VALUE, data C.VALUE) C.VALUE {
+	s, _ := base64.StdEncoding.DecodeString(ruby.Value2String(ruby.VALUE(state)))
+	h := sha256.New()
+	unmarshaler := h.(encoding.BinaryUnmarshaler)
+	unmarshaler.UnmarshalBinary(s)
+
+	buffer := ruby.Value2String(ruby.VALUE(data))
+	if len(buffer) > 0 {
+		h.Write([]byte(buffer))
+	}
+
+	marshaler := h.(encoding.BinaryMarshaler)
+	new_state, err := marshaler.MarshalBinary()
+	if err != nil {
+		log.Fatal("Unable to marshal hash:", err)
+	}
+
+	enc := base64.StdEncoding.EncodeToString(new_state)
+	return C.VALUE(ruby.String2Value(enc))
+}
+
+//export rb_foxify_resumable_sha1_update
+func rb_foxify_resumable_sha1_update(_ C.VALUE, state C.VALUE, data C.VALUE) C.VALUE {
+	s, _ := base64.StdEncoding.DecodeString(ruby.Value2String(ruby.VALUE(state)))
+	h := sha1.New()
+	unmarshaler := h.(encoding.BinaryUnmarshaler)
+	unmarshaler.UnmarshalBinary(s)
+
+	buffer := ruby.Value2String(ruby.VALUE(data))
+	if len(buffer) > 0 {
+		h.Write([]byte(buffer))
+	}
+
+	marshaler := h.(encoding.BinaryMarshaler)
+	new_state, err := marshaler.MarshalBinary()
+	if err != nil {
+		log.Fatal("Unable to marshal hash:", err)
+	}
+
+	enc := base64.StdEncoding.EncodeToString(new_state)
+	return C.VALUE(ruby.String2Value(enc))
+}
+
+//export rb_foxify_resumable_sha256_finalize
+func rb_foxify_resumable_sha256_finalize(_ C.VALUE, state C.VALUE) C.VALUE {
+	s, _ := base64.StdEncoding.DecodeString(ruby.Value2String(ruby.VALUE(state)))
+	h := sha256.New()
+	unmarshaler := h.(encoding.BinaryUnmarshaler)
+	unmarshaler.UnmarshalBinary(s)
+
+	result := h.Sum(nil)
+	return C.VALUE(ruby.String2Value(hex.EncodeToString(result)))
+}
+
+//export rb_foxify_resumable_sha1_finalize
+func rb_foxify_resumable_sha1_finalize(_ C.VALUE, state C.VALUE) C.VALUE {
+	s, _ := base64.StdEncoding.DecodeString(ruby.Value2String(ruby.VALUE(state)))
+	h := sha1.New()
+	unmarshaler := h.(encoding.BinaryUnmarshaler)
+	unmarshaler.UnmarshalBinary(s)
+
+	result := h.Sum(nil)
+	return C.VALUE(ruby.String2Value(hex.EncodeToString(result)))
+}
+
+//export Init_foxify
+func Init_foxify() {
+	rb_mFoxify := ruby.RbDefineModule("Foxify")
+	rb_mNative := ruby.RbDefineModuleUnder(rb_mFoxify, "Native")
+
+	// SHA256
+	ruby.RbDefineSingletonMethod(rb_mNative, "sha256_init", C.rb_foxify_resumable_sha256_init, 0)
+	ruby.RbDefineSingletonMethod(rb_mNative, "sha256_update", C.rb_foxify_resumable_sha256_update, 2)
+	ruby.RbDefineSingletonMethod(rb_mNative, "sha256_finalize", C.rb_foxify_resumable_sha256_finalize, 1)
+
+	// SHA1
+	ruby.RbDefineSingletonMethod(rb_mNative, "sha1_init", C.rb_foxify_resumable_sha1_init, 0)
+	ruby.RbDefineSingletonMethod(rb_mNative, "sha1_update", C.rb_foxify_resumable_sha1_update, 2)
+	ruby.RbDefineSingletonMethod(rb_mNative, "sha1_finalize", C.rb_foxify_resumable_sha1_finalize, 1)
+}
+
+func main() {
+}

data/ext/foxify/foxify.h

@@ -0,0 +1,6 @@
+#ifndef FOXIFY_H
+#define FOXIFY_H 1
+
+#include "ruby.h"
+
+#endif /* FOXIFY_H */

data/ext/foxify/go.mod

@@ -0,0 +1,5 @@
+module github.com/username/foxify
+
+go 1.23.4
+
+require github.com/ruby-go-gem/go-gem-wrapper v0.6.0 // indirect

data/ext/foxify/go.sum

@@ -0,0 +1,2 @@
+github.com/ruby-go-gem/go-gem-wrapper v0.6.0 h1:WFu2Cj/uzKAOemsrCo4P6vsdOgB5yesrrJtAqvLkAso=
+github.com/ruby-go-gem/go-gem-wrapper v0.6.0/go.mod h1:k2k+LziSCMxNYP4J9/9v90xdU6zlU1DJpJDTU6oJhHE=

data/lib/foxify/resumable_sha1.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require "msgpack"
+
+module Foxify
+  # A resumable SHA1 implementation
+  class ResumableSHA1
+    attr_reader :state, :finalized
+
+    def initialize(state = nil, finalized: false)
+      @state = state
+      @finalized = finalized
+      reset unless @state
+    end
+
+    def reset
+      @state = Foxify::Native.sha1_init
+      @finalized = false
+      self
+    end
+
+    def update(data)
+      raise Foxify::Error "Invalid state - you must reset this instance before adding new data" if @finalized
+
+      @state = Foxify::Native.sha1_update(@state, data)
+      self
+    end
+
+    def hexdigest
+      raise Foxify::Error, "Invalid state - this is already finalized" if @finalized
+
+      Foxify::Native.sha1_finalize(@state).tap do
+        @finalized = true
+      end
+    end
+
+    def ==(other)
+      self.class == other.class && state == other.state && finalized == other.finalized
+    end
+
+    def to_msgpack
+      [@state, @finalized].to_msgpack
+    end
+
+    def self.from_msgpack(data)
+      state, finalized = MessagePack.unpack(data)
+      new(state, finalized:)
+    end
+  end
+end

data/lib/foxify/resumable_sha256.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require "msgpack"
+
+module Foxify
+  # A resumable SHA256 implementation
+  class ResumableSHA256
+    attr_reader :state, :finalized
+
+    def initialize(state = nil, finalized: false)
+      @state = state
+      @finalized = finalized
+      reset unless @state
+    end
+
+    def reset
+      @state = Foxify::Native.sha256_init
+      @finalized = false
+      self
+    end
+
+    def update(data)
+      raise Foxify::Error "Invalid state - you must reset this instance before adding new data" if @finalized
+
+      @state = Foxify::Native.sha256_update(@state, data)
+      self
+    end
+
+    def hexdigest
+      raise Foxify::Error, "Invalid state - this is already finalized" if @finalized
+
+      Foxify::Native.sha256_finalize(@state).tap do
+        @finalized = true
+      end
+    end
+
+    def ==(other)
+      self.class == other.class && state == other.state && finalized == other.finalized
+    end
+
+    def to_msgpack
+      [@state, @finalized].to_msgpack
+    end
+
+    def self.from_msgpack(data)
+      state, finalized = MessagePack.unpack(data)
+      new(state, finalized:)
+    end
+  end
+end

data/lib/foxify/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Foxify
+  VERSION = "0.9.1"
+end

data/lib/foxify.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative "foxify/version"
+require_relative "foxify/foxify"
+require_relative "foxify/resumable_sha256"
+require_relative "foxify/resumable_sha1"
+
+module Foxify
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/sig/foxify.rbs

@@ -0,0 +1,4 @@
+module Foxify
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: foxify
+version: !ruby/object:Gem::Version
+  version: 0.9.1
+platform: ruby
+authors:
+- Dr. Zarkov
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-01-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: go_gem
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: msgpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provides ruby implementation of resumable digests based on golang implementation
+email:
+- zarkov@tor.ch
+executables: []
+extensions:
+- ext/foxify/extconf.rb
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- ext/foxify/extconf.rb
+- ext/foxify/foxify.c
+- ext/foxify/foxify.go
+- ext/foxify/foxify.h
+- ext/foxify/go.mod
+- ext/foxify/go.sum
+- lib/foxify.rb
+- lib/foxify/resumable_sha1.rb
+- lib/foxify/resumable_sha256.rb
+- lib/foxify/version.rb
+- sig/foxify.rbs
+homepage: https://github.com/orlon-pro/foxify
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/orlon-pro/foxify
+  source_code_uri: https://github.com/orlon-pro/foxify.
+  changelog_uri: https://github.com/orlon-pro/foxify/CHANGELOG.md
+  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.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.10
+signing_key:
+specification_version: 4
+summary: Implementation of resumable digests and other nifty foxalike things
+test_files: []