randpass 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cbb8602dd6f07d03f70be18df83861597616e0f3c71608cafe2f4b5453857879
-  data.tar.gz: 93948d8bebdf6d8fbcbb7e8c36ac196e2b4bc210cdade6016d624f90f45b024a
+  metadata.gz: ff3fc4f874b2494d17acd4781ead4b775d83f5498258e77ccea97bfeae90ab00
+  data.tar.gz: 015f7ae1c0567a0c403e31447c6f2f4ce63342128a9e9da6b41da95c3930ef22
 SHA512:
-  metadata.gz: b08fa98c352f7de784e226ff7e3fbc6dff57ee6937113300386767e6557d407547591b971fb2492d58f3c6f68197c7acfc8a1a031dce99ff8d8e8c9469945d65
-  data.tar.gz: f8b505b3194cab5340894203b38d0e7dd379445c714bb9049cb56d732bb8ba9e477a54a26be1024a841ee4cfb049122dcae9b74062a64d24f6ec9c1475ab6958
+  metadata.gz: 9a6e5995afa0b9eb6ffa5b0973587f925b2989a1beed08d7a2bd1681266288c18a06d146964f829fd5f9b6acdacb6768c2e47adacb5d15f1bbccb98c607d0d60
+  data.tar.gz: 8320a134f57d210ee2e47e87571dfa3937e903d9c8dd2c0225e017a2d89cbdd695bc07cf3c5440b5eadbc148c09a868bdb73a146f14322d08a0069306fd1ab49

data/README.md

@@ -1,17 +1,10 @@
-### UNDER DEVELOPMENT
-
-# Randpass
-
-V-0.2.0:
-  - copy password in clipboard
-  - add storage module
-
+# Randpass v0.3.0
 
 Ruby random password generator.  
-Generate password and copy in clipboard, or generate list and save as `.txt` file.  
+Generate password and copy in clipboard, or generate list and/or save it as `.txt` file.  
 File is saved as plain text, it is up to end-user to decide how to secure it.  
 
-Password is generated with `SecureRandom#base64` and a few special characters `! # * $ % _ @`  
+Password is generated with `SecureRandom#base64` and a few (random) special characters `! # * $ % _ @`  
 
 
 ## Dependencies
@@ -24,25 +17,41 @@ Setup script will check and install `xsel` if nothing is found.
 
  Use from terminal:  
 
+ When generating a single password, you don't need any argument, or you can add number of password characters (default is 25). By default, password is printed in STDOUT and copied to clipboard, but not saved as file.  
+
  - generate password with 25 characters  
    `randpass`  
 
  - generate password with 30 characters  
    `randpass 30`  
+   `randpass --char 30`
 
  - clear clipboard  
-   `randpass -c`  
+   `randpass -k`  
+   `randpass --clear`  
+
+ - add `-c` or `--noc` to disable clipboard copy  
+    `randpass 35 -c`  
+
+ - add `-p` or `--nop` to disable STDOUT  
+    `randpass 20 -p`  
+
+ When generating a list of passwords, you need to supply `-n` or `--char` to set number of password characters (default is 25). Passwords will be saved in a current working directory (unless otherwise specified) in format `randpass_#{Time.now.to_i}.txt`. This way we avoid overwrite, and it's possible to get time of file generation with `Time.at TIME_INTEGER`  
 
  - generate password list from comments (20 characters long password)  
-    `randpass -n 20 -l password1 password2 password3`  
+    `randpass -n 20 -l GitHub RubyGems AnotherWebSite`  
 
  - generate password list with 10 passwords - without comments  
     `randpass -r 10`  
-    `randpass -n 20 -r 10`
+    `randpass -n 20 -r 10`  
+
+ - add `-s` or `--nos` to disable saving list as a file  
+    `randpass -n 20 -r 5 -s` 
+    `randpass -r 10 --nos --noc`  
+
+ - add `-d` or `--dir` as location to store password list  
+    `randpass -r 10 -d 'my_path/directory'`  
 
- - add `--noc` and/or `--nop` to diasable copy and stdout, respectively  
-    `randpass 35 --noc`  
-    `randpass -r 10 --noc --nop`  
 
 
 ## How to install
@@ -50,26 +59,25 @@ Setup script will check and install `xsel` if nothing is found.
  - install from rubygems
 
 ```
-gem install randpass && randpass -s
+gem install randpass && randpass -i
 ```
  - download from github with ssh
 
 ```
 git clone git@github.com:alx3dev/randpass \
-cd randpass && bin/setup
+cd randpass && randpass -i
 ```
  - download from github with https
 
 ```
 git clone https://www.github.com/alx3dev/randpass \
-cd randpass && bin/setup
-```
-
-To build your own gem, run `rake bundle`, and install it locally with `gem install pkg/randpass-0.2.0.gem`
+cd randpass && randpass -i
+```  
 
 
 Tested on:
  - ruby `2.7.5`
  - ruby `3.0.3`
- - ruby `3.1.0-preview1`
+ - ruby `3.1.0`
+ - ruby `3.1.3`
  - jruby `9.3.2.0`

data/bin/{options.rb → output.rb}

@@ -2,23 +2,28 @@ require_relative '../lib/randpass/version' unless defined? Randpass::VERSION
 
 require 'optimist'
 
+# Check if password should be printed and/or copied
+module Output
+  # @param [String] pass **Required**. Password
+  def self.[](txt)
+    txt = txt.join("\n") if txt.is_a?(Array)
+    STDOUT.puts(txt) unless Randpass.noprint?
+    Clipboard.copy(txt) unless Randpass.nocopy?
+  end
+end
+
 BANNER =
   <<~DESC
     randpass
-      >> generate 25 chars long password
-
     randpass 33
-      >> generate 33 chars long password
-
-    ----------------------------------------
+    randpass -n 25 -r 5 --dir 'output/directory'
+    :
   DESC
 
 SETUP_DESCRIPTION =
   <<~DESC
     Install gem dependencies
       xsel or xclip on linux (for clipboard manipulation)
-
-    ----------------------------------------
   DESC
 
 NUMBER_DESCRIPTION =
@@ -26,7 +31,7 @@ NUMBER_DESCRIPTION =
     Number of password characters
       randpass -n 20 -l github rubygems
 
-    ----------------------------------------
+    ----------------------------------
   DESC
 
 LIST_DESCRIPTION =
@@ -34,7 +39,7 @@ LIST_DESCRIPTION =
     Save list of passwords for given comments
       randpass -l GitHub GitLab StackOverflow
 
-    ----------------------------------------
+    ----------------------------------
   DESC
 
 RANDOM_DESCRIPTION =
@@ -43,7 +48,13 @@ RANDOM_DESCRIPTION =
       randpass -r 5
       randpass -r 5 -n 25
 
-    ----------------------------------------
+    ----------------------------------
+  DESC
+
+PATH_DESCRIPTION =
+  <<~DESC
+    Path to directory where to save password list
+      default: gem directory
   DESC
 
 CLIPBOARD_DESCRIPTION =
@@ -53,19 +64,15 @@ CLIPBOARD_DESCRIPTION =
 
 NO_COPY_DESCRIPTION =
   <<~DESC
-    Do not copy password into clipboard
+    Do not copy password to clipboard
   DESC
 
 NO_PRINT_DESCRIPTION =
   <<~DESC
-    Do not print output in stdout
+    Do not print output to stdout
   DESC
 
-  
-module Output
-
-  def self.[](txt)
-    STDOUT.puts(txt) unless Randpass.noprint?
-    Clipboard.copy(txt) unless Randpass.nocopy?
-  end
-end
+NO_SAVE_DESCRIPTION =
+  <<~DESC
+    Do not save list output as txt file
+  DESC

data/bin/randpass

@@ -1,67 +1,67 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require_relative './options'
+require_relative 'output'
+require_relative 'setup_gem'
 
 opts = Optimist.options do
-
   banner BANNER
 
-  opt :setup,   SETUP_DESCRIPTION,      short: 's', long: 'gem-setup'
-  opt :num,     NUMBER_DESCRIPTION,     short: 'n', long: 'no',       type: :integer
+  opt :num,     NUMBER_DESCRIPTION,     short: 'n', long: 'char',     type: :integer
   opt :list,    LIST_DESCRIPTION,       short: 'l', long: 'list',     type: :strings
   opt :random,  RANDOM_DESCRIPTION,     short: 'r', long: 'random',   type: :integer
-  opt :clear,   CLIPBOARD_DESCRIPTION,  short: 'c', long: 'clear',    default: false
-  opt :nocopy,  NO_COPY_DESCRIPTION,    short: 'd', long: 'noc',      default: false
-  opt :noprint, NO_PRINT_DESCRIPTION,   short: 'o', long: 'nop',      default: false
+  opt :path,    PATH_DESCRIPTION,       short: 'd', long: 'dir',      type: :string
+  opt :clear,   CLIPBOARD_DESCRIPTION,  short: 'k', long: 'clear',    default: false
+  opt :nocopy,  NO_COPY_DESCRIPTION,    short: 'c', long: 'noc',      default: false
+  opt :noprint, NO_PRINT_DESCRIPTION,   short: 'p', long: 'nop',      default: false
+  opt :nosave,  NO_SAVE_DESCRIPTION,    short: 's', long: 'nos',      default: false
+
+  opt :setup,   SETUP_DESCRIPTION,      short: 'i', long: 'gem-install'
 
-  version "Randpass #{Randpass::VERSION}"
+  version "Randpass version #{Randpass::VERSION}"
 end
 
 if opts[:setup]
 
-  dir = File.expand_path(__FILE__).gsub('/bin/randpass', '')
-  Dir.chdir dir
-  system 'bin/setup'
+  UserOS.gem_init
   exit(1)
 
 else
   require_relative '../lib/randpass'
   require 'clipboard'
 
-
   (Clipboard.clear && exit(1)) if opts[:clear]
 
-  Randpass.nocopy! if opts[:nocopy]
+  Randpass.path = opts[:path] if opts[:path]
+
+  Randpass.nocopy!  if opts[:nocopy]
+  Randpass.nosave!  if opts[:nosave]
   Randpass.noprint! if opts[:noprint]
 
-  case
-  when opts[:num] && opts[:random]
-    Randpass.generate_list opts[:num], list: opts[:random]
+  if opts[:list] && opts[:num]
+    Randpass.generate_list opts[:num].to_i, comments: opts[:list]
     Output[Randpass.storage]
-    exit(1)
 
-  when opts[:random]
-    Randpass.generate_list nil, list: opts[:random]
+  elsif opts[:list]
+    Randpass.generate_list nil, comments: opts[:list]
     Output[Randpass.storage]
-    exit(1)
 
-  when opts[:list] && opts[:num]
-    Randpass.generate_list opts[:num].to_i, comments: opts[:list]
+  elsif opts[:num] && opts[:random]
+    Randpass.generate_list opts[:num], list: opts[:random]
     Output[Randpass.storage]
-    exit(1)
 
-  when opts[:list]
-    Randpass.generate_list nil, comments: opts[:list]
+  elsif opts[:random]
+    Randpass.generate_list nil, list: opts[:random]
     Output[Randpass.storage]
-    exit(1)
 
-  when ARGV.empty?
-    Output[Randpass[20]] && exit(1)
-    exit(1)
+  elsif opts[:num]
+    Output[Randpass[opts[:num]]]
+
+  elsif ARGV.empty?
+    Output[Randpass[20]]
 
-  when ARGV.size == 1
+  elsif ARGV.size == 1
     Output[Randpass[ARGV[0].to_i]]
-    exit(1)
   end
-end
+
+end # if opts[:setup]

data/bin/setup

@@ -3,31 +3,22 @@ set -euo pipefail
 IFS=$'\n\t'
 
 function install_clipboard_dependency() {
-
   if !(command -v xsel) >/dev/null 2>&1; then
-
-    echo "xsel was not found on the system, looking for xclip..."
+    echo "Xsel was not found on the system..."
 
     if !(command -v xclip) >/dev/null 2>&1; then
-
-      echo "xclip also not found, installing xsell..."
+      echo "Xclip also not found, installing Xsell..."
+      sudo apt update -y -qq
       sudo apt install xsel -y
 
     else
-      echo "but xclip was"
+      echo "but Xclip was"
     fi
-    
+
   else
-    echo "xsel found on the system"
+    echo "Xsel found on the system"
   fi
 }
 
-echo -e -n "Type 'w' if you are on Windows system, otherwise press enter: "
-read linux_key
-
-if [ "$linux_key" == "w" ] || [ "$linux_key" == "W" ]; then
-  bundle install
-else
-  install_clipboard_dependency
-  bundle install
-fi
+install_clipboard_dependency
+bundle install

data/bin/setup_gem.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+# Helper module for gem installation
+module UserOS
+  GEM_ROOT = File.expand_path(__FILE__).gsub('/bin/setup_gem.rb', '')
+
+  class << self
+    def windows?
+      (/cygwin|mswin|mingw|bccwin|wince|emx/ =~ RUBY_PLATFORM) != nil
+    end
+
+    def mac?
+      (/darwin/ =~ RUBY_PLATFORM) != nil
+    end
+
+    def linux?
+      !windows? && !mac?
+    end
+
+    # Call setup script based on user OS, if randpass is not installed
+    def gem_init
+      if system('bin/randpass --version')
+        puts 'was found on the system'
+        return
+      end
+      Dir.chdir GEM_ROOT
+      linux? ? system('bin/setup') : system('bundle install')
+    end
+  end
+end

data/lib/randpass/random.rb

@@ -2,32 +2,16 @@
 
 require 'securerandom'
 
-# Generate random password with SecureRandom#base64 and a few
-# random special characters. Method #randpass is defined as
-# class and instance method, so you can call it or include it.
-#
 module Randpass
-
-  # Allowed specials. xxx is just a flag for #add_special_chars
+  # Allowed specials (xxx is just a skip-flag)
   ARRAY = %w[! # * $ % _ @ xxx].freeze
 
-  # Random number of times try to add random special character.
-  # Transform to array, shuffle, and join back to string.
-  #
-  # Provide number of characters for password as argument,
-  # default value is **25**.
-  #
-  # @param [Integer] chars_no Optional. Number of password characters.
-  # @return [String]
-  #
-  def randpass(chars_no = nil)
-    Randpass[chars_no]
-  end
-
-
   class << self
-
+    # Generate random password
+    #
+    # @param  [Integer] chars_no Optional. Number of password characters. Default: 25.
     # @return [String]
+    #
     def randpass(chars_no = nil)
 
       chars_no = 25 if [nil, 0, 1].include?(chars_no)

data/lib/randpass/storage.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'tempfile'
 require 'fileutils'
 
 module Randpass
@@ -9,22 +8,30 @@ module Randpass
 
     attr_accessor :path
 
-    FILE_PATH = File.expand_path(__FILE__).gsub('/lib/randpass/storage.rb', '')
-
-    # Add password to file
-    # @param [String] pass **Required**. Add password to list
-    # @param [String] comm Optional. Comment to write with password
+    # Add password to list
+    # @param [String] pass **Required**. Password
+    # @param [String] comm Optional. Password comment
     #
     def add(pass, comm = nil)
-      storage_init unless @initialized
-      @temp << "#{comm}: " unless comm.nil?
-      @temp << pass
-      @temp << "\n"
+      reload unless @initialized
+      line = comm.nil? ? pass : "#{comm}: #{pass}"
+      @temp << line
     end
-    
-    # Write list as .txt file
+
+    # Clear old password list
+    def reload
+      @path ||= Dir.pwd
+      @temp = Array.new
+      @initialized = true
+    end
+
+    # Save list of passwords as txt file
     def finalize
-      File.write "#{@path}/randpass_#{Time.now.to_i}.txt", @temp
+      unless Randpass.nosave?
+        temp = @temp.join "\n"
+        @path += '/' unless @path.end_with?('/')
+        File.write "#{@path}randpass_#{Time.now.to_i}.txt", temp
+      end
       @initialized = false
     end
 
@@ -37,8 +44,6 @@ module Randpass
     # @option opts [Integer] list Number of passwords to generate (if no comments)
     #
     def generate_list(chars_no, opts = {list: 10})
-      storage_init unless initialized?
-
       if opts[:comments].nil?
         opts[:list].times do
           add Randpass[chars_no]
@@ -62,13 +67,5 @@ module Randpass
 
     def initialized?; @initialized == true end
 
-    def storage_init
-      @path ||= FILE_PATH
-      Dir.chdir @path
-      @temp = String.new
-      @initialized = true
-    end
-
-    alias :init_storage :storage_init
   end
-end
+end

data/lib/randpass/version.rb

@@ -2,5 +2,5 @@
 
 module Randpass
   # gem version
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/lib/randpass.rb

@@ -4,31 +4,41 @@ require_relative 'randpass/version'
 require_relative 'randpass/random'
 require_relative 'randpass/storage'
 
+# Generate random password with SecureRandom#base64 and a few
+# special characters.
+#
 module Randpass
 
   class << self
 
-    @output = true
-    @copy = true
-
-
+    # Check if password(s) will be copied to clipboard
     def nocopy?
       @copy == false
     end
 
-
+    # Disable password(s) copy (affect only executable)
     def nocopy!
       @copy = false
     end
 
-
+    # Check if password(s) will be printed to STDOUT
     def noprint?
       @output == false
     end
 
-
+    # Do not print password(s) to STDOUT (affect only executable)
     def noprint!
       @output = false
     end
+
+    # Check if password list will be saved as txt file.
+    def nosave?
+      @save == false
+    end
+
+    # Do not save password list as txt file.
+    def nosave!
+      @save = false
+    end
   end
 end

data/randpass.gemspec

@@ -7,9 +7,8 @@ Gem::Specification.new do |s|
   s.version     = Randpass::VERSION
   s.summary     = 'Ruby random password generator'
   s.description = <<~DESCRIPTION
-    Generate single password or list, with or without comments,
-    and copy password in clipboard (or not). Password is generated with
-    SecureRandom#base64 + random special characters.
+    Ruby random password generator. Allow single password or list, comments,
+    use of clipboard and/or STDOUT.
   DESCRIPTION
 
   s.license = 'MIT'
@@ -31,7 +30,8 @@ Gem::Specification.new do |s|
                 lib/randpass/version.rb
                 lib/randpass/random.rb
                 lib/randpass/storage.rb
-                bin/options.rb
+                bin/setup_gem.rb
+                bin/output.rb
                 bin/setup
                 LICENSE
                 README.md

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: randpass
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - alx3dev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-15 00:00:00.000000000 Z
+date: 2022-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clipboard
@@ -67,9 +67,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '13.0'
 description: |
-  Generate single password or list, with or without comments,
-  and copy password in clipboard (or not). Password is generated with
-  SecureRandom#base64 + random special characters.
+  Ruby random password generator. Allow single password or list, comments,
+  use of clipboard and/or STDOUT.
 email:
 executables:
 - randpass
@@ -78,9 +77,10 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
-- bin/options.rb
+- bin/output.rb
 - bin/randpass
 - bin/setup
+- bin/setup_gem.rb
 - lib/randpass.rb
 - lib/randpass/random.rb
 - lib/randpass/storage.rb
@@ -94,7 +94,7 @@ metadata:
   source_code_uri: https://github.com/alx3dev/randpass
   bug_tracker_uri: https://github.com/alx3dev/randpass/issues
   changelog_uri: https://github.com/alx3dev/randpass/changelog.md
-  documentation_uri: https://rubydoc.info/gems/randpass/0.2.0
+  documentation_uri: https://rubydoc.info/gems/randpass/0.3.0
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
@@ -114,7 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: Ruby random password generator