typesense 3.0.0.rc1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 207a723a469821c92408584d89b0d74db1c705e472ab1f7f238cea1640816993
-  data.tar.gz: ce2df2d51c341f60c5f2626810b71d3250e03640ae01cfe5e74cfc0be262ee65
+  metadata.gz: 3efcebcc5a0475181b09faa3e0b7b1c08886c5b3ade298f51dbb1743b9d9cc70
+  data.tar.gz: 70e5a40fb8481c70d04f53196ede21112df3bf0e903202e73d2aab4fd4cd7d9a
 SHA512:
-  metadata.gz: '08f5e7ba0388270bb7f510ea9d8150d159673d3cedee6fbaa9e867e5591716add353359af503754aa8da1d75f9732522df106def8a98ce77dae5d1f9ba80b037'
-  data.tar.gz: 58e734bcf1a05efb399e32ceed24827dac1818c9ea669d9b1d99c52707a60854af2305c3275ae863c5cca88fa0142b53f25e53e3c816ed44d4f0c0eb69e1d164
+  metadata.gz: 9fc680cf4defb9ad733da576c56f7ce127e9622d44ee0b3912cd5f139c1fb373ac1c1475da59bd191ec943f6991215966b951dde34be84fc2d85496b554e3410
+  data.tar.gz: e5c66ae5868171ccf75a9800bc52b3cc539434480285232b1debbb84a79e22f1ad2b404c9951f4085dfaa99ffd87f1043b96b2a5f24c7dfee16392ce25f05dfe

data/.github/workflows/tests.yml

@@ -10,10 +10,10 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.7', '3.0', '3.2']
+        ruby-version: ['3.0', '3.2', '3.3']
     services:
       typesense:
-        image: typesense/typesense:27.1
+        image: typesense/typesense:28.0
         ports:
           - 8108:8108
         volumes:
@@ -37,8 +37,8 @@ jobs:
           bundler-cache: true # runs 'bundle install' and caches installed gems automatically
       - run: bundle exec rubocop
       - run: bundle exec rspec --format documentation
-      - uses: actions/upload-artifact@v3
+      - uses: actions/upload-artifact@v4
         with:
-          name: coverage
+          name: coverage-ruby-${{ matrix.ruby-version }}
           path: coverage/
           retention-days: 1

data/README.md

@@ -33,6 +33,7 @@ Tests are also a good place to know how the the library works internally: [spec]
 
 | Typesense Server | typesense-ruby |
 |------------------|----------------|
+| \>= v28.0        | \>= v3.0.0     |
 | \>= v0.25.0      | \>= v1.0.0     |
 | \>= v0.23.0      | \>= v0.14.0    |
 | \>= v0.21.0      | \>= v0.13.0    |

data/lib/typesense/client.rb

@@ -3,7 +3,7 @@
 module Typesense
   class Client
     attr_reader :configuration, :collections, :aliases, :keys, :debug, :health, :metrics, :stats, :operations,
-                :multi_search, :analytics, :presets
+                :multi_search, :analytics, :presets, :stemming
 
     def initialize(options = {})
       @configuration = Configuration.new(options)
@@ -18,6 +18,7 @@ module Typesense
       @stats = Stats.new(@api_call)
       @operations = Operations.new(@api_call)
       @analytics = Analytics.new(@api_call)
+      @stemming = Stemming.new(@api_call)
       @presets = Presets.new(@api_call)
     end
   end

data/lib/typesense/stemming.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Typesense
+  class Stemming
+    RESOURCE_PATH = '/stemming'
+
+    def initialize(api_call)
+      @api_call = api_call
+    end
+
+    def dictionaries
+      @dictionaries ||= StemmingDictionaries.new(@api_call)
+    end
+  end
+end

data/lib/typesense/stemming_dictionaries.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Typesense
+  class StemmingDictionaries
+    RESOURCE_PATH = '/stemming/dictionaries'
+
+    def initialize(api_call)
+      @api_call = api_call
+      @dictionaries = {}
+    end
+
+    def upsert(dict_id, words_and_roots_combinations)
+      words_and_roots_combinations_in_jsonl = if words_and_roots_combinations.is_a?(Array)
+                                                words_and_roots_combinations.map { |combo| Oj.dump(combo, mode: :compat) }.join("\n")
+                                              else
+                                                words_and_roots_combinations
+                                              end
+
+      result_in_jsonl = @api_call.perform_request(
+        'post',
+        endpoint_path('import'),
+        query_parameters: { id: dict_id },
+        body_parameters: words_and_roots_combinations_in_jsonl,
+        additional_headers: { 'Content-Type' => 'text/plain' }
+      )
+
+      if words_and_roots_combinations.is_a?(Array)
+        result_in_jsonl.split("\n").map { |r| Oj.load(r) }
+      else
+        result_in_jsonl
+      end
+    end
+
+    def retrieve
+      response = @api_call.get(endpoint_path)
+      response || { 'dictionaries' => [] }
+    end
+
+    def [](dict_id)
+      @dictionaries[dict_id] ||= StemmingDictionary.new(dict_id, @api_call)
+    end
+
+    private
+
+    def endpoint_path(operation = nil)
+      "#{StemmingDictionaries::RESOURCE_PATH}#{operation.nil? ? '' : "/#{URI.encode_www_form_component(operation)}"}"
+    end
+  end
+end

data/lib/typesense/stemming_dictionary.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Typesense
+  class StemmingDictionary
+    def initialize(id, api_call)
+      @dict_id = id
+      @api_call = api_call
+    end
+
+    def retrieve
+      @api_call.get(endpoint_path)
+    end
+
+    private
+
+    def endpoint_path
+      "#{StemmingDictionaries::RESOURCE_PATH}/#{URI.encode_www_form_component(@dict_id)}"
+    end
+  end
+end

data/lib/typesense/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Typesense
-  VERSION = '3.0.0.rc1'
+  VERSION = '3.0.0'
 end

data/lib/typesense.rb

@@ -32,3 +32,6 @@ require_relative 'typesense/metrics'
 require_relative 'typesense/stats'
 require_relative 'typesense/operations'
 require_relative 'typesense/error'
+require_relative 'typesense/stemming'
+require_relative 'typesense/stemming_dictionaries'
+require_relative 'typesense/stemming_dictionary'

data/typesense.gemspec

@@ -26,6 +26,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'base64', '~> 0.2.0'
   spec.add_dependency 'faraday', '~> 2.8'
   spec.add_dependency 'oj', '~> 3.16'
   spec.metadata['rubygems_mfa_required'] = 'true'

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: typesense
 version: !ruby/object:Gem::Version
-  version: 3.0.0.rc1
+  version: 3.0.0
 platform: ruby
 authors:
 - Typesense, Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-20 00:00:00.000000000 Z
+date: 2025-02-18 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -91,6 +105,9 @@ files:
 - lib/typesense/preset.rb
 - lib/typesense/presets.rb
 - lib/typesense/stats.rb
+- lib/typesense/stemming.rb
+- lib/typesense/stemming_dictionaries.rb
+- lib/typesense/stemming_dictionary.rb
 - lib/typesense/synonym.rb
 - lib/typesense/synonyms.rb
 - lib/typesense/version.rb
@@ -111,9 +128,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.4.10
 signing_key: