kobot 1.1.0 → 1.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00f2c1151ffcb202b20d4b3f9881c9570b1075ea3684f7ab3ea2cfc65baf4b33
-  data.tar.gz: a6f3da0260abbbfce192557ea580526698b828ed19ec7175dd64080fa437ba35
+  metadata.gz: 0e8cedf9053f994144d21b233b2c68fb4e03aff011192f1273e1ad24d347c4f9
+  data.tar.gz: 8daab86f87c5ffe5e0588c9029ccd062954ca7ad3557769861ef19fd07347c79
 SHA512:
-  metadata.gz: 4fb7e982db990bdbf659009501f3eb028d02fdddf7e8d6ea48762495867196f5dfc748c6d14926d5239b57c4433dad3d2568c8d6ca9bf42d6de401b91391e7a3
-  data.tar.gz: '06482f411bfbf8f0083d0750e7d8ea4074f6740de3e9b1d6ba27c3e850356cd28c39d83d3a27f5d99bf7e21589cce65d64396793ffd018180ec621f926db7327'
+  metadata.gz: 4aaaa2f0e8eebe98487536158b0f571e794b76db95dec5cd2eb268037dfd0888045d6cebbeb46876162ed9944813f7429e8a4466da20ca9010ecacfd552cd302
+  data.tar.gz: 9ede3410f3ad664982db308f382140eb19bc8140970fc4991f68829a0c63fe664a6978b99ef5753036954a0bbabb9731b3f7e5fe08aff11c589798898ce0ec59

data/CHANGELOG.md

@@ -5,3 +5,23 @@
 - Deprecated lower-case environment variables for credentials configuration
 - Updated option help doc to indicate weekends and public holidays are skipped by default
 - Updated required_ruby_version to be >= 2.4.0 to align with the webdrivers dependency
+
+### v1.2.0
+- Added an option to allow forcibly running regardless of weekends or public holidays
+- Added an ENV flag to allow requiring lib in local workspace for development purpose
+
+### v1.2.1
+- Improved logging for better readability in logs
+- Switched to builtin Logger#deprecate from Logger#warn for deprecations
+- Renamed internal method to skip? from holiday? as it was meant for skipping any specified date
+
+### v1.2.2
+- Improved login screen wait and logging
+- Applied fix for offenses about empty lines and long lines reported by Rubocop
+
+### v1.2.3
+- Improved validation logic to skip running due to weekend or intentional skips
+- Refactored engine by reducing methods length based on reports by Rubocop
+
+### v1.2.4
+- Changed to use boolean values for validation instead of raising exceptions

data/README.md

@@ -57,15 +57,17 @@ Get help doc:
 ```
 $ kobot -h
 Usage: kobot [options]
-    -c, --clock CLOCK                The clock action: in, out
-    -l, --loglevel [LEVEL]           Specify log level: debug, info, warn, error. Default is info
+    -c, --clock CLOCK                Required; the clock action option: in, out
+    -l, --loglevel [LEVEL]           Specify log level: debug, info, warn, error; default is info
     -s, --skip [D1,D2,D3]            Specify dates to skip clock in/out with date format YYYY-MM-DD and
-                                     multiple values separated by comma, such as: 2020-05-01,2020-12-31
-                                     Weekends and public holidays in Japan are skipped by default.
-    -t, --to [TO]                    Email address to send notification to. By default it is sent to
+                                     multiple values separated by comma, such as: 2020-05-01,2020-12-31;
+                                     weekends and public holidays in Japan will be skipped by default
+    -t, --to [TO]                    Email address to send notification to; by default it is sent to
                                      the same self email account used in SMTP config as the sender
     -n, --notify                     Enable email notification
     -d, --dryrun                     Run the process without actual clock in/out
+    -f, --force                      Run the process forcibly regardless of weekends or public holidays;
+                                     must be used together with --dryrun to prevent mistaken operations
     -x, --headless                   Start browser in headless mode
     -g, --geolocation                Allow browser to use geolocation
     -h, --help                       Show this help message

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'kobot'

data/exe/kobot

@@ -1,6 +1,15 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require 'kobot'
+begin
+  # For quickly tryout in local development
+  # without installing to system gems path
+  raise LoadError if ENV['KOBOT_DEV']
+
+  require 'kobot'
+rescue LoadError
+  $LOAD_PATH.unshift File.expand_path('../lib', __dir__)
+  require 'kobot'
+end
 
 Kobot.run

data/lib/kobot.rb

@@ -14,8 +14,6 @@ require 'kobot/engine'
 # and with Google Gmail service email notification can also be sent to notify the results.
 module Kobot
   class << self
-
-    # The entrance to run Kobot.
     def run
       configure
       Engine.new.start
@@ -33,6 +31,7 @@ module Kobot
         config.clock                 = options[:clock].to_sym
         config.loglevel              = options[:loglevel]&.to_sym || :info
         config.dryrun                = options[:dryrun]
+        config.force                 = options[:force]
         config.skip                  = options[:skip] || []
 
         config.kot_url               = 'https://s2.kingtime.jp/independent/recorder/personal/'

data/lib/kobot/config.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 module Kobot
-
   # Configuration definition includes static ones hardcoded and
   # dynamic ones that can be specified by command line options.
   class Config
@@ -9,7 +8,8 @@ module Kobot
       attr_accessor :clock,
                     :loglevel,
                     :skip,
-                    :dryrun
+                    :dryrun,
+                    :force
 
       attr_accessor :kot_url,
                     :kot_timezone_offset,

data/lib/kobot/credential.rb

@@ -4,7 +4,6 @@ module Kobot
   # Credentials include id and password to login to KOT and
   # Gmail SMTP id and password to send email notifications.
   class Credential
-
     class << self
       attr_accessor :kot_id,
                     :kot_password,
@@ -30,7 +29,7 @@ module Kobot
         @credentials.each do |attr, value|
           send("#{attr}=".to_sym, value)
         end
-        Kobot.logger.info('Credentials load successful')
+        Kobot.logger.info('Load credentials successful')
         Kobot.logger.debug(@credentials)
       end
 
@@ -49,11 +48,7 @@ module Kobot
         required_credentials = %w[kot_id kot_password]
         required_credentials.concat %w[gmail_id gmail_password] if Config.gmail_notify_enabled
         required_credentials.each do |attr|
-          if ENV[attr]
-            Kobot.logger.warn(
-              "[DEPRECATION] lower-case ENV variable is deprecated, please use #{attr.upcase} instead."
-            )
-          end
+          Kobot.logger.deprecate(attr, attr.upcase) if ENV[attr]
           env_attr_value = ENV[attr.upcase] || ENV[attr]
           @credentials[attr] = env_attr_value if env_attr_value
         end

data/lib/kobot/engine.rb

@@ -6,7 +6,6 @@ module Kobot
   # The core class that launches browser, logins to KOT, reads today
   # record, and conducts clock in or clock out action based on config.
   class Engine
-
     def initialize
       @now = Time.now.getlocal(Config.kot_timezone_offset)
       @today = @now.strftime(Config.kot_date_format)
@@ -15,7 +14,7 @@ module Kobot
 
     # The entrance where the whole flow starts.
     #
-    # It exits early if today is weekend or treated as holiday by
+    # It exits early if today is weekend or marked as to skip by
     # the #{Config.skip} specified from command line option --skip.
     #
     # Unexpected behavior such as record appearing as holiday on
@@ -25,22 +24,12 @@ module Kobot
     # System errors or any unknown exceptions occurred if any are
     # to be popped up and should be handled by the outside caller.
     def start
-      if weekend?
-        Kobot.logger.info("Today=#{@today} is weekend.")
-        return
-      end
-      if holiday?
-        Kobot.logger.info("Today=#{@today} is holiday.")
-        return
-      end
-      unless %i[in out].include? Config.clock
-        Kobot.logger.warn("Invalid clock operation: #{Config.clock}")
-        return
-      end
+      return unless should_run_today?
+
       launch_browser
       login
       read_today_record
-      verify_today_record!
+      validate_today_record!
       if Config.clock == :in
         clock_in!
       else
@@ -65,11 +54,23 @@ module Kobot
       Mailer.send(clock_notify_message(status: e.message))
       logout
     ensure
-      @browser&.quit
+      close_browser
     end
 
     private
 
+    def should_run_today?
+      if skip?
+        Kobot.logger.warn("Today=#{@today} is skipped as per: --skip=#{Config.skip}")
+        return false
+      end
+      return true unless weekend?
+
+      Kobot.logger.info("[Force] should have exited: today=#{@today} is weekend") if Config.force
+      Kobot.logger.warn("Today=#{@today} is weekend") unless Config.force
+      Config.force
+    end
+
     def launch_browser
       prefs = {
         profile: {
@@ -85,9 +86,18 @@ module Kobot
       Kobot.logger.info('Launch browser successful')
     end
 
+    def close_browser
+      return unless @browser
+
+      Kobot.logger.info('Close browser')
+      @browser.quit
+    end
+
     def login
-      @browser.get @top_url
       Kobot.logger.info("Navigate to: #{@top_url}")
+      @browser.get @top_url
+      @wait.until { @browser.find_element(id: 'modal_window') }
+      Kobot.logger.info "Page title: #{@browser.title}"
       Kobot.logger.debug do
         "Login with id=#{Credential.kot_id} and password=#{Credential.kot_password}"
       end
@@ -104,13 +114,15 @@ module Kobot
           Kobot.logger.warn "Get geolocation failed: #{e.message}"
         end
       end
-      Kobot.logger.info @browser.title
+      Kobot.logger.info "Page title: #{@browser.title}"
     end
 
     def logout
       if @browser.current_url.include? 'admin'
+        Kobot.logger.info('Logout from タイムカード page')
         @browser.find_element(css: 'div.htBlock-header_logoutButton').click
       else
+        Kobot.logger.info('Logout from Myレコーダー page')
         @wait.until { @browser.find_element(id: 'menu_icon') }.click
         @wait.until { @browser.find_element(link: 'ログアウト') }.click
         @browser.switch_to.alert.accept
@@ -119,6 +131,7 @@ module Kobot
     end
 
     def read_today_record
+      Kobot.logger.info('Navigate to タイムカード page')
       @wait.until { @browser.find_element(id: 'menu_icon') }.click
       @wait.until { @browser.find_element(link: 'タイムカード') }.click
 
@@ -131,8 +144,12 @@ module Kobot
         @kot_today = date_cell.text
         @kot_today_css_class = date_cell.attribute('class')
         @kot_today_type = tr.find_element(css: 'td.work_day_type').text
-        @kot_today_clock_in = tr.find_element(css: 'td.start_end_timerecord[data-ht-sort-index="START_TIMERECORD"]').text
-        @kot_today_clock_out = tr.find_element(css: 'td.start_end_timerecord[data-ht-sort-index="END_TIMERECORD"]').text
+        @kot_today_clock_in = tr.find_element(
+          css: 'td.start_end_timerecord[data-ht-sort-index="START_TIMERECORD"]'
+        ).text
+        @kot_today_clock_out = tr.find_element(
+          css: 'td.start_end_timerecord[data-ht-sort-index="END_TIMERECORD"]'
+        ).text
         Kobot.logger.debug do
           {
             kot_toay: @kot_today,
@@ -146,10 +163,23 @@ module Kobot
       end
     end
 
-    def verify_today_record!
-      raise KotRecordError, "Today=#{@today} is not found on kot." if @kot_today.strip.empty?
-      raise KotRecordError, "Today=#{@today} is marked as weekend on kot: #{@kot_today}" if kot_weekend?
-      raise KotRecordError, "Today=#{@today} is marked as public holiday on kot: #{@kot_today}" if kot_public_holiday?
+    def validate_today_record!
+      raise KotRecordError, "Today=#{@today} is not found on kot" if @kot_today.strip.empty?
+
+      if kot_weekend?
+        raise KotRecordError, "Today=#{@today} is marked as weekend on kot: #{@kot_today}" unless Config.force
+
+        Kobot.logger.info(
+          "[Force] should have exited: today=#{@today} is marked as weekend on kot: #{@kot_today}"
+        )
+      end
+
+      return unless kot_public_holiday?
+      raise KotRecordError, "Today=#{@today} is marked as public holiday on kot: #{@kot_today}" unless Config.force
+
+      Kobot.logger.info(
+        "[Force] should have exited: today=#{@today} is marked as public holiday on kot: #{@kot_today}"
+      )
     end
 
     def clock_in!
@@ -192,21 +222,25 @@ module Kobot
     end
 
     def click_clock_in_button
+      Kobot.logger.info("Navigate to: #{@top_url}")
       @browser.get @top_url
       clock_in_button = @wait.until { @browser.find_element(css: 'div.record-clock-in') }
       if Config.dryrun
         Kobot.logger.info('[Dryrun] clock in button (出勤) would have been clicked')
       else
+        Kobot.logger.info('Clicking the clock in button (出勤)')
         clock_in_button.click
       end
     end
 
     def click_clock_out_button
+      Kobot.logger.info("Navigate to: #{@top_url}")
       @browser.get @top_url
       clock_out_button = @wait.until { @browser.find_element(css: 'div.record-clock-out') }
       if Config.dryrun
         Kobot.logger.info('[Dryrun] clock out button (退勤) would have been clicked')
       else
+        Kobot.logger.info('Clicking the clock in button (退勤)')
         clock_out_button.click
       end
     end
@@ -215,7 +249,7 @@ module Kobot
       @now.saturday? || @now.sunday?
     end
 
-    def holiday?
+    def skip?
       return false unless Config.skip
       return false unless Config.skip.respond_to? :include?
 

data/lib/kobot/exception.rb

@@ -1,14 +1,7 @@
 # frozen_string_literal: true
 
 module Kobot
-
-  class KotRecordError < StandardError
-  end
-
-  class KotClockInError < StandardError
-  end
-
-  class KotClockOutError < StandardError
-  end
-
+  class KotRecordError < StandardError; end
+  class KotClockInError < StandardError; end
+  class KotClockOutError < StandardError; end
 end

data/lib/kobot/mailer.rb

@@ -3,11 +3,9 @@
 require 'net/smtp'
 
 module Kobot
-
   # Responsible for sending email notifications in SMTP with Gmail
   class Mailer
     class << self
-
       # Sends email in preconfigured Gmail SMTP credential and to the recipient
       # configured by #{Config.gmail_notify_to} or self if not configured, with
       # email subject set by #{Config.gmail_notify_subject}.

data/lib/kobot/option.rb

@@ -3,34 +3,32 @@
 require 'optparse'
 
 module Kobot
-
   # Responsible for parsing the command line options for custom execution.
   class Option
     class << self
-
       # Parses command line options and returns a hash containing the options.
       def parse!
         options = {}
         opt_parser = OptionParser.new do |opt|
           opt.banner = "Usage: #{$PROGRAM_NAME} [options]"
 
-          opt.on('-c', '--clock CLOCK', 'The clock action: in, out') do |clock|
+          opt.on('-c', '--clock CLOCK', 'Required; the clock action option: in, out') do |clock|
             options[:clock] = clock
           end
 
-          opt.on('-l', '--loglevel [LEVEL]', 'Specify log level: debug, info, warn, error. Default is info') do |level|
+          opt.on('-l', '--loglevel [LEVEL]', 'Specify log level: debug, info, warn, error; default is info') do |level|
             options[:loglevel] = level
           end
 
           opt.on('-s', '--skip [D1,D2,D3]', Array,
                  'Specify dates to skip clock in/out with date format YYYY-MM-DD and',
-                 'multiple values separated by comma, such as: 2020-05-01,2020-12-31',
-                 'Weekends and public holidays in Japan are skipped by default.') do |skip|
+                 'multiple values separated by comma, such as: 2020-05-01,2020-12-31;',
+                 'weekends and public holidays in Japan will be skipped by default') do |skip|
             options[:skip] = skip
           end
 
           opt.on('-t', '--to [TO]',
-                 'Email address to send notification to. By default it is sent to',
+                 'Email address to send notification to; by default it is sent to',
                  'the same self email account used in SMTP config as the sender') do |to|
             options[:to] = to
           end
@@ -43,6 +41,12 @@ module Kobot
             options[:dryrun] = dryrun
           end
 
+          opt.on('-f', '--force',
+                 'Run the process forcibly regardless of weekends or public holidays;',
+                 'must be used together with --dryrun to prevent mistaken operations') do |force|
+            options[:force] = force
+          end
+
           opt.on('-x', '--headless', 'Start browser in headless mode') do |headless|
             options[:headless] = headless
           end
@@ -63,7 +67,12 @@ module Kobot
         end
         opt_parser.parse! ARGV
         raise OptionParser::MissingArgument, 'The clock option is required' if options[:clock].nil?
-        raise OptionParser::InvalidArgument, 'The clock option must be either: in, out' unless %w[in out].include? options[:clock]
+        unless %w[in out].include? options[:clock]
+          raise OptionParser::InvalidArgument, 'The clock option must be either: in, out'
+        end
+        if options[:force] && !options[:dryrun]
+          raise OptionParser::InvalidArgument, 'Must specify --dryrun for forcibly running'
+        end
 
         options
       rescue OptionParser::MissingArgument, OptionParser::InvalidArgument => e

data/lib/kobot/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Kobot
-  VERSION = '1.1.0'
+  VERSION = '1.2.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kobot
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.4
 platform: ruby
 authors:
 - Andy Jiang
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-22 00:00:00.000000000 Z
+date: 2020-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: webdrivers