memorable_password 0.0.1

data/lib/memorable_password/sample.rb

@@ -0,0 +1,7 @@
+if RUBY_VERSION.to_f < 1.9
+  class Array
+    def sample
+      self[rand(length)]
+    end
+  end
+end

data/lib/memorable_password/version.rb

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

data/lib/memorable_password.rb

@@ -0,0 +1,102 @@
+require 'memorable_password/sample'
+
+module MemorablePassword
+  
+  MAX_WORD_LENGTH = 7
+  DIGITS = (0..9).to_a.map{|d| d.to_s}
+  CHARACTERS = %w[! @ $ ? -]
+  
+  DEFAULT_OPTIONS = {
+    :mixed_case => false,
+    :special_characters => false,
+    :length => nil
+  }
+  
+  class << self; attr_accessor :dictionary, :blacklist end
+  @dictionary = nil
+  @blacklist = nil
+  
+  def self.generate(opts={})
+    opts = DEFAULT_OPTIONS.merge(opts)
+    
+    if opts[:length]
+      password = [(opts[:length] >= 9 ? long_word : word), (opts[:special_characters] ? character : digit)]
+      password << word(opts[:length] - password.compact.join.length)
+
+      if (count = opts[:length] - password.compact.join.length) > 0
+        count.times{ password << digit }
+      end
+    else
+      if opts[:special_characters]
+        password = [word, character, word, digit]
+      else
+        password = [word, digit, word]
+      end
+    end
+    
+    if opts[:mixed_case]
+      password.compact.reject{|x| x.length == 1}.sample.capitalize!
+    end
+    
+    # If it is too long, just cut it down to size. This should not happen often unless the :length option is present and is very small.
+    if opts[:length] && password.compact.join.length > opts[:length]
+      password.compact.join.slice(0, opts[:length])
+    else
+      password.compact.join
+    end
+  end
+  
+  private
+  
+  def self.character
+    CHARACTERS.sample
+  end
+  
+  def self.digit
+    DIGITS.sample
+  end
+  
+  def self.word(length=nil)
+    length = self.dictionary.keys.sample if !length || length > self.dictionary.keys.max
+    self.dictionary[length].sample if self.dictionary.has_key?(length)
+  end
+  
+  def self.long_word
+    keys = self.dictionary.keys.sort
+    self.dictionary[keys.partition{|v| v >= keys[keys.size/2] }.first.sample].sample  # Magic! It actually just randomly picks from the larger words..
+  end
+  
+  def self.initialize_dictionary
+    unless self.dictionary
+      self.dictionary = {}
+      self.blacklist = []
+      
+      # Load blacklist from text file
+      File.foreach(File.join(File.dirname(__FILE__), 'memorable_password', 'blacklist.txt'))do |word|
+        word = word.strip.downcase
+        self.blacklist << word if word =~ /^[a-z]+$/
+      end
+      
+      # Load system dictionary words
+      File.foreach("/usr/share/dict/words"){|word| add_word word}
+      
+      # Load list of proper names
+      File.foreach(File.join(File.dirname(__FILE__), 'memorable_password', 'names.txt')){|word| add_word word}
+    end
+    
+    self.dictionary
+  end
+  
+  def self.add_word(word)
+    word = word.strip.downcase
+    length = word.length
+    
+    if length <= MAX_WORD_LENGTH && length > 1 && word =~ /^[a-z]+$/ && !self.blacklist.include?(word)
+      self.dictionary[length] = [] unless self.dictionary[length]
+      self.dictionary[length] << word
+    end
+  end
+
+  initialize_dictionary
+  
+end

data/memorable_password.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "memorable_password/version"
+
+Gem::Specification.new do |s|
+  s.name        = "memorable_password"
+  s.version     = MemorablePassword::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Kevin McPhillips"]
+  s.email       = ["github@kevinmcphillips.ca"]
+  s.homepage    = "http://github.com/kimos/memorable_password"
+  s.summary     = %q{Generate human readable and easy to remember passwords}
+  s.description = %q{This simple gem generates a random password that is easy to read and remember. It uses dictionary words as well as a list of proper names mixed in with numbers and special characters.}
+
+  s.rubyforge_project = "memorable_password"
+
+  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"]
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: memorable_password
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Kevin McPhillips
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-16 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: This simple gem generates a random password that is easy to read and remember. It uses dictionary words as well as a list of proper names mixed in with numbers and special characters.
+email: 
+- github@kevinmcphillips.ca
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.markdown
+- Rakefile
+- lib/memorable_password.rb
+- lib/memorable_password/blacklist.txt
+- lib/memorable_password/names.txt
+- lib/memorable_password/sample.rb
+- lib/memorable_password/version.rb
+- memorable_password.gemspec
+has_rdoc: true
+homepage: http://github.com/kimos/memorable_password
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: memorable_password
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Generate human readable and easy to remember passwords
+test_files: []
+