gemini-ai 3.1.2 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9bd73b705a0583ff417c3e27341d49dc4847d7ecda287d5ce3f3e501dce0d784
-  data.tar.gz: af6e6f982b09a4787303c03e02f6bbf67c10520b7852d8398d87f14d1b72a947
+  metadata.gz: c726dcc65ecf4cfca2819e6f18da5fd1a3eb96e45888971881c7255631a2f074
+  data.tar.gz: 2d1617c38f987a40386b48b8465871e44f60bc2bd00dc4883704f91aa12aaab9
 SHA512:
-  metadata.gz: 67bd3d6acbf83b7e9d2da8e8082f5bc412b0390822cc71884e40e4e2e93d1abbd01c2c6d7413b76a37f4c4dc2250064f00862cb64fc07851458685375af78619
-  data.tar.gz: ef46dd2bee2c1329c1c2a50a3f409f8a6205f81279add1c1bce409304790c018bcc0041676a11809ede5df12e008cdf56cd2064592e30c3384808e748cd7deb2
+  metadata.gz: c3356afb013f69f51c1dfd6f379da7ae615dbbc4750dff25b977bc70a4ccda428a4466cbf4ea60dd7341bbc634882b56d1d76a24c3993a449c97ae566c44daf1
+  data.tar.gz: 9412ff5d682105db69caf9cc98688d499f794f76231e741450ee6eebd2c0f49efaeca6376f3b45a424e070e717e702a347ce5cf5cf0eb27229dc8e10727cdb32

data/.gitignore

@@ -1,2 +1,3 @@
 *.gem
 .devcontainer
+.env

data/Gemfile

@@ -5,6 +5,7 @@ source 'https://rubygems.org'
 gemspec
 
 group :test, :development do
+  gem 'dotenv', '~> 2.8', '>= 2.8.1'
   gem 'pry-byebug', '~> 3.10', '>= 3.10.1'
-  gem 'rubocop', '~> 1.58'
+  gem 'rubocop', '~> 1.60', '>= 1.60.1'
 end

data/Gemfile.lock

@@ -1,10 +1,12 @@
 PATH
   remote: .
   specs:
-    gemini-ai (3.1.2)
+    gemini-ai (3.2.0)
       event_stream_parser (~> 1.0)
-      faraday (~> 2.8, >= 2.8.1)
+      faraday (~> 2.9)
+      faraday-typhoeus (~> 1.1)
       googleauth (~> 1.8)
+      typhoeus (~> 1.4, >= 1.4.1)
 
 GEM
   remote: https://rubygems.org/
@@ -12,15 +14,20 @@ GEM
     addressable (2.8.6)
       public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
-    base64 (0.2.0)
     byebug (11.1.3)
     coderay (1.1.3)
+    dotenv (2.8.1)
+    ethon (0.16.0)
+      ffi (>= 1.15.0)
     event_stream_parser (1.0.0)
-    faraday (2.8.1)
-      base64
-      faraday-net_http (>= 2.0, < 3.1)
-      ruby2_keywords (>= 0.0.4)
-    faraday-net_http (3.0.2)
+    faraday (2.9.0)
+      faraday-net_http (>= 2.0, < 3.2)
+    faraday-net_http (3.1.0)
+      net-http
+    faraday-typhoeus (1.1.0)
+      faraday (~> 2.0)
+      typhoeus (~> 1.4)
+    ffi (1.16.3)
     google-cloud-env (2.1.0)
       faraday (>= 1.0, < 3.a)
     googleauth (1.9.1)
@@ -35,9 +42,11 @@ GEM
     language_server-protocol (3.17.0.3)
     method_source (1.0.0)
     multi_json (1.15.0)
+    net-http (0.4.1)
+      uri
     os (1.1.4)
     parallel (1.24.0)
-    parser (3.3.0.0)
+    parser (3.3.0.5)
       ast (~> 2.4.1)
       racc
     pry (0.14.2)
@@ -49,13 +58,13 @@ GEM
     public_suffix (5.0.4)
     racc (1.7.3)
     rainbow (3.1.1)
-    regexp_parser (2.8.3)
+    regexp_parser (2.9.0)
     rexml (3.2.6)
-    rubocop (1.59.0)
+    rubocop (1.60.1)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.2.2.4)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
@@ -65,21 +74,24 @@ GEM
     rubocop-ast (1.30.0)
       parser (>= 3.2.1.0)
     ruby-progressbar (1.13.0)
-    ruby2_keywords (0.0.5)
     signet (0.18.0)
       addressable (~> 2.8)
       faraday (>= 0.17.5, < 3.a)
       jwt (>= 1.5, < 3.0)
       multi_json (~> 1.10)
+    typhoeus (1.4.1)
+      ethon (>= 0.9.0)
     unicode-display_width (2.5.0)
+    uri (0.13.0)
 
 PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
+  dotenv (~> 2.8, >= 2.8.1)
   gemini-ai!
   pry-byebug (~> 3.10, >= 3.10.1)
-  rubocop (~> 1.58)
+  rubocop (~> 1.60, >= 1.60.1)
 
 BUNDLED WITH
    2.4.22

data/README.md

@@ -9,7 +9,7 @@ A Ruby Gem for interacting with [Gemini](https://deepmind.google/technologies/ge
 ## TL;DR and Quick Start
 
 ```ruby
-gem 'gemini-ai', '~> 3.1.2'
+gem 'gemini-ai', '~> 3.2.0'
 ```
 
 ```ruby
@@ -79,6 +79,7 @@ Result:
         - [Option 2: Service Account Credentials File (Vertex AI API)](#option-2-service-account-credentials-file-vertex-ai-api)
         - [Option 3: Application Default Credentials (Vertex AI API)](#option-3-application-default-credentials-vertex-ai-api)
         - [Required Data](#required-data)
+    - [Custom Version](#custom-version)
 - [Usage](#usage)
     - [Client](#client)
     - [Methods](#methods)
@@ -97,6 +98,7 @@ Result:
     - [Tools (Functions) Calling](#tools-functions-calling)
     - [New Functionalities and APIs](#new-functionalities-and-apis)
     - [Request Options](#request-options)
+        - [Adapter](#adapter)
         - [Timeout](#timeout)
     - [Error Handling](#error-handling)
         - [Rescuing](#rescuing)
@@ -114,11 +116,11 @@ Result:
 ### Installing
 
 ```sh
-gem install gemini-ai -v 3.1.2
+gem install gemini-ai -v 3.2.0
 ```
 
 ```sh
-gem 'gemini-ai', '~> 3.1.2'
+gem 'gemini-ai', '~> 3.2.0'
 ```
 
 ### Credentials
@@ -270,6 +272,43 @@ You might want to explicitly set a Google Cloud Project ID, which you can do as
 }
 ```
 
+### Custom Version
+
+By default, the gem uses the `v1` version of the APIs. You may want to use a different version:
+
+```ruby
+# With an API key
+client = Gemini.new(
+  credentials: {
+    service: 'generative-language-api',
+    api_key: ENV['GOOGLE_API_KEY'],
+    version: 'v1beta'
+  },
+  options: { model: 'gemini-pro', server_sent_events: true }
+)
+
+# With a Service Account Credentials File
+client = Gemini.new(
+  credentials: {
+    service: 'vertex-ai-api',
+    file_path: 'google-credentials.json',
+    region: 'us-east4',
+    version: 'v1beta'
+  },
+  options: { model: 'gemini-pro', server_sent_events: true }
+)
+
+# With Application Default Credentials
+client = Gemini.new(
+  credentials: {
+    service: 'vertex-ai-api',
+    region: 'us-east4',
+    version: 'v1beta'
+  },
+  options: { model: 'gemini-pro', server_sent_events: true }
+)
+```
+
 ## Usage
 
 ### Client
@@ -876,6 +915,24 @@ result = client.request(
 
 ### Request Options
 
+#### Adapter
+
+To enable streaming, the gem uses [Faraday](https://github.com/lostisland/faraday) with the [Typhoeus](https://github.com/typhoeus/typhoeus) adapter by default.
+
+You can use a different adapter if you want:
+
+```ruby
+require 'faraday/net_http'
+
+client = Gemini.new(
+  credentials: { service: 'vertex-ai-api', region: 'us-east4' },
+  options: {
+    model: 'gemini-pro',
+    connection: { adapter: :net_http }
+  }
+)
+```
+
 #### Timeout
 
 You can set the maximum number of seconds to wait for the request to complete with the `timeout` option:
@@ -967,6 +1024,8 @@ RequestError
 ```bash
 bundle
 rubocop -A
+
+bundle exec ruby spec/tasks/run-client.rb
 ```
 
 ### Purpose
@@ -980,7 +1039,7 @@ gem build gemini-ai.gemspec
 
 gem signin
 
-gem push gemini-ai-3.1.2.gem
+gem push gemini-ai-3.2.0.gem
 ```
 
 ### Updating the README

data/controllers/client.rb

@@ -2,17 +2,28 @@
 
 require 'event_stream_parser'
 require 'faraday'
+require 'faraday/typhoeus'
 require 'json'
 require 'googleauth'
 
-require_relative '../ports/dsl/gemini-ai/errors'
+require_relative '../components/errors'
 
 module Gemini
   module Controllers
     class Client
       ALLOWED_REQUEST_OPTIONS = %i[timeout open_timeout read_timeout write_timeout].freeze
 
+      DEFAULT_FARADAY_ADAPTER = :typhoeus
+
+      DEFAULT_SERVICE_VERSION = 'v1'
+
       def initialize(config)
+        @service = config[:credentials][:service]
+
+        unless %w[vertex-ai-api generative-language-api].include?(@service)
+          raise Errors::UnsupportedServiceError, "Unsupported service: #{@service}"
+        end
+
         if config[:credentials][:api_key]
           @authentication = :api_key
           @api_key = config[:credentials][:api_key]
@@ -30,24 +41,24 @@ module Gemini
         if @authentication == :service_account || @authentication == :default_credentials
           @project_id = config[:credentials][:project_id] || @authorizer.project_id || @authorizer.quota_project_id
 
-          raise MissingProjectIdError, 'Could not determine project_id, which is required.' if @project_id.nil?
+          raise Errors::MissingProjectIdError, 'Could not determine project_id, which is required.' if @project_id.nil?
         end
 
-        @service = config[:credentials][:service]
+        @service_version = config.dig(:credentials, :version) || DEFAULT_SERVICE_VERSION
 
         @address = case @service
                    when 'vertex-ai-api'
-                     "https://#{config[:credentials][:region]}-aiplatform.googleapis.com/v1/projects/#{@project_id}/locations/#{config[:credentials][:region]}/publishers/google/models/#{config[:options][:model]}"
+                     "https://#{config[:credentials][:region]}-aiplatform.googleapis.com/#{@service_version}/projects/#{@project_id}/locations/#{config[:credentials][:region]}/publishers/google/models/#{config[:options][:model]}"
                    when 'generative-language-api'
-                     "https://generativelanguage.googleapis.com/v1/models/#{config[:options][:model]}"
-                   else
-                     raise UnsupportedServiceError, "Unsupported service: #{@service}"
+                     "https://generativelanguage.googleapis.com/#{@service_version}/models/#{config[:options][:model]}"
                    end
 
         @server_sent_events = config.dig(:options, :server_sent_events)
 
         @request_options = config.dig(:options, :connection, :request)
 
+        @faraday_adapter = config.dig(:options, :connection, :adapter) || DEFAULT_FARADAY_ADAPTER
+
         @request_options = if @request_options.is_a?(Hash)
                              @request_options.select do |key, _|
                                ALLOWED_REQUEST_OPTIONS.include?(key)
@@ -80,13 +91,14 @@ module Gemini
         url += "?#{params.join('&')}" if params.size.positive?
 
         if !callback.nil? && !server_sent_events_enabled
-          raise BlockWithoutServerSentEventsError,
+          raise Errors::BlockWithoutServerSentEventsError,
                 'You are trying to use a block without Server Sent Events (SSE) enabled.'
         end
 
         results = []
 
         response = Faraday.new(request: @request_options) do |faraday|
+          faraday.adapter @faraday_adapter
           faraday.response :raise_error
         end.post do |request|
           request.url url
@@ -98,6 +110,9 @@ module Gemini
           request.body = payload.to_json
 
           if server_sent_events_enabled
+
+            partial_json = ''
+
             parser = EventStreamParser::Parser.new
 
             request.options.on_data = proc do |chunk, bytes, env|
@@ -107,20 +122,27 @@ module Gemini
               end
 
               parser.feed(chunk) do |type, data, id, reconnection_time|
-                parsed_data = safe_parse_json(data)
-                result = {
-                  event: safe_parse_json(data),
-                  parsed: { type:, data:, id:, reconnection_time: },
-                  raw: { chunk:, bytes:, env: }
-                }
+                partial_json += data
+
+                parsed_json = safe_parse_json(partial_json)
+
+                if parsed_json
+                  result = {
+                    event: parsed_json,
+                    parsed: { type:, data:, id:, reconnection_time: },
+                    raw: { chunk:, bytes:, env: }
+                  }
+
+                  callback.call(result[:event], result[:parsed], result[:raw]) unless callback.nil?
 
-                callback.call(result[:event], result[:parsed], result[:raw]) unless callback.nil?
+                  results << result
 
-                results << result
+                  partial_json = ''
 
-                if parsed_data['candidates']
-                  parsed_data['candidates'].find do |candidate|
-                    !candidate['finishReason'].nil? && candidate['finishReason'] != ''
+                  if parsed_json['candidates']
+                    parsed_json['candidates'].find do |candidate|
+                      !candidate['finishReason'].nil? && candidate['finishReason'] != ''
+                    end
                   end
                 end
               end
@@ -132,13 +154,13 @@ module Gemini
 
         results.map { |result| result[:event] }
       rescue Faraday::ServerError => e
-        raise RequestError.new(e.message, request: e, payload:)
+        raise Errors::RequestError.new(e.message, request: e, payload:)
       end
 
       def safe_parse_json(raw)
-        raw.start_with?('{', '[') ? JSON.parse(raw) : raw
+        raw.to_s.lstrip.start_with?('{', '[') ? JSON.parse(raw) : nil
       rescue JSON::ParserError
-        raw
+        nil
       end
     end
   end

data/gemini-ai.gemspec

@@ -30,8 +30,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['ports/dsl']
 
   spec.add_dependency 'event_stream_parser', '~> 1.0'
-  spec.add_dependency 'faraday', '~> 2.8', '>= 2.8.1'
+  spec.add_dependency 'faraday', '~> 2.9'
+  spec.add_dependency 'faraday-typhoeus', '~> 1.1'
   spec.add_dependency 'googleauth', '~> 1.8'
+  spec.add_dependency 'typhoeus', '~> 1.4', '>= 1.4.1'
 
   spec.metadata['rubygems_mfa_required'] = 'true'
 end

data/static/gem.rb

@@ -3,7 +3,7 @@
 module Gemini
   GEM = {
     name: 'gemini-ai',
-    version: '3.1.2',
+    version: '3.2.0',
     author: 'gbaptista',
     summary: "Interact with Google's Gemini AI.",
     description: "A Ruby Gem for interacting with Gemini through Vertex AI, Generative Language API, or AI Studio, Google's generative AI services.",

data/template.md

@@ -9,7 +9,7 @@ A Ruby Gem for interacting with [Gemini](https://deepmind.google/technologies/ge
 ## TL;DR and Quick Start
 
 ```ruby
-gem 'gemini-ai', '~> 3.1.2'
+gem 'gemini-ai', '~> 3.2.0'
 ```
 
 ```ruby
@@ -77,11 +77,11 @@ Result:
 ### Installing
 
 ```sh
-gem install gemini-ai -v 3.1.2
+gem install gemini-ai -v 3.2.0
 ```
 
 ```sh
-gem 'gemini-ai', '~> 3.1.2'
+gem 'gemini-ai', '~> 3.2.0'
 ```
 
 ### Credentials
@@ -233,6 +233,43 @@ You might want to explicitly set a Google Cloud Project ID, which you can do as
 }
 ```
 
+### Custom Version
+
+By default, the gem uses the `v1` version of the APIs. You may want to use a different version:
+
+```ruby
+# With an API key
+client = Gemini.new(
+  credentials: {
+    service: 'generative-language-api',
+    api_key: ENV['GOOGLE_API_KEY'],
+    version: 'v1beta'
+  },
+  options: { model: 'gemini-pro', server_sent_events: true }
+)
+
+# With a Service Account Credentials File
+client = Gemini.new(
+  credentials: {
+    service: 'vertex-ai-api',
+    file_path: 'google-credentials.json',
+    region: 'us-east4',
+    version: 'v1beta'
+  },
+  options: { model: 'gemini-pro', server_sent_events: true }
+)
+
+# With Application Default Credentials
+client = Gemini.new(
+  credentials: {
+    service: 'vertex-ai-api',
+    region: 'us-east4',
+    version: 'v1beta'
+  },
+  options: { model: 'gemini-pro', server_sent_events: true }
+)
+```
+
 ## Usage
 
 ### Client
@@ -839,6 +876,24 @@ result = client.request(
 
 ### Request Options
 
+#### Adapter
+
+To enable streaming, the gem uses [Faraday](https://github.com/lostisland/faraday) with the [Typhoeus](https://github.com/typhoeus/typhoeus) adapter by default.
+
+You can use a different adapter if you want:
+
+```ruby
+require 'faraday/net_http'
+
+client = Gemini.new(
+  credentials: { service: 'vertex-ai-api', region: 'us-east4' },
+  options: {
+    model: 'gemini-pro',
+    connection: { adapter: :net_http }
+  }
+)
+```
+
 #### Timeout
 
 You can set the maximum number of seconds to wait for the request to complete with the `timeout` option:
@@ -930,6 +985,8 @@ RequestError
 ```bash
 bundle
 rubocop -A
+
+bundle exec ruby spec/tasks/run-client.rb
 ```
 
 ### Purpose
@@ -943,7 +1000,7 @@ gem build gemini-ai.gemspec
 
 gem signin
 
-gem push gemini-ai-3.1.2.gem
+gem push gemini-ai-3.2.0.gem
 ```
 
 ### Updating the README

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gemini-ai
 version: !ruby/object:Gem::Version
-  version: 3.1.2
+  version: 3.2.0
 platform: ruby
 authors:
 - gbaptista
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-06 00:00:00.000000000 Z
+date: 2024-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: event_stream_parser
@@ -30,20 +30,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.8'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.8.1
+        version: '2.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.8'
-    - - ">="
+        version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: faraday-typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.8.1
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: googleauth
   requirement: !ruby/object:Gem::Requirement
@@ -58,9 +66,29 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.1
 description: A Ruby Gem for interacting with Gemini through Vertex AI, Generative
   Language API, or AI Studio, Google's generative AI services.
-email: 
+email:
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -88,7 +116,7 @@ metadata:
   homepage_uri: https://github.com/gbaptista/gemini-ai
   source_code_uri: https://github.com/gbaptista/gemini-ai
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - ports/dsl
@@ -104,7 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.3.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Interact with Google's Gemini AI.
 test_files: []