bns 0.1.0

data/lib/bns/mapper/notion/pto.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require_relative "../../domain/pto"
+require_relative "../base"
+
+module Mapper
+  module Notion
+    ##
+    # This class implementats the methods of the Mapper::Base module, specifically designed for preparing or
+    # shaping PTO's data coming from a Fetcher::Base implementation.
+    #
+    class Pto
+      include Base
+
+      # Implements the logic for shaping the results from a fetcher response.
+      #
+      # <br>
+      # <b>Params:</b>
+      # * <tt>Fetcher::Notion::Types::Response</tt> notion_response: Notion response object.
+      #
+      # <br>
+      # <b>returns</b> <tt>List<Domain::Pto></tt> ptos_list, mapped PTO's to be used by a Formatter::Base
+      # implementation.
+      #
+      def map(notion_response)
+        return [] if notion_response.results.empty?
+
+        normalized_notion_data = normalize_response(notion_response.results)
+        normalized_notion_data.map do |pto|
+          Domain::Pto.new(pto["name"], format_date(pto["start"]), format_date(pto["end"]))
+        end
+      end
+
+      private
+
+      def normalize_response(response)
+        return [] if response.nil?
+
+        normalized_response = []
+
+        response.map do |value|
+          properties = value["properties"]
+          properties.delete("Name")
+
+          normalized_value = normalize(properties)
+
+          normalized_response.append(normalized_value)
+        end
+
+        normalized_response
+      end
+
+      def normalize(properties)
+        normalized_value = {}
+
+        properties.each do |k, v|
+          extract_pto_fields(k, v, normalized_value)
+        end
+
+        normalized_value
+      end
+
+      def extract_pto_fields(key, value, normalized_value)
+        case key
+        when "Person"
+          user_name = extract_person_field_value(value)
+          normalized_value["name"] = user_name
+        when "Desde?"
+          normalized_value["start"] = extract_date_field_value(value)
+        when "Hasta?"
+          normalized_value["end"] = extract_date_field_value(value)
+        end
+      end
+
+      def extract_person_field_value(data)
+        data["people"][0]["name"]
+      end
+
+      def extract_date_field_value(data)
+        data["date"]["start"]
+      end
+
+      def format_date(str_date)
+        return "" if str_date.nil?
+
+        if str_date.include?("T")
+          format = "%Y-%m-%d|%I:%M %p"
+          datetime = Time.new(str_date)
+          datetime.strftime(format)
+        else
+          str_date
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# 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 :fetcher, :mapper, :formatter, :dispatcher
+
+      def initialize(fetcher, mapper, formatter, dispatcher)
+        @fetcher = fetcher
+        @mapper = mapper
+        @formatter = formatter
+        @dispatcher = dispatcher
+      end
+    end
+  end
+end

data/lib/bns/use_cases/use_case.rb

@@ -0,0 +1,39 @@
+# 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 :fetcher, :mapper, :formatter, :dispatcher
+
+    # 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)
+      @fetcher = config.fetcher
+      @mapper = config.mapper
+      @formatter = config.formatter
+      @dispatcher = config.dispatcher
+    end
+
+    # Executes the use case by orchestrating the sequential execution of the fetcher, mapper, formatter, and dispatcher.
+    #
+    # <br>
+    # <b>returns</b> <tt>Dispatcher::Discord::Types::Response</tt>
+    #
+    def perform
+      response = fetcher.fetch
+
+      mappings = mapper.map(response)
+
+      formatted_payload = formatter.format(mappings)
+
+      dispatcher.dispatch(formatted_payload)
+    end
+  end
+end

data/lib/bns/use_cases/use_cases.rb

@@ -0,0 +1,150 @@
+# frozen_string_literal: true
+
+require_relative "../fetcher/notion/birthday"
+require_relative "../mapper/notion/birthday"
+require_relative "../formatter/discord/birthday"
+
+require_relative "../fetcher/notion/pto"
+require_relative "../mapper/notion/pto"
+require_relative "../formatter/discord/pto"
+
+require_relative "../dispatcher/discord/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>
+  #
+  #  "filter": {
+  #    "or": [
+  #        {
+  #         "property": "BD_this_year",
+  #         "date": {
+  #          "equals": 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",
+  #       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::Birthday.new(options[:fetch_options])
+    mapper = Mapper::Notion::Birthday.new
+    formatter = Formatter::Discord::Birthday.new
+    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>
+  #
+  #   "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",
+  #       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::Pto.new(options[:fetch_options])
+    mapper = Mapper::Notion::Pto.new
+    formatter = Formatter::Discord::Pto.new
+    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
+end

data/lib/bns/version.rb

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

data/lib/bns.rb

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

data/sig/business_notification_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,84 @@
+--- !ruby/object:Gem::Specification
+name: bns
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- kommitters Open Source
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-02-06 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
+  notifications without excessive complexity.
+email:
+- oss@kommit.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/bns.rb
+- lib/bns/dispatcher/base.rb
+- lib/bns/dispatcher/discord/exceptions/invalid_webhook_token.rb
+- lib/bns/dispatcher/discord/implementation.rb
+- lib/bns/dispatcher/discord/types/response.rb
+- lib/bns/domain/birthday.rb
+- lib/bns/domain/exceptions/function_not_implemented.rb
+- lib/bns/domain/pto.rb
+- lib/bns/fetcher/base.rb
+- lib/bns/fetcher/notion/birthday.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/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/mapper/base.rb
+- lib/bns/mapper/notion/birthday.rb
+- lib/bns/mapper/notion/pto.rb
+- lib/bns/use_cases/types/config.rb
+- lib/bns/use_cases/use_case.rb
+- lib/bns/use_cases/use_cases.rb
+- lib/bns/version.rb
+- sig/business_notification_system.rbs
+homepage: https://github.com/kommitters/bns
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/kommitters/bns
+  source_code_uri: https://github.com/kommitters/bns
+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: BNS - Business notification system
+test_files: []