mpw 4.1.1 → 4.2.0

data/i18n/fr.yml

@@ -111,8 +111,10 @@ fr:
       login: "L'identifiant a été copié dans le presse papier"
       password: "Le mot de passe a été copié dans le presse papier pour 30s!"
       otp: "Le code OTP a été copié dans le presse papier il est valable %{time}s!"
+      url: "L'URL a été copié dans le presse papier"
       help:
          name: "Aide"
+         url: "Pressez <u> pour copier l'URL"
          login: "Pressez <l> pour copier l'identifiant"
          password: "Pressez <p> pour copier le mot de passe"
          otp_code: "Pressez <o> pour copier le code OTP"

data/lib/mpw/cli.rb

@@ -28,14 +28,13 @@ require 'mpw/mpw'
 
 module MPW
   class Cli
-    # Constructor
-    # @args: config -> the config
+    # @param config [Config]
     def initialize(config)
       @config = config
     end
 
     # Change a parameter int the config after init
-    # @args: options -> param to change
+    # @param options [Hash] param to change
     def set_config(options)
       @config.setup(options)
 
@@ -46,7 +45,7 @@ module MPW
     end
 
     # Change the wallet path
-    # @args: path -> the new path
+    # @param path [String] new path
     def set_wallet_path(path)
       @config.set_wallet_path(path, @wallet)
 
@@ -57,7 +56,7 @@ module MPW
     end
 
     # Create a new config file
-    # @args: options -> set param
+    # @param options [Hash]
     def setup(options)
       options[:lang] = options[:lang] || Locale::Tag.parse(ENV['LANG']).to_simple.to_s[0..1]
 
@@ -74,7 +73,7 @@ module MPW
     end
 
     # Setup a new GPG key
-    # @args: gpg_key -> the key name
+    # @param gpg_key [String] gpg key name
     def setup_gpg_key(gpg_key)
       return if @config.check_gpg_key?
 
@@ -106,7 +105,7 @@ module MPW
         'lang'           => @config.lang,
         'gpg_key'        => @config.gpg_key,
         'default_wallet' => @config.default_wallet,
-        'config_dir'     => @config.config_dir,
+        'wallet_dir'     => @config.wallet_dir,
         'pinmode'        => @config.pinmode,
         'gpg_exe'        => @config.gpg_exe
       }
@@ -127,20 +126,28 @@ module MPW
 
     # Request the GPG password and decrypt the file
     def decrypt
-      unless defined?(@mpw)
-        @password = ask(I18n.t('display.gpg_password')) { |q| q.echo = false }
-        @mpw      = MPW.new(@config.gpg_key, @wallet_file, @password, @config.gpg_exe, @config.pinmode)
-      end
+      if defined?(@mpw)
+        @mpw.read_data
+      else
+        begin
+          @mpw = MPW.new(@config.gpg_key, @wallet_file, nil, @config.gpg_exe, @config.pinmode)
+
+          @mpw.read_data
+        rescue
+          @password = ask(I18n.t('display.gpg_password')) { |q| q.echo = false }
+          @mpw      = MPW.new(@config.gpg_key, @wallet_file, @password, @config.gpg_exe, @config.pinmode)
 
-      @mpw.read_data
+          @mpw.read_data
+        end
+      end
     rescue => e
       puts "#{I18n.t('display.error')} #11: #{e}".red
       exit 2
     end
 
     # Format list on a table
-    # @args: title -> the name of table
-    #        list -> array or hash
+    # @param title [String] name of table
+    # @param list  an array or hash
     def table_list(title, list)
       length = { k: 0, v: 0 }
 
@@ -172,7 +179,7 @@ module MPW
     end
 
     # Format items on a table
-    # @args: items -> an aray items
+    # @param items [Array]
     def table_items(items = [])
       group        = '.'
       i            = 1
@@ -180,16 +187,19 @@ module MPW
       data         = { id:       { length: 3,  color: 'cyan' },
                        host:     { length: 9,  color: 'yellow' },
                        user:     { length: 7,  color: 'green' },
-                       protocol: { length: 9,  color: 'white' },
-                       port:     { length: 5,  color: 'white' },
                        otp:      { length: 4,  color: 'white' },
                        comment:  { length: 14, color: 'magenta' } }
 
       items.each do |item|
         data.each do |k, v|
-          next if k == :id || k == :otp
-
-          v[:length] = item.send(k.to_s).to_s.length + 3 if item.send(k.to_s).to_s.length >= v[:length]
+          case k
+          when :id, :otp
+            next
+          when :host
+            v[:length] = item.url.length + 3 if item.url.length >= v[:length]
+          else
+            v[:length] = item.send(k.to_s).to_s.length + 3 if item.send(k.to_s).to_s.length >= v[:length]
+          end
         end
       end
       data[:id][:length] = items.length.to_s.length + 2 if items.length.to_s.length > data[:id][:length]
@@ -232,16 +242,22 @@ module MPW
         data.each do |k, v|
           next if k == :id
 
-          if k == :otp
-            print '| '
+          print '| '
+
+          case k
+          when :otp
             item.otp ? (print ' X  ') : 4.times { print ' ' }
 
-            next
-          end
+          when :host
+            print "#{item.protocol}://".light_black if item.protocol
+            print item.host.send(v[:color])
+            print ":#{item.port}".light_black if item.port
+            (v[:length] - item.url.to_s.length).times { print ' ' }
 
-          print '| '
-          print item.send(k.to_s).to_s.send(v[:color])
-          (v[:length] - item.send(k.to_s).to_s.length).times { print ' ' }
+          else
+            print item.send(k.to_s).to_s.send(v[:color])
+            (v[:length] - item.send(k.to_s).to_s.length).times { print ' ' }
+          end
         end
         print "\n"
 
@@ -252,7 +268,7 @@ module MPW
     end
 
     # Display the query's result
-    # @args: options -> the option to search
+    # @param options [Hash] the options to search
     def list(**options)
       result = @mpw.list(options)
 
@@ -264,8 +280,8 @@ module MPW
     end
 
     # Get an item when multiple choice
-    # @args: items -> array of items
-    # @rtrn: item
+    # @param items [Array] list of items
+    # @return [Item] an item
     def get_item(items)
       return items[0] if items.length == 1
 
@@ -276,8 +292,8 @@ module MPW
     end
 
     # Copy in clipboard the login and password
-    # @args: item -> the item
-    #        clipboard -> enable clipboard
+    # @param item [Item]
+    # @param clipboard [Boolean] enable clipboard
     def clipboard(item, clipboard = true)
       # Security: force quit after 90s
       Thread.new do
@@ -292,6 +308,14 @@ module MPW
         when 'q', 'quit'
           break
 
+        when 'u', 'url'
+          if clipboard
+            Clipboard.copy(item.url)
+            puts I18n.t('form.clipboard.url').green
+          else
+            puts item.url
+          end
+
         when 'l', 'login'
           if clipboard
             Clipboard.copy(item.user)
@@ -324,6 +348,7 @@ module MPW
 
         else
           puts "----- #{I18n.t('form.clipboard.help.name')} -----".cyan
+          puts I18n.t('form.clipboard.help.url')
           puts I18n.t('form.clipboard.help.login')
           puts I18n.t('form.clipboard.help.password')
           puts I18n.t('form.clipboard.help.otp_code')
@@ -350,7 +375,7 @@ module MPW
     end
 
     # Display the wallet
-    # @args: wallet -> the wallet name
+    # @param wallet [String] wallet name
     def get_wallet(wallet = nil)
       @wallet =
         if wallet.to_s.empty?
@@ -375,7 +400,7 @@ module MPW
     end
 
     # Add a new public key
-    # args: key -> the key name or key file to add
+    # @param key [String] key name or key file to add
     def add_key(key)
       @mpw.add_key(key)
       @mpw.write_data
@@ -386,7 +411,7 @@ module MPW
     end
 
     # Add new public key
-    # args: key -> the key name to delete
+    # @param key [String] key name to delete
     def delete_key(key)
       @mpw.delete_key(key)
       @mpw.write_data
@@ -397,10 +422,10 @@ module MPW
     end
 
     # Text editor interface
-    # @args: template -> template name
-    #        item -> the item to edit
-    #        password -> disable field password
-    # @rtrn: a hash with the value for an item
+    # @param template_name [String] template name
+    # @param item [Item] the item to edit
+    # @param password [Boolean] disable field password
+    # @return [Hash] the values for an item
     def text_editor(template_name, password = false, item = nil, **options)
       editor        = ENV['EDITOR'] || 'nano'
       opts          = {}
@@ -429,9 +454,9 @@ module MPW
     end
 
     # Form to add a new item
-    # @args: password -> generate a random password
-    #        text_editor -> enable text editor mode
-    #        values -> hash with multiples value to set the item
+    # @param password [Boolean] generate a random password
+    # @param text_editor [Boolean] enable text editor mode
+    # @param values [Hash] multiples value to set the item
     def add(password = false, text_editor = false, **values)
       options            = text_editor('add_form', password, nil, values) if text_editor
       item               = Item.new(options)
@@ -448,15 +473,15 @@ module MPW
     end
 
     # Update an item
-    # @args: password -> generate a random password
-    #        text_editor -> enable text editor mode
-    #        options -> the option to search
-    #        values -> hash with multiples value to set the item
+    # @param password [Boolean] generate a random password
+    # @param text_editor [Boolean] enable text editor mode
+    # @param options [Hash] the options to search
+    # @param values [Hash] multiples value to set the item
     def update(password = false, text_editor = false, options = {}, **values)
       items = @mpw.list(options)
 
       if items.empty?
-        puts "#{I18n.t('display.warning')}: #{I18n.t('warning.select')}".yellow
+        puts I18n.t('display.nothing')
       else
         table_items(items) if items.length > 1
 
@@ -476,12 +501,12 @@ module MPW
     end
 
     # Remove an item
-    # @args: options -> the option to search
+    # @param options [Hash] the options to search
     def delete(**options)
       items = @mpw.list(options)
 
       if items.empty?
-        puts "#{I18n.t('display.warning')}: #{I18n.t('warning.select')}".yellow
+        puts I18n.t('display.nothing')
       else
         table_items(items)
 
@@ -500,8 +525,8 @@ module MPW
     end
 
     # Copy a password, otp, login
-    # @args: clipboard -> enable clipboard
-    #        options -> the option to search
+    # @param clipboard [Boolean] enable clipboard
+    # @param options [Hash] the options to search
     def copy(clipboard = true, **options)
       items = @mpw.list(options)
 
@@ -517,9 +542,9 @@ module MPW
       puts "#{I18n.t('display.error')} #14: #{e}".red
     end
 
-    # Export the items in a CSV file
-    # @args: file -> the destination file
-    #        options -> option to search
+    # Export the items in an yaml file
+    # @param file [String] the path of destination file
+    # @param options [Hash] options to search
     def export(file, options)
       file  = 'export-mpw.yml' if file.to_s.empty?
       items = @mpw.list(options)
@@ -549,8 +574,8 @@ module MPW
       puts "#{I18n.t('display.error')} #17: #{e}".red
     end
 
-    # Import items from a YAML file
-    # @args: file -> the import file
+    # Import items from an yaml file
+    # @param file [String] path of import file
     def import(file)
       raise I18n.t('form.import.file_empty')     if file.to_s.empty?
       raise I18n.t('form.import.file_not_exist') unless File.exist?(file)

data/lib/mpw/config.rb

@@ -35,8 +35,7 @@ module MPW
     attr_accessor :password
     attr_accessor :pinmode
 
-    # Constructor
-    # @args: config_file -> the specify config file
+    # @param config_file [String] path of config file
     def initialize(config_file = nil)
       @config_file = config_file
       @config_dir  =
@@ -52,19 +51,20 @@ module MPW
     end
 
     # Create a new config file
-    # @args: options -> hash with values
-    # @rtrn: true if le config file is create
+    # @param options [Hash] the value to set the config file
     def setup(**options)
       gpg_key        = options[:gpg_key]        || @gpg_key
       lang           = options[:lang]           || @lang
       wallet_dir     = options[:wallet_dir]     || @wallet_dir
       default_wallet = options[:default_wallet] || @default_wallet
       gpg_exe        = options[:gpg_exe]        || @gpg_exe
-      pinmode        = options[:pinmode]        || @pinmode
-      password       = { numeric: true,
-                         alpha:   true,
-                         special: false,
-                         length:  16 }
+      pinmode        = options.key?(:pinmode) ? options[:pinmode] : @pinmode
+      password       = {
+        numeric: true,
+        alpha:   true,
+        special: false,
+        length:  16
+      }
 
       %w[numeric special alpha length].each do |k|
         if options.key?("pwd_#{k}".to_sym)
@@ -99,11 +99,10 @@ module MPW
     end
 
     # Setup a new gpg key
-    # @args: password -> the GPG key password
-    #        name -> the name of user
-    #        length -> length of the GPG key
-    #        expire -> the time of expire to GPG key
-    # @rtrn: true if the GPG key is create, else false
+    # @param password [String] gpg key password
+    # @param name [String] the name of user
+    # @param length [Integer] length of the gpg key
+    # @param expire [Integer] time of expire to gpg key
     def setup_gpg_key(password, name, length = 4096, expire = 0)
       raise I18n.t('error.config.genkey_gpg.name') if name.to_s.empty?
       raise I18n.t('error.config.genkey_gpg.password') if password.to_s.empty?
@@ -137,7 +136,7 @@ module MPW
       @default_wallet = config['default_wallet']
       @gpg_exe        = config['gpg_exe']
       @password       = config['password'] || {}
-      @pinmode        = config['pinmode']
+      @pinmode        = config['pinmode'] || false
 
       raise if @gpg_key.empty? || @wallet_dir.empty?
 
@@ -147,7 +146,7 @@ module MPW
     end
 
     # Check if private key exist
-    # @rtrn: true if the key exist, else false
+    # @return [Boolean] true if the key exist, else false
     def check_gpg_key?
       ctx = GPGME::Ctx.new
       ctx.each_key(@gpg_key, true) do
@@ -158,8 +157,8 @@ module MPW
     end
 
     # Change the path of one wallet
-    # @args: path -> the new directory path
-    #        wallet -> the wallet name
+    # @param path [String]new directory path
+    # @param wallet [String] wallet name
     def set_wallet_path(path, wallet)
       path = @wallet_dir if path == 'default'
 

data/lib/mpw/item.rb

@@ -31,10 +31,7 @@ module MPW
     attr_accessor :last_edit
     attr_accessor :created
 
-    # Constructor
-    # Create a new item
-    # @args: options -> a hash of parameter
-    # raise an error if the hash hasn't the key name
+    # @param options [Hash] the option :host is required
     def initialize(**options)
       if !options.key?(:host) || options[:host].to_s.empty?
         raise I18n.t('error.update.host_empty')
@@ -54,7 +51,7 @@ module MPW
     end
 
     # Update the item
-    # @args: options -> a hash of parameter
+    # @param options [Hash]
     def update(**options)
       if options.key?(:host) && options[:host].to_s.empty?
         raise I18n.t('error.update.host_empty')
@@ -84,6 +81,17 @@ module MPW
       @last_edit = nil
     end
 
+    # Return data on url format
+    # @return [String] an url
+    def url
+      url = ''
+      url += "#{@protocol}://" if @protocol
+      url += @host
+      url += ":#{@port}" if @port
+
+      url
+    end
+
     def empty?
       @id.to_s.empty?
     end
@@ -95,6 +103,7 @@ module MPW
     private
 
     # Generate an random id
+    # @return [String] random string
     def generate_id
       [*('A'..'Z'), *('a'..'z'), *('0'..'9')].sample(16).join
     end