update rubydoc

Author: tungnt1203

lib/minds.rb

@@ -12,6 +12,11 @@
 
 module Minds
   class MiddlewareErrors < Faraday::Middleware
+    ##
+    # Handles API error responses and provides detailed logging
+    #
+    # @param env [Hash] The Faraday environment hash
+    # @raise [Faraday::Error] Re-raises the original error after logging
     def call(env)
       @app.call(env)
     rescue Faraday::Error => e

lib/minds/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Minds
   class Client
     include Minds::RestClient

lib/minds/config/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Minds
   module Config
     class Base

lib/minds/datasources.rb

@@ -28,6 +28,8 @@ class Datasources
     def initialize(client:)
       @client = client
     end
+
+    ##
     # Create a new datasource and return it
     #
     # @param ds_config [DatabaseConfig] datasource configuration
@@ -38,6 +40,21 @@ def initialize(client:)
     # @option ds_config [Array<String>] :tables (optional) List of allowed tables
     # @param replace [Boolean] If true, replaces an existing datasource with the same name
     # @return [Datasource] The created datasource object
+    # @raise [ObjectNotSupported] If datasource type is not supported
+    #
+    # @example
+    #   config = DatabaseConfig.new(
+    #     name: 'sales_db',
+    #     engine: 'postgres',
+    #     connection_data: {
+    #       host: 'localhost',
+    #       port: 5432,
+    #       user_name: "test"
+    #       password: "test"
+    #     }
+    #   )
+    #   datasource = datasources.create(config)
+    #
     def create(ds_config, replace = false)
       name = ds_config.name
       if replace
@@ -50,9 +67,15 @@ def create(ds_config, replace = false)
       find(name)
     end
 
-    # Returns a list of all datasources
+    ##
+    # Returns a list of datasources
     #
     # @return [Array<Datasource>] An array of Datasource objects
+    #
+    # @example
+    #   datasources = datasources.all
+    #   datasources.each { |ds| puts ds.name }
+    #
     def all
       data = @client.get(path: "datasources")
       return [] if data.empty?
@@ -64,11 +87,17 @@ def all
       end
     end
 
-    # Get a datasource by name
+    ##
+    # Find a datasource by name
     #
     # @param name [String] The name of the datasource to find
     # @return [Datasource] The found datasource object
     # @raise [ObjectNotSupported] If the datasource type is not supported
+    #
+    # @example
+    #   datasource = datasources.find('sales_db')
+    #   puts datasource.engine
+    #
     def find(name)
       data = @client.get(path: "datasources/#{name}")
       if data["engine"].nil?
@@ -77,10 +106,19 @@ def find(name)
       Datasource.new(**data.transform_keys(&:to_sym))
     end
 
-    # Destroy (delete) a datasource by name
+    ##
+    # Deletes a datasource
+    #
+    # @param name [String]  Datasource name to delete
+    # @param force [Boolean] Whether to force delete from all minds
+    #
+    # @example
+    #   # Simple delete
+    #   datasources.destroy('old_db')
+    #
+    #   # Force delete
+    #   datasources.destroy('old_db', force: true)
     #
-    # @param name [String] The name of the datasource to delete
-    # @param force: if true -remove from all minds, default: false
     def destroy(name, force: false)
       data = force ? { cascade: true } : nil
       @client.delete(path: "datasources/#{name}", parameters: data)

lib/minds/minds.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "openai"
 require "uri"
 
@@ -20,7 +22,8 @@ def initialize(client, attributes = {})
       @datasources = attributes["datasources"]
     end
 
-    # Update the mind with new parameters
+    ##
+    # Update mind
     #
     # @param name [String, nil] New name of the mind (optional)
     # @param model_name [String, nil] New LLM model name (optional)
@@ -29,8 +32,8 @@ def initialize(client, attributes = {})
     # @param datasources [Array<String, Datasource, DatabaseConfig>, nil] Alter list of datasources used by mind (optional)
     #   Datasource can be passed as:
     #   - String: name of the datasource
-    #   - Datasource object (Minds::Resources::Datasource)
-    #   - DatabaseConfig object (Minds::Resources::DatabaseConfig), in this case datasource will be created
+    #   - Datasource object (Minds::Datasource)
+    #   - DatabaseConfig object (Minds::DatabaseConfig), in this case datasource will be created
     # @param parameters [Hash, nil] Alter other parameters of the mind (optional)
     # @return [void]
     def update(name: nil, model_name: nil, provider: nil, prompt_template: nil, datasources: nil, parameters: nil)
@@ -54,13 +57,14 @@ def update(name: nil, model_name: nil, provider: nil, prompt_template: nil, data
       @name = name if name && name != @name
     end
 
-    # Add a datasource to the mind
+    ##
+    # Add datasource to mind
     #
-    # @param datasource [String, Datasource, DatabaseConfig] The datasource to add
+    # @param datasource [String, Datasource, DatabaseConfig] Datasource to add
     #   Can be passed as:
     #   - String: name of the datasource
-    #   - Datasource object (Minds::Resources::Datasource)
-    #   - DatabaseConfig object (Minds::Resources::DatabaseConfig), in this case datasource will be created
+    #   - Datasource object (Minds::Datasource)
+    #   - DatabaseConfig object (Minds::DatabaseConfig), in this case datasource will be created
     # @return [void]
     def add_datasources(datasource)
       ds_name = @client.minds.check_datasource(datasource)
@@ -71,13 +75,15 @@ def add_datasources(datasource)
       @datasources = mind.datasources
     end
 
-    # Delete a datasource from the mind
+    ##
+    # Remove datasource from mind
     #
-    # @param datasource [String, Datasource] The datasource to delete
+    # @param datasource [String, Datasource] Datasource to remove
     #   Can be passed as:
     #   - String: name of the datasource
     #   - Datasource object (Minds::Resources::Datasource)
     # @return [void]
+    # @raise [ArgumentError] If datasource type is invalid
     def destroy_datasources(datasource)
       if datasource.is_a?(Datasource)
         datasource = datasource.name
@@ -90,6 +96,7 @@ def destroy_datasources(datasource)
       @datasources = mind.datasources
     end
 
+    ##
     # Call mind completion
     #
     # @param message [String] The input question or prompt
@@ -125,34 +132,52 @@ def initialize(client:)
       @project = "mindsdb"
     end
 
-    # Returns a list of all minds
+    ##
+    # Lists minds
+    #
+    # @return [Array<Mind>] List of minds
+    #
+    # @example
+    #   minds = minds.all
+    #   minds.each { |mind| puts mind.name }
     #
-    # @return [Array<Mind>] An array of Mind objects
     def all
       data = @client.get(path: "projects/#{@project}/minds")
       return [] if data.empty?
 
       data.map { |item| Mind.new(@client, item) }
     end
 
-    # Get a mind by name
+    ##
+    # Find a mind by name
     #
     # @param name [String] The name of the mind to find
     # @return [Mind] The found mind object
+    #
+    # @example
+    #   mind = minds.find('sales_assistant')
+    #   puts mind.model_name
+    #
     def find(name)
       data = @client.get(path: "projects/#{@project}/minds/#{name}")
       Mind.new(@client, data)
     end
 
-    # Drop (delete) a mind by name
+    ##
+    # Deletes a mind
     #
     # @param name [String] The name of the mind to delete
     # @return [void]
+    #
+    # @example
+    #   minds.destroy('old_assistant')
+    #
     def destroy(name)
       @client.delete(path: "projects/#{@project}/minds/#{name}")
     end
 
-    # Create a new mind and return it
+    ##
+    # Creates a new mind
     #
     # @param name [String] The name of the mind
     # @param model_name [String, nil] The LLM model name (optional)
@@ -163,9 +188,21 @@ def destroy(name)
     #   - String: name of the datasource
     #   - Datasource object (Minds::Datasource)
     #   - DatabaseConfig object (Minds::DatabaseConfig), in this case datasource will be created
-    # @param parameters [Hash, nil] Other parameters of the mind (optional)
-    # @param replace [Boolean] If true, remove existing mind with the same name (default: false)
-    # @return [Mind] The created mind object
+    # @param [Hash, nil] parameters Additional parameters
+    # @param [Boolean] replace Whether to replace existing mind
+    # @return [Mind] The created mind
+    #
+    # @example Simple creation
+    #   mind = minds.create(name: 'sales_assistant', model_name: 'gpt-4')
+    #
+    # @example Creation with datasources
+    #   mind = minds.create(
+    #     name: 'sales_assistant',
+    #     model_name: 'gpt-4',
+    #     datasources: ['sales_db'],
+    #     prompt_template: 'Analyze sales data: {{question}}'
+    #   )
+    #
     def create(name:, model_name: nil, provider: nil, prompt_template: nil, datasources: nil, parameters: nil, replace: false)
       if replace
         begin

lib/minds/rest_client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Minds
   module RestClient
     def get(path:)