pwgen 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 781a8343812268d938ed4c403ad1d00bef54f6cfa59ce8563fd66e264b917319
-  data.tar.gz: 9e2afc567d6ce15332836f8e21ae9008f6c8ceeb4cd094fe1b47f1f94bdec728
+  metadata.gz: 4472ad381c4a88ef103a89f5c2de0ec9ab0e1cf986889da83fc969c729a510cc
+  data.tar.gz: b3bb08649f13c105300fe0a2c7e974b1609a40b20080edb97c2e80584f6d3986
 SHA512:
-  metadata.gz: 14bbf8f04c8fe2df6240d6b00996066dc4f4f7eb408bc2471f006a18624318990c3ac60738b29b54d40dacd68b711e469d5baac6a2a0de70ebc0b9093aad1c13
-  data.tar.gz: 6b8899bbfc35f3bc63c02612033cde3ff95ca095cc43df15c325358535dd101ca792c178b92e06089d8ac078a5a76eb77bedadae79170fd6f279abd6e6a86620
+  metadata.gz: f33c81b5c7bd7e0194fcf33354aa8ccbd517261acac318d04c3ff731054bbb2e55692e00020bc7ae28b1dbb6587e41db7b4f8417201002564d74b424a6ea8400
+  data.tar.gz: c7d28838150b5250048948d286b44b34c6234dfb894070ca4f0ded15e4284d94cbcb160ee502451b773d276ed2349c907f23bb716db111975e18032cfbf59720

data/.travis.yml

@@ -2,19 +2,33 @@ sudo: required
 matrix:
   include:
   - language: ruby
-    rvm: 2.2
+    env:
+      - NAME="Bundle test"
+    rvm: 2.3.8
     before_install:
-      - gem install bundler -v 1.16.1
+      - gem install bundler -v 2.0.1
   - language: ruby
+    env:
+      - NAME="Bundle test"
     rvm: 2.4.4
     before_install:
-      - gem install bundler -v 1.17.3
+      - gem install bundler -v 2.0.1
   - language: ruby
-    rvm: 2.4.4
+    env:
+      - NAME="Bundle test"
+    rvm: 2.5.3
     before_install:
       - gem install bundler -v 2.0.1
   - language: ruby
-    env: SKIP_INTERPRETER=true
+    env:
+      - NAME="Bundle test"
+    rvm: 2.6.0
+    before_install:
+      - gem install bundler -v 2.0.1
+  - language: ruby
+    env:
+      - NAME="Rubocop Checks"
+      - SKIP_INTERPRETER=true
     rvm: 2.4.4
     before_install:
       - git clone https://github.com/TravisToolbox/rubocop-travis.git
@@ -23,7 +37,9 @@ matrix:
     script:
       - ./rubocop-travis/scan.sh
   - language: ruby
-    rvm: 2.2
+    env:
+      - NAME="Link Checker"
+    rvm: 2.4.4
     before_install:
       - mkdir travis
       - git clone https://github.com/TravisToolbox/awesomebot-travis.git travis/awesomebot

data/CHANGELOG.md

@@ -1,4 +1,4 @@
-## 1.0.0 (January 28, 2019)
+## 1.0.0 (January 29, 2019)
 
 * Initial Release ([@TGWolf][])
 

data/README.md

@@ -60,6 +60,26 @@ There are a number of options that can be password:
 
 You can also pass the options parameter to the 'generate_password' method to override the settings for a specific password creation.
 
+## Executable
+
+There is also an executable linked to this gem which allows you to generate passwords within bash scripts etc.
+
+```
+Usage: pwgen
+    -h, --help                       Display this screen
+    -c, --show-config                Show the configuration
+    -d, --digits string              Minimum number of digits to use. (default: random)
+    -l, --length string              The length of the password (default 12)
+    -s, --symbols string             Minimum number of symbols to use. (default: random)
+    -C, --skip-confusables           Skip the use of letters which are easily confused e.g. 1 and l in passwords
+    -D, --skip-digits                Skip the use of digits in passwords
+    -L, --skip-lower-case            Skip the use of lower case letters in passwords
+    -P, --skip-phonetic              Skip creation of the phonetic password
+    -S, --skip-symbols               Skip the use of symbols in passwords
+    -U, --skip-upper-case            Skip the use of upper case letters in passwords
+    -W, --skip-url-unsafe            Skip the use of url (Web) unsafe characters in passwords
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -72,7 +92,7 @@ For local testing make sure that you run `bundle exec rspec spec` and then `rake
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/pwgen. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/AntiPhotonltd/password_generator. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
@@ -80,4 +100,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Pwgen project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/pwgen/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Pwgen project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/AntiPhotonltd/password_generator/blob/master/CODE_OF_CONDUCT.md).

data/exe/pwgen

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 require 'optparse'
-require "pwgen"
+require 'pwgen'
 
 # -------------------------------------------------------------------------------- #
 # Generate Password                                                                #
@@ -10,11 +10,19 @@ require "pwgen"
 # -------------------------------------------------------------------------------- #
 
 def generate_password(options)
-    Pwgen::Password.generate_password(options[:length])
-
-    pputs Pwgen::Password.password
-
-    pputs Pwgen::Password.phonetic_password if options[:phonetic]
+    if options[:config]
+        Pwgen::Password.configure(options)
+        Pwgen::Password.show_configuration
+    else
+        begin
+            Pwgen::Password.generate_password(options[:length], options)
+        rescue RuntimeError => e
+            puts e.message
+        else
+            puts Pwgen::Password.password
+            puts Pwgen::Password.phonetic_password unless options[:skip_phonetic]
+        end
+    end
 end
 
 # -------------------------------------------------------------------------------- #
@@ -27,7 +35,7 @@ end
 # -------------------------------------------------------------------------------- #
 
 def process_arguments
-    options = {}
+    options = { length: 12 }
     # Enforce the presence of
     mandatory = %I[length]
 
@@ -38,9 +46,50 @@ def process_arguments
             puts opts
             exit(1)
         end
-        opts.on('-l', '--length string', 'The length of the password') do |length|
+
+        opts.on('-c', '--show-config', 'Show the configuration') do |_config|
+            options[:config] = true
+        end
+
+        opts.on('-d', '--digits string', 'Minimum number of digits to use. (default: random)') do |digits|
+            options[:digits] = digits
+        end
+
+        opts.on('-l', '--length string', 'The length of the password (default 12)') do |length|
             options[:length] = length
         end
+
+        opts.on('-s', '--symbols string', 'Minimum number of symbols to use. (default: random)') do |symbols|
+            options[:symbols] = symbols
+        end
+
+        opts.on('-C', '--skip-confusables', 'Skip the use of letters which are easily confused e.g. 1 and l in passwords') do |_skip_confusables|
+            options[:skip_confusables] = true
+        end
+
+        opts.on('-D', '--skip-digits', 'Skip the use of digits in passwords') do |_skip_digits|
+            options[:skip_digits] = true
+        end
+
+        opts.on('-L', '--skip-lower-case', 'Skip the use of lower case letters in passwords') do |_skip_lower_case|
+            options[:skip_lower_case] = true
+        end
+
+        opts.on('-P', '--skip-phonetic', 'Skip creation of the phonetic password') do |_skip_phonetic|
+            options[:skip_phonetic] = true
+        end
+
+        opts.on('-S', '--skip-symbols', 'Skip the use of symbols in passwords') do |_skip_symbols|
+            options[:skip_symbols] = true
+        end
+
+        opts.on('-U', '--skip-upper-case', 'Skip the use of upper case letters in passwords') do |_skip_upper_case|
+            options[:skip_upper_case] = true
+        end
+
+        opts.on('-W', '--skip-url-unsafe', 'Skip the use of url (Web) unsafe characters in passwords') do |_skip_url_unsafe|
+            options[:skip_url_unsafe] = true
+        end
     end
 
     begin
@@ -73,4 +122,3 @@ main
 # -------------------------------------------------------------------------------- #
 # This is the end - nothing more to see here.                                      #
 # -------------------------------------------------------------------------------- #
-

data/lib/pwgen.rb

@@ -12,7 +12,7 @@ module Pwgen
     # docs to go here
     #
     class Password
-        UNFRIENDLY_CHARS = ['$', 'S', 's', '5', 'B', 'b', '8', '|', 'I', 'i', 'o', '0', '1', 'l', 'O', '!'].freeze
+        CONFUSABLE_CHARS = ['$', 'S', 's', '5', 'B', 'b', '8', '|', 'I', 'i', 'o', '0', '1', 'l', 'O', '!'].freeze
         URL_UNSAFE = ['$', '&', '+', ',', '/', ':', ';', '=', '?', '@', '<', '>', '#', '%', '{', '}', '|', '^', '~', '[', ']', '\\', '"', '`'].freeze
 
         $lower_case = []
@@ -44,19 +44,19 @@ module Pwgen
         def self.configure(options)
             $lower_case = []
             $lower_case = ('a'..'z').to_a unless options[:skip_lower_case]
-            $lower_case -= UNFRIENDLY_CHARS unless options[:dont_exclude_unfrieldly_chars]
+            $lower_case -= CONFUSABLE_CHARS if options[:skip_confusables]
 
             $upper_case = []
             $upper_case = ('A'..'Z').to_a unless options[:skip_upper_case]
-            $upper_case -= UNFRIENDLY_CHARS unless options[:dont_exclude_unfrieldly_chars]
+            $upper_case -= CONFUSABLE_CHARS if options[:skip_confusables]
 
             $digits = []
             $digits = ('0'..'9').to_a unless options[:skip_digits]
-            $digits -= UNFRIENDLY_CHARS unless options[:dont_exclude_unfrieldly_chars]
+            $digits -= CONFUSABLE_CHARS if options[:skip_confusables]
 
             $symbols = []
-            $symbols = ['!', '@', '#', '£', '$', '%', '^', '&', '*', '(', ')', '-', '_', '+', '=', '{', '}', '[', ']', ':', ';', '"', '\'', '|', '\\', '~', '`', '<', '>', '?', ',', '.', '/', '\ '].freeze unless options[:skip_symbols]
-            $symbols -= UNFRIENDLY_CHARS unless options[:dont_exclude_unfrieldly_chars]
+            $symbols = ['!', '@', '#', '£', '$', '%', '^', '&', '*', '(', ')', '-', '_', '+', '=', '{', '}', '[', ']', ':', ';', '"', '\'', '|', '\\', '~', '`', '<', '>', '?', ',', '.', '/', ' '].freeze unless options[:skip_symbols]
+            $symbols -= CONFUSABLE_CHARS if options[:skip_confusables]
             $symbols -= URL_UNSAFE if options[:skip_url_unsafe]
 
             $alpha = []
@@ -80,15 +80,22 @@ module Pwgen
             puts "Alpha: #{$alpha}"
             puts "AlphaNumeric: #{$alphanum}"
 
-            puts "Unfriendly Chars: #{UNFRIENDLY_CHARS}"
+            puts "Confusable Chars: #{CONFUSABLE_CHARS}"
             puts "URL Unsafe: #{URL_UNSAFE}"
 
             puts "Full Character Set: #{$full_character_set}"
         end
 
         def self.generate_password(length = 12, options = {})
-            raise 'length must be an integer!' unless length.is_a? Integer
-            raise 'length must be a positive integer!' unless length > 0
+            raise 'length must be a number!' unless length !~ /\D/
+
+            length = length.to_i
+
+            raise 'length must be a positive number!' unless length > 0
+
+            if options[:digits] || options[:symbols]
+                raise 'length is to short to meet digits/symbols requirements!' if length < options[:digits].to_i + options[:symbols].to_i
+            end
 
             reset(options)
 

data/lib/pwgen/version.rb

@@ -1,3 +1,3 @@
 module Pwgen
-    VERSION = '0.1.0'.freeze
+    VERSION = '1.0.0'.freeze
 end

data/pwgen.gemspec

@@ -21,7 +21,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.required_ruby_version = '>= 2.3.0'
+
+  spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
 

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: pwgen
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Tim Gurney aka Wolf
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-28 00:00:00.000000000 Z
+date: 2019-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -173,7 +173,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="