bas 0.1.0

data/lib/bas/use_cases/use_cases.rb

@@ -0,0 +1,377 @@
+# frozen_string_literal: true
+
+# fetcher
+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/imap/use_case/support_emails"
+
+# mapper
+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 "../mapper/imap/support_emails"
+
+# formatter
+require_relative "../formatter/birthday"
+require_relative "../formatter/pto"
+require_relative "../formatter/work_items_limit"
+require_relative "../formatter/support_emails"
+
+# dispatcher
+require_relative "../dispatcher/discord/implementation"
+require_relative "../dispatcher/slack/implementation"
+
+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 = {
+  #     fetch_options: {
+  #       database_id: NOTION_DATABASE_ID,
+  #       secret: NOTION_API_INTEGRATION_SECRET,
+  #     },
+  #     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: {
+  #       database_id: NOTION_DATABASE_ID,
+  #       secret: NOTION_API_INTEGRATION_SECRET,
+  #     },
+  #     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_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)
+    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)
+
+    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 = {
+  #     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"
+  #     }
+  #   }
+  #
+  #   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)
+    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_config = UseCases::Types::Config.new(fetcher, mapper, formatter, dispatcher)
+
+    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
+
+  # Provides an instance of the support emails from an google IMAP server to Discord use case implementation.
+  #
+  # <br>
+  # <b>Example</b>
+  #
+  #   options = {
+  #     fetch_options: {
+  #       user: 'info@email.co',
+  #       refresh_token: REFRESH_TOKEN,
+  #       client_id: CLIENT_ID,
+  #       client_secret: CLIENT_SECRET,
+  #       inbox: 'INBOX',
+  #       search_email: 'support@email.co'
+  #     },
+  #     dispatch_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)
+    fetcher = Fetcher::Imap::SupportEmails.new(options[:fetch_options])
+    mapper = Mapper::Imap::SupportEmails.new
+    formatter = Formatter::SupportEmails.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/bas/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Bas
+  # Gem version
+  VERSION = "0.1.0"
+end

data/lib/bas.rb

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

data/renovate.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": [
+    "config:semverAllMonthly"
+  ]
+}

data/sig/business_automation_system.rbs

@@ -0,0 +1,4 @@
+module BusinessNotificationSystem
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: bas
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- kommitters Open Source
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-03-26 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
+  workflows without excessive complexity.     Formerly known as 'bns'.
+email:
+- oss@kommit.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- "._.rspec_status"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- SECURITY.md
+- lib/bas.rb
+- lib/bas/dispatcher/base.rb
+- lib/bas/dispatcher/discord/exceptions/invalid_webhook_token.rb
+- lib/bas/dispatcher/discord/implementation.rb
+- lib/bas/dispatcher/discord/types/response.rb
+- lib/bas/dispatcher/slack/exceptions/invalid_webhook_token.rb
+- lib/bas/dispatcher/slack/implementation.rb
+- lib/bas/dispatcher/slack/types/response.rb
+- lib/bas/domain/birthday.rb
+- lib/bas/domain/email.rb
+- lib/bas/domain/exceptions/function_not_implemented.rb
+- lib/bas/domain/pto.rb
+- lib/bas/domain/work_items_limit.rb
+- lib/bas/fetcher/base.rb
+- lib/bas/fetcher/imap/base.rb
+- lib/bas/fetcher/imap/types/response.rb
+- lib/bas/fetcher/imap/use_case/support_emails.rb
+- lib/bas/fetcher/notion/base.rb
+- lib/bas/fetcher/notion/exceptions/invalid_api_key.rb
+- lib/bas/fetcher/notion/exceptions/invalid_database_id.rb
+- lib/bas/fetcher/notion/helper.rb
+- lib/bas/fetcher/notion/types/response.rb
+- lib/bas/fetcher/notion/use_case/birthday_next_week.rb
+- lib/bas/fetcher/notion/use_case/birthday_today.rb
+- lib/bas/fetcher/notion/use_case/pto_next_week.rb
+- lib/bas/fetcher/notion/use_case/pto_today.rb
+- lib/bas/fetcher/notion/use_case/work_items_limit.rb
+- lib/bas/fetcher/postgres/base.rb
+- lib/bas/fetcher/postgres/helper.rb
+- lib/bas/fetcher/postgres/types/response.rb
+- lib/bas/fetcher/postgres/use_case/pto_today.rb
+- lib/bas/formatter/base.rb
+- lib/bas/formatter/birthday.rb
+- lib/bas/formatter/exceptions/invalid_data.rb
+- lib/bas/formatter/pto.rb
+- lib/bas/formatter/support_emails.rb
+- lib/bas/formatter/work_items_limit.rb
+- lib/bas/mapper/base.rb
+- lib/bas/mapper/imap/support_emails.rb
+- lib/bas/mapper/notion/birthday_today.rb
+- lib/bas/mapper/notion/pto_today.rb
+- lib/bas/mapper/notion/work_items_limit.rb
+- lib/bas/mapper/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/version.rb
+- renovate.json
+- sig/business_automation_system.rbs
+homepage: https://github.com/kommitters/bas
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/kommitters/bas
+  source_code_uri: https://github.com/kommitters/bas
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: BAS - Business automation system
+test_files: []