elastic-enterprise-search 0.3.1 → 7.12.1

data/spec/fixtures/vcr/workplace_search/oauth_request_token.yml

@@ -0,0 +1,57 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://localhost:3002/ws/oauth/token?client_id=client_id&client_secret=client_secret&code=authorization_code&grant_type=authorization_code&redirect_uri=http://localhost:9393
+    body:
+      encoding: UTF-8
+      string: "{}"
+    headers:
+      X-Elastic-Client-Meta:
+      - es=7.11.0.pre.1,rb=2.7.2,t=7.11.0.pre.1,fd=1.3.0,nh=1.1
+      User-Agent:
+      - 'elastic-enteprise-search-ruby/7.11.0.pre (RUBY_VERSION: 2.7.2; linux x86_64;
+        elasticsearch-transport: 7.11.0.pre.1)'
+      Content-Type:
+      - application/json
+      Authorization:
+      - Bearer authorization_code
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message:  OK
+    headers:
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      Cache-Control:
+      - no-store
+      Pragma:
+      - no-cache
+      Content-Type:
+      - application/json;charset=utf-8
+      Etag:
+      - W/"5328608ddb7afff05662a7292d3c9726--gzip"
+      X-Request-Id:
+      - 3056fc4d-5c75-4681-917c-a691322dc91c
+      X-Runtime:
+      - '0.046821'
+      Vary:
+      - Accept-Encoding, User-Agent
+      Transfer-Encoding:
+      - chunked
+      Server:
+      - Jetty(9.4.33.v20201020)
+    body:
+      encoding: ASCII-8BIT
+      string: '{"access_token":"9c1e9abc5f240f49b29612a9d3a0dd2b20870d859983d9e2dd0488aed5e8b08d","token_type":"Bearer","expires_in":7200,"refresh_token":"96f222b89cfaed8fb62f61998fbc4e6708f2877cee6b7d8e8cefef62bf43a9e1","scope":"search"}'
+    http_version: 
+  recorded_at: Thu, 04 Feb 2021 17:50:56 GMT
+recorded_with: VCR 3.0.3

data/spec/fixtures/vcr/workplace_search/put_external_identity.yml

@@ -0,0 +1,53 @@
+---
+http_interactions:
+- request:
+    method: put
+    uri: http://localhost:3002/api/ws/v1/sources/content_source_id/external_identities/elastic_user/?user=elastic_user
+    body:
+      encoding: UTF-8
+      string: '{"source_user_id":"example2@elastic.co"}'
+    headers:
+      User-Agent:
+      - 'elastic-enteprise-search-ruby/7.11.0.pre (RUBY_VERSION: 2.7.2; linux x86_64;
+        elasticsearch-transport: 7.10.0)'
+      Content-Type:
+      - application/json
+      Authorization:
+      - Bearer access_token
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      Content-Type:
+      - application/json;charset=utf-8
+      Etag:
+      - W/"e791eae2a9e8158a885dfdc173ed6b02--gzip"
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - 59340e3c-f447-4fbf-8ada-de73618a8740
+      X-Runtime:
+      - '0.057303'
+      Vary:
+      - Accept-Encoding, User-Agent
+      Transfer-Encoding:
+      - chunked
+      Server:
+      - Jetty(9.4.33.v20201020)
+    body:
+      encoding: ASCII-8BIT
+      string: '{"source_user_id":"example2@elastic.co","user":"elastic_user"}'
+    http_version: 
+  recorded_at: Wed, 13 Jan 2021 16:04:35 GMT
+recorded_with: VCR 3.0.3

data/spec/fixtures/vcr/workplace_search/put_user_permissions.yml

@@ -0,0 +1,103 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://localhost:3002/api/ws/v1/sources/content_source_id/permissions/enterprise_search/add/?permissions%5B%5D=more&permissions%5B%5D=permissions&permissions%5B%5D=testing&user=enterprise_search
+    body:
+      encoding: UTF-8
+      string: "{}"
+    headers:
+      User-Agent:
+      - 'elastic-enteprise-search-ruby/7.11.0.pre (RUBY_VERSION: 2.7.2; linux x86_64;
+        elasticsearch-transport: 7.10.0)'
+      Content-Type:
+      - application/json
+      Authorization:
+      - Bearer access_token
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      Content-Type:
+      - application/json;charset=utf-8
+      Etag:
+      - W/"d10c028fa9c684778511b469120f4df9--gzip"
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - 64149045-4d39-402c-8636-bf29f27a974f
+      X-Runtime:
+      - '1.674349'
+      Vary:
+      - Accept-Encoding, User-Agent
+      Transfer-Encoding:
+      - chunked
+      Server:
+      - Jetty(9.4.33.v20201020)
+    body:
+      encoding: ASCII-8BIT
+      string: '{"user":"enterprise_search","permissions":["testing","more","permissions"]}'
+    http_version: 
+  recorded_at: Wed, 13 Jan 2021 16:00:57 GMT
+- request:
+    method: put
+    uri: http://localhost:3002/api/ws/v1/sources/content_source_id/permissions/enterprise_search/?permissions%5B%5D&user=enterprise_search
+    body:
+      encoding: UTF-8
+      string: "{}"
+    headers:
+      User-Agent:
+      - 'elastic-enteprise-search-ruby/7.11.0.pre (RUBY_VERSION: 2.7.2; linux x86_64;
+        elasticsearch-transport: 7.10.0)'
+      Content-Type:
+      - application/json
+      Authorization:
+      - Bearer access_token
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      Content-Type:
+      - application/json;charset=utf-8
+      Etag:
+      - W/"eaf0aef29a99d5f9dda5844986aa3880--gzip"
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - 0ec6ac2d-b631-4038-8b89-d855125e48a9
+      X-Runtime:
+      - '1.993345'
+      Vary:
+      - Accept-Encoding, User-Agent
+      Transfer-Encoding:
+      - chunked
+      Server:
+      - Jetty(9.4.33.v20201020)
+    body:
+      encoding: ASCII-8BIT
+      string: '{"user":"enterprise_search","permissions":[]}'
+    http_version: 
+  recorded_at: Wed, 13 Jan 2021 16:00:59 GMT
+recorded_with: VCR 3.0.3

data/spec/fixtures/vcr/workplace_search/remove_user_permissions.yml

@@ -0,0 +1,53 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://localhost:3002/api/ws/v1/sources/content_source_id/permissions/enterprise_search/remove/?permissions%5B%5D=permission1&permissions%5B%5D=permission2&user=enterprise_search
+    body:
+      encoding: UTF-8
+      string: "{}"
+    headers:
+      User-Agent:
+      - 'elastic-enteprise-search-ruby/7.11.0.pre (RUBY_VERSION: 2.7.2; linux x86_64;
+        elasticsearch-transport: 7.10.0)'
+      Content-Type:
+      - application/json
+      Authorization:
+      - Bearer access_token
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      Content-Type:
+      - application/json;charset=utf-8
+      Etag:
+      - W/"eaf0aef29a99d5f9dda5844986aa3880--gzip"
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - 070c6c38-5aca-492e-ad99-046345766c41
+      X-Runtime:
+      - '2.010759'
+      Vary:
+      - Accept-Encoding, User-Agent
+      Transfer-Encoding:
+      - chunked
+      Server:
+      - Jetty(9.4.33.v20201020)
+    body:
+      encoding: ASCII-8BIT
+      string: '{"user":"enterprise_search","permissions":[]}'
+    http_version: 
+  recorded_at: Wed, 13 Jan 2021 16:01:11 GMT
+recorded_with: VCR 3.0.3

data/spec/fixtures/vcr/workplace_search/retrieve_external_identity.yml

@@ -0,0 +1,53 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://localhost:3002/api/ws/v1/sources/content_source_id/external_identities/elastic_user/?user=elastic_user
+    body:
+      encoding: UTF-8
+      string: "{}"
+    headers:
+      User-Agent:
+      - 'elastic-enteprise-search-ruby/7.11.0.pre (RUBY_VERSION: 2.7.2; linux x86_64;
+        elasticsearch-transport: 7.10.0)'
+      Content-Type:
+      - application/json
+      Authorization:
+      - Bearer access_token
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      Content-Type:
+      - application/json;charset=utf-8
+      Etag:
+      - W/"58321c212599891b518fb2bac5efb797--gzip"
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - 68f9b489-9502-4e20-becc-a7f57ba8f7d5
+      X-Runtime:
+      - '0.047753'
+      Vary:
+      - Accept-Encoding, User-Agent
+      Transfer-Encoding:
+      - chunked
+      Server:
+      - Jetty(9.4.33.v20201020)
+    body:
+      encoding: ASCII-8BIT
+      string: '{"source_user_id":"example@elastic.co","user":"elastic_user"}'
+    http_version: 
+  recorded_at: Wed, 13 Jan 2021 16:01:57 GMT
+recorded_with: VCR 3.0.3

data/spec/fixtures/vcr/workplace_search/search_request.yml

@@ -0,0 +1,60 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://localhost:3002/api/ws/v1/search/
+    body:
+      encoding: UTF-8
+      string: '{"query":"1984"}'
+    headers:
+      X-Elastic-Client-Meta:
+      - es=7.11.0.pre.1,rb=2.7.2,t=7.11.0.pre.1,fd=1.3.0,nh=1.1
+      User-Agent:
+      - 'elastic-enteprise-search-ruby/7.11.0.pre (RUBY_VERSION: 2.7.2; linux x86_64;
+        elasticsearch-transport: 7.11.0.pre.1)'
+      Content-Type:
+      - application/json
+      Authorization:
+      - Bearer 9c1e9abc5f240f49b29612a9d3a0dd2b20870d859983d9e2dd0488aed5e8b08d
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      Content-Type:
+      - application/json;charset=utf-8
+      Vary:
+      - Accept-Encoding, User-Agent
+      - Origin
+      Etag:
+      - W/"e71ffae332362bc9057bc0ea0ba1edf2--gzip"
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - 793191cb-9ef4-4d4b-ab51-ab9e2981869d
+      X-Runtime:
+      - '0.131835'
+      Transfer-Encoding:
+      - chunked
+      Server:
+      - Jetty(9.4.33.v20201020)
+    body:
+      encoding: ASCII-8BIT
+      string: '{"meta":{"page":{"current":1,"total_pages":1,"total_results":3,"size":10},"request_id":"793191cb-9ef4-4d4b-ab51-ab9e2981869d","warnings":[]},"results":[{"release_date":{"raw":"1985-06-01"},"title":{"raw":"1984"},"_meta":{"source":"custom","last_updated":"2021-02-04T17:16:07+00:00","content_source_id":"601c0ee3a2fa0410731ab185","id":"doc-601c2bd7a2fa047ab91ab1a5","score":17.172085},"source":{"raw":"custom"},"page_count":{"raw":"328"},"last_updated":{"raw":"2021-02-04T17:16:07+00:00"},"content_source_id":{"raw":"601c0ee3a2fa0410731ab185"},"id":{"raw":"doc-601c2bd7a2fa047ab91ab1a5"},"author":{"raw":"George
+        Orwell"}},{"release_date":{"raw":"1984-07-01"},"title":{"raw":"Neuromancer"},"_meta":{"source":"custom","last_updated":"2021-02-04T17:16:07+00:00","content_source_id":"601c0ee3a2fa0410731ab185","id":"doc-601c2bd7a2fa047ab91ab1ab","score":1.0758291},"source":{"raw":"custom"},"page_count":{"raw":"271"},"last_updated":{"raw":"2021-02-04T17:16:07+00:00"},"content_source_id":{"raw":"601c0ee3a2fa0410731ab185"},"id":{"raw":"doc-601c2bd7a2fa047ab91ab1ab"},"author":{"raw":"William
+        Gibson"}},{"release_date":{"raw":"1985-06-01"},"title":{"raw":"The Handmaid''s
+        Tale"},"_meta":{"source":"custom","last_updated":"2021-02-04T17:16:07+00:00","content_source_id":"601c0ee3a2fa0410731ab185","id":"doc-601c2bd7a2fa047ab91ab1ac","score":0.07125},"source":{"raw":"custom"},"page_count":{"raw":"311"},"last_updated":{"raw":"2021-02-04T17:16:07+00:00"},"content_source_id":{"raw":"601c0ee3a2fa0410731ab185"},"id":{"raw":"doc-601c2bd7a2fa047ab91ab1ac"},"author":{"raw":"Margaret
+        Atwood"}}]}'
+    http_version: 
+  recorded_at: Thu, 04 Feb 2021 17:51:10 GMT
+recorded_with: VCR 3.0.3

data/spec/fixtures/vcr/workplace_search/user_permissions_empty.yml

@@ -0,0 +1,53 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://localhost:3002/api/ws/v1/sources/content_source_id/permissions/enterprise_search/?user=enterprise_search
+    body:
+      encoding: UTF-8
+      string: "{}"
+    headers:
+      User-Agent:
+      - 'elastic-enteprise-search-ruby/7.11.0.pre (RUBY_VERSION: 2.7.2; linux x86_64;
+        elasticsearch-transport: 7.10.0)'
+      Content-Type:
+      - application/json
+      Authorization:
+      - Bearer access_token
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      Content-Type:
+      - application/json;charset=utf-8
+      Etag:
+      - W/"eaf0aef29a99d5f9dda5844986aa3880--gzip"
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - ea185891-850b-499f-83b8-9ab960432ceb
+      X-Runtime:
+      - '0.057762'
+      Vary:
+      - Accept-Encoding, User-Agent
+      Transfer-Encoding:
+      - chunked
+      Server:
+      - Jetty(9.4.33.v20201020)
+    body:
+      encoding: ASCII-8BIT
+      string: '{"user":"enterprise_search","permissions":[]}'
+    http_version: 
+  recorded_at: Wed, 13 Jan 2021 16:00:47 GMT
+recorded_with: VCR 3.0.3

data/spec/integration/enterprise_search_api_spec.rb

@@ -0,0 +1,96 @@
+# 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.
+
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Elastic::EnterpriseSearch::Client do
+  let(:host) { ENV['ELASTIC_ENTERPRISE_HOST'] || 'http://localhost:3002' }
+  let(:http_auth) do
+    {
+      user: ENV['ELASTIC_ENTERPRISE_USER'] || 'elastic',
+      password: ENV['ELASTIC_ENTERPRISE_PASSWORD'] || 'changeme'
+    }
+  end
+  let(:client) do
+    Elastic::EnterpriseSearch::Client.new(host: host, http_auth: http_auth)
+  end
+
+  context 'API' do
+    context 'health' do
+      it 'makes GET request' do
+        response = client.health
+
+        expect(response.status).to eq 200
+        expect(response.body['name']).to be_a(String)
+        expect(response.body['version']).to have_key('number')
+        expect(response.body['jvm']).to have_key('gc')
+        expect(response.body['system']).to have_key('os_name')
+      end
+    end
+
+    context 'read only' do
+      it 'makes GET request' do
+        response = client.read_only
+
+        expect(response.status).to eq 200
+        expect(response.body).to have_key('enabled')
+      end
+    end
+
+    context 'put_read_only' do
+      it 'makes PUT request with enabled: true' do
+        response = client.put_read_only(body: { enabled: true })
+
+        expect(response.status).to eq 200
+        expect(response.body).to have_key('enabled')
+        expect(response.body['enabled'])
+      end
+
+      it 'makes PUT request with enabled: false' do
+        response = client.put_read_only(body: { enabled: false })
+
+        expect(response.status).to eq 200
+        expect(response.body).to have_key('enabled')
+        expect(response.body['enabled']).to eq false
+      end
+    end
+
+    context 'stats' do
+      it 'makes GET request' do
+        response = client.stats
+
+        expect(response.status).to eq 200
+        expect(response.body).to have_key('app')
+        expect(response.body).to have_key('queues')
+        expect(response.body).to have_key('connectors')
+      end
+    end
+
+    context 'version' do
+      it 'makes GET request' do
+        response = client.version
+
+        expect(response.status).to eq 200
+        expect(response.body).to have_key('number')
+        expect(response.body).to have_key('build_hash')
+        expect(response.body).to have_key('build_date')
+      end
+    end
+  end
+end