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

data/spec/fixtures/vcr/user_permissions_empty.yml

@@ -0,0 +1,51 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://localhost:3002/api/ws/v1/sources/content_source_key/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)'
+      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"
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - fe4e4e34-d5c6-43ac-aae6-6f47a4e4c28d
+      X-Runtime:
+      - '0.063630'
+      Transfer-Encoding:
+      - chunked
+      Server:
+      - Jetty(9.4.30.v20200611)
+    body:
+      encoding: UTF-8
+      string: '{"user":"enterprise_search","permissions":[]}'
+    http_version: 
+  recorded_at: Tue, 03 Nov 2020 23:15:20 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(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(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

data/spec/spec_helper.rb

@@ -1,28 +1,39 @@
-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 '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/api_spec.rb

@@ -0,0 +1,188 @@
+# 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_key) { ENV['ELASTIC_WORKPLACE_SOURCE_KEY'] || 'content_source_key' }
+  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(:index_documents) do
+        response = client.index_documents(content_source_key, body: 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(:index_documents) do
+        client.index_documents(content_source_key, body: documents)
+      end
+
+      VCR.use_cassette(:delete_documents) do
+        response = client.delete_documents(content_source_key, 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
+
+  context 'permissions' do
+    let(:user) { 'enterprise_search' }
+
+    it 'lists permissions' do
+      VCR.use_cassette(:list_permissions) do
+        response = client.list_permissions(content_source_key)
+
+        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(:user_permissions_empty) do
+        response = client.user_permissions(content_source_key, { 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(:clear_user_permissions) do
+        client.put_user_permissions(
+          content_source_key,
+          { permissions: [], user: user }
+        )
+      end
+    end
+
+    it 'updates user permissions' do
+      VCR.use_cassette(:put_user_permissions) do
+        response = client.add_user_permissions(
+          content_source_key,
+          { 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_key,
+          { 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(:add_user_permissions) do
+        permissions = ['permission1', 'permission2']
+        response = client.add_user_permissions(
+          content_source_key,
+          { 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(:remove_user_permissions) do
+        permissions = ['permission1', 'permission2']
+        response = client.remove_user_permissions(
+          content_source_key,
+          { permissions: permissions, user: user }
+        )
+
+        expect(response.status).to eq 200
+
+        expect(response.body)
+          .to eq(
+            { 'user' => 'enterprise_search', 'permissions' => [] }
+          )
+      end
+    end
+  end
+end

data/spec/workplace-search/client_spec.rb

@@ -0,0 +1,69 @@
+# 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' }
+
+  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
+      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) }
+    let(:access_token) { 'access_token' }
+
+    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
+end