pwfoo 0.1.0 → 0.1.1

data/Manifest

@@ -10,7 +10,6 @@ lib/pwfoo/generate_password.rb
 lib/pwfoo/password_score_calculator.rb
 lib/pwfoo/password_strength.rb
 lib/pwfoo/srand_seed_generator.rb
-pwfoo.gemspec
 spec/pwfoo/generates_password_spec.rb
 spec/pwfoo/password_score_calculator_spec.rb
 spec/pwfoo/random_seed_generator_spec.rb

data/README.rdoc

@@ -1,3 +1,23 @@
 = pwfoo
 
-== INSTALL
+pwfoo is a gem that provides random password generation, password strength calculation, and a random seed generator.
+
+== Examples
+Generate password of length *12* with lower case, upper case, numbers, and special characters with a minimum strength score of *80*:
+
+	require 'generate_password'
+	generate_password = PwFoo::GeneratePassword.new(12, PwFoo::GeneratePassword.LOWER_CASE, PwFoo::GeneratePassword.UPPER_CASE, PwFoo::GeneratePassword.NUMBERS, PwFoo::GeneratePassword.SPECIALS )
+	my_new_password = generate_password.generate_with_min_strength 80
+	
+Determine the strength of your password:
+	require 'password_strength'
+	my_pw = 'secret'
+	my_pw_score = PwFoo::PasswordStrength.new.calculate_score(my_pw)
+
+== INSTALL
+  $ sudo gem install gemcutter
+  $ gem tumble
+  $ sudo gem install pwfoo
+or add the following to your <b>environment.rb</b>
+	config.gem 'pwfoo'
+

data/Rakefile

@@ -1,8 +1,13 @@
 require 'rubygems'
 require 'rake'
 require 'echoe'
+require 'spec'
+require 'cucumber'
 
-Echoe.new("pwfoo", "0.1.0") do |p|
+require 'cucumber/rake/task'
+require 'spec/rake/spectask'
+
+Echoe.new("pwfoo", "0.1.1") do |p|
   p.author = "Perry Hertler"
   p.summary = "A gem that generates strong random passwords, scores the strength of passwords, and generates random seeds."
   p.url = "http://github.com/perry3819/pwfoo"
@@ -11,4 +16,20 @@ Echoe.new("pwfoo", "0.1.0") do |p|
   p.development_dependencies = []
 end
 
-Dir["#File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }
+Dir["#File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }
+
+
+
+spec_files = Rake::FileList["spec/**/*_spec.rb"]
+ 
+desc "Run specs"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = spec_files
+  t.spec_opts = ["-c"]
+end
+ 
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = "features --format progress"
+end
+ 
+task :default => [:spec, :features]

data/lib/pwfoo.rb

@@ -1,4 +1,4 @@
 require 'pwfoo/password_strength'
 require 'pwfoo/password_score_calculator'
 require 'pwfoo/generate_password'
-require 'pwfoo/srand_seed_generator'
+require 'pwfoo/srand_seed_generator'

data/lib/pwfoo/generate_password.rb

@@ -1,3 +1,14 @@
+# = generate_password.rb - Random Password Generator
+#
+# Perry Hertler mailto:perry@hertler.org
+#
+# == Example
+#
+# Generate password of length *12* with lower case, upper case, numbers, and special characters with a minimum strength score of *80*.
+#
+# require 'generate_password'
+# generate_password = PwFoo::GeneratePassword.new(12, PwFoo::GeneratePassword.LOWER_CASE, PwFoo::GeneratePassword.UPPER_CASE, PwFoo::GeneratePassword.NUMBERS, PwFoo::GeneratePassword.SPECIALS )
+# my_new_password = generate_password.generate_with_min_strength 80
 module PwFoo
   class GeneratePassword
     LOWER_CASE = 'lower_case'
@@ -14,7 +25,7 @@ module PwFoo
 
     def initialize(length = 10, *allowed_types)
       @length = length
-      @allowed_types = allowed_types == nil || 0 == allowed_types.length ? [LOWER_CASE, UPPER_CASE, NUMBERS] : allowed_types
+      @allowed_types = allowed_types.nil? || 0 == allowed_types.length ? [LOWER_CASE, UPPER_CASE, NUMBERS] : allowed_types
       @pw_strength_finder = PasswordStrength.new
       srand(SrandSeedGenerator.new().get_next_seed)
     end

data/lib/pwfoo/password_score_calculator.rb

@@ -1,3 +1,8 @@
+# = password_score_calculator.rb - Calculates various password strength scores.
+# This class will usually never be used directly. Instead use *PasswordStrength*.
+#
+# Perry Hertler mailto:perry@hertler.org
+#
 module PwFoo
   class PasswordScoreCalculator
     SYMBOLS_REGEX = /[^a-zA-Z0-9_]/

data/lib/pwfoo/password_strength.rb

@@ -1,3 +1,16 @@
+# = password_strength.rb - Password Strength Finder
+#
+# Perry Hertler mailto:perry@hertler.org
+#
+# == Example
+#
+# Given a password, *PasswordStrength* will calculate a strength score.
+#
+# *0* is the lowest score and *100* is the highest score.
+#
+# require 'password_strength'
+# my_pw = 'secret'
+# my_pw_score = PwFoo::PasswordStrength.new.calculate_score(my_pw)
 module PwFoo
   class PasswordStrength
     def initialize

data/lib/pwfoo/srand_seed_generator.rb

@@ -1,6 +1,13 @@
+# = srand_seed_generator.rb - Random seed generator uses the system time and currently running processes to generate a highly random seed.
+#
+# Perry Hertler mailto:perry@hertler.org
+#
+# == Example
+#
+# my_seed = PwFoo::SrandSeedGenerator.new.get_next_seed
 module PwFoo
   require 'digest/md5'
-  
+
   class SrandSeedGenerator
     def initialize
     end

data/pwfoo.gemspec

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{pwfoo}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Perry Hertler"]
-  s.date = %q{2009-11-10}
+  s.date = %q{2009-11-17}
   s.description = %q{A gem that generates strong random passwords, scores the strength of passwords, and generates random seeds.}
   s.email = %q{perry@hertler.org}
   s.extra_rdoc_files = ["README.rdoc", "lib/pwfoo.rb", "lib/pwfoo/generate_password.rb", "lib/pwfoo/password_score_calculator.rb", "lib/pwfoo/password_strength.rb", "lib/pwfoo/srand_seed_generator.rb"]
-  s.files = ["Manifest", "README.rdoc", "Rakefile", "features/pwfoo_calculate_password_strength.feature", "features/pwfoo_generate_random_password.feature", "features/step_definitions/password_steps.rb", "features/support/env.rb", "lib/pwfoo.rb", "lib/pwfoo/generate_password.rb", "lib/pwfoo/password_score_calculator.rb", "lib/pwfoo/password_strength.rb", "lib/pwfoo/srand_seed_generator.rb", "pwfoo.gemspec", "spec/pwfoo/generates_password_spec.rb", "spec/pwfoo/password_score_calculator_spec.rb", "spec/pwfoo/random_seed_generator_spec.rb", "spec/spec_helper.rb"]
+  s.files = ["Manifest", "README.rdoc", "Rakefile", "features/pwfoo_calculate_password_strength.feature", "features/pwfoo_generate_random_password.feature", "features/step_definitions/password_steps.rb", "features/support/env.rb", "lib/pwfoo.rb", "lib/pwfoo/generate_password.rb", "lib/pwfoo/password_score_calculator.rb", "lib/pwfoo/password_strength.rb", "lib/pwfoo/srand_seed_generator.rb", "spec/pwfoo/generates_password_spec.rb", "spec/pwfoo/password_score_calculator_spec.rb", "spec/pwfoo/random_seed_generator_spec.rb", "spec/spec_helper.rb", "pwfoo.gemspec"]
   s.homepage = %q{http://github.com/perry3819/pwfoo}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Pwfoo", "--main", "README.rdoc"]
   s.require_paths = ["lib"]

data/spec/pwfoo/generates_password_spec.rb

@@ -2,7 +2,6 @@ require File.join(File.dirname(__FILE__), "..", "spec_helper")
 
 module PwFoo
   describe GeneratePassword do
-    include GeneratePasswordHelper
 
     before(:all) do
       Spec::Matchers.define :be_greater_than_or_equal do |min_score|

data/spec/spec_helper.rb

@@ -1,3 +1,3 @@
 $LOAD_PATH << File.join(File.dirname(__FILE__),"..","lib")
 require 'spec'
-require 'pwfoo'
+require 'pwfoo'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: pwfoo
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Perry Hertler
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-10 00:00:00 -06:00
+date: 2009-11-17 00:00:00 -06:00
 default_executable: 
 dependencies: []
 
@@ -39,11 +39,11 @@ files:
 - lib/pwfoo/password_score_calculator.rb
 - lib/pwfoo/password_strength.rb
 - lib/pwfoo/srand_seed_generator.rb
-- pwfoo.gemspec
 - spec/pwfoo/generates_password_spec.rb
 - spec/pwfoo/password_score_calculator_spec.rb
 - spec/pwfoo/random_seed_generator_spec.rb
 - spec/spec_helper.rb
+- pwfoo.gemspec
 has_rdoc: true
 homepage: http://github.com/perry3819/pwfoo
 licenses: []