bas 0.1.0 → 0.3.0

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

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

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

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

@@ -0,0 +1,17 @@
+# 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/{fetcher → read}/imap/base.rb

@@ -6,25 +6,25 @@ require "gmail_xoauth"
 require_relative "../base"
 require_relative "./types/response"
 
-module Fetcher
+module Read
   module Imap
     ##
-    # This class is an implementation of the Fetcher::Base interface, specifically designed
-    # for fetching data from an IMAP server.
+    # This class is an implementation of the Read::Base interface, specifically designed
+    # for reading data from an IMAP server.
     #
-    class Base < Fetcher::Base
+    class Base < Read::Base
       protected
 
-      # Implements the data fetching logic for emails data from an IMAP server.
+      # 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 execute(email_domain, email_port, token_uri, query)
+      def read(email_domain, email_port, token_uri, query)
         access_token = refresh_token(token_uri)
 
         imap_fetch(email_domain, email_port, query, access_token)
 
-        Fetcher::Imap::Types::Response.new(@emails)
+        Read::Imap::Types::Response.new(@emails)
       end
 
       private

data/lib/bas/{fetcher → read}/imap/types/response.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Fetcher
+module Read
   module Imap
     module Types
       ##

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

@@ -0,0 +1,26 @@
+# 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/{fetcher → read}/notion/base.rb

@@ -8,18 +8,18 @@ require_relative "./exceptions/invalid_database_id"
 require_relative "./types/response"
 require_relative "./helper"
 
-module Fetcher
+module Read
   module Notion
     ##
-    # This class is an implementation of the Fetcher::Base interface, specifically designed
-    # for fetching data from Notion.
+    # This class is an implementation of the Read::Base interface, specifically designed
+    # for reading data from Notion.
     #
-    class Base < Fetcher::Base
+    class Base < Read::Base
       NOTION_BASE_URL = "https://api.notion.com"
 
       protected
 
-      # Implements the data fetching logic for data from Notion. It sends a POST
+      # 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>
@@ -28,14 +28,14 @@ module Fetcher
       # <b>raises</b> <tt>Exceptions::Notion::InvalidDatabaseId</tt> if the Database id provided is incorrect
       # or invalid.
       #
-      def execute(filter)
+      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 = Fetcher::Notion::Types::Response.new(httparty_response)
+        notion_response = Read::Notion::Types::Response.new(httparty_response)
 
-        Fetcher::Notion::Helper.validate_response(notion_response)
+        Read::Notion::Helper.validate_response(notion_response)
       end
 
       private

data/lib/bas/{fetcher → read}/notion/helper.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Fetcher
+module Read
   module Notion
     ##
     # Provides common fuctionalities along the Notion domain.

data/lib/bas/{fetcher → read}/notion/types/response.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Fetcher
+module Read
   module Notion
     module Types
       ##

data/lib/bas/{fetcher → read}/notion/use_case/birthday_next_week.rb

@@ -2,18 +2,18 @@
 
 require_relative "../base"
 
-module Fetcher
+module Read
   module Notion
     ##
-    # This class is an implementation of the Fetcher::Notion::Base interface, specifically designed
-    # for fetching next week birthdays data from Notion.
+    # This class is an implementation of the Read::Notion::Base interface, specifically designed
+    # for reading next week birthdays data from Notion.
     #
     class BirthdayNextWeek < Notion::Base
       DAYS_BEFORE_NOTIFY = 8
 
-      # Implements the data fetching filter for next week Birthdays data from Notion.
+      # Implements the data reading filter for next week Birthdays data from Notion.
       #
-      def fetch
+      def execute
         filter = {
           filter: {
             or: [
@@ -22,7 +22,7 @@ module Fetcher
           }
         }
 
-        execute(filter)
+        read(filter)
       end
 
       private

data/lib/bas/{fetcher → read}/notion/use_case/birthday_today.rb

@@ -2,16 +2,16 @@
 
 require_relative "../base"
 
-module Fetcher
+module Read
   module Notion
     ##
-    # This class is an implementation of the Fetcher::Notion::Base interface, specifically designed
-    # for fetching birthday data from Notion.
+    # This class is an implementation of the Read::Notion::Base interface, specifically designed
+    # for reading birthday data from Notion.
     #
     class BirthdayToday < Notion::Base
-      # Implements the data fetching filter for todays Birthdays data from Notion.
+      # Implements the reading filter for todays Birthdays data from Notion.
       #
-      def fetch
+      def execute
         today = Time.now.utc.strftime("%F").to_s
 
         filter = {
@@ -22,7 +22,7 @@ module Fetcher
           }
         }
 
-        execute(filter)
+        read(filter)
       end
     end
   end

data/lib/bas/{fetcher → read}/notion/use_case/pto_next_week.rb

@@ -2,19 +2,19 @@
 
 require_relative "../base"
 
-module Fetcher
+module Read
   module Notion
     ##
-    # This class is an implementation of the Fetcher::Notion::Base interface, specifically designed
-    # for fetching next week Paid Time Off (PTO) data from Notion.
+    # This class is an implementation of the Read::Notion::Base interface, specifically designed
+    # for reading next week Paid Time Off (PTO) data from Notion.
     #
     class PtoNextWeek < Notion::Base
-      # Implements the data fetching filter for next week PTO's data from Notion.
+      # Implements the reading filter for next week PTO's data from Notion.
       #
-      def fetch
+      def execute
         filter = build_filter
 
-        execute(filter)
+        read(filter)
       end
 
       private

data/lib/bas/{fetcher → read}/notion/use_case/pto_today.rb

@@ -2,16 +2,16 @@
 
 require_relative "../base"
 
-module Fetcher
+module Read
   module Notion
     ##
-    # This class is an implementation of the Fetcher::Notion::Base interface, specifically designed
-    # for fetching Paid Time Off (PTO) data from Notion.
+    # This class is an implementation of the Read::Notion::Base interface, specifically designed
+    # for reading Paid Time Off (PTO) data from Notion.
     #
     class PtoToday < Notion::Base
-      # Implements the data fetching filter for todays PTO's data from Notion.
+      # Implements the reading filter for todays PTO's data from Notion.
       #
-      def fetch
+      def execute
         today = Time.now.utc.strftime("%F").to_s
 
         filter = {
@@ -23,7 +23,7 @@ module Fetcher
           }
         }
 
-        execute(filter)
+        read(filter)
       end
     end
   end

data/lib/bas/{fetcher → read}/notion/use_case/work_items_limit.rb

@@ -2,16 +2,16 @@
 
 require_relative "../base"
 
-module Fetcher
+module Read
   module Notion
     ##
-    # This class is an implementation of the Fetcher::Notion::Base interface, specifically designed
+    # This class is an implementation of the Read::Notion::Base interface, specifically designed
     # for counting "in progress" work items from work item database in Notion.
     #
     class WorkItemsLimit < Notion::Base
-      # Implements the data fetching count of "in progress" work items from Notion.
+      # Implements the data reading count of "in progress" work items from Notion.
       #
-      def fetch
+      def execute
         filter = {
           filter: {
             "and": [
@@ -21,7 +21,7 @@ module Fetcher
           }
         }
 
-        execute(filter)
+        read(filter)
       end
 
       private

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

@@ -6,28 +6,28 @@ require_relative "../base"
 require_relative "./types/response"
 require_relative "./helper"
 
-module Fetcher
+module Read
   module Postgres
     ##
-    # This class is an implementation of the Fetcher::Base interface, specifically designed
-    # for fetching data from Postgres.
+    # This class is an implementation of the Read::Base interface, specifically designed
+    # for reading data from Postgres.
     #
-    class Base < Fetcher::Base
+    class Base < Read::Base
       protected
 
-      # Implements the data fetching logic from a Postgres database. It use the PG gem
+      # Implements the read logic from a Postgres database. It use the PG gem
       # to request data from a local or external database and returns a validated response.
       #
       # Gem: pg (https://rubygems.org/gems/pg)
       #
-      def execute(query)
+      def read(query)
         pg_connection = PG::Connection.new(config[:connection])
 
         pg_result = execute_query(pg_connection, query)
 
-        postgres_response = Fetcher::Postgres::Types::Response.new(pg_result)
+        postgres_response = Read::Postgres::Types::Response.new(pg_result)
 
-        Fetcher::Postgres::Helper.validate_response(postgres_response)
+        Read::Postgres::Helper.validate_response(postgres_response)
       end
 
       private

data/lib/bas/{fetcher → read}/postgres/helper.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Fetcher
+module Read
   module Postgres
     ##
     # Provides common fuctionalities along the Postgres domain.

data/lib/bas/{fetcher → read}/postgres/types/response.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module Fetcher
+module Read
   module Postgres
     module Types
       ##

data/lib/bas/{fetcher → read}/postgres/use_case/pto_today.rb

@@ -2,17 +2,17 @@
 
 require_relative "../base"
 
-module Fetcher
+module Read
   module Postgres
     ##
-    # This class is an implementation of the Fetcher::Postgres::Base interface, specifically designed
-    # for fetching Paid Time Off (PTO) data from a Postgres Database.
+    # This class is an implementation of the Read::Postgres::Base interface, specifically designed
+    # for reading Paid Time Off (PTO) data from a Postgres Database.
     #
     class PtoToday < Base
-      # Implements the data fetching query for todays PTO data from a Postgres database.
+      # Implements the data reading query for todays PTO data from a Postgres database.
       #
-      def fetch
-        execute(build_query)
+      def execute
+        read(build_query)
       end
 
       private

data/lib/bas/{mapper → serialize}/base.rb

@@ -2,28 +2,28 @@
 
 require_relative "../domain/exceptions/function_not_implemented"
 
-module Mapper
+module Serialize
   ##
-  # The Mapper::Base module serves as the foundation for implementing specific data shaping logic within the
-  # Mapper module. Defines essential methods, that provide a blueprint for organizing or shaping data in a manner
+  # 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 Fetcher::Base interface.
+    # 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>Fetcher::Notion::Types::Response</tt> response: Response produced by a fetcher.
+    # * <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> Mapped list of data, ready to be formatted.
+    # <b>returns</b> <tt>List<Domain::></tt> Serialize list of data, ready to be formatted.
     #
-    def map(_response)
+    def execute(_response)
       raise Domain::Exceptions::FunctionNotImplemented
     end
   end