humanhash 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 28d8ec5e6e2033ba568335b1c13cf78faa790df0
+  data.tar.gz: 05d609e3a0d25494f7e1d26a1648d5816ff0514c
+SHA512:
+  metadata.gz: e37e624b96dff6f8f0f0c8a117c4664515f3c73bffdf4b534b029ccc2ddfa6074e6e72c1e890a3380fa74c6a27b205326d929fe5b3d55da543fdb4751e2b18ca
+  data.tar.gz: 6febea86a4ac16e06218b062d83571ef9a04d7003cffbfdb7bafc8df7a59cf495ae02702e469b7c0be65ffd56f29930254bb28d04413965a9f1e78d4a2221469

data/README.md

@@ -0,0 +1,63 @@
+#humanhash-ruby
+
+humanhash provides human-readable representations of digests. 
+
+This is a fork of Jacob Carlson's [port](https://github.com/jacobwcarlson/humanhash-ruby) 
+of a HumanHash implementation. It rearranges the library, adding some tests
+and helper methods to make usage more similar to [Zachary Voase's Python
+implementation](https://github.com/zacharyvoase/humanhash), while retaining extensibility.
+
+## Examples
+
+    irb(main):001:0> require 'humanhash'
+    irb(main):002:0> digest = '535061bddb0549f691c8b9c012a55ee2'
+    irb(main):003:0> HumanHash.humanize(digest)
+    => "alpha-twenty-mockingbird-twelve"
+    irb(main):004:0>
+    irb(main):005:0* HumanHash.uuid
+    => ["illinois-michigan-sad-bulldog", "7030c321-c015-4f84-88df-8da92138831b"]
+
+## Caveats
+
+Don't store the humanhash output, as its statistical uniqueness is only
+256^words. Its intended use is as a human-readable (and, most
+importantly, **memorable**) representation of a longer digest, unique enough
+for display in a user interface, where a user may need to remember or verbally
+communicate the identity of a hash, without having to remember a 40-character
+hexadecimal sequence. Nevertheless, you should keep original digests around,
+then pass them through `humanize()` only as you're displaying them.
+
+
+## How It Works
+
+The procedure for generating a humanhash involves compressing the input to a
+fixed length (default: 4 bytes), then mapping each of these bytes to a word in
+a pre-defined wordlist (a default wordlist is supplied with the library). This
+algorithm is consistent, so the same input, given the same wordlist, will
+always give the same output. You can also use your own wordlist, and specify a
+different number of words for output.
+
+
+## (Un)license
+
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or distribute this
+software, either in source code form or as a compiled binary, for any purpose,
+commercial or non-commercial, and by any means.
+
+In jurisdictions that recognize copyright laws, the author or authors of this
+software dedicate any and all copyright interest in the software to the public
+domain. We make this dedication for the benefit of the public at large and to
+the detriment of our heirs and successors. We intend this dedication to be an
+overt act of relinquishment in perpetuity of all present and future rights to
+this software under copyright law.
+
+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 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.
+
+For more information, please refer to <http://unlicense.org/>

data/lib/humanhash.rb

@@ -0,0 +1,48 @@
+require 'securerandom'
+require 'humanhash/version'
+require 'humanhash/wordlist'
+
+module HumanHash
+
+  class HumanHasher
+    attr_accessor :words
+    attr_accessor :separator
+    attr_accessor :wordlist
+
+    def initialize(opts={})
+      @words = opts.fetch(:words, 4)
+      @separator = opts.fetch(:separator, '-')
+      @wordlist = opts.fetch(:wordlist, DEFAULT_WORDLIST)
+      nil
+    end
+
+    def humanize(hexdigest)
+      bytes = [hexdigest].pack("H*").bytes.to_a
+      compress(bytes, words).map{|x| wordlist[x]}.join(separator)
+    end
+    
+    def compress(bytes, target)
+      len = bytes.size
+      return bytes unless target < len
+
+      segment_size = (len / target) + 1;
+      bytes.each_slice(segment_size).map{|x| x.reduce{|s,b| s ^ b}}
+    end
+    
+    def uuid
+      uuid = SecureRandom.uuid.gsub('-', '')
+      [ humanize(uuid), uuid ]
+    end
+
+  end
+
+  def self.humanize(hexdigest, opts={})
+    h = HumanHasher.new(opts)
+    h.humanize(hexdigest)
+  end
+
+  def self.uuid(opts={})
+    h = HumanHasher.new(opts)
+    h.uuid
+  end
+end

data/lib/humanhash/version.rb

@@ -0,0 +1,3 @@
+module HumanHash
+  VERSION = "0.1.0"
+end

data/lib/humanhash/wordlist.rb

@@ -0,0 +1,40 @@
+module HumanHash
+  DEFAULT_WORDLIST = [
+    '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'
+  ]
+end

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: humanhash
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jacob Carlson
+- Ross Duggan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-02 00:00:00.000000000 Z
+dependencies: []
+description: humanhash provides human-readable representations of digests.
+email:
+- ross.duggan@acm.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/humanhash/version.rb
+- lib/humanhash/wordlist.rb
+- lib/humanhash.rb
+- README.md
+homepage: https://github.com/duggan/humanhash-ruby
+licenses:
+- Unlicense
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Human-readable digests.
+test_files: []
+has_rdoc: