elastic-enterprise-search 7.10.0.beta.1 → 7.11.0

data/spec/fixtures/vcr/{put_user_permissions.yml → workplace_search/put_user_permissions.yml}

@@ -2,14 +2,14 @@
 http_interactions:
 - request:
     method: post
-    uri: http://localhost:3002/api/ws/v1/sources/content_source_key/permissions/enterprise_search/add/?permissions%5B%5D=more&permissions%5B%5D=permissions&permissions%5B%5D=testing&user=enterprise_search
+    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/0.0.1 (RUBY_VERSION: 2.7.1; linux x86_64; elasticsearch-transport:
-        7.9.0)'
+      - '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:
@@ -32,32 +32,34 @@ http_interactions:
       Content-Type:
       - application/json;charset=utf-8
       Etag:
-      - W/"d10c028fa9c684778511b469120f4df9"
+      - W/"d10c028fa9c684778511b469120f4df9--gzip"
       Cache-Control:
       - max-age=0, private, must-revalidate
       X-Request-Id:
-      - 62635fa8-edce-4b90-806b-a2544b295d23
+      - 64149045-4d39-402c-8636-bf29f27a974f
       X-Runtime:
-      - '2.435278'
+      - '1.674349'
+      Vary:
+      - Accept-Encoding, User-Agent
       Transfer-Encoding:
       - chunked
       Server:
-      - Jetty(9.4.30.v20200611)
+      - Jetty(9.4.33.v20201020)
     body:
-      encoding: UTF-8
+      encoding: ASCII-8BIT
       string: '{"user":"enterprise_search","permissions":["testing","more","permissions"]}'
     http_version: 
-  recorded_at: Tue, 03 Nov 2020 23:16:55 GMT
+  recorded_at: Wed, 13 Jan 2021 16:00:57 GMT
 - request:
     method: put
-    uri: http://localhost:3002/api/ws/v1/sources/content_source_key/permissions/enterprise_search/?permissions%5B%5D&user=enterprise_search
+    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/0.0.1 (RUBY_VERSION: 2.7.1; linux x86_64; elasticsearch-transport:
-        7.9.0)'
+      - '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:
@@ -80,20 +82,22 @@ http_interactions:
       Content-Type:
       - application/json;charset=utf-8
       Etag:
-      - W/"eaf0aef29a99d5f9dda5844986aa3880"
+      - W/"eaf0aef29a99d5f9dda5844986aa3880--gzip"
       Cache-Control:
       - max-age=0, private, must-revalidate
       X-Request-Id:
-      - 5e7c7f55-f940-4cb1-9278-5807ecd338d6
+      - 0ec6ac2d-b631-4038-8b89-d855125e48a9
       X-Runtime:
-      - '2.016964'
+      - '1.993345'
+      Vary:
+      - Accept-Encoding, User-Agent
       Transfer-Encoding:
       - chunked
       Server:
-      - Jetty(9.4.30.v20200611)
+      - Jetty(9.4.33.v20201020)
     body:
-      encoding: UTF-8
+      encoding: ASCII-8BIT
       string: '{"user":"enterprise_search","permissions":[]}'
     http_version: 
-  recorded_at: Tue, 03 Nov 2020 23:16:58 GMT
+  recorded_at: Wed, 13 Jan 2021 16:00:59 GMT
 recorded_with: VCR 3.0.3

data/spec/fixtures/vcr/{remove_user_permissions.yml → workplace_search/remove_user_permissions.yml}

@@ -2,14 +2,14 @@
 http_interactions:
 - request:
     method: post
-    uri: http://localhost:3002/api/ws/v1/sources/content_source_key/permissions/enterprise_search/remove/?permissions%5B%5D=permission1&permissions%5B%5D=permission2&user=enterprise_search
+    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/0.0.1 (RUBY_VERSION: 2.7.1; linux x86_64; elasticsearch-transport:
-        7.9.0)'
+      - '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:
@@ -32,20 +32,22 @@ http_interactions:
       Content-Type:
       - application/json;charset=utf-8
       Etag:
-      - W/"eaf0aef29a99d5f9dda5844986aa3880"
+      - W/"eaf0aef29a99d5f9dda5844986aa3880--gzip"
       Cache-Control:
       - max-age=0, private, must-revalidate
       X-Request-Id:
-      - 1d0696c0-e60f-45d4-a402-7e67acbd5049
+      - 070c6c38-5aca-492e-ad99-046345766c41
       X-Runtime:
-      - '1.407605'
+      - '2.010759'
+      Vary:
+      - Accept-Encoding, User-Agent
       Transfer-Encoding:
       - chunked
       Server:
-      - Jetty(9.4.30.v20200611)
+      - Jetty(9.4.33.v20201020)
     body:
-      encoding: UTF-8
+      encoding: ASCII-8BIT
       string: '{"user":"enterprise_search","permissions":[]}'
     http_version: 
-  recorded_at: Tue, 03 Nov 2020 23:17:47 GMT
+  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/{user_permissions_empty.yml → workplace_search/user_permissions_empty.yml}

@@ -2,14 +2,14 @@
 http_interactions:
 - request:
     method: get
-    uri: http://localhost:3002/api/ws/v1/sources/content_source_key/permissions/enterprise_search/?user=enterprise_search
+    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/0.0.1 (RUBY_VERSION: 2.7.1; linux x86_64; elasticsearch-transport:
-        7.9.0)'
+      - '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:
@@ -32,20 +32,22 @@ http_interactions:
       Content-Type:
       - application/json;charset=utf-8
       Etag:
-      - W/"eaf0aef29a99d5f9dda5844986aa3880"
+      - W/"eaf0aef29a99d5f9dda5844986aa3880--gzip"
       Cache-Control:
       - max-age=0, private, must-revalidate
       X-Request-Id:
-      - fe4e4e34-d5c6-43ac-aae6-6f47a4e4c28d
+      - ea185891-850b-499f-83b8-9ab960432ceb
       X-Runtime:
-      - '0.063630'
+      - '0.057762'
+      Vary:
+      - Accept-Encoding, User-Agent
       Transfer-Encoding:
       - chunked
       Server:
-      - Jetty(9.4.30.v20200611)
+      - Jetty(9.4.33.v20201020)
     body:
-      encoding: UTF-8
+      encoding: ASCII-8BIT
       string: '{"user":"enterprise_search","permissions":[]}'
     http_version: 
-  recorded_at: Tue, 03 Nov 2020 23:15:20 GMT
+  recorded_at: Wed, 13 Jan 2021 16:00:47 GMT
 recorded_with: VCR 3.0.3

data/spec/integration/enterprise_search_api_spec.rb

@@ -55,7 +55,7 @@ describe Elastic::EnterpriseSearch::Client do
 
     context 'put_read_only' do
       it 'makes PUT request with enabled: true' do
-        response = client.put_read_only(enabled: true)
+        response = client.put_read_only(body: { enabled: true })
 
         expect(response.status).to eq 200
         expect(response.body).to have_key('enabled')
@@ -63,7 +63,7 @@ describe Elastic::EnterpriseSearch::Client do
       end
 
       it 'makes PUT request with enabled: false' do
-        response = client.put_read_only(enabled: false)
+        response = client.put_read_only(body: { enabled: false })
 
         expect(response.status).to eq 200
         expect(response.body).to have_key('enabled')

data/spec/spec_helper.rb

@@ -17,6 +17,8 @@
 
 # frozen_string_literal: true
 
+require 'simplecov'
+SimpleCov.start
 require 'elastic/enterprise_search'
 require 'rspec'
 require 'vcr'

data/spec/workplace-search/client_spec.rb

@@ -21,11 +21,11 @@ require 'spec_helper'
 
 describe Elastic::EnterpriseSearch::WorkplaceSearch::Client do
   let(:host) { 'https://localhost:8080' }
+  let(:access_token) { 'access_token' }
 
   context 'dependant on EnterpriseSearch' do
     let(:ent_client) { Elastic::EnterpriseSearch::Client.new(host: host) }
     let(:workplace_client) { ent_client.workplace_search }
-    let(:access_token) { 'access_token' }
 
     it 'initializes a workplace search client' do
       expect(workplace_client).not_to be nil
@@ -47,7 +47,6 @@ describe Elastic::EnterpriseSearch::WorkplaceSearch::Client do
 
   context 'independent from EnterpriseSearch client' do
     let(:workplace_client) { Elastic::EnterpriseSearch::WorkplaceSearch::Client.new(host: host) }
-    let(:access_token) { 'access_token' }
 
     it 'initializes a workplace search client' do
       expect(workplace_client).not_to be nil
@@ -66,4 +65,13 @@ describe Elastic::EnterpriseSearch::WorkplaceSearch::Client do
       expect(workplace_client.http_auth).to eq access_token
     end
   end
+
+  context 'OAuth' do
+    let(:client) { Elastic::EnterpriseSearch::WorkplaceSearch::Client.new(host: host) }
+
+    it 'generates an authorization url' do
+      authorization_url = 'https://localhost:8080/ws/oauth/authorize?response_type=code&client_id=client_id&redirect_uri=https%3A%2F%2Flocalhost%3A3002'
+      expect(client.authorization_url('client_id', 'https://localhost:3002')).to eq authorization_url
+    end
+  end
 end

data/spec/workplace-search/create_analytics_event_spec.rb

@@ -0,0 +1,59 @@
+# 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::WorkplaceSearch::Client do
+  let(:host) { ENV['ELASTIC_ENTERPRISE_HOST'] || 'http://localhost:3002' }
+  let(:content_source_id) { ENV['ELASTIC_WORKPLACE_SOURCE_ID'] || 'content_source_id' }
+  let(:client) do
+    Elastic::EnterpriseSearch::WorkplaceSearch::Client.new(
+      host: host
+    )
+  end
+
+  context 'create analytics event' do
+    it 'creates an event' do
+      VCR.use_cassette('workplace_search/oauth_request_token') do
+        client_id = 'client_id'
+        client_secret = 'client_secret'
+        redirect_uri = 'http://localhost:9393'
+
+        # gets authorization code via  client.authorization_url(client_id, redirect_uri)
+        authorization_code = 'authorization_code'
+        @oauth_access_token = client.request_access_token(client_id, client_secret, authorization_code, redirect_uri)
+      end
+
+      VCR.use_cassette('workplace_search/create_analytics_event') do
+        body = {
+          type: 'click',
+          query_id: 'search_query_id',
+          document_id: 'document_id',
+          page: 1,
+          content_source_id: 'content_source_id',
+          rank: 1,
+          event: 'api'
+        }
+
+        response = client.create_analytics_event(access_token: @oauth_access_token, body: body)
+        expect(response.status).to eq 200
+      end
+    end
+  end
+end

data/spec/workplace-search/documents_spec.rb

@@ -0,0 +1,80 @@
+# 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::WorkplaceSearch::Client do
+  let(:host) { ENV['ELASTIC_ENTERPRISE_HOST'] || 'http://localhost:3002' }
+  let(:access_token) { ENV['ELASTIC_WORKPLACE_TOKEN'] || 'access_token' }
+  let(:content_source_id) { ENV['ELASTIC_WORKPLACE_SOURCE_ID'] || 'content_source_id' }
+  let(:client) do
+    Elastic::EnterpriseSearch::WorkplaceSearch::Client.new(
+      host: host,
+      http_auth: access_token
+    )
+  end
+
+  context 'documents' do
+    let(:documents) do
+      [
+        { 'id' => '4e696e74656e646f203634',
+          'url' => 'https://www.elastic.co/blog/introducing-quick-start-guides-getting-started-with-elastic-enterprise-search-for-free',
+          'title' => 'Getting started with Elastic Enterprise Search for free',
+          'body' => 'this is a test' },
+        {
+          'id' => '47616d6520426f7920436f6c6f72',
+          'url' => 'https://www.elastic.co/workplace-search',
+          'title' => 'One-stop answer shop for the virtual workplace',
+          'body' => 'this is also a test'
+        }
+      ]
+    end
+
+    it 'indexes' do
+      VCR.use_cassette('workplace_search/index_documents') do
+        response = client.index_documents(content_source_id, documents: documents)
+
+        expect(response.status).to eq 200
+        expect(response.body)
+          .to eq(
+            { 'results' =>
+              [
+                { 'id' => '4e696e74656e646f203634', 'errors' => [] },
+                { 'id' => '47616d6520426f7920436f6c6f72', 'errors' => [] }
+              ] }
+          )
+      end
+    end
+
+    it 'deletes' do
+      VCR.use_cassette('workplace_search/delete_documents') do
+        response = client.delete_documents(content_source_id, body: documents.map { |doc| doc['id'] })
+        expect(response.status).to eq 200
+        expect(response.body)
+          .to eq(
+            { 'results' =>
+              [
+                { 'id' => '4e696e74656e646f203634', 'success' => true },
+                { 'id' => '47616d6520426f7920436f6c6f72', 'success' => true }
+              ] }
+          )
+      end
+    end
+  end
+end