typesense 0.14.1 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1bb8d21314545a009551827388585832a78bf7ec685032959b9829a7870ddb9f
-  data.tar.gz: 4084625e3489791d29054738567b5e6eb60c05688f553121d035ef92ba85db8e
+  metadata.gz: 3b0902a6b96d21122114a769a6d55c55cba28880ace9b116a1e3c67251148bc9
+  data.tar.gz: 5b8bec6c747b00d61ed1028569272519d724b3262b3753753a2fea0c4b5db972
 SHA512:
-  metadata.gz: a3b6f7e798a06042e57d6c6282a2f9bc1f51921542b525c4369cb4d313900ba0a2eee739356c01062e3519d8d4e7cc8f977b3a732a49ff325e5a1df750eed165
-  data.tar.gz: ae3a68760647e57b966b24a352e215673d2eff16c5d0a3830729d2ece01ab2cbd1a60282ce2d72a2b2c504084da9088647b8520445cae06605a48b8ec712e52e
+  metadata.gz: 298131cd62bb16c8fc26797eb06ffb09689ec98553ef77ba3bd4811aff5f46de777bd6a9a62ac13665d95800189456557e741b89fbbec3911adc0ddd1cd008d3
+  data.tar.gz: db2215ce53918e3e37800ba596a0a7eb7a4b75127d266cf7081e94c6bfac87834ce881d6082c850041fff755ab9436f72de0f1e5f50d25b99f047f84819ed1fc

data/.github/workflows/tests.yml

@@ -0,0 +1,27 @@
+name: tests
+
+on: [push, pull_request]
+
+permissions:
+  contents: read
+
+jobs:
+  build_and_test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0']
+
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - run: bundle exec rubocop
+      - run: bundle exec rspec --format documentation
+      - uses: actions/upload-artifact@v3
+        with:
+          name: coverage
+          path: coverage/
+          retention-days: 1

data/README.md

@@ -1,4 +1,4 @@
-# Typesense Ruby Library [![Gem Version](https://badge.fury.io/rb/typesense.svg)](https://badge.fury.io/rb/typesense) [![CircleCI](https://circleci.com/gh/typesense/typesense-ruby.svg?style=shield&circle-token=063f2179925b0b37d540126f6c96f6e1fe23f1b9)](https://circleci.com/gh/typesense/typesense-ruby) [![codecov](https://codecov.io/gh/typesense/typesense-ruby/branch/master/graph/badge.svg)](https://codecov.io/gh/typesense/typesense-ruby)
+# Typesense Ruby Library [![Gem Version](https://badge.fury.io/rb/typesense.svg)](https://badge.fury.io/rb/typesense) 
 
 
 Ruby client library for accessing the [Typesense HTTP API](https://github.com/typesense/typesense).
@@ -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    |

data/examples/collections_and_documents.rb

@@ -187,7 +187,6 @@ ap document
 ##
 # Update a document. Unlike upsert, update will error out if the doc doesn't already exist.
 document = @typesense.collections['companies'].documents['124'].update(
-  'id' => 1,
   'num_employees' => 5500
 )
 ap document

data/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

data/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

data/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

data/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, :presets
 
     def initialize(options = {})
       @configuration = Configuration.new(options)
@@ -16,6 +16,8 @@ module Typesense
       @health = Health.new(@api_call)
       @metrics = Metrics.new(@api_call)
       @operations = Operations.new(@api_call)
+      @analytics = Analytics.new(@api_call)
+      @presets = Presets.new(@api_call)
     end
   end
 end

data/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

data/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

data/lib/typesense/version.rb

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

data/lib/typesense.rb

@@ -20,6 +20,11 @@ require_relative 'typesense/alias'
 require_relative 'typesense/keys'
 require_relative 'typesense/key'
 require_relative 'typesense/multi_search'
+require_relative 'typesense/analytics'
+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'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: typesense
 version: !ruby/object:Gem::Version
-  version: 0.14.1
+  version: 0.15.0
 platform: ruby
 authors:
 - Typesense, Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-21 00:00:00.000000000 Z
+date: 2023-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -256,7 +256,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".circleci/config.yml"
+- ".github/workflows/tests.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -278,6 +278,9 @@ files:
 - lib/typesense.rb
 - lib/typesense/alias.rb
 - lib/typesense/aliases.rb
+- lib/typesense/analytics.rb
+- lib/typesense/analytics_rule.rb
+- lib/typesense/analytics_rules.rb
 - lib/typesense/api_call.rb
 - lib/typesense/client.rb
 - lib/typesense/collection.rb
@@ -295,6 +298,8 @@ files:
 - lib/typesense/operations.rb
 - lib/typesense/override.rb
 - lib/typesense/overrides.rb
+- lib/typesense/preset.rb
+- lib/typesense/presets.rb
 - lib/typesense/synonym.rb
 - lib/typesense/synonyms.rb
 - lib/typesense/version.rb
@@ -318,7 +323,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.15
+rubygems_version: 3.0.9
 signing_key:
 specification_version: 4
 summary: Ruby Library for Typesense

data/.circleci/config.yml

@@ -1,69 +0,0 @@
-# Ruby CircleCI 2.0 configuration file
-#
-# Check https://circleci.com/docs/2.0/language-ruby/ for more details
-#
-version: 2
-jobs:
-  build:
-    docker:
-      # specify the version you desire here
-       - image: circleci/ruby:2.4.1-node-browsers
-
-      # Specify service dependencies here if necessary
-      # CircleCI maintains a library of pre-built images
-      # documented at https://circleci.com/docs/2.0/circleci-images/
-      # - image: circleci/postgres:9.4
-
-    working_directory: ~/repo
-
-    steps:
-      - checkout
-
-#      # Download and cache dependencies
-#      - restore_cache:
-#          keys:
-#          - v1-dependencies-{{ checksum "Gemfile.lock" }}
-#          # fallback to using the latest cache if no exact match is found
-#          - v1-dependencies-
-
-      - run:
-          name: install bundler
-          command: |
-            echo 'export BUNDLER_VERSION=$(cat Gemfile.lock | tail -1 | tr -d " ")' >> $BASH_ENV
-            source $BASH_ENV
-            gem install bundler
-
-      - run:
-          name: install dependencies
-          command: |
-            bundle install --jobs=4 --retry=3 --path vendor/bundle
-
-#      - save_cache:
-#          paths:
-#            - ./vendor/bundle
-#          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
-
-      - run:
-          name: lint
-          command: |
-            bundle exec rubocop
-
-      # run tests!
-      - run:
-          name: run tests
-          command: |
-            mkdir /tmp/test-results
-
-            bundle exec rspec --format documentation \
-                            --format RspecJunitFormatter \
-                            --out /tmp/test-results/rspec.xml
-
-      # collect reports
-      - store_test_results:
-          path: /tmp/test-results
-      - store_artifacts:
-          path: /tmp/test-results
-          destination: test-results
-      - store_artifacts:
-          path: coverage
-          destination: coverage