human_digest 0.0.3

data/.gitignore

@@ -0,0 +1,4 @@
+.rvmrc
+.DS_Store
+Gemfile.lock
+human_digest-*.gem

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+(The MIT License)
+
+Copyright (c) 2012 Matt Vanderpol
+
+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,19 @@
+# HumanDigest
+
+HumanDigest is a Ruby library that creates human-readable representations of digests. 
+
+## Example
+
+```ruby
+digest = '60ad8d0d871b6095808297'
+puts HumanDigest.humanize(digest)  # => sodium-magnesium-nineteen-hydrogen
+```
+
+## Inspiration
+
+HumanDigest is a Ruby port of the [humanhash library for python](https://github.com/zacharyvoase/humanhash)
+
+
+## License
+
+Copyright (c) 2012 Matt Vanderpol, released under the MIT license

data/Rakefile

@@ -0,0 +1,7 @@
+require 'rspec/core/rake_task'
+
+task :default => :spec
+
+RSpec::Core::RakeTask.new do |t|
+  t.ruby_opts = ["-w"]
+end

data/human_digest.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "human_digest/version"
+
+Gem::Specification.new do |s|
+  s.name        = 'human_digest'
+  s.version     = HumanDigest::VERSION
+  s.date        = '2012-02-29'
+  s.summary     = "HumanDigest"
+  s.description = "Human-readable digests"
+  s.authors     = ["Matt Vanderpol"]
+  s.email       = 'matt@vanderpol.net'
+  s.files       = ["lib/human_digest.rb"]
+  s.homepage    = "https://github.com/bookwyrm/human_digest"
+
+  s.rubyforge_project = "human_digest"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec"
+end

data/lib/human_digest/version.rb

@@ -0,0 +1,3 @@
+module HumanDigest
+  VERSION = "0.0.3"
+end

data/lib/human_digest.rb

@@ -0,0 +1,84 @@
+require "human_digest/version"
+
+# HumanDigest - Human-readable representations of digests
+module HumanDigest
+  @word_list = [
+      'ack', 'alabama', 'alanine', 'alaska', 'alpha', 'angel', 'apart', 'april',
+      'arizona', 'arkansas', 'artist', 'asparagus', 'aspen', 'august', 'autumn',
+      'avocado', 'bacon', 'bakerloo', 'batman', 'beer', 'berlin', 'beryllium',
+      'black', 'blossom', 'blue', 'bluebird', 'bravo', 'bulldog', 'burger',
+      'butter', 'california', 'carbon', 'cardinal', 'carolina', 'carpet', 'cat',
+      'ceiling', 'charlie', 'chicken', 'coffee', 'cola', 'cold', 'colorado',
+      'comet', 'connecticut', 'crazy', 'cup', 'dakota', 'december', 'delaware',
+      'delta', 'diet', 'don', 'double', 'early', 'earth', 'east', 'echo',
+      'edward', 'eight', 'eighteen', 'eleven', 'emma', 'enemy', 'equal',
+      'failed', 'fanta', 'fifteen', 'fillet', 'finch', 'fish', 'five', 'fix',
+      'floor', 'florida', 'football', 'four', 'fourteen', 'foxtrot', 'freddie',
+      'friend', 'fruit', 'gee', 'georgia', 'glucose', 'golf', 'green', 'grey',
+      'hamper', 'happy', 'harry', 'hawaii', 'helium', 'high', 'hot', 'hotel',
+      'hydrogen', 'idaho', 'illinois', 'india', 'indigo', 'ink', 'iowa',
+      'island', 'item', 'jersey', 'jig', 'johnny', 'juliet', 'july', 'jupiter',
+      'kansas', 'kentucky', 'kilo', 'king', 'kitten', 'lactose', 'lake', 'lamp',
+      'lemon', 'leopard', 'lima', 'lion', 'lithium', 'london', 'louisiana',
+      'low', 'magazine', 'magnesium', 'maine', 'mango', 'march', 'mars',
+      'maryland', 'massachusetts', 'may', 'mexico', 'michigan', 'mike',
+      'minnesota', 'mirror', 'mississippi', 'missouri', 'mobile', 'mockingbird',
+      'monkey', 'montana', 'moon', 'mountain', 'muppet', 'music', 'nebraska',
+      'neptune', 'network', 'nevada', 'nine', 'nineteen', 'nitrogen', 'north',
+      'november', 'nuts', 'october', 'ohio', 'oklahoma', 'one', 'orange',
+      'oranges', 'oregon', 'oscar', 'oven', 'oxygen', 'papa', 'paris', 'pasta',
+      'pennsylvania', 'pip', 'pizza', 'pluto', 'potato', 'princess', 'purple',
+      'quebec', 'queen', 'quiet', 'red', 'river', 'robert', 'robin', 'romeo',
+      'rugby', 'sad', 'salami', 'saturn', 'september', 'seven', 'seventeen',
+      'shade', 'sierra', 'single', 'sink', 'six', 'sixteen', 'skylark', 'snake',
+      'social', 'sodium', 'solar', 'south', 'spaghetti', 'speaker', 'spring',
+      'stairway', 'steak', 'stream', 'summer', 'sweet', 'table', 'tango', 'ten',
+      'tennessee', 'tennis', 'texas', 'thirteen', 'three', 'timing', 'triple',
+      'twelve', 'twenty', 'two', 'uncle', 'undress', 'uniform', 'uranus', 'utah',
+      'vegan', 'venus', 'vermont', 'victor', 'video', 'violet', 'virginia',
+      'washington', 'west', 'whiskey', 'white', 'william', 'winner', 'winter',
+      'wisconsin', 'wolfram', 'wyoming', 'xray', 'yankee', 'yellow', 'zebra',
+      'zulu'
+  ]
+
+  # Make a digest human-readable
+  #
+  # Example:
+  #   >> HumanDigest.humanize('60ad8d0d871b6095808297)
+  #   => sodium-magnesium-nineteen-hydrogen
+  #
+  # Arguments:
+  #   hexdigest: (String)
+  #   words: (Integer)
+  #   separator: (String)
+
+  def self.humanize(hexdigest, words=4, separator='-')
+  	limit = hexdigest.length / 2
+  	unpack_format = 'A2' * limit
+  	bytes = hexdigest.unpack(unpack_format).collect { |x| x.hex }
+  	compressed = compress(bytes, words)
+  	return (compressed.collect { |x| @word_list[x] }).join(separator)
+  end
+
+  # Compress a byte array into a shorter length
+  #
+  # Example:
+  #   >> HumanDigest.compress([96, 173, 141, 13, 135, 27, 96, 149, 128, 130, 151])
+  #   => [205, 128, 156, 96]
+  #
+  # Arguments:
+  #   bytes: (Array)
+  #   target: (Integer)
+
+  def self.compress(bytes, target)
+  	bytes_copy = bytes.clone
+  	length = bytes_copy.length
+  	seg_size = (length / target).floor
+  	segments = []
+  	target.times { segments.push(bytes_copy.slice!(0, seg_size)) }
+  	segments[-1].concat(bytes_copy)
+  	checksums = segments.collect { |a| a.reduce(:^) }
+  	return checksums
+  end
+
+end

data/spec/human_digest_spec.rb

@@ -0,0 +1,33 @@
+require 'human_digest'
+
+describe HumanDigest do
+  it "should generate a human digest" do
+    digest = '60ad8d0d871b6095808297'
+    HumanDigest.humanize(digest).should == 'sodium-magnesium-nineteen-hydrogen'
+  end
+  
+  it "should compress byte arrays" do
+    byte_array = [96, 173, 141, 13, 135, 27, 96, 149, 128, 130, 151]
+    target = 4
+    HumanDigest.compress(byte_array, target).should == [205, 128, 156, 96]
+  end
+  
+  it "should take a word count" do
+    digest = '60ad8d0d871b6095808297'
+    words = 4
+    HumanDigest.humanize(digest, words).should eq('sodium-magnesium-nineteen-hydrogen')
+    
+    words = 3
+    HumanDigest.humanize(digest, words).should eq('equal-monkey-hydrogen')
+  end
+  
+  it "should take a separator" do
+    digest = '60ad8d0d871b6095808297'
+    words = 4
+    separator = '-'
+    HumanDigest.humanize(digest, words, separator).should eq('sodium-magnesium-nineteen-hydrogen')
+
+    separator = ' '
+    HumanDigest.humanize(digest, words, separator).should eq('sodium magnesium nineteen hydrogen')
+  end    
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: human_digest
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+  prerelease: 
+platform: ruby
+authors:
+- Matt Vanderpol
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-29 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70307781222500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70307781222500
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70307781222080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70307781222080
+description: Human-readable digests
+email: matt@vanderpol.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- human_digest.gemspec
+- lib/human_digest.rb
+- lib/human_digest/version.rb
+- spec/human_digest_spec.rb
+homepage: https://github.com/bookwyrm/human_digest
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: human_digest
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: HumanDigest
+test_files:
+- spec/human_digest_spec.rb