kobot 1.2.1 → 1.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dfc009d1da0376709ddb63ebec8176601a53cee00bc216c82554c403051d430f
-  data.tar.gz: d7df58f052b9e2e945efd43c5cb11169c20d00b7d09a5d25ebfd3b688d1e16e8
+  metadata.gz: f35251b3ce8549b6b268a9741ecc88398f4fca4e1fbe27c343e2a1c35d456ca0
+  data.tar.gz: 1af276cc34607f075650b5be4df65c9666449c761b410fb5cc63629fe0392ff7
 SHA512:
-  metadata.gz: 7728891bc95db5eb4dd2d9a4c4d20916930da12b32c82af6ee2458d4cb9e66a7c37cb4156a89f857b93141c22d06493b7f9bce4f5238786d0031bf8b0f64d0a6
-  data.tar.gz: e4bc4ae0867ecfbe3bdd1018c9ffb9c578f34bf189f820e7344bbca7a7d5f209faee49e73d45f737161993cb2b3ea2f006695ee7f9870ea0dd1f7dea7417ad64
+  metadata.gz: a1a76b64eb1aa1019a12b4f1d4a2d34c84d79cf020b0ebc7cee7c1bd4902b180aec70790ee236883100bfd2501bbee9846f61b5b40dd8fb3996159e58b94b0df
+  data.tar.gz: a81c35396d3dde1a74ab9aad3c3535e92699268f49a133f9f43514b192bae808a84f1974c9f9c537690ce3561c942251c044591fc363b54c619b44586ede7670

data/CHANGELOG.md

@@ -14,3 +14,17 @@
 - 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
+
+### v1.2.5
+- Added I18n support for both English and Japanese KOT UI

data/bin/console

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

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

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,

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,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
@@ -69,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: {
@@ -90,9 +86,24 @@ 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
       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}"
       end
@@ -101,10 +112,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
@@ -114,21 +129,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|
@@ -139,8 +154,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,
@@ -154,30 +173,23 @@ module Kobot
       end
     end
 
-    def verify_today_record!
+    def validate_today_record!
       raise KotRecordError, "Today=#{@today} is not found on kot" if @kot_today.strip.empty?
 
       if kot_weekend?
-        unless Config.force
-          raise KotRecordError,
-                "Today=#{@today} is marked as weekend on kot: #{@kot_today}"
-        end
+        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
 
-      if kot_public_holiday?
-        unless Config.force
-          raise KotRecordError,
-                "Today=#{@today} is marked as public holiday 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
+      Kobot.logger.info(
+        "[Force] should have exited: today=#{@today} is marked as public holiday on kot: #{@kot_today}"
+      )
     end
 
     def clock_in!
@@ -224,9 +236,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
@@ -236,9 +248,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
@@ -255,18 +267,21 @@ module Kobot
     end
 
     def kot_weekend?
-      %w[土 日].any? { |kanji| @kot_today&.include? kanji }
+      [
+        @selector.kot_date_saturday,
+        @selector.kot_date_sunday
+      ].any? { |weekend| @kot_today&.include? weekend }
     end
 
     def kot_public_holiday?
-      return true if @kot_today_type&.include? '休日'
+      return true if @kot_today_type&.include? @selector.kot_workday_time_off_text
 
       kot_today_highlighted = %w[sunday saturday].any? do |css|
         @kot_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_today} is highlighted (holiday) but not marked as #{@selector.kot_workday_time_off_text}"
         )
       end
       kot_today_highlighted

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,11 +3,9 @@
 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 = {}

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.1'
+  VERSION = '1.2.5'
 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'
@@ -14,8 +15,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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kobot
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.5
 platform: ruby
 authors:
 - Andy Jiang
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-27 00:00:00.000000000 Z
+date: 2021-12-07 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.