kobot 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a9d8a789566c49cffabd4006d13502a6222a211d9193cdf58f0523c6dd89937
-  data.tar.gz: 993fed11502b5149ece85da3d46d69f74169cf75c479221e56becf6b195d6d97
+  metadata.gz: 00f2c1151ffcb202b20d4b3f9881c9570b1075ea3684f7ab3ea2cfc65baf4b33
+  data.tar.gz: a6f3da0260abbbfce192557ea580526698b828ed19ec7175dd64080fa437ba35
 SHA512:
-  metadata.gz: 3fe31ae275852246a0ba1656f829352ef204278d55f4578bc160d1917b8c07a8586b621eee42ed80e1c7535c0650de0cd8a7edcbb5b7da9f7359f2fa42a8a435
-  data.tar.gz: e904e08fe88b5c616e5c7287e77a6de4d0e7b85dba1306e4c5dd8ab9ff24938437cd69dcfed4e2da0c6904ddbfb561a96a4aea92f0d61a268b2460591d950efe
+  metadata.gz: 4fb7e982db990bdbf659009501f3eb028d02fdddf7e8d6ea48762495867196f5dfc748c6d14926d5239b57c4433dad3d2568c8d6ca9bf42d6de401b91391e7a3
+  data.tar.gz: '06482f411bfbf8f0083d0750e7d8ea4074f6740de3e9b1d6ba27c3e850356cd28c39d83d3a27f5d99bf7e21589cce65d64396793ffd018180ec621f926db7327'

data/CHANGELOG.md

@@ -1,2 +1,7 @@
 ### v1.0.0
 - Initial release
+
+### v1.1.0
+- 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

data/README.md

@@ -1,8 +1,9 @@
-# Kobot
+# Kobot [![Gem Version](https://badge.fury.io/rb/kobot.svg)](https://badge.fury.io/rb/kobot)
 
 Kobot is a simple tool to automate the clock in or clock out operation on the web service
-provided by [KING OF TIME](kingtime.jp) by leveraging [Selenium WebDriver](selenium.dev),
-and with Google Gmail service email notification can also be sent to notify the results.
+provided by [KING OF TIME](https://www.kingtime.jp/) by leveraging [Selenium WebDriver](
+https://www.selenium.dev/), and with Google Gmail service email notifications can also be
+sent to notify the results.
 
 It is meant for use only by one working under the discretionary labor system or flexible
 hours where the daily record is still required regardless of the actual start or end time
@@ -21,10 +22,11 @@ Tested on macOS Catelina and runs on Heroku platform so it works on unix-like sy
 #### Configuration
 
 By default it uses `~/.kobot` file locally to persist credentials for reuse, but all credentials
-can be overridden by setting environment variables, which is the recommended way of running the
-job on platforms like Heroku. When running for the first time, if none of the configuration file
-and ENV satisfies all required credentials, an interactive prompt will be displayed for setting,
-so there is no need to manually prepare the file beforehand. The content looks something like:
+can also be supplied or overridden by runtime environment variables, which is the recommended way
+of running as scheduled jobs on platforms like Heroku. When running for the first time, if neither
+the configuration file nor ENV satisfies all required credentials, `an interactive prompt will be
+displayed for initial setting, so there is no need to manually prepare the file beforehand`. The
+content looks something like:
 ```property
 kot_id=xxx
 kot_password=xxx
@@ -34,6 +36,7 @@ Gmail account and password (or `app` password if MFA is on) are asked when notif
 gmail_id=xxx
 gmail_password=xxx
 ```
+Note: use all upper-case letters for the above variables if using environment variables, e.g. `KOT_ID`.
 
 #### Google Chrome browser
 
@@ -51,13 +54,14 @@ $ gem install kobot
 ## Usage
 
 Get help doc:
-```bash
+```
 $ 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
     -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
                                      the same self email account used in SMTP config as the sender
     -n, --notify                     Enable email notification
@@ -69,20 +73,25 @@ Usage: kobot [options]
 ```
 
 Dryrun to try out:
-```bash
-$ kobot --clock in --dryrun
+```
+$ kobot --clock in --notify --dryrun
 ```
 
 Clock in/out with email notification
-```bash
-$ kobot --clock in --notify
-$ kobot --clock out --notify
+```
+$ kobot --clock in --notify --headless
+$ kobot --clock out --notify --headless
 ```
 
 Run the task with crontab
 ```cron
-30 09 * * * user kobot --clock in --notify
-30 18 * * * user kobot --clock out --notify
+# Weekend and public holidays will be skipped by default
+30 09 * * * user kobot --cin -n -x
+30 18 * * * user kobot --cout -n -x
+
+# Skip for weekdays planned to take leave for example
+30 09 * * * user kobot --cin -n -x -s 2020-09-01,2020-11-11
+30 18 * * * user kobot --cout -n -x -s 2020-09-01,2020-11-11
 ```
 On platforms like Heroku, an add-on called [Heroku Scheduler](https://elements.heroku.com/addons/scheduler) makes
 running scheduled tasks much easier. Tips: either clock in or clock out task can be scheduled multiple times in

data/kobot.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
 
   spec.homepage                      = 'https://github.com/yuan-jiang/kobot'
   spec.license                       = 'MIT'
-  spec.required_ruby_version         = Gem::Requirement.new('>= 2.3.0')
+  spec.required_ruby_version         = Gem::Requirement.new('>= 2.4.0')
 
   spec.metadata['allowed_push_host'] = 'https://rubygems.org/'
   spec.metadata['homepage_uri']      = spec.homepage

data/lib/kobot/credential.rb

@@ -41,18 +41,22 @@ module Kobot
         if File.exist? Config.credentials_file
           File.open(Config.credentials_file) do |file|
             file.each do |line|
-              attr, value = line.chomp.split('=')
+              attr, value = line.strip.split('=')
               @credentials[attr] = value
             end
           end
         end
-        @credentials['kot_id'] = ENV['kot_id'] if ENV['kot_id']
-        @credentials['kot_password'] = ENV['kot_password'] if ENV['kot_password']
-        @credentials['gmail_id'] = ENV['gmail_id'] if ENV['gmail_id']
-        @credentials['gmail_password'] = ENV['gmail_password'] if ENV['gmail_password']
-
         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
+          env_attr_value = ENV[attr.upcase] || ENV[attr]
+          @credentials[attr] = env_attr_value if env_attr_value
+        end
         required_credentials.none? do |attr|
           credential = @credentials[attr]
           !credential || credential.strip.empty?

data/lib/kobot/option.rb

@@ -24,7 +24,8 @@ module Kobot
 
           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') do |skip|
+                 '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|
             options[:skip] = skip
           end
 

data/lib/kobot/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kobot
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Andy Jiang
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-10 00:00:00.000000000 Z
+date: 2020-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: webdrivers
@@ -100,7 +100,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="