bas 1.4.1 → 1.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b66afc50b75886393d36686a909055c677de6c84cea65580c40142487440097
-  data.tar.gz: 454565030fbbea5d60a54ec5f6bf7ec43f996f64ed5bc372908470a7173a09cf
+  metadata.gz: 6956cdda4a4735a5eb0a3d4413d41a972ac8190bb8d7da920e298a71bbe41516
+  data.tar.gz: 27c071aa1a681fb0f657af8e21c46057e3eb11cb467b5dd715f28c2f691d6dda
 SHA512:
-  metadata.gz: 0d6a66d745da40e8498b63eb12a2e8e006d727313c08a8924cbbf5fe960362fe6621b9059ecc430103a1bcf3740618dcfa55d3ed11f21e8b8847cb7b6767a723
-  data.tar.gz: ebb4c84192b579df371022608bf0195f177b8fcd9d7cbacfb03c77d724ceef8e0d25cff3281c78e92db28e3ba8deb07281fb4611608afc4bff667b65fe7e101e
+  metadata.gz: bb89f398a03c6c8bae97798d069772790f2bd80a3ef7db4956b86751c4ef5a2b04420184e76ed138685f45dee3b1a9cdb1994517ca585663d9998a40bcb07f83
+  data.tar.gz: 9a586528f93844ad4e68d34a938bb2cff62eec5cd58fd952d1b431c5641c7af9ba5933ed8803b7fda42086b258b167c3826d2b492546887155b47e563c080b1f

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+# 1.4.2 (28.08.2024)
+- [Adjust digital ocean billing bots](https://github.com/kommitters/bas/issues/97)
+
 # 1.4.1 (12.08.2024)
 - [Add github issues assignees to work items](https://github.com/kommitters/bas/issues/92)
 

data/README.md

@@ -102,142 +102,8 @@ bot.execute
 
 ```
 
-### Serverless
-We'll explain how to configure and deploy a bot with serverless.
-
-#### Configuring environment variables
-Create the environment variables configuration file.
-
-```bash
-cp env.yml.example env.yml
-```
-
-And put the following env variables
-```
-dev:
-  BIRTHDAY_NOTION_DATABASE_ID: "BIRTHDAY_NOTION_DATABASE_ID"
-  BIRTHDAY_NOTION_SECRET: "BIRTHDAY_NOTION_SECRET"
-prod:
-  BIRTHDAY_NOTION_DATABASE_ID: "BIRTHDAY_NOTION_DATABASE_ID"
-  BIRTHDAY_NOTION_SECRET: "BIRTHDAY_NOTION_SECRET"
-
-```
-
-The variables should be defined either in the custom settings section within the `serverless.yml` file to ensure accessibility by all lambdas, or in the environment configuration option for each lambda respectively. For example:
-
-```bash
-# Accessible by all the lambdas
-custom:
-  settings:
-      api:
-        NOTION_DATABASE_ID: ${file(./env.yml):${env:STAGE}.NOTION_DATABASE_ID}
-        NOTION_SECRET: ${file(./env.yml):${env:STAGE}.NOTION_SECRET}}
-
-# Accessible by the lambda
-functions:
-  lambdaName:
-    environment:
-      NOTION_DATABASE_ID: ${file(./env.yml):${env:STAGE}.NOTION_DATABASE_ID}
-      NOTION_SECRET: ${file(./env.yml):${env:STAGE}.NOTION_SECRET}}
-```
-
-#### Schedule
-the schedule is configured using an environment variable containing the cron configuration. For example:
-```bash
-# env.yml file
-SCHEDULER: cron(0 13 ? * MON-FRI *)
-
-# serverless.yml
-functions:
-  lambdaName:
-    events:
-      - schedule:
-        rate: ${file(./env.yml):${env:STAGE}.SCHEDULER}
-```
-
-To learn how to modify the cron configuration follow this guide: [Schedule expressions using rate or cron](https://docs.aws.amazon.com/lambda/latest/dg/services-cloudwatchevents-expressions.html)
-
-#### Building your lambda
-On your serverless configuration, create your lambda function, on your serverless `/src` folder.
-
-```ruby
-# frozen_string_literal: true
-
-require 'bas/bot/fetch_birthdays_from_notion'
-
-# Initialize the environment variables
-NOTION_DATABASE_ID = ENV.fetch('NOTION_DATABASE_ID')
-NOTION_SECRET = ENV.fetch('NOTION_SECRET')
-
-module Notifier
-  # Service description
-  class UseCaseName
-    def self.notify(*)
-      options = { process_options: , write_options: }
-
-      begin
-        use_case = Bot::FetchBirthdaysFromNotion.new(options)
-
-        use_case.execute
-      rescue StandardError => e
-        { body: { message: e.message } }
-      end
-    end
-
-    def self.process_options
-      {
-        database_id: NOTION_DATABASE_ID,
-        secret: NOTION_SECRET
-      }
-    end
-
-    def self.write_options
-      {
-        connection: {
-          host: "host",
-          port: 5432,
-          dbname: "bas",
-          user: "postgres",
-          password: "postgres"
-        },
-        db_table: "use_cases",
-        bot_name: "FetchBirthdaysFromNotion"
-      }
-    end
-  end
-end
-```
-
-#### Configure the lambda
-In the `serverless.yml` file, add a new instance in the `functions` block with this structure:
-
-```bash
-functions:
-  fetchBirthdayFromNotion:
-    handler: src/lambdas/birthday_fetch.Bot::Birthday.fetch
-    environment:
-      BIRTHDAY_NOTION_DATABASE_ID: ${file(./env.yml):${env:STAGE}.BIRTHDAY_NOTION_DATABASE_ID}
-      BIRTHDAY_NOTION_SECRET: ${file(./env.yml):${env:STAGE}.BIRTHDAY_NOTION_SECRET}
-    events:
-      - schedule:
-          name: birthday-fetch
-          description: "Fetch every 24 hours at 8:30 a.m (UTC-5) from monday to friday"
-          rate: cron(${file(./env.yml):${env:STAGE}.BIRTHDAY_FETCH_SCHEDULER})
-          enabled: true
-```
-
-#### Deploying
-
-Configure the AWS keys:
-
-```bash
-serverless config credentials --provider aws --key YOUR_KEY --secret YOUR_SECRET
-```
-
-Deploy the project:
-```bash
-STAGE=prod sls deploy --verbose
-```
+## Real case usage
+For implementation details, please refer to the examples folder in the repository. You can find an example of how to configure a Lambda function with a bot there.
 
 ## Development
 

data/examples/serverless_example.md

@@ -0,0 +1,132 @@
+### Serverless
+We'll explain how to configure and deploy a bot with serverless.
+
+#### Configuring environment variables
+Create the environment variables configuration file (`env.yml`)
+
+And put the following env variables
+```
+dev:
+  BIRTHDAY_NOTION_DATABASE_ID: "BIRTHDAY_NOTION_DATABASE_ID"
+  BIRTHDAY_NOTION_SECRET: "BIRTHDAY_NOTION_SECRET"
+prod:
+  BIRTHDAY_NOTION_DATABASE_ID: "BIRTHDAY_NOTION_DATABASE_ID"
+  BIRTHDAY_NOTION_SECRET: "BIRTHDAY_NOTION_SECRET"
+
+```
+
+The variables should be defined either in the custom settings section within the `serverless.yml` file to ensure accessibility by all lambdas, or in the environment configuration option for each lambda respectively. For example:
+
+```bash
+# Accessible by all the lambdas
+custom:
+  settings:
+      api:
+        NOTION_DATABASE_ID: ${file(./env.yml):${env:STAGE}.NOTION_DATABASE_ID}
+        NOTION_SECRET: ${file(./env.yml):${env:STAGE}.NOTION_SECRET}}
+
+# Accessible by the lambda
+functions:
+  lambdaName:
+    environment:
+      NOTION_DATABASE_ID: ${file(./env.yml):${env:STAGE}.NOTION_DATABASE_ID}
+      NOTION_SECRET: ${file(./env.yml):${env:STAGE}.NOTION_SECRET}}
+```
+
+#### Schedule
+the schedule is configured using an environment variable containing the cron configuration. For example:
+```bash
+# env.yml file
+SCHEDULER: cron(0 13 ? * MON-FRI *)
+
+# serverless.yml
+functions:
+  lambdaName:
+    events:
+      - schedule:
+        rate: ${file(./env.yml):${env:STAGE}.SCHEDULER}
+```
+
+To learn how to modify the cron configuration follow this guide: [Schedule expressions using rate or cron](https://docs.aws.amazon.com/lambda/latest/dg/services-cloudwatchevents-expressions.html)
+
+#### Building your lambda
+On your serverless configuration, create your lambda function, on your serverless `/src` folder.
+
+```ruby
+# frozen_string_literal: true
+
+require 'bas/bot/fetch_birthdays_from_notion'
+
+# Initialize the environment variables
+NOTION_DATABASE_ID = ENV.fetch('NOTION_DATABASE_ID')
+NOTION_SECRET = ENV.fetch('NOTION_SECRET')
+
+module Notifier
+  # Service description
+  class UseCaseName
+    def self.notify(*)
+      options = { process_options: , write_options: }
+
+      begin
+        use_case = Bot::FetchBirthdaysFromNotion.new(options)
+
+        use_case.execute
+      rescue StandardError => e
+        { body: { message: e.message } }
+      end
+    end
+
+    def self.process_options
+      {
+        database_id: NOTION_DATABASE_ID,
+        secret: NOTION_SECRET
+      }
+    end
+
+    def self.write_options
+      {
+        connection: {
+          host: "host",
+          port: 5432,
+          dbname: "bas",
+          user: "postgres",
+          password: "postgres"
+        },
+        db_table: "use_cases",
+        bot_name: "FetchBirthdaysFromNotion"
+      }
+    end
+  end
+end
+```
+
+#### Configure the lambda
+In the `serverless.yml` file, add a new instance in the `functions` block with this structure:
+
+```bash
+functions:
+  fetchBirthdayFromNotion:
+    handler: src/lambdas/birthday_fetch.Bot::Birthday.fetch
+    environment:
+      BIRTHDAY_NOTION_DATABASE_ID: ${file(./env.yml):${env:STAGE}.BIRTHDAY_NOTION_DATABASE_ID}
+      BIRTHDAY_NOTION_SECRET: ${file(./env.yml):${env:STAGE}.BIRTHDAY_NOTION_SECRET}
+    events:
+      - schedule:
+          name: birthday-fetch
+          description: "Fetch every 24 hours at 8:30 a.m (UTC-5) from monday to friday"
+          rate: cron(${file(./env.yml):${env:STAGE}.BIRTHDAY_FETCH_SCHEDULER})
+          enabled: true
+```
+
+#### Deploying
+
+Configure the AWS keys:
+
+```bash
+serverless config credentials --provider aws --key YOUR_KEY --secret YOUR_SECRET
+```
+
+Deploy the project:
+```bash
+STAGE=prod sls deploy --verbose
+```

data/lib/bas/bot/fetch_billing_from_digital_ocean.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "./base"
-require_relative "../read/default"
+require_relative "../read/postgres"
 require_relative "../utils/digital_ocean/request"
 require_relative "../write/postgres"
 
@@ -37,7 +37,7 @@ module Bot
     # Read function to execute the default Read component
     #
     def read
-      reader = Read::Default.new
+      reader = Read::Postgres.new(read_options.merge(conditions))
 
       reader.execute
     end
@@ -48,8 +48,7 @@ module Bot
       response = Utils::DigitalOcean::Request.execute(params)
 
       if response.code == 200
-
-        { success: { billing: response.parsed_response } }
+        { success: { billing: response.parsed_response, last_billing: } }
       else
         { error: { message: response.parsed_response, status_code: response.code } }
       end
@@ -65,6 +64,13 @@ module Bot
 
     private
 
+    def conditions
+      {
+        where: "archived=$1 AND tag=$2 ORDER BY inserted_at DESC",
+        params: [false, read_options[:tag]]
+      }
+    end
+
     def params
       {
         endpoint: "customers/my/balance",
@@ -73,5 +79,11 @@ module Bot
         body: {}
       }
     end
+
+    def last_billing
+      return read_response.data["billing"] unless read_response.data.nil?
+
+      { month_to_date_balance: 0 }
+    end
   end
 end

data/lib/bas/bot/format_do_bill_alert.rb

@@ -79,23 +79,30 @@ module Bot
     end
 
     def threshold_exceeded
-      daily_usage > process_options[:threshold]
+      return false if billing.zero?
+
+      usage > process_options[:threshold]
+    end
+
+    def usage
+      billing - last_billing
     end
 
-    def daily_usage
-      balance = read_response.data["billing"]["month_to_date_balance"].to_f
-      day_of_month = Time.now.utc.mday
+    def billing
+      read_response.data["billing"]["month_to_date_balance"].to_f
+    end
 
-      balance / day_of_month
+    def last_billing
+      read_response.data["last_billing"]["month_to_date_balance"].to_f
     end
 
     def message
-      balance = read_response.data["billing"]["month_to_date_balance"]
+      balance = billing
       threshold = process_options[:threshold]
 
       ":warning: The **DigitalOcean** daily usage was exceeded. \
       Current balance: #{balance}, Threshold: #{threshold}, \
-      Current daily usage: #{daily_usage.round(3)}"
+      Current daily usage: #{usage.round(3)}"
     end
   end
 end

data/lib/bas/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bas
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.4.2
 platform: ruby
 authors:
 - kommitters Open Source
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-12 00:00:00.000000000 Z
+date: 2024-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gmail_xoauth
@@ -184,6 +184,7 @@ files:
 - README.md
 - Rakefile
 - SECURITY.md
+- examples/serverless_example.md
 - lib/bas.rb
 - lib/bas/bot/base.rb
 - lib/bas/bot/compare_wip_limit_count.rb