typesense 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '06109ee5575c2188f478655bff4795ecc880618c304b3f1c0e50211287f8f9d7'
-  data.tar.gz: 7771a1fa516b731a95554de2f5e9bfb168bc1eb62fb516f7475ba707a88e3826
+  metadata.gz: 941ee507b1ee46cb3235f82ac93318de3dbc625f572620f8deadb679eea694d5
+  data.tar.gz: a0955db04b6a1396321b99d3f27d7493cef43061b18b9d39730e6e585933cc76
 SHA512:
-  metadata.gz: eaab9b60b14196dcd217222f5e506ccec30758814e224e209c4d9df945cf8aecc94e16c1102fabd736850a714803539d294b940c0bd020ce51bf940a5ac1a95c
-  data.tar.gz: cf592673f925704675d79e163acd7e6ddc8319ef0a46ed2a2c9a1781da93d538e29c76432a7dd32dc1a93783b7e511bdc87ce063e77f40705346bd5d524114c4
+  metadata.gz: ea253619d869583cd9e6945c05a693eb74444fc0506d3526a1eceec3eecebc38850f6f79051489bd68dde242618f2a0c40835048738fc6fa89917b52b3437892
+  data.tar.gz: 441c80f4304b6944c888bd73ddccda5cb361af247fd01d545a8e663f909a131758e1611b3936337fca39e4c981d636a6c61e208c64bb37b4205018c7e2348867

data/examples/search.rb

@@ -110,7 +110,9 @@ ap results
 # Search for more documents
 results = @typesense.collections['companies'].documents.search(
   'q' => 'Non-existent',
-  'query_by' => 'company_name'
+  'query_by' => 'company_name',
+  # Optionally add a user id if you use Analytics & Query Suggestions
+  'x-typesense-user-id' => 42
 )
 ap results
 

data/lib/typesense/alias.rb

@@ -18,7 +18,7 @@ module Typesense
     private
 
     def endpoint_path
-      "#{Aliases::RESOURCE_PATH}/#{@name}"
+      "#{Aliases::RESOURCE_PATH}/#{ERB::Util.url_encode(@name)}"
     end
   end
 end

data/lib/typesense/aliases.rb

@@ -24,7 +24,7 @@ module Typesense
     private
 
     def endpoint_path(alias_name)
-      "#{Aliases::RESOURCE_PATH}/#{alias_name}"
+      "#{Aliases::RESOURCE_PATH}/#{ERB::Util.url_encode(alias_name)}"
     end
   end
 end

data/lib/typesense/analytics_rule.rb

@@ -18,7 +18,7 @@ module Typesense
     private
 
     def endpoint_path
-      "#{AnalyticsRules::RESOURCE_PATH}/#{@rule_name}"
+      "#{AnalyticsRules::RESOURCE_PATH}/#{ERB::Util.url_encode(@rule_name)}"
     end
   end
 end

data/lib/typesense/analytics_rules.rb

@@ -24,7 +24,7 @@ module Typesense
     private
 
     def endpoint_path(operation = nil)
-      "#{AnalyticsRules::RESOURCE_PATH}#{operation.nil? ? '' : "/#{operation}"}"
+      "#{AnalyticsRules::RESOURCE_PATH}#{operation.nil? ? '' : "/#{ERB::Util.url_encode(operation)}"}"
     end
   end
 end

data/lib/typesense/collection.rb

@@ -27,7 +27,7 @@ module Typesense
     private
 
     def endpoint_path
-      "#{Collections::RESOURCE_PATH}/#{@name}"
+      "#{Collections::RESOURCE_PATH}/#{ERB::Util.url_encode(@name)}"
     end
   end
 end

data/lib/typesense/collections.rb

@@ -13,8 +13,8 @@ module Typesense
       @api_call.post(RESOURCE_PATH, schema)
     end
 
-    def retrieve
-      @api_call.get(RESOURCE_PATH)
+    def retrieve(options = {})
+      @api_call.get(RESOURCE_PATH, options)
     end
 
     def [](collection_name)

data/lib/typesense/document.rb

@@ -23,7 +23,7 @@ module Typesense
     private
 
     def endpoint_path
-      "#{Collections::RESOURCE_PATH}/#{@collection_name}#{Documents::RESOURCE_PATH}/#{@document_id}"
+      "#{Collections::RESOURCE_PATH}/#{ERB::Util.url_encode(@collection_name)}#{Documents::RESOURCE_PATH}/#{ERB::Util.url_encode(@document_id)}"
     end
   end
 end

data/lib/typesense/documents.rb

@@ -75,7 +75,7 @@ module Typesense
     private
 
     def endpoint_path(operation = nil)
-      "#{Collections::RESOURCE_PATH}/#{@collection_name}#{Documents::RESOURCE_PATH}#{operation.nil? ? '' : "/#{operation}"}"
+      "#{Collections::RESOURCE_PATH}/#{ERB::Util.url_encode(@collection_name)}#{Documents::RESOURCE_PATH}#{operation.nil? ? '' : "/#{operation}"}"
     end
   end
 end

data/lib/typesense/key.rb

@@ -18,7 +18,7 @@ module Typesense
     private
 
     def endpoint_path
-      "#{Keys::RESOURCE_PATH}/#{@id}"
+      "#{Keys::RESOURCE_PATH}/#{ERB::Util.url_encode(@id)}"
     end
   end
 end

data/lib/typesense/override.rb

@@ -19,7 +19,7 @@ module Typesense
     private
 
     def endpoint_path
-      "#{Collections::RESOURCE_PATH}/#{@collection_name}#{Overrides::RESOURCE_PATH}/#{@override_id}"
+      "#{Collections::RESOURCE_PATH}/#{ERB::Util.url_encode(@collection_name)}#{Overrides::RESOURCE_PATH}/#{ERB::Util.url_encode(@override_id)}"
     end
   end
 end

data/lib/typesense/overrides.rb

@@ -25,7 +25,7 @@ module Typesense
     private
 
     def endpoint_path(operation = nil)
-      "#{Collections::RESOURCE_PATH}/#{@collection_name}#{Overrides::RESOURCE_PATH}#{operation.nil? ? '' : "/#{operation}"}"
+      "#{Collections::RESOURCE_PATH}/#{ERB::Util.url_encode(@collection_name)}#{Overrides::RESOURCE_PATH}#{operation.nil? ? '' : "/#{ERB::Util.url_encode(operation)}"}"
     end
   end
 end

data/lib/typesense/preset.rb

@@ -18,7 +18,7 @@ module Typesense
     private
 
     def endpoint_path
-      "#{Presets::RESOURCE_PATH}/#{@preset_name}"
+      "#{Presets::RESOURCE_PATH}/#{ERB::Util.url_encode(@preset_name)}"
     end
   end
 end

data/lib/typesense/presets.rb

@@ -24,7 +24,7 @@ module Typesense
     private
 
     def endpoint_path(operation = nil)
-      "#{Presets::RESOURCE_PATH}#{operation.nil? ? '' : "/#{operation}"}"
+      "#{Presets::RESOURCE_PATH}#{operation.nil? ? '' : "/#{ERB::Util.url_encode(operation)}"}"
     end
   end
 end

data/lib/typesense/synonym.rb

@@ -19,7 +19,7 @@ module Typesense
     private
 
     def endpoint_path
-      "#{Collections::RESOURCE_PATH}/#{@collection_name}#{Synonyms::RESOURCE_PATH}/#{@synonym_id}"
+      "#{Collections::RESOURCE_PATH}/#{ERB::Util.url_encode(@collection_name)}#{Synonyms::RESOURCE_PATH}/#{ERB::Util.url_encode(@synonym_id)}"
     end
   end
 end

data/lib/typesense/synonyms.rb

@@ -25,7 +25,7 @@ module Typesense
     private
 
     def endpoint_path(operation = nil)
-      "#{Collections::RESOURCE_PATH}/#{@collection_name}#{Synonyms::RESOURCE_PATH}#{operation.nil? ? '' : "/#{operation}"}"
+      "#{Collections::RESOURCE_PATH}/#{ERB::Util.url_encode(@collection_name)}#{Synonyms::RESOURCE_PATH}#{operation.nil? ? '' : "/#{ERB::Util.url_encode(operation)}"}"
     end
   end
 end

data/lib/typesense/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Typesense
-  VERSION = '1.0.0'
+  VERSION = '2.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: typesense
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Typesense, Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-25 00:00:00.000000000 Z
+date: 2024-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj