bas 0.2.0 → 0.3.0

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

@@ -7,23 +7,23 @@ require "jwt"
 require_relative "../base"
 require_relative "./types/response"
 
-module Fetcher
+module Read
   module Github
     ##
-    # This class is an implementation of the Fetcher::Base interface, specifically designed
-    # for fetching data from a GitHub repository.
+    # This class is an implementation of the Read::Base interface, specifically designed
+    # for reading data from a GitHub repository.
     #
-    class Base < Fetcher::Base
+    class Base < Read::Base
       protected
 
-      # Implements the data fetching logic to get data from a Github repository.
+      # 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 execute(method, *filter)
+      def read(method, *filter)
         octokit_response = octokit.public_send(method, *filter)
 
-        Fetcher::Github::Types::Response.new(octokit_response)
+        Read::Github::Types::Response.new(octokit_response)
       end
 
       private

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

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

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

data/lib/bas/{mapper → serialize}/github/issues.rb

@@ -3,25 +3,25 @@
 require_relative "../../domain/issue"
 require_relative "../base"
 
-module Mapper
+module Serialize
   module Github
     ##
-    # This class implementats the methods of the Mapper::Base module, specifically designed for
-    # preparing or shaping Github issues data coming from a Fetcher::Base implementation.
+    # 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 fetcher response.
+      # Implements the logic for shaping the results from a reader response.
       #
       # <br>
       # <b>Params:</b>
-      # * <tt>Fetcher::Github::Types::Response</tt> github_response: Array of github issues data.
+      # * <tt>Read::Github::Types::Response</tt> github_response: Array of github issues data.
       #
       # <br>
-      # <b>return</b> <tt>List<Domain::Issue></tt> mapped github issues to be used by a
+      # <b>return</b> <tt>List<Domain::Issue></tt> serialized github issues to be used by a
       # Formatter::Base implementation.
       #
-      def map(github_response)
+      def execute(github_response)
         return [] if github_response.results.empty?
 
         normalized_github_data = normalize_response(github_response.results)

data/lib/bas/{mapper → serialize}/imap/support_emails.rb

@@ -3,25 +3,25 @@
 require_relative "../../domain/email"
 require_relative "../base"
 
-module Mapper
+module Serialize
   module Imap
     ##
-    # This class implementats the methods of the Mapper::Base module, specifically designed for
-    # preparing or shaping support emails data coming from a Fetcher::Base implementation.
+    # 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 fetcher response.
+      # Implements the logic for shaping the results from a reader response.
       #
       # <br>
       # <b>Params:</b>
-      # * <tt>Fetcher::Imap::Types::Response</tt> imap_response: Array of imap emails data.
+      # * <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, mapped support emails to be used by a
+      # <b>return</b> <tt>List<Domain::Email></tt> support_emails_list, serialized support emails to be used by a
       # Formatter::Base implementation.
       #
-      def map(imap_response)
+      def execute(imap_response)
         return [] if imap_response.results.empty?
 
         normalized_email_data = normalize_response(imap_response.results)

data/lib/bas/{mapper → serialize}/notion/birthday_today.rb

@@ -3,27 +3,27 @@
 require_relative "../../domain/birthday"
 require_relative "../base"
 
-module Mapper
+module Serialize
   module Notion
     ##
-    # This class implementats the methods of the Mapper::Base module, specifically designed for preparing or
-    # shaping birthdays data coming from a Fetcher::Base implementation.
+    # 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 fetcher response.
+      # Implements the logic for shaping the results from a reader response.
       #
       # <br>
       # <b>Params:</b>
-      # * <tt>Fetcher::Notion::Types::Response</tt> notion_response: Notion response object.
+      # * <tt>Read::Notion::Types::Response</tt> notion_response: Notion response object.
       #
       # <br>
-      # <b>return</b> <tt>List<Domain::Birthday></tt> birthdays_list, mapped birthdays to be used by a
+      # <b>return</b> <tt>List<Domain::Birthday></tt> birthdays_list, serialized birthdays to be used by a
       # Formatter::Base implementation.
       #
-      def map(notion_response)
+      def execute(notion_response)
         return [] if notion_response.results.empty?
 
         normalized_notion_data = normalize_response(notion_response.results)

data/lib/bas/{mapper → serialize}/notion/pto_today.rb

@@ -3,34 +3,34 @@
 require_relative "../../domain/pto"
 require_relative "../base"
 
-module Mapper
+module Serialize
   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.
+    # 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 = ["Person", "Desde?", "Hasta?"].freeze
+      PTO_PARAMS = ["Description", "Desde?", "Hasta?"].freeze
 
-      # Implements the logic for shaping the results from a fetcher response.
+      # Implements the logic for shaping the results from a reader response.
       #
       # <br>
       # <b>Params:</b>
-      # * <tt>Fetcher::Notion::Types::Response</tt> notion_response: Notion response object.
+      # * <tt>Read::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
+      # <b>returns</b> <tt>List<Domain::Pto></tt> ptos_list, serialized PTO's to be used by a Formatter::Base
       # implementation.
       #
-      def map(notion_response)
+      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["Person"], pto["Desde?"], pto["Hasta?"])
+          Domain::Pto.new(pto["Description"], pto["Desde?"], pto["Hasta?"])
         end
       end
 
@@ -43,15 +43,17 @@ module Mapper
           pto_fields = value["properties"].slice(*PTO_PARAMS)
 
           {
-            "Person" => extract_person_field_value(pto_fields["Person"]),
+            "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_person_field_value(data)
-        data["people"][0]["name"]
+      def extract_description_field_value(data)
+        names = data["title"].map { |name| name["plain_text"] }
+
+        names.join(" ")
       end
 
       def extract_date_field_value(date)