ollama-ruby 1.18.0 → 1.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b59a75052a3d4f15cc99f14a6ffa1172140f7bbd4ef474e20d986843ba02247
-  data.tar.gz: ed28da23aa8242a86d6b4c3c1aa1d9b10fabb683a074dc451e49a0e7cdafd8bd
+  metadata.gz: dcb4d954bc66b999983fbb02192c600d1ee1f5e052ae7808e5d287268cc54eb3
+  data.tar.gz: 3c7a867320432d99f091b11c3955a3ca9f2b66888340effae91bf34f21768e8c
 SHA512:
-  metadata.gz: c9085a100ed588c9846c4497227812fd6ee62a7ec2023f07c124dd49ddb5418ae0d0634936e44ea764e24a7f18b7c1b7799928daf1dcfbf030e11759b44409eb
-  data.tar.gz: 8a222ef6114c2e22c7ae6b8ad1d65c5ad638318088aa31580f5de45e2c4a63700fb124b6e59d0a39824a3757a4c909507f8c51c85786be0d6c2ff35c1010c585
+  metadata.gz: f0d81e6b9df50f005efed07afc8dfc82fad1f072a293276526ff35f075bfc6c06d526e49a0a15d340ed84d1b470a27ee62ecd4754a776ceacc8890f7a6cc08c6
+  data.tar.gz: a9f0c6c8cf62f75dea4f92a02f1c40b1f7b92034b69e83ba34a6282fd01df6126c14f2abd14987bd4d996023314675ede5cbbec8ca04b106d53807c971f710a4

data/CHANGES.md

@@ -1,12 +1,46 @@
 # Changes
 
+## 2026-03-04 v1.19.0
+
+- Added API key handling to the Ollama client: introduced a private `api_key`
+  attribute, interpolated it into request headers as `"Bearer #@api_key"`, and
+  merged the field into the client configuration. Updated `bin/ollama_cli` and
+  `bin/ollama_console` to accept an optional `api_key` from environment
+  variables, and extended `spec/ollama/client_spec.rb` to test this
+  functionality.
+- Implemented an interval option for `ollama_ps`: added `require
+  'term/ansicolor'`, updated help text to include the flag `-i INTERVAL`,
+  parsed the `?i` option, and added a loop that clears the terminal with
+  `Term::ANSIColor.clear_screen`, prints the model table via
+  `ps_table(models)`, sleeps for the specified interval, and repeats while the
+  interval is greater than zero.
+- Improved progress output formatting: updated
+  `lib/ollama/handlers/progress.rb` to format progress bytes using
+  `Tins::Unit.format(_1, format: '%.2f %U', unit: ?B, prefix: :iec_uc)` and
+  adjusted the `message` method to include `unit` and `prefix` options.
+- Updated dependencies and test harness: removed system‑wide gem updates from
+  `.all_images.yml`, replaced `bundle update --all` with `bundle exec rake
+  spec`, added `before:` and `after:` hooks to delete `Gemfile.lock` and echo
+  test results, bumped the `all_images` dev dependency to `~> **0.12**`,
+  updated the `gem_hadar` dev dependency to `>= **2.17.0**`, and set
+  `rubygems_version` to **4.0.3** in `ollama-ruby.gemspec`.
+- Added changelog configuration to the Rakefile: created a `changelog` block
+  with `filename` set to `'CHANGES.md'` to enable automated changelog
+  generation.
+- Updated Ruby image build matrix: enabled the `ruby:4.0-rc-alpine` image in
+  the build matrix with the `*script` template, and later switched the Ruby
+  version from **4.0-rc-alpine** to **4.0-alpine**.
+- Updated the `gem_hadar` development dependency to **2.16.3** or higher to
+  maintain compatibility with newer features and bug fixes.
+
 ## 2025-12-19 v1.18.0
 
 - Updated `gem_hadar` development dependency from version **2.8** to **2.9**
 
 ## 2025-12-19 v1.17.0
 
-- Changed `s.required_ruby_version` in the gemspec from "~> 3.1" to ">= 3.1" to allow usage with **Ruby 3.1** and higher, including **4.0**
+- Changed `s.required_ruby_version` in the gemspec from "~> 3.1" to ">= 3.1" to
+  allow usage with **Ruby 3.1** and higher, including **4.0**
 - Updated `s.rubygems_version` from **3.7.2** to **4.0.2**
 - Replaced `bundle update` with `bundle update --all` in the update command
 - Added **4.0-rc** release candidate to the Ruby version matrix (commented out)
@@ -72,10 +106,13 @@
 ## 2025-11-30 v1.12.0
 
 - `ollama_cli`
-    - Added `-i` flag to display Ollama server version using `ollama.version.version`
-    - Refactored model options handling to use `Ollama::Options.from_hash` or `Ollama::Options.new`
+    - Added `-i` flag to display Ollama server version using
+      `ollama.version.version`
+    - Refactored model options handling to use `Ollama::Options.from_hash` or
+      `Ollama::Options.new`
     - Stored client configuration in `ollama` variable for reuse
-    - Added `-d` flag for debug mode in `ollama_cli` instead of using environment variable
+    - Added `-d` flag for debug mode in `ollama_cli` instead of using
+      environment variable
 - Included `Ollama::DTO` in `Client::Config` class for consistent behavior
 - Improved documentation formatting in `dto.rb` file
 - Added documentation that `think` can be "high", "medium", "low" instead of just `true`
@@ -502,7 +539,7 @@ and introduced new context files for project structure documentation in
   + Normalizes URL by decoding URI components, removing anchors, and escaping special characters
   + `excon` method now calls `normalize_url` on the provided URL
   + Added specs for `normalize_url` in `fetcher_spec.rb`
-* Remove Ollama top level Namespace b/c we include it from `ollama_chat`: 
+* Remove Ollama top level Namespace b/c we include it from `ollama_chat`:
   + Removed the top-level namespace
 
 ## 2024-10-18 v0.9.0
@@ -554,7 +591,7 @@ and introduced new context files for project structure documentation in
   + Moved case order
   + Renamed `/collection clear [tag]|change` to `/collection (clear|change)`
   + Improved help message, added /info
-* **Update README.md** 
+* **Update README.md**
   + Update README.md to reflect changed/added commands
 * **Add support for reading PostScript**
   + Extracted `pdf_read` method to read PDF files using `PDF::Reader`
@@ -572,7 +609,7 @@ and introduced new context files for project structure documentation in
   + Updated `choose` method to handle cases better where no entry was chosen
 * **Fix Redis cache expiration logic**
   + Update `set` method to delete key expiration time is less than 1 second.
-* **Update dependencies and add source tracking** 
+* **Update dependencies and add source tracking**
   - Remove `sorted_set` dependency from Rakefile
   - Modify `Ollama::Documents` class to track source of tags
   - Update `Ollama::Utils::Tags` class to include source in tag output and add methods for tracking source
@@ -787,28 +824,28 @@ and introduced new context files for project structure documentation in
 
 * Update dependencies and date in gemspec files:
   - Updated `complex_config` dependency to '~> 0.22'
-* Refactor FollowChat#eval_stats to add bold eval rates
-  * Improve formatting in eval_stats using bold and color for better
+* Refactor `FollowChat#eval_stats` to add bold eval rates
+  * Improve formatting in `eval_stats` using bold and color for better
     readability.
-  * Update import_document and add_image methods to handle nil values
+  * Update `import_document` and `add_image` methods to handle nil values
     correctly.
   * Update width method in utils/width.rb to use uncolor when checking line
     length.
 * Refactor eval stats output in FollowChat class
   - Add indentation to eval stats output for better readability
 * FollowChat evaluation stats refactored
-  - Removed hardcoded eval_stats hash and replaced with method call
+  - Removed hardcoded `eval_stats` hash and replaced with method call
     `eval_stats(response)`
   - Added new method `eval_stats(response)` to calculate evaluation statistics
     - Calculates eval duration, prompt eval duration, total duration, and load
       duration
     - Adds eval count, prompt eval count, eval rate, and prompt eval rate
-* Use default to_s tree representation of config.
-  * Update complex_config dependency to ~> 0.21, >= 0.21.1 in Rakefile
-  * Update complex_config dependency to ~> 0.21, >= 0.21.1 in
+* Use default `to_s` tree representation of config.
+  * Update `complex_config` dependency to ~> 0.21, >= 0.21.1 in Rakefile
+  * Update `complex_config` dependency to ~> 0.21, >= 0.21.1 in
     ollama-ruby.gemspec
 * Update dependencies and configuration display
-  * Update 'complex_config' dependency to '~> 0.21'
+  * Update `complex_config` dependency to '~> 0.21'
   * Change OllamaChatConfig to display configuration as a tree instead of yaml
 * Improve /web search command
   * Update infobar dependency to ~> 0.8
@@ -858,9 +895,10 @@ and introduced new context files for project structure documentation in
   + Updated `/summarize` command to handle cases where summarization fails
   + Fix bug in parsing content type of source document
 * **Refactored Options Class and Usage**
-  + Renamed `options` variable to use `Options[]` method in ollama_chat script
+  + Renamed `options` variable to use `Options[]` method in `ollama_chat`
+    script
   + Added `[](value)` method to Ollama::Options class for casting hashes
-  + Updated options_spec.rb with tests for casting hashes and error handling
+  + Updated `options_spec.rb` with tests for casting hashes and error handling
 * **Refactored Web Search Command**
   + Added support for specifying a page number in `/web` command
   + Updated regular expression to match new format
@@ -870,10 +908,11 @@ and introduced new context files for project structure documentation in
   + Renamed `json_create` method to `from_hash` in Ollama::DTO class
   + Updated `as_json` method to remove now unnecessary hash creation
 * **Message and Tool Spec Changes**
-  + Removed `json_class` from JSON serialization in message_spec
-  + Removed `json_class` from JSON serialization in tool_spec
+  + Removed `json_class` from JSON serialization in `message_spec`
+  + Removed `json_class` from JSON serialization in `tool_spec`
 * **Command Spec Changes**
-  + Removed `json_class` from JSON serialization in various command specs (e.g. generate_spec, pull_spec, etc.)
+  + Removed `json_class` from JSON serialization in various command specs (e.g.
+    `generate_spec`, `pull_spec`, etc.)
 * **Miscellaneous Changes**
   + Improved width calculation for text truncation
   + Updated FollowChat class to display evaluation statistics
@@ -886,26 +925,36 @@ and introduced new context files for project structure documentation in
 
 #### Significant Changes
 
-* **Document Splitting and Embedding Functionality**: Added `Ollama::Documents` class with methods for adding documents, checking existence, deleting documents, and finding similar documents.
+* **Document Splitting and Embedding Functionality**: Added `Ollama::Documents`
+  class with methods for adding documents, checking existence, deleting
+  documents, and finding similar documents.
   + Introduced two types of caches: `MemoryCache` and `RedisCache`
-  + Implemented `SemanticSplitter` class to split text into sentences based on semantic similarity
-* **Improved Ollama Chat Client**: Added support for document embeddings and web/file RAG
+  + Implemented `SemanticSplitter` class to split text into sentences based on
+    semantic similarity
+* **Improved Ollama Chat Client**: Added support for document embeddings and
+  web/file RAG
   + Allowed configuration per yaml file
   + Parse user input for URLs or files to send images to multimodal models
-* **Redis Docker Service**: Set `REDIS_URL` environment variable to `redis://localhost:9736`
+* **Redis Docker Service**: Set `REDIS_URL` environment variable to
+  `redis://localhost:9736`
   + Added Redis service to `docker-compose.yml`
-* **Status Display and Progress Updates**: Added infobar.label = response.status when available
-  + Updated infobar with progress message on each call if total and completed are set
+* **Status Display and Progress Updates**: Added infobar.label =
+  response.status when available
+  + Updated infobar with progress message on each call if total and completed
+    are set
   + Display error message from response.error if present
-* **Refactored Chat Commands**: Simplified regular expression patterns for `/pop`, `/save`, `/load`, and `/image` commands
+* **Refactored Chat Commands**: Simplified regular expression patterns for
+  `/pop`, `/save`, `/load`, and `/image` commands
   + Added whitespace to some command patterns for better readability
 
 #### Other Changes
 
-* Added `Character` and `RecursiveCharacter` splitter classes to split text into chunks based on character separators
+* Added `Character` and `RecursiveCharacter` splitter classes to split text
+  into chunks based on character separators
 * Added RSpec tests for the Ollama::Documents class(es)
-* Updated dependencies and added new methods for calculating breakpoint thresholds and sentence embeddings
-* Added 'ollama_update' to executables in Rakefile
+* Updated dependencies and added new methods for calculating breakpoint
+  thresholds and sentence embeddings
+* Added `ollama_update` to executables in Rakefile
 * Started using webmock
 * Refactored chooser and add fetcher specs
 * Added tests for Ollama::Utils::Fetcher

data/Rakefile

@@ -21,6 +21,10 @@ GemHadar do
   executables << 'ollama_console' << 'ollama_update' << 'ollama_cli' <<
     'ollama_browse' << 'ollama_ps'
 
+  changelog do
+    filename 'CHANGES.md'
+  end
+
   github_workflows(
     'static.yml' => {}
   )
@@ -36,7 +40,7 @@ GemHadar do
   dependency             'ostruct',               '~> 0.0'
   dependency             'terminal-table',        '~> 3.0'
   dependency             'nokogiri',              '~> 1.0'
-  development_dependency 'all_images',            '~> 0.6'
+  development_dependency 'all_images',            '~> 0.12'
   development_dependency 'rspec',                 '~> 3.2'
   development_dependency 'kramdown',              '~> 2.0'
   development_dependency 'webmock'

data/bin/ollama_cli

@@ -44,7 +44,7 @@ module Ollama::Handlers
     # specified output.
     #
     # @param output [IO] the output stream to write markdown content to,
-    # defaults to $stdout
+    #   defaults to $stdout
     def initialize(output: $stdout)
       super
       @output.sync = true
@@ -137,9 +137,10 @@ opts = go 'u:m:M:s:p:P:H:c:I:STdih', defaults: { ?H => 'ChatStart' }
 
 opts[?h] and usage
 
-base_url  = opts[?u] || ENV['OLLAMA_URL'] || 'http://%s' % ENV.fetch('OLLAMA_HOST')
+base_url = opts[?u] || ENV['OLLAMA_URL'] || 'http://%s' % ENV.fetch('OLLAMA_HOST')
+api_key  = ENV['OLLAMA_API_KEY']
 client_config = Client::Config[
-  { base_url:, debug: !!opts[?d] } |
+  { base_url:, api_key:, debug: !!opts[?d] } |
   JSON(get_file_argument(opts[?c], default: ENV['OLLAMA_CLIENT']).full? || '{}')
 ]
 model         = (opts[?m] || ENV['OLLAMA_MODEL']).full? || 'llama3.1'

data/bin/ollama_console

@@ -40,7 +40,17 @@ end
 #
 # @return [ Hash ] a hash containing the merged configuration settings
 def client_config
-  Client::Config[ { base_url: } | JSON(ENV.fetch('OLLAMA_CLIENT', '{}')) ]
+  Client::Config[
+    { base_url:, api_key: } | JSON(ENV.fetch('OLLAMA_CLIENT', '{}')).transform_keys(&:to_sym)
+  ]
+end
+
+# Retrieves the Ollama API key from the environment variable OLLAMA_API_KEY.
+#
+# @return [ String, nil ] the API key value or nil if the environment variable
+#   is not set
+def api_key
+  ENV['OLLAMA_API_KEY']
 end
 
 # The ollama method provides access to a configured Ollama client instance.

data/bin/ollama_ps

@@ -34,6 +34,7 @@
 require 'ollama'
 include Ollama
 require 'terminal-table'
+require 'term/ansicolor'
 require 'tins'
 include Tins::GO
 
@@ -49,6 +50,7 @@ def usage
     Usage: #{File.basename($0)} [OPTIONS]
 
       -f FORMAT      output format: json, yaml, or table (default)
+      -i INTERVAL    output the ps table every INTERVAL seconds
       -h             this help
 
   EOT
@@ -188,7 +190,7 @@ def ps_table(models)
   puts table
 end
 
-opts = go 'f:h'
+opts = go 'f:i:h'
 
 opts[?h] and usage
 
@@ -200,5 +202,11 @@ when 'json'
 when 'yaml'
   YAML.dump(interpret_models(models), STDOUT)
 else
-  ps_table(interpret_models(models))
+  n = opts[?i].to_i
+  begin
+    print Term::ANSIColor.clear_screen, Term::ANSIColor.move_home if n > 0
+    ps_table(interpret_models(models))
+    n == 0 and break
+    sleep n
+  end while n
 end

data/lib/ollama/client/command.rb

@@ -27,7 +27,7 @@ module Ollama::Client::Command
     # @param stream_handler [ Class, nil ] the handler class to use for streaming responses, if applicable
     #
     # @note Create Command `name`, if `stream` was true, set `stream_handler`
-    # as default, otherwise `default_handler`.
+    #   as default, otherwise `default_handler`.
     #
     # @return [ self ] returns the receiver after defining the command method
     def command(name, default_handler:, stream_handler: nil)

data/lib/ollama/client/configuration/config.rb

@@ -66,7 +66,7 @@ module Ollama::Client::Configuration
     # @param value [ Hash ] a hash containing the attribute names and their values
     #
     # @return [ self ] a new instance of the class initialized with the provided
-    # attributes
+    #   attributes
     def self.[](value)
       new(**value.to_h)
     end
@@ -77,6 +77,12 @@ module Ollama::Client::Configuration
     # @attr [ URI ] the new base URL to be set for API requests
     attr_accessor :base_url
 
+    # The api_key attribute allows setting and retrieving the API key for
+    # Ollama API authentication.
+    #
+    # @attr [ String, nil ] the API key used for authenticating requests
+    attr_accessor :api_key
+
     # The output attribute accessor allows reading and setting the output stream
     # used for handling responses and messages.
     #
@@ -126,13 +132,14 @@ module Ollama::Client::Configuration
     # settings.
 
     # @param config [ Ollama::Client::Configuration::Config ] the configuration
-    # object containing client settings
+    #   object containing client settings
     #
     # @return [ Ollama::Client ] a new client instance configured with the
-    # provided settings
+    #   provided settings
     def configure_with(config)
       new(
         base_url:        config.base_url,
+        api_key:         config.api_key,
         output:          config.output,
         connect_timeout: config.connect_timeout,
         read_timeout:    config.read_timeout,

data/lib/ollama/client.rb

@@ -35,13 +35,14 @@ class Ollama::Client
   # configuration options, making them available for use in subsequent client operations.
   #
   # @param base_url [ String, nil ] the base URL of the Ollama API endpoint, defaults to nil
+  # @param api_key  [ String, nil ] the API key for the Ollama API, defaults to nil
   # @param output [ IO ] the output stream to be used for handling responses, defaults to $stdout
   # @param connect_timeout [ Integer, nil ] the connection timeout value in seconds, defaults to nil
   # @param read_timeout [ Integer, nil ] the read timeout value in seconds, defaults to nil
   # @param write_timeout [ Integer, nil ] the write timeout value in seconds, defaults to nil
   # @param debug [ Boolean, nil ] the debug flag indicating whether debug output is enabled, defaults to nil
   # @param user_agent [ String, nil ] the user agent string to be used for API requests, defaults to nil
-  def initialize(base_url: nil, output: $stdout, connect_timeout: nil, read_timeout: nil, write_timeout: nil, debug: nil, user_agent: nil)
+  def initialize(base_url: nil, api_key: nil, output: $stdout, connect_timeout: nil, read_timeout: nil, write_timeout: nil, debug: nil, user_agent: nil)
     base_url.nil? and base_url = ENV.fetch('OLLAMA_URL') do
       raise ArgumentError,
         'missing :base_url parameter or OLLAMA_URL environment variable'
@@ -52,8 +53,8 @@ class Ollama::Client
     @ssl_verify_peer = base_url.query.to_s.split(?&).inject({}) { |h, l|
       h.merge Hash[*l.split(?=)]
     }['ssl_verify_peer'] != 'false'
-    @base_url, @output, @connect_timeout, @read_timeout, @write_timeout, @debug, @user_agent =
-      base_url, output, connect_timeout, read_timeout, write_timeout, debug, user_agent
+    @base_url, @api_key, @output, @connect_timeout, @read_timeout, @write_timeout, @debug, @user_agent =
+      base_url, api_key, output, connect_timeout, read_timeout, write_timeout, debug, user_agent
   end
 
   # The output attribute accessor allows reading and setting the output stream
@@ -68,6 +69,13 @@ class Ollama::Client
   # @return [ URI ] the base URL configured for API requests
   attr_reader :base_url
 
+  # The api_key attribute reader returns the API key used for authenticating
+  # requests.
+  #
+  # @attr_reader :api_key
+  attr_reader :api_key
+  private :api_key
+
   # The ssl_verify_peer? method checks whether SSL peer verification is enabled.
   #
   # This method returns a boolean value indicating if the client should verify
@@ -217,7 +225,7 @@ class Ollama::Client
     {
       'User-Agent'   => @user_agent || self.class.user_agent,
       'Content-Type' => 'application/json; charset=utf-8',
-    }
+    } | @api_key.full? { { 'Authorization' => "Bearer #@api_key" } }
   end
 
   # The user_agent method generates a formatted user agent string for API requests.

data/lib/ollama/commands/chat.rb

@@ -107,7 +107,7 @@ class Ollama::Commands::Chat
   # scenarios based on the command's configuration.
   #
   # @param handler [ Ollama::Handler ] the handler object responsible for processing API
-  # responses
+  #   responses
   #
   # @return [ self ] returns the current instance after initiating the request
   def perform(handler)

data/lib/ollama/commands/copy.rb

@@ -68,7 +68,7 @@ class Ollama::Commands::Copy
   # copy commands do not support streaming.
   #
   # @param handler [ Ollama::Handler ] the handler object responsible for processing API
-  # responses
+  #   responses
   #
   # @return [ self ] returns the current instance after initiating the request
   def perform(handler)

data/lib/ollama/commands/create.rb

@@ -123,7 +123,7 @@ class Ollama::Commands::Create
   # scenarios based on the command's configuration.
   #
   # @param handler [ Ollama::Handler ] the handler object responsible for processing API
-  # responses
+  #   responses
   #
   # @return [ self ] returns the current instance after initiating the request
   def perform(handler)

data/lib/ollama/commands/delete.rb

@@ -62,7 +62,7 @@ class Ollama::Commands::Delete
   # delete commands do not support streaming.
   #
   # @param handler [ Ollama::Handler ] the handler object responsible for processing API
-  # responses
+  #   responses
   #
   # @return [ self ] returns the current instance after initiating the request
   def perform(handler)

data/lib/ollama/commands/embed.rb

@@ -99,7 +99,7 @@ class Ollama::Commands::Embed
   # embedding commands do not support streaming.
   #
   # @param handler [ Ollama::Handler ] the handler object responsible for processing API
-  # responses
+  #   responses
   #
   # @return [ self ] returns the current instance after initiating the request
   def perform(handler)

data/lib/ollama/commands/embeddings.rb

@@ -82,7 +82,7 @@ class Ollama::Commands::Embeddings
   # embeddings commands do not support streaming.
   #
   # @param handler [ Ollama::Handler ] the handler object responsible for processing API
-  # responses
+  #   responses
   #
   # @return [ self ] returns the current instance after initiating the request
   def perform(handler)

data/lib/ollama/commands/ps.rb

@@ -65,7 +65,7 @@ class Ollama::Commands::Ps
   # ps commands do not support streaming.
   #
   # @param handler [ Ollama::Handler ] the handler object responsible for processing API
-  # responses
+  #   responses
   #
   # @return [ self ] returns the current instance after initiating the request
   def perform(handler)

data/lib/ollama/commands/pull.rb

@@ -10,7 +10,7 @@
 # @param stream_handler [ Class, nil ] the handler class to use for streaming responses, if applicable
 #
 # @note Create Command `name`, if `stream` was true, set `stream_handler`
-# as default, otherwise `default_handler`.
+#   as default, otherwise `default_handler`.
 #
 # @return [ self ] returns the receiver after defining the command method
 class Ollama::Commands::Pull
@@ -81,7 +81,7 @@ class Ollama::Commands::Pull
   # non-streaming scenarios based on the command's configuration.
   #
   # @param handler [ Ollama::Handler ] the handler object responsible for processing API
-  # responses
+  #   responses
   #
   # @return [ self ] returns the current instance after initiating the request
   def perform(handler)

data/lib/ollama/commands/tags.rb

@@ -40,7 +40,7 @@ class Ollama::Commands::Tags
   # associated with the object.
   #
   # @return [ TrueClass, FalseClass ] the streaming behavior flag, indicating
-  # whether streaming is enabled for the command execution
+  #   whether streaming is enabled for the command execution
   attr_reader :stream
 
   # The client attribute writer allows setting the client instance associated

data/lib/ollama/commands/version.rb

@@ -18,7 +18,7 @@ class Ollama::Commands::Version
   # operations.
   #
   # @return [ String ] the API endpoint path '/api/version' for version
-  # requests
+  #   requests
   def self.path
     '/api/version'
   end
@@ -37,7 +37,7 @@ class Ollama::Commands::Version
   # associated with the object.
   #
   # @return [ TrueClass, FalseClass ] the streaming behavior flag, indicating
-  # whether streaming is enabled for the command execution
+  #   whether streaming is enabled for the command execution
   attr_reader :stream
 
   # The client attribute writer allows setting the client instance associated

data/lib/ollama/handlers/collector.rb

@@ -15,7 +15,7 @@ class Ollama::Handlers::Collector
   # output destination and initializes an empty array for collecting responses.
   #
   # @param output [ IO ] the output stream to be used for handling responses,
-  # defaults to $stdout
+  #   defaults to $stdout
   def initialize(output: $stdout)
     super
     @array = []

data/lib/ollama/handlers/concern.rb

@@ -57,7 +57,7 @@ module Ollama::Handlers::Concern
   # in contexts where a proc is expected.
   #
   # @return [ Proc ] a proc that wraps the handler's call method for response
-  # processing
+  #   processing
   def to_proc
     -> response { call(response) }
   end
@@ -67,10 +67,10 @@ module Ollama::Handlers::Concern
     # response.
     #
     # @param response [ Ollama::Response ] the response object to be processed by the
-    # handler
+    #   handler
     #
     # @return [ self ] returns the handler instance itself after processing the
-    # response
+    #   response
     def call(response)
       new.call(response)
     end

data/lib/ollama/handlers/dump_yaml.rb

@@ -19,10 +19,10 @@ class Ollama::Handlers::DumpYAML
   # YAML format for debugging or inspection purposes.
   #
   # @param response [ Ollama::Response ] the response object to be serialized
-  # and output
+  #   and output
   #
   # @return [ self ] returns the handler instance itself after processing the
-  # response
+  #   response
   def call(response)
     @output.puts Psych.dump(response)
     self

data/lib/ollama/handlers/markdown.rb

@@ -36,10 +36,10 @@ class Ollama::Handlers::Markdown
   # single-message display.
   #
   # @param response [ Ollama::Response ] the response object containing content
-  # to be rendered
+  #   to be rendered
   #
   # @return [ self ] returns the handler instance itself after processing the
-  # response
+  #   response
   def call(response)
     if content = response.response || response.message&.content
       if @stream

data/lib/ollama/handlers/progress.rb

@@ -35,10 +35,10 @@ class Ollama::Handlers::Progress
   # ensures proper formatting of output.
   #
   # @param response [ Ollama::Response ] the response object containing
-  # progress information
+  #   progress information
   #
   # @return [ self ] returns the handler instance itself after processing the
-  # response
+  #   response
   def call(response)
     infobar.display.output = @output
     if status = response.status
@@ -80,7 +80,7 @@ class Ollama::Handlers::Progress
   #         time information, and estimated completion details
   def message(current, total)
     progress = '%s/%s' % [ current, total ].map {
-      Tins::Unit.format(_1, format: '%.2f %U')
+      Tins::Unit.format(_1, format: '%.2f %U', unit: ?B, prefix: :iec_uc)
     }
     '%l ' + progress + ' in %te, ETA %e @%E'
   end

data/lib/ollama/handlers/say.rb

@@ -23,7 +23,7 @@ class Ollama::Handlers::Say
   # @param output [ IO, nil ] the output stream to be used for handling responses, defaults to nil
   # @param voice [ String ] the voice to be used for speech synthesis, defaults to 'Samantha'
   # @param interactive [ TrueClass, FalseClass, String, nil ] the interactive
-  # mode setting for speech synthesis, defaults to nil
+  #   mode setting for speech synthesis, defaults to nil
   def initialize(output: nil, voice: 'Samantha', interactive: nil)
     @voice       = voice
     @interactive = interactive
@@ -43,7 +43,7 @@ class Ollama::Handlers::Say
   # associated with the object.
   #
   # @return [ TrueClass, FalseClass, String, nil ] the interactive mode value
-  # stored in the instance variable
+  #   stored in the instance variable
   attr_reader :interactive
 
   # The call method processes a response by printing its content to the output stream.
@@ -107,7 +107,7 @@ class Ollama::Handlers::Say
   #
   # @param voice [ String ] the voice to be used for speech synthesis
   # @param interactive [ TrueClass, FalseClass, String, nil ] the interactive
-  # mode setting for speech synthesis
+  #   mode setting for speech synthesis
   #
   # @return [ Array<String> ] an array containing the command and its arguments
   def command(voice:, interactive:)

data/lib/ollama/handlers/single.rb

@@ -15,7 +15,7 @@ class Ollama::Handlers::Single
   # output destination and initializes an empty array for collecting responses.
   #
   # @param output [ IO ] the output stream to be used for handling responses,
-  # defaults to $stdout
+  #   defaults to $stdout
   def initialize(output: $stdout)
     super
     @array = []

data/lib/ollama/image.rb

@@ -44,7 +44,7 @@ class Ollama::Image
     # @param path [ String, nil ] the optional file path associated with the image
     #
     # @return [ Ollama::Image ] a new Image instance initialized with the
-    # provided data and path
+    #   provided data and path
     def for_base64(data, path: nil)
       obj = new(data)
       obj.path = path
@@ -57,7 +57,7 @@ class Ollama::Image
     # @param path [ String, nil ] the optional file path associated with the image
     #
     # @return [ Ollama::Image ] a new Image instance initialized with the
-    # encoded string data and optional path
+    #   encoded string data and optional path
     def for_string(string, path: nil)
       for_base64(Base64.strict_encode64(string), path:)
     end
@@ -69,7 +69,7 @@ class Ollama::Image
     # @param path [ String, nil ] the optional file path associated with the image
     #
     # @return [ Ollama::Image ] a new Image instance initialized with the IO
-    # object's data and optional path
+    #   object's data and optional path
     def for_io(io, path: nil)
       path ||= io.path
       for_string(io.read, path:)
@@ -81,7 +81,7 @@ class Ollama::Image
     # @param path [ String ] the file system path to the image file
     #
     # @return [ Ollama::Image ] a new Image instance initialized with the
-    # contents of the file at the specified path
+    #   contents of the file at the specified path
     def for_filename(path)
       File.open(path, 'rb') { |io| for_io(io, path:) }
     end
@@ -95,7 +95,7 @@ class Ollama::Image
   # @param other [ Ollama::Image ] the other Image object to compare against
   #
   # @return [ TrueClass, FalseClass ] true if both Image objects have identical
-  # data, false otherwise
+  #   data, false otherwise
   def ==(other)
     @data == other.data
   end

data/lib/ollama/options.rb

@@ -154,7 +154,7 @@ class Ollama::Options
   # @param value [ Hash ] a hash containing the attribute names and their values
   #
   # @return [ self ] a new instance of the class initialized with the provided
-  # attributes
+  #   attributes
   def self.[](value)
     new(**value.to_h)
   end

data/lib/ollama/tool/function/parameters/property.rb

@@ -34,7 +34,7 @@ class Ollama::Tool::Function::Parameters::Property
   # The enum attribute reader returns the enumeration values associated with the object.
   #
   # @return [ Array<String>, nil ] an array of valid string values that the
-  # property can take, or nil if not set
+  #   property can take, or nil if not set
   attr_reader :enum
 
   # The initialize method sets up a new Property instance with the specified

data/lib/ollama/tool/function/parameters.rb

@@ -33,7 +33,7 @@ class Ollama::Tool::Function::Parameters
   # associated with the object.
   #
   # @return [ Array<String>, nil ] an array of required parameter names, or nil
-  # if not set
+  #   if not set
   attr_reader :required
 
   # The initialize method sets up a new Parameters instance with the specified

data/lib/ollama/tool.rb

@@ -23,14 +23,14 @@ class Ollama::Tool
   # The type attribute reader returns the type associated with the tool.
   #
   # @return [ String ] the type of tool, typically 'function' for function
-  # calling capabilities
+  #   calling capabilities
   attr_reader :type
 
   # The function attribute reader returns the function definition associated
   # with the tool.
   #
   # @return [ Hash ] the function definition as a hash, containing details such
-  # as the function's name, description, parameters, and required fields
+  #   as the function's name, description, parameters, and required fields
   attr_reader :function
 
   # The initialize method sets up a new Tool instance with the specified type
@@ -38,7 +38,7 @@ class Ollama::Tool
   #
   # @param type [ String ] the type of tool being created
   # @param function [ Ollama::Tool::Function ] the function definition
-  # associated with the tool
+  #   associated with the tool
   def initialize(type:, function:)
     @type, @function = type, function.to_hash
   end

data/lib/ollama/version.rb

@@ -1,6 +1,6 @@
 module Ollama
   # Ollama version
-  VERSION         = '1.18.0'
+  VERSION         = '1.19.0'
   VERSION_ARRAY   = VERSION.split('.').map(&:to_i) # :nodoc:
   VERSION_MAJOR   = VERSION_ARRAY[0] # :nodoc:
   VERSION_MINOR   = VERSION_ARRAY[1] # :nodoc:

data/ollama-ruby.gemspec

@@ -1,9 +1,9 @@
 # -*- encoding: utf-8 -*-
-# stub: ollama-ruby 1.18.0 ruby lib
+# stub: ollama-ruby 1.19.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "ollama-ruby".freeze
-  s.version = "1.18.0".freeze
+  s.version = "1.19.0".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
@@ -18,14 +18,14 @@ Gem::Specification.new do |s|
   s.licenses = ["MIT".freeze]
   s.rdoc_options = ["--title".freeze, "Ollama-ruby - Interacting with the Ollama API".freeze, "--main".freeze, "README.md".freeze]
   s.required_ruby_version = Gem::Requirement.new(">= 3.1".freeze)
-  s.rubygems_version = "4.0.2".freeze
+  s.rubygems_version = "4.0.3".freeze
   s.summary = "Interacting with the Ollama API".freeze
   s.test_files = ["spec/ollama/client/doc_spec.rb".freeze, "spec/ollama/client_spec.rb".freeze, "spec/ollama/commands/chat_spec.rb".freeze, "spec/ollama/commands/copy_spec.rb".freeze, "spec/ollama/commands/create_spec.rb".freeze, "spec/ollama/commands/delete_spec.rb".freeze, "spec/ollama/commands/embed_spec.rb".freeze, "spec/ollama/commands/embeddings_spec.rb".freeze, "spec/ollama/commands/generate_spec.rb".freeze, "spec/ollama/commands/ps_spec.rb".freeze, "spec/ollama/commands/pull_spec.rb".freeze, "spec/ollama/commands/push_spec.rb".freeze, "spec/ollama/commands/show_spec.rb".freeze, "spec/ollama/commands/tags_spec.rb".freeze, "spec/ollama/commands/version_spec.rb".freeze, "spec/ollama/handlers/collector_spec.rb".freeze, "spec/ollama/handlers/dump_json_spec.rb".freeze, "spec/ollama/handlers/dump_yaml_spec.rb".freeze, "spec/ollama/handlers/markdown_spec.rb".freeze, "spec/ollama/handlers/nop_spec.rb".freeze, "spec/ollama/handlers/print_spec.rb".freeze, "spec/ollama/handlers/progress_spec.rb".freeze, "spec/ollama/handlers/say_spec.rb".freeze, "spec/ollama/handlers/single_spec.rb".freeze, "spec/ollama/image_spec.rb".freeze, "spec/ollama/message_spec.rb".freeze, "spec/ollama/options_spec.rb".freeze, "spec/ollama/tool_spec.rb".freeze, "spec/spec_helper.rb".freeze]
 
   s.specification_version = 4
 
-  s.add_development_dependency(%q<gem_hadar>.freeze, ["~> 2.9".freeze])
-  s.add_development_dependency(%q<all_images>.freeze, ["~> 0.6".freeze])
+  s.add_development_dependency(%q<gem_hadar>.freeze, [">= 2.17.0".freeze])
+  s.add_development_dependency(%q<all_images>.freeze, ["~> 0.12".freeze])
   s.add_development_dependency(%q<rspec>.freeze, ["~> 3.2".freeze])
   s.add_development_dependency(%q<kramdown>.freeze, ["~> 2.0".freeze])
   s.add_development_dependency(%q<webmock>.freeze, [">= 0".freeze])

data/spec/ollama/client_spec.rb

@@ -21,6 +21,17 @@ describe Ollama::Client do
     expect(client.output).to be $stdout
   end
 
+  it 'can be instantiated with config and api_key' do
+    config = Ollama::Client::Config[base_url: base_url, api_key: 'the-secret']
+    client = described_class.configure_with(config).expose
+    expect(client).to be_a described_class
+    expect(client.base_url.to_s).to eq base_url
+    expect(client.api_key).to eq 'the-secret'
+    expect(client.headers).to include(
+      'Authorization' => 'Bearer the-secret'
+    )
+  end
+
   it 'can be instantiated with config loaded from JSON' do
     config = Ollama::Client::Config.load_from_json(asset('client.json'))
     config.base_url = base_url
@@ -34,14 +45,11 @@ describe Ollama::Client do
     expect(client.instance_variable_get(:@read_timeout)).to eq 3_600
   end
 
-  it 'can be configured via environment variable' do
-    old_base_url = ENV['OLLAMA_URL']
+  it 'can be configured via environment variable', protect_env: true do
     ENV.delete('OLLAMA_URL')
     expect { described_class.new }.to raise_error(ArgumentError)
     ENV['OLLAMA_URL'] = base_url
     expect(described_class.new).to be_a described_class
-  ensure
-    ENV['OLLAMA_URL'] = old_base_url
   end
 
   it 'can disable ssl peer verification' do

data/spec/spec_helper.rb

@@ -14,7 +14,38 @@ def asset(name)
   File.join(__dir__, 'assets', name)
 end
 
+# A module that provides functionality for protecting environment variables
+# during tests.
+#
+# This module ensures that environment variable changes made during test
+# execution are automatically restored to their original values after the test
+# completes. It is designed to prevent side effects between tests that modify
+# environment variables, maintaining a clean testing environment.
+module ProtectEnvVars
+  # The apply method creates a lambda that protects environment variables
+  # during test execution.
+  #
+  # @return [Proc] a lambda that wraps test execution with environment variable
+  #   preservation
+  def self.apply
+    -> example do
+      if example.metadata[:protect_env]
+        begin
+          stored_env = ENV.to_h
+          example.run
+        ensure
+          ENV.replace(stored_env)
+        end
+      else
+        example.run
+      end
+    end
+  end
+end
+
 RSpec.configure do |config|
+  config.around(&ProtectEnvVars.apply)
+
   config.before(:suite) do
     infobar.show = nil
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ollama-ruby
 version: !ruby/object:Gem::Version
-  version: 1.18.0
+  version: 1.19.0
 platform: ruby
 authors:
 - Florian Frank
@@ -13,30 +13,30 @@ dependencies:
   name: gem_hadar
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.9'
+        version: 2.17.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.9'
+        version: 2.17.0
 - !ruby/object:Gem::Dependency
   name: all_images
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.12'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -413,7 +413,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.2
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Interacting with the Ollama API
 test_files: