kobot 1.2.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5280569d35d3db17de90830bc1b6b2fa7fd4ec17c1b3efae0772a2329288fbe
-  data.tar.gz: 51a08ceb2e07e577a503e6c5bbd17352e664612a9b6ae6fd6e3ca9aedc56a71e
+  metadata.gz: '08261437cd35a8b09dfad79740f2f6ec52e87fea47713aba5e00133aa570ac08'
+  data.tar.gz: a7941208f88d46d40fb8d5366851f5b466bb85e975b3d5ff95e7753bf9f8032c
 SHA512:
-  metadata.gz: 9ce2200116a9c36f384edbc2a0a2b47b37819ddb44fb8f590a1a1af1afd0859ea4d56c2022c4990f720f9bbd42eb4aaaf26986333298ed61580a4ad37b41bbed
-  data.tar.gz: 783cd8e9c729404108119fc2c26b49729852c68e40e415dad7d5ab92066021a4c2496fe3aaeab355911ad174b848af1cda99510496a53ff282f5d4fa42f8d244
+  metadata.gz: f14ebacda3eaec90ae6f6e9f995821d3116599e2fdff2e19afcd546c43404f6453055d256828f4f549e07d5f3e08ac0ba4cbc1c6ee0e4b3739a02277b0285258
+  data.tar.gz: d42d8f45187cc512eb08b13d5c891cd7b0bf567a76bf55b49ffc089c240946f0345208b7586fecbd2a32c8e3f3855f22086913bed5c79152e3248e5db0692d75

data/CHANGELOG.md

@@ -18,3 +18,18 @@
 ### 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
+
+### v1.2.5
+- Added I18n support for both English and Japanese KOT UI
+
+### v1.3.0
+- Added config option (-a, --auto-skip-without) to enable automatic skipping based on schedule
+- Replaced deprecated options with capabilities option in Selenium driver initialization
+- Refactored scattered attr_accessors and reduced instance variables count reported by Rubocop

data/README.md

@@ -62,6 +62,9 @@ Usage: kobot [options]
     -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 will be skipped by default
+    -a [SCHEDULE],                   Enable automatic skipping by reading schedule from the Time Card page;
+        --auto-skip-without          skip today if the provided text is not contained in the schedule column
+                                     on the Time Card page; by default 裁量労働 is used
     -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

data/lib/kobot/config.rb

@@ -8,24 +8,21 @@ module Kobot
       attr_accessor :clock,
                     :loglevel,
                     :skip,
+                    :auto_skip_without,
                     :dryrun,
-                    :force
-
-      attr_accessor :kot_url,
+                    :force,
+                    :kot_url,
                     :kot_timezone_offset,
-                    :kot_date_format
-
-      attr_accessor :gmail_notify_enabled,
+                    :kot_date_format,
+                    :gmail_notify_enabled,
                     :gmail_notify_subject,
                     :gmail_notify_to,
                     :gmail_smtp_address,
-                    :gmail_smtp_port
-
-      attr_accessor :browser_headless,
+                    :gmail_smtp_port,
+                    :browser_headless,
                     :browser_geolocation,
-                    :browser_wait_timeout
-
-      attr_accessor :credentials_file
+                    :browser_wait_timeout,
+                    :credentials_file
 
       def configure
         yield self

data/lib/kobot/engine.rb

@@ -14,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
@@ -24,26 +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?
-        if Config.force
-          Kobot.logger.info("[Force] should have exited: today=#{@today} is weekend")
-        else
-          Kobot.logger.info("Today=#{@today} is weekend")
-          return
-        end
-      end
-      if skip?
-        Kobot.logger.info("Today=#{@today} is skipped as per: --skip=#{Config.skip}")
-        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
@@ -68,12 +54,23 @@ module Kobot
       Mailer.send(clock_notify_message(status: e.message))
       logout
     ensure
-      Kobot.logger.info('Close browser')
-      @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: {
@@ -84,15 +81,31 @@ module Kobot
       }
       options = Selenium::WebDriver::Chrome::Options.new(prefs: prefs)
       options.headless! if Config.browser_headless
-      @browser = Selenium::WebDriver.for(:chrome, options: options)
+      caps = [
+        options
+      ]
+      @browser = Selenium::WebDriver.for(:chrome, capabilities: caps)
       @wait = Selenium::WebDriver::Wait.new(timeout: Config.browser_wait_timeout)
       Kobot.logger.info('Launch browser successful')
     end
 
+    def close_browser
+      return unless @browser
+
+      Kobot.logger.info('Close browser')
+      @browser.quit
+    end
+
     def login
       Kobot.logger.info("Navigate to: #{@top_url}")
       @browser.get @top_url
       @wait.until { @browser.find_element(id: 'modal_window') }
+      modal_title_element = @wait.until { @browser.find_element(css: '.modal-title') }
+      @selector = if modal_title_element.text.downcase.include? 'password'
+                    Selector.en
+                  else
+                    Selector.ja
+                  end
       Kobot.logger.info "Page title: #{@browser.title}"
       Kobot.logger.debug do
         "Login with id=#{Credential.kot_id} and password=#{Credential.kot_password}"
@@ -102,10 +115,14 @@ module Kobot
       @browser.find_element(css: 'div.btn-control-message').click
 
       Kobot.logger.info 'Login successful'
-      @wait.until { @browser.find_element(id: 'notification_content').text.include?('データを取得しました') }
+      @wait.until do
+        @browser.find_element(id: 'notification_content').text.include?(@selector.login_success_notification_text)
+      end
       if Config.browser_geolocation
         begin
-          @wait.until { @browser.find_element(id: 'location_area').text.include?('位置情報取得済み') }
+          @wait.until do
+            @browser.find_element(id: 'location_area').text.include?(@selector.location_area_notification_text)
+          end
         rescue StandardError => e
           Kobot.logger.warn "Get geolocation failed: #{e.message}"
         end
@@ -115,21 +132,21 @@ module Kobot
 
     def logout
       if @browser.current_url.include? 'admin'
-        Kobot.logger.info('Logout from タイムカード page')
+        Kobot.logger.info('Logout from Time Card (タイムカード) page')
         @browser.find_element(css: 'div.htBlock-header_logoutButton').click
       else
-        Kobot.logger.info('Logout from Myレコーダー page')
+        Kobot.logger.info('Logout from My Recorder (Myレコーダー) page')
         @wait.until { @browser.find_element(id: 'menu_icon') }.click
-        @wait.until { @browser.find_element(link: 'ログアウト') }.click
+        @wait.until { @browser.find_element(link: @selector.logout_menu_link_text) }.click
         @browser.switch_to.alert.accept
       end
       Kobot.logger.info 'Logout successful'
     end
 
     def read_today_record
-      Kobot.logger.info('Navigate to タイムカード page')
+      Kobot.logger.info('Navigate to Time Card (タイムカード) page')
       @wait.until { @browser.find_element(id: 'menu_icon') }.click
-      @wait.until { @browser.find_element(link: 'タイムカード') }.click
+      @wait.until { @browser.find_element(link: @selector.time_card_menu_link_text) }.click
 
       time_table = @wait.until { @browser.find_element(css: 'div.htBlock-adjastableTableF_inner > table') }
       time_table.find_elements(css: 'tbody > tr').each do |tr|
@@ -137,83 +154,94 @@ module Kobot
         next unless date_cell.text.include? @today
 
         Kobot.logger.info('Reading today record')
-        @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(
+        @kot_data = {}
+        @kot_data[:today] = date_cell.text
+        @kot_data[:today_css_class] = date_cell.attribute('class')
+        @kot_data[:today_type] = tr.find_element(css: 'td.work_day_type').text
+        @kot_data[:today_schedule] = tr.find_element(css: 'td.schedule').text
+        @kot_data[: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(
+        @kot_data[: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,
-            kot_today_css_class: @kot_today_css_class,
-            kot_today_type: @kot_today_type,
-            kot_today_clock_in: @kot_today_clock_in,
-            kot_today_clock_out: @kot_today_clock_out
+            kot_toay: @kot_data[:today],
+            kot_today_css_class: @kot_data[:today_css_class],
+            kot_today_type: @kot_data[:today_type],
+            kot_today_clock_in: @kot_data[:today_clock_in],
+            kot_today_clock_out: @kot_data[:today_clock_out]
           }
         end
         break
       end
     end
 
-    def verify_today_record!
-      raise KotRecordError, "Today=#{@today} is not found on kot" if @kot_today.strip.empty?
+    def validate_today_record!
+      raise KotRecordError, "Today=#{@today} is not found on kot" if @kot_data[:today].strip.empty?
 
       if kot_weekend?
-        raise KotRecordError, "Today=#{@today} is marked as weekend on kot: #{@kot_today}" unless Config.force
+        raise KotRecordError, "Today=#{@today} is marked as weekend: #{@kot_data[:today]}" unless Config.force
+
+        Kobot.logger.info(
+          "[Force] should have exited: today=#{@today} is marked as weekend: #{@kot_data[:today]}"
+        )
+      end
+
+      if kot_public_holiday?
+        raise KotRecordError, "Today=#{@today} is marked as public holiday: #{@kot_data[:today]}" unless Config.force
 
         Kobot.logger.info(
-          "[Force] should have exited: today=#{@today} is marked as weekend on kot: #{@kot_today}"
+          "[Force] should have exited: today=#{@today} is marked as public holiday: #{@kot_data[:today]}"
         )
       end
 
-      return unless kot_public_holiday?
-      raise KotRecordError, "Today=#{@today} is marked as public holiday on kot: #{@kot_today}" unless Config.force
+      if kot_non_work_schedule?
+        raise KotRecordError, "Today=#{@today} is non-work schedule: #{@kot_data[:today_schedule]}" unless Config.force
 
-      Kobot.logger.info(
-        "[Force] should have exited: today=#{@today} is marked as public holiday on kot: #{@kot_today}"
-      )
+        Kobot.logger.info(
+          "[Force] should have exited: today=#{@today} is non-work schedule: #{@kot_data[:today_schedule]}"
+        )
+      end
     end
 
     def clock_in!
       Kobot.logger.warn("Clock in during the afternoon: #{@now}") if @now.hour > 12
-      if @kot_today_clock_in.strip.empty?
+      if @kot_data[:today_clock_in].strip.empty?
         click_clock_in_button
         return if Config.dryrun
 
         read_today_record
-        raise KotClockInError, 'Clock in operation seems to have failed' if @kot_today_clock_in.strip.empty?
+        raise KotClockInError, 'Clock in operation seems to have failed' if @kot_data[:today_clock_in].strip.empty?
 
-        Kobot.logger.info("Clock in successful: #{@kot_today_clock_in}")
+        Kobot.logger.info("Clock in successful: #{@kot_data[:today_clock_in]}")
         Mailer.send(clock_notify_message(clock: :in))
       else
-        Kobot.logger.warn("Clock in done already: #{@kot_today_clock_in}")
+        Kobot.logger.warn("Clock in done already: #{@kot_data[:today_clock_in]}")
       end
     end
 
     def clock_out!
       Kobot.logger.warn("Clock out during the morning: #{@now}") if @now.hour <= 12
       unless Config.dryrun
-        if @kot_today_clock_in.strip.empty?
+        if @kot_data[:today_clock_in].strip.empty?
           raise KotClockOutError,
-                "!!!No clock in record for today=#{@kot_today}!!!"
+                "!!!No clock in record for today=#{@kot_data[:today]}!!!"
         end
       end
 
-      if @kot_today_clock_out.strip.empty?
+      if @kot_data[:today_clock_out].strip.empty?
         click_clock_out_button
         return if Config.dryrun
 
         read_today_record
-        raise KotClockOutError, 'Clock out operation seems to have failed' if @kot_today_clock_out.strip.empty?
+        raise KotClockOutError, 'Clock out operation seems to have failed' if @kot_data[:today_clock_out].strip.empty?
 
-        Kobot.logger.info("Clock out successful: #{@kot_today_clock_out}")
+        Kobot.logger.info("Clock out successful: #{@kot_data[:today_clock_out]}")
         Mailer.send(clock_notify_message(clock: :out))
       else
-        Kobot.logger.warn("Clock out done already: #{@kot_today_clock_out}")
+        Kobot.logger.warn("Clock out done already: #{@kot_data[:today_clock_out]}")
       end
     end
 
@@ -222,9 +250,9 @@ module Kobot
       @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')
+        Kobot.logger.info('[Dryrun] Clock-in button (出勤) would have been clicked')
       else
-        Kobot.logger.info('Clicking the clock in button (出勤)')
+        Kobot.logger.info('Clicking the Clock-in button (出勤)')
         clock_in_button.click
       end
     end
@@ -234,9 +262,9 @@ module Kobot
       @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')
+        Kobot.logger.info('[Dryrun] Clock-out button (退勤) would have been clicked')
       else
-        Kobot.logger.info('Clicking the clock in button (退勤)')
+        Kobot.logger.info('Clicking the Clock-out button (退勤)')
         clock_out_button.click
       end
     end
@@ -253,18 +281,25 @@ module Kobot
     end
 
     def kot_weekend?
-      %w[土 日].any? { |kanji| @kot_today&.include? kanji }
+      [
+        @selector.kot_date_saturday,
+        @selector.kot_date_sunday
+      ].any? { |weekend| @kot_data[:today]&.include? weekend }
+    end
+
+    def kot_non_work_schedule?
+      !@kot_data[:today_schedule]&.include?(Config.auto_skip_without)
     end
 
     def kot_public_holiday?
-      return true if @kot_today_type&.include? '休日'
+      return true if @kot_data[:today_type]&.include? @selector.kot_workday_time_off_text
 
       kot_today_highlighted = %w[sunday saturday].any? do |css|
-        @kot_today_css_class&.include? css
+        @kot_data[:today_css_class]&.include? css
       end
       if kot_today_highlighted
         Kobot.logger.warn(
-          "Today=#{@kot_today} is highlighted (holiday) but not marked as 休日"
+          "Today=#{@kot_data[:today]} is highlighted (holiday) but not marked as #{@selector.kot_workday_time_off_text}"
         )
       end
       kot_today_highlighted
@@ -276,8 +311,8 @@ module Kobot
         "<b>Date:</b> #{@today}",
         "<b>Status:</b> <span style='color:#{color}'>#{status}</span>"
       ]
-      message << "<b>Clock_in:</b> #{@kot_today_clock_in}" if clock
-      message << "<b>Clock_out:</b> #{@kot_today_clock_out}" if clock == :out
+      message << "<b>Clock_in:</b> #{@kot_data[:today_clock_in]}" if clock
+      message << "<b>Clock_out:</b> #{@kot_data[:today_clock_out]}" if clock == :out
       message.join('<br>')
     end
   end

data/lib/kobot/exception.rb

@@ -1,12 +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/option.rb

@@ -27,6 +27,13 @@ module Kobot
             options[:skip] = skip
           end
 
+          opt.on('-a', '--auto-skip-without [SCHEDULE]',
+                 'Enable automatic skipping by reading schedule from the Time Card page;',
+                 'skip today if the provided text is not contained in the schedule column',
+                 'on the Time Card page; by default 裁量労働 is used') do |schedule|
+            options[:auto_skip_without] = schedule
+          end
+
           opt.on('-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') do |to|

data/lib/kobot/selector.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Kobot
+  # The texts used in selectors to identify the elements on KOT UI.
+  class Selector
+    attr_accessor :login_success_notification_text,
+                  :location_area_notification_text,
+                  :time_card_menu_link_text,
+                  :kot_date_saturday,
+                  :kot_date_sunday,
+                  :kot_workday_time_off_text,
+                  :logout_menu_link_text
+
+    class << self
+      def en
+        selector = Selector.new
+        selector.login_success_notification_text = 'Data has been obtained'
+        selector.location_area_notification_text = 'Obtained location'
+        selector.time_card_menu_link_text = 'Time Card'
+        selector.kot_date_saturday = 'Sat'
+        selector.kot_date_sunday = 'Sun'
+        selector.kot_workday_time_off_text = 'time-off'
+        selector.logout_menu_link_text = 'Sign out'
+        selector
+      end
+
+      def ja
+        selector = Selector.new
+        selector.login_success_notification_text = 'データを取得しました'
+        selector.location_area_notification_text = '位置情報取得済み'
+        selector.time_card_menu_link_text = 'タイムカード'
+        selector.kot_date_saturday = '土'
+        selector.kot_date_sunday = '日'
+        selector.kot_workday_time_off_text = '休日'
+        selector.logout_menu_link_text = 'ログアウト'
+        selector
+      end
+    end
+  end
+end

data/lib/kobot/version.rb

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

data/lib/kobot.rb

@@ -4,6 +4,7 @@ require 'kobot/version'
 require 'kobot/exception'
 require 'kobot/option'
 require 'kobot/config'
+require 'kobot/selector'
 require 'kobot/credential'
 require 'kobot/logger'
 require 'kobot/mailer'
@@ -33,6 +34,7 @@ module Kobot
         config.dryrun                = options[:dryrun]
         config.force                 = options[:force]
         config.skip                  = options[:skip] || []
+        config.auto_skip_without     = options[:auto_skip_without] || '裁量労働'
 
         config.kot_url               = 'https://s2.kingtime.jp/independent/recorder/personal/'
         config.kot_timezone_offset   = '+09:00'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kobot
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.3.0
 platform: ruby
 authors:
 - Andy Jiang
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-03 00:00:00.000000000 Z
+date: 2021-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: webdrivers
@@ -83,6 +83,7 @@ files:
 - lib/kobot/logger.rb
 - lib/kobot/mailer.rb
 - lib/kobot/option.rb
+- lib/kobot/selector.rb
 - lib/kobot/version.rb
 homepage: https://github.com/yuan-jiang/kobot
 licenses:
@@ -107,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Kobot automates the clock in/out of KING OF TIME.