bas 0.1.0 → 0.3.0

data/lib/bas/write/base.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "../domain/exceptions/function_not_implemented"
+
+module Write
+  ##
+  # The Write::Base class serves as the foundation for implementing specific data write within the Write module.
+  # Operating as an interface, this class defines essential attributes and methods, providing a blueprint for creating
+  # a custom write.
+  #
+  class Base
+    attr_reader :config
+
+    # Initializes the write with essential configuration parameters.
+    #
+    def initialize(config = {})
+      @config = config
+    end
+
+    # A method meant to execute the write request to an specific destination 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 execute(_process_response)
+      raise Domain::Exceptions::FunctionNotImplemented
+    end
+
+    protected
+
+    def write(_method, _data)
+      raise Domain::Exceptions::FunctionNotImplemented
+    end
+  end
+end

data/lib/bas/write/logs/base.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative "../base"
+
+module Write
+  module Logs
+    ##
+    # This class is an implementation of the Write::Base interface, specifically designed
+    # for writting logs as a STDOUT.
+    #
+    class Base < Write::Base
+      attr_reader :logger
+
+      # Initializes the write with essential configuration parameters like the logger
+      # using the Logger gem.
+      #
+      def initialize(config = {})
+        super(config)
+
+        @logger = Logger.new($stdout)
+      end
+
+      protected
+
+      # Implements the writing logic to write logs data as STOUT. It uses the Logger
+      # gem and execute the given method (info, error, etc) to write the log
+      #
+      def write(method, log_message)
+        @logger.send(method, log_message)
+      end
+    end
+  end
+end

data/lib/bas/write/logs/use_case/console_log.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative "../base"
+
+module Write
+  module Logs
+    ##
+    # This class is an implementation of the Write::Logs::Base interface, specifically designed
+    # to write logs as STDOUT
+    class ConsoleLog < Logs::Base
+      # Implements the writting process logic for the ConsoleLog use case.
+      #
+      # <br>
+      # <b>Params:</b>
+      # * <tt>Process::Types::Response</tt> process response: standard process response with the data to be logged.
+      #
+      def execute(_process_response)
+        write("info", "Process Executed")
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bas
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - kommitters Open Source
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-26 00:00:00.000000000 Z
+date: 2024-04-16 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
@@ -31,52 +31,62 @@ files:
 - 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/issue.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/types/response.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/process/base.rb
+- lib/bas/process/discord/exceptions/invalid_webhook_token.rb
+- lib/bas/process/discord/implementation.rb
+- lib/bas/process/discord/types/response.rb
+- lib/bas/process/slack/exceptions/invalid_webhook_token.rb
+- lib/bas/process/slack/implementation.rb
+- lib/bas/process/slack/types/response.rb
+- lib/bas/process/types/response.rb
+- lib/bas/read/base.rb
+- lib/bas/read/github/base.rb
+- lib/bas/read/github/types/response.rb
+- lib/bas/read/github/use_case/repo_issues.rb
+- lib/bas/read/imap/base.rb
+- lib/bas/read/imap/types/response.rb
+- lib/bas/read/imap/use_case/support_emails.rb
+- lib/bas/read/notion/base.rb
+- lib/bas/read/notion/exceptions/invalid_api_key.rb
+- lib/bas/read/notion/exceptions/invalid_database_id.rb
+- lib/bas/read/notion/helper.rb
+- lib/bas/read/notion/types/response.rb
+- lib/bas/read/notion/use_case/birthday_next_week.rb
+- lib/bas/read/notion/use_case/birthday_today.rb
+- lib/bas/read/notion/use_case/pto_next_week.rb
+- lib/bas/read/notion/use_case/pto_today.rb
+- lib/bas/read/notion/use_case/work_items_limit.rb
+- lib/bas/read/postgres/base.rb
+- lib/bas/read/postgres/helper.rb
+- lib/bas/read/postgres/types/response.rb
+- lib/bas/read/postgres/use_case/pto_today.rb
+- lib/bas/serialize/base.rb
+- lib/bas/serialize/github/issues.rb
+- lib/bas/serialize/imap/support_emails.rb
+- lib/bas/serialize/notion/birthday_today.rb
+- lib/bas/serialize/notion/pto_today.rb
+- lib/bas/serialize/notion/work_items_limit.rb
+- lib/bas/serialize/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
+- lib/bas/write/base.rb
+- lib/bas/write/logs/base.rb
+- lib/bas/write/logs/use_case/console_log.rb
 - renovate.json
 - sig/business_automation_system.rbs
 homepage: https://github.com/kommitters/bas

data/lib/bas/dispatcher/base.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "../domain/exceptions/function_not_implemented"
-
-module Dispatcher
-  ##
-  # Serves as a foundational structure for implementing specific dispatchers. Acting as an interface,
-  # this class defines essential attributes and methods, providing a blueprint for creating custom
-  # dispatchers tailored to different platforms or services.
-  #
-  class Base
-    attr_reader :webhook, :name
-
-    # Initializes the dispatcher with essential configuration parameters.
-    #
-    def initialize(config)
-      @webhook = config[:webhook]
-      @name = config[:name]
-    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>Discord::Response</tt>
-    #
-    def dispatch(_payload)
-      raise Domain::Exceptions::FunctionNotImplemented
-    end
-  end
-end

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

@@ -1,51 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "../base"
-require_relative "./exceptions/invalid_webhook_token"
-require_relative "./types/response"
-
-module Dispatcher
-  module Discord
-    ##
-    # This class is an implementation of the Dispatcher::Base interface, specifically designed
-    # for dispatching messages to Discord.
-    #
-    class Implementation < Base
-      # Implements the dispatching logic for the Discord use case. It sends a POST request to
-      # the Discord webhook with the specified payload.
-      #
-      # <br>
-      # <b>Params:</b>
-      # * <tt>String</tt> payload: Payload to be dispatched to discord.
-      # <br>
-      # <b>raises</b> <tt>Exceptions::Discord::InvalidWebookToken</tt> if the provided webhook token is invalid.
-      #
-      # <br>
-      # <b>returns</b> <tt>Dispatcher::Discord::Types::Response</tt>
-      #
-      def dispatch(payload)
-        body = {
-          username: name,
-          avatar_url: "",
-          content: payload
-        }.to_json
-        response = HTTParty.post(webhook, { body: body, headers: { "Content-Type" => "application/json" } })
-
-        discord_response = Dispatcher::Discord::Types::Response.new(response)
-
-        validate_response(discord_response)
-      end
-
-      private
-
-      def validate_response(response)
-        case response.code
-        when 50_027
-          raise Discord::Exceptions::InvalidWebookToken, response.message
-        else
-          response
-        end
-      end
-    end
-  end
-end

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

@@ -1,51 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "../base"
-require_relative "./exceptions/invalid_webhook_token"
-require_relative "./types/response"
-
-module Dispatcher
-  module Slack
-    ##
-    # This class is an implementation of the Dispatcher::Base interface, specifically designed
-    # for dispatching messages to Slack.
-    #
-    class Implementation < Base
-      # Implements the dispatching logic for the Slack use case. It sends a POST request to
-      # the Slack webhook with the specified payload.
-      #
-      # <br>
-      # <b>Params:</b>
-      # * <tt>String</tt> payload: Payload to be dispatched to slack.
-      # <br>
-      # <b>raises</b> <tt>Exceptions::Slack::InvalidWebookToken</tt> if the provided webhook token is invalid.
-      #
-      # <br>
-      # <b>returns</b> <tt>Dispatcher::Slack::Types::Response</tt>
-      #
-      def dispatch(payload)
-        body = {
-          username: name,
-          text: payload
-        }.to_json
-
-        response = HTTParty.post(webhook, { body: body, headers: { "Content-Type" => "application/json" } })
-
-        slack_response = Dispatcher::Discord::Types::Response.new(response)
-
-        validate_response(slack_response)
-      end
-
-      private
-
-      def validate_response(response)
-        case response.http_code
-        when 403
-          raise Dispatcher::Slack::Exceptions::InvalidWebookToken, response.message
-        else
-          response
-        end
-      end
-    end
-  end
-end

data/lib/bas/fetcher/imap/use_case/support_emails.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "../base"
-
-module Fetcher
-  module Imap
-    ##
-    # This class is an implementation of the Fetcher::Imap::Base interface, specifically designed
-    # for fetching support email from a Google Gmail account.
-    #
-    class SupportEmails < Imap::Base
-      TOKEN_URI = "https://oauth2.googleapis.com/token"
-      EMAIL_DOMAIN = "imap.gmail.com"
-      EMAIL_PORT = 993
-
-      # Implements the data fetching filter for support emails from Google Gmail.
-      #
-      def fetch
-        yesterday = (Time.now - (60 * 60 * 24)).strftime("%e-%b-%Y")
-        query = ["TO", config[:search_email], "SINCE", yesterday]
-
-        execute(EMAIL_DOMAIN, EMAIL_PORT, TOKEN_URI, query)
-      end
-    end
-  end
-end

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

@@ -1,70 +0,0 @@
-# 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 PtoToday
-      include Base
-
-      PTO_PARAMS = ["Person", "Desde?", "Hasta?"].freeze
-
-      # 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["Person"], 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)
-
-          pto_fields.each do |field, pto_value|
-            pto_fields[field] = extract_pto_value(field, pto_value)
-          end
-
-          pto_fields
-        end
-      end
-
-      def extract_pto_value(field, value)
-        case field
-        when "Person" then extract_person_field_value(value)
-        when "Desde?" then extract_date_field_value(value)
-        when "Hasta?" then 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
-    end
-  end
-end