multihashes 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: af8e16174ea380ecf973c5cd7c37122fb00e497c
+  data.tar.gz: 128a26ad0f4bd259a54f1e0fb3d46d09979e6a40
+SHA512:
+  metadata.gz: 39864436457038c35acb79fd20413053de7ffab3c65a339a88224ba5a5091afd1d78a9218333295749d0de31723f3e71fe0db56f26d3553d478de4c5b6c6b73a
+  data.tar.gz: 9ac19eb64fce65f6eff34adf6cbdc0d742c9506771c4331ca0c5025c2e9138d5087b798e1b900b0ce746881baee60d120443c8e9230d68cfb53072fea2856737

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.2
+before_install: gem install bundler -v 1.10.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in multihashes.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Kyle Drake
+
+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,65 @@
+# Multihashes
+
+A [Multihash](https://github.com/jbenet/multihash) implementation for ruby.
+
+A multihash is a digest with an embedded hash function code (and length) (['cause you never know](https://twitter.com/matthew_d_green/status/597409850381836288)). It was developed primarily for use with [IPFS](https://github.com/ipfs/ipfs), but is not specific to it.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'multihashes'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install multihashes
+
+## Usage
+
+This is a low-level library. Bring your own digest. A binary digest goes in, a binary digest goes out. To compute a sha256 multihash that would work nicely with [IPFS](https://github.com/ipfs/ipfs):
+
+```ruby
+require 'multihashes'
+require 'digest'
+
+digest = Digest::SHA256.digest 'Dade Murphy will never figure this one out'
+multihash_binary_string = Multihashes.encode digest, 'sha2-256'
+
+multihash_binary_string.unpack('H*').first # hex: "1220142711d38ca7a33c521841..."
+
+out = Multihashes.decode multihash_binary_string
+# => {:code=>18, :hash_function=>"sha2-256", :length=>32, :digest=>"\x14'\x11\xD3\x8C\xA7\xA3<R\x18Ao\x8F\xFC\xC6FH\xCAF\x16\xA6%\xB5\xE0\xA0\xAB=\xA1\x91\x1D]z"}
+
+```
+
+Hash function names (latest is [here](https://github.com/jbenet/multihash/blob/master/hashtable.csv))
+
+    code name
+    0x11 sha1
+    0x12 sha2-256
+    0x13 sha2-512
+    0x14 sha3
+    0x40 blake2b
+    0x41 blake2s
+    # 0x00-0x0f reserved for application specific functions
+    # 0x10-0x3f reserved for SHA standard functions
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/neocities/multihashes.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "multihashes"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/multihashes/version.rb

@@ -0,0 +1,3 @@
+module Multihashes
+  VERSION = "0.1.2"
+end

data/lib/multihashes.rb

@@ -0,0 +1,33 @@
+require 'multihashes/version'
+
+module Multihashes
+  class HashFunctionNotImplemented < StandardError; end
+  class DigestLengthError < StandardError; end
+
+  # https://github.com/jbenet/multihash
+  TABLE = {
+    0x11 => 'sha1',
+    0x12 => 'sha2-256',
+    0x13 => 'sha2-512',
+    0x14 => 'sha3',
+    0x40 => 'blake2b',
+    0x41 => 'blake2s'
+  }
+
+  def self.encode(digest, hash_function)
+    length = digest.bytesize
+    key = TABLE.key hash_function
+    raise HashFunctionNotImplemented, 'unknown hash function code' if key.nil?
+    [TABLE.key(hash_function), length, digest].pack("CCA#{length}")
+  end
+
+  def self.decode(multihash)
+    integer, length, digest = multihash.unpack('CCA*')
+
+    if length != digest.bytesize
+      raise DigestLengthError, 'digest did not match expected multihash length'
+    end
+
+    {code: integer, hash_function: TABLE[integer], length: length, digest: digest}
+  end
+end

data/multihashes.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'multihashes/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "multihashes"
+  spec.version       = Multihashes::VERSION
+  spec.authors       = ["Kyle Drake"]
+  spec.email         = ["kyle@kyledrake.net"]
+
+  spec.summary       = %q{A simple multihash (https://github.com/jbenet/multihash) implementation for ruby.}
+  spec.description   = %q{A simple, low-level multihash (https://github.com/jbenet/multihash) implementation for ruby.}
+  spec.homepage      = "https://github.com/neocities/ruby-multihashes"
+  spec.license       = "MIT"
+
+  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.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: multihashes
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Kyle Drake
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-06-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple, low-level multihash (https://github.com/jbenet/multihash) implementation
+  for ruby.
+email:
+- kyle@kyledrake.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/multihashes.rb
+- lib/multihashes/version.rb
+- multihashes.gemspec
+homepage: https://github.com/neocities/ruby-multihashes
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: A simple multihash (https://github.com/jbenet/multihash) implementation for
+  ruby.
+test_files: []