password_util 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 585b4336af1d3cc4191a8f5ae5e5fa9f820dcc28aaaa6e4c4d90215436825c51
-  data.tar.gz: c553b39e03316a0882d05daac8463b8c75779ab2ef2dc99a4bc27d84cf8cb33f
+  metadata.gz: 4af24e1ec068268a89fcafaf6a05f968ac9f1128bbb8cbf805c13c76344bdd4a
+  data.tar.gz: 8f8056f8479dde813d25628a799400c6a0b1cbc17ac436529b176159c6f7675b
 SHA512:
-  metadata.gz: 3cd8c25a9a87be821e22fd6eaf68ba8742531c44a955f4ad69c3036da41359f1f6e91afc987ca4b9d2d8b290047962a9e695232689f8d1a30268622c55ed54fe
-  data.tar.gz: d8fa4ca0218c83b99d321328f9b35e08c1c89330c32f39163a7d735e30f3ace975ac01ca18000f7bc474456356950b9b3e0a46522495bcb1a4a9c3c7eb22d0c4
+  metadata.gz: 895f0bdd59d36c6b4b7aabc5790bda344bde777074ca12eeea46cf4e4d14ddb5c43ef4226b1e9c01047283dbd19a46fe420560cd017f777e056bfdd7d4210710
+  data.tar.gz: 2af852bfde063c96556a7f818500b5ee6ca01ed972d91dfdcf8eed4b033dae5fb07b348d0138d58e133063d28d02d852ff7eadff170afcd80ccde41cb0b6fc7a

data/bin/password_util

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+require 'password_util'
+
+password_length = ENV['LENGTH']
+has_upper_letters = ENV['UPPER_LETTERS']
+has_lower_letters = ENV['LOWER_LETTERS']
+has_numbers = ENV['NUMBERS']
+has_symbols = ENV['SYMBOLS']
+
+PasswordUtil.password_length = password_length.to_i if password_length.to_s =~ /\A\d+\z/
+PasswordUtil.has_upper_letters = has_upper_letters == 1 if has_upper_letters.to_s =~ /\A(?:0|1)\z/
+PasswordUtil.has_lower_letters = has_lower_letters == 1 if has_lower_letters.to_s =~ /\A(?:0|1)\z/
+PasswordUtil.has_numbers = has_numbers == 1 if has_numbers.to_s =~ /\A(?:0|1)\z/
+PasswordUtil.has_symbols = has_symbols == 1 if has_symbols.to_s =~ /\A(?:0|1)\z/
+
+puts PasswordUtil.generate

data/lib/password_util.rb

@@ -1,4 +1,6 @@
 module PasswordUtil
+  ##
+  # Configuration exception.
   class ConfigurationError < StandardError; end
 
   UPPER_LETTERS = ('A'..'Z').to_a.freeze
@@ -6,6 +8,10 @@ module PasswordUtil
   NUMBERS = ('0'..'9').to_a.freeze
   SYMBOLS = %w[~ ` ! @ # $ % ^ & * ( ) _ - + = { \[ } \] | \\ : ; " ' < , > . ? /].freeze
 
+  ##
+  # Validates configuration.
+  #
+  # @return [String] the generated password
   def self.validate_config!
     boolean_classes = [TrueClass, FalseClass]
 
@@ -22,6 +28,8 @@ module PasswordUtil
     raise ConfigurationError, 'No usable character set.' unless has_lower_letters || has_upper_letters || has_numbers || has_symbols
   end
 
+  ##
+  # Resets configuration to default.
   def self.reset_config
     self.password_length = 8
     self.has_lower_letters = true
@@ -34,6 +42,10 @@ module PasswordUtil
     self.min_symbols = 1
   end
 
+  ##
+  # Generates password.
+  #
+  # @return [String] the generated password
   def self.generate
     validate_config!
     charset = []

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: password_util
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Reinier John Avila
@@ -10,12 +10,14 @@ bindir: bin
 cert_chain: []
 date: 2022-11-01 00:00:00.000000000 Z
 dependencies: []
-description: Different password related utility tool.
+description: Utility tool to generate password.
 email: reinieravila@gmail.com
-executables: []
+executables:
+- password_util
 extensions: []
 extra_rdoc_files: []
 files:
+- bin/password_util
 - lib/password_util.rb
 homepage: https://github.com/reinieravila/password_util.git
 licenses:
@@ -39,5 +41,5 @@ requirements: []
 rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
-summary: Password Utility Tool
+summary: Password Generation Utility Tool
 test_files: []