objecthash 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2089181fcfda36f9d990b35901276a5c74d97d3a
+  data.tar.gz: e62cd6cff3db9ac44a5e325529186637fa3247c3
+SHA512:
+  metadata.gz: 07656d48d95258e4ce9e4597120f378a94b8569d101ce62820128eecdd6cee8acdba58cea65a9343be4d2dd137f7d6899be3c03053d475d40222eefd2eece7de
+  data.tar.gz: be41f7fc690ec9624c00d5abf646977ea310425f25da4400d02abd45ca7d14e950cc0cf33ac686ff02bc4f64c0c3ef718aa01098e93ac66f9102f19128ac3abb

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,39 @@
+AllCops:
+  TargetRubyVersion: 2.2
+  DisplayCopNames: true
+  Exclude:
+    - '**/*.pb.rb'
+#
+# Style
+#
+
+LineLength:
+  Max: 128
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/SpaceBeforeFirstArg:
+  Enabled: false
+
+Style/ConditionalAssignment:
+  Enabled: false
+
+Style/ModuleFunction:
+  Enabled: false
+
+#
+# Metrics
+#
+
+Metrics/MethodLength:
+  Max: 50
+
+Metrics/AbcSize:
+  Max: 15
+
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+Metrics/PerceivedComplexity:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+sudo: false
+
+bundler_args: --without development doc
+
+rvm:
+  - 2.2
+  - 2.3.1
+  - jruby-9.1.1.0
+
+before_install: gem install bundler -v 1.12.3
+
+branches:
+  only:
+    - master

data/CHANGES.md

@@ -0,0 +1,7 @@
+## 1.0.1 (2016-08-04)
+
+* Initial not-completely-broken release.
+
+## 1.0.0 (2016-05-29)
+
+* Botched release. Hot crypto smoke. Don't breathe this.

data/Gemfile

@@ -0,0 +1,14 @@
+source "https://rubygems.org"
+
+gemspec
+
+group :development do
+  gem "guard-rspec"
+end
+
+group :development, :test do
+  gem "rake"
+  gem "rake-compiler"
+  gem "rspec"
+  gem "rubocop", "= 0.40.0"
+end

data/Guardfile

@@ -0,0 +1,8 @@
+directories %w(lib spec)
+clearing :on
+
+guard :rspec, cmd: "bundle exec rspec" do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch("spec/spec_helper.rb")  { "spec" }
+end

data/LICENSE

@@ -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/README.md

@@ -0,0 +1,80 @@
+# ObjectHash
+
+[![Gem Version](https://badge.fury.io/rb/objecthash.svg)](https://rubygems.org/gems/objecthash)
+[![Build Status](https://secure.travis-ci.org/cryptosphere/objecthash-ruby.svg?branch=master)](https://travis-ci.org/cryptosphere/objecthash-ruby)
+[![Apache 2 licensed](https://img.shields.io/badge/license-Apache2-blue.svg)](https://github.com/cryptosphere/objecthash-ruby/blob/master/LICENSE)
+
+A content hash algorithm which works across multiple encodings (JSON, Protobufs, etc).
+
+This gem is a Ruby implementation of a format [originally created by Ben Laurie](https://github.com/benlaurie/objecthash).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "objecthash"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install objecthash
+
+## Usage
+
+ObjectHash can calculate a digest of object graphs composed of a constrained
+set of types. The following types are supported:
+
+* Booleans: `true`, `false`, `nil`
+* Numerics: Fixnum, Float
+* Array
+* Hash
+* Set
+* String (and Symbol)
+
+The `#digest` and `#hexdigest` methods are available on ObjectHash:
+
+Please note that Strings have [Unicode normalization](http://ruby-doc.org/stdlib-2.2.0/libdoc/unicode_normalize/rdoc/String.html) applied to them by default.
+You can disable this if desired by passing in the `normalize: false` keyword
+argument to `#digest` or `#hexdigest`. `String#unicode_normalize` was added in
+MRI Ruby v2.2.0 and that is the minimum supported version for ObjectHash.
+
+```ruby
+>> ObjectHash.hexdigest("Hello, Ruby!")
+=> "c92765c1350e6df6800dbadedb3420f398d5f3c7e38a3da48aadb3332280f85f"
+>> ObjectHash.hexdigest("Hello, Ruby!", normalize: false)
+=> "c92765c1350e6df6800dbadedb3420f398d5f3c7e38a3da48aadb3332280f85f"
+>> ObjectHash.hexdigest([{complex: "structures"}, {can: "be"}, {hashed: ["with", "ObjectHash"]}])
+=> "18717799dc21fff84b30a0654807348c632bc7498c5e40c025a6c18b9a2666d2"
+```
+
+Additionally you can provide a different hash algorithm by instantiating a class:
+
+```ruby
+>> objecthash = ObjectHash.new(Digest::SHA512)
+=> #<ObjectHash:0x007ffdf39765f0 @hash_algorithm=Digest::SHA512>
+>> objecthash.hexdigest("")
+=> "58007911bf9f66711ef65e807b26c396a2d6fb464f4381520c5d4a575dbb81510f79d35e349604128a771acf2a117a2afdedc012d83b0eb822668aee0def4747"
+```
+
+For compatibility reasons it's recommended you use the default hash algorithm (SHA-256).
+
+## TODO
+
+* Adapt better tests from upstream objecthash_test.py
+* Redaction support
+
+## Contributing
+
+* Fork this repository on Github
+* Make your changes and send a pull request
+* If your changes look good, we'll merge them
+
+## Copyright
+
+Copyright (c) 2016 Tony Arcieri, Ben Laurie. Distributed under the Apache 2.0 License.
+See LICENSE file for further details.

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task default: %w(spec rubocop)

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "objecthash"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/objecthash.rb

@@ -0,0 +1,143 @@
+# Originally designed by Ben Laurie
+# Adapted from https://github.com/benlaurie/objecthash/blob/master/objecthash.py
+
+require "objecthash/version"
+
+require "digest/sha2"
+require "set"
+
+# A content hash algorithm which works across multiple encodings (JSON, Protobufs, etc)
+class ObjectHash
+  # Default algorithm to use for computing object hashes
+  DEFAULT_HASH_ALGORITHM = Digest::SHA256
+
+  # Compute a raw ObjectHash digest using the default algorithm
+  def self.digest(object, normalize: true)
+    new.digest(object, normalize: normalize)
+  end
+
+  # Compute an hex ObjectHash digest using the default algorithm
+  def self.hexdigest(object, normalize: true)
+    new.hexdigest(object, normalize: normalize)
+  end
+
+  def initialize(hash_algorithm = DEFAULT_HASH_ALGORITHM)
+    @hash_algorithm = hash_algorithm
+  end
+
+  # Compute the ObjectHash of the given object
+  def digest(object, normalize: true)
+    case object
+    when Array       then obj_hash_list(object)
+    when Hash        then obj_hash_dict(object)
+    when String      then obj_hash_unicode(object, normalize)
+    when Symbol      then obj_hash_unicode(object.to_s, normalize)
+    when Float       then obj_hash_float(object)
+    when Fixnum      then obj_hash_int(object)
+    when Set         then obj_hash_set(object)
+    when true, false then obj_hash_bool(object)
+    when nil         then hash_primitive("n", "")
+    else             raise TypeError, "unsupported: #{object.class}"
+    end
+  end
+
+  # Compute the ObjectHash of the given object as hexadecimal
+  def hexdigest(object, normalize: true)
+    digest(object, normalize: normalize).unpack("H*").first
+  end
+
+  private
+
+  def hash_primitive(t, b)
+    m = @hash_algorithm.is_a?(Proc) ? @hash_algorithm.call : @hash_algorithm.new
+    m.update(t)
+    m.update(b)
+    m.digest
+  end
+
+  def obj_hash_bool(b)
+    hash_primitive("b", b ? "1" : "0")
+  end
+
+  def obj_hash_list(l)
+    h = l.map { |o| digest(o) }.join
+    hash_primitive("l", h)
+  end
+
+  def obj_hash_dict(d)
+    h = d.map { |k, v| digest(k) + digest(v) }.sort.join
+    hash_primitive("d", h)
+  end
+
+  # Takes a unicode string and a boolean to indicate
+  # whether to normalize unicode or not.
+  def obj_hash_unicode(u, n)
+    u_enc = u.encode("utf-8")
+    u_norm = n ? u_enc.unicode_normalize(:nfc) : u_enc
+    hash_primitive("u", u_norm)
+  end
+
+  # rubocop:disable Metrics/AbcSize
+  # rubocop:disable Metrics/CyclomaticComplexity
+  def float_normalize(f)
+    # special case 0
+    # Note that if we allowed f to end up > .5 or == 0, we'd get the same thing
+    return "+0:" if f == 0.0
+
+    # sign
+    if f >= 0
+      s = "+"
+    else
+      s = "-"
+      f = -f
+    end
+
+    # exponent
+    e = 0
+    while f > 1
+      f /= 2
+      e += 1
+    end
+
+    while f <= 0.5
+      f *= 2
+      e -= 1
+    end
+
+    s += "#{e}:"
+
+    # mantissa
+    raise unless f <= 1
+    raise unless f > 0.5
+
+    while f
+      if f >= 1
+        s += "1"
+        f -= 1
+      else
+        s += "0"
+      end
+
+      raise unless f < 1
+      raise unless s.length < 1000
+      f *= 2
+    end
+
+    s
+  end
+  # rubocop:enable Metrics/AbcSize
+  # rubocop:enable Metrics/CyclomaticComplexity
+
+  def obj_hash_float(f)
+    hash_primitive("f", float_normalize(f))
+  end
+
+  def obj_hash_int(i)
+    hash_primitive("i", i.to_s)
+  end
+
+  def obj_hash_set(s)
+    h = s.map { |e| e << digest(e) }.sort.join
+    hash_primitive("s", h)
+  end
+end

data/lib/objecthash/version.rb

@@ -0,0 +1,3 @@
+class ObjectHash
+  VERSION = "1.0.1".freeze
+end

data/objecthash.gemspec

@@ -0,0 +1,24 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "objecthash/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "objecthash"
+  spec.version       = ObjectHash::VERSION
+  spec.authors       = ["Tony Arcieri"]
+  spec.email         = ["bascule@gmail.com"]
+  spec.licenses      = ["Apache-2.0"]
+  spec.homepage      = "https://github.com/cryptosphere/objecthash-ruby"
+  spec.summary       = "A content hash algorithm which works across multiple encodings (JSON, Protobufs, etc)"
+  spec.description   = <<-DESCRIPTION.strip.gsub(/\s+/, " ")
+    A way to cryptographically hash objects (in the JSON-ish sense) that
+    works cross-language, and, therefore, cross-encoding.
+  DESCRIPTION
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 2.2.0"
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: objecthash
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Tony Arcieri
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-05 00:00:00.000000000 Z
+dependencies: []
+description: A way to cryptographically hash objects (in the JSON-ish sense) that
+  works cross-language, and, therefore, cross-encoding.
+email:
+- bascule@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGES.md
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/objecthash.rb
+- lib/objecthash/version.rb
+- objecthash.gemspec
+homepage: https://github.com/cryptosphere/objecthash-ruby
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A content hash algorithm which works across multiple encodings (JSON, Protobufs,
+  etc)
+test_files: []