bas 1.1.3 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa7391a648acbe2845e4d72a2afea0cad5d844b7b6d667739ecf7efee409860c
-  data.tar.gz: 9c5f2714bd2a16f0dc396dd7e7d10afc59c4bfaf112d8e5e881a37786ba4cb1e
+  metadata.gz: 3574c150bdecb2fd88551db1b4add9bd5d0458d6b44eec87bd2c3efd44ff8a83
+  data.tar.gz: ffeac8bae610aec6449161f9c267385e84921141d953f98175a05c6186f2e641
 SHA512:
-  metadata.gz: 38d4edb9608e7f4b65bca1573c78407499fc5662efcdbbd2b165e5208e51377a3851f665e3bd6920a060a0a643b9d2ffa8f3cf3139a513b3ecaee49f69bd1ebc
-  data.tar.gz: 4755d87c9ed9622e9f299dac6c70d4fcffef6ff79cac094a41ba936d4d935a50b8008c9fd19fd02baf4ce75f19126a3d52e44b69a4580eefa22cb77047ab4cc3
+  metadata.gz: 8588edfeb8aec0ec204a040e79bd801d1563bf45b94b7ccd50c89ed160a2a2334f4285cd54d5c001228a9de5d14d02a64800c36b10b54f31d01ed1c877c0ae34
+  data.tar.gz: 921b8280f7c071a8aaa7752b99b0fffabb0e1e434f6b051433a44d49f2c137e5092889250f7301e41b678ca763e9f445237a4252bb22a0731920f4731536006e

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+# 1.2.1 (16.07.2024)
+- [Update format message for the digital ocean alert bots use case](https://github.com/kommitters/bas/pull/84)
+
+# 1.2.0 (12.07.2024)
+- [Add bots to process digital ocean billing checker](https://github.com/kommitters/bas/issues/78)
+
 # 1.1.3 (08.07.2024)
 - [Update write media request to set in process](https://github.com/kommitters/bas/issues/76)
 

data/Gemfile

@@ -29,4 +29,7 @@ gem "pg", "~> 1.5", ">= 1.5.4"
 
 gem "gmail_xoauth"
 
+gem "google-api-client"
+gem "googleauth"
+
 gem "md_to_notion", "~> 0.1.4"

data/lib/bas/bot/fetch_billing_from_digital_ocean.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require_relative "./base"
+require_relative "../read/default"
+require_relative "../utils/digital_ocean/request"
+require_relative "../write/postgres"
+
+module Bot
+  ##
+  # The Bot::FetchBillingFromDigitalOcean class serves as a bot implementation to read digital
+  # ocean current billing using the DigitalOcean API
+  #
+  # <br>
+  # <b>Example</b>
+  #
+  #   options = {
+  #     process_options: {
+  #       secret: "digital_ocean_secret_key"
+  #     },
+  #     write_options: {
+  #       connection: {
+  #         host: "host",
+  #         port: 5432,
+  #         dbname: "bas",
+  #         user: "postgres",
+  #         password: "postgres"
+  #       },
+  #       db_table: "use_cases",
+  #       tag: "FetchBillingFromDigitalOcean"
+  #     }
+  #   }
+  #
+  #   bot = Bot::FetchBillingFromDigitalOcean.new(options)
+  #   bot.execute
+  #
+  class FetchBillingFromDigitalOcean < Bot::Base
+    # Read function to execute the default Read component
+    #
+    def read
+      reader = Read::Default.new
+
+      reader.execute
+    end
+
+    # Process function to execute the DigitalOcean utility to fetch bills
+    #
+    def process
+      response = Utils::DigitalOcean::Request.execute(params)
+
+      if response.code == 200
+
+        { success: { billing: response.parsed_response } }
+      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 params
+      {
+        endpoint: "customers/my/balance",
+        secret: process_options[:secret],
+        method: "get",
+        body: {}
+      }
+    end
+  end
+end

data/lib/bas/bot/format_do_bill_alert.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+require_relative "./base"
+require_relative "../read/postgres"
+require_relative "../write/postgres"
+
+module Bot
+  ##
+  # The Bot::FormatDoBillAlert class serves as a bot implementation to format DigitalOcean bill
+  # alerts from a PostgresDB database, format them with a specific template, and write them on a
+  # PostgresDB table with a specific format.
+  #
+  # <br>
+  # <b>Example</b>
+  #
+  #   options = {
+  #     read_options: {
+  #       connection: {
+  #         host: "localhost",
+  #         port: 5432,
+  #         dbname: "bas",
+  #         user: "postgres",
+  #         password: "postgres"
+  #       },
+  #       db_table: "do_billing",
+  #       tag: "FetchBillingFromDigitalOcean"
+  #     },
+  #     process_options: {
+  #       threshold: 7
+  #     },
+  #     write_options: {
+  #       connection: {
+  #         host: "localhost",
+  #         port: 5432,
+  #         dbname: "bas",
+  #         user: "postgres",
+  #         password: "postgres"
+  #       },
+  #       db_table: "do_billing",
+  #       tag: "FormatDoBillAlert"
+  #     }
+  #   }
+  #
+  #   bot = Bot::FormatDoBillAlert.new(options)
+  #   bot.execute
+  #
+  class FormatDoBillAlert < 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 format the notification using a template
+    #
+    def process
+      return { success: { notification: "" } } if unprocessable_response || !threshold_exceeded
+
+      { success: { notification: message } }
+    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 threshold_exceeded
+      daily_usage > process_options[:threshold]
+    end
+
+    def daily_usage
+      balance = read_response.data["billing"]["month_to_date_balance"].to_f
+      day_of_month = Time.now.utc.mday
+
+      balance / day_of_month
+    end
+
+    def message
+      balance = read_response.data["billing"]["month_to_date_balance"]
+      threshold = process_options[:threshold]
+
+      """:warning: The **DigitalOcean** daily usage was exceeded.
+      Current balance: #{balance}
+      Threshold: #{threshold}
+      Current daily usage: #{daily_usage.round(3)}
+      """
+    end
+  end
+end

data/lib/bas/bot/notify_do_bill_alert_email.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require_relative "./base"
+require_relative "../read/postgres"
+require_relative "../write/postgres"
+require_relative "../utils/google/send_email"
+
+module Bot
+  ##
+  # The Bot::NotifyDoBillAlertEmail class serves as a bot implementation to send digital
+  # ocean daily bill exceeded alert emails to a recipient using a google account
+  #
+  # <br>
+  # <b>Example</b>
+  #
+  #   options = {
+  #     read_options: {
+  #       connection: {
+  #         host: "localhost",
+  #         port: 5432,
+  #         dbname: "bas",
+  #         user: "postgres",
+  #         password: "postgres"
+  #       },
+  #       db_table: "do_billing",
+  #       tag: "FetchBillingFromDigitalOcean"
+  #     },
+  #     process_options: {
+  #       refresh_token: "email server refresh token",
+  #       client_id: "email server client it",
+  #       client_secret: "email server client secret",
+  #       user_email: "sender@mail.com",
+  #       recipient_email: "recipient@mail.com",
+  #       threshold: "THRESHOLD"
+  #     },
+  #     write_options: {
+  #       connection: {
+  #         host: "localhost",
+  #         port: 5432,
+  #         dbname: "bas",
+  #         user: "postgres",
+  #         password: "postgres"
+  #       },
+  #       db_table: "do_billing",
+  #       tag: "NotifyDoBillAlertEmail"
+  #     }
+  #   }
+  #
+  #   bot = Bot::NotifyDoBillAlertEmail.new(options)
+  #   bot.execute
+  #
+  class NotifyDoBillAlertEmail < Bot::Base
+    SUBJECT = "Digital Ocean Daily Threshold Alert"
+
+    # 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 Google send email utility
+    #
+    def process
+      return { success: {} } if unprocessable_response
+
+      response = Utils::GoogleService::SendEmail.new(params).execute
+
+      response[:error].nil? ? { success: {} } : { error: response }
+    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
+      process_options.merge({ subject: SUBJECT, message: read_response.data["notification"] })
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "httparty"
+require "json"
+
+module Utils
+  module DigitalOcean
+    ##
+    # This module is a Notion utility for sending request to create, update, or delete
+    # Notion resources.
+    #
+    module Request
+      DIGITAL_OCEAN_BASE_URL = "https://api.digitalocean.com/v2"
+
+      # Implements the request process logic to Notion.
+      #
+      # <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</tt> Notion secret.
+      #
+      # <br>
+      # <b>returns</b> <tt>HTTParty::Response</tt>
+      #
+      def self.execute(params)
+        url = "#{DIGITAL_OCEAN_BASE_URL}/#{params[:endpoint]}"
+
+        headers = headers(params[:secret])
+
+        HTTParty.send(params[:method], url, { body: params[:body].to_json, headers: })
+      end
+
+      def self.headers(secret)
+        {
+          "Authorization" => "Bearer #{secret}",
+          "Content-Type" => "application/json"
+        }
+      end
+    end
+  end
+end

data/lib/bas/utils/google/send_email.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require "google/apis/gmail_v1"
+require "googleauth"
+
+module Utils
+  module GoogleService
+    ##
+    # This module is a Google service utility to send emails from a google account
+    #
+    class SendEmail
+      SCOPES = ["https://mail.google.com/", "https://www.googleapis.com/auth/gmail.send"].freeze
+      CONTENT_TYPE = "message/rfc822"
+
+      def initialize(params)
+        @refresh_token = params[:refresh_token]
+        @client_id = params[:client_id]
+        @client_secret = params[:client_secret]
+        @user_email = params[:user_email]
+        @recipient_email = params[:recipient_email]
+        @subject = params[:subject]
+        @message = params[:message]
+      end
+
+      def execute
+        { send_email: }
+      rescue StandardError => e
+        { error: e.to_s }
+      end
+
+      private
+
+      def send_email
+        service = Google::Apis::GmailV1::GmailService.new
+
+        service.authorization = access_token
+
+        service.send_user_message(@user_email, upload_source:, content_type: CONTENT_TYPE)
+      end
+
+      def upload_source
+        message = <<~END_OF_MESSAGE
+          From: me
+          To: #{@recipient_email.join(",")}
+          Subject: #{@subject}
+          MIME-Version: 1.0
+          Content-Type: text/plain; charset=UTF-8
+
+          #{@message}
+        END_OF_MESSAGE
+
+        StringIO.new(message)
+      end
+
+      def access_token
+        client = Google::Auth::UserRefreshCredentials.new(auth_params)
+
+        client.fetch_access_token!
+        client.access_token
+      end
+
+      def auth_params
+        {
+          client_id: @client_id,
+          client_secret: @client_secret,
+          refresh_token: @refresh_token,
+          scope: SCOPES
+        }
+      end
+    end
+  end
+end

data/lib/bas/version.rb

@@ -2,5 +2,5 @@
 
 module Bas
   # Gem version
-  VERSION = "1.1.3"
+  VERSION = "1.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bas
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.2.1
 platform: ruby
 authors:
 - kommitters Open Source
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-08 00:00:00.000000000 Z
+date: 2024-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gmail_xoauth
@@ -16,14 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.2
+        version: 0.4.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.2
+        version: 0.4.1
+- !ruby/object:Gem::Dependency
+  name: google-api-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.53'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.53'
+- !ruby/object:Gem::Dependency
+  name: googleauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
@@ -159,6 +187,7 @@ files:
 - lib/bas.rb
 - lib/bas/bot/base.rb
 - lib/bas/bot/compare_wip_limit_count.rb
+- lib/bas/bot/fetch_billing_from_digital_ocean.rb
 - lib/bas/bot/fetch_birthdays_from_notion.rb
 - lib/bas/bot/fetch_domains_wip_counts_from_notion.rb
 - lib/bas/bot/fetch_domains_wip_limit_from_notion.rb
@@ -168,11 +197,13 @@ files:
 - lib/bas/bot/fetch_next_week_ptos_from_notion.rb
 - lib/bas/bot/fetch_ptos_from_notion.rb
 - lib/bas/bot/format_birthdays.rb
+- lib/bas/bot/format_do_bill_alert.rb
 - lib/bas/bot/format_emails.rb
 - lib/bas/bot/format_wip_limit_exceeded.rb
 - lib/bas/bot/garbage_collector.rb
 - lib/bas/bot/humanize_pto.rb
 - lib/bas/bot/notify_discord.rb
+- lib/bas/bot/notify_do_bill_alert_email.rb
 - lib/bas/bot/review_media.rb
 - lib/bas/bot/update_review_media_state.rb
 - lib/bas/bot/write_media_review_in_notion.rb
@@ -181,9 +212,11 @@ files:
 - lib/bas/read/default.rb
 - lib/bas/read/postgres.rb
 - lib/bas/read/types/response.rb
+- lib/bas/utils/digital_ocean/request.rb
 - lib/bas/utils/discord/integration.rb
 - lib/bas/utils/exceptions/function_not_implemented.rb
 - lib/bas/utils/exceptions/invalid_process_response.rb
+- lib/bas/utils/google/send_email.rb
 - lib/bas/utils/imap/request.rb
 - lib/bas/utils/notion/request.rb
 - lib/bas/utils/notion/update_db_state.rb