bas 0.4.0 → 1.0.0

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
-      # its 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
-      # its 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: })
-
-        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 Read::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

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 its 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/notification.rb

@@ -1,28 +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 Notification data from Notion.
-    #
-    class Notification < Notion::Base
-      # Implements the reading filter for notification data from Notion.
-      #
-      def execute
-        filter = {
-          filter: {
-            property: "Use Case",
-            title: {
-              equals: config[:use_case_title]
-            }
-          }
-        }
-
-        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:, date: { on_or_after: after_day } },
-            { 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 Read::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 its 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