pwqgen.rb 0.0.2 → 0.0.3.pre

data/.travis.yml

@@ -2,4 +2,6 @@ language: ruby
 rvm:
     - 1.9.3
     - 1.9.2
-
+    - jruby-19mode
+    - ruby-head
+    - jruby-head

data/ChangeLog

@@ -1,3 +1,9 @@
+= 0.0.3 / Unreleased
+
+	* Improved CLI output.
+	* `Pwqgen.new` now works.
+	* Updated documentation with better usage examples.
+
 = 0.0.2 / 2012-06-29
 
 	* Added unit tests.

data/README.md

@@ -2,7 +2,7 @@
 
 [![Build Status](https://secure.travis-ci.org/iphoting/pwqgen.rb.png)](http://travis-ci.org/iphoting/pwqgen.rb) [![Dependency Status](https://gemnasium.com/iphoting/pwqgen.rb.png)](https://gemnasium.com/iphoting/pwqgen.rb)
 
-pwqgen.rb is a Ruby implementation of passwdqc's pwqgen password generator.
+pwqgen.rb is a Ruby implementation of passwdqc's pwqgen, a random pronouncable password generator.
 
 ## Installation
 
@@ -13,23 +13,46 @@ gem install pwqgen.rb
 ## Usage
 
 ### CLI
+You can generate a random password from the command line.
 ```
-$ pwqgen.rb
+$ pwqgen.rb --help
+Usage: pwqgen.rb [options] [<length>]
+
+Options:
+  -h, --help      show this help message and exit
+  -v, --version   show version and exit
+
+<length>: Number of words in the passphrase. [default: 3]
 ```
 
 ### Ruby App
+You can `require` it within your app:
+```
+require 'rubygems'
+require 'pwqgen'
 
-- First, add `pwqgen.rb` into your `Gemfile`.
-
-- Within your application, `require "pwqgen"`.
+p Pwqgen.generate             # => "Image&Both-action"
+p Pwqgen.generate 5           # => "Alaska_Union9Calf=domain&ever"
 
-- Then, invoke `Pwqgen.generate` for a random password.
+pgen = Pwqgen.new             # => #<Pwqgen::Generator:0x9f6ec40 ...>
+p pgen.generate               # => "String5Rebel+horse"
+p pgen.generate 2             # => "Easily2desist"
+```
 
 ## Contributing
 
 1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
+2. Create your feature branch (`git checkout -b feature/my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
+4. Push to the branch (`git push origin feature/my-new-feature`)
 5. Create new Pull Request
 
+## Related
+
+- A web-based demonstration is available on [Heroku](https://pwqgen.herokuapp.com/). ([Source](https://github.com/iphoting/pwqgen-web)).
+- Original C Implementation, <http://www.openwall.com/passwdqc/>.
+
+## Credits
+
+- Original Design and C implementation from <http://www.openwall.com/passwdqc/> by Solar Designer.
+

data/Rakefile

@@ -1,9 +1,17 @@
 #!/usr/bin/env rake
+require 'rubygems'
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require "cucumber"
+require "cucumber/rake/task"
 
-RSpec::Core::RakeTask.new
+RSpec::Core::RakeTask.new do |spec|
+	spec.rspec_opts = ['-f d', '--color']
+end
+Cucumber::Rake::Task.new(:features) do |t|
+	t.cucumber_opts = "features --format pretty"
+end
 
-task :default => :spec
-task :test => :spec
+task :default => :test
+task :test => [:spec, :features]
 

data/bin/pwqgen.rb

@@ -3,11 +3,11 @@
 require 'pwqgen/version'
 require 'pwqgen'
 
-doc = "Usage: pwqgen.rb [options] <length>
+doc = "Usage: pwqgen.rb [options] [<length>]
 
 Options:
-  -h, --help  show this help message and exit
-  --version   show version and exit
+  -h, --help      show this help message and exit
+  -v, --version   show version and exit
 
 <length>: Number of words in the passphrase. [default: 3]
 "
@@ -17,8 +17,8 @@ require 'docopt'
 options = Docopt(doc, Pwqgen::VERSION)
 
 if ARGV.length > 0 && ARGV[0].to_s.match(/\A[+-]?\d+?(\.\d+)?\Z/) then
-p Pwqgen.generate(ARGV[0].to_i)
+puts Pwqgen.generate(ARGV[0].to_i)
 else
-p Pwqgen.generate
+puts Pwqgen.generate
 end
 

data/doc/ChangeLog.html

@@ -53,6 +53,8 @@
   
     <li class="file"><a href="./Gemfile.html">Gemfile</a>
   
+    <li class="file"><a href="./Rakefile.html">Rakefile</a>
+  
   </ul>
 </nav>
 
@@ -73,6 +75,18 @@
 
 <div id="documentation" class="description">
   
+<h1 id="label-0.0.3+%2F+Unreleased">0.0.3 / Unreleased</h1>
+
+<pre>* Improved CLI output.
+* `Pwqgen.new` now works.
+* Updated documentation with better usage examples.</pre>
+
+<h1 id="label-0.0.2+%2F+2012-06-29">0.0.2 / 2012-06-29</h1>
+
+<pre>* Added unit tests.
+* Simplified invocation. You can now just call `Pwqgen.generate`.
+* Fixed a bug where `pwqgen.rb` did not produce output.</pre>
+
 <h1 id="label-0.0.1+%2F+2012-06-28">0.0.1 / 2012-06-28</h1>
 
 <pre>* Initial release.</pre>

data/doc/Gemfile.html

@@ -53,6 +53,8 @@
   
     <li class="file"><a href="./Gemfile.html">Gemfile</a>
   
+    <li class="file"><a href="./Rakefile.html">Rakefile</a>
+  
   </ul>
 </nav>
 
@@ -73,9 +75,9 @@
 
 <div id="documentation" class="description">
   
-<p>source :rubygems ruby “1.9.3”</p>
+<p>source :rubygems</p>
 
-<p>gem ‘docopt’</p>
+<p>gemspec</p>
 
 </div>
 

data/doc/Pwqgen.html

@@ -47,7 +47,6 @@
     <nav id="file-list-section" class="section">
   <h3 class="section-header">Defined In</h3>
   <ul>
-    <li>lib/pwqgen.rb
     <li>lib/pwqgen/pwqgen.rb
     <li>lib/pwqgen/wordlist.rb
     <li>lib/pwqgen/version.rb
@@ -61,7 +60,19 @@
     
     
     
+    <!-- Method Quickref -->
+<nav id="method-list-section" class="section">
+  <h3 class="section-header">Methods</h3>
+
+  <ul class="link-list">
+    
+    <li><a href="#method-c-generate">::generate</a>
     
+    <li><a href="#method-c-new">::new</a>
+    
+  </ul>
+</nav>
+
   </div>
 
   <div id="project-metadata">
@@ -74,6 +85,8 @@
   
     <li class="file"><a href="./Gemfile.html">Gemfile</a>
   
+    <li class="file"><a href="./Rakefile.html">Rakefile</a>
+  
   </ul>
 </nav>
 
@@ -100,13 +113,19 @@
 <p>Public: <a href="Pwqgen.html">Pwqgen</a> is a Ruby implementation of
 passwdqc’s pwqgen password generator.</p>
 
-<p>Example</p>
+<p>Examples</p>
+
+<pre class="ruby"><span class="ruby-constant">Pwqgen</span>.<span class="ruby-identifier">generate</span>
+<span class="ruby-comment"># =&gt; &quot;Unrest3Male!trout&quot;</span>
 
-<pre class="ruby"><span class="ruby-constant">Pwqgen</span><span class="ruby-operator">::</span><span class="ruby-constant">Generator</span>.<span class="ruby-identifier">new</span>.<span class="ruby-identifier">generate</span>
-<span class="ruby-comment"># =&gt; &quot;Crime2Behave=growth&quot;</span>
+<span class="ruby-constant">Pwqgen</span>.<span class="ruby-identifier">new</span>.<span class="ruby-identifier">generate</span>
+<span class="ruby-comment"># =&gt; &quot;Obese6Perish6viola&quot;</span>
 
-<span class="ruby-constant">Pwqgen</span><span class="ruby-operator">::</span><span class="ruby-constant">Generator</span>.<span class="ruby-identifier">new</span>.<span class="ruby-identifier">generate</span> <span class="ruby-value">4</span>
-<span class="ruby-comment"># =&gt; &quot;Caesar-Madam7draft8choose&quot;</span>
+    <span class="ruby-constant">Pwqgen</span><span class="ruby-operator">::</span><span class="ruby-constant">Generator</span>.<span class="ruby-identifier">new</span>.<span class="ruby-identifier">generate</span>
+    <span class="ruby-comment"># =&gt; &quot;Crime2Behave=growth&quot;</span>
+
+    <span class="ruby-constant">Pwqgen</span><span class="ruby-operator">::</span><span class="ruby-constant">Generator</span>.<span class="ruby-identifier">new</span>.<span class="ruby-identifier">generate</span> <span class="ruby-value">4</span>
+    <span class="ruby-comment"># =&gt; &quot;Caesar-Madam7draft8choose&quot;</span>
 </pre>
 
 <p>Private: Wordlist stolen from passwdqc’s wordset_4k.c. <a
@@ -204,6 +223,85 @@ that no word is shorter than 3 characters.</p>
 
     <!-- Methods -->
     
+     <section id="public-class-5Buntitled-5D-method-details" class="method-section section">
+      <h3 class="section-header">Public Class Methods</h3>
+
+    
+      <div id="method-c-generate" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">generate</span><span
+            class="method-args">(length = 3)</span>
+          <span class="method-click-advice">click to toggle source</span>
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Public: Returns a random generated password string.</p>
+
+<p>length - number of words used to create the passphrase.</p>
+
+<p>Example</p>
+
+<pre class="ruby"><span class="ruby-constant">Pwqgen</span>.<span class="ruby-identifier">generate</span> <span class="ruby-value">2</span>
+<span class="ruby-comment"># =&gt; &quot;Loyal8atomic&quot;</span>
+
+<span class="ruby-constant">Pwqgen</span>.<span class="ruby-identifier">generate</span>
+<span class="ruby-comment"># =&gt; &quot;Gate*Abound&amp;hull&quot;</span>
+</pre>
+
+<p>Returns a password string.</p>
+          
+
+          
+          <div class="method-source-code" id="generate-source">
+            <pre><span class="ruby-comment"># File lib/pwqgen/pwqgen.rb, line 35</span>
+<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">generate</span>(<span class="ruby-identifier">length</span> = <span class="ruby-value">3</span>)
+        <span class="ruby-keyword">self</span><span class="ruby-operator">::</span><span class="ruby-constant">Generator</span>.<span class="ruby-identifier">new</span>.<span class="ruby-identifier">generate</span> <span class="ruby-identifier">length</span>
+<span class="ruby-keyword">end</span></pre>
+          </div><!-- generate-source -->
+          
+        </div>
+
+        
+
+        
+      </div><!-- generate-method -->
+
+    
+      <div id="method-c-new" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">new</span><span
+            class="method-args">()</span>
+          <span class="method-click-advice">click to toggle source</span>
+        </div>
+        
+
+        <div class="method-description">
+          
+          
+          
+
+          
+          <div class="method-source-code" id="new-source">
+            <pre><span class="ruby-comment"># File lib/pwqgen/pwqgen.rb, line 39</span>
+<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">new</span>
+        <span class="ruby-keyword">self</span><span class="ruby-operator">::</span><span class="ruby-constant">Generator</span>.<span class="ruby-identifier">new</span>
+<span class="ruby-keyword">end</span></pre>
+          </div><!-- new-source -->
+          
+        </div>
+
+        
+
+        
+      </div><!-- new-method -->
+
+    
+    </section><!-- public-class-method-details -->
+  
   </section><!-- 5Buntitled-5D -->
 
 </div><!-- documentation -->

data/doc/Pwqgen/Generator.html

@@ -90,6 +90,8 @@
   
     <li class="file"><a href="../Gemfile.html">Gemfile</a>
   
+    <li class="file"><a href="../Rakefile.html">Rakefile</a>
+  
   </ul>
 </nav>
 
@@ -149,12 +151,11 @@
 
           
           <div class="method-source-code" id="new-source">
-            <pre><span class="ruby-comment"># File lib/pwqgen/pwqgen.rb, line 17</span>
+            <pre><span class="ruby-comment"># File lib/pwqgen/pwqgen.rb, line 44</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>
         <span class="ruby-identifier">@@wordlist_size</span> = <span class="ruby-identifier">@@wordlist</span>.<span class="ruby-identifier">length</span>
         <span class="ruby-identifier">@@separators</span> = <span class="ruby-string">&quot;-_!$&amp;*+=23456789&quot;</span>.<span class="ruby-identifier">split</span>(<span class="ruby-regexp">%r/</span>)
         <span class="ruby-identifier">@@separators_size</span> = <span class="ruby-identifier">@@separators</span>.<span class="ruby-identifier">length</span>
-        <span class="ruby-ivar">@length</span> = <span class="ruby-value">3</span>
         <span class="ruby-ivar">@rand</span> = <span class="ruby-constant">Random</span>.<span class="ruby-identifier">new</span>
 <span class="ruby-keyword">end</span></pre>
           </div><!-- new-source -->
@@ -177,20 +178,33 @@
         
         <div class="method-heading">
           <span class="method-name">generate</span><span
-            class="method-args">(length = @length)</span>
+            class="method-args">(length = 3)</span>
           <span class="method-click-advice">click to toggle source</span>
         </div>
         
 
         <div class="method-description">
           
-          
+          <p>Public: Returns a random generated password string.</p>
+
+<p>length - number of words used to create the passphrase.</p>
+
+<p>Example</p>
+
+<pre class="ruby"><span class="ruby-identifier">generate</span> <span class="ruby-value">2</span>
+<span class="ruby-comment"># =&gt; &quot;Loyal8atomic&quot;</span>
+
+<span class="ruby-identifier">generate</span>
+<span class="ruby-comment"># =&gt; &quot;Gate*Abound&amp;hull&quot;</span>
+</pre>
+
+<p>Returns a password string.</p>
           
 
           
           <div class="method-source-code" id="generate-source">
-            <pre><span class="ruby-comment"># File lib/pwqgen/pwqgen.rb, line 25</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier">generate</span>(<span class="ruby-identifier">length</span> = <span class="ruby-ivar">@length</span>)
+            <pre><span class="ruby-comment"># File lib/pwqgen/pwqgen.rb, line 64</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">generate</span>(<span class="ruby-identifier">length</span> = <span class="ruby-value">3</span>)
         <span class="ruby-identifier">output</span> = <span class="ruby-constant">Array</span>.<span class="ruby-identifier">new</span>
         <span class="ruby-keyword">for</span> <span class="ruby-identifier">i</span> <span class="ruby-keyword">in</span> <span class="ruby-value">1</span><span class="ruby-operator">..</span><span class="ruby-identifier">length</span>
                 <span class="ruby-identifier">output</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">@@wordlist</span>[<span class="ruby-ivar">@rand</span>.<span class="ruby-identifier">rand</span>(<span class="ruby-identifier">@@wordlist_size</span>)]

data/doc/Rakefile.html

@@ -0,0 +1,94 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
+
+<title>Rakefile - RDoc Documentation</title>
+
+<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet">
+
+<script type="text/javascript">
+  var rdoc_rel_prefix = "./";
+</script>
+
+<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script>
+<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script>
+<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script>
+<script type="text/javascript" charset="utf-8" src="./js/search.js"></script>
+<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script>
+<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script>
+
+
+<body class="file">
+<nav id="metadata">
+  <nav id="home-section" class="section">
+  <h3 class="section-header">
+    <a href="./index.html">Home</a>
+    <a href="./table_of_contents.html#classes">Classes</a>
+    <a href="./table_of_contents.html#methods">Methods</a>
+  </h3>
+</nav>
+
+
+  <nav id="search-section" class="section project-section" class="initially-hidden">
+  <form action="#" method="get" accept-charset="utf-8">
+    <h3 class="section-header">
+      <input type="text" name="search" placeholder="Search" id="search-field"
+             title="Type to search, Up and Down to navigate, Enter to load">
+    </h3>
+  </form>
+
+  <ul id="search-results" class="initially-hidden"></ul>
+</nav>
+
+
+  <div id="project-metadata">
+    <nav id="fileindex-section" class="section project-section">
+  <h3 class="section-header">Pages</h3>
+
+  <ul>
+  
+    <li class="file"><a href="./ChangeLog.html">ChangeLog</a>
+  
+    <li class="file"><a href="./Gemfile.html">Gemfile</a>
+  
+    <li class="file"><a href="./Rakefile.html">Rakefile</a>
+  
+  </ul>
+</nav>
+
+    <nav id="classindex-section" class="section project-section">
+  <h3 class="section-header">Class and Module Index</h3>
+
+  <ul class="link-list">
+  
+    <li><a href="./Pwqgen.html">Pwqgen</a>
+  
+    <li><a href="./Pwqgen/Generator.html">Pwqgen::Generator</a>
+  
+  </ul>
+</nav>
+
+  </div>
+</nav>
+
+<div id="documentation" class="description">
+  
+<p>#!/usr/bin/env rake require “bundler/gem_tasks” require
+“rspec/core/rake_task”</p>
+
+<p>RSpec::Core::RakeTask.new</p>
+
+<p>task :default =&gt; :spec task :test =&gt; :spec</p>
+
+</div>
+
+
+
+<footer id="validator-badges">
+  <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
+  <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12.
+  <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
+</footer>
+

data/doc/created.rid

@@ -1,8 +1,11 @@
-Thu, 28 Jun 2012 23:04:43 +0800
-./bin/pwqgen.rb	Thu, 28 Jun 2012 22:39:33 +0800
-./lib/pwqgen.rb	Thu, 28 Jun 2012 21:25:16 +0800
-./lib/pwqgen/pwqgen.rb	Thu, 28 Jun 2012 23:03:41 +0800
-./lib/pwqgen/wordlist.rb	Thu, 28 Jun 2012 23:04:40 +0800
-./lib/pwqgen/version.rb	Thu, 28 Jun 2012 22:42:06 +0800
-./Gemfile	Thu, 28 Jun 2012 22:19:30 +0800
-./ChangeLog	Thu, 28 Jun 2012 22:44:41 +0800
+Fri, 29 Jun 2012 16:02:55 +0800
+./bin/pwqgen.rb	Fri, 29 Jun 2012 11:49:44 +0800
+./lib/pwqgen.rb	Fri, 29 Jun 2012 01:05:28 +0800
+./lib/pwqgen/pwqgen.rb	Fri, 29 Jun 2012 15:48:25 +0800
+./lib/pwqgen/wordlist.rb	Fri, 29 Jun 2012 01:05:28 +0800
+./lib/pwqgen/version.rb	Fri, 29 Jun 2012 11:09:21 +0800
+./spec/lib/pwqgen_spec.rb	Fri, 29 Jun 2012 15:53:29 +0800
+./spec/spec_helper.rb	Fri, 29 Jun 2012 01:05:28 +0800
+./Rakefile	Fri, 29 Jun 2012 01:05:28 +0800
+./Gemfile	Fri, 29 Jun 2012 01:05:28 +0800
+./ChangeLog	Fri, 29 Jun 2012 15:28:04 +0800

data/doc/index.html

@@ -53,6 +53,8 @@
   
     <li class="file"><a href="./Gemfile.html">Gemfile</a>
   
+    <li class="file"><a href="./Rakefile.html">Rakefile</a>
+  
   </ul>
 </nav>
 

data/doc/js/search_index.js

@@ -1 +1 @@
-var search_data = {"index":{"searchIndex":["pwqgen","generator","generate()","new()","changelog","gemfile"],"longSearchIndex":["pwqgen","pwqgen::generator","pwqgen::generator#generate()","pwqgen::generator::new()","",""],"info":[["Pwqgen","","Pwqgen.html","","<p>Public: Pwqgen is a Ruby implementation of passwdqc’s pwqgen password\ngenerator.\n<p>Example\n\n<pre>Pwqgen::Generator.new.generate ...</pre>\n"],["Pwqgen::Generator","","Pwqgen/Generator.html","",""],["generate","Pwqgen::Generator","Pwqgen/Generator.html#method-i-generate","(length = @length)",""],["new","Pwqgen::Generator","Pwqgen/Generator.html#method-c-new","()",""],["ChangeLog","","ChangeLog.html","","<p>0.0.1 / 2012-06-28\n\n<pre>* Initial release.</pre>\n"],["Gemfile","","Gemfile.html","","<p>source :rubygems ruby “1.9.3”\n<p>gem ‘docopt’\n"]]}}
+var search_data = {"index":{"searchIndex":["pwqgen","generator","generate()","generate()","new()","new()","changelog","gemfile","rakefile"],"longSearchIndex":["pwqgen","pwqgen::generator","pwqgen::generate()","pwqgen::generator#generate()","pwqgen::new()","pwqgen::generator::new()","","",""],"info":[["Pwqgen","","Pwqgen.html","","<p>Public: Pwqgen is a Ruby implementation of passwdqc’s pwqgen password\ngenerator.\n<p>Examples\n\n<pre>Pwqgen.generate ...</pre>\n"],["Pwqgen::Generator","","Pwqgen/Generator.html","",""],["generate","Pwqgen","Pwqgen.html#method-c-generate","(length = 3)","<p>Public: Returns a random generated password string.\n<p>length - number of words used to create the passphrase. …\n"],["generate","Pwqgen::Generator","Pwqgen/Generator.html#method-i-generate","(length = 3)","<p>Public: Returns a random generated password string.\n<p>length - number of words used to create the passphrase. …\n"],["new","Pwqgen","Pwqgen.html#method-c-new","()",""],["new","Pwqgen::Generator","Pwqgen/Generator.html#method-c-new","()",""],["ChangeLog","","ChangeLog.html","","<p>0.0.3 / Unreleased\n\n<pre>* Improved CLI output.\n* `Pwqgen.new` now works.\n* Updated documentation with better ...</pre>\n"],["Gemfile","","Gemfile.html","","<p>source :rubygems\n<p>gemspec\n"],["Rakefile","","Rakefile.html","","<p>#!/usr/bin/env rake require “bundler/gem_tasks” require\n“rspec/core/rake_task”\n<p>RSpec::Core::RakeTask.new …\n"]]}}

data/doc/table_of_contents.html

@@ -30,12 +30,17 @@
 
     <img class="toc-toggle" src="images/transparent.png" alt="" title="toggle headings">
     <ul class="initially-hidden">
+      <li><a href="ChangeLog.html#label-0.0.3+%2F+Unreleased">0.0.3 / Unreleased</a>
+      <li><a href="ChangeLog.html#label-0.0.2+%2F+2012-06-29">0.0.2 / 2012-06-29</a>
       <li><a href="ChangeLog.html#label-0.0.1+%2F+2012-06-28">0.0.1 / 2012-06-28</a>
     </ul>
   </li>
     <li class="file">
     <a href="Gemfile.html">Gemfile</a>
   </li>
+    <li class="file">
+    <a href="Rakefile.html">Rakefile</a>
+  </li>
   
 </ul>
 
@@ -53,8 +58,12 @@
 <h2 id="methods">Methods</h2>
 <ul>
   
+    <li class="method"><a href="Pwqgen.html#method-c-generate">::generate &mdash; Pwqgen</a>
+  
     <li class="method"><a href="Pwqgen/Generator.html#method-c-new">::new &mdash; Pwqgen::Generator</a>
   
+    <li class="method"><a href="Pwqgen.html#method-c-new">::new &mdash; Pwqgen</a>
+  
     <li class="method"><a href="Pwqgen/Generator.html#method-i-generate">#generate &mdash; Pwqgen::Generator</a>
   
 </ul>

data/features/password_generation.feature

@@ -0,0 +1,21 @@
+@announce-cmd
+@posix
+Feature: Password Generation
+
+	In order to use a secure password for my login
+	As an end user
+	I want to get a strong randomly generated password
+
+	Scenario: Generate a random password of default length
+		When I run `pwqgen.rb`
+		Then the output should match /^[A-Za-z]{3,6}([-_!$&*+=23456789][A-Za-z]{3,6}){2}$/
+
+	Scenario: Generate a random password of length 2
+		When I run `pwqgen.rb 2`
+		Then the output should match /^[A-Za-z]{3,6}([-_!$&*+=23456789][A-Za-z]{3,6}){1}$/
+
+	Scenario: Generate a random password of length 5
+		When I run `pwqgen.rb 5`
+		Then the output should match /^[A-Za-z]{3,6}([-_!$&*+=23456789][A-Za-z]{3,6}){4}$/
+
+

data/features/step_definitions/pwqgen.rb_steps.rb

@@ -0,0 +1 @@
+

data/features/support/env.rb

@@ -0,0 +1,17 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
+require 'aruba/cucumber'
+require 'fileutils'
+require 'rspec/expectations'
+
+ENV['PATH'] = "#{File.expand_path(File.dirname(__FILE__) + '/../../bin')}#{File::PATH_SEPARATOR}#{ENV['PATH']}"
+
+Before do
+  if RUBY_PLATFORM =~ /java/
+    # ideas taken from: http://blog.headius.com/2010/03/jruby-startup-time-tips.html
+    set_env('JRUBY_OPTS', '-X-C') # disable JIT since these processes are so short lived
+    set_env('JAVA_OPTS', '-d32') # force jRuby to use client JVM for faster startup times
+    @aruba_timeout_seconds = 60
+  else
+    @aruba_timeout_seconds = 5
+  end
+end

data/lib/pwqgen/pwqgen.rb

@@ -3,7 +3,13 @@ require 'pwqgen/wordlist'
 # Public: Pwqgen is a Ruby implementation of passwdqc's pwqgen password
 # generator.
 #
-# Example
+# Examples
+#
+#   Pwqgen.generate
+#   # => "Unrest3Male!trout"
+#
+#   Pwqgen.new.generate
+#   # => "Obese6Perish6viola"
 #
 # 	Pwqgen::Generator.new.generate
 # 	# => "Crime2Behave=growth"
@@ -13,10 +19,27 @@ require 'pwqgen/wordlist'
 #
 module Pwqgen
 
+	# Public: Returns a random generated password string.
+	# 
+	# length - number of words used to create the passphrase.
+	# 
+	# Example
+	# 
+	# 	Pwqgen.generate 2
+	# 	# => "Loyal8atomic"
+	# 
+	# 	Pwqgen.generate
+	# 	# => "Gate*Abound&hull"
+	#
+	# Returns a password string.
 	def self.generate(length = 3)
 		self::Generator.new.generate length
 	end
 
+	def self.new
+		self::Generator.new
+	end
+
 	class Generator
 		def initialize
 			@@wordlist_size = @@wordlist.length
@@ -25,6 +48,19 @@ module Pwqgen
 			@rand = Random.new
 		end
 
+		# Public: Returns a random generated password string.
+		# 
+		# length - number of words used to create the passphrase.
+		# 
+		# Example
+		# 
+		# 	generate 2
+		# 	# => "Loyal8atomic"
+		# 
+		# 	generate
+		# 	# => "Gate*Abound&hull"
+		#
+		# Returns a password string.
 		def generate(length = 3)
 			output = Array.new
 			for i in 1..length

data/lib/pwqgen/version.rb

@@ -1,3 +1,3 @@
 module Pwqgen
-	VERSION = "0.0.2"
+	VERSION = "0.0.3.pre"
 end

data/pwqgen.rb.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |s|
   s.name        = 'pwqgen.rb'
   s.version     = Pwqgen::VERSION
   s.summary     = "pwqgen in Ruby"
-  s.description = "pwqgen.rb implements passwdqc's pwqgen in Ruby."
+  s.description = "pwqgen.rb is a Ruby implementation of passwdqc's pwqgen, a random pronouncable password generator."
   s.authors     = ["Ronald Ip"]
   s.email       = 'myself@iphoting.com'
   s.homepage    = 'https://github.com/iphoting/pwqgen.rb'
@@ -21,4 +21,5 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec'
+  s.add_development_dependency 'aruba'
 end

data/spec/lib/pwqgen_spec.rb

@@ -24,4 +24,36 @@ describe Pwqgen do
 		password.should be_kind_of(String)
 		password.length.should be_within(8).of(27)
 	end
+
+	it "should return a Pwqgen::Generator object when Pwqgen.new is called" do
+		obj = Pwqgen.new
+		obj.should_not be_nil
+		obj.should be_an_instance_of(Pwqgen::Generator)
+	end
+end
+
+describe Pwqgen::Generator do
+	it "should return a random password" do
+		password = Pwqgen::Generator.new.generate
+		password.should_not be_nil
+		password.should_not be_empty
+		password.should be_kind_of(String)
+		password.length.should be_within(5).of(15)
+	end
+
+	it "should return a short random password when given a length of 1" do
+		password = Pwqgen::Generator.new.generate 1
+		password.should_not be_nil
+		password.should_not be_empty
+		password.should be_kind_of(String)
+		password.length.should be_within(2).of(4)
+	end
+
+	it "should return a longer random password when given a length of 5" do
+		password = Pwqgen::Generator.new.generate 5
+		password.should_not be_nil
+		password.should_not be_empty
+		password.should be_kind_of(String)
+		password.length.should be_within(8).of(27)
+	end
 end

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: pwqgen.rb
 version: !ruby/object:Gem::Version
-  version: 0.0.2
-  prerelease: 
+  version: 0.0.3.pre
+  prerelease: 6
 platform: ruby
 authors:
 - Ronald Ip
@@ -59,7 +59,24 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: pwqgen.rb implements passwdqc's pwqgen in Ruby.
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: pwqgen.rb is a Ruby implementation of passwdqc's pwqgen, a random pronouncable
+  password generator.
 email: myself@iphoting.com
 executables:
 - pwqgen.rb
@@ -77,6 +94,7 @@ files:
 - doc/Gemfile.html
 - doc/Pwqgen.html
 - doc/Pwqgen/Generator.html
+- doc/Rakefile.html
 - doc/created.rid
 - doc/images/add.png
 - doc/images/brick.png
@@ -111,6 +129,9 @@ files:
 - doc/js/searcher.js
 - doc/rdoc.css
 - doc/table_of_contents.html
+- features/password_generation.feature
+- features/step_definitions/pwqgen.rb_steps.rb
+- features/support/env.rb
 - lib/pwqgen.rb
 - lib/pwqgen/pwqgen.rb
 - lib/pwqgen/version.rb
@@ -133,9 +154,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -143,6 +164,9 @@ signing_key:
 specification_version: 3
 summary: pwqgen in Ruby
 test_files:
+- features/password_generation.feature
+- features/step_definitions/pwqgen.rb_steps.rb
+- features/support/env.rb
 - spec/lib/pwqgen_spec.rb
 - spec/spec_helper.rb
 has_rdoc: