bns 0.1.1 → 0.2.0

data/lib/bns/use_cases/use_cases.rb

@@ -1,14 +1,24 @@
 # frozen_string_literal: true
 
-require_relative "../fetcher/notion/birthday"
-require_relative "../mapper/notion/birthday"
-require_relative "../formatter/discord/birthday"
+require_relative "../fetcher/notion/use_case/birthday_today"
+require_relative "../fetcher/notion/use_case/birthday_next_week"
+require_relative "../fetcher/notion/use_case/pto_today"
+require_relative "../fetcher/notion/use_case/pto_next_week"
+require_relative "../fetcher/notion/use_case/work_items_limit"
+require_relative "../fetcher/postgres/use_case/pto_today"
 
-require_relative "../fetcher/notion/pto"
-require_relative "../mapper/notion/pto"
-require_relative "../formatter/discord/pto"
+require_relative "../mapper/notion/birthday_today"
+require_relative "../mapper/notion/pto_today"
+require_relative "../mapper/notion/work_items_limit"
+require_relative "../mapper/postgres/pto_today"
+
+require_relative "../formatter/birthday"
+require_relative "../formatter/pto"
+require_relative "../formatter/work_items_limit"
 
 require_relative "../dispatcher/discord/implementation"
+require_relative "../dispatcher/slack/implementation"
+
 require_relative "use_case"
 require_relative "./types/config"
 
@@ -21,33 +31,70 @@ module UseCases
   #
   # <b>Example</b>
   #
-  #  "filter": {
-  #    "or": [
-  #        {
-  #         "property": "BD_this_year",
-  #         "date": {
-  #          "equals": today
-  #         }
-  #        }
-  #       ]
+  #   options = {
+  #     fetch_options: {
+  #       database_id: NOTION_DATABASE_ID,
+  #       secret: NOTION_API_INTEGRATION_SECRET,
   #     },
-  #    "sorts": []
+  #     dispatch_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)
+    fetcher = Fetcher::Notion::BirthdayToday.new(options[:fetch_options])
+    mapper = Mapper::Notion::BirthdayToday.new
+    formatter = Formatter::Birthday.new(options[:format_options])
+    dispatcher = Dispatcher::Discord::Implementation.new(options[:dispatch_options])
+    use_case_config = UseCases::Types::Config.new(fetcher, mapper, formatter, dispatcher)
+
+    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 = {
   #     fetch_options: {
-  #       base_url: "https://api.notion.com",
   #       database_id: NOTION_DATABASE_ID,
   #       secret: NOTION_API_INTEGRATION_SECRET,
-  #       filter: filter
   #     },
   #     dispatch_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_birthday_from_notion_to_discord(options)
+  #   use_case = UseCases.notify_next_week_birthday_from_notion_to_discord(options)
   #   use_case.perform
   #
   #   #################################################################################
@@ -70,10 +117,10 @@ module UseCases
   #   * 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)
-    fetcher = Fetcher::Notion::Birthday.new(options[:fetch_options])
-    mapper = Mapper::Notion::Birthday.new
-    formatter = Formatter::Discord::Birthday.new(options[:format_options])
+  def self.notify_next_week_birthday_from_notion_to_discord(options)
+    fetcher = Fetcher::Notion::BirthdayNextWeek.new(options[:fetch_options])
+    mapper = Mapper::Notion::BirthdayToday.new
+    formatter = Formatter::Birthday.new(options[:format_options])
     dispatcher = Dispatcher::Discord::Implementation.new(options[:dispatch_options])
     use_case_cofig = UseCases::Types::Config.new(fetcher, mapper, formatter, dispatcher)
 
@@ -85,31 +132,10 @@ module UseCases
   # <br>
   # <b>Example</b>
   #
-  #   "filter": {
-  #     "and": [
-  #       {
-  #         property: "Desde?",
-  #         date: {
-  #           "on_or_before": today
-  #         }
-  #       },
-  #       {s
-  #         property: "Hasta?",
-  #         date: {
-  #           "on_or_after": today
-  #         }
-  #       }
-  #      ]
-  #    },
-  #    "sorts": []
-  #   }
-  #
   #   options = {
   #     fetch_options: {
-  #       base_url: "https://api.notion.com",
   #       database_id: NOTION_DATABASE_ID,
   #       secret: NOTION_API_INTEGRATION_SECRET,
-  #       filter: filter
   #     },
   #     dispatch_options: {
   #       webhook: "https://discord.com/api/webhooks/1199213527672565760/KmpoIzBet9xYG16oFh8W1RWHbpIqT7UtTBRrhfLcvWZdNiVZCTM-gpil2Qoy4eYEgpdf",
@@ -139,12 +165,164 @@ module UseCases
   #     https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks
   #
   def self.notify_pto_from_notion_to_discord(options)
-    fetcher = Fetcher::Notion::Pto.new(options[:fetch_options])
-    mapper = Mapper::Notion::Pto.new
-    formatter = Formatter::Discord::Pto.new(options[:format_options])
+    fetcher = Fetcher::Notion::PtoToday.new(options[:fetch_options])
+    mapper = Mapper::Notion::PtoToday.new
+    formatter = Formatter::Pto.new(options[:format_options])
     dispatcher = Dispatcher::Discord::Implementation.new(options[:dispatch_options])
-    use_case_cofig = UseCases::Types::Config.new(fetcher, mapper, formatter, dispatcher)
+    use_case_config = UseCases::Types::Config.new(fetcher, mapper, formatter, dispatcher)
 
-    UseCases::UseCase.new(use_case_cofig)
+    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 = {
+  #     fetch_options: {
+  #       database_id: NOTION_DATABASE_ID,
+  #       secret: NOTION_API_INTEGRATION_SECRET,
+  #     },
+  #     dispatch_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)
+    fetcher = Fetcher::Notion::PtoNextWeek.new(options[:fetch_options])
+    mapper = Mapper::Notion::PtoToday.new
+    formatter = Formatter::Pto.new(options[:format_options])
+    dispatcher = Dispatcher::Discord::Implementation.new(options[:dispatch_options])
+    use_case_config = UseCases::Types::Config.new(fetcher, mapper, formatter, dispatcher)
+
+    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 = {
+  #   fetch_options: {
+  #     connection: {
+  #       host: "localhost",
+  #       port: 5432,
+  #       dbname: "db_pto",
+  #       user: "postgres",
+  #       password: "postgres"
+  #     }
+  #   },
+  #   dispatch_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)
+    fetcher = Fetcher::Postgres::PtoToday.new(options[:fetch_options])
+    mapper = Mapper::Postgres::PtoToday.new
+    formatter = Formatter::Pto.new(options[:format_options])
+    dispatcher = Dispatcher::Slack::Implementation.new(options[:dispatch_options])
+    use_case_config = UseCases::Types::Config.new(fetcher, mapper, formatter, dispatcher)
+
+    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 = {
+  #     fetch_options: {
+  #       database_id: NOTION_DATABASE_ID,
+  #       secret: NOTION_API_INTEGRATION_SECRET
+  #     },
+  #     dispatch_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)
+    fetcher = Fetcher::Notion::WorkItemsLimit.new(options[:fetch_options])
+    mapper = Mapper::Notion::WorkItemsLimit.new
+    formatter = Formatter::WorkItemsLimit.new(options[:format_options])
+    dispatcher = Dispatcher::Discord::Implementation.new(options[:dispatch_options])
+    use_case_config = UseCases::Types::Config.new(fetcher, mapper, formatter, dispatcher)
+
+    UseCases::UseCase.new(use_case_config)
   end
 end

data/lib/bns/version.rb

@@ -2,5 +2,5 @@
 
 module Bns
   # Gem version
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bns
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - kommitters Open Source
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-08 00:00:00.000000000 Z
+date: 2024-02-29 00:00:00.000000000 Z
 dependencies: []
 description: A versatile business notification system offering key components for
   building various use cases.     It provides an easy-to-use tool for implementing
@@ -19,6 +19,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- "._.rspec_status"
 - ".rspec"
 - ".rubocop.yml"
 - CHANGELOG.md
@@ -34,23 +35,38 @@ files:
 - lib/bns/dispatcher/discord/exceptions/invalid_webhook_token.rb
 - lib/bns/dispatcher/discord/implementation.rb
 - lib/bns/dispatcher/discord/types/response.rb
+- lib/bns/dispatcher/slack/exceptions/invalid_webhook_token.rb
+- lib/bns/dispatcher/slack/implementation.rb
+- lib/bns/dispatcher/slack/types/response.rb
 - lib/bns/domain/birthday.rb
 - lib/bns/domain/exceptions/function_not_implemented.rb
 - lib/bns/domain/pto.rb
+- lib/bns/domain/work_items_limit.rb
 - lib/bns/fetcher/base.rb
-- lib/bns/fetcher/notion/birthday.rb
+- lib/bns/fetcher/notion/base.rb
 - lib/bns/fetcher/notion/exceptions/invalid_api_key.rb
 - lib/bns/fetcher/notion/exceptions/invalid_database_id.rb
 - lib/bns/fetcher/notion/helper.rb
-- lib/bns/fetcher/notion/pto.rb
 - lib/bns/fetcher/notion/types/response.rb
+- lib/bns/fetcher/notion/use_case/birthday_next_week.rb
+- lib/bns/fetcher/notion/use_case/birthday_today.rb
+- lib/bns/fetcher/notion/use_case/pto_next_week.rb
+- lib/bns/fetcher/notion/use_case/pto_today.rb
+- lib/bns/fetcher/notion/use_case/work_items_limit.rb
+- lib/bns/fetcher/postgres/base.rb
+- lib/bns/fetcher/postgres/helper.rb
+- lib/bns/fetcher/postgres/types/response.rb
+- lib/bns/fetcher/postgres/use_case/pto_today.rb
 - lib/bns/formatter/base.rb
-- lib/bns/formatter/discord/birthday.rb
-- lib/bns/formatter/discord/exceptions/invalid_data.rb
-- lib/bns/formatter/discord/pto.rb
+- lib/bns/formatter/birthday.rb
+- lib/bns/formatter/exceptions/invalid_data.rb
+- lib/bns/formatter/pto.rb
+- lib/bns/formatter/work_items_limit.rb
 - lib/bns/mapper/base.rb
-- lib/bns/mapper/notion/birthday.rb
-- lib/bns/mapper/notion/pto.rb
+- lib/bns/mapper/notion/birthday_today.rb
+- lib/bns/mapper/notion/pto_today.rb
+- lib/bns/mapper/notion/work_items_limit.rb
+- lib/bns/mapper/postgres/pto_today.rb
 - lib/bns/use_cases/types/config.rb
 - lib/bns/use_cases/use_case.rb
 - lib/bns/use_cases/use_cases.rb

data/lib/bns/fetcher/notion/birthday.rb

@@ -1,53 +0,0 @@
-# frozen_string_literal: true
-
-require "httparty"
-require "date"
-
-require_relative "../base"
-require_relative "./exceptions/invalid_api_key"
-require_relative "./exceptions/invalid_database_id"
-require_relative "./types/response"
-require_relative "./helper"
-
-module Fetcher
-  module Notion
-    ##
-    # This class is an implementation of the Fetcher::Base interface, specifically designed
-    # for fetching birthday data from Notion.
-    #
-    class Birthday < Base
-      # Implements the data fetching logic for Birthdays data from Notion. It sends a POST
-      # request to the Notion API to query the specified database and returns a validated response.
-      #
-      # <br>
-      # <b>raises</b> <tt>Exceptions::Notion::InvalidApiKey</tt> if the API key provided is incorrect or invalid.
-      #
-      # <b>raises</b> <tt>Exceptions::Notion::InvalidDatabaseId</tt> if the Database id provided is incorrect
-      # or invalid.
-      #
-      def fetch
-        url = build_url(config[:base_url], config[:database_id])
-
-        httparty_response = HTTParty.post(url, { body: config[:filter].to_json, headers: headers })
-
-        notion_response = Fetcher::Notion::Types::Response.new(httparty_response)
-
-        Fetcher::Notion::Helper.validate_response(notion_response)
-      end
-
-      private
-
-      def headers
-        {
-          "Authorization" => "Bearer #{config[:secret]}",
-          "Content-Type" => "application/json",
-          "Notion-Version" => "2022-06-28"
-        }
-      end
-
-      def build_url(base, database_id)
-        "#{base}/v1/databases/#{database_id}/query"
-      end
-    end
-  end
-end

data/lib/bns/formatter/discord/birthday.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "../../domain/birthday"
-require_relative "../base"
-require_relative "./exceptions/invalid_data"
-
-module Formatter
-  module Discord
-    ##
-    # This class implementats the methods of the Formatter::Base module, specifically designed for formatting birthday
-    # data in a way suitable for Discord messages.
-    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 mapped birthdays.
-      #
-      # <br>
-      # <b>raises</b> <tt>Formatter::Discord::Exceptions::InvalidData</tt> when invalid data is provided.
-      #
-      # <br>
-      # <b>returns</b> <tt>String</tt> payload: formatted payload suitable for a Discord message.
-      #
-      def format(birthdays_list)
-        raise Formatter::Discord::Exceptions::InvalidData unless birthdays_list.all? do |brithday|
-                                                                   brithday.is_a?(Domain::Birthday)
-                                                                 end
-
-        birthdays_list.reduce("") do |payload, birthday|
-          payload + build_template(Domain::Birthday::ATTRIBUTES, birthday)
-        end
-      end
-    end
-  end
-end

data/lib/bns/formatter/discord/exceptions/invalid_data.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module Formatter
-  module Discord
-    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
-end

data/lib/bns/formatter/discord/pto.rb

@@ -1,49 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "../../domain/pto"
-require_relative "../base"
-
-module Formatter
-  module Discord
-    ##
-    # This class is an implementation of the Formatter::Base interface, specifically designed for formatting PTO
-    # data in a way suitable for Discord messages.
-    class Pto < Base
-      # 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 mapped PTO's.
-      #
-      # <br>
-      # <b>raises</b> <tt>Formatter::Discord::Exceptions::InvalidData</tt> when invalid data is provided.
-      #
-      # <br>
-      # <b>returns</b> <tt>String</tt> payload, formatted payload suitable for a Discord message.
-      #
-
-      def format(ptos_list)
-        raise Formatter::Discord::Exceptions::InvalidData unless ptos_list.all? { |pto| pto.is_a?(Domain::Pto) }
-
-        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
-      end
-
-      private
-
-      def format_message_by_case(built_template, pto)
-        if pto.start_date.include?("|")
-          start_time = pto.start_date.split("|")
-          end_time = pto.end_date.split("|")
-          "#{built_template} #{start_time[1]} - #{end_time[1]}\n"
-        elsif pto.start_date == pto.end_date
-          "#{built_template} all day\n"
-        else
-          "#{built_template} #{pto.start_date} - #{pto.end_date}\n"
-        end
-      end
-    end
-  end
-end