altpass 0.1.0 → 0.2.0

data/README.md

@@ -106,6 +106,7 @@ Options
 -------
 
     Usage: altpass.rb [options]
+        -c                               Create default configuration file /Users/abatko/.altpass.yaml
         -l, --length [INTEGER>0]         Password length
         -m, --memorizable [true|false]   Use the memorizable pattern or not
         -p, --permutations [vvv]         Show permutation size; verbosity increases with v's
@@ -166,6 +167,71 @@ These examples assume the above mentioned *Configuration* section is in effect.
     31,752,000 permutations
     --length 8 --memorizable true
 
+### Create a configuration file
+
+Use the convenience of the `-c` switch to create a default configuration file:
+
+    $ altpass.rb -c
+    Created configuration file /Users/abatko/.altpass.yaml
+
+    $ altpass.rb 
+    yZH3jw9r
+
+Note that once a configuration file exists, the `-c` option changes to *show* its content:
+
+    $ altpass.rb -h
+    Usage: altpass.rb [options]
+        -c                               Show default configuration file /Users/abatko/.altpass.yaml
+        ...                              ...
+        ...                              ...
+        ...                              ...
+
+    $ altpass.rb -c
+    Your altpass configuration file is /Users/abatko/.altpass.yaml
+    :length: 8
+    :memorizable: true
+    :permutations: false
+    :switches: false
+
+Let's remove the configuration file, and create another one with custom settings:
+
+    $ rm ~/.altpass.yaml
+    remove /Users/abatko/.altpass.yaml? y
+
+    $ altpass.rb -c -l20 -mf
+    Created configuration file /Users/abatko/.altpass.yaml
+
+    $ altpass.rb -c 
+    Your altpass configuration file is /Users/abatko/.altpass.yaml
+    :length: 20
+    :memorizable: false
+    :permutations: false
+    :switches: false
+
+    $ altpass.rb 
+    mgYzNWjdy2JEMZ9emDy5
+
+### Recommended configuration and usage
+
+If you create accounts frequently, and like to have unique passwords that are
+as long as the service you are signing up for allows, then consider this
+default: length 20, non-memoriable.
+
+Create your configuration file as follows:
+
+    $ altpass.rb -c -l20 -mf
+
+and simply override it at the command-line on a per-need basis (for instance,
+when the service has a shorter maximum):
+
+    $ altpass.rb -l16
+
+Note that some services don't specify a maximum, yet they actually have one. In
+such cases, you may create your account with a password that will ultimately not
+let you log in, and you will have to use their "forgot/reset password" feature
+(consider also contacting that service and asking them to post the password
+length limit on their sign-up page).
+
 Contributing
 ============
 

data/bin/altpass.rb

@@ -20,6 +20,10 @@ options = options.merge(yaml_defaults) unless yaml_defaults.nil?
 OptionParser.new do |opts|
 	opts.banner = 'Usage: altpass.rb [options]'
 
+	opts.on('-c', "#{File.exist?(CONFIGURATION_FILE) ? 'Show' : 'Create'} default configuration file #{CONFIGURATION_FILE}") do |l|
+		options[:createconfig] = true
+	end
+
 	opts.on('-l', '--length [INTEGER>0]', OptionParser::DecimalInteger, 'Password length') do |l|
 		unless l > 0
 			puts 'argument to -l must be > 0'
@@ -63,6 +67,32 @@ def show_permutations(options)
 	puts permutations.to_s.reverse.scan(/(?:\d*\.)?\d{1,3}-?/).join(',').reverse + ' permutations'
 end
 
+if options[:createconfig]
+	if File.exist?(CONFIGURATION_FILE)
+			puts "Your altpass configuration file is #{CONFIGURATION_FILE}"
+			if File.readable?(CONFIGURATION_FILE)
+				puts File.read(CONFIGURATION_FILE)
+			else
+				puts 'But it is NOT readable!'
+			end
+	else
+		File.open(CONFIGURATION_FILE, 'w') { |f|
+			f.write(
+				":length: #{options[:length]}\n" +
+				":memorizable: #{options[:memorizable]}\n" +
+				":permutations: #{options[:permutations]}\n" +
+				":switches: #{options[:switches]}\n"
+			)
+		}
+		if File.exist?(CONFIGURATION_FILE)
+			puts "Created configuration file #{CONFIGURATION_FILE}"
+		else
+			puts 'Something went wrong; configuration file NOT created!'
+		end
+	end
+	exit
+end
+
 puts Altpass.generate(:length => options[:length], :memorizable => options[:memorizable])
 
 show_permutations(options) if options[:permutations]

data/lib/altpass/version.rb

@@ -1,4 +1,4 @@
 module Altpass
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: altpass
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-14 00:00:00.000000000Z
+date: 2013-01-09 00:00:00.000000000Z
 dependencies: []
 description: Generate passwords derived from hand-alternating, visually unambiguous,
   alphanumeric characters. This is a Ruby gem and command-line utility. Formerly known