randpass 0.1.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56fe4a3d0922ef73687911332685af59657369380b77514e533ede43854cee86
-  data.tar.gz: 6f9adf346eb9fc6339964201aee71563ec41ce7b3c68b8e4a82fbaa90c94e924
+  metadata.gz: ff3fc4f874b2494d17acd4781ead4b775d83f5498258e77ccea97bfeae90ab00
+  data.tar.gz: 015f7ae1c0567a0c403e31447c6f2f4ce63342128a9e9da6b41da95c3930ef22
 SHA512:
-  metadata.gz: 938d2f69909daca1f9488c8ea23837a29caa25a995039a7b526e6a1d9c5ce66035fde1a62135544f52950028e55c952cc8b8aa077f8ed4b68d9521a5c914ba15
-  data.tar.gz: b7ec2a62282de7423cc955b4073fd0acf9a43dc7494721a6bc7b111a753557de8b5bac6b9b90e71a947f633f5285bc579549329a139b3e8b554d6040d568dc5e
+  metadata.gz: 9a6e5995afa0b9eb6ffa5b0973587f925b2989a1beed08d7a2bd1681266288c18a06d146964f829fd5f9b6acdacb6768c2e47adacb5d15f1bbccb98c607d0d60
+  data.tar.gz: 8320a134f57d210ee2e47e87571dfa3937e903d9c8dd2c0225e017a2d89cbdd695bc07cf3c5440b5eadbc148c09a868bdb73a146f14322d08a0069306fd1ab49

data/README.md

@@ -1,71 +1,83 @@
-# Randpass
+# Randpass v0.3.0
+
+Ruby random password generator.  
+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 (random) special characters `! # * $ % _ @`  
+
+
+## Dependencies
+
+Randpass use _clipboard-gem_, that require `xsel` or `xclip` on Linux systems.  
+Setup script will check and install `xsel` if nothing is found.
+
+
+## How to use:
+
+ 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 -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 GitHub RubyGems AnotherWebSite`  
+
+ - generate password list with 10 passwords - without comments  
+    `randpass -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'`  
+
 
-Create random password with ruby. Use `SecureRandom#base64` + few random special characters.
 
 ## How to install
 
  - install from rubygems
 
 ```
-gem install randpass
+gem install randpass && randpass -i
 ```
  - download from github with ssh
 
 ```
 git clone git@github.com:alx3dev/randpass \
-cd randpass && bundle install
+cd randpass && randpass -i
 ```
  - download from github with https
 
 ```
 git clone https://www.github.com/alx3dev/randpass \
-cd randpass && bundle install
-```
-
-To build your own gem, run `rake bundle`, and install it locally with `gem install pkg/randpass-0.1.3.gem`
+cd randpass && randpass -i
+```  
 
-## How to use:
-
- - use from terminal
-
-```
-# default 22 characters
-randpass
- => W4fkGVdXx6pzk$O?VP11!wWs
-
-# or add number of characters as argument
-randpass 33
- => etkK$YW1R_PXK8FsjnGHr+%w2cTBbMTOTej3s8je?2ya
- 
- # install from rubygems, or build your own version, otherwise you need to run:
- bin/randpass
-```
- - use as library
-
-```ruby
-require 'randpass'
-
-Randpass[20]
-# or
-Randpass.randpass 20
- => "1L3Jk$S850Np=ikQ7zeqb44qaBC9"
-```
-
-Randpass is a module with both class and instance methods `#randpass`, so you can include/extend it in your class.
-
-```ruby
-require 'randpass'
-include Randpass
-
-class MyClass
-  def some_method
-    random_string = randpass 33
-  end
-end
-```
 
 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/output.rb

@@ -0,0 +1,78 @@
+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
+    randpass 33
+    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 =
+  <<~DESC
+    Number of password characters
+      randpass -n 20 -l github rubygems
+
+    ----------------------------------
+  DESC
+
+LIST_DESCRIPTION =
+  <<~DESC
+    Save list of passwords for given comments
+      randpass -l GitHub GitLab StackOverflow
+
+    ----------------------------------
+  DESC
+
+RANDOM_DESCRIPTION =
+  <<~DESC
+    Save list of passwords (number of passwords to generate)
+      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 =
+  <<~DESC
+    Empty clipboard
+  DESC
+
+NO_COPY_DESCRIPTION =
+  <<~DESC
+    Do not copy password to clipboard
+  DESC
+
+NO_PRINT_DESCRIPTION =
+  <<~DESC
+    Do not print output to stdout
+  DESC
+
+NO_SAVE_DESCRIPTION =
+  <<~DESC
+    Do not save list output as txt file
+  DESC

data/bin/randpass

@@ -1,14 +1,67 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require_relative '../lib/randpass'
+require_relative 'output'
+require_relative 'setup_gem'
 
-pass = if ARGV.empty?
-         Randpass[22]
-       else
-         Randpass.randpass ARGV[0].to_i
-       end
+opts = Optimist.options do
+  banner BANNER
 
-# @todo Add clipboard gem
-# Clipboard.copy pass
-puts pass
+  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 :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 version #{Randpass::VERSION}"
+end
+
+if opts[:setup]
+
+  UserOS.gem_init
+  exit(1)
+
+else
+  require_relative '../lib/randpass'
+  require 'clipboard'
+
+  (Clipboard.clear && exit(1)) if opts[:clear]
+
+  Randpass.path = opts[:path] if opts[:path]
+
+  Randpass.nocopy!  if opts[:nocopy]
+  Randpass.nosave!  if opts[:nosave]
+  Randpass.noprint! if opts[:noprint]
+
+  if opts[:list] && opts[:num]
+    Randpass.generate_list opts[:num].to_i, comments: opts[:list]
+    Output[Randpass.storage]
+
+  elsif opts[:list]
+    Randpass.generate_list nil, comments: opts[:list]
+    Output[Randpass.storage]
+
+  elsif opts[:num] && opts[:random]
+    Randpass.generate_list opts[:num], list: opts[:random]
+    Output[Randpass.storage]
+
+  elsif opts[:random]
+    Randpass.generate_list nil, list: opts[:random]
+    Output[Randpass.storage]
+
+  elsif opts[:num]
+    Output[Randpass[opts[:num]]]
+
+  elsif ARGV.empty?
+    Output[Randpass[20]]
+
+  elsif ARGV.size == 1
+    Output[Randpass[ARGV[0].to_i]]
+  end
+
+end # if opts[:setup]

data/bin/setup

@@ -0,0 +1,24 @@
+#!/usr/bin/env bash
+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..."
+
+    if !(command -v xclip) >/dev/null 2>&1; then
+      echo "Xclip also not found, installing Xsell..."
+      sudo apt update -y -qq
+      sudo apt install xsel -y
+
+    else
+      echo "but Xclip was"
+    fi
+
+  else
+    echo "Xsel found on the system"
+  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,21 @@
 
 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 **22**.
-  #
-  # @param [Integer] number_of_chars Optional. Number of password characters.
-  # @return [String]
-  #
-  def randpass(number_of_chars = nil)
-    Randpass[number_of_chars]
-  end
-
   class << self
+    # Generate random password
+    #
+    # @param  [Integer] chars_no Optional. Number of password characters. Default: 25.
     # @return [String]
-    def randpass(number_of_chars = 20)
-      # slice string made with base64, to number of characters we want
-      param = SecureRandom.base64(number_of_chars)[0...number_of_chars]
+    #
+    def randpass(chars_no = nil)
+
+      chars_no = 25 if [nil, 0, 1].include?(chars_no)
+
+      param = SecureRandom.base64(chars_no)[0...chars_no]
 
       rand(param.size / 2).times do
         param = add_special_characters(param)
@@ -38,6 +27,7 @@ module Randpass
 
     alias [] randpass
 
+
     private
 
     def add_special_characters(param)

data/lib/randpass/storage.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+
+module Randpass
+
+  class << self
+
+    attr_accessor :path
+
+    # Add password to list
+    # @param [String] pass **Required**. Password
+    # @param [String] comm Optional. Password comment
+    #
+    def add(pass, comm = nil)
+      reload unless @initialized
+      line = comm.nil? ? pass : "#{comm}: #{pass}"
+      @temp << line
+    end
+
+    # Clear old password list
+    def reload
+      @path ||= Dir.pwd
+      @temp = Array.new
+      @initialized = true
+    end
+
+    # Save list of passwords as txt file
+    def finalize
+      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
+
+    # Generate list of passwords, and save as plain txt.
+    #
+    # @param [Integer] chars_no **Required**. Number of password characters.
+    # @param [Hash] opts Optional. Options hash.
+    #
+    # @option opts [String] comment Add comment (name) with password.
+    # @option opts [Integer] list Number of passwords to generate (if no comments)
+    #
+    def generate_list(chars_no, opts = {list: 10})
+      if opts[:comments].nil?
+        opts[:list].times do
+          add Randpass[chars_no]
+        end
+      else
+        opts[:comments].each do |com|
+          add Randpass[chars_no], com
+        end
+      end
+
+      Randpass.finalize
+    end
+
+    # Access password list
+    def storage
+      @temp
+    end
+
+
+    private
+
+    def initialized?; @initialized == true end
+
+  end
+end

data/lib/randpass/version.rb

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

data/lib/randpass.rb

@@ -2,3 +2,43 @@
 
 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
+
+    # 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,8 +7,8 @@ Gem::Specification.new do |s|
   s.version     = Randpass::VERSION
   s.summary     = 'Ruby random password generator'
   s.description = <<~DESCRIPTION
-    Generate random password with SecureRandom#base64. Add random number
-    of random special characters, and shuffle it.
+    Ruby random password generator. Allow single password or list, comments,
+    use of clipboard and/or STDOUT.
   DESCRIPTION
 
   s.license = 'MIT'
@@ -29,12 +29,19 @@ Gem::Specification.new do |s|
   s.files = %w[ lib/randpass.rb
                 lib/randpass/version.rb
                 lib/randpass/random.rb
+                lib/randpass/storage.rb
+                bin/setup_gem.rb
+                bin/output.rb
+                bin/setup
                 LICENSE
                 README.md
                 randpass.gemspec]
 
   s.required_ruby_version = '>= 2.6', '< 3.2'
 
+  s.add_runtime_dependency 'clipboard', '~> 1.3'
+  s.add_runtime_dependency 'optimist', '~> 3.0.1'
+  
   s.add_development_dependency 'bundler', '~> 2.3'
   s.add_development_dependency 'rake', '~> 13.0'
 end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: randpass
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.3.0
 platform: ruby
 authors:
 - alx3dev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-23 00:00:00.000000000 Z
+date: 2022-12-22 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: clipboard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: optimist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -39,8 +67,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '13.0'
 description: |
-  Generate random password with SecureRandom#base64. Add random number
-  of random special characters, and shuffle it.
+  Ruby random password generator. Allow single password or list, comments,
+  use of clipboard and/or STDOUT.
 email:
 executables:
 - randpass
@@ -49,9 +77,13 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
+- bin/output.rb
 - bin/randpass
+- bin/setup
+- bin/setup_gem.rb
 - lib/randpass.rb
 - lib/randpass/random.rb
+- lib/randpass/storage.rb
 - lib/randpass/version.rb
 - randpass.gemspec
 homepage: https://github.com/alx3dev/randpass
@@ -62,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.1.3
+  documentation_uri: https://rubydoc.info/gems/randpass/0.3.0
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
@@ -82,7 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.6
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: Ruby random password generator