Add support for analytics rules

Author: jasonbosco

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 |
 |------------------|----------------|
+| \>= v0.25.0      | \>= v0.15.0    |
 | \>= v0.23.0      | \>= v0.14.0    |
 | \>= v0.21.0      | \>= v0.13.0    |
 | \>= v0.20.0      | \>= v0.12.0    |

lib/typesense.rb

@@ -20,6 +20,9 @@ module Typesense
 require_relative 'typesense/keys'
 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/debug'
 require_relative 'typesense/health'
 require_relative 'typesense/metrics'

lib/typesense/analytics.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Typesense
+  class Analytics
+    RESOURCE_PATH = '/analytics'
+
+    def initialize(api_call)
+      @api_call = api_call
+    end
+
+    def rules
+      @rules ||= AnalyticsRules.new(@api_call)
+    end
+  end
+end

lib/typesense/analytics_rule.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Typesense
+  class AnalyticsRule
+    def initialize(rule_name, api_call)
+      @rule_name = rule_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
+      "#{AnalyticsRules::RESOURCE_PATH}/#{@rule_name}"
+    end
+  end
+end

lib/typesense/analytics_rules.rb

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

lib/typesense/client.rb

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

spec/typesense/analytics_rule_spec.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require_relative '../spec_helper'
+require_relative 'shared_configuration_context'
+
+describe Typesense::AnalyticsRule do
+  subject(:analytics_rule) { typesense.analytics.rules['search_suggestions'] }
+
+  include_context 'with Typesense configuration'
+
+  let(:analytics_rule_data) do
+    {
+      'name' => 'search_suggestions',
+      'type' => 'popular_queries',
+      'params' => {
+        'source' => { 'collections' => ['products'] },
+        'destination' => { 'collection' => 'products_top_queries' },
+        'limit' => 100
+      }
+    }
+  end
+
+  describe '#retrieve' do
+    it 'returns the specified analytics rule' do
+      stub_request(:get, Typesense::ApiCall.new(typesense.configuration).send(:uri_for, '/analytics/rules/search_suggestions', 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(analytics_rule_data), headers: { 'Content-Type': 'application/json' })
+
+      result = analytics_rule.retrieve
+
+      expect(result).to eq(analytics_rule_data)
+    end
+  end
+
+  describe '#delete' do
+    it 'deletes the specified analytics rule' do
+      stub_request(:delete, Typesense::ApiCall.new(typesense.configuration).send(:uri_for, '/analytics/rules/search_suggestions', typesense.configuration.nodes[0]))
+        .with(headers: {
+                'X-Typesense-Api-Key' => typesense.configuration.api_key
+              })
+        .to_return(status: 200, body: JSON.dump('name' => 'search_suggestions'), headers: { 'Content-Type': 'application/json' })
+
+      result = analytics_rule.delete
+
+      expect(result).to eq('name' => 'search_suggestions')
+    end
+  end
+end

spec/typesense/analytics_rules_spec.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require_relative '../spec_helper'
+require_relative 'shared_configuration_context'
+
+describe Typesense::AnalyticsRules do
+  subject(:analytics_rules) { typesense.analytics.rules }
+
+  include_context 'with Typesense configuration'
+
+  let(:analytics_rule) do
+    {
+      'name' => 'search_suggestions',
+      'type' => 'popular_queries',
+      'params' => {
+        'source' => { 'collections' => ['products'] },
+        'destination' => { 'collection' => 'products_top_queries' },
+        'limit' => 100
+      }
+    }
+  end
+
+  describe '#upsert' do
+    it 'creates a rule and returns it' do
+      stub_request(:put, Typesense::ApiCall.new(typesense.configuration).send(:uri_for, '/analytics/rules/search_suggestions', typesense.configuration.nodes[0]))
+        .with(body: analytics_rule,
+              headers: {
+                'X-Typesense-Api-Key' => typesense.configuration.api_key,
+                'Content-Type' => 'application/json'
+              })
+        .to_return(status: 201, body: JSON.dump(analytics_rule), headers: { 'Content-Type': 'application/json' })
+
+      result = typesense.analytics.rules.upsert(analytics_rule['name'], analytics_rule)
+
+      expect(result).to eq(analytics_rule)
+    end
+  end
+
+  describe '#retrieve' do
+    it 'retrieves all analytics rules' do
+      stub_request(:get, Typesense::ApiCall.new(typesense.configuration).send(:uri_for, '/analytics/rules', 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([analytics_rule]), headers: { 'Content-Type': 'application/json' })
+
+      result = analytics_rules.retrieve
+
+      expect(result).to eq([analytics_rule])
+    end
+  end
+
+  describe '#[]' do
+    it 'creates an analytics rule object and returns it' do
+      result = analytics_rules['search_suggestions']
+
+      expect(result).to be_a_kind_of(Typesense::AnalyticsRule)
+      expect(result.instance_variable_get(:@rule_name)).to eq('search_suggestions')
+    end
+  end
+end