perch 0.2.3

data/.autotest

@@ -0,0 +1,23 @@
+# -*- ruby -*-
+
+require 'autotest/restart'
+
+# Autotest.add_hook :initialize do |at|
+#   at.extra_files << "../some/external/dependency.rb"
+#
+#   at.libs << ":../some/external"
+#
+#   at.add_exception 'vendor'
+#
+#   at.add_mapping(/dependency.rb/) do |f, _|
+#     at.files_matching(/test_.*rb$/)
+#   end
+#
+#   %w(TestA TestB).each do |klass|
+#     at.extra_class_map[klass] = "test/test_misc.rb"
+#   end
+# end
+
+# Autotest.add_hook :run_command do |at|
+#   system "rake build"
+# end

data/History.rdoc

@@ -0,0 +1,36 @@
+=== 0.2.1 / 2009-05-14
+
+* 1 major, minor enhancement
+
+  * Ruby 1.9 compatibility.
+
+
+
+=== 0.2.0 / 2009-03-29
+
+* 1 major enhancement
+
+  * Changed "haddock" to "ha-gen" for Haskell compliance.
+
+
+=== 0.1.1 / 2009-03-29
+
+* 2 minor enhancements
+
+  * Add version option to command-line utility.
+  * Bumping up version numbers to improve credibility.
+
+
+=== 0.1.0 / 2009-03-29
+
+* 2 minor enhancements
+
+  * Friendlier command-line errors.
+  * General cleanup.
+
+
+=== 0.0.1 / 2009-03-28
+
+* 1 major enhancement
+
+  * Birthday!

data/Manifest.txt

@@ -0,0 +1,9 @@
+.autotest
+History.rdoc
+Manifest.txt
+README.rdoc
+Rakefile
+bin/ha-gen
+lib/haddock.rb
+test/names.txt
+test/test_haddock.rb

data/README.rdoc

@@ -0,0 +1,84 @@
+= haddock
+
+http://github.com/stephencelis/haddock
+
+
+== DESCRIPTION
+
+A more memorable password generator. Swordfish? No, I got tired of that. I
+changed it.
+
+
+== FEATURES/PROBLEMS
+
+* Secure!
+
+
+== SYNOPSIS
+
+In your apps:
+
+  require "rubygems"
+  require "haddock"
+  include Haddock
+  Password.generate     # => "bowl9&bracky"
+  Password.generate(30) # => "Phlebotomus2473?nonconditioned"
+  Password.generate(8)  # => "amy7@rax"
+
+
+On the command line:
+
+  % ha-gen
+  bowl9&bracky
+  % ha-gen -l31
+  symbolistically5<overthwartways
+
+
+For more information:
+
+http://stephencelis.com/2009/03/29/whats-the-password-haddock.html
+
+
+== REQUIREMENTS
+
+A newline-delimited words file. By default, it uses "/usr/share/dict/words" or
+"/usr/share/words".
+
+Otherwise:
+
+  Haddock::Password.diction = "/path/to/words"
+
+
+Or:
+
+  % ha-gen -f /path/to/words
+
+
+== INSTALL
+
+  % [sudo] gem install haddock
+
+
+== LICENSE
+
+(The MIT License)
+
+(c) 2009-2010 Stephen Celis, stephen@stephencelis.com.
+
+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/Rakefile

@@ -0,0 +1,17 @@
+$: << File.dirname(__FILE__) + "/lib"
+require "rubygems"
+require "haddock"
+
+require "rake/testtask"
+require 'bundler/gem_tasks'
+
+desc "Default: run unit tests."
+task :default => :test
+
+desc "Run unit tests."
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/test_*.rb'
+  t.verbose = true
+end

data/bin/ha-gen

@@ -0,0 +1,47 @@
+#!/usr/bin/env ruby
+
+$: << File.dirname(__FILE__) + "/../lib"
+require "optparse"
+require "haddock"
+include Haddock
+
+OptionParser.new do |opts|
+  opts.banner = "usage: #{File.basename($0)} [options]"
+
+  opts.on("-V", "--version") do
+    puts "#{File.basename($0)}: v#{Haddock::VERSION}"
+    exit
+  end
+
+  opts.on("-h", "--help") do
+    puts opts
+    exit
+  end
+
+  opts.on("-l", "--length [length]", Integer) do |value|
+    @length = value
+  end
+
+  opts.on("-f", "--words [words file]") do |value|
+    Password.diction = value
+  end
+
+  opts.on("-d", "--delimiters [symbols]") do |value|
+    Password.delimiters = value
+  end
+
+  begin
+    opts.parse!
+    puts @length ? Password.generate(@length) : Password.generate
+  rescue OptionParser::ParseError, Password::LengthError => error
+    warn "#{File.basename($0)}: #{error.message} " +
+      "(must be between #{Password::MINIMUM} and #{Password::MAXIMUM})."
+    puts opts
+    abort
+  rescue Password::NoWordsError => error
+    warn "#{File.basename($0)}: #{error.message}."
+    puts "Word lists are available here: http://wordlist.sourceforge.net"
+    puts opts
+    abort
+  end
+end

data/lib/haddock.rb

@@ -0,0 +1,129 @@
+# A more memorable password generator. Swordfish? No, I got tired of that. I
+# changed it.
+module Haddock
+  VERSION = '0.2.3'
+
+  module Password
+    # The minimum password legnth.
+    MINIMUM = 8
+
+    # The maximum password length.
+    MAXIMUM = 31
+
+    # The default password length.
+    DEFAULT = 12
+
+    # Paths used to detect default words files.
+    PATHS = %w(/usr/share/dict/words /usr/share/words)
+
+    #TODO: move these out to file.txt and expand
+    ADJECTIVES = %w(reflective happy hungry light breathing handsome purple careful gifted mushy powerful mysterious itchy eager crooked immense loud hissing massive freezing heavy foolish internal ruthless)
+    ANIMALS = %w(badger horse squirrel cats beaver armadillo camel dingo fish hamster chipmunk crocodile cougar hedgehog pony shrew puma pocrupine platypus mustang sheep mongoose rabbit fox sloth stallion)
+
+
+    @@delimiters = '`~!@#$%^&*()-_=+[{]}\\|;:\'",<.>/?'
+
+    class << self
+      # Generates a more memorable password. Its one optional argument
+      # determines the length of the generated password, and cannot be less
+      # than 8 or greater than 31 characters (default: 12). Allows simplification
+      # with options
+      #
+      #   Password.generate     # => "bowl9&bracky"
+      #   Password.generate(30) # => "Phlebotomus2473?nonconditioned"
+      #   Password.generate(8)  # => "amy7@rax"
+      #   Password.generate(8, {:use_delimeter=>false} => "bonk5and"
+      #   Password.generate(8, {:use_numbers=>false} => "jack!man"
+
+      def generate(length = DEFAULT, options = {})
+        unless defined? @@diction or options[:animal]
+	  self.diction = PATHS.find { |path| File.exist? path }
+        end
+	options = {
+	  :use_delimeter=>true, 
+	  :use_number=>true,
+	  :animal => false,
+	  :variable_length=>false
+        }.merge(options)
+	if length && length.to_s.upcase == "ANY"
+	  length = rand(DEFAULT)+DEFAULT 
+	  options[:variable_length] = true
+	end
+
+        raise LengthError, "Invalid length" unless length.is_a? Integer
+        raise LengthError, "Password length is too short" if length < MINIMUM
+        raise LengthError, "Password length is too long" if length > MAXIMUM
+
+        words_limit = length * 0.75 # Ensure over-proportionate word lengths.
+
+        begin
+	  if options[:animal]
+            words = %W(#{random_adj} #{random_animal})
+	  else
+            words = %W(#{random_word} #{random_delimiter if options[:use_delimeter]}#{random_word})
+          end
+	  words_length = words.join.length
+	  return words.join if (words_length == length && !options[:use_number]) || options[:variable_length]
+        end until words_length < length && words_length > words_limit && options[:use_number]
+        
+	words.join random_number(length - words_length) if options[:use_number]
+      end
+
+      def generate_fun
+	generate("any", {:use_delimeter=>false, :use_number=>false, :animal=>true})
+      end
+
+      # Sets the dictionary. Uses "/usr/share/dict/words" or
+      # "/usr/share/words" otherwise.
+      #
+      #   Password.diction = File.expand_path(__FILE__) + "/my_words.txt"
+      def diction=(path)
+        @@diction = IO.readlines path
+      rescue TypeError
+        raise NoWordsError, "No words file found"
+      rescue Errno::ENOENT
+        raise NoWordsError, "No words file at #{path.inspect}"
+      end
+
+      # Sets the list of characters that can delimit words. Default:
+      #
+      #   `~!@#$%^&*()-_=+[{]}\|;:'",<.>/?
+      def delimiters=(string)
+        @@delimiters = string
+      end
+
+      private
+      def random_adj
+	ADJECTIVES[rand(ADJECTIVES.length)]
+      end
+
+      def random_animal
+	ANIMALS[rand(ANIMALS.length)].capitalize
+      end
+      
+      def random_word
+        @@diction[rand(@@diction.length)].chomp
+      end
+
+      def random_delimiter
+        @@delimiters[rand(@@delimiters.length), 1]
+      end
+
+      def random_number(digits)
+        begin
+          number = rand(10 ** digits).to_s
+        end until number.length == digits
+
+        number
+      end
+    end
+
+    # Raised if a password is generated with too few or too many characters.
+    class LengthError < ArgumentError
+    end
+
+    # Raised if no words file is found.
+    class NoWordsError < StandardError
+    end
+  end
+end

data/test/names.txt

@@ -0,0 +1,2 @@
+Mary
+sturgeon

data/test/test_haddock.rb

@@ -0,0 +1,89 @@
+require "test/unit"
+require "haddock"
+
+class TestHaddock < Test::Unit::TestCase
+  include Haddock
+
+  def test_generates_password
+    password = Password.generate
+    assert_instance_of String, password
+    assert_equal Password::DEFAULT, password.length
+  end
+
+  def test_password_format
+    symbols = Password.send :class_variable_get, :@@delimiters
+    symbols = "[#{Regexp.quote symbols}]"
+    pattern = /^[a-z]+[0-9]+#{symbols}{1}[a-z]+/i
+    assert_match(pattern, Password.generate)
+  end
+
+  def test_generates_variable_password
+    assert_equal Password.generate(18).length, 18
+  end
+
+  def test_accepts_alternate_wordlist
+    Password.diction = path = File.dirname(__FILE__) + "/names.txt"
+    pattern = Regexp.new File.read(path).split.join("|")
+    assert_match(pattern, Password.generate(14))
+  ensure
+    Password.diction = "/usr/share/dict/words"
+  end
+
+  def test_accepts_alternate_symbols_list
+    Password.delimiters = "X"
+    assert_equal "X", Password.send(:random_delimiter)
+  end
+
+  def test_fail_on_too_short
+    assert_raise Password::LengthError do
+      Password.generate(Password::MINIMUM - 1)
+    end
+  end
+
+  def test_fail_on_too_long
+    assert_raise Password::LengthError do
+      Password.generate(Password::MAXIMUM + 1)
+    end
+  end
+
+  def test_fail_on_invalid
+    assert_raise Password::LengthError do
+      Password.generate("invalid")
+    end
+  end
+
+  def test_fail_on_invalid_path
+    assert_raise Password::NoWordsError do
+      Password.diction = "invalid/path"
+    end
+  end
+
+  def test_fail_on_nil_path
+    assert_raise Password::NoWordsError do
+      Password.diction = nil
+    end
+  end
+
+  def test_allows_non_delimiters
+    Password.delimiters = "#"
+    password = Password.generate(10, {:use_delimeter=>false})
+    assert_no_match /\#/, password
+  end
+
+  def test_allows_non_numbers
+    password = Password.generate(10, {:use_number=>false})
+    assert_no_match /\d/, password
+  end 
+
+  def test_length_persists_without_numbers_or_delimeters
+    password = Password.generate(10, {:use_number=>false, :use_delimeter=>false})
+    assert_equal 10, password.length
+  end
+
+  def test_can_generate_fun
+    password = Password.generate_fun
+    assert_instance_of String, password
+  end
+
+
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: perch
+version: !ruby/object:Gem::Version
+  version: 0.2.3
+  prerelease: 
+platform: ruby
+authors:
+- Stephen Celis, Paul Brennan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-08-11 00:00:00.000000000Z
+dependencies: []
+description: A more memorable password generator. Swordfish? No, I got tired of that.
+  I changed it.
+email: stephen@stephencelis.com
+executables:
+- ha-gen
+extensions: []
+extra_rdoc_files:
+- History.rdoc
+- Manifest.txt
+- README.rdoc
+files:
+- .autotest
+- History.rdoc
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- bin/ha-gen
+- lib/haddock.rb
+- test/names.txt
+- test/test_haddock.rb
+homepage: http://github.com/yule/haddock
+licenses: []
+post_install_message: 
+rdoc_options:
+- --main
+- README.rdoc
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: haddock
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: A more memorable password generator, based on haddock
+test_files:
+- test/test_haddock.rb