ruby_identicon 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 763a08551f9e59b52c16fd37d6f49a4818d1b474
+  data.tar.gz: ce13ad62ec04828f27d775eb59992e71eae6993c
+SHA512:
+  metadata.gz: ad4ac658f45c965c815849e5b04d4fa74fa9206524a276368aaff96b8013673b4e4588e3e3ba5cdcc79c9cc9e5c03b4e49cb7d67ca601549a1589c09b205372e
+  data.tar.gz: 8f5a5a5b9e7d6b70dfefa75367b3fed413270ea15fd9557891083e191cada9c45fd5d88a39b5c0a5709f843e1c7868764b2f2b4a2eadc56d1469abeb0439b0dd

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Chris Branson
+
+MIT License
+
+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,62 @@
+# RubyIdenticon
+
+![Example Identicon](https://dl.dropboxusercontent.com/u/176278/ruby_identicon.png)
+
+A Ruby implementation of [go-identicon](https://github.com/dgryski/go-identicon) by Damian Gryski
+
+RubyIdenticon creates an [identicon](https://en.wikipedia.org/wiki/Identicon), similar to those created by [Github](https://github.com/blog/1586-identicons).
+
+A title and key are used by siphash to calculate a hash value that is then used to create a visual identicon representation. The identicon is made by creating a left hand side pixel representation of each bit in the hash value - this is then mirrored onto the right hand side to create an image that we see as a shape. The grid and square sizes can be varied to create identicons of differing size.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ruby_identicon'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ruby_identicon
+
+## Usage
+
+Creating an identicon and saving to png
+
+    RubyIdenticon.create_and_save("RubyIdenticon", "ruby_identicon.png")
+
+Creating an identicon and returning a binary string
+
+    blob = RubyIdenticon.create("RubyIdenticon")
+  
+    # optional, save to a file
+    File.open("ruby_identicon.png", "wb") do |f| f.write(blob) end
+
+## Customising the identicon
+
+The identicon can be customised by passing additional options
+
+    background_color:  (Integer, default 0) the background color of the identicon in rgba notation (e.g. xffffffff for white)
+    border_size:  (Integer, default 35) the size in pixels to leave as an empty border around the identicon image
+    grid_size:    (Integer, default 7)  the number of rows and columns in the identicon, minimum 4, maximum 9
+    square_size:  (Integer, default 50) the size in pixels of each square that makes up the identicon
+    key:          (String) a 16 byte key used by siphash when calculating the hash value (see note below)
+  
+    Varying the key ensures uniqueness of an identicon for a given title, it is assumed desirable for different applications
+    to use a different key.
+  
+Example
+
+    blob = RubyIdenticon.create("identicons are great!", grid_size: 5, square_size: 70, background_color: 0xf0f0f0ff, key: "1234567890123456")
+    File.open("tmp/test_identicon.png", "wb") do |f| f.write(blob) end
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/ruby_identicon.rb

@@ -0,0 +1,143 @@
+#--
+# Copyright (c) 2013 Chris Branson
+#
+# Based on the go-identicon code at https://github.com/dgryski/go-identicon
+# go-identicon Copyright (c) 2013, Damian Gryski <damian@gryski.com>
+# Credit to Damian Gryski for the original concept.
+#
+# 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.
+#++
+
+#
+# A Ruby implementation of go-identicon
+#
+# RubyIdenticon creates an Identicon, similar to those created by Github.
+#
+# A title and key are used by siphash to calculate a hash value that is
+# then used to create a visual identicon representation.
+#
+# The identicon is made by creating a left hand side pixel representation
+# of each bit in the hash value - this is then mirrored onto the right
+# hand side to create an image that we see as a shape.
+#
+# The grid and square sizes can be varied to create identicons of
+# differing size.
+#
+
+require "ruby_identicon/version"
+require "chunky_png"
+require "siphash"
+
+module RubyIdenticon
+  # the default paramters used when creating identicons
+  #
+  # background_color: (Integer, default 0) the background color of the identicon in rgba notation (e.g. xffffffff for white)
+  # border_size:      (Integer, default 35) the size in pixels to leave as an empty border around the identicon image
+  # grid_size:        (Integer, default 7)  the number of rows and columns in the identicon, minimum 4, maximum 9
+  # square_size:      (Integer, default 50) the size in pixels of each square that makes up the identicon
+  # key:              (String) a 16 byte key used by siphash when calculating the hash value (see note below)
+  #
+  # varying the key ensures uniqueness of an identicon for a given title, it is assumed desirable for different applications
+  # to use a different key.
+  #
+
+  DEFAULT_PARAMETERS = {
+    border_size: 35,
+    square_size: 50,
+    grid_size: 7,
+    background_color: ChunkyPNG::Color::TRANSPARENT,
+    key: "\x00\x11\x22\x33\x44\x55\x66\x77\x88\x99\xAA\xBB\xCC\xDD\xEE\xFF"
+  }
+
+  # create an identicon png and save it to the given filename
+  #
+  # Example:
+  #   >> RubyIdenticon.create_and_save("identicons are great!", "test_identicon.png")
+  #   => result (Boolean)
+  #
+  # Arguments:
+  #   title: (String)
+  #   filename: (String)
+  #   options: (Hash)
+
+  def self.create_and_save(title, filename, options = {})
+    raise "filename cannot be nil" if filename == nil
+
+    blob = create(title, options)
+    return false if blob == nil
+
+    File.open(filename, "wb") do |f| f.write(blob) end
+  end
+
+  # create an identicon png and return it as a binary string
+  #
+  # Example:
+  #   >> RubyIdenticon.create("identicons are great!")
+  #   => binary blob (String)
+  #
+  # Arguments:
+  #   title: (String)
+  #   options: (Hash)
+
+  def self.create(title, options = {})
+    options = DEFAULT_PARAMETERS.merge(options)
+    
+    raise "title cannot be nil" if title == nil
+    raise "key is nil or less than 16 bytes" if options[:key] == nil || options[:key].length < 16
+    raise "grid_size must be between 4 and 9" if options[:grid_size] < 4 || options[:grid_size] > 9
+    raise "invalid border size" if options[:border_size] < 0
+    raise "invalid square size" if options[:square_size] < 0
+
+    hash = SipHash.digest(options[:key], title)
+
+    png = ChunkyPNG::Image.new((options[:border_size] * 2) + (options[:square_size] * options[:grid_size]),
+     (options[:border_size] * 2) + (options[:square_size] * options[:grid_size]), options[:background_color])
+
+    # set the foreground color by using the first three bytes of the hash value
+    color = ChunkyPNG::Color.rgba((hash & 0xff), ((hash >> 8) & 0xff), ((hash >> 16) & 0xff), 0xff)
+
+    # remove the first three bytes that were used for the foreground color
+    hash >>= 24
+
+    sqx = sqy = 0
+    for i in 0..(options[:grid_size] * ((options[:grid_size]+1) / 2))
+      if hash & 1 == 1
+        x = options[:border_size] + (sqx * options[:square_size])
+        y = options[:border_size] + (sqy * options[:square_size])
+
+        # left hand side
+        png.rect(x, y, x + options[:square_size], y + options[:square_size], color, color)
+
+        # mirror right hand side
+        x = options[:border_size] + ((options[:grid_size] - 1 - sqx) * options[:square_size])
+        png.rect(x, y, x + options[:square_size], y + options[:square_size], color, color)
+      end
+
+      hash >>= 1
+      sqy += 1
+      if sqy == options[:grid_size]
+        sqy = 0
+        sqx += 1
+      end
+    end
+
+    png.to_blob :color_mode => ChunkyPNG::COLOR_INDEXED
+  end
+end

data/lib/ruby_identicon/version.rb

@@ -0,0 +1,3 @@
+module RubyIdenticon
+  VERSION = "0.0.1"
+end

data/lib/siphash.rb

@@ -0,0 +1,117 @@
+#--
+# Copyright (c) 2012 Martin Boßlet
+#
+# 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.
+#++
+
+module SipHash
+
+  def self.digest(key, msg)
+    s = State.new(key)
+    len = msg.size
+    iter = len / 8
+
+    iter.times do |i|
+      m = msg.slice(i * 8, 8).unpack("Q<")[0]
+      s.apply_block(m)
+    end
+
+    m = last_block(msg, len, iter)
+
+    s.apply_block(m)
+    s.finalize
+    s.digest
+  end
+
+  private
+
+  def self.last_block(msg, len, iter)
+    last = (len << 56) & State::MASK_64;
+      
+    r = len % 8
+    off = iter * 8
+
+    last |= msg[off + 6].ord << 48 if r >= 7
+    last |= msg[off + 5].ord << 40 if r >= 6
+    last |= msg[off + 4].ord << 32 if r >= 5
+    last |= msg[off + 3].ord << 24 if r >= 4
+    last |= msg[off + 2].ord << 16 if r >= 3
+    last |= msg[off + 1].ord << 8 if r >= 2
+    last |= msg[off].ord if r >= 1
+    last
+  end
+
+  class State
+    
+    MASK_64 = 0xffffffffffffffff
+
+    def initialize(key)
+      @v0 = 0x736f6d6570736575
+      @v1 = 0x646f72616e646f6d
+      @v2 = 0x6c7967656e657261
+      @v3 = 0x7465646279746573
+
+      k0 = key.slice(0, 8).unpack("Q<")[0]
+      k1 = key.slice(8, 8).unpack("Q<")[0]
+
+      @v0 ^= k0
+      @v1 ^= k1
+      @v2 ^= k0
+      @v3 ^= k1
+    end
+
+    def apply_block(m)
+      @v3 ^= m
+      2.times { compress }
+      @v0 ^= m
+    end
+
+    def rotl64(num, shift)
+      ((num << shift) & MASK_64) | (num >> (64 - shift))
+    end
+
+    def compress
+      @v0 = (@v0 + @v1) & MASK_64
+      @v2 = (@v2 + @v3) & MASK_64 
+      @v1 = rotl64(@v1, 13)
+      @v3 = rotl64(@v3, 16)
+      @v1 ^= @v0
+      @v3 ^= @v2
+      @v0 = rotl64(@v0, 32)
+      @v2 = (@v2 + @v1) & MASK_64
+      @v0 = (@v0 + @v3) & MASK_64
+      @v1 = rotl64(@v1, 17)
+      @v3 = rotl64(@v3, 21)
+      @v1 ^= @v2
+      @v3 ^= @v0
+      @v2 = rotl64(@v2, 32)
+    end
+
+    def finalize
+      @v2 ^= 0xff
+      4.times { compress }
+    end
+
+    def digest
+      @v0 ^ @v1 ^ @v2 ^ @v3
+    end
+
+  end
+end

data/ruby_identicon.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ruby_identicon/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ruby_identicon"
+  spec.version       = RubyIdenticon::VERSION
+  spec.authors       = ["Chris Branson"]
+  spec.email         = ["branson.chris@gmail.com"]
+  
+  spec.description   = <<-EOT
+    A Ruby implementation of go-identicon by Damian Gryski
+
+    RubyIdenticon creates an identicon, similar to those created by Github.
+
+    A title and key are used by siphash to calculate a hash value that is then used
+    to create a visual identicon representation. The identicon is made by creating
+    a left hand side pixel representation of each bit in the hash value, this is then
+    mirrored onto the right hand side to create an image that we see as a shape.
+
+    The grid and square sizes can be varied to create identicons of differing size.
+  EOT
+
+  spec.summary       = %q{A Ruby Gem for creating GitHub like identicons}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.6"
+
+  spec.add_dependency "chunky_png", "~> 1.2.8"
+end

data/spec/ruby_identicon_spec.rb

@@ -0,0 +1,66 @@
+require 'rspec'
+require 'ruby_identicon'
+
+describe RubyIdenticon do
+  it "creates a binary string image blob" do
+    expect(RubyIdenticon.create("RubyIdenticon")).to be_a_kind_of(String)  
+  end
+
+  it "does not create a binary string image blob with an invalid title" do
+    lambda { RubyIdenticon.create(nil) }.should raise_exception("title cannot be nil")
+  end
+
+  it "does not create a binary string image blob with an invalid key" do
+    lambda { RubyIdenticon.create("identicons are great!", key: "\x00\x11\x22\x33\x44") }.should raise_exception("key is nil or less than 16 bytes")
+  end
+
+  it "does not create a binary string image blob with an invalid grid size" do
+    lambda { RubyIdenticon.create("RubyIdenticon", grid_size: 2) }.should raise_exception("grid_size must be between 4 and 9")
+    lambda { RubyIdenticon.create("RubyIdenticon", grid_size: 20) }.should raise_exception("grid_size must be between 4 and 9")
+  end
+
+  it "does not create a binary string image blob with an invalid square_size size" do
+    lambda { RubyIdenticon.create("RubyIdenticon", square_size: -2) }.should raise_exception("invalid square size")
+  end
+
+  it "does not create a binary string image blob with an invalid border_size size" do
+    lambda { RubyIdenticon.create("RubyIdenticon", border_size: -2) }.should raise_exception("invalid border size")
+  end
+
+
+
+  it "creates a png image file" do
+    blob = RubyIdenticon.create("RubyIdenticon")
+    result = File.open("tmp/ruby_identicon.png", "wb") do |f| f.write(blob) end
+    expect(result).to be_true
+  end
+
+  it "creates a png image file of grid size 5, square size 70 and grey background" do
+    blob = RubyIdenticon.create("RubyIdenticon", grid_size: 5, square_size: 70, background_color: 0xf0f0f0ff, key: "1234567890123456")
+    result = File.open("tmp/ruby_identicon_gs5_white.png", "wb") do |f| f.write(blob) end
+    expect(result).to be_true
+  end
+
+  it "creates 10 png image files" do
+    10.times do |count|
+      blob = RubyIdenticon.create("RubyIdenticon_#{count}")
+      result = File.open("tmp/ruby_identicon_#{count}.png", "wb") do |f| f.write(blob) end
+      expect(result).to be_true
+    end
+  end
+
+
+
+  it "creates a png image file via create_and_save" do
+    result = RubyIdenticon.create_and_save("RubyIdenticon is fun", "tmp/test_identicon.png")
+    expect(result).to be_true
+  end
+
+  it "does not create a png image file via create_and_save with an invalid filename" do
+    lambda { RubyIdenticon.create_and_save("RubyIdenticon is fun", nil) }.should raise_exception("filename cannot be nil")
+  end
+
+  it "does not create a png image file via create_and_save with an invalid title" do
+    lambda { RubyIdenticon.create_and_save(nil, "tmp/test_identicon.png") }.should raise_exception("title cannot be nil")
+  end
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: ruby_identicon
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Chris Branson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: chunky_png
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.8
+description: |2
+      A Ruby implementation of go-identicon by Damian Gryski
+
+      RubyIdenticon creates an identicon, similar to those created by Github.
+
+      A title and key are used by siphash to calculate a hash value that is then used
+      to create a visual identicon representation. The identicon is made by creating
+      a left hand side pixel representation of each bit in the hash value, this is then
+      mirrored onto the right hand side to create an image that we see as a shape.
+
+      The grid and square sizes can be varied to create identicons of differing size.
+email:
+- branson.chris@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ruby_identicon.rb
+- lib/ruby_identicon/version.rb
+- lib/siphash.rb
+- ruby_identicon.gemspec
+- spec/ruby_identicon_spec.rb
+homepage: ''
+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.0.7
+signing_key: 
+specification_version: 4
+summary: A Ruby Gem for creating GitHub like identicons
+test_files:
+- spec/ruby_identicon_spec.rb