cryptice-passgen 0.1.1 → 0.1.2

data/README.rdoc

@@ -12,6 +12,7 @@ non-Rails applications as well.
 
 The usage could not be easier. Just require and call the generate method:
 
+  >> require 'rubygems'
   >> require 'passgen'
   >> Passgen::generate
   => "zLWCeS3xC9"

data/Rakefile

@@ -3,7 +3,7 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('passgen', '0.1.1') do |p|
+Echoe.new('passgen', '0.1.2') do |p|
   p.description    = "A password generation gem for Ruby and Rails applications."
   p.url            = "http://github.com/cryptice/passgen"
   p.author         = "Erik Lindblad"

data/lib/passgen.rb

@@ -1,3 +1,126 @@
+#= Passgen
+#
+#Ruby gem for generating passwords quickly and easily. Although it is
+#suitable for use within Rails it has no Rails dependencies and can be used in
+#non-Rails applications as well.
+#
+#== Install
+#
+#  gem install cryptice-passgen --source http://gems.github.com
+#
+#== Usage
+#
+#The usage could not be easier. Just require and call the generate method:
+#
+#  >> require 'rubygems'
+#  >> require 'passgen'
+#  >> Passgen::generate
+#  => "zLWCeS3xC9"
+#
+#== Examples
+#
+#  >> Passgen::generate
+#  => "zLWCeS3xC9"
+#
+#  >> Passgen::generate(:length => 20)
+#  => "6lCcHvkuEW6OuzAtkoAs"
+#
+#  >> Passgen::generate(:symbols => true)
+#  => "gr)$6bIym1"
+#
+#  >> Passgen::generate(:lowercase => :only)
+#  => "ysbwuxbcea"
+#
+#  >> Passgen::generate(:number => 3)
+#  => ["REdOigTkdI", "PQu8DsV9WZ", "qptKLbw8YQ"]
+#
+#  >> Passgen::generate(:seed => 5)
+#  => "JoV9M2qjiK"
+#  >> Passgen::generate(:seed => 5) # Will generate same password again
+#  => "JoV9M2qjiK"
+#
+#  >> Passgen::generate(:seed => :default) # Will set random seed...
+#  => "SI8QDBdV98"
+#  >> Passgen::generate(:seed => :default) # and hence give different password
+#  => "tHHU5HLBAn"
+#
+#== Options:
+#
+#=== :lowercase => true/false/:only
+#* true - Use lowercase letters in the generated password.
+#* false - Do not use lowercase letters in the generated password.
+#* :only - Only use lowercase letters in the generated password.
+#
+#=== :uppercase => true/false/:only
+#* true - Use uppercase letters in the generated password.
+#* false - Do not use uppercase letters in the generated password.
+#* :only - Only use uppercase letters in the generated password.
+#
+#=== :digits => true/false/:only
+#* true - Use digits in the generated password.
+#* false - Do not use digits in the generated password.
+#* :only - Only use digits in the generated password.
+#
+#=== :symbols => true/false/:only/:list
+#* true - Use symbols in the generated password.
+#* false - Do not use symbols in the generated password.
+#* :only - Only use symbols in the generated password.
+#* :list - A string with the symbols to use. Not implemented yet.
+#
+#=== :pronounceable => true/false
+#Not implmented yet.
+#
+#=== :number => integer
+#Number of passwords to generate. If >1 the result is an Array.
+#
+#=== :length => integer/range
+#The number of characters in the generated passwords. A range results in passwords
+#lengths within the given range.
+#
+#=== :seed => integer/:default
+#Set the srand seed to the given integer prior to generating the passwords.
+#
+#=== Default values:
+#
+#:lowercase => true
+#
+#:uppercase => true
+#
+#:digits => true
+#
+#:symbols => false
+#
+#:pronounceable => Not implemented yet.
+#
+#:number => 1
+#
+#:length => 10
+#
+#:seed => nil
+#
+#== Copyright and license
+#
+#Copyright (c) 2009 Erik Lindblad
+#
+#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.
+
 require "digest"
 
 module Passgen
@@ -11,6 +134,10 @@ module Passgen
     :symbols => false
   }
 
+  def self.default_seed
+    Digest::MD5.hexdigest("#{rand}#{Time.now}#{Process.object_id}").to_i(16)
+  end
+
   def self.generate(params={})
     set_options(params)
     tokens = valid_tokens
@@ -23,20 +150,11 @@ module Passgen
     end
   end
 
+  private
   def self.generate_one(tokens)
     Array.new(password_length) {tokens[rand(tokens.size)]}.join
   end
 
-  def self.set_seed
-    if @options[:seed]
-      if @options[:seed] == :default
-        srand(Digest::MD5.hexdigest("#{rand}#{Time.now}#{Process.object_id}").to_i(16))
-      else
-        srand(@options[:seed])
-      end
-    end
-  end
-
   def self.password_length
     if @options[:length].is_a?(Range)
       tmp = @options[:length].to_a
@@ -76,12 +194,54 @@ module Passgen
     @options = DEFAULT_PARAMS.merge(params)
   end
 
+  def self.set_seed
+    if @options[:seed]
+      if @options[:seed] == :default
+        srand(default_seed)
+      else
+        srand(@options[:seed])
+      end
+    end
+  end
+
+  def self.lowercase_tokens
+    ("a".."z").to_a
+  end
+
+  def self.uppercase_tokens
+    ("A".."Z").to_a
+  end
+
+  def self.digit_tokens
+    ("0".."9").to_a
+  end
+
+  def self.symbol_tokens
+    %w{! @ # $ % & / ( ) + ? *}
+  end
+
+  def self.use_lowercase?
+    @options[:lowercase]
+  end
+
+  def self.use_uppercase?
+    @options[:uppercase]
+  end
+
+  def self.use_digits?
+    @options[:digits]
+  end
+
+  def self.use_symbols?
+    @options[:symbols]
+  end
+
   def self.valid_tokens
     tmp = []
-    tmp += ("a".."z").to_a if @options[:lowercase]
-    tmp += ("A".."Z").to_a if @options[:uppercase]
-    tmp += ("0".."9").to_a if @options[:digits]
-    tmp += %w{! @ # $ % & / ( ) + ? *} if @options[:symbols]
+    tmp += lowercase_tokens if use_lowercase?
+    tmp += uppercase_tokens if use_uppercase?
+    tmp += digit_tokens if use_digits?
+    tmp += symbol_tokens if use_symbols?
     tmp
   end
 end

data/passgen.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{passgen}
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Erik Lindblad"]

data/spec/passgen_spec.rb

@@ -92,5 +92,24 @@ describe "Using passgen" do
     pass2 = Passgen::generate(:seed => :default)
     pass1.should_not eql(pass2)
   end
-  
-end
+
+  describe "handling tokens" do
+
+    it "should return a-z" do
+      Passgen::lowercase_tokens.should eql(("a".."z").to_a)
+    end
+
+    it "should return A-Z" do
+      Passgen::uppercase_tokens.should eql(("A".."Z").to_a)
+    end
+
+    it "should return 0-9" do
+      Passgen::digit_tokens.should eql(("0".."9").to_a)
+    end
+
+    it "should return default symbols" do
+      Passgen::symbol_tokens.should eql(%w{! @ # $ % & / ( ) + ? *})
+    end
+
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: cryptice-passgen
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - Erik Lindblad