randpass 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56fe4a3d0922ef73687911332685af59657369380b77514e533ede43854cee86
-  data.tar.gz: 6f9adf346eb9fc6339964201aee71563ec41ce7b3c68b8e4a82fbaa90c94e924
+  metadata.gz: cbb8602dd6f07d03f70be18df83861597616e0f3c71608cafe2f4b5453857879
+  data.tar.gz: 93948d8bebdf6d8fbcbb7e8c36ac196e2b4bc210cdade6016d624f90f45b024a
 SHA512:
-  metadata.gz: 938d2f69909daca1f9488c8ea23837a29caa25a995039a7b526e6a1d9c5ce66035fde1a62135544f52950028e55c952cc8b8aa077f8ed4b68d9521a5c914ba15
-  data.tar.gz: b7ec2a62282de7423cc955b4073fd0acf9a43dc7494721a6bc7b111a753557de8b5bac6b9b90e71a947f633f5285bc579549329a139b3e8b554d6040d568dc5e
+  metadata.gz: b08fa98c352f7de784e226ff7e3fbc6dff57ee6937113300386767e6557d407547591b971fb2492d58f3c6f68197c7acfc8a1a031dce99ff8d8e8c9469945d65
+  data.tar.gz: f8b505b3194cab5340894203b38d0e7dd379445c714bb9049cb56d732bb8ba9e477a54a26be1024a841ee4cfb049122dcae9b74062a64d24f6ec9c1475ab6958

data/README.md

@@ -1,68 +1,72 @@
+### UNDER DEVELOPMENT
+
 # Randpass
 
-Create random password with ruby. Use `SecureRandom#base64` + few random special characters.
+V-0.2.0:
+  - copy password in clipboard
+  - add storage module
+
+
+Ruby random password generator.  
+Generate password and copy in clipboard, or generate list and save 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 `! # * $ % _ @`  
+
+
+## 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:  
+
+ - generate password with 25 characters  
+   `randpass`  
+
+ - generate password with 30 characters  
+   `randpass 30`  
+
+ - clear clipboard  
+   `randpass -c`  
+
+ - generate password list from comments (20 characters long password)  
+    `randpass -n 20 -l password1 password2 password3`  
+
+ - generate password list with 10 passwords - without comments  
+    `randpass -r 10`  
+    `randpass -n 20 -r 10`
+
+ - add `--noc` and/or `--nop` to diasable copy and stdout, respectively  
+    `randpass 35 --noc`  
+    `randpass -r 10 --noc --nop`  
+
 
 ## How to install
 
  - install from rubygems
 
 ```
-gem install randpass
+gem install randpass && randpass -s
 ```
  - download from github with ssh
 
 ```
 git clone git@github.com:alx3dev/randpass \
-cd randpass && bundle install
+cd randpass && bin/setup
 ```
  - download from github with https
 
 ```
 git clone https://www.github.com/alx3dev/randpass \
-cd randpass && bundle install
+cd randpass && bin/setup
 ```
 
-To build your own gem, run `rake bundle`, and install it locally with `gem install pkg/randpass-0.1.3.gem`
-
-## How to use:
-
- - use from terminal
+To build your own gem, run `rake bundle`, and install it locally with `gem install pkg/randpass-0.2.0.gem`
 
-```
-# 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`

data/bin/options.rb

@@ -0,0 +1,71 @@
+require_relative '../lib/randpass/version' unless defined? Randpass::VERSION
+
+require 'optimist'
+
+BANNER =
+  <<~DESC
+    randpass
+      >> generate 25 chars long password
+
+    randpass 33
+      >> generate 33 chars long password
+
+    ----------------------------------------
+  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
+
+CLIPBOARD_DESCRIPTION =
+  <<~DESC
+    Empty clipboard
+  DESC
+
+NO_COPY_DESCRIPTION =
+  <<~DESC
+    Do not copy password into clipboard
+  DESC
+
+NO_PRINT_DESCRIPTION =
+  <<~DESC
+    Do not print output in stdout
+  DESC
+
+  
+module Output
+
+  def self.[](txt)
+    STDOUT.puts(txt) unless Randpass.noprint?
+    Clipboard.copy(txt) unless Randpass.nocopy?
+  end
+end

data/bin/randpass

@@ -1,14 +1,67 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require_relative '../lib/randpass'
+require_relative './options'
 
-pass = if ARGV.empty?
-         Randpass[22]
-       else
-         Randpass.randpass ARGV[0].to_i
-       end
+opts = Optimist.options do
 
-# @todo Add clipboard gem
-# Clipboard.copy pass
-puts pass
+  banner BANNER
+
+  opt :setup,   SETUP_DESCRIPTION,      short: 's', long: 'gem-setup'
+  opt :num,     NUMBER_DESCRIPTION,     short: 'n', long: 'no',       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
+
+  version "Randpass #{Randpass::VERSION}"
+end
+
+if opts[:setup]
+
+  dir = File.expand_path(__FILE__).gsub('/bin/randpass', '')
+  Dir.chdir dir
+  system 'bin/setup'
+  exit(1)
+
+else
+  require_relative '../lib/randpass'
+  require 'clipboard'
+
+
+  (Clipboard.clear && exit(1)) if opts[:clear]
+
+  Randpass.nocopy! if opts[:nocopy]
+  Randpass.noprint! if opts[:noprint]
+
+  case
+  when opts[:num] && opts[:random]
+    Randpass.generate_list opts[:num], list: opts[:random]
+    Output[Randpass.storage]
+    exit(1)
+
+  when opts[:random]
+    Randpass.generate_list nil, list: opts[:random]
+    Output[Randpass.storage]
+    exit(1)
+
+  when opts[:list] && opts[:num]
+    Randpass.generate_list opts[:num].to_i, comments: opts[:list]
+    Output[Randpass.storage]
+    exit(1)
+
+  when opts[:list]
+    Randpass.generate_list nil, comments: opts[:list]
+    Output[Randpass.storage]
+    exit(1)
+
+  when ARGV.empty?
+    Output[Randpass[20]] && exit(1)
+    exit(1)
+
+  when ARGV.size == 1
+    Output[Randpass[ARGV[0].to_i]]
+    exit(1)
+  end
+end

data/bin/setup

@@ -0,0 +1,33 @@
+#!/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, looking for xclip..."
+
+    if !(command -v xclip) >/dev/null 2>&1; then
+
+      echo "xclip also not found, installing xsell..."
+      sudo apt install xsel -y
+
+    else
+      echo "but xclip was"
+    fi
+    
+  else
+    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

data/lib/randpass/random.rb

@@ -7,6 +7,7 @@ require 'securerandom'
 # 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
   ARRAY = %w[! # * $ % _ @ xxx].freeze
 
@@ -14,20 +15,24 @@ module Randpass
   # Transform to array, shuffle, and join back to string.
   #
   # Provide number of characters for password as argument,
-  # default value is **22**.
+  # default value is **25**.
   #
-  # @param [Integer] number_of_chars Optional. Number of password characters.
+  # @param [Integer] chars_no Optional. Number of password characters.
   # @return [String]
   #
-  def randpass(number_of_chars = nil)
-    Randpass[number_of_chars]
+  def randpass(chars_no = nil)
+    Randpass[chars_no]
   end
 
+
   class << self
+
     # @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 +43,7 @@ module Randpass
 
     alias [] randpass
 
+
     private
 
     def add_special_characters(param)

data/lib/randpass/storage.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require 'tempfile'
+require 'fileutils'
+
+module Randpass
+
+  class << self
+
+    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
+    #
+    def add(pass, comm = nil)
+      storage_init unless @initialized
+      @temp << "#{comm}: " unless comm.nil?
+      @temp << pass
+      @temp << "\n"
+    end
+    
+    # Write list as .txt file
+    def finalize
+      File.write "#{@path}/randpass_#{Time.now.to_i}.txt", @temp
+      @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})
+      storage_init unless initialized?
+
+      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
+
+    def storage_init
+      @path ||= FILE_PATH
+      Dir.chdir @path
+      @temp = String.new
+      @initialized = true
+    end
+
+    alias :init_storage :storage_init
+  end
+end

data/lib/randpass/version.rb

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

data/lib/randpass.rb

@@ -2,3 +2,33 @@
 
 require_relative 'randpass/version'
 require_relative 'randpass/random'
+require_relative 'randpass/storage'
+
+module Randpass
+
+  class << self
+
+    @output = true
+    @copy = true
+
+
+    def nocopy?
+      @copy == false
+    end
+
+
+    def nocopy!
+      @copy = false
+    end
+
+
+    def noprint?
+      @output == false
+    end
+
+
+    def noprint!
+      @output = false
+    end
+  end
+end

data/randpass.gemspec

@@ -7,8 +7,9 @@ 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.
+    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.
   DESCRIPTION
 
   s.license = 'MIT'
@@ -29,12 +30,18 @@ Gem::Specification.new do |s|
   s.files = %w[ lib/randpass.rb
                 lib/randpass/version.rb
                 lib/randpass/random.rb
+                lib/randpass/storage.rb
+                bin/options.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.2.0
 platform: ruby
 authors:
 - alx3dev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-23 00:00:00.000000000 Z
+date: 2022-12-15 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,9 @@ 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.
+  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.
 email:
 executables:
 - randpass
@@ -49,9 +78,12 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
+- bin/options.rb
 - bin/randpass
+- bin/setup
 - 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.2.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.3
 signing_key:
 specification_version: 4
 summary: Ruby random password generator