readable_random 0.1.2

data/README.markdown

@@ -0,0 +1,35 @@
+Readable string for coupon codes or auth tokens, something people can read/write and do not confuse.
+
+ - more information density than hex -> shorter codes
+ - less confusion than base64 -> readable codes
+ - less 'stupid' then ActiveSupport::SecureRandom, e.g. hex(5).size == 5, not 10
+
+Install
+=======
+ - As gem: ` sudo gem install readable_random `
+ - As Rails plugin: ` script/plugin install git://github.com/grosser/readable_random.git `
+
+Usage
+=====
+    ReadableRandom.get(5) -> 'aB23r'
+
+    # user.rb
+    def generate_token
+      while token.blank? or User.find_by_token(token)
+        self.token = ReadableRandom.get(6)
+      end
+    end
+
+    ReadableRandom.hex(5) -> '12af4'
+    ReadableRandom.base64(5) -> 'at12k'
+
+TODO
+====
+ - prevent nasty words by not using vovels or a more clever tick...
+
+
+AUTHOR
+======
+[Michael Grosser](http://pragmatig.wordpress.com)  
+grosser.michael@gmail.com  
+Hereby placed under public domain, do what you want, just do not hold me accountable...

data/Rakefile.rb

@@ -0,0 +1,29 @@
+desc "Run all specs in spec directory"
+task :default do
+  options = "--colour --format progress --loadby --reverse"
+  files = FileList['spec/**/*_spec.rb']
+  system("spec #{options} #{files}")
+end
+
+begin
+  require 'jeweler'
+  project_name = 'readable_random'
+  Jeweler::Tasks.new do |gem|
+    gem.name = project_name
+    gem.description = gem.summary = "Readable random strings for coupons or tokens"
+    gem.email = "grosser.michael@gmail.com"
+    gem.homepage = "http://github.com/grosser/#{project_name}"
+    gem.authors = ["Michael Grosser"]
+    gem.rubyforge_project = 'readable-random'
+  end
+
+  # fake task so that rubyforge:release works
+  task :rdoc do
+    `mkdir rdoc`
+    `echo documentation is at http://github.com/grosser/#{project_name} > rdoc/README.rdoc`
+  end
+
+  Jeweler::RubyforgeTasks.new
+rescue LoadError
+  puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.2

data/init.rb

@@ -0,0 +1,2 @@
+#only needed wen used as Rails plugin
+require 'readable_random'

data/lib/readable_random.rb

@@ -0,0 +1,32 @@
+require 'openssl'
+require "base64"
+
+class ReadableRandom
+  VERSION = File.read( File.join(File.dirname(__FILE__),'..','VERSION') ).strip
+  NON_READABLE = %w[o O 0 1 l / = +]
+
+  def self.get(size)
+    try = random_string(size * 2)
+    try = try.split('').reject{|x| NON_READABLE.include? x}.join('')
+
+    if try.length < size #too many excluded characters !?
+      get(size) #try once again...
+    else
+      try[0...size]
+    end
+  end
+
+  def self.hex(size)
+    random_string(size).unpack("H*")[0][0...size]
+  end
+
+  def self.base64(size)
+    random_string(size)[0...size]
+  end
+
+  private
+
+  def self.random_string(size)
+    [OpenSSL::Random.random_bytes(size)].pack("m*").delete("\n")
+  end
+end

data/rdoc/README.rdoc

@@ -0,0 +1 @@
+documentation is at http://github.com/grosser/readable_random

data/readable_random.gemspec

@@ -0,0 +1,49 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{readable_random}
+  s.version = "0.1.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Michael Grosser"]
+  s.date = %q{2009-10-22}
+  s.description = %q{Readable random strings for coupons or tokens}
+  s.email = %q{grosser.michael@gmail.com}
+  s.extra_rdoc_files = [
+    "README.markdown"
+  ]
+  s.files = [
+    "README.markdown",
+     "Rakefile.rb",
+     "VERSION",
+     "init.rb",
+     "lib/readable_random.rb",
+     "rdoc/README.rdoc",
+     "readable_random.gemspec",
+     "spec/readable_random_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/grosser/readable_random}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{readable-random}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Readable random strings for coupons or tokens}
+  s.test_files = [
+    "spec/spec_helper.rb",
+     "spec/readable_random_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/spec/readable_random_spec.rb

@@ -0,0 +1,60 @@
+require 'spec/spec_helper'
+
+describe ReadableRandom do
+  def set(method, size)
+    set = []
+    100.times{ set << ReadableRandom.send(method, size) }
+    set
+  end
+
+  describe :get do
+    it "has the expected length" do
+      set(:get, 7).map{|x|x.length}.uniq.should == [7]
+    end
+
+    it "is unique" do
+      set = set(:get, 7)
+      set.uniq.size.should == set.size
+    end
+
+    it "works for small numbers" do
+      set(:get, 1).map{|x|x.length}.uniq.should == [1]
+    end
+
+    it "works for large numbers" do
+      set(:get, 255).map{|x|x.length}.uniq.should == [255]
+    end
+
+    it "does not contain hard to read chars" do
+      set = set(:get, 7)
+      ReadableRandom::NON_READABLE.each do |ambiguouse_letter|
+        (set * '').should_not include(ambiguouse_letter)
+      end
+    end
+  end
+
+  describe :hex do
+    it "has given length" do
+      set(:hex, 5).map{|x| x.length}.uniq.should == [5]
+    end
+
+    it "contains the hex chars" do
+      set(:hex, 5).map{|x| x.split('')}.flatten.uniq.sort.should == %w[0 1 2 3 4 5 6 7 8 9 a b c d e f]
+    end
+  end
+
+  describe :base64 do
+    it "has given length" do
+      set(:base64, 5).map{|x| x.length}.uniq.should == [5]
+    end
+
+    it "contains the base64 chars" do
+      base64_chars = (['+', '/'] + ('0'..'9').to_a + ('A'..'Z').to_a + ('a'..'z').to_a)
+      set(:base64, 5).map{|x| x.split('')}.flatten.uniq.sort.should == base64_chars
+    end
+  end
+
+  it "has a VERSION" do
+    ReadableRandom::VERSION.should =~ /^\d+\.\d+\.\d+$/
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+# ---- requirements
+$LOAD_PATH << File.expand_path("../lib", File.dirname(__FILE__))
+
+# ---- setup environment/plugin
+require File.expand_path("../init", File.dirname(__FILE__))

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+name: readable_random
+version: !ruby/object:Gem::Version 
+  version: 0.1.2
+platform: ruby
+authors: 
+- Michael Grosser
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-22 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: Readable random strings for coupons or tokens
+email: grosser.michael@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- README.markdown
+- Rakefile.rb
+- VERSION
+- init.rb
+- lib/readable_random.rb
+- rdoc/README.rdoc
+- readable_random.gemspec
+- spec/readable_random_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/grosser/readable_random
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: readable-random
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Readable random strings for coupons or tokens
+test_files: 
+- spec/spec_helper.rb
+- spec/readable_random_spec.rb