mytotp 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5430db4643c04284680830dfa98af44f421c088260dbfdfc654550a249d3707e
-  data.tar.gz: dc7d8b9400f9f98c3b6b4b1d01d11d2dbfb4d887ee25a17687067f9b08256d59
+  metadata.gz: 1709c81172ffaea43aee506997a66c17bb611fa4d6a0eca9ba363b27164a1785
+  data.tar.gz: f192b136f75dc6401f5878794fc763ebc28ee611aea886322c4310e049078797
 SHA512:
-  metadata.gz: bba5a6a3d08fab02caf637088acf15792452411b0a6ba7b80db72286e6349ccba89201031baa7f2e99e74866310c6fd073217ba3c1d3e7b0a111c95ac1a8c0fb
-  data.tar.gz: 10d327657644c0a8b996faf8cf2a879d715dac6c7a5df94d86877f5172b81d40f3a58ec1ad26e6c080aa3177e05f6f67388caeaa72cb6e319b676ed75797bc5f
+  metadata.gz: 308f62c11949e20672b4b928b46b5985cf94e143f3db63c886bfe3010419fdaef24443bf98918d53121f7c1b2203bf6bcfb6caf1e62c2208dd808eee121fc7a4
+  data.tar.gz: 9031ab707aa6a941048eaa8c72491b455c0fc82aa500c994f132477952d1b02d9bb91333bb6e01c8e07209fe5b2796f90ae0d6b984d7f98443c23e90f63b9957

data/README.md

@@ -2,6 +2,8 @@
 
 Another TOTP cli app. Nice UI, simple to use and user-friendly.
 
+![mytotp-gif](https://github.com/a-chacon/mytotp/blob/aa60f18d3ec9885440796a13f66d553f0d656e96/mytotp.gif)
+
 ## Main features
 
 -   Add, remove and update services.

data/exe/mytotp

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require "mytotp"
-require "dry/cli"
+require 'mytotp'
+require 'dry/cli'
 
 Dry::CLI.new(Mytotp::Commands).call

data/lib/mytotp/commands/generate.rb

@@ -2,15 +2,17 @@ module Mytotp
   module Commands
     ##
     # Class command for generate a totp token.
-    # return IO
     class Generate < Dry::CLI::Command
-      require "clipboard"
+      require 'clipboard'
 
-      desc "Generate a totp for a specific service."
-      argument :service, require: true, desc: "Service name."
-      argument :username, desc: "Username."
-      option :mode, default: "once", values: %w[once continuos], desc: "The generator mode"
+      desc 'Generate a totp for a specific service.'
+      argument :service, require: true, desc: 'Service name.'
+      argument :username, desc: 'Username.'
+      option :mode, default: 'once', values: %w[once continuos], desc: 'The generator mode'
 
+      # call the command function
+      # @param service [String] Service's name to generate the totp code.
+      # @param username [String] Service's username to generate the totp code.
       def call(service: nil, username: nil, **options)
         # find services
         services = Mytotp::Models::Service.where(Sequel.ilike(:service, "%#{service}%"))
@@ -29,12 +31,9 @@ module Mytotp
         generate_code(service, options.fetch(:mode))
       end
 
-      private
-
       ##
       # Print message when is found one
-      # Params: [Mytotp::Models::Service]
-      # Returns: IO
+      # @param services [Collection[Mytotp::Models::Service]] Collection of services.
       def found_one_message(services)
         puts CLI::UI.fmt "{{green:Service:}} #{services.first.service.capitalize}"
         puts CLI::UI.fmt "{{green:Username:}} #{services.first.username.capitalize}"
@@ -42,10 +41,10 @@ module Mytotp
 
       ##
       # Ask which service when we have more than one found.
-      # Params: [Mytotp::Models::Service]
-      # Returns: Mytotp::Models::Service
+      # @param services [Collection[Mytotp::Models::Service]] Collection of services.
+      # @return [Mytotp::Models::Service] selected service
       def select_one(services)
-        CLI::UI::Prompt.ask("Which service?") do |handler|
+        CLI::UI::Prompt.ask('Which service?') do |handler|
           services.each do |s|
             handler.option("#{s.service} : #{s.username}") { |_selection| s }
           end
@@ -54,11 +53,11 @@ module Mytotp
 
       ##
       # Generate the complete message with the code
-      # Params: Mytotp::Models::Service,String
-      # Returns: IO
+      # @param service [Mytotp::Models::Service] Selected service for generate the totp code
+      # @param mode [String] Mode for generate the code, it can be 'continuos' or by default 'once'
       def generate_code(service, mode)
         totp = ROTP::TOTP.new(service.key, interval: service.period, digits: service.digits)
-        if mode == "continuos"
+        if mode == 'continuos'
           # infinit loop
           loop do
             actual_code = totp.now
@@ -80,8 +79,6 @@ module Mytotp
 
       ##
       # clear last line in the console
-      # Params: nil
-      # Returns: IO
       def clear_last_line
         # Clear the line
         print(CLI::UI::ANSI.previous_line + CLI::UI::ANSI.clear_to_end_of_line)
@@ -91,24 +88,24 @@ module Mytotp
 
       ##
       # Count seconds
-      # Params: Mytotp::Models::Service, ROTP::TOTP
-      # Returns: Integer
+      # @param service [Mytotp::Models::Service] Service to validate.
+      # @param totp [ROTP::TOTP] totp object generated with the service token.
+      # @return [Integer] seconds
       def valid_for(service, totp)
         (service.period - (Time.now - Time.at(totp.verify(totp.now)))).round
       end
 
       ##
       # Print valid for
-      # Params: Mytotp::Models::Service, ROTP::TOTP
-      # Returns: IO
+      # @param service [Mytotp::Models::Service] Service to validate.
+      # @param totp [ROTP::TOTP] totp object generated with the service token.
       def message_valid_for(service, totp)
         puts CLI::UI.fmt "{{green:Valid for:}} #{valid_for(service, totp)} seconds"
       end
 
       ##
       # Print the code
-      # Params: String
-      # Returns: IO
+      # @param totp [String] totp code generate for print.
       def message_code(totp)
         if copy_to_clipboard(totp)
           puts CLI::UI.fmt "{{green:Current TOTP:}} #{totp} - {{green:Copy!}}"
@@ -119,8 +116,8 @@ module Mytotp
 
       ##
       # Copy code to clipboar
-      # Params: String
-      # Returns: String
+      # @param code [String] Code to be copy on the clipboard.
+      # @return [Boolean] True or false depending if it was copy to clipboard or not.
       def copy_to_clipboard(code)
         Clipboard.copy(code)
         Clipboard.paste == code

data/lib/mytotp/commands/service.rb

@@ -2,9 +2,9 @@ module Mytotp
   module Commands
     ##
     # Class command for manage services.
-    # return boolean.
     class Service < Dry::CLI::Command
-      desc "Manage your services. Whitout subcommands print services."
+      desc 'Manage your services. Whitout subcommands print services.'
+      # call the command function
       def call(*)
         Mytotp::Models::Service.all.each do |s|
           puts CLI::UI.fmt "{{green:#{s.service.capitalize}}} - #{s.username.downcase}"

data/lib/mytotp/commands/services/add.rb

@@ -1,42 +1,47 @@
 module Mytotp
   module Commands
+    # services subcommands module
+    # it's group the service subcommands
     module Services
       ##
       # Class command for add a new service.
-      # return String
       class Add < Dry::CLI::Command
-        desc "Add a new service."
+        desc 'Add a new service.'
 
-        argument :service, desc: "Service name."
+        argument :service, desc: 'Service name.'
         argument :username, desc: "Account's username"
-        argument :key, desc: "Secret key"
+        argument :key, desc: 'Secret key'
 
+        # execute the command
+        # @param service [String] service name to add
+        # @param username [String] username used in the service
+        # @param key [String] totp key shared for generate the otp codes
         def call(service: nil, username: nil, key: nil, **)
           service_obj = Mytotp::Models::Service.new(service: service, username: username,
                                                     key: key)
           service_obj = ask_for_incomplete(service_obj)
           service_obj.save
-          puts CLI::UI.fmt "{{green:Correct saved!}}"
+          puts CLI::UI.fmt '{{green:Correct saved!}}'
         rescue StandardError => e
           print(e.to_s)
-          puts CLI::UI.fmt "{{red:Something is not fine, try again!}}"
+          puts CLI::UI.fmt '{{red:Something is not fine, try again!}}'
         end
 
         ##
         # Ask incomplete information for a service_obj
-        # Params: Mytotp::Models::Service
-        # Returns: Mytotp::Models::Service
+        # @param service_obj [Mytotp::Models::Service] the service object created with the arguments provided
+        # @return [Mytotp::Models::Service] the service object modify by the questions to the user
         def ask_for_incomplete(service_obj)
           # Check service if was input by argument or interactive ask
           if service_obj.service.nil?
             service_obj.service = CLI::UI.ask(
-              "Which service do you want to add?", allow_empty: false
+              'Which service do you want to add?', allow_empty: false
             )
           end
           # Check service if was input by argument or interactive ask
-          service_obj.username = CLI::UI.ask("Username?", allow_empty: false) if service_obj.username.nil?
+          service_obj.username = CLI::UI.ask('Username?', allow_empty: false) if service_obj.username.nil?
           # Check service if was input by argument or interactive ask
-          service_obj.key = CLI::UI.ask("Key?", allow_empty: false) if service_obj.key.nil?
+          service_obj.key = CLI::UI.ask('Key?', allow_empty: false) if service_obj.key.nil?
           service_obj
         end
       end

data/lib/mytotp/commands/services/remove.rb

@@ -2,13 +2,16 @@ module Mytotp
   module Commands
     module Services
       ##
-      # Class command for add a new service.
-      # return String
+      # Class command for remove a service.
+      # the service can be search by service's name and username for remove.
       class Remove < Dry::CLI::Command
-        desc "Remove a service."
-        argument :service, desc: "Service name."
-        argument :username, desc: "Username."
+        desc 'Remove a service.'
+        argument :service, desc: 'Service name.'
+        argument :username, desc: 'Username.'
 
+        # Execute the command
+        # @param service [String] service name to remove.
+        # @param username [String] username in the service.
         def call(service: nil, username: nil, **)
           services = Mytotp::Models::Service.where(
             Sequel.ilike(:service, "%#{service}%")
@@ -17,9 +20,9 @@ module Mytotp
           )
           case services.count
           when 0
-            puts CLI::UI.fmt "{{yellow:No service found}}"
+            puts CLI::UI.fmt '{{yellow:No service found}}'
           when 1
-            CLI::UI::Frame.open("We found one service!") do
+            CLI::UI::Frame.open('We found one service!') do
               # ask to remove
               remove(services.first.id)
             end
@@ -31,12 +34,11 @@ module Mytotp
 
         ##
         # Ask for which remove
-        # Params: [Mytotp::Models::Service]
-        # Returns: Nil
+        # @param services [Array[Mytotp::Models::Service]] Collection of services found by the input of the user.
         def multiple_options(services)
-          CLI::UI::Frame.open("We found more than one!") do
+          CLI::UI::Frame.open('We found more than one!') do
             # puts services.map { |s| s.service + " " + s.username }
-            id = CLI::UI::Prompt.ask("Which service do you want to remove?") do |handler|
+            id = CLI::UI::Prompt.ask('Which service do you want to remove?') do |handler|
               services.each do |s|
                 handler.option("#{s.service} : #{s.username}") { |_selection| s.id }
               end
@@ -47,16 +49,15 @@ module Mytotp
 
         ##
         # Remove a service by id
-        # Params: String
-        # Returns: IO
+        # @param id [Integer] Unic ID of the service to remove.
         def remove(id)
           service_obj = Mytotp::Models::Service[id]
-          answer = CLI::UI.ask("Are you sure?", options: %w[yes no])
-          if answer == "yes"
+          answer = CLI::UI.ask('Are you sure?', options: %w[yes no])
+          if answer == 'yes'
             service_obj.delete
-            puts CLI::UI.fmt "{{red:Service successfull removed!}}"
+            puts CLI::UI.fmt '{{red:Service successfull removed!}}'
           else
-            puts CLI::UI.fmt "{{green:No service removed.}}"
+            puts CLI::UI.fmt '{{green:No service removed.}}'
           end
         end
       end

data/lib/mytotp/commands/version.rb

@@ -2,9 +2,10 @@ module Mytotp
   module Commands
     ##
     # Class command for show the app version
-    # return String
     class Version < Dry::CLI::Command
       desc "Print #{::Mytotp::APP_NAME} version."
+
+      # execute the command
       def call(*)
         puts VERSION
       end

data/lib/mytotp/commands.rb

@@ -1,12 +1,13 @@
 module Mytotp
+  # It's include and register all commands available in the app
   module Commands
     extend Dry::CLI::Registry
 
     # register clasess like commands
-    register "version", Mytotp::Commands::Version, aliases: ["v", "-v", "--version"]
-    register "generate", Mytotp::Commands::Generate, aliases: ["g"]
-    register "service", Mytotp::Commands::Service
-    register "service add", Mytotp::Commands::Services::Add
-    register "service remove", Mytotp::Commands::Services::Remove
+    register 'version', Mytotp::Commands::Version, aliases: ['v', '-v', '--version']
+    register 'generate', Mytotp::Commands::Generate, aliases: ['g']
+    register 'service', Mytotp::Commands::Service
+    register 'service add', Mytotp::Commands::Services::Add
+    register 'service remove', Mytotp::Commands::Services::Remove
   end
 end

data/lib/mytotp/models/service.rb

@@ -1,8 +1,11 @@
 module Mytotp
+  # It's include the model created for save services
   module Models
     ##
     # Service model
     class Service < Sequel::Model
+      # callback for apply upcase to service and username,
+      # this is doing for make easy to search later
       def before_save
         self.service = service.upcase
         self.username = username.upcase

data/lib/mytotp/version.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
 module Mytotp
-  VERSION = "0.1.2"
+  # app version
+  VERSION = '0.1.3'
 end

data/lib/mytotp.rb

@@ -1,23 +1,25 @@
 # require_relative "mytotp/version"
-require "dry/cli"
-require "sequel"
-require "zeitwerk"
-require "cli/ui"
-require "rotp"
+require 'dry/cli'
+require 'sequel'
+require 'zeitwerk'
+require 'cli/ui'
+require 'rotp'
 # code loader
 Zeitwerk::Loader.eager_load_all
 loader = Zeitwerk::Loader.for_gem
 loader.setup # ready!
-##
-# Mytotp module
+
+# Main module of the app,
+# its contains the global variables and configurations
+# @author a-chacon
 module Mytotp
   # app name
-  APP_NAME = "Mytotp".freeze
+  APP_NAME = 'Mytotp'.freeze
   # cli configuration
   CLI::UI.frame_style = :bracket
   CLI::UI::StdoutRouter.enable
 
-  if ENV.fetch("MYTOTP_ENV", nil) == "test"
+  if ENV.fetch('MYTOTP_ENV', nil) == 'test'
     # db connection, in memmory only
     DB = Sequel.sqlite
   else

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mytotp
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - a-chacon
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-20 00:00:00.000000000 Z
+date: 2022-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clipboard
@@ -120,8 +120,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.5.4
-description: Totp cli tool for who loves the cli. With features that I don't found
-  in another totp cli.
+description: Totp cli tool for who loves the cli. I made it for myself, I don't like
+  others.
 email:
 - andres.ch@protonmail.com
 executables:
@@ -145,10 +145,11 @@ homepage: https://github.com/a-chacon/mytotp
 licenses:
 - GPL-3.0
 metadata:
+  bug_tracker_uri: https://github.com/a-chacon/mytotp/issues
+  changelog_uri: https://github.com/a-chacon/mytotp
+  documentation_uri: https://www.rubydoc.info/gems/mytotp
   homepage_uri: https://github.com/a-chacon/mytotp
   source_code_uri: https://github.com/a-chacon/mytotp
-  changelog_uri: https://github.com/a-chacon/mytotp
-  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -167,5 +168,5 @@ requirements: []
 rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
-summary: Another totp cli
+summary: Another boring totp cli.
 test_files: []