bas 0.3.1 → 1.0.0

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

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module Read
-  module Notion
-    module Types
-      ##
-      # Represents a response received from the Notion API. 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["results"].nil?
-            @status_code = response["status"]
-            @message = response["message"]
-            @results = []
-          else
-            @status_code = 200
-            @message = "success"
-            @results = response["results"]
-          end
-        end
-      end
-    end
-  end
-end

data/lib/bas/read/notion/use_case/birthday_next_week.rb

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "../base"
-
-module Read
-  module 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 reading filter for next week Birthdays data from Notion.
-      #
-      def execute
-        filter = {
-          filter: {
-            or: [
-              { property: "BD_this_year", date: { equals: eight_days_from_now } }
-            ]
-          }
-        }
-
-        read(filter)
-      end
-
-      private
-
-      def eight_days_from_now
-        date = Time.now.utc + days_in_second(DAYS_BEFORE_NOTIFY)
-
-        date.utc.strftime("%F").to_s
-      end
-
-      def days_in_second(days)
-        days * 24 * 60 * 60
-      end
-    end
-  end
-end

data/lib/bas/read/notion/use_case/birthday_today.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "../base"
-
-module Read
-  module 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 reading filter for todays Birthdays data from Notion.
-      #
-      def execute
-        today = Time.now.utc.strftime("%F").to_s
-
-        filter = {
-          filter: {
-            or: [
-              { property: "BD_this_year", date: { equals: today } }
-            ]
-          }
-        }
-
-        read(filter)
-      end
-    end
-  end
-end

data/lib/bas/read/notion/use_case/pto_next_week.rb

@@ -1,71 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "../base"
-
-module Read
-  module 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 reading filter for next week PTO's data from Notion.
-      #
-      def execute
-        filter = build_filter
-
-        read(filter)
-      end
-
-      private
-
-      def next_week_dates
-        monday = next_week_monday
-        sunday = monday + 6
-
-        [monday, sunday]
-      end
-
-      def next_week_monday
-        today = Date.today
-        week_day = today.wday
-
-        days = week_day.zero? ? 1 : 8 - week_day
-
-        today + days
-      end
-
-      def build_filter
-        monday, sunday = next_week_dates
-
-        {
-          filter: {
-            or: [
-              belong_next_week("Desde?", monday, sunday),
-              belong_next_week("Hasta?", monday, sunday),
-              cover_next_week(monday, sunday)
-            ]
-          }
-        }
-      end
-
-      def belong_next_week(property, after_day, before_day)
-        {
-          and: [
-            { property: property, date: { on_or_after: after_day } },
-            { property: property, date: { on_or_before: before_day } }
-          ]
-        }
-      end
-
-      def cover_next_week(monday, sunday)
-        {
-          and: [
-            { property: "Hasta?", date: { on_or_after: sunday } },
-            { property: "Desde?", date: { on_or_before: monday } }
-          ]
-        }
-      end
-    end
-  end
-end

data/lib/bas/read/notion/use_case/pto_today.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "../base"
-
-module Read
-  module 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 reading filter for todays PTO's data from Notion.
-      #
-      def execute
-        today = Time.now.utc.strftime("%F").to_s
-
-        filter = {
-          filter: {
-            "and": [
-              { property: "Desde?", date: { on_or_before: today } },
-              { property: "Hasta?", date: { on_or_after: today } }
-            ]
-          }
-        }
-
-        read(filter)
-      end
-    end
-  end
-end

data/lib/bas/read/notion/use_case/work_items_limit.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "../base"
-
-module Read
-  module Notion
-    ##
-    # 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 reading count of "in progress" work items from Notion.
-      #
-      def execute
-        filter = {
-          filter: {
-            "and": [
-              { property: "OK", formula: { string: { contains: "✅" } } },
-              { "or": status_conditions }
-            ]
-          }
-        }
-
-        read(filter)
-      end
-
-      private
-
-      def status_conditions
-        [
-          { property: "Status", status: { equals: "In Progress" } },
-          { property: "Status", status: { equals: "On Hold" } }
-        ]
-      end
-    end
-  end
-end

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

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-require "pg"
-
-require_relative "../base"
-require_relative "./types/response"
-require_relative "./helper"
-
-module Read
-  module Postgres
-    ##
-    # This class is an implementation of the Read::Base interface, specifically designed
-    # for reading data from Postgres.
-    #
-    class Base < Read::Base
-      protected
-
-      # 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 read(query)
-        pg_connection = PG::Connection.new(config[:connection])
-
-        pg_result = execute_query(pg_connection, query)
-
-        postgres_response = Read::Postgres::Types::Response.new(pg_result)
-
-        Read::Postgres::Helper.validate_response(postgres_response)
-      end
-
-      private
-
-      def execute_query(pg_connection, query)
-        if query.is_a? String
-          pg_connection.exec(query)
-        else
-          sentence, params = query
-
-          pg_connection.exec_params(sentence, params)
-        end
-      end
-    end
-  end
-end

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

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-module Read
-  module Postgres
-    ##
-    # Provides common fuctionalities along the Postgres domain.
-    #
-    module Helper
-      def self.validate_response(response)
-        response.response.check_result
-
-        response
-      end
-    end
-  end
-end

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

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-module Read
-  module Postgres
-    module Types
-      ##
-      # Represents a response received from the Postgres API. It encapsulates essential information about the response,
-      # providing a structured way to handle and analyze it's responses.
-      class Response
-        attr_reader :status, :message, :response, :fields, :records
-
-        SUCCESS_STATUS = "PGRES_TUPLES_OK"
-
-        def initialize(response)
-          if response.res_status == SUCCESS_STATUS
-            success_response(response)
-          else
-            failure_response(response)
-          end
-        end
-
-        private
-
-        def success_response(response)
-          @status = response.res_status
-          @message = "success"
-          @response = response
-          @fields = response.fields
-          @records = response.values
-        end
-
-        def failure_response(response)
-          @status = response.res_status
-          @message = response.result_error_message
-          @response = response
-          @fields = nil
-          @records = nil
-        end
-      end
-    end
-  end
-end

data/lib/bas/read/postgres/use_case/pto_today.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "../base"
-
-module Read
-  module Postgres
-    ##
-    # 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 reading query for todays PTO data from a Postgres database.
-      #
-      def execute
-        read(build_query)
-      end
-
-      private
-
-      def build_query
-        today = Time.now.utc.strftime("%F").to_s
-
-        start_time = "#{today}T00:00:00"
-        end_time = "#{today}T23:59:59"
-
-        where = "(start_date <= $1 AND end_date >= $1) OR (start_date>= $2 AND end_date <= $3)"
-
-        ["SELECT * FROM pto WHERE #{where}", [today, start_time, end_time]]
-      end
-    end
-  end
-end

data/lib/bas/serialize/base.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "../domain/exceptions/function_not_implemented"
-
-module Serialize
-  ##
-  # 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 Read::Base interface.
-    # Must be overridden by subclasses, with specific logic based on the use case.
-    #
-    # <br>
-    # <b>Params:</b>
-    # * <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> Serialize list of data, ready to be formatted.
-    #
-    def execute(_response)
-      raise Domain::Exceptions::FunctionNotImplemented
-    end
-  end
-end

data/lib/bas/serialize/github/issues.rb

@@ -1,57 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "../../domain/issue"
-require_relative "../base"
-
-module Serialize
-  module Github
-    ##
-    # 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 reader response.
-      #
-      # <br>
-      # <b>Params:</b>
-      # * <tt>Read::Github::Types::Response</tt> github_response: Array of github issues data.
-      #
-      # <br>
-      # <b>return</b> <tt>List<Domain::Issue></tt> serialized github issues to be used by a
-      # Formatter::Base implementation.
-      #
-      def execute(github_response)
-        return [] if github_response.results.empty?
-
-        normalized_github_data = normalize_response(github_response.results)
-
-        normalized_github_data.map do |issue|
-          Domain::Issue.new(
-            issue["title"], issue["state"], issue["assignees"], issue["body"], issue["url"]
-          )
-        end
-      end
-
-      private
-
-      def normalize_response(results)
-        return [] if results.nil?
-
-        results.map do |value|
-          {
-            "title" => value[:title],
-            "state" => value[:state],
-            "assignees" => extract_assignees(value[:assignees]),
-            "body" => value[:body],
-            "url" => value[:url]
-          }
-        end
-      end
-
-      def extract_assignees(assignees)
-        assignees.map { |assignee| assignee[:login] }
-      end
-    end
-  end
-end

data/lib/bas/serialize/imap/support_emails.rb

@@ -1,56 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "../../domain/email"
-require_relative "../base"
-
-module Serialize
-  module Imap
-    ##
-    # 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 reader response.
-      #
-      # <br>
-      # <b>Params:</b>
-      # * <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, serialized support emails to be used by a
-      # Formatter::Base implementation.
-      #
-      def execute(imap_response)
-        return [] if imap_response.results.empty?
-
-        normalized_email_data = normalize_response(imap_response.results)
-
-        normalized_email_data.map do |email|
-          Domain::Email.new(email["subject"], email["sender"], email["date"])
-        end
-      end
-
-      private
-
-      def normalize_response(results)
-        return [] if results.nil?
-
-        results.map do |value|
-          {
-            "sender" => extract_sender(value),
-            "date" => value.date,
-            "subject" => value.subject
-          }
-        end
-      end
-
-      def extract_sender(value)
-        mailbox = value.sender[0]["mailbox"]
-        host = value.sender[0]["host"]
-
-        "#{mailbox}@#{host}"
-      end
-    end
-  end
-end

data/lib/bas/serialize/notion/birthday_today.rb

@@ -1,68 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "../../domain/birthday"
-require_relative "../base"
-
-module Serialize
-  module Notion
-    ##
-    # 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 reader response.
-      #
-      # <br>
-      # <b>Params:</b>
-      # * <tt>Read::Notion::Types::Response</tt> notion_response: Notion response object.
-      #
-      # <br>
-      # <b>return</b> <tt>List<Domain::Birthday></tt> birthdays_list, serialized birthdays to be used by a
-      # Formatter::Base implementation.
-      #
-      def execute(notion_response)
-        return [] if notion_response.results.empty?
-
-        normalized_notion_data = normalize_response(notion_response.results)
-
-        normalized_notion_data.map do |birthday|
-          Domain::Birthday.new(birthday["Complete Name"], birthday["BD_this_year"])
-        end
-      end
-
-      private
-
-      def normalize_response(results)
-        return [] if results.nil?
-
-        results.map do |value|
-          birthday_fields = value["properties"].slice(*BIRTHDAY_PARAMS)
-
-          birthday_fields.each do |field, birthday_value|
-            birthday_fields[field] = extract_birthday_value(field, birthday_value)
-          end
-
-          birthday_fields
-        end
-      end
-
-      def extract_birthday_value(field, value)
-        case field
-        when "Complete Name" then extract_rich_text_field_value(value)
-        when "BD_this_year" then extract_date_field_value(value)
-        end
-      end
-
-      def extract_rich_text_field_value(data)
-        data["rich_text"][0]["plain_text"]
-      end
-
-      def extract_date_field_value(data)
-        data["formula"]["date"]["start"]
-      end
-    end
-  end
-end

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

@@ -1,75 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "../../domain/pto"
-require_relative "../base"
-
-module Serialize
-  module Notion
-    ##
-    # 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 = ["Description", "Desde?", "Hasta?"].freeze
-
-      # Implements the logic for shaping the results from a reader response.
-      #
-      # <br>
-      # <b>Params:</b>
-      # * <tt>Read::Notion::Types::Response</tt> notion_response: Notion response object.
-      #
-      # <br>
-      # <b>returns</b> <tt>List<Domain::Pto></tt> ptos_list, serialized PTO's to be used by a Formatter::Base
-      # implementation.
-      #
-      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["Description"], 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)
-
-          {
-            "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_description_field_value(data)
-        names = data["title"].map { |name| name["plain_text"] }
-
-        names.join(" ")
-      end
-
-      def extract_date_field_value(date)
-        {
-          from: extract_start_date(date),
-          to: extract_end_date(date)
-        }
-      end
-
-      def extract_start_date(data)
-        data["date"]["start"]
-      end
-
-      def extract_end_date(data)
-        data["date"]["end"]
-      end
-    end
-  end
-end