bas 1.6.2 → 1.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5128c22f8ba67518e5171077718313c0f540655f1a83b3954adc18613fe6863d
-  data.tar.gz: 71a7085f7dc92004aaf6271601d2d83a0e35f19c2e053f8050a959839347c87a
+  metadata.gz: 63490ab5165fd3aa1793a7521272869addb0ebd691d65e7e300b757af770b6fe
+  data.tar.gz: 834e5ff6ebe43795ddfd94fa19f7d3435cd6ae99fc24902abdec2a8c3215ce3d
 SHA512:
-  metadata.gz: 80d344d73476474246f4f3020ccd3adeac789f4e9d76dcf16aa5f872f3030f58c9b193f8b22bc5dbdf5dede180c6bcc42a63c403dfa42135837474f52f2fd777
-  data.tar.gz: 508c9b6ec55f0f5a28029a09f830fc4ce1284df19a05892e6f35ab3f21aefc3519583103e76ab44c37db529d1912801251d34688177d91b8ed3b01aca7cad2aa
+  metadata.gz: 97a51249e553a947453084004b2c4701f801bd43a9b14c439721fe1f3e2262813ac541ce0326262997757368eddfc46e08390938f116eef3eb75ecdb80d5e41d
+  data.tar.gz: 2d0d10c08ae2c5a1810e88c624e42d11dbf16ecacc45184185f0ff55caf27a0819b37baeb645991d3eac1ace9595dd1fedba1c4c7939460d824acfaa0fcc1d86

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+# 1.7.1 (11.02.2025)
+- [Fix absolute_path in order to execute the scripts](https://github.com/kommitters/bas/pull/133)
+
+# 1.7.0 (10.02.2025)
+- [Add orchestrator logic into the gem](https://github.com/kommitters/bas/issues/130)
+- [Improve and update test suite](https://github.com/kommitters/bas/issues/129)
+- [Cleanup gem dependencies](https://github.com/kommitters/bas/pull/126)
+- [Update bas in terms of business automation suite](http://github.com/kommitters/bas/pull/125)
+
 # 1.6.2 (12.12.2024)
 - [Bots with default shared storage reader are not saving data](https://github.com/kommitters/bas/issues/122)
 

data/Gemfile

@@ -5,16 +5,8 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in bas.gemspec
 gemspec
 
-gem "jwt", "~> 2.8.1"
-
 gem "rake", "~> 13.0"
 
-gem "net-imap", "~> 0.4.10"
-gem "net-smtp", "~> 0.4.0.1"
-
-gem "octokit", "~> 8.1.0"
-gem "openssl", "~> 3.2"
-
 gem "rspec", "~> 3.0"
 gem "rubocop", "~> 1.21"
 gem "simplecov", require: false, group: :test
@@ -27,9 +19,14 @@ gem "httparty"
 
 gem "pg", "~> 1.5", ">= 1.5.4"
 
-gem "gmail_xoauth"
-
-gem "google-api-client"
-gem "googleauth"
-
-gem "md_to_notion", "~> 0.1.4"
+group :test do
+  gem "faraday-retry"
+  gem "gmail_xoauth", "~> 0.4.1"
+  gem "google-api-client", "~> 0.53"
+  gem "jwt", "~> 2.8.1"
+  gem "md_to_notion", "~> 0.1.4"
+  gem "net-imap", "~> 0.4.10"
+  gem "net-smtp", "~> 0.4.0.1"
+  gem "octokit", "~> 8.1.0"
+  gem "openssl", "~> 3.2"
+end

data/README.md

@@ -1,4 +1,4 @@
-# BAS - Business Automation System
+# BAS - Business Automation Suite
 
 Many organizations and individuals rely on automation across various contexts in their daily operations. With BAS, we aim to provide an open-source platform that empowers users to create customized automation systems tailored to their unique requirements. BAS consists of a series of abstract components designed to facilitate the creation of diverse bots, regardless of context.
 
@@ -31,32 +31,46 @@ If bundler is not being used to manage dependencies, install the gem by executin
 ### BOT
 A bot is a tool responsible for executing a specific automation task. The bot's pipeline consists of reading from a shared storage (if required), processing a particular task, and then writing the result to a shared storage.
 
-### Shared Storage
-Shared storage is a central location where data can be read and written by multiple bots to facilitate coordination in an automation task. It serves as a common data exchange point, allowing each bot to access information generated by others as needed to complete its specific task. Examples of shared storage include a PostgreSQL database, an S3 bucket, or other types of storage systems that support concurrent access and data persistence.
-
 ### Use case
 A use case refers to an automation problem larger than what a single bot can manage. It typically involves a set of bots, each solving a specific part of the overall problem independently. To enable these bots to interact, shared storage is used. This shared storage could be a PostgreSQL database, an S3 bucket, or another shared storage type, allowing bots to read and write data that other bots can access to complete their tasks.
 
-## Building my own BOT
-
-The gem provides essential interfaces, types, and methods to help you easily create your own bot. For instance, two base classes are provided: one for handling shared storage read-write operations and another for defining the bot’s specific task logic.
+## Shared Storage
+Shared storage is a central location where data can be read and written by multiple bots to facilitate coordination in an automation task. It serves as a common data exchange point, allowing each bot to access information generated by others as needed to complete its specific task. Examples of shared storage include a PostgreSQL database, an S3 bucket, or other types of storage systems that support concurrent access and data persistence.
 
-### 1. SharedStorage - Read and Write data.
+### Read and Write data
 
 The `SharedStorage` class abstracts the process of reading from and writing to shared storage. This class specification is available in `bas/shared_storage/base.rb`, from which custom implementations can be built.
 
 Currently, the gem supports: `PostgreSQL`.
 
-### 2. Bot - Solve a specific automation task
-The bot executes the logic required to complete a specific task. For this, an instance of shared storage (for reading and for writing) must be provided to the bot.
+### Configurations
 
-The base interface for a bot is available in the `bas/bot/base.rb class`.
+This configuration provides an example of the structure a PostgreSQL shared storage would require for this purpose. The exact structure should be tailored to the nature of the implemented use cases.
 
-## Examples
+### Optional Dependencies
+
+BAS supports integrations with various external services like GitHub, Notion, OpenAI, and more. To use these integrations, you need to install the required gems manually.
+
+**Installing Optional Dependencies**
+
+The following gems are needed to use the following optional dependencies, add to your Gemfile or install them individually:
+
+```ruby
+- GitHub Integration:   gem 'octokit', '~> 8.1.0'
+                        gem 'jwt", "~> 2.8.1'
+                        gem 'openssl', '~> 3.2'
+
+- Notion Integration:   gem 'md_to_notion', '~> 0.1.4'
 
-### Preparing the configurations
+- Google Integration:   gem 'google-api-client', '~> 0.53'
+                        gem 'googleauth', '~> 1.11'
+
+- IMAP/SMTP Email:      gem 'net-imap', '~> 0.4.10'
+                        gem 'net-smtp', '~> 0.4.0.1'
+
+- Gmail OAuth:          gem 'gmail_xoauth', '~> 0.4.1'
+```
 
-The current implementation of the PostgreSQL shared storage expect a table with the following structure: 
 
 ```sql
 CREATE TABLE api_data(
@@ -74,6 +88,137 @@ CREATE TABLE api_data(
 );
 ```
 
+## Orchestrator: Manager for Scheduling and Running Scripts ##
+
+This module manages the execution of scheduled bots based on time intervals, specific times, or days. It uses a **ThreadPool** to run the scripts concurrently, ensuring efficient execution.
+
+### Adding Schedules to Your Repository
+
+To use the Orchestrator for scheduling and executing your bots, you need to define a `schedules` array in your repository. This array should include the paths to your scripts and the schedules for execution.
+
+### Example of the `schedules` defintion
+
+```ruby
+BIRTHDAY_SCHEDULES = [
+  # Execute every 1000ms (1 second)
+  { path: '/birthday/fetch_birthday_from_notion.rb', interval: 1000 },
+  { path: '/birthday/format_birthday.rb', interval: 1000 },
+  { path: '/birthday/notify_birthday_in_discord.rb', interval: 1000 },
+  { path: '/birthday/garbage_collector.rb', interval: 1000 },
+  ].freeze
+
+  # With days and hours
+  # Execute at 08:00 AM on Mondays
+  { path: '/birthday/notify_birthday_in_email.rb', day: ['Monday'], time: ['08:00'] }
+
+```
+
+### How to Use the Orchestrator
+
+Once you've defined your schedules, you can initialize and run the Orchestrator to begin executing your scripts based on their schedules.
+
+
+```ruby
+
+# Initialize the orchestrator with the defined schedules
+manager = Bas::Orchestrator::Manager.new(BIRTHDAY_SCHEDULES)
+
+# Run the orchestrator
+manager.run
+
+```
+### Folder structure example:
+
+```bash
+src/use_cases_execution/
+├── birthday/
+│   ├── fetch_birthday_from_notion.rb
+│   ├── format_birthday.rb
+│   ├── notify_birthday_in_discord.rb
+│   └── garbage_collector.rb
+└── schedules.rb
+```
+
+### Implementation examples
+
+#### Example 1: Using the Same Shared Storage for Reading and Writing
+
+In some cases, a bot may need to both read from and write to the same shared storage. Here is an example implementation using a PostgreSQL database as shared storage:
+
+```ruby
+connection = {
+  host: "localhost",
+  port: 5432,
+  dbname: "bas",
+  user: "postgres",
+  password: "postgres"
+}
+
+read_options = {
+  connection: connection,
+  db_table: "api_data",
+  tag: "AnotherBot"
+}
+
+write_options = {
+  connection: connection,
+  db_table: "api_data",
+  tag: "FetchFromAPi"
+}
+
+options = {
+  token: "api_token"
+}
+
+shared_storage = SharedStorage.new(read_options: read_options, write_options: write_options)
+
+bot = Bas::Bot::FetchFromAPi.new(options, shared_storage)
+bot.execute
+```
+
+#### Example 2: Using Different Shared Storage Instances for Reading and Writing
+
+In some situations, it may be beneficial to use separate shared storage instances for reading and writing. For example, a bot might read from a default shared storage implementation and write to a PostgreSQL database:
+
+```ruby
+connection = {
+  host: "localhost",
+  port: 5432,
+  dbname: "bas",
+  user: "postgres",
+  password: "postgres"
+}
+
+write_options = {
+  connection: connection,
+  db_table: "api_data",
+  tag: "FetchFromAPi"
+}
+
+options = {
+  token: "api_token"
+}
+
+shared_storage_reader = Bas::SharedStorage::Default.new
+shared_storage_writer = Bas::SharedStorage::Postgres.new(write_options: write_options)
+
+bot = Bas::Bot::FetchFromAPi.new(options, shared_storage_reader, shared_storage_writer)
+bot.execute
+```
+
+In this example, the shared_storage_reader is a default implementation that does not perform actual reading operations, while shared_storage_writer writes to a PostgreSQL database.
+
+## Building my own BOT
+
+The gem provides essential interfaces, types, and methods to help you easily create your own bot. For instance, two base classes are provided: one for handling shared storage read-write operations and another for defining the bot’s specific task logic.
+
+### Bot - Solve a specific automation task
+The bot executes the logic required to complete a specific task. For this, an instance of shared storage (for reading and for writing) must be provided to the bot.
+
+The base interface for a bot is available in the `bas/bot/base.rb class`.
+
+## Examples
+
 ### Define the bot
 
 In this example, we demonstrate how to configure a bot to fetch data from an API and save it in a postgres database.

data/lib/bas/orchestrator/manager.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require "concurrent-ruby"
+
+module Bas
+  module Orchestrator
+    ##
+    # Manager class responsible for scheduling and executing scripts concurrently.
+    #
+    # This class initializes a thread pool and processes scheduled scripts based on
+    # time intervals, specific days, or exact times.
+    #
+    class Manager
+      def initialize(schedules)
+        @last_executions = Hash.new(0.0)
+        @schedules = schedules
+        @pool = Concurrent::FixedThreadPool.new(@schedules.size)
+      end
+
+      def run
+        @schedules.each { |script| @pool.post { process_script(script) } }
+
+        @pool.shutdown
+        @pool.wait_for_termination
+      end
+
+      private
+
+      def process_script(script)
+        loop do
+          @actual_time = Time.new
+
+          execute_interval(script) if interval?(script)
+          execute_day(script) if day?(script) && time?(script)
+          execute_time(script) if time?(script) && !day?(script)
+
+          sleep 0.1
+        rescue StandardError => e
+          puts "Error in thread: #{e.message}"
+        end
+      end
+
+      def execute_interval(script)
+        return unless time_in_milliseconds - @last_executions[script[:path]] >= script[:interval]
+
+        execute(script)
+        @last_executions[script[:path]] = time_in_milliseconds
+      end
+
+      def execute_day(script)
+        return unless script[:day].include?(current_day) && script[:time].include?(current_time)
+
+        execute(script) unless @last_executions[script[:path]].eql?(current_time)
+        @last_executions[script[:path]] = current_time
+      end
+
+      def execute_time(script)
+        execute(script) if script[:time].include?(current_time) && !@last_executions[script[:path]].eql?(current_time)
+        @last_executions[script[:path]] = current_time
+      end
+
+      def interval?(script)
+        script[:interval]
+      end
+
+      def time?(script)
+        script[:time]
+      end
+
+      def day?(script)
+        script[:day]
+      end
+
+      def time_in_milliseconds
+        @actual_time.to_f * 1000
+      end
+
+      def current_time
+        @actual_time.strftime("%H:%M")
+      end
+
+      def current_day
+        @actual_time.strftime("%A")
+      end
+
+      def execute(script)
+        puts "Executing #{script[:path]} at #{current_time}"
+        absolute_path = File.expand_path(script[:path], __dir__)
+
+        system("ruby", absolute_path)
+      end
+    end
+  end
+end

data/lib/bas/orchestrator.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "bas/orchestrator/manager"
+module Bas
+  # The Orchestrator module is responsible for managing the scheduling and execution
+  # of scripts within the business automation services. It provides a high-level
+  # interface to start the orchestration process using the `Manager` class.
+  #
+  module Orchestrator
+    # Starts the orchestration process with the given schedules.
+    #
+    # @param schedules [Array<Hash>] A list of scripts with execution details.
+    def self.start(schedules)
+      manager = Manager.new(schedules)
+      manager.run
+    end
+  end
+end

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

@@ -25,11 +25,13 @@ module Utils
       # <b>returns</b> <tt>HTTParty::Response</tt>
       #
       def self.execute(params)
-        url = "#{DIGITAL_OCEAN_BASE_URL}/#{params[:endpoint]}"
+        validate_params(params)
 
+        url = "#{DIGITAL_OCEAN_BASE_URL}/#{params[:endpoint]}"
         headers = headers(params[:secret])
+        body = params[:body]&.to_json
 
-        HTTParty.send(params[:method], url, { body: params[:body].to_json, headers: })
+        HTTParty.send(params[:method], url, { body: body, headers: headers })
       end
 
       def self.headers(secret)
@@ -38,6 +40,11 @@ module Utils
           "Content-Type" => "application/json"
         }
       end
+
+      def self.validate_params(params)
+        raise ArgumentError, "Secret is required" unless params[:secret]
+        raise ArgumentError, "Endpoint is required" unless params[:endpoint]
+      end
     end
   end
 end

data/lib/bas/utils/github/octokit_client.rb

@@ -22,6 +22,12 @@ module Utils
         { error: e.to_s }
       end
 
+      def repository_info(repo)
+        octokit.repository(repo)
+      rescue StandardError => e
+        { error: e.to_s }
+      end
+
       private
 
       def octokit

data/lib/bas/version.rb

@@ -2,5 +2,5 @@
 
 module Bas
   # Gem version
-  VERSION = "1.6.2"
+  VERSION = "1.7.1"
 end

metadata

@@ -1,57 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bas
 version: !ruby/object:Gem::Version
-  version: 1.6.2
+  version: 1.7.1
 platform: ruby
 authors:
 - kommitters Open Source
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-12 00:00:00.000000000 Z
+date: 2025-02-11 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: gmail_xoauth
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.4.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        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
@@ -66,90 +23,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.22.0
-- !ruby/object:Gem::Dependency
-  name: jwt
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.8.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.8.1
-- !ruby/object:Gem::Dependency
-  name: md_to_notion
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.1.4
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.1.4
-- !ruby/object:Gem::Dependency
-  name: net-imap
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.4.10
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.4.10
-- !ruby/object:Gem::Dependency
-  name: net-smtp
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.4.0.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.4.0.1
-- !ruby/object:Gem::Dependency
-  name: octokit
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 8.1.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 8.1.0
-- !ruby/object:Gem::Dependency
-  name: openssl
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
@@ -164,9 +37,10 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
-description: A versatile business automation system offering key components for building
-  various use cases.     It provides an easy-to-use tool for implementing automation
-  workflows without excessive complexity.     Formerly known as 'bns'.
+description: A versatile business automation suite offering key components for     building
+  and automating a wide variety of use cases.     It provides an easy-to-use tool
+  for implementing automation workflows without excessive complexity.     Formerly
+  known as 'bns'.
 email:
 - oss@kommit.co
 executables: []
@@ -187,6 +61,8 @@ files:
 - examples/serverless_example.md
 - lib/bas.rb
 - lib/bas/bot/base.rb
+- lib/bas/orchestrator.rb
+- lib/bas/orchestrator/manager.rb
 - lib/bas/shared_storage/base.rb
 - lib/bas/shared_storage/default.rb
 - lib/bas/shared_storage/postgres.rb
@@ -216,7 +92,6 @@ licenses:
 metadata:
   homepage_uri: https://github.com/kommitters/bas
   source_code_uri: https://github.com/kommitters/bas
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -231,8 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
-summary: BAS - Business automation system
+summary: BAS - Business automation suite
 test_files: []