elastic-enterprise-search 0.2.1 → 7.12.0

data/spec/spec_helper.rb

@@ -1,28 +1,41 @@
-require 'bundler/setup'
+# 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 'simplecov'
+SimpleCov.start
+require 'elastic/enterprise_search'
 require 'rspec'
-require 'webmock'
 require 'vcr'
-require 'awesome_print'
-require 'elastic/enterprise-search'
-
 
 RSpec.configure do |config|
   # Run specs in random order to surface order dependencies. If you find an
   # order dependency and want to debug it, you can fix the order by providing
   # the seed, which is printed after each run.
   #     --seed 1234
-  config.order = "random"
+  config.order = 'random'
+
+  config.add_formatter('documentation')
+  config.add_formatter('RspecJunitFormatter', 'enterprise-search-junit.xml')
 
   VCR.configure do |c|
     c.cassette_library_dir = 'spec/fixtures/vcr'
     c.hook_into :webmock
-  end
-
-  config.before :each do
-    Elastic::EnterpriseSearch.endpoint = ENV["ENDPOINT"]
-  end
-
-  config.after :each do
-    Elastic::EnterpriseSearch.reset
+    c.allow_http_connections_when_no_cassette = true
   end
 end

data/spec/webmock_requires.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'webmock'
+require 'webmock/rspec'

data/spec/workplace-search/client_spec.rb

@@ -0,0 +1,77 @@
+# 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) { '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 }
+
+    it 'initializes a workplace search client' do
+      expect(workplace_client).not_to be nil
+      expect(workplace_client).to be_a(Elastic::EnterpriseSearch::WorkplaceSearch::Client)
+      expect(workplace_client.host).to eq(host)
+    end
+
+    it 'sets up authentication during initialization' do
+      ent_client = Elastic::EnterpriseSearch::Client.new(host: host)
+      workplace_client = ent_client.workplace_search(http_auth: access_token)
+      expect(workplace_client.http_auth).to eq access_token
+    end
+
+    it 'sets up authentication as a parameter' do
+      workplace_client.http_auth = access_token
+      expect(workplace_client.http_auth).to eq access_token
+    end
+  end
+
+  context 'independent from EnterpriseSearch client' do
+    let(:workplace_client) { Elastic::EnterpriseSearch::WorkplaceSearch::Client.new(host: host) }
+
+    it 'initializes a workplace search client' do
+      expect(workplace_client).not_to be nil
+      expect(workplace_client).to be_a(Elastic::EnterpriseSearch::WorkplaceSearch::Client)
+      expect(workplace_client.host).to eq(host)
+    end
+
+    it 'sets up authentication during initialization' do
+      ent_client = Elastic::EnterpriseSearch::Client.new(host: host)
+      workplace_client = ent_client.workplace_search(http_auth: access_token)
+      expect(workplace_client.http_auth).to eq access_token
+    end
+
+    it 'sets up authentication as a parameter' do
+      workplace_client.http_auth = access_token
+      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, document_ids: 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

data/spec/workplace-search/external_identities_spec.rb

@@ -0,0 +1,84 @@
+# 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 'external identities' do
+    let(:user) { 'elastic_user' }
+    let(:source_user_id) { 'example@elastic.co' }
+
+    it 'creates an external identity' do
+      VCR.use_cassette('workplace_search/create_external_identity') do
+        body = { user: user, source_user_id: source_user_id }
+        response = client.create_external_identity(content_source_id, body: body)
+
+        expect(response.status).to eq 200
+        expect(response.body).to eq({ 'source_user_id' => source_user_id, 'user' => user })
+      end
+    end
+
+    it 'retrieves an external identity' do
+      VCR.use_cassette('workplace_search/retrieve_external_identity') do
+        response = client.external_identity(content_source_id, user: user)
+
+        expect(response.status).to eq 200
+        expect(response.body).to eq({ 'source_user_id' => source_user_id, 'user' => user })
+      end
+    end
+
+    it 'lists external identities' do
+      VCR.use_cassette('workplace_search/list_external_identities') do
+        response = client.list_external_identities(content_source_id)
+
+        expect(response.status).to eq 200
+        expect(response.body['results']).to eq([{ 'source_user_id' => source_user_id, 'user' => user }])
+      end
+    end
+
+    it 'updates an external identity' do
+      VCR.use_cassette('workplace_search/put_external_identity') do
+        body = { source_user_id: 'example2@elastic.co' }
+        response = client.put_external_identity(content_source_id, user: user, body: body)
+
+        expect(response.status).to eq 200
+        expect(response.body).to eq({ 'source_user_id' => 'example2@elastic.co', 'user' => user })
+      end
+    end
+
+    it 'deletes an external identity' do
+      VCR.use_cassette('workplace_search/delete_external_identity') do
+        response = client.delete_external_identity(content_source_id, user: user)
+
+        expect(response.status).to eq 200
+        expect(response.body).to eq 'ok'
+      end
+    end
+  end
+end

data/spec/workplace-search/permissions_spec.rb

@@ -0,0 +1,136 @@
+# 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 'permissions' do
+    let(:user) { 'enterprise_search' }
+
+    it 'lists permissions' do
+      VCR.use_cassette('workplace_search/list_permissions') do
+        response = client.list_permissions(content_source_id)
+
+        expect(response.status).to eq 200
+
+        expect(response.body)
+          .to eq(
+            { 'meta' =>
+              { 'page' => { 'current' => 1, 'total_pages' => 1, 'total_results' => 1, 'size' => 25 } }, 'results' => [
+                { 'user' => 'enterprise_search', 'permissions' => [] }
+              ] }
+          )
+      end
+    end
+
+    it 'gets user permissions' do
+      clear_user_permissions
+
+      VCR.use_cassette('workplace_search/user_permissions_empty') do
+        response = client.user_permissions(content_source_id, { user: user })
+
+        expect(response.status).to eq 200
+
+        expect(response.body)
+          .to eq(
+            { 'user' => 'enterprise_search', 'permissions' => [] }
+          )
+      end
+    end
+
+    def clear_user_permissions
+      VCR.use_cassette('workplace_search/clear_user_permissions') do
+        client.put_user_permissions(
+          content_source_id,
+          { permissions: [], user: user }
+        )
+      end
+    end
+
+    it 'updates user permissions' do
+      VCR.use_cassette('workplace_search/put_user_permissions') do
+        response = client.add_user_permissions(
+          content_source_id,
+          { permissions: ['testing', 'more', 'permissions'], user: user }
+        )
+
+        expect(response.status).to eq 200
+
+        expect(response.body)
+          .to eq(
+            { 'user' => 'enterprise_search', 'permissions' => ['testing', 'more', 'permissions'] }
+          )
+
+        response = client.put_user_permissions(
+          content_source_id,
+          { permissions: [], user: user }
+        )
+
+        expect(response.status).to eq 200
+
+        expect(response.body)
+          .to eq(
+            { 'user' => 'enterprise_search', 'permissions' => [] }
+          )
+      end
+    end
+
+    it 'adds and removes permissions from a user' do
+      VCR.use_cassette('workplace_search/add_user_permissions') do
+        permissions = ['permission1', 'permission2']
+        response = client.add_user_permissions(
+          content_source_id,
+          { permissions: permissions, user: user }
+        )
+
+        expect(response.status).to eq 200
+
+        expect(response.body)
+          .to eq(
+            { 'user' => 'enterprise_search', 'permissions' => ['permission1', 'permission2'] }
+          )
+      end
+
+      VCR.use_cassette('workplace_search/remove_user_permissions') do
+        permissions = ['permission1', 'permission2']
+        response = client.remove_user_permissions(
+          content_source_id,
+          { permissions: permissions, user: user }
+        )
+
+        expect(response.status).to eq 200
+
+        expect(response.body)
+          .to eq(
+            { 'user' => 'enterprise_search', 'permissions' => [] }
+          )
+      end
+    end
+  end
+end