xkpassword 0.2.1 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cfed3f08e36ae1aab210348dc428cae6c010c3f8
-  data.tar.gz: f4a354aafded3a56625438cf718e2f0b8ce95158
+  metadata.gz: f84da1ad0dfef6ea960bb3e03d167ede3b3a45b1
+  data.tar.gz: 838f02e3b6a4bb534c91bfe5fddee5168bf05d2a
 SHA512:
-  metadata.gz: dd3a65350baf83fe693c48d06d34e682f9ef3f323e3a5649f214c7df20a80f80e2915e33cf70ae3f8cc1f0252550f26ecf5e12dfdb2d366bab2635369976c0af
-  data.tar.gz: 66465600de579c1f7f91a7641c1d54a93ddd2284313a85c5a0779ef7fd2d5df897c2bdd7f0fb2b701ac698c08bbcd17b908d7a2713a523ff48e9b12d6f1f69f2
+  metadata.gz: 2fd8e2109dedce564cc2f5d254b4f9ac55da1b2aa2a385f6a2bfd1e2e349b5e75c191aab48e1f7bfb4da121c304087770d001eb68caf5f5832d30208f385ad25
+  data.tar.gz: 8976003191ea7e0caa2170bb334e535c91568c275b3d3cfa338d7be1353c52c0229194a2ebefb1bb8dc358c16be640f504ad9dcf40a2a0b897a73dec67ca0fc5

data/Gemfile

@@ -4,5 +4,6 @@ source 'https://rubygems.org'
 gemspec
 
 group :development do
+  gem 'yard'
   gem 'pry'
 end

data/README.md

@@ -22,7 +22,52 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+You can use this app stand-alone in the command line or include it in any of your Ruby
+applications.
+
+### Comamnd Line
+The commandline application accepts the same collection of configuration options as would
+the `XKPassword` module would. For more information use `xkpassword --help` to obtain a
+full list of options.
+
+```bash
+~# xkpassword
+~# xkpassword --help
+```
+
+### Ruby Apps
+
+```ruby
+require 'xkpassword/generator'
+
+options = {
+  max_length: 8,
+  min_length: 4,
+  separator: '-',
+  words: 4,
+}
+
+XKPassword.generate(options)
+```
+
+If you are generating multiple passwords at once, I recommend you use
+the following as then it will only load and parse the databse once.
+
+```ruby
+require 'xkpassword/generator'
+
+options = {
+  max_length: 8,
+  min_length: 4,
+  separator: '-',
+  words: 4,
+}
+  
+generator = XKPassword::Generator.new
+generator.generate(options)
+
+# 10.times { generator.generate(options) }
+```
 
 ## Development
 

data/bin/xkpassword

@@ -1,48 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'optparse'
-require 'artii'
-
-require 'bundler/setup'
-require 'xkpassword'
-
-artii = Artii::Base.new font: 'standard'
-message = """
-#{ artii.asciify('XKPassword') }
-by Ziyan Junaideen
-
-How many times have you changed your password just because you forgot it?
-Well, you are not alone. In todays security requirements, passwords need
-to be secure and difficult to break. Passwords need to be secure, sure,
-but they can also be easy to remember. Follow up this XKCD article for more
-information - http://xkcd.com/936/
-
-This does exactly what the picture predicts. You can use this in your Ruby 
-applications (Ex: Rails, Sinatra) or standalone if you install the gem (as 
-you have done here).
-
-Wish you all the best keeping things secure.
-
-Ziyan Junaideen
-ziyan@jdeen.com
-
-"""
-
-options = {}
-OptionParser.new do |opts|
-  opts.banner = "Usage: ./bin/xkpassword [options]"
-
-  opts.on('-v', '--version', 'Gem version') { options[:version] = true }
-  opts.on('-i', '--info', 'Gem info') { options[:info] = true }
-
-  opts.on('--words [INTEGER]', 'Number of wrods to be used in the generated password') { |words| options[:words] = words.to_i }
-  opts.on('--min-length [INTEGER]', 'Minimum length of a word') { |min| options[:min_length] = min.to_i }
-  opts.on('--max-length [INTEGER]', 'Maximum length of a word') { |max| options[:max_length] = max.to_i }
-  opts.on('--separator [STRING]', 'The separator to separate password') { |separator| options[:separator] = separator }
-end.parse!
-
-puts message if options[:info]
-puts XKPassword::VERSION if options[:version]
-puts XKPassword.generate(options) if !options[:info] && !options[:version]
-
-

data/exe/xkpassword

@@ -0,0 +1,48 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'artii'
+
+require 'bundler/setup'
+require 'xkpassword'
+
+artii = Artii::Base.new font: 'standard'
+message = """
+#{ artii.asciify('XKPassword') }
+by Ziyan Junaideen
+
+How many times have you changed your password just because you forgot it?
+Well, you are not alone. In todays security requirements, passwords need
+to be secure and difficult to break. Passwords need to be secure, sure,
+but they can also be easy to remember. Follow up this XKCD article for more
+information - http://xkcd.com/936/
+
+This does exactly what the picture predicts. You can use this in your Ruby 
+applications (Ex: Rails, Sinatra) or standalone if you install the gem (as 
+you have done here).
+
+Wish you all the best keeping things secure.
+
+Ziyan Junaideen
+ziyan@jdeen.com
+
+"""
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = "Usage: ./exe/xkpassword [options]"
+
+  opts.on('-v', '--version', 'Gem version') { options[:version] = true }
+  opts.on('-i', '--info', 'Gem info') { options[:info] = true }
+
+  opts.on('--words [INTEGER]', 'Number of wrods to be used in the generated password') { |words| options[:words] = words.to_i }
+  opts.on('--min-length [INTEGER]', 'Minimum length of a word') { |min| options[:min_length] = min.to_i }
+  opts.on('--max-length [INTEGER]', 'Maximum length of a word') { |max| options[:max_length] = max.to_i }
+  opts.on('--separator [STRING]', 'The separator to separate password') { |separator| options[:separator] = separator }
+end.parse!
+
+puts message if options[:info]
+puts XKPassword::VERSION if options[:version]
+puts XKPassword.generate(options) if !options[:info] && !options[:version]
+
+

data/lib/xkpassword.rb

@@ -1,8 +1,22 @@
 module XKPassword
+
+  # Generates a random password by intializing a `XKPassword::Generator` instance.
+  # This accepts argumennts identcal to the above class.
+  #
+  # If you are to generate multiple passwords (batch process lets say), you might as well directly
+  # use the `XKPassword::Generator` class as it will be faster since it will only need to load
+  # the dictionary once.
+  #
+  # @param [Hash] options The options to populate a generator
+  # @option options [Integer] :words      The number of words to include in the generated password
+  # @option options [String]  :separator  The separator symbol to use joining words used in password
+  # @option options [Integer] :min_length The minimum length of a word to be used in the process
+  # @option options [Integer] :max_length The maximum length of a word to be used in the process
   def self.generate(options = nil)
     generator = XKPassword::Generator.new
     generator.generate(options)
   end
+
 end
 
 require 'xkpassword/version'

data/lib/xkpassword/generator.rb

@@ -1,5 +1,9 @@
 require 'xkpassword/words'
 
+# The Generator class which finds words based on the requirement and using the provided options to build a
+# new random passowrd.
+# 
+# @attr_reader [XKPassword::Words] words  A word database that gen provide you words for the length required
 class XKPassword::Generator
   DEFAULTS = {
     max_length: 8,
@@ -14,15 +18,26 @@ class XKPassword::Generator
     @words = XKPassword::Words.new
   end
 
-  # options = {
-  #   separator: ' ',
-  #   words: 4,
-  #   min_length: 4,
-  #   max_length: 8
-  # }
+  # Generates a password absed on the configuration provided.
   #
-  # generator = XKPassword::Generator.new
-  # generator.generate(options)
+  # @param [Hash] options The options to populate a generator
+  # @option options [Integer] :words      The number of words to include in the generated password
+  # @option options [String]  :separator  The separator symbol to use joining words used in password
+  # @option options [Integer] :min_length The minimum length of a word to be used in the process
+  # @option options [Integer] :max_length The maximum length of a word to be used in the process
+  #
+  # @return [String]                      The generated password
+  #
+  # @example Populating the method with all options (current default)
+  #   options = {
+  #     separator: ' ',
+  #     words: 4,
+  #     min_length: 4,
+  #     max_length: 8
+  #   }
+  #
+  #   generator = XKPassword::Generator.new
+  #   generator.generate(options)
   def generate(options = nil)
     options ||= {}
     options = DEFAULTS.merge(options)

data/lib/xkpassword/version.rb

@@ -1,3 +1,3 @@
 module XKPassword
-  VERSION = `git describe --tags`.gsub(/-.+$\n/, '')
+  VERSION = '0.2.3'
 end

data/lib/xkpassword/words.rb

@@ -1,5 +1,15 @@
 require 'xkpassword/store'
 
+# XKPassword::Words basically is a mini database of words. Its job is to provide words
+# that mach a certain criteria. At the moment this criteria is limited to the length
+# of the word.
+#
+# This uses `XKPassword::Store` which is basically the internal store for words. It is
+# expected in the future to make this store configurable and use an external source.
+#
+# @attr_reader [Hash]   words     A collection of words store in a hash with the
+#                                 corresponding key to a word be a function of the
+#                                 lenght of the word.
 class XKPassword::Words
   attr_reader :words
 
@@ -8,24 +18,44 @@ class XKPassword::Words
     setup
   end
 
+  # Provide an array of words having the specified number of characters in it
+  #
+  # @param length   [String]      The number of characters of words should contain
+  #
+  # @return [Array<String>]       Words from the source that match the length requirement.
   def with_length(length)
     fail ArgumentError 'Length should be a numeric' unless length.is_a? Numeric
     words[key(length)]
   end
 
+
+  # Provides a random word with the specified length
+  #
+  # @param length   [Integer]     The number of characters the word should contain
+  #
+  # @return [String]              A random word with length
   def random(length)
     fail ArgumentError, 'Length should be numeric' unless length.is_a? Numeric
     with_length(length).sample
   end
 
+  # Provide lengths available in the databse
+  #
+  # @return [Array<Integer>]      A collection of lengths of words available
   def lengths
     words.keys.map{ |key| gsub(/l/, '').to_i }
   end
 
+  # The lenght of the shortest word
+  #
+  # @return [Integer]             The length of the shortest word
   def min_length
     lengths.min
   end
 
+  # The length of the longest word
+  #
+  # @return [Integer]             The length of the longest word
   def max_length
     lengths.max
   end

data/xkpassword.gemspec

@@ -11,9 +11,15 @@ Gem::Specification.new do |spec|
 
   spec.summary       = %q{Hard to crack - XKPassword Generator for Ruby}
   spec.description   = """
-    Have you been interested in XKCD Password Generator as seen on http://xkpasswd.net? I was, looked
-    arround but found no lib that did the job. So this is my take on the probelm. Hopefully useful to
-    you guys. Comments and suggestions are appreciated.
+  Passwords are hard to remember, specially when they are hard to crack. I'd spend countless hours
+  every eyar resetting passwords and eventually running out of options that I can remember. I found
+  an interesting concept among a comic XKCD, it is to generate passwords using words and thus easier
+  to remember. Here is XKPassword, a lib which you can install to our Ruby app or run indipendant
+  in the command line.
+
+  Wish you a safer future.
+
+  Ziyan
   """
   spec.homepage      = "https://github.com/jdeen/xkpassword"
   spec.license       = "MIT"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xkpassword
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.3
 platform: ruby
 authors:
 - Ziyan Junaideen
@@ -66,13 +66,16 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.5'
-description: "\n    Have you been interested in XKCD Password Generator as seen on
-  http://xkpasswd.net? I was, looked\n    arround but found no lib that did the job.
-  So this is my take on the probelm. Hopefully useful to\n    you guys. Comments and
-  suggestions are appreciated.\n  "
+description: "\n  Passwords are hard to remember, specially when they are hard to
+  crack. I'd spend countless hours\n  every eyar resetting passwords and eventually
+  running out of options that I can remember. I found\n  an interesting concept among
+  a comic XKCD, it is to generate passwords using words and thus easier\n  to remember.
+  Here is XKPassword, a lib which you can install to our Ruby app or run indipendant\n
+  \ in the command line.\n\n  Wish you a safer future.\n\n  Ziyan\n  "
 email:
 - ziyan@jdeen.com
-executables: []
+executables:
+- xkpassword
 extensions: []
 extra_rdoc_files: []
 files:
@@ -88,6 +91,7 @@ files:
 - bin/console
 - bin/setup
 - bin/xkpassword
+- exe/xkpassword
 - lib/xkpassword.rb
 - lib/xkpassword/data/google-10000-english.txt
 - lib/xkpassword/generator.rb