elastic-enterprise-search 7.13.0 → 7.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f34ee86d14a96362e791a8f5542bf4a4da9ff48df0ee92b35996f08c56219ce
-  data.tar.gz: 11be1147329f5adafc17769b825c7262a9d3d4309a705233ceebe24b36c3dc05
+  metadata.gz: 1eef7550b4a936e514eb9b0eb52272a2b445b3e54c301c7cec29039c789561ee
+  data.tar.gz: 47ab2fcbb9b00a3cbb219e713ee9308642345b72dcc6af5b9f0f1f334edd7c09
 SHA512:
-  metadata.gz: c867f7c2c897cade800f5e6c6c415eece5c939f53996246378021cb584a39a5b768b02459525741fa3d59654a44893ce8d0c02084a22daf3d7c352230fcf3895
-  data.tar.gz: 368a0e0137e5315ca34c5b661cca686eff108a2ee31a7951bc1043e57558bc3d48b403dc3d5c03967da7c7fdf6b24cd03018889f6651760e22a6db6d5da17f0e
+  metadata.gz: 38a4519bfa5d4b3ea04507468b0c5ddb7122d8c5c928943b45d3d1ce120d3a1652ac7c2aff217082aaca4cdc3124b732e4f31c265bf5c6f0cdc0173672e020f0
+  data.tar.gz: 7cd26fe0a7fc874ccbcfb16ef443d5c9ddd69b0a882690dcbfc0b90d698a10bd89d942530ba93aae78531cddc6960721edd8d2a410728be87aacd018e1aeed31

data/.ci/make.sh

@@ -0,0 +1,162 @@
+#!/usr/bin/env bash
+
+# ------------------------------------------------------- #
+#
+# Skeleton for common build entry script for all elastic
+# clients. Needs to be adapted to individual client usage.
+#
+# Must be called: ./.ci/make.sh <target> <params>
+#
+# Version: 1.1.0
+#
+# Targets:
+# ---------------------------
+# assemble <VERSION> : build client artefacts with version
+# bump     <VERSION> : bump client internals to version
+# codegen  <VERSION> : generate endpoints
+# docsgen  <VERSION> : generate documentation
+# examplegen         : generate the doc examples
+# clean              : clean workspace
+#
+# ------------------------------------------------------- #
+
+# ------------------------------------------------------- #
+# Bootstrap
+# ------------------------------------------------------- #
+
+script_path=$(dirname "$(realpath -s "$0")")
+repo=$(realpath "$script_path/../")
+
+# shellcheck disable=SC1090
+CMD=$1
+TASK=$1
+TASK_ARGS=()
+VERSION=$2
+STACK_VERSION=$VERSION
+set -euo pipefail
+
+product="elastic/enterprise-search-ruby"
+output_folder=".ci/output"
+codegen_folder=".ci/output"
+OUTPUT_DIR="$repo/${output_folder}"
+REPO_BINDING="${OUTPUT_DIR}:/sln/${output_folder}"
+mkdir -p "$OUTPUT_DIR"
+
+echo -e "\033[34;1mINFO:\033[0m PRODUCT ${product}\033[0m"
+echo -e "\033[34;1mINFO:\033[0m VERSION ${STACK_VERSION}\033[0m"
+echo -e "\033[34;1mINFO:\033[0m OUTPUT_DIR ${OUTPUT_DIR}\033[0m"
+
+RUBY_TEST_VERSION=${RUBY_TEST_VERSION-2.7}
+
+case $CMD in
+    clean)
+        echo -e "\033[36;1mTARGET: clean workspace $output_folder\033[0m"
+        rm -rf "$output_folder"
+        echo -e "\033[32;1mdone.\033[0m"
+        exit 0
+        ;;
+    assemble)
+        if [ -v $VERSION ]; then
+            echo -e "\033[31;1mTARGET: assemble -> missing version parameter\033[0m"
+            exit 1
+        fi
+        echo -e "\033[36;1mTARGET: assemble artefact $VERSION\033[0m"
+        TASK=assemble
+        TASK_ARGS=("$VERSION" "$output_folder")
+        ;;
+    codegen)
+        if [ -v $VERSION ]; then
+            echo -e "\033[31;1mTARGET: codegen -> missing version parameter\033[0m"
+            exit 1
+        fi
+        echo -e "\033[36;1mTARGET: codegen API v$VERSION\033[0m"
+        TASK=codegen
+        # VERSION is BRANCH here for now
+        TASK_ARGS=("$VERSION" "$codegen_folder")
+        ;;
+    docsgen)
+        if [ -v $VERSION ]; then
+            echo -e "\033[31;1mTARGET: docsgen -> missing version parameter\033[0m"
+            exit 1
+        fi
+        echo -e "\033[36;1mTARGET: generate docs for $VERSION\033[0m"
+        TASK=codegen
+        # VERSION is BRANCH here for now
+        TASK_ARGS=("$VERSION" "$codegen_folder")
+        ;;
+    examplesgen)
+        echo -e "\033[36;1mTARGET: generate examples\033[0m"
+        TASK=codegen
+        # VERSION is BRANCH here for now
+        TASK_ARGS=("$VERSION" "$codegen_folder")
+        ;;
+    bump)
+        if [ -v $VERSION ]; then
+            echo -e "\033[31;1mTARGET: bump -> missing version parameter\033[0m"
+            exit 1
+        fi
+        echo -e "\033[36;1mTARGET: bump to version $VERSION\033[0m"
+        TASK=bump
+        # VERSION is BRANCH here for now
+        TASK_ARGS=("$VERSION")
+        ;;
+    *)
+        echo -e "\nUsage:\n\t $CMD is not supported right now\n"
+        exit 1
+esac
+
+
+# ------------------------------------------------------- #
+# Build Container
+# ------------------------------------------------------- #
+
+echo -e "\033[34;1mINFO: building $product container\033[0m"
+
+docker build --file .ci/Dockerfile --tag ${product} \
+  --build-arg USER_ID="$(id -u)" \
+  --build-arg GROUP_ID="$(id -g)" .
+
+
+# ------------------------------------------------------- #
+# Run the Container
+# ------------------------------------------------------- #
+
+echo -e "\033[34;1mINFO: running $product container\033[0m"
+
+# Convert ARGS to comma separated string for Rake:
+args_string="${TASK_ARGS[*]}"
+args_string="${args_string// /,}"
+
+docker run \
+       --env "RUBY_TEST_VERSION=${RUBY_TEST_VERSION}" \
+       --name test-runner \
+       --volume $REPO_BINDING \
+       --volume $repo:/usr/src/app \
+       --rm \
+       $product \
+       bundle exec rake unified_release:"$TASK"["$args_string"]
+
+# ------------------------------------------------------- #
+# Post Command tasks & checks
+# ------------------------------------------------------- #
+
+if [[ "$CMD" == "assemble" ]]; then
+	if compgen -G ".ci/output/*" > /dev/null; then
+		echo -e "\033[32;1mTARGET: successfully assembled client v$VERSION\033[0m"
+	else
+		echo -e "\033[31;1mTARGET: assemble failed, empty workspace!\033[0m"
+		exit 1
+	fi
+fi
+
+if [[ "$CMD" == "codegen" ]]; then
+    echo "TODO"
+fi
+
+if [[ "$CMD" == "docsgen" ]]; then
+    echo "TODO"
+fi
+
+if [[ "$CMD" == "examplesgen" ]]; then
+    echo "TODO"
+fi

data/.ci/test-matrix.yml

@@ -6,7 +6,7 @@ RUBY_VERSION:
   - 2.5
 
 STACK_VERSION:
-  - 7.13-SNAPSHOT
+  - 7.14-SNAPSHOT
 
 TEST_SUITE:
   - platinum

data/.github/check_license_headers.rb

@@ -0,0 +1,33 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+LICENSE = File.read('./.github/license-header.txt')
+files = `git ls-files | grep -E '\.rb|Rakefile|\.rake|\.erb|Gemfile|gemspec'`.split("\n")
+errors = []
+
+files.each do |file|
+  unless File.read(file).include?(LICENSE)
+    errors << file
+    puts "#{file} doesn't contain the correct license header"
+  end
+end
+
+if errors.empty?
+  puts 'All checked files have the correct license header'
+else
+  exit 1
+end

data/.github/license-header.txt

@@ -0,0 +1,16 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.

data/.github/workflows/license.yml

@@ -0,0 +1,13 @@
+name: License headers
+on: [pull_request]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3
+    - name: Check license headers
+      run: |
+        ruby ./.github/check_license_headers.rb

data/.github/workflows/testing.yml

@@ -1,4 +1,4 @@
-name: master
+name: 7.14
 on: [push, pull_request]
 
 jobs:

data/Rakefile

@@ -19,6 +19,7 @@
 
 require 'rspec/core/rake_task'
 require 'bundler/gem_tasks'
+import 'rake_tasks/unified_release_tasks.rake'
 
 desc 'Open an irb session preloaded with this library'
 task :console do

data/docs/guide/app-search-api.asciidoc

@@ -146,6 +146,34 @@ client.list_curations(engine_name)
 client.delete_curation(engine_name, curation_id: 'cur-id')
 ----------------------------
 
+=== Api Key
+
+[source,rb]
+----------------------------
+# Create API Key
+body = {
+  name: name,
+  type: 'private',
+  read: true,
+  write: true,
+  access_all_engines: true
+}
+response = client.create_api_key(body: body)
+
+# Get the details of an API Key
+client.api_key(api_key_name: name)
+
+# List API Keys
+client.list_api_keys
+
+# Update an API Key
+body = { name: name, type: 'private', read: true, write: true, engines: ['test'] }
+client.put_api_key(api_key_name: name, body: body)
+
+# Delete an API Key
+client.delete_api_key(api_key_name: name)
+----------------------------
+
 === Other API Endpoints
 
 [source,rb]

data/docs/guide/release_notes/712.asciidoc

@@ -1,6 +1,18 @@
 [[release_notes_712]]
+=== 7.12 Release notes
+
+[discrete]
+[[release_notes_7121]]
+=== 7.12.1 Release notes
+
+- Elastic Transport: Locks dependency version to < 7.14
+- Elastic Transport: Adds ENTERPRISE_SERVICE_VERSION constant for compatibility
+
+[discrete]
+[[release_notes_7120]]
 === 7.12.0 Release notes
 
+
 [discrete]
 ==== General
 

data/docs/guide/release_notes/714.asciidoc

@@ -0,0 +1,21 @@
+[[release_notes_714]]
+=== 7.14.0 Release notes
+
+[discrete]
+==== General
+
+- Tested with Elastic Enterprise Search API version 7.14.0.
+
+[discrete]
+==== App Search
+
+- Adds API Key endpoints: `api_key`, `create_api_key`, `delete_api_key`, `list_api_keys`, `put_api_key`
+
+[discrete]
+==== Workplace Search
+
+- Adds synonym set endpoints: `create_batch_synonym_sets`, `delete_synonym_set`, `list_synonym_sets`, `put_synonym_set`, `synonym_set`
+- Adds `current_user` endpoint
+- Adds `command_sync_jobs` endpoint
+- Adds `delete_documents_by_query` endpoint
+- Adds `put_content_source_icons` endpoint

data/docs/guide/release_notes/index.asciidoc

@@ -5,11 +5,13 @@
 [discrete]
 === 7.x
 
+* <<release_notes_714, 7.14.0 Release Notes>>
 * <<release_notes_713, 7.13.0 Release Notes>>
 * <<release_notes_712, 7.12.0 Release Notes>>
 * <<release_notes_711, 7.11.0 Release Notes>>
 * <<release_notes_710, 7.10.0.beta.1 Release Notes>>
 
+include::714.asciidoc[]
 include::713.asciidoc[]
 include::712.asciidoc[]
 include::711.asciidoc[]

data/docs/guide/workplace-search-api.asciidoc

@@ -26,6 +26,17 @@ body = {
   is_searchable: true
 }
 client.put_content_source(id, body: body)
+
+# Issue commands to a Content Source's sync jobs
+client.command_sync_jobs(content_source_id, body: { command: 'interrupt' })
+
+# Update a content source icon
+# You need to encode the file with Base64:
+require 'base64'
+
+path = File.expand_path("#{File.dirname(__FILE__)}/icon.png")
+icon = Base64.strict_encode64(File.read(path))
+response = client.put_content_source_icons(content_source_id, main_icon: icon, alt_icon: icon)
 ----------------------------
 
 === Documents
@@ -50,6 +61,9 @@ client.delete_documents(content_source_id, document_ids: ['e68fbc2688f1', 'c535e
 
 # Delete all documents for a given content source
 client.delete_all_documents(content_source_id)
+
+# Delete documents by query
+client.delete_documents_by_query(content_source_id, query: query)
 ----------------------------
 
 [discrete]
@@ -163,3 +177,44 @@ body = {
 
 client.create_analytics_event(access_token: oauth_access_token, body: body)
 ----------------------------
+
+=== Synonym Sets
+
+[source,rb]
+----------------------------
+body = {
+  synonym_sets: [
+    { 'synonyms' => ['house', 'home', 'abode'] },
+    { 'synonyms' => ['cat', 'feline', 'kitty'] },
+    { 'synonyms' => ['mouses', 'mice'] }
+  ]
+}
+
+# Create batch synonym set
+client.create_batch_synonym_sets(body: body)
+
+# Delete synonym set
+client.delete_synonym_set(synonym_set_id: id)
+
+# List synonym sets
+client.list_synonym_sets
+
+# Get a synonym set
+client.synonym_set(synonym_set_id: id)
+
+# Update a synonym set
+body = { synonyms: ['mouses', 'mice', 'luch'] }
+client.put_synonym_set(synonym_set_id: id, body: body)
+----------------------------
+
+
+=== Current User
+
+[source,rb]
+----------------------------
+# Get the current user
+client.current_user
+
+# Get the current user and return the access token
+client.current_user(get_token: true)
+----------------------------

data/lib/elastic/app-search/api/api_key.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module Elastic
+  module EnterpriseSearch
+    module AppSearch
+      module Actions
+        # Credentials - Get the details of an API key
+        #
+        # @param arguments [Hash] endpoint arguments
+        # @option arguments [String] :api_key_name Name of an API key (*Required*)
+        # @option arguments [Hash] :body The request body
+        # @option arguments [Hash] :headers optional HTTP headers to send with the request
+        #
+        # @see https://www.elastic.co/guide/en/app-search/current/credentials.html#credentials-single
+        #
+        def api_key(arguments = {})
+          raise ArgumentError, "Required parameter 'api_key_name' missing" unless arguments[:api_key_name]
+
+          api_key_name = arguments[:api_key_name]
+          body = arguments.delete(:body) || {}
+          headers = arguments.delete(:headers) || {}
+
+          request(
+            :get,
+            "api/as/v1/credentials/#{api_key_name}/",
+            arguments,
+            body,
+            headers
+          )
+        end
+      end
+    end
+  end
+end