ollama-ruby 0.3.2 → 0.5.0

data/spec/ollama/documents/memory_cache_spec.rb

@@ -1,63 +1,63 @@
 require 'spec_helper'
 
 RSpec.describe Ollama::Documents::MemoryCache do
-  let :memory_cache do
+  let :cache do
     described_class.new prefix: 'test-'
   end
 
   it 'can be instantiated' do
-    expect(memory_cache).to be_a described_class
+    expect(cache).to be_a described_class
   end
 
   it 'can get/set a key' do
     key, value = 'foo', { test: true }
     expect {
-      memory_cache[key] = value
+      cache[key] = value
     }.to change {
-      memory_cache[key]
+      cache[key]
     }.from(nil).to(value)
   end
 
   it 'can determine if key exists' do
     key, value = 'foo', { test: true }
     expect {
-      memory_cache[key] = value
+      cache[key] = value
     }.to change {
-      memory_cache.key?(key)
+      cache.key?(key)
     }.from(false).to(true)
   end
 
   it 'can delete' do
     key, value = 'foo', { test: true }
-    memory_cache[key] = value
+    cache[key] = value
     expect {
-      memory_cache.delete(key)
+      cache.delete(key)
     }.to change {
-      memory_cache.key?(key)
+      cache.key?(key)
     }.from(true).to(false)
   end
 
   it 'returns size' do
     key, value = 'foo', { test: true }
     expect {
-      memory_cache[key] = value
+      cache[key] = value
     }.to change {
-      memory_cache.size
+      cache.size
     }.from(0).to(1)
   end
 
   it 'can clear' do
     key, value = 'foo', { test: true }
-    memory_cache[key] = value
+    cache[key] = value
     expect {
-      expect(memory_cache.clear).to eq memory_cache
+      expect(cache.clear).to eq cache
     }.to change {
-      memory_cache.size
+      cache.size
     }.from(1).to(0)
   end
 
   it 'can iterate over keys under a prefix' do
-    memory_cache['foo'] = 'bar'
-    expect(memory_cache.to_a).to eq [ %w[ test-foo bar ] ]
+    cache['foo'] = 'bar'
+    expect(cache.to_a).to eq [ %w[ test-foo bar ] ]
   end
 end

data/spec/ollama/documents/redis_backed_memory_cache_spec.rb

@@ -0,0 +1,106 @@
+require 'spec_helper'
+
+RSpec.describe Ollama::Documents::RedisBackedMemoryCache do
+  it 'raises ArgumentError if url is missing' do
+    expect {
+      described_class.new prefix: 'test-', url: nil
+    }.to raise_error ArgumentError
+  end
+
+  context 'test redis interactions' do
+    let :cache do
+      described_class.new prefix: 'test-', url: 'something'
+    end
+
+    let :data do
+      cache.instance_eval { @data }
+    end
+
+    let :redis_cache do
+      cache.instance_eval { @redis_cache }
+    end
+
+    let :redis do
+      double('Redis')
+    end
+
+    before do
+      allow_any_instance_of(Ollama::Documents::RedisCache).to\
+        receive(:redis).and_return(redis)
+      allow(redis).to receive(:scan_each)
+    end
+
+    it 'can be instantiated and initialized' do
+      cache = described_class.new prefix: 'test-', url: 'something'
+      expect(cache).to be_a described_class
+    end
+
+    it 'defaults to nil object_class' do
+      cache = described_class.new prefix: 'test-', url: 'something'
+      expect(cache.object_class).to be_nil
+    end
+
+    it 'can be configured with object_class' do
+      object_class = Class.new(JSON::GenericObject)
+      cache = described_class.new(prefix: 'test-', url: 'something', object_class:)
+      expect(cache.object_class).to eq object_class
+    end
+
+    it 'has Redis client' do
+      expect(cache.redis).to eq redis
+    end
+
+    it 'can get a key' do
+      key = 'foo'
+      expect(data).to receive(:[]).with('test-' + key).and_return 666
+      expect(cache[key]).to eq 666
+    end
+
+    it 'can set a value for a key' do
+      key, value = 'foo', { test: true }
+      expect(data).to receive(:[]=).with('test-' + key, { test: true }).and_call_original
+      expect(redis).to receive(:set).with('test-' + key, JSON(value))
+      cache[key] = value
+    end
+
+    it 'can determine if key exists' do
+      key = 'foo'
+      expect(data).to receive(:key?).with('test-' + key).and_return(false, true)
+      expect(cache.key?('foo')).to eq false
+      expect(cache.key?('foo')).to eq true
+    end
+
+    it 'can delete' do
+      key = 'foo'
+      expect(data).to receive(:delete).with('test-' + key)
+      expect(redis).to receive(:del).with('test-' + key)
+      cache.delete(key)
+    end
+
+    it 'returns size' do
+      allow(cache).to receive(:count).and_return 3
+      expect(cache.size).to eq 3
+    end
+
+    it 'can clear' do
+      expect(redis).to receive(:scan_each).with(match: 'test-*').and_yield(
+        'test-foo'
+      )
+      expect(redis).to receive(:del).with('test-foo')
+      expect(cache.clear).to eq cache
+    end
+
+    it 'can iterate over keys under a prefix' do
+      data['test-foo'] = 'bar'
+      expect(cache.to_a).to eq [ %w[ test-foo bar ] ]
+    end
+
+    it 'can compute prefix with pre' do
+      expect(cache.pre('foo')).to eq 'test-foo'
+    end
+
+    it 'can remove prefix with unpre' do
+      expect(cache.unpre('test-foo')).to eq 'foo'
+    end
+  end
+end

data/spec/ollama/documents/redis_cache_spec.rb

@@ -2,8 +2,19 @@ require 'spec_helper'
 
 RSpec.describe Ollama::Documents::RedisCache do
   it 'can be instantiated' do
-    redis_cache = described_class.new prefix: 'test-', url: 'something'
-    expect(redis_cache).to be_a described_class
+    cache = described_class.new prefix: 'test-', url: 'something'
+    expect(cache).to be_a described_class
+  end
+
+  it 'defaults to nil object_class' do
+    cache = described_class.new prefix: 'test-', url: 'something'
+    expect(cache.object_class).to be_nil
+  end
+
+  it 'can be configured with object_class' do
+    object_class = Class.new(JSON::GenericObject)
+    cache = described_class.new(prefix: 'test-', url: 'something', object_class:)
+    expect(cache.object_class).to eq object_class
   end
 
   it 'raises ArgumentError if url is missing' do
@@ -13,7 +24,7 @@ RSpec.describe Ollama::Documents::RedisCache do
   end
 
   context 'test redis interactions' do
-    let :redis_cache do
+    let :cache do
       described_class.new prefix: 'test-', url: 'something'
     end
 
@@ -26,32 +37,41 @@ RSpec.describe Ollama::Documents::RedisCache do
     end
 
     it 'has Redis client' do
-      expect(redis_cache.redis).to eq redis
+      expect(cache.redis).to eq redis
     end
 
     it 'can get a key' do
       key = 'foo'
-      expect(redis).to receive(:get).with('test-' + key).and_return 666
-      redis_cache[key]
+      expect(redis).to receive(:get).with('test-' + key).and_return '"some_json"'
+      expect(cache[key]).to eq 'some_json'
     end
 
     it 'can set a value for a key' do
       key, value = 'foo', { test: true }
-      expect(redis).to receive(:set).with('test-' + key, JSON(value))
-      redis_cache[key] = value
+      expect(redis).to receive(:set).with('test-' + key, JSON(value), ex: nil)
+      cache[key] = value
+    end
+
+    it 'can set a value for a key with ttl' do
+      cache = described_class.new prefix: 'test-', url: 'something', ex: 3_600
+      key, value = 'foo', { test: true }
+      expect(redis).to receive(:set).with('test-' + key, JSON(value), ex: 3_600)
+      cache[key] = value
+      allow(redis).to receive(:ttl).with('test-' + key).and_return 3_600
+      expect(cache.ttl(key)).to eq 3_600
     end
 
     it 'can determine if key exists' do
       key = 'foo'
       expect(redis).to receive(:exists?).with('test-' + key).and_return(false, true)
-      expect(redis_cache.key?('foo')).to eq false
-      expect(redis_cache.key?('foo')).to eq true
+      expect(cache.key?('foo')).to eq false
+      expect(cache.key?('foo')).to eq true
     end
 
     it 'can delete' do
       key = 'foo'
       expect(redis).to receive(:del).with('test-' + key)
-      redis_cache.delete(key)
+      cache.delete(key)
     end
 
     it 'returns size' do
@@ -59,7 +79,7 @@ RSpec.describe Ollama::Documents::RedisCache do
         and_yield('test-foo').
         and_yield('test-bar').
         and_yield('test-baz')
-      expect(redis_cache.size).to eq 3
+      expect(cache.size).to eq 3
     end
 
     it 'can clear' do
@@ -67,20 +87,20 @@ RSpec.describe Ollama::Documents::RedisCache do
         'test-foo'
       )
       expect(redis).to receive(:del).with('test-foo')
-      expect(redis_cache.clear).to eq redis_cache
+      expect(cache.clear).to eq cache
     end
 
     it 'can iterate over keys under a prefix' do
       expect(redis).to receive(:scan_each).with(match: 'test-*')
-      redis_cache.to_a
+      cache.to_a
     end
 
     it 'can compute prefix with pre' do
-      expect(redis_cache.pre('foo')).to eq 'test-foo'
+      expect(cache.pre('foo')).to eq 'test-foo'
     end
 
     it 'can remove prefix with unpre' do
-      expect(redis_cache.unpre('test-foo')).to eq 'foo'
+      expect(cache.unpre('test-foo')).to eq 'foo'
     end
   end
 end

data/spec/ollama/documents/splitters/character_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 RSpec.describe Ollama::Documents::Splitters::Character do
   let :splitter do
-    described_class.new chunk_size: 23
+    described_class.new chunk_size: 23, combining_string: ''
   end
 
   it 'can be instantiated' do
@@ -10,29 +10,41 @@ RSpec.describe Ollama::Documents::Splitters::Character do
   end
 
   it 'can split' do
-    text = [ "A" * 10 ] * 10 * "\n\n"
+    text = [ ?A * 10 ] * 10 * "\n\n"
     result = splitter.split(text)
     expect(result.count).to eq 5
     expect(result.to_a.join('')).to eq ?A * 100
   end
 
+  it 'can split combining with separation' do
+    splitter = described_class.new chunk_size: 25, include_separator: false,
+      combining_string: ?X
+    text = [ ?A * 10 ] * 10 * "\n\n"
+    result = splitter.split(text)
+    expect(result.count).to eq 5
+    expect(result.to_a.join(?B)).to eq\
+      "AAAAAAAAAAXAAAAAAAAAAXBAAAAAAAAAAAAAAAAAAAAXBAAAAAAAAAAAAAAAAAAAAXB"\
+      "AAAAAAAAAAAAAAAAAAAAXBAAAAAAAAAAAAAAAAAAAAX"
+  end
+
   it 'can split including separator' do
-    splitter = described_class.new chunk_size: 25, include_separator: true
-    text = [ "A" * 10 ] * 10 * "\n\n"
+    splitter = described_class.new chunk_size: 25, include_separator: true,
+      combining_string: ''
+    text = [ ?A * 10 ] * 10 * "\n\n"
     result = splitter.split(text)
     expect(result.count).to eq 5
     expect(result.to_a.join('')).to eq text
   end
 
   it 'cannot split' do
-    text = [ "A" * 10 ] * 10 * "\n"
+    text = [ ?A * 10 ] * 10 * "\n"
     result = splitter.split(text)
     expect(result.count).to eq 1
     expect(result.to_a.join('').count(?A)).to eq text.count(?A)
   end
 
   it 'cannot split2' do
-    text = "A" * 25
+    text = ?A * 25
     result = splitter.split(text)
     expect(result.count).to eq 1
     expect(result.to_a.join('')).to eq ?A * 25
@@ -48,7 +60,7 @@ end
 
 RSpec.describe Ollama::Documents::Splitters::RecursiveCharacter do
   let :splitter do
-    described_class.new chunk_size: 23
+    described_class.new chunk_size: 23, combining_string: ''
   end
 
   it 'can be instantiated' do
@@ -56,7 +68,7 @@ RSpec.describe Ollama::Documents::Splitters::RecursiveCharacter do
   end
 
   it 'can split' do
-    text = [ "A" * 10 ] * 10 * "\n\n"
+    text = [ ?A * 10 ] * 10 * "\n\n"
     result = splitter.split(text)
     expect(result.count).to eq 5
     expect(result.to_a.join('')).to eq ?A * 100
@@ -65,30 +77,32 @@ RSpec.describe Ollama::Documents::Splitters::RecursiveCharacter do
   it 'cannot split' do
     splitter = described_class.new chunk_size: 23, include_separator: true,
       separators: described_class::DEFAULT_SEPARATORS[0..-2]
-    text = "A" * 25
+    text = ?A * 25
     result = splitter.split(text)
     expect(result.count).to eq 1
     expect(result.to_a.join('')).to eq ?A * 25
   end
 
   it 'can split including separator' do
-    splitter = described_class.new chunk_size: 25, include_separator: true
-    text = [ "A" * 10 ] * 10 * "\n\n"
+    splitter = described_class.new chunk_size: 25, include_separator: true,
+      combining_string: ''
+    text = [ ?A * 10 ] * 10 * "\n\n"
     result = splitter.split(text)
     expect(result.count).to eq 5
     expect(result.to_a.join('')).to eq text
   end
 
   it 'can split single newline as well' do
-    text = [ "A" * 10 ] * 10 * "\n"
+    text = [ ?A * 10 ] * 10 * "\n"
     result = splitter.split(text)
     expect(result.count).to eq 5
     expect(result.to_a.join('')).to eq ?A * 100
   end
 
   it 'can split single newline as well including separator' do
-    splitter = described_class.new chunk_size: 25, include_separator: true
-    text = [ "A" * 10 ] * 10 * "\n"
+    splitter = described_class.new chunk_size: 25, include_separator: true,
+      combining_string: ''
+    text = [ ?A * 10 ] * 10 * "\n"
     result = splitter.split(text)
     expect(result.count).to eq 5
     expect(result.to_a.join('')).to eq text

data/spec/ollama/utils/fetcher_spec.rb

@@ -33,6 +33,28 @@ RSpec.describe Ollama::Utils::Fetcher do
     end
   end
 
+  it 'can #get without ssl peer verification' do
+    fetcher = described_class.new(
+      http_options: { ssl_verify_peer: false }
+    )
+    stub_request(:get, 'https://www.example.com/hello').
+      with(headers: fetcher.headers).
+      to_return(
+        status: 200,
+        body: 'world',
+        headers: { 'Content-Type' => 'text/plain' },
+      )
+    expect(Excon).to receive(:new).with(
+      'https://www.example.com/hello',
+      hash_including(ssl_verify_peer: false)
+    ).and_call_original
+    fetcher.get(url) do |tmp|
+      expect(tmp).to be_a Tempfile
+      expect(tmp.read).to eq 'world'
+      expect(tmp.content_type).to eq 'text/plain'
+    end
+  end
+
   it 'can #get and fallback from streaming' do
     stub_request(:get, 'https://www.example.com/hello').
       with(headers: fetcher.headers).
@@ -56,7 +78,9 @@ RSpec.describe Ollama::Utils::Fetcher do
       with(headers: fetcher.headers).
       to_return(status: 500)
     fetcher.get(url) do |tmp|
-      expect(tmp).to be_nil
+      expect(tmp).to be_a StringIO
+      expect(tmp.read).to eq ''
+      expect(tmp.content_type).to eq 'text/plain'
     end
   end
 
@@ -71,4 +95,21 @@ RSpec.describe Ollama::Utils::Fetcher do
       expect(file.content_type).to eq 'application/x-ruby'
     end
   end
+
+  it 'can .execute' do
+    described_class.execute('echo -n hello world') do |file|
+      expect(file).to be_a Tempfile
+      expect(file.read).to eq 'hello world'
+      expect(file.content_type).to eq 'text/plain'
+    end
+  end
+
+  it 'can .execute and fail' do
+    allow(IO).to receive(:popen).and_raise StandardError
+    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
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ollama-ruby
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Florian Frank
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-15 00:00:00.000000000 Z
+date: 2024-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gem_hadar
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.17.1
+        version: 1.18.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.17.1
+        version: 1.18.0
 - !ruby/object:Gem::Dependency
   name: all_images
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +66,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: debug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: excon
   requirement: !ruby/object:Gem::Requirement
@@ -276,6 +304,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 description: Library that allows interacting with the Ollama API
 email: flori@ping.de
 executables:
@@ -303,8 +359,10 @@ extra_rdoc_files:
 - lib/ollama/commands/show.rb
 - lib/ollama/commands/tags.rb
 - lib/ollama/documents.rb
-- lib/ollama/documents/memory_cache.rb
-- lib/ollama/documents/redis_cache.rb
+- lib/ollama/documents/cache/common.rb
+- lib/ollama/documents/cache/memory_cache.rb
+- lib/ollama/documents/cache/redis_backed_memory_cache.rb
+- lib/ollama/documents/cache/redis_cache.rb
 - lib/ollama/documents/splitters/character.rb
 - lib/ollama/documents/splitters/semantic.rb
 - lib/ollama/dto.rb
@@ -367,8 +425,10 @@ files:
 - lib/ollama/commands/show.rb
 - lib/ollama/commands/tags.rb
 - lib/ollama/documents.rb
-- lib/ollama/documents/memory_cache.rb
-- lib/ollama/documents/redis_cache.rb
+- lib/ollama/documents/cache/common.rb
+- lib/ollama/documents/cache/memory_cache.rb
+- lib/ollama/documents/cache/redis_backed_memory_cache.rb
+- lib/ollama/documents/cache/redis_cache.rb
 - lib/ollama/documents/splitters/character.rb
 - lib/ollama/documents/splitters/semantic.rb
 - lib/ollama/dto.rb
@@ -420,6 +480,7 @@ files:
 - spec/ollama/commands/show_spec.rb
 - spec/ollama/commands/tags_spec.rb
 - spec/ollama/documents/memory_cache_spec.rb
+- spec/ollama/documents/redis_backed_memory_cache_spec.rb
 - spec/ollama/documents/redis_cache_spec.rb
 - spec/ollama/documents/splitters/character_spec.rb
 - spec/ollama/documents/splitters/semantic_spec.rb
@@ -486,6 +547,7 @@ test_files:
 - spec/ollama/commands/show_spec.rb
 - spec/ollama/commands/tags_spec.rb
 - spec/ollama/documents/memory_cache_spec.rb
+- spec/ollama/documents/redis_backed_memory_cache_spec.rb
 - spec/ollama/documents/redis_cache_spec.rb
 - spec/ollama/documents/splitters/character_spec.rb
 - spec/ollama/documents/splitters/semantic_spec.rb