maritaca-ai 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d09d3d7f30a05367ba9488b60754235fb4ecd4ad204e699aa7b7035a75329d4b
-  data.tar.gz: f235d41d277a28ca87c6dca8037e8bb706145cf75e46386ac40e39ba28f945cf
+  metadata.gz: 6303b41bc438b8e903a651e906e695cca755c34820cb75c66a9f669b2b8bedc4
+  data.tar.gz: cf98f0c7cdd2580885e681077fb57d15c78b68d6908176bc1cff8b737adff174
 SHA512:
-  metadata.gz: 7b2ef8109622f102f41f2a14b1c21177c5ffa0af47417b5b0d17b61f334fe32e336ae25a5fb6cc9d08c31d60f6055cde42f9ac2503169abaa0bc6ee097bc4bca
-  data.tar.gz: 5da080135ef573549d4948c4b242dd4bc840be4db30b0313a5608f36613cd8e1cd00a1b5db503d65f2dad7ac195a411617ad8c43bae5ebd998d582fb8f374ad1
+  metadata.gz: e2107ca61810c3ac4c0ef71955cfd998b71451a6dd2c0ef91a3442448a38f0594d4791687c5852bf668736c5f5a3b9f954932f601cd7629c8e871592cc8a7002
+  data.tar.gz: bde4023b33d3afbd36cbe183a60c14fd558135d99f323686a8130b98e601d9910af4e3d81f97a08a49ffd51d1ecbec68704d3772c86c6f2a2fdaa27f982335d1

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.2'
 end

data/Gemfile.lock

@@ -1,26 +1,34 @@
 PATH
   remote: .
   specs:
-    maritaca-ai (1.0.0)
-      faraday (~> 2.8, >= 2.8.1)
+    maritaca-ai (1.1.0)
+      faraday (~> 2.9)
+      faraday-typhoeus (~> 1.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
-    base64 (0.2.0)
     byebug (11.1.3)
     coderay (1.1.3)
-    faraday (2.8.1)
-      base64
-      faraday-net_http (>= 2.0, < 3.1)
-      ruby2_keywords (>= 0.0.4)
-    faraday-net_http (3.0.2)
+    dotenv (2.8.1)
+    ethon (0.16.0)
+      ffi (>= 1.15.0)
+    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)
     json (2.7.1)
     language_server-protocol (3.17.0.3)
     method_source (1.0.0)
+    net-http (0.4.1)
+      uri
     parallel (1.24.0)
-    parser (3.2.2.4)
+    parser (3.3.0.5)
       ast (~> 2.4.1)
       racc
     pry (0.14.2)
@@ -31,13 +39,13 @@ GEM
       pry (>= 0.13, < 0.15)
     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.2)
       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)
@@ -47,16 +55,19 @@ GEM
     rubocop-ast (1.30.0)
       parser (>= 3.2.1.0)
     ruby-progressbar (1.13.0)
-    ruby2_keywords (0.0.5)
+    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)
   maritaca-ai!
   pry-byebug (~> 3.10, >= 3.10.1)
-  rubocop (~> 1.58)
+  rubocop (~> 1.60, >= 1.60.2)
 
 BUNDLED WITH
    2.4.22

data/README.md

@@ -9,7 +9,7 @@ A Ruby gem for interacting with [MariTalk](https://chat.maritaca.ai) from [Marit
 ## TL;DR and Quick Start
 
 ```ruby
-gem 'maritaca-ai', '~> 1.0.0'
+gem 'maritaca-ai', '~> 1.1.0'
 ```
 
 ```ruby
@@ -36,27 +36,28 @@ Result:
 - [TL;DR and Quick Start](#tldr-and-quick-start)
 - [Index](#index)
 - [Setup](#setup)
-    - [Installing](#installing)
-    - [Credentials](#credentials)
+  - [Installing](#installing)
+  - [Credentials](#credentials)
 - [Usage](#usage)
-    - [Client](#client)
-        - [Custom Address](#custom-address)
-    - [Methods](#methods)
-        - [chat_inference](#chat_inference)
-        - [Chat](#chat)
-        - [Back-and-Forth Conversations](#back-and-forth-conversations)
-        - [Without Chat](#without-chat)
-    - [New Functionalities and APIs](#new-functionalities-and-apis)
-    - [Request Options](#request-options)
-        - [Timeout](#timeout)
-    - [Error Handling](#error-handling)
-        - [Rescuing](#rescuing)
-        - [For Short](#for-short)
-        - [Errors](#errors)
+  - [Client](#client)
+    - [Custom Address](#custom-address)
+  - [Methods](#methods)
+    - [chat_inference](#chat_inference)
+      - [Chat](#chat)
+      - [Back-and-Forth Conversations](#back-and-forth-conversations)
+      - [Without Chat](#without-chat)
+  - [New Functionalities and APIs](#new-functionalities-and-apis)
+  - [Request Options](#request-options)
+    - [Adapter](#adapter)
+    - [Timeout](#timeout)
+  - [Error Handling](#error-handling)
+    - [Rescuing](#rescuing)
+    - [For Short](#for-short)
+    - [Errors](#errors)
 - [Development](#development)
-    - [Purpose](#purpose)
-    - [Publish to RubyGems](#publish-to-rubygems)
-    - [Updating the README](#updating-the-readme)
+  - [Purpose](#purpose)
+  - [Publish to RubyGems](#publish-to-rubygems)
+  - [Updating the README](#updating-the-readme)
 - [Resources and References](#resources-and-references)
 - [Disclaimer](#disclaimer)
 
@@ -65,11 +66,11 @@ Result:
 ### Installing
 
 ```sh
-gem install maritaca-ai -v 1.0.0
+gem install maritaca-ai -v 1.1.0
 ```
 
 ```sh
-gem 'maritaca-ai', '~> 1.0.0'
+gem 'maritaca-ai', '~> 1.1.0'
 ```
 
 ### Credentials
@@ -116,7 +117,7 @@ client = Maritaca.new(
 
 #### chat_inference
 
-#### Chat
+##### Chat
 
 ```ruby
 result = client.chat_inference(
@@ -131,7 +132,7 @@ Result:
 { 'answer' => 'Oi! Como posso ajudá-lo(a) hoje?' }
 ```
 
-#### Back-and-Forth Conversations
+##### Back-and-Forth Conversations
 
 To maintain a back-and-forth conversation, you need to append the received responses and build a history for your requests:
 
@@ -152,7 +153,7 @@ Result:
 { 'answer' => 'Seu nome é Tamanduá.' }
 ```
 
-#### Without Chat
+##### Without Chat
 
 You can prompt the model without using chat mode:
 
@@ -187,6 +188,21 @@ result = client.request(
 
 ### Request Options
 
+#### Adapter
+
+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 = Maritaca.new(
+  credentials: { api_key: ENV['MARITACA_API_KEY'] },
+  options: { connection: { adapter: :net_http } }
+)
+```
+
 #### Timeout
 
 You can set the maximum number of seconds to wait for the request to complete with the `timeout` option:
@@ -275,6 +291,8 @@ RequestError
 ```bash
 bundle
 rubocop -A
+
+bundle exec ruby spec/tasks/run-client.rb
 ```
 
 ### Purpose
@@ -288,7 +306,7 @@ gem build maritaca-ai.gemspec
 
 gem signin
 
-gem push maritaca-ai-1.0.0.gem
+gem push maritaca-ai-1.1.0.gem
 ```
 
 ### Updating the README

data/controllers/client.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require 'event_stream_parser'
 require 'faraday'
+require 'faraday/typhoeus'
 require 'json'
 
-require_relative '../ports/dsl/maritaca-ai/errors'
+require_relative '../components/errors'
 
 module Maritaca
   module Controllers
@@ -13,6 +13,8 @@ module Maritaca
 
       ALLOWED_REQUEST_OPTIONS = %i[timeout open_timeout read_timeout write_timeout].freeze
 
+      DEFAULT_FARADAY_ADAPTER = :typhoeus
+
       def initialize(config)
         @api_key = config.dig(:credentials, :api_key)
         @server_sent_events = config.dig(:options, :server_sent_events)
@@ -24,7 +26,7 @@ module Maritaca
                    end
 
         if @api_key.nil? && @address == "#{DEFAULT_ADDRESS}/"
-          raise MissingAPIKeyError, 'Missing API Key, which is required.'
+          raise Errors::MissingAPIKeyError, 'Missing API Key, which is required.'
         end
 
         @request_options = config.dig(:options, :connection, :request)
@@ -36,6 +38,8 @@ module Maritaca
                            else
                              {}
                            end
+
+        @faraday_adapter = config.dig(:options, :connection, :adapter) || DEFAULT_FARADAY_ADAPTER
       end
 
       def chat_inference(payload, server_sent_events: nil, &callback)
@@ -47,7 +51,7 @@ module Maritaca
         url = "#{@address}#{path}"
 
         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
 
@@ -58,6 +62,7 @@ module Maritaca
         partial_json = ''
 
         response = Faraday.new(request: @request_options) do |faraday|
+          faraday.adapter @faraday_adapter
           faraday.response :raise_error
         end.send(method_to_call) do |request|
           request.url url
@@ -95,7 +100,7 @@ module Maritaca
 
         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_with_fallback_to_raw(raw)

data/maritaca-ai.gemspec

@@ -29,7 +29,8 @@ Gem::Specification.new do |spec|
 
   spec.require_paths = ['ports/dsl']
 
-  spec.add_dependency 'faraday', '~> 2.8', '>= 2.8.1'
+  spec.add_dependency 'faraday', '~> 2.9'
+  spec.add_dependency 'faraday-typhoeus', '~> 1.1'
 
   spec.metadata['rubygems_mfa_required'] = 'true'
 end

data/static/gem.rb

@@ -3,7 +3,7 @@
 module Maritaca
   GEM = {
     name: 'maritaca-ai',
-    version: '1.0.0',
+    version: '1.1.0',
     author: 'gbaptista',
     summary: 'Interact with Maritaca AI.',
     description: "A Ruby gem for interacting with Maritaca AI's large language models.",

data/tasks/generate-readme.clj

@@ -23,7 +23,7 @@
                              (remove nil?))]
     (->> processed-lines
          (map (fn [{:keys [level title link]}]
-                (str (apply str (repeat (* 4 (- level 2)) " "))
+                (str (apply str (repeat (* 2 (- level 2)) " "))
                      "- ["
                      title
                      "](#"

data/template.md

@@ -9,7 +9,7 @@ A Ruby gem for interacting with [MariTalk](https://chat.maritaca.ai) from [Marit
 ## TL;DR and Quick Start
 
 ```ruby
-gem 'maritaca-ai', '~> 1.0.0'
+gem 'maritaca-ai', '~> 1.1.0'
 ```
 
 ```ruby
@@ -40,11 +40,11 @@ Result:
 ### Installing
 
 ```sh
-gem install maritaca-ai -v 1.0.0
+gem install maritaca-ai -v 1.1.0
 ```
 
 ```sh
-gem 'maritaca-ai', '~> 1.0.0'
+gem 'maritaca-ai', '~> 1.1.0'
 ```
 
 ### Credentials
@@ -91,7 +91,7 @@ client = Maritaca.new(
 
 #### chat_inference
 
-#### Chat
+##### Chat
 
 ```ruby
 result = client.chat_inference(
@@ -106,7 +106,7 @@ Result:
 { 'answer' => 'Oi! Como posso ajudá-lo(a) hoje?' }
 ```
 
-#### Back-and-Forth Conversations
+##### Back-and-Forth Conversations
 
 To maintain a back-and-forth conversation, you need to append the received responses and build a history for your requests:
 
@@ -127,7 +127,7 @@ Result:
 { 'answer' => 'Seu nome é Tamanduá.' }
 ```
 
-#### Without Chat
+##### Without Chat
 
 You can prompt the model without using chat mode:
 
@@ -162,6 +162,21 @@ result = client.request(
 
 ### Request Options
 
+#### Adapter
+
+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 = Maritaca.new(
+  credentials: { api_key: ENV['MARITACA_API_KEY'] },
+  options: { connection: { adapter: :net_http } }
+)
+```
+
 #### Timeout
 
 You can set the maximum number of seconds to wait for the request to complete with the `timeout` option:
@@ -250,6 +265,8 @@ RequestError
 ```bash
 bundle
 rubocop -A
+
+bundle exec ruby spec/tasks/run-client.rb
 ```
 
 ### Purpose
@@ -263,7 +280,7 @@ gem build maritaca-ai.gemspec
 
 gem signin
 
-gem push maritaca-ai-1.0.0.gem
+gem push maritaca-ai-1.1.0.gem
 ```
 
 ### Updating the README

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: maritaca-ai
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - gbaptista
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-30 00:00:00.000000000 Z
+date: 2024-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -16,22 +16,30 @@ 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: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.8.1
+        version: '1.1'
 description: A Ruby gem for interacting with Maritaca AI's large language models.
-email: 
+email:
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -59,7 +67,7 @@ metadata:
   homepage_uri: https://github.com/gbaptista/maritaca-ai
   source_code_uri: https://github.com/gbaptista/maritaca-ai
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - ports/dsl
@@ -74,8 +82,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
 summary: Interact with Maritaca AI.
 test_files: []