bas 1.5.2 → 1.6.0

data/lib/bas/bot/format_emails.rb

@@ -1,124 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "./base"
-require_relative "../read/postgres"
-require_relative "../write/postgres"
-
-module Bot
-  ##
-  # The Bot::FormatEmails class serves as a bot implementation to read emails from a
-  # PostgresDB database, format them with a specific template, and write them on a PostgresDB
-  # table with a specific format.
-  #
-  # <br>
-  # <b>Example</b>
-  #
-  #   options = {
-  #     read_options: {
-  #       connection: {
-  #         host: "localhost",
-  #         port: 5432,
-  #         dbname: "bas",
-  #         user: "postgres",
-  #         password: "postgres"
-  #       },
-  #       db_table: "use_cases",
-  #       tag: "FetchEmailsFromImap"
-  #     },
-  #     process_options: {
-  #       template: "emails template message"
-  #     },
-  #     write_options: {
-  #       connection: {
-  #         host: "localhost",
-  #         port: 5432,
-  #         dbname: "bas",
-  #         user: "postgres",
-  #         password: "postgres"
-  #       },
-  #       db_table: "use_cases",
-  #       tag: "FormatEmails"
-  #     }
-  #   }
-  #
-  #   bot = Bot::FormatEmails.new(options)
-  #   bot.execute
-  #
-  class FormatEmails < Bot::Base
-    EMAIL_ATTRIBUTES = %w[subject sender date].freeze
-    DEFAULT_TIME_ZONE = "+00:00"
-
-    # read function to execute the PostgresDB Read component
-    #
-    def read
-      reader = Read::Postgres.new(read_options.merge(conditions))
-
-      reader.execute
-    end
-
-    # Process function to format the notification using a template
-    #
-    def process
-      return { success: { notification: "" } } if unprocessable_response
-
-      emails_list = read_response.data["emails"]
-
-      notification = process_emails(emails_list).reduce("") do |payload, email|
-        "#{payload} #{build_template(EMAIL_ATTRIBUTES, email)} \n"
-      end
-
-      { success: { notification: } }
-    end
-
-    # Write function to execute the PostgresDB write component
-    #
-    def write
-      write = Write::Postgres.new(write_options, process_response)
-
-      write.execute
-    end
-
-    private
-
-    def conditions
-      {
-        where: "archived=$1 AND tag=$2 AND stage=$3 ORDER BY inserted_at ASC",
-        params: [false, read_options[:tag], "unprocessed"]
-      }
-    end
-
-    def process_emails(emails)
-      emails.each do |email|
-        date = DateTime.parse(email["date"]).to_time
-        email["date"] = at_timezone(date)
-      end
-      emails.filter! { |email| email["date"] > time_window } unless process_options[:frequency].nil?
-
-      format_timestamp(emails)
-    end
-
-    def format_timestamp(emails)
-      emails.each { |email| email["date"] = email["date"].strftime("%F %r") }
-    end
-
-    def time_window
-      date_time = Time.now - (60 * 60 * process_options[:frequency])
-
-      at_timezone(date_time)
-    end
-
-    def at_timezone(date)
-      timezone = process_options[:timezone] || DEFAULT_TIME_ZONE
-
-      Time.at(date, in: timezone)
-    end
-
-    def build_template(attributes, instance)
-      template = process_options[:template]
-
-      attributes.reduce(template) do |formated_template, attribute|
-        formated_template.gsub("<#{attribute}>", instance[attribute].to_s)
-      end
-    end
-  end
-end

data/lib/bas/bot/format_wip_limit_exceeded.rb

@@ -1,97 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "./base"
-require_relative "../read/postgres"
-require_relative "../write/postgres"
-
-module Bot
-  ##
-  # The Bot::FormatWipLimitExceeded class serves as a bot implementation to read exceeded domain wip
-  # counts by limits from a PostgresDB database, format them with a specific template, and write them
-  # on a PostgresDB table with a specific format.
-  #
-  # <br>
-  # <b>Example</b>
-  #
-  #   options = {
-  #     read_options: {
-  #       connection: {
-  #         host: "localhost",
-  #         port: 5432,
-  #         dbname: "bas",
-  #         user: "postgres",
-  #         password: "postgres"
-  #       },
-  #       db_table: "use_cases",
-  #       tag: "CompareWipLimitCount"
-  #     },
-  #     process_options: {
-  #       template: "exceeded wip limit template message"
-  #     },
-  #     write_options: {
-  #       connection: {
-  #         host: "localhost",
-  #         port: 5432,
-  #         dbname: "bas",
-  #         user: "postgres",
-  #         password: "postgres"
-  #       },
-  #       db_table: "use_cases",
-  #       tag: "FormatWipLimitExceeded"
-  #     }
-  #   }
-  #
-  #   bot = Bot::FormatWipLimitExceeded.new(options)
-  #   bot.execute
-  #
-  class FormatWipLimitExceeded < Bot::Base
-    WIP_LIMIT_ATTRIBUTES = %w[domain exceeded].freeze
-
-    # read function to execute the PostgresDB Read component
-    #
-    def read
-      reader = Read::Postgres.new(read_options.merge(conditions))
-
-      reader.execute
-    end
-
-    # Process function to format the notification using a template
-    #
-    def process
-      return { success: { notification: "" } } if unprocessable_response
-
-      exceedded_limits_list = read_response.data["exceeded_domain_count"]
-
-      notification = exceedded_limits_list.reduce("") do |payload, exceedded_limit|
-        "#{payload} #{build_template(WIP_LIMIT_ATTRIBUTES, exceedded_limit)} \n"
-      end
-
-      { success: { notification: } }
-    end
-
-    # Write function to execute the PostgresDB write component
-    #
-    def write
-      write = Write::Postgres.new(write_options, process_response)
-
-      write.execute
-    end
-
-    private
-
-    def conditions
-      {
-        where: "archived=$1 AND tag=$2 AND stage=$3 ORDER BY inserted_at ASC",
-        params: [false, read_options[:tag], "unprocessed"]
-      }
-    end
-
-    def build_template(attributes, instance)
-      template = process_options[:template]
-
-      attributes.reduce(template) do |formated_template, attribute|
-        formated_template.gsub("<#{attribute}>", instance[attribute].to_s)
-      end
-    end
-  end
-end

data/lib/bas/bot/garbage_collector.rb

@@ -1,85 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "./base"
-require_relative "../read/default"
-require_relative "../write/postgres"
-
-module Bot
-  ##
-  # The Bot::GarbageCollector class serves as a bot implementation to archive bot records from a
-  # PostgresDB database table and write a response on a PostgresDB table with a specific format.
-  #
-  # <br>
-  # <b>Example</b>
-  #
-  #   options = {
-  #     process_options: {
-  #       connection: {
-  #         host: "localhost",
-  #         port: 5432,
-  #         dbname: "bas",
-  #         user: "postgres",
-  #         password: "postgres"
-  #       },
-  #       db_table: "use_cases"
-  #     },
-  #     write_options: {
-  #       connection: {
-  #         host: "localhost",
-  #         port: 5432,
-  #         dbname: "bas",
-  #         user: "postgres",
-  #         password: "postgres"
-  #       },
-  #       db_table: "use_cases"
-  #     }
-  #   }
-  #
-  #   bot = Bot::GarbageCollector.new(options)
-  #   bot.execute
-  #
-  class GarbageCollector < Bot::Base
-    SUCCESS_STATUS = "PGRES_COMMAND_OK"
-
-    # Read function to execute the default Read component
-    #
-    def read
-      reader = Read::Default.new
-
-      reader.execute
-    end
-
-    # Process function to update records in a PostgresDB database table
-    #
-    def process
-      response = Utils::Postgres::Request.execute(params)
-
-      if response.res_status == SUCCESS_STATUS
-        { success: { archived: true } }
-      else
-        { error: { message: response.result_error_message, status_code: response.res_status } }
-      end
-    end
-
-    # Write function to execute the PostgresDB write component
-    #
-    def write
-      write = Write::Postgres.new(write_options, process_response)
-
-      write.execute
-    end
-
-    private
-
-    def params
-      {
-        connection: process_options[:connection],
-        query:
-      }
-    end
-
-    def query
-      "UPDATE #{process_options[:db_table]} SET archived=true WHERE archived=false"
-    end
-  end
-end

data/lib/bas/bot/humanize_pto.rb

@@ -1,117 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "./base"
-require_relative "../read/postgres"
-require_relative "../write/postgres"
-require_relative "../utils/openai/run_assistant"
-
-module Bot
-  ##
-  # The Bot::HumanizePto class serves as a bot implementation to read PTO's from a
-  # PostgresDb table, format them using an OpenAI Assistant with the OpenAI API, and
-  # write the response as a notification on a PostgresDB table.
-  #
-  # <br>
-  # <b>Example</b>
-  #
-  #   options = {
-  #     read_options: {
-  #       connection: {
-  #         host: "host",
-  #         port: 5432,
-  #         dbname: "bas",
-  #         user: "postgres",
-  #         password: "postgres"
-  #       },
-  #       db_table: "pto",
-  #       tag: "FetchPtosFromNotion"
-  #     },
-  #     process_options: {
-  #       secret: "openai secret key",
-  #       assistant_id: "assistant_id",
-  #       prompt: "optional additional prompt"
-  #     },
-  #     write_options: {
-  #       connection: {
-  #         host: "host",
-  #         port: 5432,
-  #         dbname: "bas",
-  #         user: "postgres",
-  #         password: "postgres"
-  #       },
-  #       db_table: "pto",
-  #       tag: "HumanizePto"
-  #     }
-  #   }
-  #
-  #   bot = Bot::HumanizePto.new(options)
-  #   bot.execute
-  #
-  class HumanizePto < Bot::Base
-    DEFAULT_PROMPT = "{data}"
-
-    # read function to execute the PostgresDB Read component
-    #
-    def read
-      reader = Read::Postgres.new(read_options.merge(conditions))
-
-      reader.execute
-    end
-
-    # process function to execute the OpenaAI utility to process the PTO's
-    #
-    def process
-      return { success: { notification: "" } } if unprocessable_response
-
-      response = Utils::OpenAI::RunAssitant.execute(params)
-
-      if response.code != 200 || (!response["status"].nil? && response["status"] != "completed")
-        return error_response(response)
-      end
-
-      sucess_response(response)
-    end
-
-    # write function to execute the PostgresDB write component
-    #
-    def write
-      write = Write::Postgres.new(write_options, process_response)
-
-      write.execute
-    end
-
-    private
-
-    def conditions
-      {
-        where: "archived=$1 AND tag=$2 AND stage=$3 ORDER BY inserted_at ASC",
-        params: [false, read_options[:tag], "unprocessed"]
-      }
-    end
-
-    def params
-      {
-        assistant_id: process_options[:assistant_id],
-        secret: process_options[:secret],
-        prompt: build_prompt
-      }
-    end
-
-    def build_prompt
-      prompt = process_options[:prompt] || DEFAULT_PROMPT
-      ptos_list = read_response.data["ptos"]
-
-      ptos_list_formatted_string = ptos_list.join("\n")
-
-      prompt.gsub("{data}", ptos_list_formatted_string)
-    end
-
-    def sucess_response(response)
-      { success: { notification: response.parsed_response["data"].first["content"].first["text"]["value"] } }
-    end
-
-    def error_response(response)
-      { error: { message: response.parsed_response, status_code: response.code } }
-    end
-  end
-end

data/lib/bas/bot/notify_discord.rb

@@ -1,96 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "./base"
-require_relative "../read/postgres"
-require_relative "../write/postgres"
-require_relative "../utils/discord/integration"
-
-module Bot
-  ##
-  # The Bot::NotifyDiscord class serves as a bot implementation to send messages to a
-  # Discord readed from a PostgresDB table.
-  #
-  # <br>
-  # <b>Example</b>
-  #
-  #   options = {
-  #     read_options: {
-  #       connection: {
-  #         host: "host",
-  #         port: 5432,
-  #         dbname: "bas",
-  #         user: "postgres",
-  #         password: "postgres"
-  #       },
-  #       db_table: "pto",
-  #       tag: "HumanizePto"
-  #     },
-  #     process_options: {
-  #       name: "bot name to be shown on discord",
-  #       webhook: "discord webhook"
-  #     },
-  #     write_options: {
-  #       connection: {
-  #         host: "host",
-  #         port: 5432,
-  #         dbname: "bas",
-  #         user: "postgres",
-  #         password: "postgres"
-  #       },
-  #       db_table: "pto",
-  #       tag: "NotifyDiscord"
-  #     }
-  #   }
-  #
-  #   bot = Bot::NotifyDiscord.new(options)
-  #   bot.execute
-  #
-  class NotifyDiscord < Bot::Base
-    # read function to execute the PostgresDB Read component
-    #
-    def read
-      reader = Read::Postgres.new(read_options.merge(conditions))
-
-      reader.execute
-    end
-
-    # process function to execute the Discord utility to send the PTO's notification
-    #
-    def process
-      return { success: {} } if unprocessable_response
-
-      response = Utils::Discord::Integration.execute(params)
-
-      if response.code == 204
-        { success: {} }
-      else
-        { error: { message: response.parsed_response, status_code: response.code } }
-      end
-    end
-
-    # write function to execute the PostgresDB write component
-    #
-    def write
-      write = Write::Postgres.new(write_options, process_response)
-
-      write.execute
-    end
-
-    private
-
-    def conditions
-      {
-        where: "archived=$1 AND tag=$2 AND stage=$3 ORDER BY inserted_at ASC",
-        params: [false, read_options[:tag], "unprocessed"]
-      }
-    end
-
-    def params
-      {
-        name: process_options[:name],
-        notification: read_response.data["notification"],
-        webhook: process_options[:webhook]
-      }
-    end
-  end
-end

data/lib/bas/bot/notify_do_bill_alert_email.rb

@@ -1,94 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "./base"
-require_relative "../read/postgres"
-require_relative "../write/postgres"
-require_relative "../utils/google/send_email"
-
-module Bot
-  ##
-  # The Bot::NotifyDoBillAlertEmail class serves as a bot implementation to send digital
-  # ocean daily bill exceeded alert emails to a recipient using a google account
-  #
-  # <br>
-  # <b>Example</b>
-  #
-  #   options = {
-  #     read_options: {
-  #       connection: {
-  #         host: "localhost",
-  #         port: 5432,
-  #         dbname: "bas",
-  #         user: "postgres",
-  #         password: "postgres"
-  #       },
-  #       db_table: "do_billing",
-  #       tag: "FetchBillingFromDigitalOcean"
-  #     },
-  #     process_options: {
-  #       refresh_token: "email server refresh token",
-  #       client_id: "email server client it",
-  #       client_secret: "email server client secret",
-  #       user_email: "sender@mail.com",
-  #       recipient_email: "recipient@mail.com",
-  #       threshold: "THRESHOLD"
-  #     },
-  #     write_options: {
-  #       connection: {
-  #         host: "localhost",
-  #         port: 5432,
-  #         dbname: "bas",
-  #         user: "postgres",
-  #         password: "postgres"
-  #       },
-  #       db_table: "do_billing",
-  #       tag: "NotifyDoBillAlertEmail"
-  #     }
-  #   }
-  #
-  #   bot = Bot::NotifyDoBillAlertEmail.new(options)
-  #   bot.execute
-  #
-  class NotifyDoBillAlertEmail < Bot::Base
-    SUBJECT = "Digital Ocean Daily Threshold Alert"
-
-    # read function to execute the PostgresDB Read component
-    #
-    def read
-      reader = Read::Postgres.new(read_options.merge(conditions))
-
-      reader.execute
-    end
-
-    # process function to execute the Google send email utility
-    #
-    def process
-      return { success: {} } if unprocessable_response
-
-      response = Utils::GoogleService::SendEmail.new(params).execute
-
-      response[:error].nil? ? { success: {} } : { error: response }
-    end
-
-    # write function to execute the PostgresDB write component
-    #
-    def write
-      write = Write::Postgres.new(write_options, process_response)
-
-      write.execute
-    end
-
-    private
-
-    def conditions
-      {
-        where: "archived=$1 AND tag=$2 AND stage=$3 ORDER BY inserted_at ASC",
-        params: [false, read_options[:tag], "unprocessed"]
-      }
-    end
-
-    def params
-      process_options.merge({ subject: SUBJECT, message: read_response.data["notification"] })
-    end
-  end
-end

data/lib/bas/bot/review_domain_availability.rb

@@ -1,96 +0,0 @@
-# frozen_string_literal: true
-
-require "httparty"
-
-require_relative "./base"
-require_relative "../read/postgres"
-require_relative "../write/postgres"
-require_relative "../utils/openai/run_assistant"
-
-module Bot
-  ##
-  # The Bot::ReviewDomainAvailability class serves as a bot implementation to read from a postgres
-  # shared storage a domain requests and review its availability.
-  #
-  # <br>
-  # <b>Example</b>
-  #
-  #   options = {
-  #     read_options: {
-  #       connection: {
-  #         host: "localhost",
-  #         port: 5432,
-  #         dbname: "bas",
-  #         user: "postgres",
-  #         password: "postgres"
-  #       },
-  #       db_table: "web_availability",
-  #       tag: "ReviewDomainRequest"
-  #     },
-  #     write_options: {
-  #       connection: {
-  #         host: "localhost",
-  #         port: 5432,
-  #         dbname: "bas",
-  #         user: "postgres",
-  #         password: "postgres"
-  #       },
-  #       db_table: "web_availability",
-  #       tag: "ReviewDomainAvailability"
-  #     }
-  #   }
-  #
-  #   bot = Bot::ReviewDomainAvailability.new(options)
-  #   bot.execute
-  #
-  class ReviewDomainAvailability < Bot::Base
-    # read function to execute the PostgresDB Read component
-    #
-    def read
-      reader = Read::Postgres.new(read_options.merge(conditions))
-
-      reader.execute
-    end
-
-    # process function to make a http request to the domain and check the status
-    #
-    def process
-      return { success: { review: nil } } if unprocessable_response
-
-      response = availability
-
-      if response.code == 200
-        { success: { review: nil } }
-      else
-        { success: { notification: notification(response) } }
-      end
-    end
-
-    # write function to execute the PostgresDB write component
-    #
-    def write
-      write = Write::Postgres.new(write_options, process_response)
-
-      write.execute
-    end
-
-    private
-
-    def conditions
-      {
-        where: "archived=$1 AND tag=$2 AND stage=$3 ORDER BY inserted_at ASC",
-        params: [false, read_options[:tag], "unprocessed"]
-      }
-    end
-
-    def availability
-      url = read_response.data["url"]
-
-      HTTParty.get(url, {})
-    end
-
-    def notification(response)
-      ":warning: The Domain #{read_response.data["url"]} is down with an error code of #{response.code}"
-    end
-  end
-end