bas 0.4.0 → 1.0.0

data/lib/bas/serialize/base.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "../domain/exceptions/function_not_implemented"
-
-module Serialize
-  ##
-  # The Serialize::Base module serves as the foundation for implementing specific data shaping logic within the
-  # Serialize module. Defines essential methods, that provide a blueprint for organizing or shaping data in a manner
-  # suitable for downstream formatting processes.
-  #
-  module Base
-    # An method meant to prepare or organize the data coming from an implementation of the Read::Base interface.
-    # Must be overridden by subclasses, with specific logic based on the use case.
-    #
-    # <br>
-    # <b>Params:</b>
-    # * <tt>Read::Notion::Types::Response</tt> response: Response produced by a reader.
-    #
-    # <br>
-    #
-    # <b>raises</b> <tt>Domain::Exceptions::FunctionNotImplemented</tt> when missing implementation.
-    # <br>
-    #
-    # <b>returns</b> <tt>List<Domain::></tt> Serialize list of data, ready to be formatted.
-    #
-    def execute(_response)
-      raise Domain::Exceptions::FunctionNotImplemented
-    end
-  end
-end

data/lib/bas/serialize/github/issues.rb

@@ -1,57 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "../../domain/issue"
-require_relative "../base"
-
-module Serialize
-  module Github
-    ##
-    # This class implements the methods of the Serialize::Base module, specifically designed for
-    # preparing or shaping Github issues data coming from a Read::Base implementation.
-    class Issues
-      include Base
-
-      # Implements the logic for shaping the results from a reader response.
-      #
-      # <br>
-      # <b>Params:</b>
-      # * <tt>Read::Github::Types::Response</tt> github_response: Array of github issues data.
-      #
-      # <br>
-      # <b>return</b> <tt>List<Domain::Issue></tt> serialized github issues to be used by a
-      # Formatter::Base implementation.
-      #
-      def execute(github_response)
-        return [] if github_response.results.empty?
-
-        normalized_github_data = normalize_response(github_response.results)
-
-        normalized_github_data.map do |issue|
-          Domain::Issue.new(
-            issue["title"], issue["state"], issue["assignees"], issue["body"], issue["url"]
-          )
-        end
-      end
-
-      private
-
-      def normalize_response(results)
-        return [] if results.nil?
-
-        results.map do |value|
-          {
-            "title" => value[:title],
-            "state" => value[:state],
-            "assignees" => extract_assignees(value[:assignees]),
-            "body" => value[:body],
-            "url" => value[:url]
-          }
-        end
-      end
-
-      def extract_assignees(assignees)
-        assignees.map { |assignee| assignee[:login] }
-      end
-    end
-  end
-end

data/lib/bas/serialize/imap/support_emails.rb

@@ -1,56 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "../../domain/email"
-require_relative "../base"
-
-module Serialize
-  module Imap
-    ##
-    # This class implements the methods of the Serialize::Base module, specifically designed for
-    # preparing or shaping support emails data coming from a Read::Base implementation.
-    class SupportEmails
-      include Base
-
-      # Implements the logic for shaping the results from a reader response.
-      #
-      # <br>
-      # <b>Params:</b>
-      # * <tt>Read::Imap::Types::Response</tt> imap_response: Array of imap emails data.
-      #
-      # <br>
-      # <b>return</b> <tt>List<Domain::Email></tt> support_emails_list, serialized support emails to be used by a
-      # Formatter::Base implementation.
-      #
-      def execute(imap_response)
-        return [] if imap_response.results.empty?
-
-        normalized_email_data = normalize_response(imap_response.results)
-
-        normalized_email_data.map do |email|
-          Domain::Email.new(email["subject"], email["sender"], email["date"])
-        end
-      end
-
-      private
-
-      def normalize_response(results)
-        return [] if results.nil?
-
-        results.map do |value|
-          {
-            "sender" => extract_sender(value),
-            "date" => value.date,
-            "subject" => value.subject
-          }
-        end
-      end
-
-      def extract_sender(value)
-        mailbox = value.sender[0]["mailbox"]
-        host = value.sender[0]["host"]
-
-        "#{mailbox}@#{host}"
-      end
-    end
-  end
-end

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

@@ -1,68 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "../../domain/birthday"
-require_relative "../base"
-
-module Serialize
-  module Notion
-    ##
-    # This class implements the methods of the Serialize::Base module, specifically designed for preparing or
-    # shaping birthdays data coming from a Read::Base implementation.
-    class BirthdayToday
-      include Base
-
-      BIRTHDAY_PARAMS = ["Complete Name", "BD_this_year"].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::Birthday></tt> birthdays_list, serialized birthdays 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)
-
-        normalized_notion_data.map do |birthday|
-          Domain::Birthday.new(birthday["Complete Name"], birthday["BD_this_year"])
-        end
-      end
-
-      private
-
-      def normalize_response(results)
-        return [] if results.nil?
-
-        results.map do |value|
-          birthday_fields = value["properties"].slice(*BIRTHDAY_PARAMS)
-
-          birthday_fields.each do |field, birthday_value|
-            birthday_fields[field] = extract_birthday_value(field, birthday_value)
-          end
-
-          birthday_fields
-        end
-      end
-
-      def extract_birthday_value(field, value)
-        case field
-        when "Complete Name" then extract_rich_text_field_value(value)
-        when "BD_this_year" then extract_date_field_value(value)
-        end
-      end
-
-      def extract_rich_text_field_value(data)
-        data["rich_text"][0]["plain_text"]
-      end
-
-      def extract_date_field_value(data)
-        data["formula"]["date"]["start"]
-      end
-    end
-  end
-end

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

@@ -1,56 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "../../domain/notification"
-require_relative "../base"
-
-module Serialize
-  module Notion
-    ##
-    # This class implements the methods of the Serialize::Base module, specifically designed for preparing or
-    # shaping Notification's data coming from a Read::Base implementation.
-    #
-    class Notification
-      include Base
-
-      NOTIFICATION_PARAMS = ["Notification"].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>returns</b> <tt>List<Domain::Notification></tt> notification_list, serialized
-      # notifications 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)
-
-        normalized_notion_data.map do |notification|
-          Domain::Notification.new(notification["Notification"])
-        end
-      end
-
-      private
-
-      def normalize_response(response)
-        return [] if response.nil?
-
-        response.map do |value|
-          notification_fields = value["properties"].slice(*NOTIFICATION_PARAMS)
-
-          {
-            "Notification" => extract_notification_field_value(notification_fields["Notification"])
-          }
-        end
-      end
-
-      def extract_notification_field_value(notification)
-        notification["rich_text"][0]["plain_text"]
-      end
-    end
-  end
-end

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

@@ -1,75 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "../../domain/pto"
-require_relative "../base"
-
-module Serialize
-  module Notion
-    ##
-    # This class implements the methods of the Serialize::Base module, specifically designed for preparing or
-    # shaping PTO's data coming from a Read::Base implementation.
-    #
-    class PtoToday
-      include Base
-
-      PTO_PARAMS = ["Description", "Desde?", "Hasta?"].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>returns</b> <tt>List<Domain::Pto></tt> ptos_list, serialized PTO's 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)
-
-        normalized_notion_data.map do |pto|
-          Domain::Pto.new(pto["Description"], pto["Desde?"], pto["Hasta?"])
-        end
-      end
-
-      private
-
-      def normalize_response(response)
-        return [] if response.nil?
-
-        response.map do |value|
-          pto_fields = value["properties"].slice(*PTO_PARAMS)
-
-          {
-            "Description" => extract_description_field_value(pto_fields["Description"]),
-            "Desde?" => extract_date_field_value(pto_fields["Desde?"]),
-            "Hasta?" => extract_date_field_value(pto_fields["Hasta?"])
-          }
-        end
-      end
-
-      def extract_description_field_value(data)
-        names = data["title"].map { |name| name["plain_text"] }
-
-        names.join(" ")
-      end
-
-      def extract_date_field_value(date)
-        {
-          from: extract_start_date(date),
-          to: extract_end_date(date)
-        }
-      end
-
-      def extract_start_date(data)
-        data["date"]["start"]
-      end
-
-      def extract_end_date(data)
-        data["date"]["end"]
-      end
-    end
-  end
-end

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