ticking_away 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0e696ea9fcd6af36dfc8a9bd7be89923a35fdf70eb4d05bb9fe3c3003606de6f
+  data.tar.gz: 6d22e898217913ac1b7bb349f62c83d220c2d83be92bf2b5c4976e382cc4a90e
+SHA512:
+  metadata.gz: 487b5fc04e9f0994bd8e082e09d389496457bb7357a3f770076b83b441f10caa76a839835e89e2a9b2e3afadc072c4dd034c3c6b754e5f2f0793dc789bcf203f
+  data.tar.gz: 3dbe408e1701b270c3494c1701ee3dbc97f395e1b83e3b38994dc5edd96b603d4af7b34a806bc190b14b97d76359a738b42101ce0cfea00212b7f674f3bb4c9c

data/lib/ticking_away/bot.rb

@@ -0,0 +1,84 @@
+module TickingAway
+  class Bot
+    TIMEAT_CMD = '!timeat '.freeze
+    TIMEPOPULARITY_CMD = '!timepopularity '.freeze
+    DEFAULT_TIME_API = 'http://worldtimeapi.org/api'.freeze
+    EXCUSES = [
+      'Time is an illusion',
+      'What is time, really?',
+      'The linear progression of time is currently on hold'
+    ].freeze
+
+    attr_reader :storage, :time_api
+
+    # Allow the caller to pass in the storage method via
+    # primitive DI. Other storage methods must implement
+    # increment_stat(<tz_info>) and get_stat(<tz_info or prefix>)
+    def initialize(storage: nil, time_api: nil)
+      @storage = storage || TickingAway::JSONFileStorage.new
+      @time_api = ENV['TIME_API'] || time_api || DEFAULT_TIME_API
+    end
+
+    # Send a string to the Bot in the format of
+    # <user_name>: <message>
+    # Only !timeat <tz_info> and !timepopularity <tz_info or prefix>
+    # commands will return a string response
+    def chat(msg)
+      message = strip_username(msg)
+
+      case message.partition(' ')[0]
+      when TIMEAT_CMD.strip
+        time_check(message)
+      when TIMEPOPULARITY_CMD.strip
+        stat_check(message)
+      end
+    end
+
+    # Check time for the timezone provided against the
+    # provided time api.
+    def time_check(msg)
+      tz_info = parse_message(msg, TIMEAT_CMD.length)
+
+      puts "Event: Checking Time for timezone: #{tz_info}"
+
+      time_message(tz_info)
+    end
+
+    # Return the statistic for the provided tz_info or prefix
+    def stat_check(msg)
+      storage.get_stat(parse_message(msg, TIMEPOPULARITY_CMD.length))
+    end
+
+    private
+
+    def strip_username(msg)
+      return msg unless msg.include?(':')
+
+      msg.partition(':')[2].strip
+    end
+
+    # Parse the message for the string after the command.
+    # Requires the command length (including the ! and space)
+    # to know where to start the substring
+    def parse_message(msg, cmd_length)
+      msg[cmd_length..msg.length]
+    end
+
+    # Generate the time message, returning "unknown location"
+    # for any unrecognized time zones and logging any uncaught
+    # errors before returning an excuse at random.
+    # Stats will only be incremented if the api call was successful
+    def time_message(tz_info)
+      time = TickingAway::WorldTime.time_at(time_api, tz_info)
+
+      storage.increment_stat(tz_info)
+      time.strftime('%e %b %Y %H:%M')
+    rescue TickingAway::Errors::UnrecognizedTimeZone => e
+      puts e.message
+      'unknown timezone'
+    rescue => e
+      puts e.message
+      EXCUSES.sample
+    end
+  end
+end

data/lib/ticking_away/chat_bot.rb

@@ -0,0 +1,45 @@
+require 'cinch'
+
+# This provides a default Chat Bot for running
+# the TickingAway::TimeInfo Cinch plugin. A new
+# Chatbot can be started by calling
+# bot = TickingAway::ChatBot.new(<server>, <channel>)
+# bot.start
+module TickingAway
+  class ChatBot
+
+    def initialize(server, channels)
+      @server = server
+      @channels = channels
+      @bot = nil
+    end
+
+    def start
+      # Required for dealing with scope.
+      # The block provided when instantiating the
+      # bot and the configuration block only have the
+      # scope of the start method while the start
+      # method has access to the class's instance vars
+      # The block cannot access the class's instance vars
+      # unless they're assigned to a var in the method's scope
+      # Good target for some refactoring
+      server = @server
+      channels = @channels
+
+      @bot = Cinch::Bot.new do
+        configure do |c|
+          c.server = server
+          c.channels = channels
+          c.nick = 'TickingAwayBot'
+          c.plugins.plugins = [TickingAway::TimeInfo]
+        end
+      end
+
+      @bot.start
+    end
+
+    def stop
+      @bot.stop
+    end
+  end
+end

data/lib/ticking_away/cinch/plugins/time_info.rb

@@ -0,0 +1,80 @@
+# = Cinch TickingAway::TimeInfo plugin
+# This plugin enables Cinch to respond to !timeat <tz_info> and
+# !timepopularity <tz_info or prefix> commands.
+#
+# !timeat <tz_info> will respond with the current time for the
+# provided timezone according to the World Time Api or any other
+# provided time Api that conforms to the spec.
+#
+# !timepopularity <tz_info or prefix> will respond with the number
+# of times !timeat was called successfully for the provided tz_info or
+# prefix. For instance, "!timepopularity America" will return the
+# number of times "!timeat America" was called, but it will also
+# count the number of times "!timeat America/Los_Angeles" or
+# "!timeat America/New_York" was called because they both contain
+# the prefix "America"
+#
+#
+# == Configuration
+# Add the following to your bot’s configure.do stanza:
+#
+#   config.plugins.options[TickingAway::TimeInfo] = {
+#     :time_api => 'https://worldtimeapi.org/api'
+#   }
+#
+# [time_api ('https://worldtimeapi.org/api')]
+#   The time is retreived from a time Api. It requires the spec to match
+#   the World Time Api. If this is not specified either through the config,
+#   or by providing the ENV var TIME_API, it will default to https://worldtimeapi.org/api
+#
+# == Author
+# Jeff Wood
+#
+# == License
+# A time info plugin for Cinch.
+# Copyright © 2021 Jeff Wood
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+require 'cinch'
+
+module TickingAway
+  class TimeInfo
+    include ::Cinch::Plugin
+
+    match (/timeat */), method: :timeat
+    match (/timepopularity */), method: :timepopularity
+
+    listen_to :connect, method: :on_connect
+
+    # Instantiate bot with JSON file storage when the bot connects
+    # to the IRC server. I'd like storage to be configurable
+    # through the Cinch configs eventually
+    def on_connect(*)
+      @storage = TickingAway::JSONFileStorage.new
+      @ta_bot = config[:time_api] ? TickingAway::Bot.new(storage: @storage, time_api: config[:time_api]) : TickingAway::Bot.new(storage: @storage)
+    end
+
+    # Check time for the timezone provided against the
+    # provided time api by asking the TickingAway Bot
+    def timeat(msg)
+      msg.reply @ta_bot.time_check(msg.params[1])
+    end
+
+    # Return the statistic for the provided tz_info or prefix
+    # by asking the TickingAway Bot
+    def timepopularity(msg)
+      msg.reply @ta_bot.stat_check(msg.params[1])
+    end
+  end
+end

data/lib/ticking_away/custom_errors.rb

@@ -0,0 +1,7 @@
+module TickingAway
+  module Errors
+    # Custom Errors
+    class UnrecognizedTimeZone < StandardError; end
+    class ApiUrlNotFound < StandardError; end
+  end
+end

data/lib/ticking_away/json_file_storage.rb

@@ -0,0 +1,55 @@
+require 'json'
+
+module TickingAway
+  # Class to store !timeat stats as a JSON file in local storage
+  # and return !timepopularity stats for a provided !timeat call
+  class JSONFileStorage
+    attr_reader :filename
+    attr_accessor :stats
+
+    def initialize(filename = 'ticking_away_stats.json')
+      @filename = filename
+      @stats = read_from_file
+    end
+
+    # Add 1 to a !timeat <tz_info> stat
+    # and save the hash as JSON to a file
+    def increment_stat(stat_name)
+      if stats[stat_name]
+        stats[stat_name] += 1
+      else
+        stats.merge!({ stat_name => 1 })
+      end
+      save_stats
+    end
+
+    # Get the number of times !timeat was called for a
+    # tz_info or prefix. Partial prefix matches count towards
+    # the total.
+    # If we didn't want them to, it could check the
+    # next char in the key after the .start_with? match. If it's outside the
+    # length or a "/", then the prefix or tz_info matches exactly
+    def get_stat(stat_name)
+      call_count = 0
+      stats.each do |key, value|
+        call_count += value if key.start_with?(stat_name)
+      end
+
+      call_count
+    end
+
+    def save_stats
+      File.write(filename, JSON.dump(stats))
+    end
+
+    def read_file
+      File.read(filename)
+    end
+
+    # Get saved stats on instantiation or return an empty hash
+    def read_from_file
+      return JSON.parse(read_file) if File.file?(filename)
+      {}
+    end
+  end
+end

data/lib/ticking_away/world_time.rb

@@ -0,0 +1,47 @@
+require 'httparty'
+require 'time'
+require 'json'
+
+module TickingAway
+  # Class to get time from the World Time Api or another Api with the same spec
+  class WorldTime
+    UNKNOWN_LOCATION_RESPONSE = {
+      'error' => 'unknown location'
+    }.freeze
+
+    # Define methods as (kind of) Class methods since we don't need to store state
+    class << self
+      def time_at(base_url, tz_info)
+        request_url = "#{base_url}/timezone/#{tz_info}"
+
+        response = HTTParty.get(request_url)
+        handle_response(response, request_url)
+      rescue => e
+        puts "Could not connect to time server #{request_url}"
+        raise e
+      end
+
+      def handle_response(response, request_url)
+        # Convert JSON response to Hash, handling an empty or nil body
+        parsed_response = response.body.nil? || response.body.empty? ? {} : JSON.parse(response.body)
+
+        case response.code
+        when 200
+          puts "Event: Retreived current time for #{parsed_response['timezone']}: #{parsed_response['datetime']}"
+        when 404
+          # Differentiate between an unknown location response and a random 404 by checking the response body
+          if parsed_response.eql?(UNKNOWN_LOCATION_RESPONSE)
+            raise TickingAway::Errors::UnrecognizedTimeZone, "Error: Unrecognized Time Zone #{request_url}"
+          end
+
+          raise TickingAway::Errors::ApiUrlNotFound, "Error: 404 response for #{request_url}"
+        else
+          raise "Error: #{response.code} #{parsed_response}"
+        end
+
+        # Convert the time from a RFC3339 formatted string to a Time object
+        Time.parse(parsed_response['datetime'])
+      end
+    end
+  end
+end

data/lib/ticking_away.rb

@@ -0,0 +1,6 @@
+require 'ticking_away/chat_bot'
+require 'ticking_away/cinch/plugins/time_info'
+require 'ticking_away/world_time'
+require 'ticking_away/custom_errors'
+require 'ticking_away/json_file_storage'
+require 'ticking_away/bot'

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: ticking_away
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Jeff Wood
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-05-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cinch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.3.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.3.4
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description:
+email: woodjeffrey2@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/ticking_away.rb
+- lib/ticking_away/bot.rb
+- lib/ticking_away/chat_bot.rb
+- lib/ticking_away/cinch/plugins/time_info.rb
+- lib/ticking_away/custom_errors.rb
+- lib/ticking_away/json_file_storage.rb
+- lib/ticking_away/world_time.rb
+homepage: https://github.com/woodjeffrey2/ticking_away
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: IRC Chat Bot for time shenanigans
+test_files: []