haddock 0.2.0

data/History.txt

@@ -0,0 +1,28 @@
+=== 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,8 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/ha-gen
+lib/haddock.rb
+test/names.txt
+test/test_haddock.rb

data/README.txt

@@ -0,0 +1,81 @@
+= 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
+
+
+== 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
+
+GitHub:
+
+  % gem install stephencelis-haddock --source=http://gems.github.com
+
+
+== LICENSE
+
+(The MIT License)
+
+(c) 2009-* 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,9 @@
+$: << File.dirname(__FILE__) + "/lib"
+require "rubygems"
+require "hoe"
+require "haddock"
+
+Hoe.new('haddock', Haddock::VERSION) do |p|
+  p.developer('Stephen Celis', 'stephen@stephencelis.com')
+  p.remote_rdoc_dir = ''
+end

data/bin/ha-gen

@@ -0,0 +1,45 @@
+#!/usr/bin/env ruby
+
+$: << File.dirname(__FILE__) + "/../lib"
+require "optparse"
+require "haddock"
+include Haddock
+
+parser = OptionParser.new do |opts|
+  opts.banner = "usage: #{File.basename($0)} [options]"
+
+  opts.on("-V", "--version") do
+    require 'capistrano/version'
+    puts "#{File.basename($0)}: v#{Haddock::VERSION}"
+    exit
+  end
+
+  opts.on("-h", "--help") do
+    puts opts
+    exit
+  end
+
+  opts.on("-l", "--length [length]") do |value|
+    raise Password::LengthError, "Invalid length" if value.match(/\D/)
+    @length = value.to_i
+  end
+
+  opts.on("-f", "--words [words file]") do |value|
+    Password.diction = value
+  end
+end
+
+begin
+  parser.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 parser
+  exit 1
+rescue Password::NoWordsError => error
+  warn "#{File.basename($0)}: #{error.message}."
+  puts "Word lists are available here: http://wordlist.sourceforge.net"
+  puts parser
+  exit 1
+end

data/lib/haddock.rb

@@ -0,0 +1,81 @@
+# A more memorable password generator. Swordfish? No, I got tired of that. I
+# changed it.
+module Haddock
+  VERSION = '0.2.0'
+
+  module Password
+    MINIMUM = 8
+    MAXIMUM = 31
+    DEFAULT = 12
+
+    SYMBOLS = '`~!@#$%^&*()-_=+[{]}\\|;:\'",<.>/?'
+
+    class << self
+      @@paths = %w(/usr/share/dict/words /usr/share/words)
+
+      # 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).
+      #
+      #   Password.generate     # => "bowl9&bracky"
+      #   Password.generate(30) # => "Phlebotomus2473?nonconditioned"
+      #   Password.generate(8)  # => "amy7@rax"
+      def generate(length = DEFAULT)
+        unless defined? @@diction
+          self.diction = @@paths.find { |path| File.exist? path }
+        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
+          words = %W(#{random_word} #{random_symbol}#{random_word})
+          words_length = words.to_s.length
+        end until words_length < length && words_length > words_limit
+
+        words.join random_number(length - words_length)
+      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
+
+      private
+
+      def random_word
+        @@diction[rand(@@diction.length)].chomp
+      end
+
+      def random_symbol
+        SYMBOLS[rand(SYMBOLS.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,60 @@
+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 = "[#{Regexp.quote Password::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_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
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: haddock
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- Stephen Celis
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-01 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.11.0
+    version: 
+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.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- bin/ha-gen
+- lib/haddock.rb
+- test/names.txt
+- test/test_haddock.rb
+has_rdoc: true
+homepage: http://github.com/stephencelis/haddock
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+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: haddock
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: A more memorable password generator
+test_files: 
+- test/test_haddock.rb