bas 1.5.2 → 1.6.0

data/lib/bas/bot/write_media_review_in_discord.rb

@@ -1,114 +0,0 @@
-# frozen_string_literal: true
-
-require "json"
-
-require_relative "./base"
-require_relative "../read/postgres"
-require_relative "../write/postgres"
-require_relative "../utils/discord/request"
-
-module Bot
-  ##
-  # The Bot::WriteMediaReviewInDiscord class serves as a bot implementation to read from a postgres
-  # shared storage images object blocks and send them to a thread of Discord channel
-  #
-  # <br>
-  # <b>Example</b>
-  #
-  #   options = {
-  #     read_options: {
-  #       connection: {
-  #         host: "localhost",
-  #         port: 5432,
-  #         dbname: "bas",
-  #         user: "postgres",
-  #         password: "postgres"
-  #       },
-  #       db_table: "review_media",
-  #       tag: "FormatMediaReview"
-  #     },
-  #     process_options: {
-  #       secret_token: "discord_bot_token"
-  #     },
-  #     write_options: {
-  #       connection: {
-  #         host: "localhost",
-  #         port: 5432,
-  #         dbname: "bas",
-  #         user: "postgres",
-  #         password: "postgres"
-  #       },
-  #       db_table: "review_media",
-  #       tag: "WriteMediaReviewInDiscord"
-  #     }
-  #   }
-  #
-  #   bot = Bot::WriteMediaReviewInDiscord.new(options)
-  #   bot.execute
-  #
-  class WriteMediaReviewInDiscord < Bot::Base
-    # read function to execute the PostgresDB Read component
-    #
-    def read
-      reader = Read::Postgres.new(read_options.merge(conditions))
-
-      reader.execute
-    end
-
-    # process function to execute the Discord utility to send image feedback to a thread of a Discord channel
-    #
-    def process
-      return { success: { review_added: nil } } if unprocessable_response
-
-      response = Utils::Discord::Request.write_media_text(params)
-
-      if response.code == 200
-        { success: { message_id: read_response.data["message_id"], property: read_response.data["property"] } }
-      else
-        { error: { message: response.parsed_response, status_code: response.code } }
-      end
-    end
-
-    # write function to execute the PostgresDB write component
-    #
-    def write
-      write = Write::Postgres.new(write_options, process_response)
-
-      write.execute
-    end
-
-    private
-
-    def conditions
-      {
-        where: "archived=$1 AND tag=$2 AND stage=$3 ORDER BY inserted_at ASC",
-        params: [false, read_options[:tag], "unprocessed"]
-      }
-    end
-
-    def params
-      {
-        body:,
-        secret_token: process_options[:secret_token],
-        message_id: read_response.data["message_id"],
-        channel_id: read_response.data["channel_id"]
-      }
-    end
-
-    def body
-      { content: "#{toggle_title}\n\n#{read_response.data["review"]}\n\n#{mention_content}" }
-    end
-
-    def mention_content
-      author_name = read_response.data["author"]
-      "<@#{author_name}>"
-    end
-
-    def toggle_title
-      case read_response.data["media_type"]
-      when "images" then "Image review results"
-      when "paragraph" then "Text review results"
-      end
-    end
-  end
-end

data/lib/bas/bot/write_media_review_requests.rb

@@ -1,104 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "./base"
-require_relative "../read/postgres"
-require_relative "../utils/notion/update_db_state"
-require_relative "../write/postgres"
-
-module Bot
-  ##
-  # The Bot::WriteMediaReviewRequests class serves as a bot implementation to read from a postgres
-  # shared storage a set of review media requests and create single request on the shared storage to
-  # be processed one by one.
-  #
-  # <br>
-  # <b>Example</b>
-  #
-  #   options = {
-  #     read_options: {
-  #       connection: {
-  #         host: "localhost",
-  #         port: 5432,
-  #         dbname: "bas",
-  #         user: "postgres",
-  #         password: "postgres"
-  #       },
-  #       db_table: "review_images",
-  #       tag: "FetchMediaFromDiscord"
-  #     },
-  #     process_options: {
-  #       connection: {
-  #         host: "localhost",
-  #         port: 5432,
-  #         dbname: "bas",
-  #         user: "postgres",
-  #         password: "postgres"
-  #       },
-  #       db_table: "review_images",
-  #       tag: "ReviewMediaRequest"
-  #     },
-  #     write_options: {
-  #       connection: {
-  #         host: "localhost",
-  #         port: 5432,
-  #         dbname: "bas",
-  #         user: "postgres",
-  #         password: "postgres"
-  #       },
-  #       db_table: "review_images",
-  #       tag: "WriteMediaReviewRequests"
-  #     }
-  #   }
-  #
-  #   bot = Bot::WriteMediaReviewRequests.new(options)
-  #   bot.execute
-  #
-  class WriteMediaReviewRequests < Bot::Base
-    # read function to execute the PostgresDB Read component
-    #
-    def read
-      reader = Read::Postgres.new(read_options.merge(conditions))
-
-      reader.execute
-    end
-
-    # Process function to execute the Discord utility create single review requests
-    #
-    def process
-      return { success: { created: nil } } if unprocessable_response
-
-      read_response.data["results"].each { |request| create_request(request) }
-
-      { success: { created: true } }
-    end
-
-    # Write function to execute the PostgresDB write component
-    #
-    def write
-      write = Write::Postgres.new(write_options, process_response)
-
-      write.execute
-    end
-
-    private
-
-    def conditions
-      {
-        where: "archived=$1 AND tag=$2 AND stage=$3 ORDER BY inserted_at ASC",
-        params: [false, read_options[:tag], "unprocessed"]
-      }
-    end
-
-    def create_request(request)
-      write_data = write_request(request)
-
-      Write::Postgres.new(process_options, write_data).execute
-    end
-
-    def write_request(request)
-      return { error: request } if request["media"].empty? || !request["error"].nil?
-
-      { success: request }
-    end
-  end
-end

data/lib/bas/read/base.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "../utils/exceptions/function_not_implemented"
-
-module Read
-  ##
-  # The Read::Base class serves as the foundation for implementing specific data read components within
-  # the Read module. Operating as an interface, this class defines essential attributes and methods,
-  # providing a blueprint for creating custom read components tailored to different data sources.
-  #
-  class Base
-    attr_reader :config
-
-    # Initializes the read with essential configuration parameters.
-    #
-    def initialize(config = {})
-      @config = config
-    end
-
-    # A method meant to execute the read request from an specific <b>common storage</b>.
-    # Must be overridden by subclasses, with specific logic based on the storage source.
-    #
-    # <br>
-    # <b>raises</b> <tt>Utils::Exceptions::FunctionNotImplemented</tt> when missing implementation.
-    #
-    def execute
-      raise Utils::Exceptions::FunctionNotImplemented
-    end
-  end
-end

data/lib/bas/read/default.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "./base"
-require_relative "./types/response"
-
-module Read
-  ##
-  # This class is an implementation of the Read::Base interface, specifically designed
-  # for bots who don't read from a <b>common storage</b>".
-  #
-  class Default < Read::Base
-    def execute
-      Read::Types::Response.new
-    end
-  end
-end

data/lib/bas/read/postgres.rb

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-require "json"
-
-require_relative "./base"
-require_relative "../utils/postgres/request"
-require_relative "./types/response"
-
-module Read
-  ##
-  # This class is an implementation of the Read::Base interface, specifically designed
-  # to read from a PostgresDB used as <b>common storage</b>.
-  #
-  class Postgres < Read::Base
-    # Execute the Postgres utility to read data from the <b>common storage</b>
-    #
-    def execute
-      response = Utils::Postgres::Request.execute(params)
-
-      unless response.values == []
-        id = response.values.first[0]
-        data = JSON.parse(response.values.first[1])
-        inserted_at = response.values.first[2]
-      end
-
-      Read::Types::Response.new(id, data, inserted_at)
-    end
-
-    private
-
-    def params
-      {
-        connection: config[:connection],
-        query: build_query
-      }
-    end
-
-    def build_query
-      query = "SELECT id, data, inserted_at FROM #{config[:db_table]} WHERE status='success' AND #{config[:where]}"
-
-      [query, config[:params]]
-    end
-  end
-end

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

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-module Read
-  module Types
-    ##
-    # Represents a response from a read component. It encapsulates the requested data
-    # from the <b>common storage</b> to be processed by a Bot.
-    class Response
-      attr_reader :id, :data, :inserted_at
-
-      def initialize(id = nil, response = {}, inserted_at = nil)
-        @id = id
-        @data = response
-        @inserted_at = inserted_at
-      end
-    end
-  end
-end

data/lib/bas/write/base.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "../utils/exceptions/function_not_implemented"
-
-module Write
-  ##
-  # The Write::Base class serves as the foundation for implementing specific data write components within
-  # the Write module. Operating as an interface, this class defines essential attributes and methods,
-  # providing a blueprint for creating custom write components tailored to different data storages.
-  #
-  class Base
-    attr_reader :config, :process_response
-
-    # Initializes the write with essential configuration parameters.
-    #
-    def initialize(config, process_response = nil)
-      @config = config
-      @process_response = process_response
-    end
-
-    # A method meant to execute the write request to an specific <b>common storage</b>.
-    # Must be overridden by subclasses, with specific logic based on the storage destination.
-    #
-    # <br>
-    # <b>raises</b> <tt>Utils::Exceptions::FunctionNotImplemented</tt> when missing implementation.
-    #
-    def execute
-      raise Utils::Exceptions::FunctionNotImplemented
-    end
-  end
-end

data/lib/bas/write/postgres.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "./base"
-require_relative "../version"
-require_relative "../utils/postgres/request"
-
-module Write
-  ##
-  # This class is an implementation of the Write::Base interface, specifically designed
-  # to wtite to a PostgresDB used as <b>common storage</b>.
-  #
-  class Postgres < Write::Base
-    PTO_PARAMS = "data, tag, archived, stage, status, error_message, version"
-
-    # Execute the Postgres utility to write data in the <b>common storage</b>
-    #
-    def execute
-      Utils::Postgres::Request.execute(params)
-    end
-
-    private
-
-    def params
-      {
-        connection: config[:connection],
-        query: build_query
-      }
-    end
-
-    def build_query
-      query = "INSERT INTO #{config[:db_table]} (#{PTO_PARAMS}) VALUES ($1, $2, $3, $4, $5, $6, $7);"
-      params = build_params
-
-      [query, params]
-    end
-
-    def build_params
-      if process_response[:success]
-        [process_response[:success].to_json, config[:tag], false, "unprocessed", "success", nil, Bas::VERSION]
-      else
-        [nil, config[:tag], false, "unprocessed", "failed", process_response[:error].to_json, Bas::VERSION]
-      end
-    end
-  end
-end

data/lib/bas/write/postgres_update.rb

@@ -1,49 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "./base"
-require_relative "../version"
-require_relative "../utils/postgres/request"
-
-module Write
-  ##
-  # This class is an implementation of the Write::Base interface, specifically designed
-  # to update to a PostgresDB used as <b>common storage</b>.
-  #
-  class PostgresUpdate < Write::Base
-    PTO_PARAMS = "data, tag, archived, stage, status, version"
-
-    # Execute the Postgres utility to update data in the <b>common storage</b>
-    #
-    def execute
-      Utils::Postgres::Request.execute(params)
-    end
-
-    private
-
-    def params
-      {
-        connection: config[:connection],
-        query: build_query
-      }
-    end
-
-    def build_query
-      params, values = build_params
-      query = "UPDATE #{config[:db_table]} SET #{params} WHERE #{config[:conditions]}"
-
-      [query, values]
-    end
-
-    def build_params
-      params = ""
-      values = []
-
-      config[:params].each_with_index do |(param, value), idx|
-        params += "#{param}=$#{idx + 1}"
-        values << value
-      end
-
-      [params, values]
-    end
-  end
-end