kobot 1.2.4 → 1.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e8cedf9053f994144d21b233b2c68fb4e03aff011192f1273e1ad24d347c4f9
-  data.tar.gz: 8daab86f87c5ffe5e0588c9029ccd062954ca7ad3557769861ef19fd07347c79
+  metadata.gz: f35251b3ce8549b6b268a9741ecc88398f4fca4e1fbe27c343e2a1c35d456ca0
+  data.tar.gz: 1af276cc34607f075650b5be4df65c9666449c761b410fb5cc63629fe0392ff7
 SHA512:
-  metadata.gz: 4aaaa2f0e8eebe98487536158b0f571e794b76db95dec5cd2eb268037dfd0888045d6cebbeb46876162ed9944813f7429e8a4466da20ca9010ecacfd552cd302
-  data.tar.gz: 9ede3410f3ad664982db308f382140eb19bc8140970fc4991f68829a0c63fe664a6978b99ef5753036954a0bbabb9731b3f7e5fe08aff11c589798898ce0ec59
+  metadata.gz: a1a76b64eb1aa1019a12b4f1d4a2d34c84d79cf020b0ebc7cee7c1bd4902b180aec70790ee236883100bfd2501bbee9846f61b5b40dd8fb3996159e58b94b0df
+  data.tar.gz: a81c35396d3dde1a74ab9aad3c3535e92699268f49a133f9f43514b192bae808a84f1974c9f9c537690ce3561c942251c044591fc363b54c619b44586ede7670

data/CHANGELOG.md

@@ -25,3 +25,6 @@
 
 ### 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/lib/kobot/engine.rb

@@ -97,6 +97,12 @@ module Kobot
       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}"
@@ -106,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
@@ -119,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|
@@ -226,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
@@ -238,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
@@ -257,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/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.4'
+  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'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kobot
 version: !ruby/object:Gem::Version
-  version: 1.2.4
+  version: 1.2.5
 platform: ruby
 authors:
 - Andy Jiang
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-18 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.