passphrase 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4033cb9da1097b10de0c83644706f4b5ec71d04a
-  data.tar.gz: aba0d115c820f615f3f6124688f548b96f0fe9ba
+  metadata.gz: 6839c4a93fcaa7b8ab1b15bcc1e5008f00167dde
+  data.tar.gz: 155d75784ec0a430721e6d9521c1e33eff210e12
 SHA512:
-  metadata.gz: 4cb595f7d1b1de7ee367a32817a6c5f9f1e568a12433303867f188192d7c8e4354c7ea3b4d3e40c5218c69592d3ff8b9a47b0fb81169c7263cea198f5bcc1b77
-  data.tar.gz: c2d8bb80517d152cfdf8f23e4c1c8bcb2f9ca52dfd01dee89b682b931940a849714219176919dade72afbdea97daaa7c9ba16bbbf6b4dea183081630d0352c5d
+  metadata.gz: df27ed521cffb79b6c04ce4267d7c4162dcb71ea64448794bf240217bb3b1ae586805dab230c86733a86ffc48dc00d00c667354fba298001bb98a672e5046a64
+  data.tar.gz: fd8a89985fce259dfd1041fbb5da86af009af52ed66370aaaab8e2ea2512d53bb6556ba9f057c881f9313a86e2957ebf3e15378240d89a4ebadf31a27795d63a

data.tar.gz.sig

@@ -1 +1,5 @@
-uȦvp˨�`E�^x.�Sp,i��Pe��O��BR�c6�%	����}�m{�b��m��&���|�dOe�	w��r5GV���En�`$���r�!��2B�����A��Vz�Y:%�SJ�=>o��B�4xJ�%�����I���H)�I��@��c?ϙiջ�P�R�XQ�4a3���B�Ozaf�D_���arhY����aJm�:b�3� �|	�>�f�\L>F�>XVd��"S0�(\J�ƍ^��_W��
+-K�Im:���XQ����
+G	�8ڢN��N�f���0�j~�KX��]mK��^�k��Q
+�|�a?�(��pe�30�g�4
+s����ިu���6�O�����yE3p  
+ɸ��$�Ϥ�N^45��Tb�Y��w\W#
�\LbK

data/CHANGELOG.md

@@ -2,7 +2,11 @@
 All notable changes to this project will be documented in this file. This
 project adheres to [Semantic Versioning](http://semver.org/).
 
-## UNRELEASED
+## Version 1.2.1 - 2015-04-19
+### Changed
+- Updated documentation in the README file.
+
+## Version 1.2.0 - 2015-04-17
 ### Added
 - List available languages.
 - Added option `--languages|-l` to select a subset of languages.

data/README.md

@@ -2,26 +2,23 @@
 Use Passphrase to generate a passphrase for SSH or GPG keys. For example, on
 the command-line, run
 
-```bash
-$ passphrase --num-words=4
-dokusi uolgo allunga totalisa
-```
+    $ passphrase --num-words=4
+    dokusi uolgo allunga totalisa
+
 or programmatically,
 
-```ruby
+~~~ruby
 require "passphrase"
 p = Passphrase::Passphrase.new(number_of_words: 4)
 passphrase = p.passphrase
-```
+~~~
 
 Passphrase also has the capability to generate passwords (indirectly).
 
 ## Installation
 The Passphrase command-line tool and library can be installed with
 
-```bash
-$ gem install passphrase
-```
+    $ gem install passphrase
 
 However, because the gem is cryptographically signed to prevent tampering, the
 preferred installation command should include the `--trust-policy` security
@@ -29,15 +26,11 @@ option, which causes the gem to be verified before being installed. To invoke
 this option, you must first add my public key `esumbar.pem` to your list of
 trusted certificates, as follows.
 
-```bash
-$ gem cert --add <(curl -Ls https://raw.githubusercontent.com/esumbar/passphrase/master/certs/esumbar.pem)
-```
+    $ gem cert --add <(curl -Ls https://raw.githubusercontent.com/esumbar/passphrase/master/certs/esumbar.pem)
 
 Finally, specify the appropriate security level when installing.
 
-```bash
-$ gem install passphrase --trust-policy MediumSecurity
-```
+    $ gem install passphrase --trust-policy MediumSecurity
 
 Using `MediumSecurity` rather than `HighSecurity` omits dependent gems that
 are not signed from the verification process. Passphrase depends on the
@@ -46,50 +39,71 @@ unsigned gem `sqlite3`.
 ## Basic usage
 ### Command-line tool
 
-```bash
-$ passphrase --help
-Usage: passphrase [options]
-    -l, --languages=LANG1,...    Specify languages to use, none for a listing
-                                 (default: --languages=all)
-    -n, --num-words=NUM          Number of words in passphrase 3..10
-                                 (default: --num-words=5)
-    -p, --[no-]passwordize       Add one cap, one num, and one special char
-                                 (default: --no-passwordize)
-    -r, --[no-]random-org        Use RANDOM.ORG to generate random numbers
-                                 (default: --no-random-org)
-    -h, --help                   Show this message
-    -v, --version                Show version
-
-$ # generate a passphrase using default settings
-$ passphrase
-sinmak termyne ismus affidavo recur
-
-$ # generate a four-word passphrase
-$ passphrase -n4
-apaisado vermouth seemag ebelik
-
-$ # generate a passphrase using only English and Spanish words
-$ passphrase --languages=english,spanish
-fumada hearsay murcio phosphor azufroso
-
-$ # generate a three-word Polish passphrase and password
-$ passphrase -lp -n3 -p
-podejrza zmalala wypadkow
-8odej=za_Xmalala_wypadkow
-
-$ # list the available languages
-$ passphrase -l
-afrikaans
-croatian
-czech
-diceware
-english
-...
-```
+    $ passphrase --help
+    Usage: passphrase [options]
+        -l, --languages=LANG1,...    Specify languages to use, none for a listing
+                                     (default: --languages=all)
+        -n, --num-words=NUM          Number of words in passphrase 3..10
+                                     (default: --num-words=5)
+        -p, --[no-]passwordize       Add one cap, one num, and one special char
+                                     (default: --no-passwordize)
+        -r, --[no-]random-org        Use RANDOM.ORG to generate random numbers
+                                     (default: --no-random-org)
+        -h, --help                   Show this message
+        -v, --version                Show version
+
+    $ # generate a passphrase using default settings
+    $ passphrase
+    sinmak termyne ismus affidavo recur
+
+    $ # generate a four-word passphrase
+    $ passphrase -n4
+    apaisado vermouth seemag ebelik
+
+    $ # generate a passphrase using only English and Spanish words
+    $ passphrase --languages=english,spanish
+    fumada hearsay murcio phosphor azufroso
+
+    $ # generate a three-word Polish passphrase and password
+    $ passphrase -lp -n3 -p
+    podejrza zmalala wypadkow
+    8odej=za_Xmalala_wypadkow
+
+    $ # list the available languages
+    $ passphrase -l
+    afrikaans
+    croatian
+    czech
+    diceware
+    english
+    finnish
+    french
+    italian
+    japanese
+    latin
+    norwegian
+    polish
+    spanish
+    swedish
+    turkish
 
 ### Ruby library
+Initialize a Passphrase object with
+
+~~~ruby
+Passphrase::Passphrase.new(options={})
+~~~
+
+The following options are accepted.
+
+* `:languages` - array of languages from which to select words
+  (default: `["all"]`)
+* `:number_of_words` - number of words to select (default: `5`)
+* `:use_random_org` - source random numbers from RANDOM.ORG (default: `false`)
+
+For example,
 
-```ruby
+~~~ruby
 require "passphrase"
 
 # generate a passphrase with default options
@@ -110,8 +124,8 @@ Passphrase::Passphrase.new(number_of_words: 6) do |p|
   passphrase_array.map! { |array_element| p.generate.passphrase }
 end
 
-# generate a passphrase using only French and Italian words
-options = { number_of_words: 4, languages: %w( fr it ) }
+# generate a four-word passphrase using only French and Italian words
+options = { languages: %w( fr italian ), number_of_words: 4 }
 p = Passphrase::Passphrase.new(options)
 passphrase = p.passphrase
 
@@ -119,7 +133,7 @@ passphrase = p.passphrase
 p = Passphrase::Passphrase.new(number_of_words: 3)
 passphrase = p.passphrase
 password   = passphrase.to_password
-```
+~~~
 
 ## Background
 ### Diceware Method
@@ -186,10 +200,9 @@ network access, it is susceptible to network problems, and is also slower.
 
 ### Subset of languages
 By default, Passphrase randomly selects words from the collection of available
-languages. If desired, the selection can be limited to a subset of languages.
-This can be done on the command-line and in code by supplying a list of
-language names or abbreviations. A minimal abbreviation uses the first one or
-two letters of a language name, just enough to avoid ambiguity.
+languages. If desired, the selection can be restricted to a subset. This can
+be done on the command-line and in code by supplying a list of language names.
+The names can be abbreviated to the first letter (or two, to avoid ambiguity).
 
 ### Passwords
 A typical passphrase will not satisfy password policies that require the use
@@ -214,17 +227,15 @@ compliment of 7776 entries.
 To run the command-line tool within the repository directory, try `ruby -Ilib
 bin/passphrase`. You can also experiment with the library in irb. For example,
 
-```bash
-$ irb -Ilib -rpassphrase
->> p = Passphrase::Passphrase.new(number_of_words: 3)
-=> {:passphrase=>"jazzy vannier viscount", :number_of_words=>3, ... }
->> p.passphrase
-=> "jazzy vannier viscount"
->> p.passphrase.to_password
-=> "jazz{_2annier_vBscount"
->> p = Passphrase::Passphrase.new(languages: ["e", "fr"])
-=> {:passphrase=>"obstrua lamparos orgy forerez deduce", ... }
-```
+    $ irb -Ilib -rpassphrase
+    >> p = Passphrase::Passphrase.new(number_of_words: 3)
+    => {:passphrase=>"jazzy vannier viscount", :number_of_words=>3, ... }
+    >> p.passphrase
+    => "jazzy vannier viscount"
+    >> p.passphrase.to_password
+    => "jazz{_2annier_vBscount"
+    >> p = Passphrase::Passphrase.new(languages: ["e", "fr"])
+    => {:passphrase=>"obstrua lamparos orgy forerez deduce", ... }
 
 Run the tests with `rake spec`.
 

data/lib/passphrase/default.rb

@@ -4,8 +4,8 @@ module Passphrase
   # specified for a passphrase on the command-line.
   class Default
     class << self
-      # @return [Hash] the default options that the command line interface
-      #   uses to instantiate a {Passphrase} object in {CLI.parse}
+      # @return [Hash] the default options used to instantiate a {Passphrase}
+      #   object
       attr_reader :options
       # @return [Range] an arbitrary range specifying the allowable number of
       #   words in a passphrase, referenced by the {CLI.parse} method
@@ -15,8 +15,8 @@ module Passphrase
     @options = {
       languages: ["all"],
       number_of_words: 5,
-      passwordize: nil,
-      use_random_org: nil
+      passwordize: false,  # only relevant in {CLI.parse}
+      use_random_org: false
     }
     @number_range = (3..10)
   end

data/lib/passphrase/version.rb

@@ -1,5 +1,5 @@
 module Passphrase
   # Version numbers are bumped according to {http://semver.org Semantic
   # Versioning}.
-  VERSION = "1.2.0"
+  VERSION = "1.2.1"
 end

data/spec/passphrase/passphrase_spec.rb

@@ -121,7 +121,7 @@ module Passphrase
           expect(@result.inspect).to match(
             passphrase: "passphrase",
             number_of_words: 1,
-            use_random_org: nil,
+            use_random_org: false,
             word_origins: { "passphrase" => {
               language: "language",
               die_rolls: "11111"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: passphrase
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Edmund Sumbar
@@ -30,7 +30,7 @@ cert_chain:
   aoKZhUfRmAZDUgzW4PMtMxO34fQDbDYevBzMcxmkHNDs87ROMOuPLWJGLcKpgGwJ
   TxzUtBfb7E+Qa/wyo0Ws7A==
   -----END CERTIFICATE-----
-date: 2015-04-18 00:00:00.000000000 Z
+date: 2015-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sqlite3