Add support for presets

Author: jasonbosco

lib/typesense.rb

@@ -21,8 +21,10 @@ module Typesense
 require_relative 'typesense/key'
 require_relative 'typesense/multi_search'
 require_relative 'typesense/analytics'
-require_relative 'typesense/analytics_rule'
 require_relative 'typesense/analytics_rules'
+require_relative 'typesense/analytics_rule'
+require_relative 'typesense/presets'
+require_relative 'typesense/preset'
 require_relative 'typesense/debug'
 require_relative 'typesense/health'
 require_relative 'typesense/metrics'

lib/typesense/client.rb

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

lib/typesense/preset.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Typesense
+  class Preset
+    def initialize(preset_name, api_call)
+      @preset_name = preset_name
+      @api_call = api_call
+    end
+
+    def retrieve
+      @api_call.get(endpoint_path)
+    end
+
+    def delete
+      @api_call.delete(endpoint_path)
+    end
+
+    private
+
+    def endpoint_path
+      "#{Presets::RESOURCE_PATH}/#{@preset_name}"
+    end
+  end
+end

lib/typesense/presets.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Typesense
+  class Presets
+    RESOURCE_PATH = '/presets'
+
+    def initialize(api_call)
+      @api_call = api_call
+      @presets = {}
+    end
+
+    def upsert(preset_name, params)
+      @api_call.put(endpoint_path(preset_name), params)
+    end
+
+    def retrieve
+      @api_call.get(endpoint_path)
+    end
+
+    def [](preset_name)
+      @presets[preset_name] ||= Preset.new(preset_name, @api_call)
+    end
+
+    private
+
+    def endpoint_path(operation = nil)
+      "#{Presets::RESOURCE_PATH}#{operation.nil? ? '' : "/#{operation}"}"
+    end
+  end
+end

spec/typesense/preset_spec.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require_relative '../spec_helper'
+require_relative 'shared_configuration_context'
+
+describe Typesense::Preset do
+  subject(:preset) { typesense.presets['search-view'] }
+
+  include_context 'with Typesense configuration'
+
+  let(:preset_data) do
+    {
+      'name' => 'search-view',
+      'value' => {
+        'query_by' => 'title,subjects,author',
+        'query_by_weights' => '1,4,8',
+        'sort_by' => '_text_match:desc'
+      }
+    }
+  end
+
+  describe '#retrieve' do
+    it 'returns the specified preset' do
+      stub_request(:get, Typesense::ApiCall.new(typesense.configuration).send(:uri_for, '/presets/search-view', typesense.configuration.nodes[0]))
+        .with(headers: {
+                'X-Typesense-Api-Key' => typesense.configuration.api_key,
+                'Content-Type': 'application/json'
+              })
+        .to_return(status: 200, body: JSON.dump(preset_data), headers: { 'Content-Type': 'application/json' })
+
+      result = preset.retrieve
+
+      expect(result).to eq(preset_data)
+    end
+  end
+
+  describe '#delete' do
+    it 'deletes the specified preset' do
+      stub_request(:delete, Typesense::ApiCall.new(typesense.configuration).send(:uri_for, '/presets/search-view', typesense.configuration.nodes[0]))
+        .with(headers: {
+                'X-Typesense-Api-Key' => typesense.configuration.api_key
+              })
+        .to_return(status: 200, body: JSON.dump('name' => 'search-view'), headers: { 'Content-Type': 'application/json' })
+
+      result = preset.delete
+
+      expect(result).to eq('name' => 'search-view')
+    end
+  end
+end

spec/typesense/presets_spec.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require_relative '../spec_helper'
+require_relative 'shared_configuration_context'
+
+describe Typesense::Presets do
+  subject(:presets) { typesense.presets }
+
+  include_context 'with Typesense configuration'
+
+  let(:preset_data) do
+    {
+      'name' => 'search-view',
+      'value' => {
+        'query_by' => 'title,subjects,author',
+        'query_by_weights' => '1,4,8',
+        'sort_by' => '_text_match:desc'
+      }
+    }
+  end
+
+  describe '#upsert' do
+    it 'creates a preset and returns it' do
+      stub_request(:put, Typesense::ApiCall.new(typesense.configuration).send(:uri_for, '/presets/search-view', typesense.configuration.nodes[0]))
+        .with(body: preset_data,
+              headers: {
+                'X-Typesense-Api-Key' => typesense.configuration.api_key,
+                'Content-Type' => 'application/json'
+              })
+        .to_return(status: 201, body: JSON.dump(preset_data), headers: { 'Content-Type': 'application/json' })
+
+      result = presets.upsert(preset_data['name'], preset_data)
+
+      expect(result).to eq(preset_data)
+    end
+  end
+
+  describe '#retrieve' do
+    it 'retrieves all presets' do
+      stub_request(:get, Typesense::ApiCall.new(typesense.configuration).send(:uri_for, '/presets', typesense.configuration.nodes[0]))
+        .with(headers: {
+                'X-Typesense-Api-Key' => typesense.configuration.api_key,
+                'Content-Type' => 'application/json'
+              })
+        .to_return(status: 201, body: JSON.dump([preset_data]), headers: { 'Content-Type': 'application/json' })
+
+      result = presets.retrieve
+
+      expect(result).to eq([preset_data])
+    end
+  end
+
+  describe '#[]' do
+    it 'creates a preset object and returns it' do
+      result = presets['search-view']
+
+      expect(result).to be_a_kind_of(Typesense::Preset)
+      expect(result.instance_variable_get(:@preset_name)).to eq('search-view')
+    end
+  end
+end