bas 0.4.0 → 1.0.0

data/lib/bas/write/postgres_update.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require_relative "./base"
+require_relative "../version"
+require_relative "../utils/postgres/request"
+
+module Write
+  ##
+  # This class is an implementation of the Write::Base interface, specifically designed
+  # to update to a PostgresDB used as <b>common storage</b>.
+  #
+  class PostgresUpdate < Write::Base
+    PTO_PARAMS = "data, tag, archived, stage, status, version"
+
+    # Execute the Postgres utility to update data in the <b>common storage</b>
+    #
+    def execute
+      Utils::Postgres::Request.execute(params)
+    end
+
+    private
+
+    def params
+      {
+        connection: config[:connection],
+        query: build_query
+      }
+    end
+
+    def build_query
+      params, values = build_params
+      query = "UPDATE #{config[:db_table]} SET #{params} WHERE #{config[:conditions]}"
+
+      [query, values]
+    end
+
+    def build_params
+      params = ""
+      values = []
+
+      config[:params].each_with_index do |(param, value), idx|
+        params += "#{param}=$#{idx + 1}"
+        values << value
+      end
+
+      [params, values]
+    end
+  end
+end

data/lib/bas.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "bas/version"
-require_relative "bas/use_cases/use_cases"
 
-module Bas # rubocop:disable Style/Documentation
-  include UseCases
+module Bas
   class Error < StandardError; end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bas
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 1.0.0
 platform: ruby
 authors:
 - kommitters Open Source
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-19 00:00:00.000000000 Z
+date: 2024-05-17 00:00:00.000000000 Z
 dependencies: []
 description: A versatile business automation system offering key components for building
   various use cases.     It provides an easy-to-use tool for implementing automation
@@ -31,73 +31,36 @@ files:
 - Rakefile
 - SECURITY.md
 - lib/bas.rb
-- lib/bas/domain/birthday.rb
-- lib/bas/domain/email.rb
-- lib/bas/domain/exceptions/function_not_implemented.rb
-- lib/bas/domain/issue.rb
-- lib/bas/domain/notification.rb
-- lib/bas/domain/pto.rb
-- lib/bas/domain/work_items_limit.rb
-- lib/bas/formatter/base.rb
-- lib/bas/formatter/birthday.rb
-- lib/bas/formatter/exceptions/invalid_data.rb
-- lib/bas/formatter/notification.rb
-- lib/bas/formatter/pto.rb
-- lib/bas/formatter/support_emails.rb
-- lib/bas/formatter/types/response.rb
-- lib/bas/formatter/work_items_limit.rb
-- lib/bas/process/base.rb
-- lib/bas/process/discord/exceptions/invalid_webhook_token.rb
-- lib/bas/process/discord/implementation.rb
-- lib/bas/process/discord/types/response.rb
-- lib/bas/process/openai/base.rb
-- lib/bas/process/openai/helper.rb
-- lib/bas/process/openai/types/response.rb
-- lib/bas/process/openai/use_case/humanize_pto.rb
-- lib/bas/process/slack/exceptions/invalid_webhook_token.rb
-- lib/bas/process/slack/implementation.rb
-- lib/bas/process/slack/types/response.rb
-- lib/bas/process/types/response.rb
+- lib/bas/bot/base.rb
+- lib/bas/bot/compare_wip_limit_count.rb
+- lib/bas/bot/fetch_birthdays_from_notion.rb
+- lib/bas/bot/fetch_domains_wip_counts_from_notion.rb
+- lib/bas/bot/fetch_domains_wip_limit_from_notion.rb
+- lib/bas/bot/fetch_emails_from_imap.rb
+- lib/bas/bot/fetch_next_week_birthdays_from_notion.rb
+- lib/bas/bot/fetch_next_week_ptos_from_notion.rb
+- lib/bas/bot/fetch_ptos_from_notion.rb
+- lib/bas/bot/format_birthdays.rb
+- lib/bas/bot/format_emails.rb
+- lib/bas/bot/format_wip_limit_exceeded.rb
+- lib/bas/bot/garbage_collector.rb
+- lib/bas/bot/humanize_pto.rb
+- lib/bas/bot/notify_discord.rb
 - lib/bas/read/base.rb
-- lib/bas/read/github/base.rb
-- lib/bas/read/github/types/response.rb
-- lib/bas/read/github/use_case/repo_issues.rb
-- lib/bas/read/imap/base.rb
-- lib/bas/read/imap/types/response.rb
-- lib/bas/read/imap/use_case/support_emails.rb
-- lib/bas/read/notion/base.rb
-- lib/bas/read/notion/exceptions/invalid_api_key.rb
-- lib/bas/read/notion/exceptions/invalid_database_id.rb
-- lib/bas/read/notion/helper.rb
-- lib/bas/read/notion/types/response.rb
-- lib/bas/read/notion/use_case/birthday_next_week.rb
-- lib/bas/read/notion/use_case/birthday_today.rb
-- lib/bas/read/notion/use_case/notification.rb
-- lib/bas/read/notion/use_case/pto_next_week.rb
-- lib/bas/read/notion/use_case/pto_today.rb
-- lib/bas/read/notion/use_case/work_items_limit.rb
-- lib/bas/read/postgres/base.rb
-- lib/bas/read/postgres/helper.rb
-- lib/bas/read/postgres/types/response.rb
-- lib/bas/read/postgres/use_case/pto_today.rb
-- lib/bas/serialize/base.rb
-- lib/bas/serialize/github/issues.rb
-- lib/bas/serialize/imap/support_emails.rb
-- lib/bas/serialize/notion/birthday_today.rb
-- lib/bas/serialize/notion/notification.rb
-- lib/bas/serialize/notion/pto_today.rb
-- lib/bas/serialize/notion/work_items_limit.rb
-- lib/bas/serialize/postgres/pto_today.rb
-- lib/bas/use_cases/types/config.rb
-- lib/bas/use_cases/use_case.rb
-- lib/bas/use_cases/use_cases.rb
+- lib/bas/read/default.rb
+- lib/bas/read/postgres.rb
+- lib/bas/read/types/response.rb
+- lib/bas/utils/discord/integration.rb
+- lib/bas/utils/exceptions/function_not_implemented.rb
+- lib/bas/utils/exceptions/invalid_process_response.rb
+- lib/bas/utils/imap/request.rb
+- lib/bas/utils/notion/request.rb
+- lib/bas/utils/openai/run_assistant.rb
+- lib/bas/utils/postgres/request.rb
 - lib/bas/version.rb
 - lib/bas/write/base.rb
-- lib/bas/write/logs/base.rb
-- lib/bas/write/logs/use_case/console_log.rb
-- lib/bas/write/notion/base.rb
-- lib/bas/write/notion/use_case/empty_notification.rb
-- lib/bas/write/notion/use_case/notification.rb
+- lib/bas/write/postgres.rb
+- lib/bas/write/postgres_update.rb
 - renovate.json
 - sig/business_automation_system.rbs
 homepage: https://github.com/kommitters/bas
@@ -121,7 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: BAS - Business automation system

data/lib/bas/domain/birthday.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-module Domain
-  ##
-  # The Domain::Birthday class provides a domain-specific representation of a Birthday object.
-  # It encapsulates the individual's name and their birthdate, offering a structured way to
-  # handle and manipulate birthday information.
-  class Birthday
-    attr_reader :individual_name, :birth_date
-
-    ATTRIBUTES = %w[individual_name birth_date].freeze
-
-    # Initializes a Domain::Birthday instance with the specified individual name, and date of birth.
-    #
-    # <br>
-    # <b>Params:</b>
-    # * <tt>String</tt> individual_name Name of the individual
-    # * <tt>Date</tt> birth_date Birthdate from the individual
-    #
-    def initialize(individual_name, date)
-      @individual_name = individual_name
-      @birth_date = date
-    end
-  end
-end

data/lib/bas/domain/email.rb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-module Domain
-  ##
-  # The Domain::Email class provides a domain-specific representation of an Email object.
-  # It encapsulates information about an email, including the subject, the sender, and the date.
-  #
-  class Email
-    attr_reader :subject, :sender
-    attr_accessor :date
-
-    ATTRIBUTES = %w[subject sender date].freeze
-
-    # Initializes a Domain::Email instance with the specified subject, sender, and date.
-    #
-    # <br>
-    # <b>Params:</b>
-    # * <tt>String</tt> email subject.
-    # * <tt>String</tt> Email of the sender.
-    # * <tt>String</tt> Reception date
-    #
-    def initialize(subject, sender, date)
-      @subject = subject
-      @sender = sender
-      @date = parse_to_datetime(date)
-    end
-
-    private
-
-    def parse_to_datetime(date)
-      DateTime.parse(date).to_time
-    end
-  end
-end

data/lib/bas/domain/exceptions/function_not_implemented.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-module Domain
-  module Exceptions
-    ##
-    # Provides a domain-specific representation for errors that occur when a function has not been implemented yet.
-    # It inherits from StandardError # and allows developers to raise a specific exception when a required function
-    # remains unimplemented in a subclass.
-    #
-    class FunctionNotImplemented < StandardError
-      # Initializes the exception with an optional custom error message.
-      #
-      def initialize(message = "The function haven't been implemented yet.")
-        super(message)
-      end
-    end
-  end
-end

data/lib/bas/domain/issue.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-module Domain
-  ##
-  # The Domain::Issue class provides a domain-specific representation of a Github issue object.
-  # It encapsulates information about a repository issue, including the title, state, assignees,
-  # description, and the repository url.
-  #
-  class Issue
-    attr_reader :title, :state, :assignees, :description, :url
-
-    ATTRIBUTES = %w[title state assignees description url].freeze
-
-    def initialize(title, state, assignees, body, url)
-      @title = title
-      @state = state
-      @assignees = assignees
-      @description = body
-      @url = url
-    end
-  end
-end

data/lib/bas/domain/notification.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-module Domain
-  ##
-  # The Domain::Notification class provides a domain-specific representation of a Notification object.
-  # It encapsulates the notification text.
-  #
-  class Notification
-    attr_reader :notification
-
-    ATTRIBUTES = %w[notification].freeze
-
-    # Initializes a Domain::Notification instance with the specified notification text.
-    #
-    # <br>
-    # <b>Params:</b>
-    # * <tt>String</tt> notification
-    #
-    def initialize(notification)
-      @notification = notification
-    end
-  end
-end

data/lib/bas/domain/pto.rb

@@ -1,69 +0,0 @@
-# frozen_string_literal: true
-
-module Domain
-  ##
-  # The Domain::Pto class provides a domain-specific representation of a Paid Time Off (PTO) object.
-  # It encapsulates information about an individual's time off, including the individual's name,
-  # the start date, and the end date of the time off period.
-  #
-  class Pto
-    attr_reader :individual_name, :start_date_from, :start_date_to, :end_date_from, :end_date_to
-
-    ATTRIBUTES = %w[individual_name start_date_from start_date_to end_date_from end_date_to].freeze
-
-    # Initializes a Domain::Pto instance with the specified individual name, start date, and end date.
-    #
-    # <br>
-    # <b>Params:</b>
-    # * <tt>String</tt> individual_name Name of the individual.
-    # * <tt>DateTime</tt> start_date Start day of the PTO.
-    # * <tt>String</tt> end_date End date of the PTO.
-    #
-    def initialize(individual_name, start_date, end_date)
-      @individual_name = individual_name
-
-      @start_date_from = start_date[:from]
-      @start_date_to = start_date[:to]
-      @end_date_from = end_date[:from]
-      @end_date_to = end_date[:to]
-    end
-
-    def same_day?
-      start_date = extract_date(start_date_from)
-      end_date = extract_date(end_date_from)
-
-      start_date == end_date
-    end
-
-    def format_timezone(timezone)
-      @start_date_from = set_timezone(start_date_from, timezone)
-      @start_date_to = set_timezone(start_date_to, timezone)
-      @end_date_from = set_timezone(end_date_from, timezone)
-      @end_date_to = set_timezone(end_date_to, timezone)
-    end
-
-    private
-
-    def extract_date(date)
-      return if date.nil?
-
-      date.strftime("%F")
-    end
-
-    def build_date_time(date, timezone)
-      return if date.nil?
-
-      date_time = date.include?("T") ? date : "#{date}T00:00:00.000#{timezone}"
-
-      DateTime.parse(date_time).to_time
-    end
-
-    def set_timezone(date, timezone)
-      return if date.nil?
-
-      date_time = build_date_time(date, timezone)
-
-      Time.at(date_time, in: timezone)
-    end
-  end
-end

data/lib/bas/domain/work_items_limit.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-module Domain
-  ##
-  # The Domain::WorkItemsLimit class provides a domain-specific representation of a Work Item object.
-  # It encapsulates information about a work items limit, including the domain and total.
-  #
-  class WorkItemsLimit
-    attr_reader :domain, :total
-
-    ATTRIBUTES = %w[domain total].freeze
-
-    # Initializes a Domain::WorkItemsLimit instance with the specified domain and total.
-    #
-    # <br>
-    # <b>Params:</b>
-    # * <tt>String</tt> 'domain' responsible domain of the work items.
-    # * <tt>String</tt> 'total' total 'in progress' work items.
-    #
-    def initialize(domain, total)
-      @domain = domain
-      @total = total
-    end
-  end
-end

data/lib/bas/formatter/base.rb

@@ -1,53 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "../domain/exceptions/function_not_implemented"
-require "erb"
-
-module Formatter
-  ##
-  # The Formatter::Base module serves as the foundation for implementing specific data presentation logic
-  # within the Formatter module. Defines essential methods, that provide a blueprint for creating custom
-  # formatters tailored to different use cases.
-  #
-  class Base
-    attr_reader :template
-
-    # Initializes the fetcher with essential configuration parameters.
-    #
-    def initialize(config = {})
-      @config = config
-      @template = config[:template]
-    end
-
-    # This method is designed to provide a specified format for data from any implementation of
-    # the Serialize::Base interface.
-    # Must be overridden by subclasses, with specific logic based on the use case.
-    #
-    # <br>
-    # <b>Params:</b>
-    # * <tt>List<Domain::></tt> domain_data: List of specific domain objects depending on the use case.
-    #
-    # <br>
-    # <b>raises</b> <tt>Domain::Exceptions::FunctionNotImplemented</tt> when missing implementation.
-    #
-    # <b>returns</b> <tt>String</tt> Formatted payload suitable for a Process::Base implementation.
-    #
-    def format(_domain_data)
-      raise Domain::Exceptions::FunctionNotImplemented
-    end
-
-    protected
-
-    def build_template(attributes, instance)
-      formated_template = format_template(attributes, instance)
-
-      "#{ERB.new(formated_template).result(binding)}\n"
-    end
-
-    def format_template(attributes, _instance)
-      attributes.reduce(template) do |formated_template, attribute|
-        formated_template.gsub(attribute, "<%= instance.#{attribute} %>")
-      end
-    end
-  end
-end

data/lib/bas/formatter/birthday.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "../domain/birthday"
-require_relative "./exceptions/invalid_data"
-require_relative "./base"
-require_relative "./types/response"
-
-module Formatter
-  ##
-  # This class implements methods from the Formatter::Base module, tailored to format the
-  # Domain::Birthday structure for a Process.
-  class Birthday < Base
-    # Implements the logic for building a formatted payload with the given template for birthdays.
-    #
-    # <br>
-    # <b>Params:</b>
-    # * <tt>List<Domain::Birthday></tt> birthdays_list: list of serialized birthdays.
-    #
-    # <br>
-    # <b>raises</b> <tt>Formatter::Exceptions::InvalidData</tt> when invalid data is provided.
-    #
-    # <br>
-    # <b>returns</b> <tt>Formatter::Types::Response</tt> formatter response: standard output for
-    # the formatted payload suitable for a Process.
-    #
-    def format(birthdays_list)
-      raise Formatter::Exceptions::InvalidData unless birthdays_list.all? do |brithday|
-        brithday.is_a?(Domain::Birthday)
-      end
-
-      response = birthdays_list.reduce("") do |payload, birthday|
-        payload + build_template(Domain::Birthday::ATTRIBUTES, birthday)
-      end
-
-      Formatter::Types::Response.new(response)
-    end
-  end
-end

data/lib/bas/formatter/exceptions/invalid_data.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module Formatter
-  module Exceptions
-    ##
-    # Provides a domain-specific representation for errors that occurs when trying to process invalid
-    # data on a Fetcher::Base implementation
-    #
-    class InvalidData < StandardError
-      def initialize(message = "")
-        super(message)
-      end
-    end
-  end
-end

data/lib/bas/formatter/notification.rb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "../domain/notification"
-require_relative "./exceptions/invalid_data"
-require_relative "./base"
-require_relative "./types/response"
-
-module Formatter
-  ##
-  # This class implements methods from the Formatter::Base module, tailored to format the
-  # Domain::Notification structure for a Process.
-  class Notification < Base
-    # Implements the logic for building a formatted notification message
-    #
-    # <br>
-    # <b>Params:</b>
-    # * <tt>List<Domain::Notification></tt> notifications_list: list of serialized notifications.
-    #
-    # <br>
-    # <b>raises</b> <tt>Formatter::Exceptions::InvalidData</tt> when invalid data is provided.
-    #
-    # <br>
-    # <b>returns</b> <tt>Formatter::Types::Response</tt> formatter response: standard output for
-    # the formatted payload suitable for a Process.
-    #
-    def format(notifications_list)
-      raise Formatter::Exceptions::InvalidData unless notifications_list.all? do |notification|
-        notification.is_a?(Domain::Notification)
-      end
-
-      Formatter::Types::Response.new(notifications_list[0].notification)
-    end
-  end
-end

data/lib/bas/formatter/pto.rb

@@ -1,89 +0,0 @@
-# frozen_string_literal: true
-
-require "date"
-
-require_relative "../domain/pto"
-require_relative "./exceptions/invalid_data"
-require_relative "./base"
-require_relative "./types/response"
-
-module Formatter
-  ##
-  # This class implements methods from the Formatter::Base module, tailored to format the
-  # Domain::Pto structure for a Process.
-  class Pto < Base
-    DEFAULT_TIME_ZONE = "+00:00"
-
-    # Initializes the Slack formatter with essential configuration parameters.
-    #
-    # <b>timezone</b> : expect an string with the time difference relative to the UTC. Example: "-05:00"
-    def initialize(config = {})
-      super(config)
-
-      @timezone = config[:timezone] || DEFAULT_TIME_ZONE
-    end
-
-    # Implements the logic for building a formatted payload with the given template for PTO's.
-    #
-    # <br>
-    # <b>Params:</b>
-    # * <tt>List<Domain::Pto></tt> pto_list: List of serialized PTO's.
-    #
-    # <br>
-    # <b>raises</b> <tt>Formatter::Exceptions::InvalidData</tt> when invalid data is provided.
-    #
-    # <br>
-    # <b>returns</b> <tt>Formatter::Types::Response</tt> formatter response: standard output for
-    # the formatted payload suitable for a Process.
-    #
-
-    def format(ptos_list)
-      raise Formatter::Exceptions::InvalidData unless ptos_list.all? { |pto| pto.is_a?(Domain::Pto) }
-
-      ptos_list.each { |pto| pto.format_timezone(@timezone) }
-
-      response = ptos_list.reduce("") do |payload, pto|
-        built_template = build_template(Domain::Pto::ATTRIBUTES, pto)
-        payload + format_message_by_case(built_template.gsub("\n", ""), pto)
-      end
-
-      Formatter::Types::Response.new(response)
-    end
-
-    private
-
-    def format_message_by_case(built_template, pto)
-      if pto.same_day?
-        interval = same_day_interval(pto)
-        day_message = today?(pto.start_date_from) ? "today" : "the day #{pto.start_date_from.strftime("%F")}"
-
-        "#{built_template} #{day_message} #{interval}\n"
-      else
-        start_date_interval = day_interval(pto.start_date_from, pto.start_date_to)
-        end_date_interval = day_interval(pto.end_date_from, pto.end_date_to)
-
-        "#{built_template} from #{start_date_interval} to #{end_date_interval}\n"
-      end
-    end
-
-    def day_interval(start_date, end_date)
-      return start_date.strftime("%F") if end_date.nil?
-
-      time_start = start_date.strftime("%I:%M %P")
-      time_end = end_date.strftime("%I:%M %P")
-
-      "#{start_date.strftime("%F")} (#{time_start} - #{time_end})"
-    end
-
-    def same_day_interval(pto)
-      time_start = pto.start_date_from.strftime("%I:%M %P")
-      time_end = pto.end_date_from.strftime("%I:%M %P")
-
-      time_start == time_end ? "all day" : "from #{time_start} to #{time_end}"
-    end
-
-    def today?(date)
-      date == Time.now(in: @timezone).strftime("%F")
-    end
-  end
-end