bas 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97cc25416cff1a50cad38e85bbc1e7389693ccf2f4004a1c5fb8d5049162b407
-  data.tar.gz: efef410e0d776c8808655dbd20cb7500c81bcf53c16f072a7103d5827def9e58
+  metadata.gz: 362d8c607c7fbfd0405b4e7e349505f45e12b5218ae9c23416954919920bdb63
+  data.tar.gz: 78513d4ae926c12a290ceb200c1aa718d15f05c8e4536a8b58deabb3c9ca17b4
 SHA512:
-  metadata.gz: f7d915c41461667d858750e117e63468fba9cdea4fac59dfd80b0dcf1a7c4ce749b773378b06a81e2cdfafbefce92a61a2ee8415a80edd6a1e1a61380c5bdda9
-  data.tar.gz: fa174b7e86b013055efabe32b7dc7c2f213bd8dd18600c35e655d4c7512ce8e8f7ed4e104c091ca5b4def7180d4499a1c37f3dd5f4ad5e0a936ac79d716f03b1
+  metadata.gz: 9a27723bb27bc0e9aefee19b4e9a159b2da7a1171da540f910a5a1affaa940ab7861afbdafadd34fa16ed71ce2284a69503b5e43a0ac1f4f399a3cf99e5aa90f
+  data.tar.gz: 0da18b42118777de21d8c7a0a91c8ee32f3499d7a0f0bc8d5671442762cbd4a20bcb5a0daa24d9b1bfac63c1a2bb03bcedfd867c18ee52667b3e5634e79be6b6

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.3.0 (16.04.2024)
+- [Rename the Fetcher to Read](https://github.com/kommitters/bas/issues/13)
+- [Rename the Mapper to Serialize](https://github.com/kommitters/bas/issues/14)
+- [Rename the Dispatcher to Process](https://github.com/kommitters/bas/issues/15)
+- [Add the Writer Component](https://github.com/kommitters/bas/issues/16)
+
 ## 0.2.0 (04.04.2024)
 - [Add a GitHub fetcher component](https://github.com/kommitters/bas/issues/6)
 - [Allow daily hours pto for more than one day pto](https://github.com/kommitters/bas/issues/8)

data/README.md

@@ -39,27 +39,27 @@ There are 7 currently implemented use cases:
 * WIP limit exceeded - from Notion to Discord
 * Support email notification - from IMAP to Discord
 
-For this example we'll analyze the birthday notification use case, bringing data from a notion database, and dispatching the
+For this example we'll analyze the birthday notification use case, bringing data from a notion database, and sending the
 notifications to a Discord channel.
 
-A *Use Case* object, consists on 4 main components, having it's own responsibility:
+A *Use Case* object, consists on 5 main components, having it's own responsibility:
 
-### 1. Fetcher - Obtaining the data
+### 1. Read - Obtaining the data
 
-Specifically, a fetcher is an object in charged of bringing data from a data source. The gem already provides the base interface
-for building your own fetcher for your specific data source, or rely on already built classes if they match your purpose.
+Specifically, a reader is an object in charged of bringing data from a data source. The gem already provides the base interface
+for building your own reader for your specific data source, or rely on already built classes if they match your purpose.
 
-The base interface for a fetcher can be found under the `bas/fetcher/base.rb` class. Since this is a implementation of the `Fetcher::Base`
+The base interface for a reader can be found under the `bas/read/base.rb` class. Since this is a implementation of the `Read::Base`
 for bringing data from a Notion database, it was created on a new namespace for that data source, it can be found under
-`/bas/fetcher/notion/use_case/birthday_today.rb`. It implements specific logic for fetching the data and validating the response.
+`/bas/read/notion/use_case/birthday_today.rb`. It implements specific logic for reading the data and validating the response.
 
-### 2. Mapper - Shaping it
+### 2. Serialize - Shaping it
 
-The **Mapper** responsibility, is to shape the data using custom types from the app domain, bringing it into a
+The **Serializer** responsibility, is to shape the data using custom types from the app domain, bringing it into a
 common structure understandable for other components, specifically the **Formatter**.
 
-Because of the use case, the Mapper implementation for it, relies on specific types for representing a Birthday it self. It can be found
-under `/bas/mapper/notion/birthday_today.rb`
+Because of the use case, the Serializer implementation for it, relies on specific types for representing a Birthday it self. It can be found
+under `/bas/serialize/notion/birthday_today.rb`
 
 ### 3. Formatter - Preparing the message
 
@@ -67,11 +67,14 @@ The **Formatter**, is in charge of preparing the message to be sent in our notif
 The template or 'format' to be used should be included in the use case configurations, which we'll review in a further step. It's
 implementation can be found under `/bas/formatter/birthday.rb`.
 
-### 4. Dispatcher - Sending your notification
+### 4. Process - Optional Data Process
 
-Finally, the **Dispatcher** basically, sends or dispatches the formatted message into a destination, since the use case was implemented for
+Finally, the **Process** basically, allow required data process depending on the use case like sending formatted messages into a destination. In this case, since the use case was implemented for
 Discord, it implements specific logic to communicate with a Discord channel using a webhook. The webhook configuration and name for the 'Sender'
-in the channel should be provided with the initial use case configurations. It can be found under `/bas/dispatcher/discord/implementation.rb`
+in the channel should be provided with the initial use case configurations. It can be found under `/bas/process/discord/implementation.rb`
+
+### 5. Write - Apply changes in a destination
+Finally, the **Write** is in charge of creating or updating information in a destination. This is the last step in the pipeline, and it aims to allow the users to apply changes in a destination depending on the use case. These changes can be a transaction in a database, adding files in a cloud storage, or simply creating logs. For the Birthday use case, after the Process sends the notification, the Write creates a Log in the `$stdout`. It can be found under `lib/bas/write/logs/use_case/console_log.rb`
 
 ## Examples
 
@@ -113,7 +116,7 @@ today = Date.now
 }
 ```
 
-* A template for the formatter to be used for formatting the payload to dispatch to Discord. For this specific case, the format of the messages should be:
+* A template for the formatter to be used for formatting the payload to be send to Discord. For this specific case, the format of the messages should be:
 
 `"NAME, Wishing you a very happy birthday! Enjoy your special day! :birthday: :gift:"`
 
@@ -139,13 +142,13 @@ filter = {
 }
 
 options = {
-    fetch_options: {
+    read_options: {
       base_url: "https://api.notion.com",
       database_id: NOTION_DATABASE_ID,
       secret: NOTION_API_INTEGRATION_SECRET,
       filter: filter
     },
-    dispatch_options: {
+    process_options: {
       webhook: "https://discord.com/api/webhooks/1199213527672565760/KmpoIzBet9xYG16oFh8W1RWHbpIqT7UtTBRrhfLcvWZdNiVZCTM-gpil2Qoy4eYEgpdf",
       name: "Birthday Bot"
     }
@@ -235,7 +238,7 @@ module Notifier
   # Service description
   class UseCaseName
     def self.notify(*)
-      options = { fetch_options:, dispatch_options: }
+      options = { read_options:, process_options: }
 
       begin
         use_case = UseCases.use_case_build_function(options)
@@ -246,18 +249,18 @@ module Notifier
       end
     end
 
-    def self.fetch_options
+    def self.read_options
       {
         base_url: NOTION_BASE_URL,
         database_id: NOTION_DATABASE_ID,
         secret: NOTION_SECRET,
         filter: {
-          filter: { "and": fetch_filter }
+          filter: { "and": read_filter }
         }
       }
     end
 
-    def self.fetch_filter
+    def self.read_filter
       today = Common::TimeZone.set_colombia_time_zone.strftime('%F').to_s
 
       [
@@ -266,7 +269,7 @@ module Notifier
       ]
     end
 
-    def self.dispatch_options
+    def self.process_options
       {
         webhook: DISCORD_WEBHOOK,
         name: DISCORD_BOT_NAME

data/lib/bas/formatter/base.rb

@@ -20,7 +20,7 @@ module Formatter
     end
 
     # This method is designed to provide a specified format for data from any implementation of
-    # the Mapper::Base interface.
+    # the Serialize::Base interface.
     # Must be overridden by subclasses, with specific logic based on the use case.
     #
     # <br>
@@ -30,7 +30,7 @@ module Formatter
     # <br>
     # <b>raises</b> <tt>Domain::Exceptions::FunctionNotImplemented</tt> when missing implementation.
     #
-    # <b>returns</b> <tt>String</tt> Formatted payload suitable for a Dispatcher::Base implementation.
+    # <b>returns</b> <tt>String</tt> Formatted payload suitable for a Process::Base implementation.
     #
     def format(_domain_data)
       raise Domain::Exceptions::FunctionNotImplemented

data/lib/bas/formatter/birthday.rb

@@ -3,32 +3,36 @@
 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 dispatcher.
+  # 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 mapped birthdays.
+    # * <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>String</tt> payload: formatted payload suitable for a Dispatcher.
+    # <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
 
-      birthdays_list.reduce("") do |payload, birthday|
+      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/pto.rb

@@ -5,11 +5,12 @@ 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 dispatcher.
+  # Domain::Pto structure for a Process.
   class Pto < Base
     DEFAULT_TIME_ZONE = "+00:00"
 
@@ -26,13 +27,14 @@ module Formatter
     #
     # <br>
     # <b>Params:</b>
-    # * <tt>List<Domain::Pto></tt> pto_list: List of mapped PTO's.
+    # * <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>String</tt> payload, formatted payload suitable for a Dispatcher.
+    # <b>returns</b> <tt>Formatter::Types::Response</tt> formatter response: standard output for
+    # the formatted payload suitable for a Process.
     #
 
     def format(ptos_list)
@@ -40,10 +42,12 @@ module Formatter
 
       ptos_list.each { |pto| pto.format_timezone(@timezone) }
 
-      ptos_list.reduce("") do |payload, pto|
+      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

data/lib/bas/formatter/support_emails.rb

@@ -3,11 +3,12 @@
 require_relative "../domain/email"
 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::Email structure for a dispatcher.
+  # Domain::Email structure for a Process.
   class SupportEmails < Base
     DEFAULT_TIME_ZONE = "+00:00"
 
@@ -31,16 +32,19 @@ module Formatter
     # <b>raises</b> <tt>Formatter::Exceptions::InvalidData</tt> when invalid data is provided.
     #
     # <br>
-    # <b>returns</b> <tt>String</tt> payload: formatted payload suitable for a Dispatcher.
+    # <b>returns</b> <tt>Formatter::Types::Response</tt> formatter response: standard output for
+    # the formatted payload suitable for a Process.
     #
     def format(support_emails_list)
       raise Formatter::Exceptions::InvalidData unless support_emails_list.all? do |support_email|
         support_email.is_a?(Domain::Email)
       end
 
-      process_emails(support_emails_list).reduce("") do |payload, support_email|
+      response = process_emails(support_emails_list).reduce("") do |payload, support_email|
         payload + build_template(Domain::Email::ATTRIBUTES, support_email)
       end
+
+      Formatter::Types::Response.new(response)
     end
 
     private

data/lib/bas/formatter/types/response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Formatter
+  module Types
+    ##
+    # Represents a response received from a Formatter. It encapsulates the formatted data to be used by
+    # a Process or a Write component.
+    class Response
+      attr_reader :data
+
+      def initialize(response)
+        @data = response
+      end
+    end
+  end
+end

data/lib/bas/formatter/work_items_limit.rb

@@ -3,11 +3,12 @@
 require_relative "../domain/work_items_limit"
 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::WorkItemsLimit structure for a dispatcher.
+  # Domain::WorkItemsLimit structure for a Process.
   class WorkItemsLimit < Base
     DEFAULT_DOMAIN_LIMIT = 6
 
@@ -24,13 +25,14 @@ module Formatter
     #
     # <br>
     # <b>Params:</b>
-    # * <tt>List<Domain::WorkItemsLimit></tt> work_items_list: List of mapped work items limits.
+    # * <tt>List<Domain::WorkItemsLimit></tt> work_items_list: List of serialized work items limits.
     #
     # <br>
     # <b>raises</b> <tt>Formatter::Exceptions::InvalidData</tt> when invalid data is provided.
     #
     # <br>
-    # <b>returns</b> <tt>String</tt> payload, formatted payload suitable for a Dispatcher.
+    # <b>returns</b> <tt>Formatter::Types::Response</tt> formatter response: standard output for
+    # the formatted payload suitable for a Process.
     #
 
     def format(work_items_list)
@@ -38,10 +40,12 @@ module Formatter
         work_item.is_a?(Domain::WorkItemsLimit)
       end
 
-      exceeded_domains(work_items_list).reduce("") do |payload, work_items_limit|
+      response = exceeded_domains(work_items_list).reduce("") do |payload, work_items_limit|
         built_template = build_template(Domain::WorkItemsLimit::ATTRIBUTES, work_items_limit)
         payload + format_message_by_case(built_template.gsub("\n", ""), work_items_limit)
       end
+
+      Formatter::Types::Response.new(response)
     end
 
     private

data/lib/bas/process/base.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "../domain/exceptions/function_not_implemented"
+require_relative "./types/response"
+
+module Process
+  ##
+  # Serves as a foundational structure for implementing specific process. Acting as an interface,
+  # this class defines essential attributes and methods, providing a blueprint for creating custom
+  # process tailored to different platforms or services.
+  #
+  class Base
+    attr_reader :config
+
+    # Initializes the process with essential configuration parameters.
+    #
+    def initialize(config = {})
+      @config = config
+    end
+
+    # A method meant to send messages to an specific destination depending on the implementation.
+    # Must be overridden by subclasses, with specific logic based on the use case.
+    #
+    # <br>
+    # <b>returns</b> a <tt>Process::Types::Response</tt>: standard output for a process
+    #
+    def execute(format_response)
+      Process::Types::Response.new(format_response.data)
+    end
+
+    protected
+
+    def valid_format_response(format_response)
+      return format_response if format_response.is_a?(Formatter::Types::Response)
+
+      raise Formatter::Exceptions::InvalidData
+    end
+  end
+end

data/lib/bas/{dispatcher → process}/discord/exceptions/invalid_webhook_token.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Dispatcher
+module Process
   module Discord
     module Exceptions
       ##

data/lib/bas/process/discord/implementation.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require_relative "../base"
+require_relative "./exceptions/invalid_webhook_token"
+require_relative "./types/response"
+
+module Process
+  module Discord
+    ##
+    # This class is an implementation of the Process::Base interface, specifically designed
+    # for sending messages to Discord.
+    #
+    class Implementation < Base
+      attr_reader :webhook, :name
+
+      # Initializes the process with essential configuration parameters.
+      #
+      def initialize(config = {})
+        super(config)
+
+        @webhook = config[:webhook]
+        @name = config[:name]
+      end
+
+      # Implements the sending process logic for the Discord use case. It sends a POST request to
+      # the Discord webhook with the specified payload.
+      #
+      # <br>
+      # <b>Params:</b>
+      # * <tt>Formatter::Types::Response</tt> formatter response: standard formatter response
+      # with the Payload to be send to discord.
+      # <br>
+      # <b>raises</b> <tt>Exceptions::Discord::InvalidWebookToken</tt> if the provided webhook
+      # token is invalid.
+      #
+      # <br>
+      # <b>returns</b> <tt>Process::Types::Response</tt>
+      #
+      def execute(format_response)
+        response = valid_format_response(format_response)
+
+        body = post_body(response.data)
+
+        response = HTTParty.post(webhook, { body: body, headers: { "Content-Type" => "application/json" } })
+
+        discord_response = Process::Discord::Types::Response.new(response)
+
+        validate_response(discord_response)
+      end
+
+      private
+
+      def post_body(payload)
+        {
+          username: name,
+          avatar_url: "",
+          content: payload
+        }.to_json
+      end
+
+      def validate_response(response)
+        case response.code
+        when 50_027
+          raise Discord::Exceptions::InvalidWebookToken, response.message
+        else
+          Process::Types::Response.new(response)
+        end
+      end
+    end
+  end
+end

data/lib/bas/{dispatcher → process}/discord/types/response.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Dispatcher
+module Process
   module Discord
     module Types
       ##

data/lib/bas/{dispatcher → process}/slack/exceptions/invalid_webhook_token.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Dispatcher
+module Process
   module Slack
     module Exceptions
       ##

data/lib/bas/process/slack/implementation.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require_relative "../base"
+require_relative "./exceptions/invalid_webhook_token"
+require_relative "./types/response"
+
+module Process
+  module Slack
+    ##
+    # This class is an implementation of the Process::Base interface, specifically designed
+    # for sending messages to Slack.
+    #
+    class Implementation < Base
+      attr_reader :webhook, :name
+
+      # Initializes the process with essential configuration parameters.
+      #
+      def initialize(config = {})
+        super(config)
+
+        @webhook = config[:webhook]
+        @name = config[:name]
+      end
+
+      # Implements the sending process logic for the Slack use case. It sends a POST request to
+      # the Slack webhook with the specified payload.
+      #
+      # <br>
+      # <b>Params:</b>
+      # * <tt>Formatter::Types::Response</tt> formatter response: standard formatter response
+      # with the Payload to be send to slack.
+      # <br>
+      # <b>raises</b> <tt>Exceptions::Slack::InvalidWebookToken</tt> if the provided webhook
+      # token is invalid.
+      #
+      # <br>
+      # <b>returns</b> <tt>Process::Types::Response</tt>
+      #
+      def execute(format_response)
+        response = valid_format_response(format_response)
+
+        body = post_body(response.data)
+
+        response = HTTParty.post(webhook, { body: body, headers: { "Content-Type" => "application/json" } })
+
+        slack_response = Process::Discord::Types::Response.new(response)
+
+        validate_response(slack_response)
+      end
+
+      private
+
+      def post_body(payload)
+        {
+          username: name,
+          text: payload
+        }.to_json
+      end
+
+      def validate_response(response)
+        case response.http_code
+        when 403
+          raise Process::Slack::Exceptions::InvalidWebookToken, response.message
+        else
+          Process::Types::Response.new(response)
+        end
+      end
+    end
+  end
+end

data/lib/bas/{dispatcher → process}/slack/types/response.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Dispatcher
+module Process
   module Slack
     module Types
       ##

data/lib/bas/process/types/response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Process
+  module Types
+    ##
+    # Represents a response received from a Process. It encapsulates the formatted data to be used by
+    # a Write component.
+    class Response
+      attr_reader :data
+
+      def initialize(response)
+        @data = response
+      end
+    end
+  end
+end

data/lib/bas/{fetcher → read}/base.rb

@@ -2,41 +2,41 @@
 
 require_relative "../domain/exceptions/function_not_implemented"
 
-module Fetcher
+module Read
   ##
-  # The Fetcher::Base class serves as the foundation for implementing specific data fetchers within the Fetcher module.
+  # The Read::Base class serves as the foundation for implementing specific data readers within the Read module.
   # Operating as an interface, this class defines essential attributes and methods, providing a blueprint for creating
-  # custom fetchers tailored to different data sources.
+  # custom readers tailored to different data sources.
   #
   class Base
     attr_reader :config
 
-    # Initializes the fetcher with essential configuration parameters.
+    # Initializes the reader with essential configuration parameters.
     #
     def initialize(config)
       @config = config
     end
 
-    # A method meant to fetch data from an specific source depending on the implementation.
+    # A method meant to execute the read request from an specific source depending on the implementation.
     # Must be overridden by subclasses, with specific logic based on the use case.
     #
     # <br>
     # <b>raises</b> <tt>Domain::Exceptions::FunctionNotImplemented</tt> when missing implementation.
     #
-    def fetch
+    def execute
       raise Domain::Exceptions::FunctionNotImplemented
     end
 
     protected
 
-    # A method meant to execute the fetch request, retrieven the required data
+    # A method meant to read from the source, retrieven the required data
     # from an specific filter configuration depending on the use case implementation.
     # Must be overridden by subclasses, with specific logic based on the use case.
     #
     # <br>
     # <b>raises</b> <tt>Domain::Exceptions::FunctionNotImplemented</tt> when missing implementation.
     #
-    def execute
+    def read(*_filters)
       raise Domain::Exceptions::FunctionNotImplemented
     end
   end