bas 0.3.1 → 1.0.0

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: 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/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: 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

data/lib/bas/read/github/types/response.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-module Read
-  module Github
-    module Types
-      ##
-      # Represents a response received from the Octokit Github client. It encapsulates essential
-      # information about the response, providing a structured way to handle and analyze
-      # it's responses.
-      class Response
-        attr_reader :status_code, :message, :results
-
-        def initialize(response)
-          if response.empty?
-            @status_code = 404
-            @message = "no result were found"
-            @results = []
-          else
-            @status_code = 200
-            @message = "success"
-            @results = response
-          end
-        end
-      end
-    end
-  end
-end

data/lib/bas/read/github/use_case/repo_issues.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "../base"
-
-module Read
-  module Github
-    ##
-    # This class is an implementation of the Read::Github::Base interface, specifically designed
-    # for reading issues from a Github repository.
-    #
-    class RepoIssues < Github::Base
-      def execute
-        read("list_issues", config[:repo])
-      end
-    end
-  end
-end

data/lib/bas/read/imap/base.rb

@@ -1,70 +0,0 @@
-# frozen_string_literal: true
-
-require "net/imap"
-require "gmail_xoauth"
-
-require_relative "../base"
-require_relative "./types/response"
-
-module Read
-  module Imap
-    ##
-    # This class is an implementation of the Read::Base interface, specifically designed
-    # for reading data from an IMAP server.
-    #
-    class Base < Read::Base
-      protected
-
-      # Implements the reading logic for emails data from an IMAP server.
-      # It connects to an IMAP server inbox, request emails base on a filter,
-      # and returns a validated response.
-      #
-      def read(email_domain, email_port, token_uri, query)
-        access_token = refresh_token(token_uri)
-
-        imap_fetch(email_domain, email_port, query, access_token)
-
-        Read::Imap::Types::Response.new(@emails)
-      end
-
-      private
-
-      def imap_fetch(email_domain, email_port, query, access_token)
-        imap = Net::IMAP.new(email_domain, port: email_port, ssl: true)
-
-        imap.authenticate("XOAUTH2", config[:user], access_token)
-
-        imap.examine(config[:inbox])
-
-        @emails = fetch_emails(imap, query)
-
-        imap.logout
-        imap.disconnect
-      end
-
-      def fetch_emails(imap, query)
-        imap.search(query).map do |message_id|
-          imap.fetch(message_id, "ENVELOPE")[0].attr["ENVELOPE"]
-        end
-      end
-
-      def refresh_token(token_uri)
-        uri = URI.parse(token_uri)
-
-        response = Net::HTTP.post_form(uri, params)
-        token_data = JSON.parse(response.body)
-
-        token_data["access_token"]
-      end
-
-      def params
-        {
-          "grant_type" => "refresh_token",
-          "refresh_token" => config[:refresh_token],
-          "client_id" => config[:client_id],
-          "client_secret" => config[:client_secret]
-        }
-      end
-    end
-  end
-end

data/lib/bas/read/imap/types/response.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-module Read
-  module Imap
-    module Types
-      ##
-      # Represents a response received from the Imap client. It encapsulates essential
-      # information about the response, providing a structured way to handle and analyze
-      # it's responses.
-      class Response
-        attr_reader :status_code, :message, :results
-
-        def initialize(response)
-          if response.empty?
-            @status_code = 404
-            @message = "no result were found"
-            @results = []
-          else
-            @status_code = 200
-            @message = "success"
-            @results = response
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "../base"
-
-module Read
-  module Imap
-    ##
-    # This class is an implementation of the Read::Imap::Base interface, specifically designed
-    # for reading 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 reading filter for support emails from Google Gmail.
-      #
-      def execute
-        yesterday = (Time.now - (60 * 60 * 24)).strftime("%d-%b-%Y")
-        query = ["TO", config[:search_email], "SINCE", yesterday]
-
-        read(EMAIL_DOMAIN, EMAIL_PORT, TOKEN_URI, query)
-      end
-    end
-  end
-end

data/lib/bas/read/notion/base.rb

@@ -1,52 +0,0 @@
-# frozen_string_literal: true
-
-require "httparty"
-
-require_relative "../base"
-require_relative "./exceptions/invalid_api_key"
-require_relative "./exceptions/invalid_database_id"
-require_relative "./types/response"
-require_relative "./helper"
-
-module Read
-  module Notion
-    ##
-    # This class is an implementation of the Read::Base interface, specifically designed
-    # for reading data from Notion.
-    #
-    class Base < Read::Base
-      NOTION_BASE_URL = "https://api.notion.com"
-
-      protected
-
-      # Implements the read logic for data from Notion. It sends a POST
-      # request to the Notion API to query the specified database and returns a validated response.
-      #
-      # <br>
-      # <b>raises</b> <tt>Exceptions::Notion::InvalidApiKey</tt> if the API key provided is incorrect or invalid.
-      #
-      # <b>raises</b> <tt>Exceptions::Notion::InvalidDatabaseId</tt> if the Database id provided is incorrect
-      # or invalid.
-      #
-      def read(filter)
-        url = "#{NOTION_BASE_URL}/v1/databases/#{config[:database_id]}/query"
-
-        httparty_response = HTTParty.post(url, { body: filter.to_json, headers: headers })
-
-        notion_response = Read::Notion::Types::Response.new(httparty_response)
-
-        Read::Notion::Helper.validate_response(notion_response)
-      end
-
-      private
-
-      def headers
-        {
-          "Authorization" => "Bearer #{config[:secret]}",
-          "Content-Type" => "application/json",
-          "Notion-Version" => "2022-06-28"
-        }
-      end
-    end
-  end
-end

data/lib/bas/read/notion/exceptions/invalid_api_key.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module Exceptions
-  module Notion
-    ##
-    # Provides a domain-specific representation for errors that occurs when an invalid API key is provided
-    # for a Notion-related operation.
-    #
-    class InvalidApiKey < StandardError
-      def initialize(message = "The provided API token is invalid.")
-        super(message)
-      end
-    end
-  end
-end

data/lib/bas/read/notion/exceptions/invalid_database_id.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module Exceptions
-  module Notion
-    ##
-    # Provides a domain-specific representation for errors that occurs when an invalid database id is provided
-    # for a Notion-related operation.
-    #
-    class InvalidDatabaseId < StandardError
-      def initialize(message = "The provided id doesn't match any database.")
-        super(message)
-      end
-    end
-  end
-end

data/lib/bas/read/notion/helper.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module Read
-  module Notion
-    ##
-    # Provides common fuctionalities along the Notion domain.
-    #
-    module Helper
-      def self.validate_response(response)
-        case response.status_code
-        when 401
-          raise Exceptions::Notion::InvalidApiKey, response.message
-        when 404
-          raise Exceptions::Notion::InvalidDatabaseId, response.message
-        else
-          response
-        end
-      end
-    end
-  end
-end