ruby_identicon 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 45e5291c5b8bf12e49c19f80b3b27905b961852f
-  data.tar.gz: 87915f3490067d6be2cb9fbabeef1bd67244b24a
+  metadata.gz: 864f1543ca10712e1e4db984ce599ef5a49b23ae
+  data.tar.gz: 3009ca72274f11cfaa090fa275c9e64783d218fc
 SHA512:
-  metadata.gz: 5231070780e611164d5a31af26a6b3ff3e48e360d83efb70d417fb9c3eae2d185014e878563e5fa1d5667f94c66dbd010838ea803cf0d05c32140ca08f73a48d
-  data.tar.gz: 429ae0d91d748fc27918151595ef70df6050cb7fa12db5e24c69a66b6b1aa70a741f6b04a4bbf8051f71ef7c0b9b7850a5240b5cf1cd3dc6042a0ec681b4f0c0
+  metadata.gz: 68aa48240830d7c2df66e9244aff4da2042aebf65eebbb755da1f5a7d3ea0335a2f9297b6b6795c213e478c256b8db3bbdaecb3e0e8d87c382e4b9a93b229599
+  data.tar.gz: dda0a4b288e810f63eab0728c7574d79b0fd082337a8a843065a5d45193da8259abc717ff1998fe7a5feafabb7a34cfa8c22892698681855bc883b86a21b849b

data/Gemfile

@@ -1,5 +1,9 @@
 source 'https://rubygems.org'
 
+group :development do
+  gem 'yard'
+end
+
 group :test do
   gem 'coveralls', :require => false
 end

data/README.md

@@ -36,10 +36,14 @@ Creating an identicon and saving to 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
 
+Creating an identicon and returns in base64 format
+
+    base64 = RubyIdenticon.create_base64("RubyIdenticon")
+
 ## Customising the identicon
 
 The identicon can be customised by passing additional options
@@ -49,10 +53,10 @@ The identicon can be customised by passing additional options
     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")

data/lib/ruby_identicon.rb

@@ -25,6 +25,11 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #++
 
+require 'ruby_identicon/version'
+require 'chunky_png'
+require 'siphash'
+require 'base64'
+
 #
 # A Ruby implementation of go-identicon
 #
@@ -40,13 +45,8 @@
 # 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
+  # the default options 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
@@ -57,8 +57,7 @@ module RubyIdenticon
   # 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 = {
+  DEFAULT_OPTIONS = {
     border_size: 35,
     square_size: 50,
     grid_size: 7,
@@ -69,41 +68,39 @@ module RubyIdenticon
   # create an identicon png and save it to the given filename
   #
   # Example:
-  #   >> RubyIdenticon.create_and_save("identicons are great!", "test_identicon.png")
+  #   >> RubyIdenticon.create_and_save('identicons are great!', 'test_identicon.png')
   #   => result (Boolean)
   #
-  # Arguments:
-  #   title: (String)
-  #   filename: (String)
-  #   options: (Hash)
-
+  # @param title [string] the string value to be represented as an identicon
+  # @param filename [string] the full path and filename to save the identicon png to
+  # @param options [hash] additional options for the identicon
+  #
   def self.create_and_save(title, filename, options = {})
-    raise "filename cannot be nil" if filename == nil
+    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
+    File.open(filename, 'wb') { |f| f.write(blob) }
   end
 
   # create an identicon png and return it as a binary string
   #
   # Example:
-  #   >> RubyIdenticon.create("identicons are great!")
+  #   >> RubyIdenticon.create('identicons are great!')
   #   => binary blob (String)
   #
-  # Arguments:
-  #   title: (String)
-  #   options: (Hash)
-
+  # @param title [string] the string value to be represented as an identicon
+  # @param options [hash] additional options for the identicon
+  #
   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
+    options = DEFAULT_OPTIONS.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)
 
@@ -117,7 +114,7 @@ module RubyIdenticon
     hash >>= 24
 
     sqx = sqy = 0
-    for i in 0..(options[:grid_size] * ((options[:grid_size]+1) / 2))
+    (options[:grid_size] * ((options[:grid_size] + 1) / 2)).times do
       if hash & 1 == 1
         x = options[:border_size] + (sqx * options[:square_size])
         y = options[:border_size] + (sqy * options[:square_size])
@@ -138,6 +135,10 @@ module RubyIdenticon
       end
     end
 
-    png.to_blob :color_mode => ChunkyPNG::COLOR_INDEXED
+    png.to_blob color_mode: ChunkyPNG::COLOR_INDEXED
+  end
+
+  def self.create_base64(title, options = {})
+    Base64.encode64(self.create(title, options)).force_encoding('UTF-8')
   end
 end

data/lib/ruby_identicon/version.rb

@@ -1,3 +1,3 @@
 module RubyIdenticon
-  VERSION = "0.0.3"
+  VERSION = '0.0.4'
 end

data/lib/siphash.rb

@@ -8,10 +8,10 @@
 # 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
@@ -22,14 +22,13 @@
 #++
 
 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]
+      m = msg.slice(i * 8, 8).unpack('Q<')[0]
       s.apply_block(m)
     end
 
@@ -44,7 +43,7 @@ module SipHash
 
   def self.last_block(msg, len, iter)
     last = (len << 56) & State::MASK_64;
-      
+
     r = len % 8
     off = iter * 8
 
@@ -59,7 +58,7 @@ module SipHash
   end
 
   class State
-    
+
     MASK_64 = 0xffffffffffffffff
 
     def initialize(key)
@@ -68,8 +67,8 @@ module SipHash
       @v2 = 0x6c7967656e657261
       @v3 = 0x7465646279746573
 
-      k0 = key.slice(0, 8).unpack("Q<")[0]
-      k1 = key.slice(8, 8).unpack("Q<")[0]
+      k0 = key.slice(0, 8).unpack('Q<')[0]
+      k1 = key.slice(8, 8).unpack('Q<')[0]
 
       @v0 ^= k0
       @v1 ^= k1
@@ -89,7 +88,7 @@ module SipHash
 
     def compress
       @v0 = (@v0 + @v1) & MASK_64
-      @v2 = (@v2 + @v3) & MASK_64 
+      @v2 = (@v2 + @v3) & MASK_64
       @v1 = rotl64(@v1, 13)
       @v3 = rotl64(@v3, 16)
       @v1 ^= @v0
@@ -112,6 +111,5 @@ module SipHash
     def digest
       @v0 ^ @v1 ^ @v2 ^ @v3
     end
-
   end
 end

data/ruby_identicon.gemspec

@@ -31,9 +31,10 @@ Gem::Specification.new do |spec|
   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 "bundler", "~> 1.5"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec", "~> 2.6"
+  spec.add_development_dependency "rspec", "~> 2.14"
+  spec.add_development_dependency "yard", "~> 0.8.7"
 
   spec.add_dependency "chunky_png", "~> 1.3.0"
 end

data/ruby_identicon.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "ruby_identicon.rb"
+
+abort "Please run with a filename as an argument" unless ARGV[0]
+filename = ARGV[0].clone
+ARGV.clear
+
+print "Reading standard input to generate identicon...\n"
+
+identstring = gets
+
+blob = RubyIdenticon.create(identstring, grid_size: 5, square_size: 70, background_color: 0xf0f0f0ff, key: "1234567890123456")
+File.open(filename, "wb") do |f| f.write(blob) end

data/spec/ruby_identicon_spec.rb

@@ -2,68 +2,74 @@ require 'helper'
 
 describe RubyIdenticon do
   before(:each) do
-    Dir.mkdir("tmp") unless File.directory?("tmp")
+    Dir.mkdir('tmp') unless File.directory?('tmp')
   end
 
-  it "creates a binary string image blob" do
-    expect(RubyIdenticon.create("RubyIdenticon")).to be_a_kind_of(String)  
+  # general parameter tests
+  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")
+  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")
+  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")
+  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")
+  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")
+  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
+  # blob creation tests
+  it 'creates a png image file' do
+    blob = RubyIdenticon.create('RubyIdenticon')
+    result = File.open('tmp/ruby_identicon.png', 'wb') { |f| f.write(blob) }
     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
+  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') { |f| f.write(blob) }
     expect(result).to be_true
   end
 
-  it "creates 10 png image files" do
+  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
+      result = File.open("tmp/ruby_identicon_#{count}.png", 'wb') { |f| f.write(blob) }
       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")
+  # file creation tests
+  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")
+  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
 
-  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")
+  # Base64 creation tests
+  it 'creates base64 version of the image' do
+    blob = RubyIdenticon.create('RubyIdenticon')
+    base64 = RubyIdenticon.create_base64('RubyIdenticon')
+    expect(Base64.decode64(base64).force_encoding('UTF-8')).to eq blob
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_identicon
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Chris Branson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-17 00:00:00.000000000 Z
+date: 2015-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +44,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7
 - !ruby/object:Gem::Dependency
   name: chunky_png
   requirement: !ruby/object:Gem::Requirement
@@ -93,6 +107,7 @@ files:
 - lib/ruby_identicon/version.rb
 - lib/siphash.rb
 - ruby_identicon.gemspec
+- ruby_identicon.rb
 - spec/helper.rb
 - spec/ruby_identicon_spec.rb
 homepage: ''
@@ -115,10 +130,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: A Ruby Gem for creating GitHub like identicons
 test_files:
 - spec/helper.rb
 - spec/ruby_identicon_spec.rb
+has_rdoc: