multihashes 0.1.2

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: af8e16174ea380ecf973c5cd7c37122fb00e497c
4
+ data.tar.gz: 128a26ad0f4bd259a54f1e0fb3d46d09979e6a40
5
+ SHA512:
6
+ metadata.gz: 39864436457038c35acb79fd20413053de7ffab3c65a339a88224ba5a5091afd1d78a9218333295749d0de31723f3e71fe0db56f26d3553d478de4c5b6c6b73a
7
+ data.tar.gz: 9ac19eb64fce65f6eff34adf6cbdc0d742c9506771c4331ca0c5025c2e9138d5087b798e1b900b0ce746881baee60d120443c8e9230d68cfb53072fea2856737
data/.gitignore ADDED
@@ -0,0 +1,9 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
data/.travis.yml ADDED
@@ -0,0 +1,4 @@
1
+ language: ruby
2
+ rvm:
3
+ - 2.1.2
4
+ before_install: gem install bundler -v 1.10.2
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in multihashes.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2015 Kyle Drake
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,65 @@
1
+ # Multihashes
2
+
3
+ A [Multihash](https://github.com/jbenet/multihash) implementation for ruby.
4
+
5
+ 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.
6
+
7
+ ## Installation
8
+
9
+ Add this line to your application's Gemfile:
10
+
11
+ ```ruby
12
+ gem 'multihashes'
13
+ ```
14
+
15
+ And then execute:
16
+
17
+ $ bundle
18
+
19
+ Or install it yourself as:
20
+
21
+ $ gem install multihashes
22
+
23
+ ## Usage
24
+
25
+ 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):
26
+
27
+ ```ruby
28
+ require 'multihashes'
29
+ require 'digest'
30
+
31
+ digest = Digest::SHA256.digest 'Dade Murphy will never figure this one out'
32
+ multihash_binary_string = Multihashes.encode digest, 'sha2-256'
33
+
34
+ multihash_binary_string.unpack('H*').first # hex: "1220142711d38ca7a33c521841..."
35
+
36
+ out = Multihashes.decode multihash_binary_string
37
+ # => {: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"}
38
+
39
+ ```
40
+
41
+ Hash function names (latest is [here](https://github.com/jbenet/multihash/blob/master/hashtable.csv))
42
+
43
+ code name
44
+ 0x11 sha1
45
+ 0x12 sha2-256
46
+ 0x13 sha2-512
47
+ 0x14 sha3
48
+ 0x40 blake2b
49
+ 0x41 blake2s
50
+ # 0x00-0x0f reserved for application specific functions
51
+ # 0x10-0x3f reserved for SHA standard functions
52
+
53
+ ## Development
54
+
55
+ 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.
56
+
57
+ To install this gem onto your local machine, run `bundle exec rake install`.
58
+
59
+ ## Contributing
60
+
61
+ Bug reports and pull requests are welcome on GitHub at https://github.com/neocities/multihashes.
62
+
63
+ ## License
64
+
65
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
data/Rakefile ADDED
@@ -0,0 +1,10 @@
1
+ require "bundler/gem_tasks"
2
+ require "rake/testtask"
3
+
4
+ Rake::TestTask.new(:test) do |t|
5
+ t.libs << "test"
6
+ t.libs << "lib"
7
+ t.test_files = FileList['test/**/*_test.rb']
8
+ end
9
+
10
+ task :default => :test
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "multihashes"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start
data/bin/setup ADDED
@@ -0,0 +1,7 @@
1
+ #!/bin/bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+
5
+ bundle install
6
+
7
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,3 @@
1
+ module Multihashes
2
+ VERSION = "0.1.2"
3
+ end
@@ -0,0 +1,33 @@
1
+ require 'multihashes/version'
2
+
3
+ module Multihashes
4
+ class HashFunctionNotImplemented < StandardError; end
5
+ class DigestLengthError < StandardError; end
6
+
7
+ # https://github.com/jbenet/multihash
8
+ TABLE = {
9
+ 0x11 => 'sha1',
10
+ 0x12 => 'sha2-256',
11
+ 0x13 => 'sha2-512',
12
+ 0x14 => 'sha3',
13
+ 0x40 => 'blake2b',
14
+ 0x41 => 'blake2s'
15
+ }
16
+
17
+ def self.encode(digest, hash_function)
18
+ length = digest.bytesize
19
+ key = TABLE.key hash_function
20
+ raise HashFunctionNotImplemented, 'unknown hash function code' if key.nil?
21
+ [TABLE.key(hash_function), length, digest].pack("CCA#{length}")
22
+ end
23
+
24
+ def self.decode(multihash)
25
+ integer, length, digest = multihash.unpack('CCA*')
26
+
27
+ if length != digest.bytesize
28
+ raise DigestLengthError, 'digest did not match expected multihash length'
29
+ end
30
+
31
+ {code: integer, hash_function: TABLE[integer], length: length, digest: digest}
32
+ end
33
+ end
@@ -0,0 +1,25 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'multihashes/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "multihashes"
8
+ spec.version = Multihashes::VERSION
9
+ spec.authors = ["Kyle Drake"]
10
+ spec.email = ["kyle@kyledrake.net"]
11
+
12
+ spec.summary = %q{A simple multihash (https://github.com/jbenet/multihash) implementation for ruby.}
13
+ spec.description = %q{A simple, low-level multihash (https://github.com/jbenet/multihash) implementation for ruby.}
14
+ spec.homepage = "https://github.com/neocities/ruby-multihashes"
15
+ spec.license = "MIT"
16
+
17
+ spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
18
+ spec.bindir = "exe"
19
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
20
+ spec.require_paths = ["lib"]
21
+
22
+ spec.add_development_dependency "bundler", "~> 1.10"
23
+ spec.add_development_dependency "rake", "~> 10.0"
24
+ spec.add_development_dependency "minitest"
25
+ end
metadata ADDED
@@ -0,0 +1,99 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: multihashes
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.2
5
+ platform: ruby
6
+ authors:
7
+ - Kyle Drake
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2015-06-09 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.10'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.10'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: minitest
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - ">="
46
+ - !ruby/object:Gem::Version
47
+ version: '0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - ">="
53
+ - !ruby/object:Gem::Version
54
+ version: '0'
55
+ description: A simple, low-level multihash (https://github.com/jbenet/multihash) implementation
56
+ for ruby.
57
+ email:
58
+ - kyle@kyledrake.net
59
+ executables: []
60
+ extensions: []
61
+ extra_rdoc_files: []
62
+ files:
63
+ - ".gitignore"
64
+ - ".travis.yml"
65
+ - Gemfile
66
+ - LICENSE.txt
67
+ - README.md
68
+ - Rakefile
69
+ - bin/console
70
+ - bin/setup
71
+ - lib/multihashes.rb
72
+ - lib/multihashes/version.rb
73
+ - multihashes.gemspec
74
+ homepage: https://github.com/neocities/ruby-multihashes
75
+ licenses:
76
+ - MIT
77
+ metadata: {}
78
+ post_install_message:
79
+ rdoc_options: []
80
+ require_paths:
81
+ - lib
82
+ required_ruby_version: !ruby/object:Gem::Requirement
83
+ requirements:
84
+ - - ">="
85
+ - !ruby/object:Gem::Version
86
+ version: '0'
87
+ required_rubygems_version: !ruby/object:Gem::Requirement
88
+ requirements:
89
+ - - ">="
90
+ - !ruby/object:Gem::Version
91
+ version: '0'
92
+ requirements: []
93
+ rubyforge_project:
94
+ rubygems_version: 2.4.6
95
+ signing_key:
96
+ specification_version: 4
97
+ summary: A simple multihash (https://github.com/jbenet/multihash) implementation for
98
+ ruby.
99
+ test_files: []