bas 0.4.0 → 1.0.0

data/lib/bas/formatter/support_emails.rb

@@ -1,73 +0,0 @@
-# frozen_string_literal: true
-
-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 Process.
-  class SupportEmails < Base
-    DEFAULT_TIME_ZONE = "+00:00"
-
-    # Initializes the formatter with essential configuration parameters.
-    #
-    # <b>timezone</b> : expect an string with the time difference relative to the UTC. Example: "-05:00"
-    def initialize(config = {})
-      super(config)
-
-      @timezone = config[:timezone] || DEFAULT_TIME_ZONE
-      @frecuency = config[:frecuency]
-    end
-
-    # Implements the logic for building a formatted payload with the given template for support emails.
-    #
-    # <br>
-    # <b>Params:</b>
-    # * <tt>List<Domain::Email></tt> support_emails_list: list of support emails.
-    #
-    # <br>
-    # <b>raises</b> <tt>Formatter::Exceptions::InvalidData</tt> when invalid data is provided.
-    #
-    # <br>
-    # <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
-
-      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
-
-    def process_emails(emails)
-      emails.each { |email| email.date = at_timezone(email.date) }
-      emails.filter! { |email| email.date > time_window } unless @frecuency.nil?
-
-      format_timestamp(emails)
-    end
-
-    def format_timestamp(emails)
-      emails.each { |email| email.date = email.date.strftime("%F %r") }
-    end
-
-    def time_window
-      date_time = Time.now - (60 * 60 * @frecuency)
-
-      at_timezone(date_time)
-    end
-
-    def at_timezone(date)
-      Time.at(date, in: @timezone)
-    end
-  end
-end

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

@@ -1,16 +0,0 @@
-# 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

@@ -1,68 +0,0 @@
-# frozen_string_literal: true
-
-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 Process.
-  class WorkItemsLimit < Base
-    DEFAULT_DOMAIN_LIMIT = 6
-
-    # Initializes the formatter with essential configuration parameters.
-    #
-    # <b>limits</b> : expect a map with the wip limits by domain. Example: { "ops": 5 }
-    def initialize(config = {})
-      super(config)
-
-      @limits = config[:limits]
-    end
-
-    # Implements the logic for building a formatted payload with the given template for wip limits.
-    #
-    # <br>
-    # <b>Params:</b>
-    # * <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>Formatter::Types::Response</tt> formatter response: standard output for
-    # the formatted payload suitable for a Process.
-    #
-
-    def format(work_items_list)
-      raise Formatter::Exceptions::InvalidData unless work_items_list.all? do |work_item|
-        work_item.is_a?(Domain::WorkItemsLimit)
-      end
-
-      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
-
-    def format_message_by_case(template, work_items_limit)
-      total_items = work_items_limit.total
-      limit = domain_limit(work_items_limit.domain)
-
-      template + ", #{total_items} of #{limit}\n"
-    end
-
-    def exceeded_domains(work_items_list)
-      work_items_list.filter { |work_item| work_item.total > domain_limit(work_item.domain) }
-    end
-
-    def domain_limit(domain)
-      @limits[domain.to_sym] || DEFAULT_DOMAIN_LIMIT
-    end
-  end
-end

data/lib/bas/process/base.rb

@@ -1,39 +0,0 @@
-# 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/process/discord/exceptions/invalid_webhook_token.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-module Process
-  module Discord
-    module Exceptions
-      ##
-      # Domain specific representation  when an invalid Discord webhook token is provided to Discord.
-      #
-      class InvalidWebookToken < StandardError
-        def initialize(message = "The provided Webhook token is invalid.")
-          super(message)
-        end
-      end
-    end
-  end
-end

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

@@ -1,71 +0,0 @@
-# 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:, 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/process/discord/types/response.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-module Process
-  module Discord
-    module Types
-      ##
-      # Represents a response received from Discord. It encapsulates essential information about the response,
-      # providing a structured way to handle and analyze Discord server responses.
-      #
-      class Response
-        attr_reader :code, :http_code, :message, :response
-
-        def initialize(response)
-          @http_code = response.code
-          @code = response["code"]
-          @message = response.message
-          @response = response.response
-        end
-      end
-    end
-  end
-end

data/lib/bas/process/openai/base.rb

@@ -1,72 +0,0 @@
-# frozen_string_literal: true
-
-require "httparty"
-
-require_relative "../base"
-require_relative "./types/response"
-require_relative "./helper"
-
-module Process
-  module OpenAI
-    ##
-    # This class is an implementation of the Process::Base interface, specifically designed
-    # for requesting to the OpenAI API for chat completion.
-    #
-    class Base < Process::Base
-      OPENAI_BASE_URL = "https://api.openai.com"
-      DEFAULT_N_CHOICES = 1
-
-      # Initializes the process with essential configuration parameters.
-      #
-      def initialize(config = {})
-        super(config)
-
-        @n_choices = config[:n_choices] || DEFAULT_N_CHOICES
-      end
-
-      protected
-
-      # Implements the sending process logic for the OpenAI API. It sends a
-      # POST request to the OpenAI API for chat completion with the specified payload.
-      #
-      # <br>
-      # <b>Params:</b>
-      # * <tt>Formatter::Types::Response</tt> formatter response: standard formatter response
-      # with the data to be send to OpenAI.
-      # <br>
-      # <b>raises</b> <tt>StandardError</tt> if the API returns an error response
-      #
-      # <br>
-      # <b>returns</b> <tt>Process::Types::Response</tt>
-      #
-      def process(messages)
-        url = "#{OPENAI_BASE_URL}/v1/chat/completions"
-
-        httparty_response = HTTParty.post(url, { body: body(messages).to_json, headers: })
-
-        openai_response = Process::OpenAI::Types::Response.new(httparty_response)
-
-        response = Process::OpenAI::Helper.validate_response(openai_response)
-
-        Process::Types::Response.new(response)
-      end
-
-      private
-
-      def body(messages)
-        {
-          "model": config[:model],
-          "n": @n_choices,
-          "messages": messages
-        }
-      end
-
-      def headers
-        {
-          "Authorization" => "Bearer #{config[:secret]}",
-          "Content-Type" => "application/json"
-        }
-      end
-    end
-  end
-end

data/lib/bas/process/openai/helper.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module Process
-  module OpenAI
-    ##
-    # Provides common fuctionalities along the Process::OpenAI domain.
-    #
-    module Helper
-      def self.validate_response(response)
-        case response.status_code
-        when 200
-          response
-        else
-          raise StandardError, response.message
-        end
-      end
-    end
-  end
-end

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

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-module Process
-  module OpenAI
-    module Types
-      ##
-      # Represents a response received from the OpenAI chat completion service API. It encapsulates
-      # essential information about the response, providing a structured way to handle and analyze
-      # its responses.
-      class Response
-        attr_reader :status_code, :message, :choices
-
-        def initialize(response)
-          if response["error"]
-            @status_code = response.code
-            @message = response["error"]
-            @choices = []
-          else
-            @status_code = 200
-            @message = "success"
-            @choices = response["choices"]
-          end
-        end
-      end
-    end
-  end
-end

data/lib/bas/process/openai/use_case/humanize_pto.rb

@@ -1,53 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "../base"
-
-module Process
-  module OpenAI
-    ##
-    # This class is an implementation of the Process::OpenAI::Base interface, specifically designed
-    # to humanize formatted PTO messages for better understanding.
-    #
-    class HumanizePto < OpenAI::Base
-      # Implements the data process to humanize formatted PTO messages.
-      #
-      def execute(format_response)
-        messages = [
-          {
-            "role": "user",
-            "content": content(format_response.data)
-          }
-        ]
-
-        process(messages)
-      end
-
-      private
-
-      def content(data)
-        <<~MESSAGE
-          The following message is too complex for a human to read since it has specific dates formatted as YYYY-MM-DD:
-
-          \"#{data}\"
-
-          Create a text that gives the same message in a more human-readable and context-valuable fashion for a human.
-          Use the current date (#{current_date}) to provide context.
-          Try grouping information and using bullet points to make it easier to read the information at a quick glance.
-          Additionally, keep in mind that we work from Monday to Friday - not weekends.
-          Please, just give the PTOs message and avoid the intro message such as \"Here is a reader-friendly message\".
-          Add emojis for a cool message, but keep it seriously.
-
-          For example:
-          The input "Jane Doe is on PTO from 2024-04-08 to 2024-04-26", means that Jane will be on PTO starting at 2024-04-08
-          and ending at 2024-04-26, i.e, she will be back the next work-day which is 2024-04-29.
-        MESSAGE
-      end
-
-      def current_date
-        utc_today = Time.now.utc
-
-        Time.at(utc_today, in: config[:timezone]).strftime("%A, %F").to_s
-      end
-    end
-  end
-end

data/lib/bas/process/slack/exceptions/invalid_webhook_token.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-module Process
-  module Slack
-    module Exceptions
-      ##
-      # Domain specific representation when an invalid webhook token is provided to Slack.
-      #
-      class InvalidWebookToken < StandardError
-        def initialize(message = "The provided Webhook token is invalid.")
-          super(message)
-        end
-      end
-    end
-  end
-end

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

@@ -1,70 +0,0 @@
-# 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:, 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/process/slack/types/response.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module Process
-  module Slack
-    module Types
-      ##
-      # Represents a response received from Slack. It encapsulates essential information about the response,
-      # providing a structured way to handle and analyze Slack server responses.
-      #
-      class Response
-        attr_reader :body, :http_code, :message
-
-        def initialize(response)
-          @http_code = response.code
-          @message = response.message
-          @body = response.body
-        end
-      end
-    end
-  end
-end

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

@@ -1,16 +0,0 @@
-# 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/read/github/base.rb

@@ -1,57 +0,0 @@
-# frozen_string_literal: true
-
-require "octokit"
-require "openssl"
-require "jwt"
-
-require_relative "../base"
-require_relative "./types/response"
-
-module Read
-  module Github
-    ##
-    # This class is an implementation of the Read::Base interface, specifically designed
-    # for reading data from a GitHub repository.
-    #
-    class Base < Read::Base
-      protected
-
-      # Implements the data reading logic to get data from a Github repository.
-      # It connects to Github using the octokit gem, authenticates with a github app,
-      # request the data and returns a validated response.
-      #
-      def read(method, *filter)
-        octokit_response = octokit.public_send(method, *filter)
-
-        Read::Github::Types::Response.new(octokit_response)
-      end
-
-      private
-
-      def octokit
-        Octokit::Client.new(bearer_token: access_token)
-      end
-
-      def access_token
-        app = Octokit::Client.new(client_id: config[:app_id], bearer_token: jwt)
-
-        app.create_app_installation_access_token(config[:installation_id])[:token]
-      end
-
-      def jwt
-        private_pem = File.read(config[:secret_path])
-        private_key = OpenSSL::PKey::RSA.new(private_pem)
-
-        JWT.encode(jwt_payload, private_key, "RS256")
-      end
-
-      def jwt_payload
-        {
-          iat: Time.now.to_i - 60,
-          exp: Time.now.to_i + (10 * 60),
-          iss: config[:app_id]
-        }
-      end
-    end
-  end
-end