kobot 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5a9d8a789566c49cffabd4006d13502a6222a211d9193cdf58f0523c6dd89937
+  data.tar.gz: 993fed11502b5149ece85da3d46d69f74169cf75c479221e56becf6b195d6d97
+SHA512:
+  metadata.gz: 3fe31ae275852246a0ba1656f829352ef204278d55f4578bc160d1917b8c07a8586b621eee42ed80e1c7535c0650de0cd8a7edcbb5b7da9f7359f2fa42a8a435
+  data.tar.gz: e904e08fe88b5c616e5c7287e77a6de4d0e7b85dba1306e4c5dd8ab9ff24938437cd69dcfed4e2da0c6904ddbfb561a96a4aea92f0d61a268b2460591d950efe

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/Gemfile.lock
+/*.gem

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.6
+before_install: gem install bundler -v 2.1.4

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+### v1.0.0
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at andy.jiang@appier.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in kobot.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Andy Jiang
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,121 @@
+# 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.
+
+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
+of working, for example, software programmers or IT related engineers.
+
+By being run in a periodic schedule system such as crontab, it eases the mental burden to
+one for trying not to forget the clock action, as well as reduces the application process
+for making up for the records when it was forgotten.
+
+## Installation
+
+#### Environment
+
+Tested on macOS Catelina and runs on Heroku platform so it works on unix-like systems.
+
+#### 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:
+```property
+kot_id=xxx
+kot_password=xxx
+```
+Gmail account and password (or `app` password if MFA is on) are asked when notification is needed:
+```property
+gmail_id=xxx
+gmail_password=xxx
+```
+
+#### Google Chrome browser
+
+Make sure the latest version of Google Chrome is installed in system. On platforms like Heroku,
+the [heroku-buildpack-google-chrome](https://elements.heroku.com/buildpacks/heroku/heroku-buildpack-google-chrome)
+makes it extremely easy to get the browser ready.
+
+#### Install the command line tool 
+
+Make sure a modern version of Ruby is available and run command below to install:
+```bash
+$ 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
+    -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
+    -d, --dryrun                     Run the process without actual clock in/out
+    -x, --headless                   Start browser in headless mode
+    -g, --geolocation                Allow browser to use geolocation
+    -h, --help                       Show this help message
+    -v, --version                    Show current version
+```
+
+Dryrun to try out:
+```bash
+$ kobot --clock in --dryrun
+```
+
+Clock in/out with email notification
+```bash
+$ kobot --clock in --notify
+$ kobot --clock out --notify
+```
+
+Run the task with crontab
+```cron
+30 09 * * * user kobot --clock in --notify
+30 18 * * * user kobot --clock out --notify
+```
+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
+case Scheduler misses to run due to Heroku system failures (which might occur very rarely in reality).
+
+## Dependency
+
+Kobot is an opinionated tool for which the only purpose is to get the tedious process automated, and therefore
+Google Chrome is used as the supported browser and Google Gmail is chosen to be the email notification service
+because both simply just work to get the job done. The [webdrivers](https://github.com/titusfortner/webdrivers)
+gem is the only direct dependency and it is by intention to minimize the runtime gem dependency. 
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests.
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the
+version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version,
+push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/yuan-jiang/kobot.
+This project is intended tobe a safe, welcoming space for collaboration, and contributors are
+expected to adhere to the [code of conduct](https://github.com/yuan-jiang/kobot/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Kobot project's codebases, issue trackers, chat rooms and mailing lists is expected to
+follow the [code of conduct](https://github.com/yuan-jiang/kobot/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'kobot'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/kobot

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'kobot'
+
+Kobot.run

data/kobot.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative 'lib/kobot/version'
+
+Gem::Specification.new do |spec|
+  spec.name                          = 'kobot'
+  spec.version                       = Kobot::VERSION
+  spec.authors                       = ['Andy Jiang']
+  spec.email                         = ['yuanjiang@outlook.com']
+
+  spec.summary                       = 'Kobot automates the clock in/out of KING OF TIME.'
+  spec.description                   = <<-DESC
+    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.
+  DESC
+
+  spec.homepage                      = 'https://github.com/yuan-jiang/kobot'
+  spec.license                       = 'MIT'
+  spec.required_ruby_version         = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org/'
+  spec.metadata['homepage_uri']      = spec.homepage
+  spec.metadata['source_code_uri']   = 'https://github.com/yuan-jiang/kobot'
+  spec.metadata['changelog_uri']     = 'https://github.com/yuan-jiang/kobot/blob/master/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files                         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir                        = 'exe'
+  spec.executables                   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths                 = ['lib']
+
+  spec.add_runtime_dependency 'webdrivers', '~> 4.0'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/kobot.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'kobot/version'
+require 'kobot/exception'
+require 'kobot/option'
+require 'kobot/config'
+require 'kobot/credential'
+require 'kobot/logger'
+require 'kobot/mailer'
+require 'kobot/engine'
+
+# 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.
+module Kobot
+  class << self
+
+    # The entrance to run Kobot.
+    def run
+      configure
+      Engine.new.start
+    rescue StandardError => e
+      logger.error e.message
+      logger.error e.backtrace
+      Mailer.send e.message
+    end
+
+    # Parses command line options, configures Kobot, and finally ensures
+    # required credentials are loaded properly and ready to be in use.
+    def configure
+      options = Option.parse!
+      Config.configure do |config|
+        config.clock                 = options[:clock].to_sym
+        config.loglevel              = options[:loglevel]&.to_sym || :info
+        config.dryrun                = options[:dryrun]
+        config.skip                  = options[:skip] || []
+
+        config.kot_url               = 'https://s2.kingtime.jp/independent/recorder/personal/'
+        config.kot_timezone_offset   = '+09:00'
+        config.kot_date_format       = '%m/%d'
+
+        config.gmail_notify_enabled  = options[:notify]
+        config.gmail_notify_to       = options[:to]
+        config.gmail_notify_subject  = "[#{Module.nesting.last}] Notification"
+        config.gmail_smtp_address    = 'smtp.gmail.com'
+        config.gmail_smtp_port       = 587
+
+        config.browser_headless      = options[:headless]
+        config.browser_geolocation   = options[:geolocation]
+        config.browser_wait_timeout  = 10
+
+        config.credentials_file      = File.join(Dir.home, ".#{File.basename(__FILE__, File.extname(__FILE__))}")
+      end
+      Credential.load!
+    end
+
+    def logger
+      @logger ||= Logger.new
+    end
+  end
+end

data/lib/kobot/config.rb

@@ -0,0 +1,35 @@
+# 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
+    class << self
+      attr_accessor :clock,
+                    :loglevel,
+                    :skip,
+                    :dryrun
+
+      attr_accessor :kot_url,
+                    :kot_timezone_offset,
+                    :kot_date_format
+
+      attr_accessor :gmail_notify_enabled,
+                    :gmail_notify_subject,
+                    :gmail_notify_to,
+                    :gmail_smtp_address,
+                    :gmail_smtp_port
+
+      attr_accessor :browser_headless,
+                    :browser_geolocation,
+                    :browser_wait_timeout
+
+      attr_accessor :credentials_file
+
+      def configure
+        yield self
+      end
+    end
+  end
+end

data/lib/kobot/credential.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+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,
+                    :gmail_id,
+                    :gmail_password
+
+      # Make sure credentials are loaded by first checking
+      # and reading from #{Config.credentials_file} if it
+      # exists and then overriding any credentials if they
+      # are also supplied as environment variables in ENV.
+      #
+      # If neither #{Config.credentials_file} nor ENV has
+      # all the required credentials a command line prompt
+      # will be displayed for users to input credentials
+      # which will be saved to #{Config.credentials.file}
+      # for later use.
+      #
+      # KOT id and password are required by default and
+      # Gmail SMTP id and password are required only when
+      # #{Config.gmail_notify_enabled} is true.
+      def load!
+        prompt_for_credentials until credentials_loaded
+        @credentials.each do |attr, value|
+          send("#{attr}=".to_sym, value)
+        end
+        Kobot.logger.info('Credentials load successful')
+        Kobot.logger.debug(@credentials)
+      end
+
+      private
+
+      def credentials_loaded
+        @credentials ||= {}
+        if File.exist? Config.credentials_file
+          File.open(Config.credentials_file) do |file|
+            file.each do |line|
+              attr, value = line.chomp.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.none? do |attr|
+          credential = @credentials[attr]
+          !credential || credential.strip.empty?
+        end
+      end
+
+      def prompt_for_credentials
+        puts 'Required credentials missing, please enter:'
+        print 'kot_id: '
+        kot_id_input = gets.chomp
+        print 'kot_password: '
+        kot_password_input = gets.chomp
+        if Config.gmail_notify_enabled
+          print 'gmail_id: '
+          gmail_id_input = gets.chomp
+          print 'gmail_password: '
+          gmail_password_input = gets.chomp
+        end
+        File.open(Config.credentials_file, 'w+') do |file|
+          file.puts "kot_id=#{kot_id_input}"
+          file.puts "kot_password=#{kot_password_input}"
+          if Config.gmail_notify_enabled
+            file.puts "gmail_id=#{gmail_id_input}"
+            file.puts "gmail_password=#{gmail_password_input}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/kobot/engine.rb

@@ -0,0 +1,254 @@
+# frozen_string_literal: true
+
+require 'webdrivers/chromedriver'
+
+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)
+      @top_url = Config.kot_url
+    end
+
+    # The entrance where the whole flow starts.
+    #
+    # It exits early if today is weekend or treated as holiday by
+    # the #{Config.skip} specified from command line option --skip.
+    #
+    # Unexpected behavior such as record appearing as holiday on
+    # the web or failure of clock in/out action is handled within
+    # the method by logging and/or email notifications if enabled.
+    #
+    # 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?
+        Kobot.logger.info("Today=#{@today} is weekend.")
+        return
+      end
+      if holiday?
+        Kobot.logger.info("Today=#{@today} is holiday.")
+        return
+      end
+      unless %i[in out].include? Config.clock
+        Kobot.logger.warn("Invalid clock operation: #{Config.clock}")
+        return
+      end
+      launch_browser
+      login
+      read_today_record
+      verify_today_record!
+      if Config.clock == :in
+        clock_in!
+      else
+        clock_out!
+      end
+      logout
+    rescue KotRecordError => e
+      Kobot.logger.warn(e.message)
+      Mailer.send(clock_notify_message(status: e.message))
+      logout
+    rescue KotClockInError => e
+      Kobot.logger.warn e.message
+      Mailer.send(clock_notify_message(clock: :in, status: e.message))
+      logout
+    rescue KotClockOutError => e
+      Kobot.logger.warn e.message
+      Mailer.send(clock_notify_message(clock: :out, status: e.message))
+      logout
+    rescue StandardError => e
+      Kobot.logger.error(e.message)
+      Kobot.logger.error(e.backtrace)
+      Mailer.send(clock_notify_message(status: e.message))
+      logout
+    ensure
+      @browser&.quit
+    end
+
+    private
+
+    def launch_browser
+      prefs = {
+        profile: {
+          default_content_settings: {
+            geolocation: Config.browser_geolocation ? 1 : 2
+          }
+        }
+      }
+      options = Selenium::WebDriver::Chrome::Options.new(prefs: prefs)
+      options.headless! if Config.browser_headless
+      @browser = Selenium::WebDriver.for(:chrome, options: options)
+      @wait = Selenium::WebDriver::Wait.new(timeout: Config.browser_wait_timeout)
+      Kobot.logger.info('Launch browser successful')
+    end
+
+    def login
+      @browser.get @top_url
+      Kobot.logger.info("Navigate to: #{@top_url}")
+      Kobot.logger.debug do
+        "Login with id=#{Credential.kot_id} and password=#{Credential.kot_password}"
+      end
+      @browser.find_element(id: 'id').send_keys Credential.kot_id
+      @browser.find_element(id: 'password').send_keys Credential.kot_password
+      @browser.find_element(css: 'div.btn-control-message').click
+
+      Kobot.logger.info 'Login successful'
+      @wait.until { @browser.find_element(id: 'notification_content').text.include?('データを取得しました') }
+      if Config.browser_geolocation
+        begin
+          @wait.until { @browser.find_element(id: 'location_area').text.include?('位置情報取得済み') }
+        rescue StandardError => e
+          Kobot.logger.warn "Get geolocation failed: #{e.message}"
+        end
+      end
+      Kobot.logger.info @browser.title
+    end
+
+    def logout
+      if @browser.current_url.include? 'admin'
+        @browser.find_element(css: 'div.htBlock-header_logoutButton').click
+      else
+        @wait.until { @browser.find_element(id: 'menu_icon') }.click
+        @wait.until { @browser.find_element(link: 'ログアウト') }.click
+        @browser.switch_to.alert.accept
+      end
+      Kobot.logger.info 'Logout successful'
+    end
+
+    def read_today_record
+      @wait.until { @browser.find_element(id: 'menu_icon') }.click
+      @wait.until { @browser.find_element(link: 'タイムカード') }.click
+
+      time_table = @wait.until { @browser.find_element(css: 'div.htBlock-adjastableTableF_inner > table') }
+      time_table.find_elements(css: 'tbody > tr').each do |tr|
+        date_cell = tr.find_element(css: 'td.htBlock-scrollTable_day')
+        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(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,
+            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
+          }
+        end
+        break
+      end
+    end
+
+    def verify_today_record!
+      raise KotRecordError, "Today=#{@today} is not found on kot." if @kot_today.strip.empty?
+      raise KotRecordError, "Today=#{@today} is marked as weekend on kot: #{@kot_today}" if kot_weekend?
+      raise KotRecordError, "Today=#{@today} is marked as public holiday on kot: #{@kot_today}" if kot_public_holiday?
+    end
+
+    def clock_in!
+      Kobot.logger.warn("Clock in during the afternoon: #{@now}") if @now.hour > 12
+      if @kot_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?
+
+        Kobot.logger.info("Clock in successful: #{@kot_today_clock_in}")
+        Mailer.send(clock_notify_message(clock: :in))
+      else
+        Kobot.logger.warn("Clock in done already: #{@kot_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?
+          raise KotClockOutError,
+                "!!!No clock in record for today=#{@kot_today}!!!"
+        end
+      end
+
+      if @kot_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?
+
+        Kobot.logger.info("Clock out successful: #{@kot_today_clock_out}")
+        Mailer.send(clock_notify_message(clock: :out))
+      else
+        Kobot.logger.warn("Clock out done already: #{@kot_today_clock_out}")
+      end
+    end
+
+    def click_clock_in_button
+      @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
+        clock_in_button.click
+      end
+    end
+
+    def click_clock_out_button
+      @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
+        clock_out_button.click
+      end
+    end
+
+    def weekend?
+      @now.saturday? || @now.sunday?
+    end
+
+    def holiday?
+      return false unless Config.skip
+      return false unless Config.skip.respond_to? :include?
+
+      Config.skip.include? @now.strftime('%F')
+    end
+
+    def kot_weekend?
+      %w[土 日].any? { |kanji| @kot_today&.include? kanji }
+    end
+
+    def kot_public_holiday?
+      return true if @kot_today_type&.include? '休日'
+
+      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 休日"
+        )
+      end
+      kot_today_highlighted
+    end
+
+    def clock_notify_message(clock: nil, status: :success)
+      color = status == :success ? 'green' : 'red'
+      message = [
+        "<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.join('<br>')
+    end
+  end
+end

data/lib/kobot/exception.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Kobot
+
+  class KotRecordError < StandardError
+  end
+
+  class KotClockInError < StandardError
+  end
+
+  class KotClockOutError < StandardError
+  end
+
+end

data/lib/kobot/logger.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+require 'logger'
+
+# Code adapted conveniently from webdrivers for consistency
+# https://github.com/titusfortner/webdrivers/blob/master/lib/webdrivers/logger.rb
+
+module Kobot
+  #
+  # @example Enable full logging
+  #   Kobot.logger.level = :debug
+  #
+  # @example Log to file
+  #   Kobot.logger.output = 'kobot.log'
+  #
+  # @example Use logger manually
+  #   Kobot.logger.info('This is info message')
+  #   Kobot.logger.warn('This is warning message')
+  #
+  class Logger
+    extend Forwardable
+    include ::Logger::Severity
+
+    def_delegators :@logger, :debug, :debug?,
+                   :info, :info?,
+                   :warn, :warn?,
+                   :error, :error?,
+                   :fatal, :fatal?,
+                   :level
+
+    def initialize
+      @logger = create_logger($stdout)
+    end
+
+    def output=(io)
+      # `Logger#reopen` was added in Ruby 2.3
+      if @logger.respond_to?(:reopen)
+        @logger.reopen(io)
+      else
+        @logger = create_logger(io)
+      end
+    end
+
+    #
+    # For Ruby < 2.3 compatibility
+    # Based on https://github.com/ruby/ruby/blob/ruby_2_3/lib/logger.rb#L250
+    #
+
+    def level=(severity)
+      if severity.is_a?(Integer)
+        @logger.level = severity
+      else
+        case severity.to_s.downcase
+        when 'debug'
+          @logger.level = DEBUG
+        when 'info'
+          @logger.level = INFO
+        when 'warn'
+          @logger.level = WARN
+        when 'error'
+          @logger.level = ERROR
+        when 'fatal'
+          @logger.level = FATAL
+        when 'unknown'
+          @logger.level = UNKNOWN
+        else
+          raise ArgumentError, "invalid log level: #{severity}"
+        end
+      end
+    end
+
+    #
+    # Returns IO object used by logger internally.
+    #
+    # Normally, we would have never needed it, but we want to
+    # use it as IO object for all child processes to ensure their
+    # output is redirected there.
+    #
+    # It is only used in debug level, in other cases output is suppressed.
+    #
+    # @api private
+    #
+    def io
+      @logger.instance_variable_get(:@logdev).instance_variable_get(:@dev)
+    end
+
+    #
+    # Marks code as deprecated with replacement.
+    #
+    # @param [String] old
+    # @param [String] new
+    #
+    def deprecate(old, new)
+      warn "[DEPRECATION] #{old} is deprecated. Use #{new} instead."
+    end
+
+    private
+
+    def create_logger(output)
+      logger = ::Logger.new(output)
+      logger.progname = Module.nesting.last.to_s
+      logger.level = ($DEBUG ? DEBUG : Config.loglevel)
+      logger.formatter = proc do |severity, time, progname, msg|
+        "#{time.strftime('%F %T')} #{severity} #{progname} #{msg}\n"
+      end
+
+      logger
+    end
+  end
+end

data/lib/kobot/mailer.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+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}.
+      #
+      # Whether the email is actually sent or not is dependent on the value of
+      # #{Config.gmail_notify_enabled}, and when it is set to false, the email
+      # message will be printed in logging instead.
+      #
+      # @param body The email message body to send
+      def send(body)
+        from = Credential.gmail_id
+        to = Config.gmail_notify_to || from
+        subject = Config.gmail_notify_subject
+        message = compose(from, to, subject, body)
+        unless Config.gmail_notify_enabled
+          Kobot.logger.info "This email notification would have been sent:\n#{message}"
+          return
+        end
+        smtp = Net::SMTP.new(
+          Config.gmail_smtp_address,
+          Config.gmail_smtp_port
+        )
+        smtp.enable_starttls_auto
+        smtp.start(
+          'localhost',
+          Credential.gmail_id,
+          Credential.gmail_password,
+          :plain
+        ) do
+          smtp.send_message message, from, to
+        end
+      end
+
+      private
+
+      def compose(from, to, subject, body)
+        <<~END_OF_MESSAGE
+          From: <#{from}>
+          To: <#{to}>
+          MIME-Version: 1.0
+          Content-type: text/html
+          Subject: #{subject} 
+          Date: #{Time.now.getlocal(Config.kot_timezone_offset)}
+
+          #{body}
+        END_OF_MESSAGE
+      end
+    end
+  end
+end

data/lib/kobot/option.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+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 = {}
+        opt_parser = OptionParser.new do |opt|
+          opt.banner = "Usage: #{$PROGRAM_NAME} [options]"
+
+          opt.on('-c', '--clock CLOCK', 'The clock action: in, out') do |clock|
+            options[:clock] = clock
+          end
+
+          opt.on('-l', '--loglevel [LEVEL]', 'Specify log level: debug, info, warn, error. Default is info') do |level|
+            options[:loglevel] = level
+          end
+
+          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|
+            options[:skip] = skip
+          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|
+            options[:to] = to
+          end
+
+          opt.on('-n', '--notify', 'Enable email notification') do |notify|
+            options[:notify] = notify
+          end
+
+          opt.on('-d', '--dryrun', 'Run the process without actual clock in/out') do |dryrun|
+            options[:dryrun] = dryrun
+          end
+
+          opt.on('-x', '--headless', 'Start browser in headless mode') do |headless|
+            options[:headless] = headless
+          end
+
+          opt.on('-g', '--geolocation', 'Allow browser to use geolocation') do |geolocation|
+            options[:geolocation] = geolocation
+          end
+
+          opt.on_tail('-h', '--help', 'Show this help message') do
+            puts opt
+            exit 0
+          end
+
+          opt.on_tail('-v', '--version', 'Show current version') do
+            puts VERSION
+            exit 0
+          end
+        end
+        opt_parser.parse! ARGV
+        raise OptionParser::MissingArgument, 'The clock option is required' if options[:clock].nil?
+        raise OptionParser::InvalidArgument, 'The clock option must be either: in, out' unless %w[in out].include? options[:clock]
+
+        options
+      rescue OptionParser::MissingArgument, OptionParser::InvalidArgument => e
+        puts e
+        puts opt_parser.help
+        exit 1
+      end
+    end
+  end
+end

data/lib/kobot/version.rb

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

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: kobot
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Andy Jiang
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-08-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: webdrivers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: |2
+      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.
+email:
+- yuanjiang@outlook.com
+executables:
+- kobot
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/kobot
+- kobot.gemspec
+- lib/kobot.rb
+- lib/kobot/config.rb
+- lib/kobot/credential.rb
+- lib/kobot/engine.rb
+- lib/kobot/exception.rb
+- lib/kobot/logger.rb
+- lib/kobot/mailer.rb
+- lib/kobot/option.rb
+- lib/kobot/version.rb
+homepage: https://github.com/yuan-jiang/kobot
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://github.com/yuan-jiang/kobot
+  source_code_uri: https://github.com/yuan-jiang/kobot
+  changelog_uri: https://github.com/yuan-jiang/kobot/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Kobot automates the clock in/out of KING OF TIME.
+test_files: []