bas 0.3.1 → 1.0.0

data/lib/bas/serialize/notion/work_items_limit.rb

@@ -1,65 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "../../domain/work_items_limit"
-require_relative "../base"
-
-module Serialize
-  module Notion
-    ##
-    # This class implements the methods of the Serialize::Base module, specifically designed
-    # for preparing or shaping work items data coming from a Read::Base implementation.
-    class WorkItemsLimit
-      include Base
-
-      WORK_ITEM_PARAMS = ["Responsible domain"].freeze
-
-      # Implements the logic for shaping the results from a reader response.
-      #
-      # <br>
-      # <b>Params:</b>
-      # * <tt>Read::Notion::Types::Response</tt> notion_response: Notion response object.
-      #
-      # <br>
-      # <b>return</b> <tt>List<Domain::WorkItem></tt> work_items_list, serialized work items to be used by a
-      # Formatter::Base implementation.
-      #
-      def execute(notion_response)
-        return [] if notion_response.results.empty?
-
-        normalized_notion_data = normalize_response(notion_response.results)
-
-        domain_items_count = count_domain_items(normalized_notion_data)
-
-        domain_items_count.map do |domain, items_count|
-          Domain::WorkItemsLimit.new(domain, items_count)
-        end
-      end
-
-      private
-
-      def normalize_response(results)
-        return [] if results.nil?
-
-        results.map do |value|
-          work_item_fields = value["properties"].slice(*WORK_ITEM_PARAMS)
-
-          work_item_fields.each do |field, work_item_value|
-            work_item_fields[field] = extract_domain_field_value(work_item_value)
-          end
-
-          work_item_fields
-        end
-      end
-
-      def extract_domain_field_value(data)
-        data["select"]["name"]
-      end
-
-      def count_domain_items(work_items_list)
-        domain_work_items = work_items_list.group_by { |work_item| work_item["Responsible domain"] }
-
-        domain_work_items.transform_values(&:count)
-      end
-    end
-  end
-end

data/lib/bas/serialize/postgres/pto_today.rb

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "../../domain/pto"
-require_relative "../base"
-
-module Serialize
-  module Postgres
-    ##
-    # This class implements the methods of the Serialize::Base module, specifically designed for preparing or
-    # shaping PTO's data coming from the Read::Postgres::Pto class.
-    #
-    class PtoToday
-      # Implements the logic for shaping the results from a reader response.
-      #
-      # <br>
-      # <b>Params:</b>
-      # * <tt>Read::Postgres::Types::Response</tt> pg_response: Postgres response object.
-      #
-      # <br>
-      # <b>returns</b> <tt>List<Domain::Pto></tt> ptos_list, serialized PTO's to be used by a Formatter::Base
-      # implementation.
-      #
-      def execute(pg_response)
-        return [] if pg_response.records.empty?
-
-        ptos = build_map(pg_response)
-
-        ptos.map do |pto|
-          name = pto["name"]
-          start_date = { from: pto["start_date"], to: nil }
-          end_date = { from: pto["end_date"], to: nil }
-
-          Domain::Pto.new(name, start_date, end_date)
-        end
-      end
-
-      private
-
-      def build_map(pg_response)
-        fields = pg_response.fields
-        values = pg_response.records
-
-        values.map { |value| Hash[fields.zip(value)] }
-      end
-    end
-  end
-end

data/lib/bas/use_cases/types/config.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-module UseCases
-  module Types
-    ##
-    # Represents a the configuration composing the initial components required by a UseCases::UseCase implementation.
-    #
-    class Config
-      attr_reader :read, :serialize, :formatter, :process, :write
-
-      def initialize(read, serialize, formatter, process, write)
-        @read = read
-        @serialize = serialize
-        @formatter = formatter
-        @process = process
-        @write = write
-      end
-    end
-  end
-end

data/lib/bas/use_cases/use_case.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-module UseCases
-  ##
-  # The UseCases::UseCase class represents a generic structure for use cases within the system. It encapsulates the
-  # logic flow by coordinating the execution of its components to fulfill a specific use case.
-  #
-  class UseCase
-    attr_reader :read, :serialize, :formatter, :process, :write
-
-    # Initializes the use case with the necessary components.
-    #
-    # <br>
-    # <b>Params:</b>
-    # * <tt>Usecases::Types::Config</tt> config, The components required to instantiate a use case.
-    #
-    def initialize(config)
-      @read = config.read
-      @serialize = config.serialize
-      @formatter = config.formatter
-      @process = config.process
-      @write = config.write
-    end
-
-    # Executes the use case by orchestrating the sequential execution of the read, serialize, formatter, and process.
-    #
-    # <br>
-    # <b>returns</b> <tt>Process::Discord::Types::Response</tt>
-    #
-    def perform
-      response = read.execute
-
-      serialization = serialize.execute(response)
-
-      format_response = formatter.format(serialization)
-
-      process_response = process.execute(format_response)
-
-      write.execute(process_response)
-    end
-  end
-end

data/lib/bas/use_cases/use_cases.rb

@@ -1,389 +0,0 @@
-# frozen_string_literal: true
-
-# read
-require_relative "../read/notion/use_case/birthday_today"
-require_relative "../read/notion/use_case/birthday_next_week"
-require_relative "../read/notion/use_case/pto_today"
-require_relative "../read/notion/use_case/pto_next_week"
-require_relative "../read/notion/use_case/work_items_limit"
-require_relative "../read/postgres/use_case/pto_today"
-require_relative "../read/imap/use_case/support_emails"
-require_relative "../read/github/use_case/repo_issues"
-
-# serialize
-require_relative "../serialize/notion/birthday_today"
-require_relative "../serialize/notion/pto_today"
-require_relative "../serialize/notion/work_items_limit"
-require_relative "../serialize/postgres/pto_today"
-require_relative "../serialize/imap/support_emails"
-require_relative "../serialize/github/issues"
-
-# formatter
-require_relative "../formatter/birthday"
-require_relative "../formatter/pto"
-require_relative "../formatter/work_items_limit"
-require_relative "../formatter/support_emails"
-
-# process
-require_relative "../process/discord/implementation"
-require_relative "../process/slack/implementation"
-
-# write
-require_relative "../write/logs/use_case/console_log"
-
-require_relative "use_case"
-require_relative "./types/config"
-
-##
-# This module provides factory methods for use cases within the system. Each method
-# represents a use case implementation introduced in the system.
-#
-module UseCases
-  # Provides an instance of the Birthdays notifications from Notion to Discord use case implementation.
-  #
-  # <b>Example</b>
-  #
-  #   options = {
-  #     read_options: {
-  #       database_id: NOTION_DATABASE_ID,
-  #       secret: NOTION_API_INTEGRATION_SECRET,
-  #     },
-  #     process_options: {
-  #       webhook: "https://discord.com/api/webhooks/1199213527672565760/KmpoIzBet9xYG16oFh8W1RWHbpIqT7UtTBRrhfLcvWZdNiVZCTM-gpil2Qoy4eYEgpdf",
-  #       name: "Birthday Bot"
-  #     }
-  #   }
-  #
-  #   use_case = UseCases.notify_birthday_from_notion_to_discord(options)
-  #   use_case.perform
-  #
-  #   #################################################################################
-  #
-  #   Requirements:
-  #   * Notion database ID, from a database with the following structure:
-  #
-  #         _________________________________________________________________________________
-  #         | Complete Name (text) |    BD_this_year (formula)   |         BD (date)        |
-  #         | -------------------- | --------------------------- | ------------------------ |
-  #         |       John Doe       |       January 24, 2024      |      January 24, 2000    |
-  #         |       Jane Doe       |       June 20, 2024         |      June 20, 2000       |
-  #         ---------------------------------------------------------------------------------
-  #         With the following formula for the BD_this_year column:
-  #            dateAdd(prop("BD"), year(now()) - year(prop("BD")), "years")
-  #
-  #   * A Notion secret, which can be obtained, by creating an integration here: `https://developers.notion.com/`,
-  #     browsing on the <View my integations> option, and selecting the <New Integration> or <Create new>
-  #     integration** buttons.
-  #   * A webhook key, which can be generated directly on discrod on the desired channel, following this instructions:
-  #     https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks
-  #
-  def self.notify_birthday_from_notion_to_discord(options)
-    read = Read::Notion::BirthdayToday.new(options[:read_options])
-    serialize = Serialize::Notion::BirthdayToday.new
-    formatter = Formatter::Birthday.new(options[:format_options])
-    process = Process::Discord::Implementation.new(options[:process_options])
-    write = Write::Logs::ConsoleLog.new
-    use_case_config = UseCases::Types::Config.new(read, serialize, formatter, process, write)
-
-    UseCases::UseCase.new(use_case_config)
-  end
-
-  # Provides an instance of the next week Birthdays notifications from Notion to Discord use case implementation.
-  #
-  # <b>Example</b>
-  #
-  #   options = {
-  #     read_options: {
-  #       database_id: NOTION_DATABASE_ID,
-  #       secret: NOTION_API_INTEGRATION_SECRET,
-  #     },
-  #     process_options: {
-  #       webhook: "https://discord.com/api/webhooks/1199213527672565760/KmpoIzBet9xYG16oFh8W1RWHbpIqT7UtTBRrhfLcvWZdNiVZCTM-gpil2Qoy4eYEgpdf",
-  #       name: "Birthday Bot"
-  #     },
-  #     format_options: {
-  #       template: "individual_name, Wishing you a very happy birthday! Enjoy your special day! :birthday: :gift:",
-  #       timezone: "-05:00"
-  #     }
-  #   }
-  #
-  #   use_case = UseCases.notify_next_week_birthday_from_notion_to_discord(options)
-  #   use_case.perform
-  #
-  #   #################################################################################
-  #
-  #   Requirements:
-  #   * Notion database ID, from a database with the following structure:
-  #
-  #         _________________________________________________________________________________
-  #         | Complete Name (text) |    BD_this_year (formula)   |         BD (date)        |
-  #         | -------------------- | --------------------------- | ------------------------ |
-  #         |       John Doe       |       January 24, 2024      |      January 24, 2000    |
-  #         |       Jane Doe       |       June 20, 2024         |      June 20, 2000       |
-  #         ---------------------------------------------------------------------------------
-  #         With the following formula for the BD_this_year column:
-  #            dateAdd(prop("BD"), year(now()) - year(prop("BD")), "years")
-  #
-  #   * A Notion secret, which can be obtained, by creating an integration here: `https://developers.notion.com/`,
-  #     browsing on the <View my integations> option, and selecting the <New Integration> or <Create new>
-  #     integration** buttons.
-  #   * A webhook key, which can be generated directly on discrod on the desired channel, following this instructions:
-  #     https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks
-  #
-  def self.notify_next_week_birthday_from_notion_to_discord(options)
-    read = Read::Notion::BirthdayNextWeek.new(options[:read_options])
-    serialize = Serialize::Notion::BirthdayToday.new
-    formatter = Formatter::Birthday.new(options[:format_options])
-    process = Process::Discord::Implementation.new(options[:process_options])
-    write = Write::Logs::ConsoleLog.new
-    use_case_cofig = UseCases::Types::Config.new(read, serialize, formatter, process, write)
-
-    UseCases::UseCase.new(use_case_cofig)
-  end
-
-  # Provides an instance of the PTO notifications from Notion to Discord use case implementation.
-  #
-  # <br>
-  # <b>Example</b>
-  #
-  #   options = {
-  #     read_options: {
-  #       database_id: NOTION_DATABASE_ID,
-  #       secret: NOTION_API_INTEGRATION_SECRET,
-  #     },
-  #     process_options: {
-  #       webhook: "https://discord.com/api/webhooks/1199213527672565760/KmpoIzBet9xYG16oFh8W1RWHbpIqT7UtTBRrhfLcvWZdNiVZCTM-gpil2Qoy4eYEgpdf",
-  #       name: "Pto Bot"
-  #     }
-  #   }
-  #
-  #   use_case = UseCases.notify_pto_from_notion_to_discord(options)
-  #   use_case.perform
-  #
-  #   #################################################################################
-  #
-  #   Requirements:
-  #   * Notion database ID, from a database with the following structure:
-  #
-  #         ________________________________________________________________________________________________________
-  #         |    Person (person)   |        Desde? (date)                    |       Hasta? (date)                  |
-  #         | -------------------- | --------------------------------------- | ------------------------------------ |
-  #         |       John Doe       |       January 24, 2024                  |      January 27, 2024                |
-  #         |       Jane Doe       |       November 11, 2024 2:00 PM         |      November 11, 2024 6:00 PM       |
-  #         ---------------------------------------------------------------------------------------------------------
-  #
-  #   * A Notion secret, which can be obtained, by creating an integration here: `https://developers.notion.com/`,
-  #     browsing on the <View my integations> option, and selecting the <New Integration> or <Create new>
-  #     integration** buttons.
-  #   * A webhook key, which can be generated directly on discrod on the desired channel, following this instructions:
-  #     https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks
-  #
-  def self.notify_pto_from_notion_to_discord(options)
-    read = Read::Notion::PtoToday.new(options[:read_options])
-    serialize = Serialize::Notion::PtoToday.new
-    formatter = Formatter::Pto.new(options[:format_options])
-    process = Process::Discord::Implementation.new(options[:process_options])
-    write = Write::Logs::ConsoleLog.new
-    use_case_config = UseCases::Types::Config.new(read, serialize, formatter, process, write)
-
-    UseCases::UseCase.new(use_case_config)
-  end
-
-  # Provides an instance of the next week PTO notifications from Notion to Discord use case implementation.
-  #
-  # <br>
-  # <b>Example</b>
-  #
-  #   options = {
-  #     read_options: {
-  #       database_id: NOTION_DATABASE_ID,
-  #       secret: NOTION_API_INTEGRATION_SECRET,
-  #     },
-  #     process_options: {
-  #       webhook: "https://discord.com/api/webhooks/1199213527672565760/KmpoIzBet9xYG16oFh8W1RWHbpIqT7UtTBRrhfLcvWZdNiVZCTM-gpil2Qoy4eYEgpdf",
-  #       name: "Pto Bot"
-  #     },
-  #     format_options: {
-  #       template: ":beach: individual_name its going to be on PTO next week,",
-  #       timezone: "-05:00"
-  #     }
-  #   }
-  #
-  #   use_case = UseCases.notify_next_week_pto_from_notion_to_discord(options)
-  #   use_case.perform
-  #
-  #   #################################################################################
-  #
-  #   Requirements:
-  #   * Notion database ID, from a database with the following structure:
-  #
-  #         ________________________________________________________________________________________________________
-  #         |    Person (person)   |        Desde? (date)                    |       Hasta? (date)                  |
-  #         | -------------------- | --------------------------------------- | ------------------------------------ |
-  #         |       John Doe       |       January 24, 2024                  |      January 27, 2024                |
-  #         |       Jane Doe       |       November 11, 2024 2:00 PM         |      November 11, 2024 6:00 PM       |
-  #         ---------------------------------------------------------------------------------------------------------
-  #
-  #   * A Notion secret, which can be obtained, by creating an integration here: `https://developers.notion.com/`,
-  #     browsing on the <View my integations> option, and selecting the <New Integration> or <Create new>
-  #     integration** buttons.
-  #   * A webhook key, which can be generated directly on discrod on the desired channel, following this instructions:
-  #     https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks
-  #
-  def self.notify_next_week_pto_from_notion_to_discord(options)
-    read = Read::Notion::PtoNextWeek.new(options[:read_options])
-    serialize = Serialize::Notion::PtoToday.new
-    formatter = Formatter::Pto.new(options[:format_options])
-    process = Process::Discord::Implementation.new(options[:process_options])
-    write = Write::Logs::ConsoleLog.new
-    use_case_config = UseCases::Types::Config.new(read, serialize, formatter, process, write)
-
-    UseCases::UseCase.new(use_case_config)
-  end
-
-  # Provides an instance of the PTO notifications from Postgres to Slack use case implementation.
-  #
-  # <br>
-  # <b>Example</b>
-  #
-  # options = {
-  #   read_options: {
-  #     connection: {
-  #       host: "localhost",
-  #       port: 5432,
-  #       dbname: "db_pto",
-  #       user: "postgres",
-  #       password: "postgres"
-  #     }
-  #   },
-  #   process_options:{
-  #     webhook: "https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX",
-  #     name: "Pto Bot"
-  #   },
-  #   format_options: {
-  #     template: "Custom template",
-  #     timezone: "-05:00"
-  #   }
-  # }
-  #
-  #   use_case = UseCases.notify_pto_from_postgres_to_slack(options)
-  #   use_case.perform
-  #
-  #   #################################################################################
-  #
-  #   Requirements:
-  #   * A connection to a Postgres database and a table with the following structure:
-  #
-  #          Column      |          Type          | Collation | Nullable |           Default
-  #     -----------------+------------------------+-----------+----------+------------------------------
-  #      id              | integer                |           | not null | generated always as identity
-  #      create_time     | date                   |           |          |
-  #      individual_name | character varying(255) |           |          |
-  #      start_date      | date                   |           |          |
-  #      end_date        | date                   |           |          |
-  #
-  #   * A webhook key, which can be generated directly on slack on the desired channel, following this instructions:
-  #     https://api.slack.com/messaging/webhooks#create_a_webhook
-  #
-  def self.notify_pto_from_postgres_to_slack(options)
-    read = Read::Postgres::PtoToday.new(options[:read_options])
-    serialize = Serialize::Postgres::PtoToday.new
-    formatter = Formatter::Pto.new(options[:format_options])
-    process = Process::Slack::Implementation.new(options[:process_options])
-    write = Write::Logs::ConsoleLog.new
-    use_case_config = UseCases::Types::Config.new(read, serialize, formatter, process, write)
-
-    UseCases::UseCase.new(use_case_config)
-  end
-
-  # Provides an instance of the Work Items wip limit notifications from Notion to Discord use case implementation.
-  #
-  # <br>
-  # <b>Example</b>
-  #
-  #   options = {
-  #     read_options: {
-  #       database_id: NOTION_DATABASE_ID,
-  #       secret: NOTION_API_INTEGRATION_SECRET
-  #     },
-  #     process_options: {
-  #       webhook: "https://discord.com/api/webhooks/1199213527672565760/KmpoIzBet9xYG16oFh8W1RWHbpIqT7UtTBRrhfLcvWZdNiVZCTM-gpil2Qoy4eYEgpdf",
-  #       name: "wipLimit"
-  #     }
-  #   }
-  #
-  #   use_case = UseCases.notify_wip_limit_from_notion_to_discord(options)
-  #   use_case.perform
-  #
-  #   #################################################################################
-  #
-  #   Requirements:
-  #   * Notion database ID, from a database with the following structure:
-  #
-  #         _________________________________________________________________________________
-  #         |           OK         |            Status           |     Responsible Domain   |
-  #         | -------------------- | --------------------------- | ------------------------ |
-  #         |           ✅         |       In Progress           |      "kommit.admin"      |
-  #         |           🚩         |       Fail                  |      "kommit.ops"        |
-  #         ---------------------------------------------------------------------------------
-  #
-  #   * A Notion secret, which can be obtained, by creating an integration here: `https://developers.notion.com/`,
-  #     browsing on the <View my integations> option, and selecting the <New Integration> or <Create new>
-  #     integration** buttons.
-  #   * A webhook key, which can be generated directly on discrod on the desired channel, following this instructions:
-  #     https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks
-  #
-  def self.notify_wip_limit_from_notion_to_discord(options)
-    read = Read::Notion::WorkItemsLimit.new(options[:read_options])
-    serialize = Serialize::Notion::WorkItemsLimit.new
-    formatter = Formatter::WorkItemsLimit.new(options[:format_options])
-    process = Process::Discord::Implementation.new(options[:process_options])
-    write = Write::Logs::ConsoleLog.new
-    use_case_config = UseCases::Types::Config.new(read, serialize, formatter, process, write)
-
-    UseCases::UseCase.new(use_case_config)
-  end
-
-  # Provides an instance of the support emails from an google IMAP server to Discord use case implementation.
-  #
-  # <br>
-  # <b>Example</b>
-  #
-  #   options = {
-  #     read_options: {
-  #       user: 'info@email.co',
-  #       refresh_token: REFRESH_TOKEN,
-  #       client_id: CLIENT_ID,
-  #       client_secret: CLIENT_SECRET,
-  #       inbox: 'INBOX',
-  #       search_email: 'support@email.co'
-  #     },
-  #     process_options: {
-  #       webhook: "https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX",
-  #       name: "emailSupport"
-  #     }
-  #   }
-  #
-  #   use_case = UseCases.notify_support_email_from_imap_to_discord(options)
-  #   use_case.perform
-  #
-  #   #################################################################################
-  #
-  #   Requirements:
-  #   * A google gmail account with IMAP support activated.
-  #   * A set of authorization parameters like a client_id, client_secret, and a resfresh_token. To
-  #     generate them, follow this instructions: https://developers.google.com/identity/protocols/oauth2
-  #   * A webhook key, which can be generated directly on discrod on the desired channel, following this instructions:
-  #     https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks
-  #
-  def self.notify_support_email_from_imap_to_discord(options)
-    read = Read::Imap::SupportEmails.new(options[:read_options])
-    serialize = Serialize::Imap::SupportEmails.new
-    formatter = Formatter::SupportEmails.new(options[:format_options])
-    process = Process::Discord::Implementation.new(options[:process_options])
-    write = Write::Logs::ConsoleLog.new
-    use_case_config = UseCases::Types::Config.new(read, serialize, formatter, process, write)
-
-    UseCases::UseCase.new(use_case_config)
-  end
-end

data/lib/bas/write/logs/base.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "../base"
-
-module Write
-  module Logs
-    ##
-    # This class is an implementation of the Write::Base interface, specifically designed
-    # for writting logs as a STDOUT.
-    #
-    class Base < Write::Base
-      attr_reader :logger
-
-      # Initializes the write with essential configuration parameters like the logger
-      # using the Logger gem.
-      #
-      def initialize(config = {})
-        super(config)
-
-        @logger = Logger.new($stdout)
-      end
-
-      protected
-
-      # Implements the writing logic to write logs data as STOUT. It uses the Logger
-      # gem and execute the given method (info, error, etc) to write the log
-      #
-      def write(method, log_message)
-        @logger.send(method, log_message)
-      end
-    end
-  end
-end

data/lib/bas/write/logs/use_case/console_log.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "../base"
-
-module Write
-  module Logs
-    ##
-    # This class is an implementation of the Write::Logs::Base interface, specifically designed
-    # to write logs as STDOUT
-    class ConsoleLog < Logs::Base
-      # Implements the writting process logic for the ConsoleLog use case.
-      #
-      # <br>
-      # <b>Params:</b>
-      # * <tt>Process::Types::Response</tt> process response: standard process response with the data to be logged.
-      #
-      def execute(_process_response)
-        write("info", "Process Executed")
-      end
-    end
-  end
-end