diff --git a/lib/typesense.rb b/lib/typesense.rb index 84ce51c..2d64bd3 100644 --- a/lib/typesense.rb +++ b/lib/typesense.rb @@ -18,6 +18,8 @@ module Typesense require_relative 'typesense/synonym' require_relative 'typesense/synonym_sets' require_relative 'typesense/synonym_set' +require_relative 'typesense/synonym_set_items' +require_relative 'typesense/synonym_set_item' require_relative 'typesense/aliases' require_relative 'typesense/alias' require_relative 'typesense/keys' diff --git a/lib/typesense/analytics_rule.rb b/lib/typesense/analytics_rule.rb index d113f70..cab6c65 100644 --- a/lib/typesense/analytics_rule.rb +++ b/lib/typesense/analytics_rule.rb @@ -27,15 +27,16 @@ def delete @api_call.delete(endpoint_path) end - # Upserts an analytics rule with the given name. + # Create or update an analytics rule with the given name. # # @example - # client.analytics.rules['products_query_hits'].update('type' => 'popular_queries', 'params' => {}) + # client.analytics.rules['products_click_counter'].upsert('type' => 'counter', 'collection' => 'products', 'event_type' => 'click', 'params' => { 'counter_field' => 'popularity', 'weight' => 1 }) # # @see https://typesense.org/docs/latest/api/analytics-query-suggestions.html - def update(params) + def upsert(params) @api_call.put(endpoint_path, params) end + alias update upsert private diff --git a/lib/typesense/analytics_rules.rb b/lib/typesense/analytics_rules.rb index dd352b9..f6dbf59 100644 --- a/lib/typesense/analytics_rules.rb +++ b/lib/typesense/analytics_rules.rb @@ -18,14 +18,26 @@ def create(rules) @api_call.post(self.class::RESOURCE_PATH, rules) end - # Retrieve all analytics rules. + # Create or update an analytics rule with the given name. + # + # @example + # client.analytics.rules.upsert('products_click_counter', 'type' => 'counter', 'collection' => 'products', 'event_type' => 'click', 'params' => { 'counter_field' => 'popularity', 'weight' => 1 }) + # + # @see https://typesense.org/docs/latest/api/analytics-query-suggestions.html + def upsert(rule_name, params) + @api_call.put("#{self.class::RESOURCE_PATH}/#{URI.encode_www_form_component(rule_name)}", params) + end + + # Retrieve all analytics rules. Pass `rule_tag` to only retrieve the rules with that tag. # # @example # client.analytics.rules.retrieve + # @example + # client.analytics.rules.retrieve(rule_tag: 'homepage') # # @see https://typesense.org/docs/latest/api/analytics-query-suggestions.html - def retrieve - @api_call.get(self.class::RESOURCE_PATH) + def retrieve(params = {}) + @api_call.get(self.class::RESOURCE_PATH, params) end # Access an individual analytics rule by name. diff --git a/lib/typesense/synonym_set.rb b/lib/typesense/synonym_set.rb index e4b3211..34d9da5 100644 --- a/lib/typesense/synonym_set.rb +++ b/lib/typesense/synonym_set.rb @@ -2,9 +2,23 @@ module Typesense class SynonymSet + # Access the items in this synonym set. Use it to list items, or as an array + # to access a single item by ID. + # + # @example + # client.synonym_sets['my-set'].items.retrieve + # @example + # client.synonym_sets['my-set'].items['smart-phone-synonyms'].retrieve + # + # @see https://typesense.org/docs/latest/api/synonyms.html + # + # @return [SynonymSetItems] + attr_reader :items + def initialize(synonym_set_name, api_call) @synonym_set_name = synonym_set_name @api_call = api_call + @items = SynonymSetItems.new(@synonym_set_name, @api_call) end # Create or update a synonym set with the given name diff --git a/lib/typesense/synonym_set_item.rb b/lib/typesense/synonym_set_item.rb new file mode 100644 index 0000000..2cd441a --- /dev/null +++ b/lib/typesense/synonym_set_item.rb @@ -0,0 +1,47 @@ +# frozen_string_literal: true + +module Typesense + class SynonymSetItem + def initialize(synonym_set_name, item_id, api_call) + @synonym_set_name = synonym_set_name + @item_id = item_id + @api_call = api_call + end + + # Retrieve a specific synonym item by its id + # + # @example + # client.synonym_sets['my-set'].items['smart-phone-synonyms'].retrieve + # + # @see https://typesense.org/docs/latest/api/synonyms.html + def retrieve + @api_call.get(endpoint_path) + end + + # Create or update a synonym item with the given id + # + # @example + # client.synonym_sets['my-set'].items['smart-phone-synonyms'].upsert('synonyms' => ['smart phone', 'iphone']) + # + # @see https://typesense.org/docs/latest/api/synonyms.html + def upsert(params) + @api_call.put(endpoint_path, params) + end + + # Delete a specific synonym item by its id + # + # @example + # client.synonym_sets['my-set'].items['smart-phone-synonyms'].delete + # + # @see https://typesense.org/docs/latest/api/synonyms.html + def delete + @api_call.delete(endpoint_path) + end + + private + + def endpoint_path + "#{SynonymSets::RESOURCE_PATH}/#{URI.encode_www_form_component(@synonym_set_name)}/items/#{URI.encode_www_form_component(@item_id)}" + end + end +end diff --git a/lib/typesense/synonym_set_items.rb b/lib/typesense/synonym_set_items.rb new file mode 100644 index 0000000..464de2b --- /dev/null +++ b/lib/typesense/synonym_set_items.rb @@ -0,0 +1,39 @@ +# frozen_string_literal: true + +module Typesense + class SynonymSetItems + def initialize(synonym_set_name, api_call) + @synonym_set_name = synonym_set_name + @api_call = api_call + @items = {} + end + + # Retrieve all synonym items in a set + # + # @example + # client.synonym_sets['my-set'].items.retrieve + # + # @see https://typesense.org/docs/latest/api/synonyms.html + def retrieve + @api_call.get(endpoint_path) + end + + # Access an individual synonym item by ID within this synonym set. + # + # @example + # client.synonym_sets['my-set'].items['smart-phone-synonyms'].retrieve + # + # @see https://typesense.org/docs/latest/api/synonyms.html + # + # @return [SynonymSetItem] + def [](item_id) + @items[item_id] ||= SynonymSetItem.new(@synonym_set_name, item_id, @api_call) + end + + private + + def endpoint_path + "#{SynonymSets::RESOURCE_PATH}/#{URI.encode_www_form_component(@synonym_set_name)}/items" + end + end +end diff --git a/spec/typesense/analytics_rule_spec.rb b/spec/typesense/analytics_rule_spec.rb index 18bcef5..4eef152 100644 --- a/spec/typesense/analytics_rule_spec.rb +++ b/spec/typesense/analytics_rule_spec.rb @@ -135,4 +135,17 @@ expect(result['params']['weight']).to eq(5) end end + + describe '#upsert' do + it 'is aliased as #update' do + expect(described_class.instance_method(:update)).to eq(described_class.instance_method(:upsert)) + end + + it 'creates the analytics rule if it does not exist yet' do + result = integration_client.analytics.rules['test__new_rule'].upsert(rule_configuration.except('name')) + + expect(result['name']).to eq('test__new_rule') + expect(integration_client.analytics.rules['test__new_rule'].retrieve['type']).to eq('counter') + end + end end diff --git a/spec/typesense/analytics_rules_spec.rb b/spec/typesense/analytics_rules_spec.rb index bdc7d9c..36618a0 100644 --- a/spec/typesense/analytics_rules_spec.rb +++ b/spec/typesense/analytics_rules_spec.rb @@ -137,6 +137,39 @@ rule_names = result.map { |rule| rule['name'] } expect(rule_names).to include(rule_name) end + + it 'filters analytics rules by rule_tag' do + integration_client.analytics.rules.upsert('test__other_rule', rule_configuration.except('name').merge('rule_tag' => 'other_tag')) + + result = integration_client.analytics.rules.retrieve(rule_tag: 'test_tag') + + rule_names = result.map { |rule| rule['name'] } + expect(rule_names).to include(rule_name) + expect(rule_names).not_to include('test__other_rule') + expect(result.map { |rule| rule['rule_tag'] }).to all(eq('test_tag')) + end + end + + describe '#upsert' do + it 'creates a rule that does not exist yet' do + result = integration_client.analytics.rules.upsert('test__upserted rule', rule_configuration.except('name')) + + expect(result['name']).to eq('test__upserted rule') + expect(integration_client.analytics.rules['test__upserted rule'].retrieve['rule_tag']).to eq('test_tag') + end + + it 'updates an existing rule' do + update_params = rule_configuration.except('name').merge( + 'rule_tag' => 'updated_tag', + 'params' => { 'counter_field' => 'popularity', 'weight' => 5 } + ) + + result = integration_client.analytics.rules.upsert(rule_name, update_params) + + expect(result['name']).to eq(rule_name) + expect(result['rule_tag']).to eq('updated_tag') + expect(result['params']['weight']).to eq(5) + end end describe '#[]' do diff --git a/spec/typesense/synonym_set_item_spec.rb b/spec/typesense/synonym_set_item_spec.rb new file mode 100644 index 0000000..c2581f2 --- /dev/null +++ b/spec/typesense/synonym_set_item_spec.rb @@ -0,0 +1,89 @@ +# frozen_string_literal: true + +require_relative '../spec_helper' + +describe Typesense::SynonymSetItem do + subject(:synonym_set_item) { typesense.synonym_sets['test-synonym-set'].items['smart-phone-synonyms'] } + + let(:typesense) do + Typesense::Client.new( + api_key: 'xyz', + nodes: [ + { + host: 'localhost', + port: 8108, + protocol: 'http' + } + ], + connection_timeout_seconds: 10, + retry_interval_seconds: 0.01 + ) + end + + let(:synonym_set_data) do + { + 'items' => [ + { + 'id' => 'smart-phone-synonyms', + 'synonyms' => ['smart phone', 'android', 'iphone'], + 'root' => '' + } + ] + } + end + + before do + skip('SynonymSets is only supported in Typesense v30+') unless typesense_v30_or_above? + + typesense.synonym_sets.upsert('test-synonym-set', synonym_set_data) + end + + after do + typesense.synonym_sets['test-synonym-set'].delete + rescue StandardError + # Ignore errors if already deleted + end + + describe '#retrieve' do + it 'returns the specified synonym set item' do + skip('SynonymSets is only supported in Typesense v30+') unless typesense_v30_or_above? + + result = synonym_set_item.retrieve + + expect(result).to eq(synonym_set_data['items'].first) + end + end + + describe '#upsert' do + it 'updates the specified synonym set item' do + skip('SynonymSets is only supported in Typesense v30+') unless typesense_v30_or_above? + + result = synonym_set_item.upsert('synonyms' => %w[smartphone mobile], 'root' => 'smartphone') + + expect(result['id']).to eq('smart-phone-synonyms') + expect(result['synonyms']).to eq(%w[smartphone mobile]) + expect(result['root']).to eq('smartphone') + end + + it 'creates an item that does not exist yet' do + skip('SynonymSets is only supported in Typesense v30+') unless typesense_v30_or_above? + + typesense.synonym_sets['test-synonym-set'].items['tablet synonyms'].upsert('synonyms' => %w[tablet ipad]) + + items = typesense.synonym_sets['test-synonym-set'].items.retrieve + expect(items.map { |item| item['id'] }).to contain_exactly('smart-phone-synonyms', 'tablet synonyms') + end + end + + describe '#delete' do + it 'deletes the specified synonym set item' do + skip('SynonymSets is only supported in Typesense v30+') unless typesense_v30_or_above? + + result = synonym_set_item.delete + + expect(result['id']).to eq('smart-phone-synonyms') + + expect { synonym_set_item.retrieve }.to raise_error(Typesense::Error::ObjectNotFound) + end + end +end diff --git a/spec/typesense/synonym_set_items_spec.rb b/spec/typesense/synonym_set_items_spec.rb new file mode 100644 index 0000000..c8203fb --- /dev/null +++ b/spec/typesense/synonym_set_items_spec.rb @@ -0,0 +1,68 @@ +# frozen_string_literal: true + +require_relative '../spec_helper' + +describe Typesense::SynonymSetItems do + subject(:synonym_set_items) { typesense.synonym_sets['test synonym set'].items } + + let(:typesense) do + Typesense::Client.new( + api_key: 'xyz', + nodes: [ + { + host: 'localhost', + port: 8108, + protocol: 'http' + } + ], + connection_timeout_seconds: 10, + retry_interval_seconds: 0.01 + ) + end + + let(:synonym_set_data) do + { + 'items' => [ + { + 'id' => 'smart-phone-synonyms', + 'synonyms' => ['smart phone', 'android', 'iphone'], + 'root' => '' + } + ] + } + end + + before do + skip('SynonymSets is only supported in Typesense v30+') unless typesense_v30_or_above? + + typesense.synonym_sets.upsert('test synonym set', synonym_set_data) + end + + after do + typesense.synonym_sets['test synonym set'].delete + rescue StandardError + # Ignore errors if already deleted + end + + describe '#retrieve' do + it 'retrieves all items in a synonym set' do + skip('SynonymSets is only supported in Typesense v30+') unless typesense_v30_or_above? + + result = synonym_set_items.retrieve + + expect(result).to eq(synonym_set_data['items']) + end + end + + describe '#[]' do + it 'creates a synonym set item object and returns it' do + skip('SynonymSets is only supported in Typesense v30+') unless typesense_v30_or_above? + + result = synonym_set_items['smart-phone-synonyms'] + + expect(result).to be_a(Typesense::SynonymSetItem) + expect(result.instance_variable_get(:@synonym_set_name)).to eq('test synonym set') + expect(result.instance_variable_get(:@item_id)).to eq('smart-phone-synonyms') + end + end +end diff --git a/spec/typesense/synonym_set_spec.rb b/spec/typesense/synonym_set_spec.rb index 751e4c0..4fe96d9 100644 --- a/spec/typesense/synonym_set_spec.rb +++ b/spec/typesense/synonym_set_spec.rb @@ -66,6 +66,15 @@ end end + describe '#items' do + it 'returns the items of the synonym set' do + skip('SynonymSets is only supported in Typesense v30+') unless typesense_v30_or_above? + + expect(synonym_set.items).to be_a(Typesense::SynonymSetItems) + expect(synonym_set.items.retrieve).to eq(synonym_set_data['items']) + end + end + describe '#delete' do it 'deletes the specified synonym set' do skip('SynonymSets is only supported in Typesense v30+') unless typesense_v30_or_above?