elastic-enterprise-search 7.12.0 → 7.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 304ea65c57225137d2e1b45f38d49bbc71a7a19ffaf0b4fe13313cbf6bd790f6
-  data.tar.gz: b470d629aa5d13e83af77ca0ff7ccfe1555baba0bb31fcaa4e621896aea5738c
+  metadata.gz: 1eef7550b4a936e514eb9b0eb52272a2b445b3e54c301c7cec29039c789561ee
+  data.tar.gz: 47ab2fcbb9b00a3cbb219e713ee9308642345b72dcc6af5b9f0f1f334edd7c09
 SHA512:
-  metadata.gz: a6621e4b977abb889c81bb6ecb6ed10857cc03ea2dc6db26325145f936d3d0effd55f941518a03cdeae3a7f70c7223e63e537412b241097b7b68917f1f26f49f
-  data.tar.gz: 6ba8192ac2a50e08bbfbbaafad916f42c8102bb34145aa291fa914f4d5ebaa47f42386e5190000e4b013f4f21ef5d1363b23262ae1c737a2bcc65007aafc5abe
+  metadata.gz: 38a4519bfa5d4b3ea04507468b0c5ddb7122d8c5c928943b45d3d1ce120d3a1652ac7c2aff217082aaca4cdc3124b732e4f31c265bf5c6f0cdc0173672e020f0
+  data.tar.gz: 7cd26fe0a7fc874ccbcfb16ef443d5c9ddd69b0a882690dcbfc0b90d698a10bd89d942530ba93aae78531cddc6960721edd8d2a410728be87aacd018e1aeed31

data/.ci/jobs/elastic+enterprise-search-ruby+7.10.0.beta.1.yml

@@ -0,0 +1,12 @@
+---
+- job:
+    name: elastic+enterprise-search-ruby+7.10.0.beta.1
+    display-name: 'elastic / enterprise-search-ruby # 7.10.0.beta.1'
+    description: Testing the enterprise-search-ruby 7.10.0.beta.1 branch.
+    junit_results: "*-junit.xml"
+    parameters:
+    - string:
+        name: branch_specifier
+        default: refs/heads/7.10.0.beta.1
+        description: the Git branch specifier to build (<branchName>, <tagName>,
+          <commitId>, etc.)

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/run-repository.sh

@@ -14,6 +14,7 @@ set -euo pipefail
 
 echo -e "\033[34;1mINFO:\033[0m VERSION: ${STACK_VERSION}\033[0m"
 echo -e "\033[34;1mINFO:\033[0m TEST_SUITE: ${TEST_SUITE}\033[0m"
+echo -e "\033[34;1mINFO:\033[0m RUBY_VERSION: ${RUBY_VERSION}\033[0m"
 echo -e "\033[34;1mINFO:\033[0m RUNSCRIPTS: ${RUNSCRIPTS}\033[0m"
 echo -e "\033[34;1mINFO:\033[0m URL: ${elasticsearch_url}\033[0m"
 
@@ -33,6 +34,7 @@ echo -e "\033[32;1mBUILD: \033[31mRuby \e[0m container.\033[0m"
 docker build \
        --file .ci/Dockerfile \
        --tag elastic/enterprise-search-ruby \
+       --build-arg RUBY_VERSION=${RUBY_VERSION} \
        .
 
 echo -e "\033[32;1mRUN: \033[31mRuby \e[0m container.\033[0m"

data/.ci/test-matrix.yml

@@ -6,7 +6,7 @@ RUBY_VERSION:
   - 2.5
 
 STACK_VERSION:
-  - 7.x-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/connecting.asciidoc

@@ -87,7 +87,13 @@ client.search(engine_name, query: 'jungle')
 [[auth-ws]]
 ==== Authenticating with Workplace Search
 
-In your Elastic Workplace Search dashboard navigate to _Sources/Add a Shared Content Source_ and select _Custom API Source_ to create a new source. Name your source (e.g. `Enterprise Search Ruby Client`) and once it's created you'll get an `access token` and an `ID`. You'll need these in the following steps.
+Workplace Search supports multiple authentication methods:
+
+[discrete]
+[[access-tokens]]
+===== Workplace Search admin user access tokens
+
+In your Elastic Workplace Search dashboard navigate to _Sources/Add a Shared Content Source_ and select _Custom API Source_ to create a new source. Name your source (e.g. `Enterprise Search Ruby Client`) and once it's created you'll get an `access token` and an `ID`.
 
 The Workplace Search client can be accessed from an existing Enterprise Search Client, or you can initialize a new one. If you instantiate the Workplace Search client from an existing Enterprise Search Client, it's going to share the HTTP transport instance, so it's going to connect to the same host, which is a common scenario. However, if you want to connect to a different host, you should instantiate a new Workplace Client on its own:
 
@@ -109,6 +115,46 @@ workplace_search_client = Elastic::EnterpriseSearch::WorkplaceSearch::Client.new
 )
 ----------------------------
 
+[discrete]
+[[basic-auth]]
+===== Basic Authentication
+
+Workplace Search APIs support basic authentication headers to authenticate users. All Workplace Search APIs support basic authentication:
+
+[source,rb]
+----------------------------
+host = 'https://id.ent-search.europe-west2.gcp.elastic-cloud.com'
+basic_auth = { user: 'enterprise_search', password: 'changeme' }
+
+workplace_search_client = Elastic::EnterpriseSearch::WorkplaceSearch::Client.new(
+  host: host,
+  http_auth: basic_auth
+)
+----------------------------
+
+[discrete]
+[[es-tokens]]
+===== Elasticsearch tokens
+
+Workplace Search APIs support Elasticsearch tokens generated by the Elasticsearch Token Service. All Workplace Search APIs support Elasticsearch tokens as an authentication method.
+
+[source,rb]
+----------------------------
+host = 'https://id.ent-search.europe-west2.gcp.elastic-cloud.com'
+access_token = '<access token>'
+
+workplace_search_client = Elastic::EnterpriseSearch::WorkplaceSearch::Client.new(
+  host: host,
+  http_auth: access_token
+)
+----------------------------
+
+[discrete]
+[[ws-oauth]]
+===== Workplace Search OAuth access tokens
+
+The Search API and the Analytics Events API support user access tokens generated by the Workplace Search OAuth Service. The token is acquired via an OAuth authorization flow. User access tokens are meant to be used for Custom Search Experiences. Check <<ws-oauth-authentication>>.
+
 [discrete]
 [[custom_headers]]
 === Custom HTTP Headers

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
 
@@ -14,13 +26,3 @@
 
 - Updates source code documentation for `current_page` and `page_size` parameters from type `String` to `Integer`.
 - In `multi_search`, the body parameter is renamed to `body` from `queries` to avoid repetition and potential confusion.
-
-[discrete]
-==== Workplace Search
-
-- Body parameter renamed to `document_ids` in `delete_documents`:
-
-[source,rb]
-----------------------------
-client.delete_documents(content_source_id, document_ids: ['e68fbc2688f1', 'c535e226aee3'])
-----------------------------

data/docs/guide/release_notes/713.asciidoc

@@ -0,0 +1,21 @@
+[[release_notes_713]]
+=== 7.13.0 Release notes
+
+[discrete]
+==== General
+
+- Tested with Elastic Enterprise Search API version 7.13.0.
+- Improved meta header implementation for Elastic Cloud.
+
+[discrete]
+==== Workplace Search
+
+* The client now supports Basic Authentication and Elasticsearch tokens. All Workplace Search APIs support Basic Authentication, Elasticsearch tokens and Workplace Search admin user access tokens as an authentication method. You still need to set up user access tokens generated by the Workplace Search OAuth Service for the Search API and the Analytics Events API.
+* New APIs:
+** `document`: Retrieve a document by ID from a specified content source.
+** `delete_all_documents`: Delete all documents for a given content source
+** `content_source`: Retrieves a content source by ID
+** `create_content_source`: Creates a custom content source
+** `delete_content_source`: Deletes a content source by ID
+** `list_content_sources`: Retrieves all content sources
+** `put_content_source`: Updates a custom content source