Merge pull request #45 from tharropoulos/nl-search

feat(nl-search): add natural language search models support

Author: jasonbosco

.gitignore

@@ -1,4 +1,5 @@
 /.bundle/
+/vendor/
 /.yardoc
 /_yardoc/
 /coverage/

lib/typesense.rb

@@ -35,3 +35,5 @@ module Typesense
 require_relative 'typesense/stemming'
 require_relative 'typesense/stemming_dictionaries'
 require_relative 'typesense/stemming_dictionary'
+require_relative 'typesense/nl_search_models'
+require_relative 'typesense/nl_search_model'

lib/typesense/analytics_rules.rb

@@ -24,7 +24,7 @@ def [](rule_name)
     private
 
     def endpoint_path(operation = nil)
-      "#{AnalyticsRules::RESOURCE_PATH}#{operation.nil? ? '' : "/#{URI.encode_www_form_component(operation)}"}"
+      "#{AnalyticsRules::RESOURCE_PATH}#{"/#{URI.encode_www_form_component(operation)}" unless operation.nil?}"
     end
   end
 end

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, :stemming
+                :multi_search, :analytics, :presets, :stemming, :nl_search_models
 
     def initialize(options = {})
       @configuration = Configuration.new(options)
@@ -20,6 +20,7 @@ def initialize(options = {})
       @analytics = Analytics.new(@api_call)
       @stemming = Stemming.new(@api_call)
       @presets = Presets.new(@api_call)
+      @nl_search_models = NlSearchModels.new(@api_call)
     end
   end
 end

lib/typesense/documents.rb

@@ -88,7 +88,7 @@ def truncate
     private
 
     def endpoint_path(operation = nil)
-      "#{Collections::RESOURCE_PATH}/#{URI.encode_www_form_component(@collection_name)}#{Documents::RESOURCE_PATH}#{operation.nil? ? '' : "/#{operation}"}"
+      "#{Collections::RESOURCE_PATH}/#{URI.encode_www_form_component(@collection_name)}#{Documents::RESOURCE_PATH}#{"/#{operation}" unless operation.nil?}"
     end
   end
 end

lib/typesense/nl_search_model.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Typesense
+  class NlSearchModel
+    def initialize(model_id, api_call)
+      @model_id = model_id
+      @api_call = api_call
+    end
+
+    def retrieve
+      @api_call.get(endpoint_path)
+    end
+
+    def update(update_schema)
+      @api_call.put(endpoint_path, update_schema)
+    end
+
+    def delete
+      @api_call.delete(endpoint_path)
+    end
+
+    private
+
+    def endpoint_path
+      "#{NlSearchModels::RESOURCE_PATH}/#{URI.encode_www_form_component(@model_id)}"
+    end
+  end
+end

lib/typesense/nl_search_models.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Typesense
+  class NlSearchModels
+    RESOURCE_PATH = '/nl_search_models'
+
+    def initialize(api_call)
+      @api_call = api_call
+      @nl_search_models = {}
+    end
+
+    def create(schema)
+      @api_call.post(RESOURCE_PATH, schema)
+    end
+
+    def retrieve
+      @api_call.get(RESOURCE_PATH)
+    end
+
+    def [](model_id)
+      @nl_search_models[model_id] ||= NlSearchModel.new(model_id, @api_call)
+    end
+  end
+end

lib/typesense/overrides.rb

@@ -25,7 +25,7 @@ def [](override_id)
     private
 
     def endpoint_path(operation = nil)
-      "#{Collections::RESOURCE_PATH}/#{URI.encode_www_form_component(@collection_name)}#{Overrides::RESOURCE_PATH}#{operation.nil? ? '' : "/#{URI.encode_www_form_component(operation)}"}"
+      "#{Collections::RESOURCE_PATH}/#{URI.encode_www_form_component(@collection_name)}#{Overrides::RESOURCE_PATH}#{"/#{URI.encode_www_form_component(operation)}" unless operation.nil?}"
     end
   end
 end

lib/typesense/presets.rb

@@ -24,7 +24,7 @@ def [](preset_name)
     private
 
     def endpoint_path(operation = nil)
-      "#{Presets::RESOURCE_PATH}#{operation.nil? ? '' : "/#{URI.encode_www_form_component(operation)}"}"
+      "#{Presets::RESOURCE_PATH}#{"/#{URI.encode_www_form_component(operation)}" unless operation.nil?}"
     end
   end
 end

lib/typesense/stemming_dictionaries.rb

@@ -43,7 +43,7 @@ def [](dict_id)
     private
 
     def endpoint_path(operation = nil)
-      "#{StemmingDictionaries::RESOURCE_PATH}#{operation.nil? ? '' : "/#{URI.encode_www_form_component(operation)}"}"
+      "#{StemmingDictionaries::RESOURCE_PATH}#{"/#{URI.encode_www_form_component(operation)}" unless operation.nil?}"
     end
   end
 end