kobot 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c867dcb791e15db7a407fc9dc0898ad49e9dccba53514f98ad32b253f1fc8adc
-  data.tar.gz: 6887ebe669b7628a7972a89d2b508b498f5ce856fe80d98e85a52c3bcedfd377
+  metadata.gz: dfc009d1da0376709ddb63ebec8176601a53cee00bc216c82554c403051d430f
+  data.tar.gz: d7df58f052b9e2e945efd43c5cb11169c20d00b7d09a5d25ebfd3b688d1e16e8
 SHA512:
-  metadata.gz: 8ed4028a1a25f75cfa21370c41b72a7fbe66916c442279f7985b3dc6f1be6e540395b81292931549b53496b7db026ec0ca33f9c743623176207d31bf1b740aa4
-  data.tar.gz: b53a002259ad6312ae6437d11320b9b12f8d62e3ac26a01ed4e3dc48399cfb9d2f572384aebc2c3930014bf77e83c6351c7e7cf051b5eab02a87db33e31f7f51
+  metadata.gz: 7728891bc95db5eb4dd2d9a4c4d20916930da12b32c82af6ee2458d4cb9e66a7c37cb4156a89f857b93141c22d06493b7f9bce4f5238786d0031bf8b0f64d0a6
+  data.tar.gz: e4bc4ae0867ecfbe3bdd1018c9ffb9c578f34bf189f820e7344bbca7a7d5f209faee49e73d45f737161993cb2b3ea2f006695ee7f9870ea0dd1f7dea7417ad64

data/CHANGELOG.md

@@ -9,3 +9,8 @@
 ### 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

data/lib/kobot/credential.rb

@@ -30,7 +30,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 +49,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

@@ -33,8 +33,8 @@ module Kobot
           return
         end
       end
-      if holiday?
-        Kobot.logger.info("Today=#{@today} is holiday")
+      if skip?
+        Kobot.logger.info("Today=#{@today} is skipped as per: --skip=#{Config.skip}")
         return
       end
       unless %i[in out].include? Config.clock
@@ -69,6 +69,7 @@ module Kobot
       Mailer.send(clock_notify_message(status: e.message))
       logout
     ensure
+      Kobot.logger.info('Close browser')
       @browser&.quit
     end
 
@@ -90,8 +91,8 @@ module Kobot
     end
 
     def login
-      @browser.get @top_url
       Kobot.logger.info("Navigate to: #{@top_url}")
+      @browser.get @top_url
       Kobot.logger.debug do
         "Login with id=#{Credential.kot_id} and password=#{Credential.kot_password}"
       end
@@ -108,13 +109,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
@@ -123,6 +126,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
 
@@ -216,21 +220,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
@@ -239,7 +247,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/version.rb

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

metadata

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