ollama-ruby 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0b3ea2bd67e3f4fa2ca4da88a25cb869fc81e35578f1e7fd97ba43e84fc2278
-  data.tar.gz: 626c534bd2fd0580ab0520e8b70587489edbc963e179be0f800ee63235690b33
+  metadata.gz: 3976b4254bbedc3655a6a737000903217eff8b4b941971eb6ae4fda630ba40c3
+  data.tar.gz: 29187dded0f2748e8e684648ab374d027aaff18a6f85ede48df78dc34b705645
 SHA512:
-  metadata.gz: 149986d8144b1bc2c20771e245ead20f6e6bc07b46dbe26f8f355e0bc61eca146cc085a920dcbe3e3e08de65632693a35b6995c9dffef288aa929dd6b034de16
-  data.tar.gz: 4214aa2911db561635011b8ea200074d15c74b93bf7abb3c8e77af9c40ac5d8994e908e2ade8e5f288c2919678e03ea5d84d07684a63ba1f8039de52b6091a86
+  metadata.gz: 69ad552c73c297d23db6a65681008c79329de3d4a02a07f28b027a94820f9505488870e4bce6b43c1ae6a6fb64c6107ce4cc3d28b307f07573987464e6eaed84
+  data.tar.gz: 79dd0a71d48726900ed7df4508f2031191f00f15b3713cc562aa29112c4942e72836c5d487c8883b173dc760d8e815461b66e3c4b0fbdccd1226e6019af2419a

data/CHANGES.md

@@ -1,5 +1,21 @@
 # Changes
 
+## 2024-10-19 v0.9.1
+
+* Fixing string interpolation in `import_source` method:
+  + Changed result to use `#{}` instead of `%{}` for string interpolation
+* Move `pull_model_unless_present` method:
+  + Moved the method before other methods
+* Moved Switch classes and `setup_switches` method into Switches module:
+  + Moved the classes and method into a new module
+* Utils::Fetcher: Normalize URL in fetcher utility:
+  + Added `normalize_url` method to class Ollama::Utils::Fetcher
+  + 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`: 
+  + Removed the top-level namespace
+
 ## 2024-10-18 v0.9.0
 
 * Add document policy chooser and modify embedding/importing/summarizing

data/bin/ollama_chat

@@ -108,7 +108,7 @@ class OllamaChatConfig
 end
 
 class FollowChat
-  include Ollama::Handlers::Concern
+  include Handlers::Concern
   include Term::ANSIColor
 
   def initialize(messages:, markdown: false, voice: nil, output: $stdout)
@@ -164,114 +164,142 @@ class FollowChat
   end
 end
 
-module CheckSwitch
-  extend Tins::Concern
+module Switches
+  module CheckSwitch
+    extend Tins::Concern
 
-  included do
-    alias_method :on?, :value
-  end
+    included do
+      alias_method :on?, :value
+    end
 
-  def off?
-    !on?
-  end
+    def off?
+      !on?
+    end
 
-  def show
-    puts @msg[value]
+    def show
+      puts @msg[value]
+    end
   end
-end
 
-class Switch
-  def initialize(name, msg:, config: $config)
-    @value = [ false, true ].include?(config) ? config : !!config.send("#{name}?")
-    @msg   = msg
-  end
+  class Switch
+    def initialize(name, msg:, config: $config)
+      @value = [ false, true ].include?(config) ? config : !!config.send("#{name}?")
+      @msg   = msg
+    end
 
-  attr_reader :value
+    attr_reader :value
 
-  def set(value, show: false)
-    @value = !!value
-    show && self.show
-  end
+    def set(value, show: false)
+      @value = !!value
+      show && self.show
+    end
+
+    def toggle(show: true)
+      @value = !@value
+      show && self.show
+    end
 
-  def toggle(show: true)
-    @value = !@value
-    show && self.show
+    include CheckSwitch
   end
 
-  include CheckSwitch
-end
+  class CombinedSwitch
+    def initialize(value:, msg:)
+      @value = value
+      @msg   = msg
+    end
 
-class CombinedSwitch
-  def initialize(value:, msg:)
-    @value = value
-    @msg   = msg
-  end
+    def value
+      @value.()
+    end
 
-  def value
-    @value.()
+    include CheckSwitch
   end
 
-  include CheckSwitch
-end
+  def setup_switches
+    $markdown = Switch.new(
+      :markdown,
+      msg: {
+        true  => "Using #{italic{'ANSI'}} markdown to output content.",
+        false => "Using plaintext for outputting content.",
+      }
+    )
 
-def setup_switches
-  $markdown = Switch.new(
-    :markdown,
-    msg: {
-      true  => "Using #{italic{'ANSI'}} markdown to output content.",
-      false => "Using plaintext for outputting content.",
-    }
-  )
+    $stream = Switch.new(
+      :stream,
+      msg: {
+        true  => "Streaming enabled.",
+        false => "Streaming disabled.",
+      }
+    )
 
-  $stream = Switch.new(
-    :stream,
-    msg: {
-      true  => "Streaming enabled.",
-      false => "Streaming disabled.",
-    }
-  )
+    $voice = Switch.new(
+      :stream,
+      msg: {
+        true  => "Voice output enabled.",
+        false => "Voice output disabled.",
+      },
+      config: $config.voice
+    )
 
-  $voice = Switch.new(
-    :stream,
-    msg: {
-      true  => "Voice output enabled.",
-      false => "Voice output disabled.",
-    },
-    config: $config.voice
-  )
+    $embedding_enabled = Switch.new(
+      :embedding_enabled,
+      msg: {
+        true  => "Embedding enabled.",
+        false => "Embedding disabled.",
+      }
+    )
 
-  $embedding_enabled = Switch.new(
-    :embedding_enabled,
-    msg: {
-      true  => "Embedding enabled.",
-      false => "Embedding disabled.",
-    }
-  )
+    $embedding_paused = Switch.new(
+      :embedding_paused,
+      msg: {
+        true  => "Embedding paused.",
+        false => "Embedding resumed.",
+      }
+    )
 
-  $embedding_paused = Switch.new(
-    :embedding_paused,
-    msg: {
-      true  => "Embedding paused.",
-      false => "Embedding resumed.",
-    }
-  )
+    $embedding = CombinedSwitch.new(
+      value: -> { $embedding_enabled.on? && $embedding_paused.off? },
+      msg: {
+        true  => "Embedding is currently performed.",
+        false => "Embedding is currently not performed.",
+      }
+    )
 
-  $embedding = CombinedSwitch.new(
-    value: -> { $embedding_enabled.on? && $embedding_paused.off? },
-    msg: {
-      true  => "Embedding is currently performed.",
-      false => "Embedding is currently not performed.",
-    }
-  )
+    $location = Switch.new(
+      :location,
+      msg: {
+        true  => "Location and localtime enabled.",
+        false => "Location and localtime disabled.",
+      },
+      config: $config.location.enabled
+    )
+  end
+end
+include Switches
 
-  $location = Switch.new(
-    :location,
-    msg: {
-      true  => "Location and localtime enabled.",
-      false => "Location and localtime disabled.",
-    },
-    config: $config.location.enabled
-  )
+def pull_model_unless_present(model, options, retried = false)
+  ollama.show(name: model) { |response|
+    puts "Model #{bold{model}} with architecture "\
+      "#{response.model_info['general.architecture']} found."
+    if system = response.system
+      puts "Configured model system prompt is:\n#{italic { system }}"
+      return system
+    else
+      return
+    end
+  }
+rescue Errors::NotFoundError
+  puts "Model #{bold{model}} not found locally, attempting to pull it from remote now…"
+  ollama.pull(name: model)
+  if retried
+    exit 1
+  else
+    retried = true
+    retry
+  end
+rescue Errors::Error => e
+  warn "Caught #{e.class} while pulling model: #{e} => Exiting."
+  exit 1
 end
 
 def search_web(query, n = nil)
@@ -282,7 +310,7 @@ def search_web(query, n = nil)
   n < 1 and n = 1
   query = URI.encode_uri_component(query)
   url = "https://www.duckduckgo.com/html/?q=#{query}"
-  Ollama::Utils::Fetcher.get(url, debug: $config.debug) do |tmp|
+  Utils::Fetcher.get(url, debug: $config.debug) do |tmp|
     result = []
     doc = Nokogiri::HTML(tmp)
     doc.css('.results_links').each do |link|
@@ -303,38 +331,13 @@ def search_web(query, n = nil)
   end
 end
 
-def pull_model_unless_present(model, options, retried = false)
-  ollama.show(name: model) { |response|
-    puts "Model #{bold{model}} with architecture "\
-      "#{response.model_info['general.architecture']} found."
-    if system = response.system
-      puts "Configured model system prompt is:\n#{italic { system }}"
-      return system
-    else
-      return
-    end
-  }
-rescue Errors::NotFoundError
-  puts "Model #{bold{model}} not found locally, attempting to pull it from remote now…"
-  ollama.pull(name: model)
-  if retried
-    exit 1
-  else
-    retried = true
-    retry
-  end
-rescue Errors::Error => e
-  warn "Caught #{e.class} while pulling model: #{e} => Exiting."
-  exit 1
-end
-
 def load_conversation(filename)
   unless File.exist?(filename)
     puts "File #{filename} doesn't exist. Choose another filename."
     return
   end
   File.open(filename, 'r') do |output|
-    return JSON(output.read).map { Ollama::Message.from_hash(_1) }
+    return JSON(output.read).map { Message.from_hash(_1) }
   end
 end
 
@@ -504,7 +507,7 @@ def fetch_source(source, &block)
       source,
       cache:        $cache,
       debug:        $config.debug,
-      http_options: http_options(source)
+      http_options: http_options(Utils::Fetcher.normalize_url(source))
     ) do |tmp|
       block.(tmp)
     end
@@ -518,7 +521,7 @@ def fetch_source(source, &block)
     raise "invalid source"
   end
 rescue => e
-  STDERR.puts "Cannot fetch source #{source.to_s.inspect}: #{e}\n#{e.backtrace * ?\n}"
+  STDERR.puts "Cannot fetch source #{source.to_s.inspect}: #{e.class} #{e}\n#{e.backtrace * ?\n}"
 end
 
 def add_image(images, source_io, source)
@@ -530,7 +533,8 @@ end
 def import_source(source_io, source)
   source = source.to_s
   puts "Importing #{italic { source_io&.content_type }} document #{source.inspect} now."
-  "Imported #{source.inspect}:\n%s\n\n" % parse_source(source_io)
+	source_content = parse_source(source_io)
+  "Imported #{source.inspect}:\n#{source_content}\n\n"
 end
 
 def import(source)
@@ -572,17 +576,17 @@ def embed_source(source_io, source, count: nil)
   inputs = nil
   case splitter_config.name
   when 'Character'
-    splitter = Ollama::Documents::Splitters::Character.new(
+    splitter = Documents::Splitters::Character.new(
       chunk_size: splitter_config.chunk_size,
     )
     inputs = splitter.split(text)
   when 'RecursiveCharacter'
-    splitter = Ollama::Documents::Splitters::RecursiveCharacter.new(
+    splitter = Documents::Splitters::RecursiveCharacter.new(
       chunk_size: splitter_config.chunk_size,
     )
     inputs = splitter.split(text)
   when 'Semantic'
-    splitter = Ollama::Documents::Splitters::Semantic.new(
+    splitter = Documents::Splitters::Semantic.new(
       ollama:, model: $config.embedding.model.name,
       chunk_size: splitter_config.chunk_size,
     )
@@ -597,7 +601,7 @@ def embed_source(source_io, source, count: nil)
   inputs or return
   source = source.to_s
   if source.start_with?(?!)
-    source = Ollama::Utils::Width.truncate(
+    source = Utils::Width.truncate(
       source[1..-1].gsub(/\W+/, ?_),
       length: 10
     )
@@ -662,7 +666,7 @@ end
 def choose_model(cli_model, current_model)
   models = ollama.tags.models.map(&:name).sort
   model = if cli_model == ''
-            Ollama::Utils::Chooser.choose(models) || current_model
+            Utils::Chooser.choose(models) || current_model
           else
             cli_model || current_model
           end
@@ -679,7 +683,7 @@ def choose_collection(current_collection)
   collections = [ current_collection ] + $documents.collections
   collections = collections.compact.map(&:to_s).uniq.sort
   collections.unshift('[EXIT]').unshift('[NEW]')
-  collection = Ollama::Utils::Chooser.choose(collections) || current_collection
+  collection = Utils::Chooser.choose(collections) || current_collection
   case collection
   when '[NEW]'
     $documents.collection = ask?(prompt: "Enter name of the new collection: ")
@@ -703,7 +707,7 @@ def choose_document_policy
                policies.first
              end
   policies.unshift('[EXIT]')
-  policy = Ollama::Utils::Chooser.choose(policies)
+  policy = Utils::Chooser.choose(policies)
   case policy
   when nil, '[EXIT]'
     puts "Exiting chooser."
@@ -733,19 +737,19 @@ end
 
 def configure_cache
   if $opts[?M]
-    Ollama::Documents::MemoryCache
+    Documents::MemoryCache
   else
     Object.const_get($config.cache)
   end
 rescue => e
   STDERR.puts "Caught #{e.class}: #{e} => Falling back to MemoryCache."
-  Ollama::Documents::MemoryCache
+  Documents::MemoryCache
 end
 
 def show_system_prompt
   puts <<~EOT
     Configured system prompt is:
-    #{Ollama::Utils::ANSIMarkdown.parse($system.to_s).gsub(/\n+\z/, '').full? || 'n/a'}
+    #{Utils::ANSIMarkdown.parse($system.to_s).gsub(/\n+\z/, '').full? || 'n/a'}
   EOT
 end
 
@@ -769,7 +773,7 @@ end
 
 def change_system_prompt(messages, default)
   prompts = $config.system_prompts.attribute_names.compact
-  chosen  = Ollama::Utils::Chooser.choose(prompts)
+  chosen  = Utils::Chooser.choose(prompts)
   system  = if chosen
               $config.system_prompts.send(chosen)
             else
@@ -779,7 +783,7 @@ def change_system_prompt(messages, default)
 end
 
 def change_voice
-  chosen  = Ollama::Utils::Chooser.choose($config.voice.list)
+  chosen  = Utils::Chooser.choose($config.voice.list)
   $current_voice = chosen.full? || $config.voice.default
 end
 
@@ -872,7 +876,7 @@ def usage
 end
 
 def version
-  puts "%s %s" % [ File.basename($0), Ollama::VERSION ]
+  puts "%s %s" % [ File.basename($0), VERSION ]
   exit 0
 end
 
@@ -907,7 +911,7 @@ else
   if $opts[?s] == ??
     change_system_prompt(messages, default)
   else
-    system = Ollama::Utils::FileArgument.get_file_argument($opts[?s], default:)
+    system = Utils::FileArgument.get_file_argument($opts[?s], default:)
     system.present? and set_system_prompt(messages, system)
   end
 end
@@ -957,7 +961,7 @@ else
 end
 
 if redis_expiring_url = $config.redis.expiring.url?
-  $cache = Ollama::Documents::RedisCache.new(
+  $cache = Documents::RedisCache.new(
     prefix: 'Expiring-',
     url:    redis_expiring_url,
     ex:     $config.redis.expiring.ex,
@@ -1051,7 +1055,7 @@ loop do
     when 'clear'
       loop do
         tags = $documents.tags.add('[EXIT]').add('[ALL]')
-        tag = Ollama::Utils::Chooser.choose(tags, prompt: 'Clear? %s')
+        tag = Utils::Chooser.choose(tags, prompt: 'Clear? %s')
         case tag
         when nil, '[EXIT]'
           puts "Exiting chooser."

data/lib/ollama/utils/fetcher.rb

@@ -38,6 +38,13 @@ class Ollama::Utils::Fetcher
     end
   end
 
+  def self.normalize_url(url)
+    url = url.to_s
+    url = URI.decode_uri_component(url)
+    url = url.sub(/#.*/, '')
+    URI::Parser.new.escape(url).to_s
+  end
+
   def self.read(filename, &block)
     if File.exist?(filename)
       File.open(filename) do |file|
@@ -80,6 +87,7 @@ class Ollama::Utils::Fetcher
   private
 
   def excon(url, **options)
+    url = self.class.normalize_url(url)
     Excon.new(url, options.merge(@http_options))
   end
 

data/lib/ollama/version.rb

@@ -1,6 +1,6 @@
 module Ollama
   # Ollama version
-  VERSION         = '0.9.0'
+  VERSION         = '0.9.1'
   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,14 +1,14 @@
 # -*- encoding: utf-8 -*-
-# stub: ollama-ruby 0.9.0 ruby lib
+# stub: ollama-ruby 0.9.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "ollama-ruby".freeze
-  s.version = "0.9.0".freeze
+  s.version = "0.9.1".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Florian Frank".freeze]
-  s.date = "2024-10-18"
+  s.date = "2024-10-19"
   s.description = "Library that allows interacting with the Ollama API".freeze
   s.email = "flori@ping.de".freeze
   s.executables = ["ollama_console".freeze, "ollama_chat".freeze, "ollama_update".freeze, "ollama_cli".freeze]

data/spec/ollama/utils/fetcher_spec.rb

@@ -19,7 +19,7 @@ RSpec.describe Ollama::Utils::Fetcher do
   end
 
   it 'can #get with streaming' do
-    stub_request(:get, 'https://www.example.com/hello').
+    stub_request(:get, url).
       with(headers: fetcher.headers).
       to_return(
         status: 200,
@@ -37,7 +37,7 @@ RSpec.describe Ollama::Utils::Fetcher do
     fetcher = described_class.new(
       http_options: { ssl_verify_peer: false }
     ).expose
-    stub_request(:get, 'https://www.example.com/hello').
+    stub_request(:get, url).
       with(headers: fetcher.headers).
       to_return(
         status: 200,
@@ -45,7 +45,7 @@ RSpec.describe Ollama::Utils::Fetcher do
         headers: { 'Content-Type' => 'text/plain' },
       )
     expect(Excon).to receive(:new).with(
-      'https://www.example.com/hello',
+      url,
       hash_including(ssl_verify_peer: false)
     ).and_call_original
     fetcher.get(url) do |tmp|
@@ -56,7 +56,7 @@ RSpec.describe Ollama::Utils::Fetcher do
   end
 
   it 'can #get and fallback from streaming' do
-    stub_request(:get, 'https://www.example.com/hello').
+    stub_request(:get, url).
       with(headers: fetcher.headers).
       to_return(
         { status: 501 },
@@ -74,9 +74,10 @@ RSpec.describe Ollama::Utils::Fetcher do
   end
 
   it 'can #get and finally fail' do
-    stub_request(:get, 'https://www.example.com/hello').
+    stub_request(:get, url).
       with(headers: fetcher.headers).
       to_return(status: 500)
+		expect(STDERR).to receive(:puts).with(/cannot.*get.*#{url}/i)
     fetcher.get(url) do |tmp|
       expect(tmp).to be_a StringIO
       expect(tmp.read).to eq ''
@@ -106,10 +107,31 @@ RSpec.describe Ollama::Utils::Fetcher do
 
   it 'can .execute and fail' do
     expect(IO).to receive(:popen).and_raise StandardError
+		expect(STDERR).to receive(:puts).with(/cannot.*execute.*foobar/i)
     described_class.execute('foobar') do |file|
       expect(file).to be_a StringIO
       expect(file.read).to be_empty
       expect(file.content_type).to eq 'text/plain'
     end
   end
+
+	describe '.normalize_url' do
+		it 'can handle umlauts' do
+			expect(described_class.normalize_url('https://foo.de/bär')).to eq(
+				'https://foo.de/b%C3%A4r'
+			)
+		end
+
+		it 'can handle escaped umlauts' do
+			expect(described_class.normalize_url('https://foo.de/b%C3%A4r')).to eq(
+				'https://foo.de/b%C3%A4r'
+			)
+		end
+
+		it 'can remove #anchors' do
+			expect(described_class.normalize_url('https://foo.de#bar')).to eq(
+				'https://foo.de'
+			)
+		end
+	end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ollama-ruby
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Florian Frank
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-18 00:00:00.000000000 Z
+date: 2024-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gem_hadar