easy_passwords 0.1 → 0.2

data/README.md

@@ -8,13 +8,15 @@ easy_passwords.rb is a Ruby implementation of passwdqc's easy_passwords, a rando
 gem install easy_passwords
 ```
 
-```
-gem easy_passwords
+```ruby
+#Gemfile
+gem 'easy_passwords'
 ```
 
 ## Goals
 - Passwords are easily to read
 - You can setup max password length in characters(useful when sending password in sms message)
+- You can define separators list
 
 ## Usage
 
@@ -27,12 +29,18 @@ require 'easy_passwords'
 
 p EasyPassword.generate             # => "employ7Royal"
 p EasyPassword.generate 5           # => "Peach"
+p EasyPassword.generate 7, '|'      # => "cat|eat"
 p EasyPassword.generate 15          # => "soggy*Apart9Odd"
 p EasyPassword.generate 2           # => raise error, min length is 3
 
 gen = EasyPassword.new             # => #<EasyPasswords::Generator:0x9f6ec40 ...>
-p gen.generate               # => "employ7Royal"
-p gen.generate 15             # => "soggy*Apart9Odd"
+p gen.generate                     # => "employ7Royal"
+p gen.generate 15                  # => "soggy*Apart9Odd"
+
+
+my_gen = EasyPassword.new('|')  # => #<EasyPasswords::Generator:0x9f6ec40 ...>
+p my_gen.generate               # => "employ|Royal"
+p my_gen.generate 15            # => "soggy|Apart|Odd"
 ```
 
 ## Contributing
@@ -47,3 +55,6 @@ p gen.generate 15             # => "soggy*Apart9Odd"
 - Based on gem https://github.com/iphoting/pwqgen.rb
 - Original Design and C implementation from <http://www.openwall.com/passwdqc/> by Solar Designer.
 
+## Legal
+
+[Licensed under the MIT license](http://www.opensource.org/licenses/mit-license.php)

data/easy_passwords.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |s|
   s.name        = 'easy_passwords'
   s.version     = EasyPasswords::VERSION
   s.summary     = "Easy passwords generator in Ruby"
-  s.description = "Easy password is a Ruby implementation of passwdqc's easy_passwords, a random pronouncable password generator. Don't use it for serious projects :)"
+  s.description = "Easy password is a Ruby implementation of passwdqc's easy_passwords, a random pronouncable password generator. Probably don't use it in banks."
   s.authors     = ["Pete"]
   s.email       = 'piotr.bliszczyk@gmail.com'
   s.homepage    = 'https://github.com/piotrze/easy_passwords'

data/lib/easy_passwords/easy_passwords.rb

@@ -7,10 +7,10 @@ require 'securerandom'
 # Examples
 #
 #   EasyPasswords.generate
-#   # => "merger*Hick$"
+#   # => "merger4Hick_"
 #
 #   EasyPasswords.new.generate
-#   # => "employ7Royal"
+#   # => "employ-Royal"
 #
 # 	EasyPasswords::Generator.new.generate
 # 	# => "Beige7Jacob2"
@@ -23,22 +23,27 @@ module EasyPasswords
   DEFAULT_MAX_LENGTH = 12
   MIN_WORD_LENGTH = 3
   MAX_WORD_LENGTH = 6
+  SEPARATORS = "-_123456789"
 
   # Public: Returns a random generated password string.
   #
   # max_length - max number of characters used in password, it could generate password shorter by 3 characters.
+  # separators - list of separators as a String
   #
   # Example
   #
   # 	generate 8
-  # 	# => "Fun=Crop"
+  # 	# => "Fun-Crop"
+  #
+  # 	generate 8, '01'
+  # 	# => "Fun0Crop"
   #
   # 	generate
   # 	# => "spate7Coup"
   #
   # Returns a password string.
-	def self.generate(max_length = DEFAULT_MAX_LENGTH)
-		self::Generator.new.generate max_length
+	def self.generate(max_length = DEFAULT_MAX_LENGTH, separators = SEPARATORS)
+		self::Generator.new(separators).generate max_length
 	end
 
 	def self.new
@@ -46,9 +51,9 @@ module EasyPasswords
 	end
 
 	class Generator
-		def initialize
+		def initialize(separators = EasyPasswords::SEPARATORS)
 			@@wordlist_size = @@wordlist.length
-			@@separators = "-_!$&*+=23456789".split(//)
+			@@separators = separators
 			@@separators_size = @@separators.length
 			@rand = SecureRandom
 		end
@@ -60,7 +65,7 @@ module EasyPasswords
 		# Example
 		# 
 		# 	generate 8
-		# 	# => "Fun=Crop"
+		# 	# => "Fun_Crop"
 		# 
 		# 	generate
 		# 	# => "spate7Coup"
@@ -94,9 +99,9 @@ module EasyPasswords
     def random_word(maxsize = EasyPasswords::MAX_WORD_LENGTH)
       list = if maxsize < EasyPasswords::MAX_WORD_LENGTH
         @@wordlist.select{|w| w.size <= maxsize }
-             else
+      else
         @@wordlist
-             end
+      end
       word = list[@rand.random_number(list.size)]
 			@rand.random_number(2) == 0 ? word.capitalize : word
     end

data/lib/easy_passwords/version.rb

@@ -1,3 +1,3 @@
 module EasyPasswords
-	VERSION = "0.1"
+	VERSION = "0.2"
 end

data/spec/lib/easy_passwords_spec.rb

@@ -3,12 +3,22 @@ require 'spec_helper'
 describe EasyPasswords do
 	it "should return a random password" do
 		password = EasyPasswords.generate
-    debugger
 		password.should_not be_nil
 		password.should_not be_empty
 		password.should be_kind_of(String)
 		password.length.should be_within(7).of(10)
-	end
+  end
+
+  it "should return a random password with custom separator" do
+    separator = '|'
+    password = EasyPasswords.generate 7, separator
+    password.should_not be_nil
+    password.should_not be_empty
+    password.should be_kind_of(String)
+    password.length.should be_within(7).of(7)
+    password.include?(separator)
+  end
+
 
 	it "should return a short random password when given a length of 5" do
 		password = EasyPasswords.generate 5
@@ -40,7 +50,18 @@ describe EasyPasswords::Generator do
 		password.should_not be_empty
 		password.should be_kind_of(String)
 		password.length.should be_within(5).of(15)
-	end
+  end
+
+
+  it "should return a password with custom separator" do
+    separator = '|'
+    password = EasyPasswords::Generator.new(separator).generate 7
+    password.should_not be_nil
+    password.should_not be_empty
+    password.should be_kind_of(String)
+    password.length.should be_within(7).of(7)
+    password.include?(separator)
+  end
 
 	it "should raise error when given a length of 1" do
 		expect {EasyPasswords::Generator.new.generate 1}.to raise_error

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: easy_passwords
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: '0.2'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-15 00:00:00.000000000 Z
+date: 2014-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -60,7 +60,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: Easy password is a Ruby implementation of passwdqc's easy_passwords,
-  a random pronouncable password generator. Don't use it for serious projects :)
+  a random pronouncable password generator. Probably don't use it in banks.
 email: piotr.bliszczyk@gmail.com
 executables: []
 extensions: []