bas 1.4.2 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6956cdda4a4735a5eb0a3d4413d41a972ac8190bb8d7da920e298a71bbe41516
-  data.tar.gz: 27c071aa1a681fb0f657af8e21c46057e3eb11cb467b5dd715f28c2f691d6dda
+  metadata.gz: 7973ce35f2f21618cec7a06ad45604419d1ef3523a63d451f7e21ec5034fe766
+  data.tar.gz: b4245c4f9adda76ce60e1638e812dd8efee15afe2643bb85c63f22bf3e27f516
 SHA512:
-  metadata.gz: bb89f398a03c6c8bae97798d069772790f2bd80a3ef7db4956b86751c4ef5a2b04420184e76ed138685f45dee3b1a9cdb1994517ca585663d9998a40bcb07f83
-  data.tar.gz: 9a586528f93844ad4e68d34a938bb2cff62eec5cd58fd952d1b431c5641c7af9ba5933ed8803b7fda42086b258b167c3826d2b492546887155b47e563c080b1f
+  metadata.gz: e54fb58367965508444478928581d8822212def15cfe3b1d5b47ef75ef0a5126293d35295d8a54f43f828fb97a102f86c68d7a3eb057c66f82db435576be042e
+  data.tar.gz: 471ec1cff36b69d3e51468c0372a00b0fb1a1185977d82ab458a3afbfce6aeccd32bf4861dc93f67270f6c301aff1c6fea7c75aeacd933db10ce9e486b7b69b1

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+# 1.5.0 (03.10.2024)
+- [Add bots to fetch images from Discord](https://github.com/kommitters/bas/issues/103)
+
+# 1.4.3 (06.09.2024)
+- [Adjust website monitoring use case notifications](https://github.com/kommitters/bas/issues/99)
+
 # 1.4.2 (28.08.2024)
 - [Adjust digital ocean billing bots](https://github.com/kommitters/bas/issues/97)
 

data/lib/bas/bot/fetch_billing_from_digital_ocean.rb

@@ -81,9 +81,7 @@ module Bot
     end
 
     def last_billing
-      return read_response.data["billing"] unless read_response.data.nil?
-
-      { month_to_date_balance: 0 }
+      read_response.data.nil? ? nil : read_response.data["billing"]
     end
   end
 end

data/lib/bas/bot/fetch_images_from_discord.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require_relative "./base"
+require_relative "../read/default"
+require_relative "../utils/discord/request"
+require_relative "../write/postgres"
+
+module Bot
+  ##
+  # The Bot::FetchImagesFromDiscord class serves as a bot implementation to read images
+  # from a any thread of Discord channel.
+  #
+  # <br>
+  # <b>Example</b>
+  #
+  #   options = {
+  #     process_options: {
+  #       secret_token: "discord_bot_token"
+  #       discord_channel: "discord_channel_id"
+  #     },
+  #     write_options: {
+  #       connection: {
+  #         host: "localhost",
+  #         port: 5432,
+  #         dbname: "bas",
+  #         user: "postgres",
+  #         password: "postgres"
+  #       },
+  #       db_table: "review_images",
+  #       tag: "FetchImagesFromDiscord"
+  #     }
+  #   }
+  #
+  #   bot = Bot::FetchImagesFromDiscord.new(options)
+  #   bot.execute
+  #
+  class FetchImagesFromDiscord < Bot::Base
+    # read function to execute the Default Read component
+    #
+    def read
+      reader = Read::Default.new
+
+      reader.execute
+    end
+
+    # Process function to execute the Discord utility to fetch images from a discord channel threads
+    #
+    def process
+      response = Utils::Discord::Request.get_thread_messages(params)
+
+      if !response.nil?
+        { success: { results: response } }
+      else
+        { error: "response is empty" }
+      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 params
+      {
+        endpoint: "channels/#{process_options[:discord_channel]}/messages",
+        channel_id: process_options[:discord_channel],
+        secret_token: process_options[:secret_token],
+        method: "get",
+        body: {}
+      }
+    end
+  end
+end

data/lib/bas/bot/review_domain_availability.rb

@@ -90,12 +90,7 @@ module Bot
     end
 
     def notification(response)
-      data = {
-        domain: read_response.data["url"],
-        status_code: response.code
-      }
-
-      ":warning: Domain is down: #{data}"
+      ":warning: The Domain #{read_response.data["url"]} is down with an error code of #{response.code}"
     end
   end
 end

data/lib/bas/bot/review_media.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require "md_to_notion"
 require "json"
 
 require_relative "./base"
@@ -11,8 +10,8 @@ require_relative "../utils/openai/run_assistant"
 module Bot
   ##
   # The Bot::ReviewMedia 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.
+  # shared storage a images hash with a specific format and create single request
+  # on the shared storage to be processed one by one.
   #
   # <br>
   # <b>Example</b>
@@ -32,7 +31,7 @@ module Bot
   #     process_options: {
   #       secret: "openai_secret",
   #       assistant_id: "openai_assistant_id",
-  #       media_type: "paragraph"
+  #       media_type: "images"
   #     },
   #     write_options: {
   #       connection: {
@@ -72,7 +71,7 @@ module Bot
         return error_response(response)
       end
 
-      sucess_response(response)
+      success_response(response)
     end
 
     # write function to execute the PostgresDB write component
@@ -115,19 +114,22 @@ module Bot
       read_response.data["media"]
     end
 
-    def notion_format(response)
-      md_response = response.parsed_response["data"].first["content"].first["text"]["value"]
-
-      MdToNotion::Parser.markdown_to_notion_blocks(md_response).to_json
+    def success_response(response)
+      review = get_review(response)
+      { success: media_hash.merge({ review: }) }
     end
 
-    def sucess_response(response)
-      review = notion_format(response)
-      page_id = read_response.data["page_id"]
-      created_by = read_response.data["created_by"]
-      property = read_response.data["property"]
+    def get_review(response)
+      response.parsed_response["data"].first["content"].first["text"]["value"]
+    end
 
-      { success: { review:, page_id:, created_by:, property:, media_type: process_options[:media_type] } }
+    def media_hash
+      {
+        thread_id: read_response.data["thread_id"],
+        property: read_response.data["property"],
+        author: read_response.data["author"],
+        media_type: process_options[:media_type]
+      }
     end
 
     def error_response(response)

data/lib/bas/bot/{write_media_review_in_notion.rb → write_media_review_in_discord.rb}

@@ -4,14 +4,13 @@ require "json"
 
 require_relative "./base"
 require_relative "../read/postgres"
-require_relative "../utils/notion/request"
-require_relative "../utils/notion/update_db_state"
 require_relative "../write/postgres"
+require_relative "../utils/discord/request"
 
 module Bot
   ##
-  # The Bot::WriteMediaReviewInNotion class serves as a bot implementation to read from a postgres
-  # shared storage formated notion blocks and send them to a Notion page
+  # 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>
@@ -29,7 +28,7 @@ module Bot
   #       tag: "FormatMediaReview"
   #     },
   #     process_options: {
-  #       secret: "notion_secret"
+  #       secret_token: "discord_bot_token"
   #     },
   #     write_options: {
   #       connection: {
@@ -40,16 +39,14 @@ module Bot
   #         password: "postgres"
   #       },
   #       db_table: "review_media",
-  #       tag: "WriteMediaReviewInNotion"
+  #       tag: "WriteMediaReviewInDiscord"
   #     }
   #   }
   #
-  #   bot = Bot::WriteMediaReviewInNotion.new(options)
+  #   bot = Bot::WriteMediaReviewInDiscord.new(options)
   #   bot.execute
   #
-  class WriteMediaReviewInNotion < Bot::Base
-    READY_STATE = "ready"
-
+  class WriteMediaReviewInDiscord < Bot::Base
     # read function to execute the PostgresDB Read component
     #
     def read
@@ -58,17 +55,15 @@ module Bot
       reader.execute
     end
 
-    # process function to execute the Notion utility to send formated blocks to a page
+    # 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::Notion::Request.execute(params)
+      response = Utils::Discord::Request.write_media_text(params)
 
       if response.code == 200
-        update_state
-
-        { success: { page_id: read_response.data["page_id"], property: read_response.data["property"] } }
+        { success: { thread_id: read_response.data["thread_id"], property: read_response.data["property"] } }
       else
         { error: { message: response.parsed_response, status_code: response.code } }
       end
@@ -93,54 +88,27 @@ module Bot
 
     def params
       {
-        endpoint: "blocks/#{read_response.data["page_id"]}/children",
-        secret: process_options[:secret],
-        method: "patch",
+        endpoint: "channels/#{read_response.data["thread_id"]}/messages",
+        secret_token: process_options[:secret_token],
+        method: "post",
         body:
       }
     end
 
     def body
-      { children: [{ object: "block", type: "toggle", toggle: }] }
-    end
-
-    def toggle
-      {
-        rich_text: [{ type: "text", text: { content: toggle_title } }, mention],
-        children: toggle_childrens
-      }
-    end
-
-    def toggle_childrens
-      JSON.parse(read_response.data["review"])
+      { content: "#{toggle_title}\n\n#{read_response.data["review"]}\n\n#{mention_content}" }
     end
 
-    def mention
-      {
-        type: "mention",
-        mention: {
-          type: "user",
-          user: { id: read_response.data["created_by"] }
-        }
-      }
+    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/"
+      when "images" then "Image review results"
+      when "paragraph" then "Text review results"
       end
     end
-
-    def update_state
-      data = {
-        property: read_response.data["property"],
-        page_id: read_response.data["page_id"],
-        state: READY_STATE,
-        secret: process_options[:secret]
-      }
-
-      Utils::Notion::UpdateDbState.execute(data)
-    end
   end
 end

data/lib/bas/bot/write_media_review_requests.rb

@@ -23,8 +23,8 @@ module Bot
   #         user: "postgres",
   #         password: "postgres"
   #       },
-  #       db_table: "review_media",
-  #       tag: "FetchMediaFromNotion"
+  #       db_table: "review_images",
+  #       tag: "FetchMediaFromDiscord"
   #     },
   #     process_options: {
   #       connection: {
@@ -34,7 +34,7 @@ module Bot
   #         user: "postgres",
   #         password: "postgres"
   #       },
-  #       db_table: "review_media",
+  #       db_table: "review_images",
   #       tag: "ReviewMediaRequest"
   #     },
   #     write_options: {
@@ -45,7 +45,7 @@ module Bot
   #         user: "postgres",
   #         password: "postgres"
   #       },
-  #       db_table: "review_media",
+  #       db_table: "review_images",
   #       tag: "WriteMediaReviewRequests"
   #     }
   #   }
@@ -54,8 +54,6 @@ module Bot
   #   bot.execute
   #
   class WriteMediaReviewRequests < Bot::Base
-    IN_PROCESS_STATE = "in process"
-
     # read function to execute the PostgresDB Read component
     #
     def read
@@ -64,7 +62,7 @@ module Bot
       reader.execute
     end
 
-    # Process function to execute the Notion utility create single review requests
+    # Process function to execute the Discord utility create single review requests
     #
     def process
       return { success: { created: nil } } if unprocessable_response
@@ -100,20 +98,7 @@ module Bot
     def write_request(request)
       return { error: request } if request["media"].empty? || !request["error"].nil?
 
-      update_state(request)
-
       { success: request }
     end
-
-    def update_state(request)
-      data = {
-        property: request["property"],
-        page_id: request["page_id"],
-        state: IN_PROCESS_STATE,
-        secret: process_options[:secret]
-      }
-
-      Utils::Notion::UpdateDbState.execute(data)
-    end
   end
 end

data/lib/bas/utils/discord/request.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "json"
+require "uri"
+require "httparty"
+
+module Utils
+  module Discord
+    ##
+    # This module is a Discord utility for obtain all images of any threads of a
+    # Discord channel.
+    #
+    module Request
+      DISCORD_BASE_URL = "https://discord.com/api/v10"
+
+      # Implements the request process logic to Discord.
+      #
+      # <br>
+      # <b>Params:</b>
+      # * <tt>method</tt> HTTP request method: post, get, put, etc.
+      # * <tt>body</tt> Request body (Hash).
+      # * <tt>endpoint</tt> Notion resource endpoint.
+      # * <tt>secret_token</tt> Discord Bot Token.
+      #
+      # <br>
+      #
+      #
+
+      def self.get_discord_images(message)
+        images_urls = message.attachments.map(&:url)
+
+        {
+          "media" => images_urls,
+          "thread_id" => message.id,
+          "author" => message.author.username,
+          "timestamp" => message.timestamp.to_s,
+          "property" => "images"
+        }
+      end
+
+      def self.write_media_text(params)
+        url = URI.parse("#{DISCORD_BASE_URL}/#{params[:endpoint]}")
+        headers = headers(params[:secret_token])
+        HTTParty.send(params[:method], url, { body: params[:body].to_json, headers: })
+      end
+
+      def self.headers(secret_token)
+        {
+          "Authorization" => secret_token.to_s,
+          "Content-Type" => "application/json"
+        }
+      end
+    end
+  end
+end

data/lib/bas/version.rb

@@ -2,5 +2,5 @@
 
 module Bas
   # Gem version
-  VERSION = "1.4.2"
+  VERSION = "1.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bas
 version: !ruby/object:Gem::Version
-  version: 1.4.2
+  version: 1.5.0
 platform: ruby
 authors:
 - kommitters Open Source
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-29 00:00:00.000000000 Z
+date: 2024-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gmail_xoauth
@@ -196,6 +196,7 @@ files:
 - lib/bas/bot/fetch_domains_wip_limit_from_notion.rb
 - lib/bas/bot/fetch_emails_from_imap.rb
 - lib/bas/bot/fetch_github_issues.rb
+- lib/bas/bot/fetch_images_from_discord.rb
 - lib/bas/bot/fetch_media_from_notion.rb
 - lib/bas/bot/fetch_next_week_birthdays_from_notion.rb
 - lib/bas/bot/fetch_next_week_ptos_from_notion.rb
@@ -214,7 +215,7 @@ files:
 - lib/bas/bot/update_work_item.rb
 - lib/bas/bot/verify_issue_existance_in_notion.rb
 - lib/bas/bot/write_domain_review_requests.rb
-- lib/bas/bot/write_media_review_in_notion.rb
+- lib/bas/bot/write_media_review_in_discord.rb
 - lib/bas/bot/write_media_review_requests.rb
 - lib/bas/read/base.rb
 - lib/bas/read/default.rb
@@ -222,6 +223,7 @@ files:
 - lib/bas/read/types/response.rb
 - lib/bas/utils/digital_ocean/request.rb
 - lib/bas/utils/discord/integration.rb
+- lib/bas/utils/discord/request.rb
 - lib/bas/utils/exceptions/function_not_implemented.rb
 - lib/bas/utils/exceptions/invalid_process_response.rb
 - lib/bas/utils/github/octokit_client.rb
@@ -262,7 +264,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: BAS - Business automation system