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

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/{api_spec.rb → permissions_spec.rb}

@@ -22,7 +22,7 @@ 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(:content_source_id) { ENV['ELASTIC_WORKPLACE_SOURCE_ID'] || 'content_source_id' }
   let(:client) do
     Elastic::EnterpriseSearch::WorkplaceSearch::Client.new(
       host: host,
@@ -30,64 +30,12 @@ describe Elastic::EnterpriseSearch::WorkplaceSearch::Client do
     )
   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)
+      VCR.use_cassette('workplace_search/list_permissions') do
+        response = client.list_permissions(content_source_id)
 
         expect(response.status).to eq 200
 
@@ -104,8 +52,8 @@ describe Elastic::EnterpriseSearch::WorkplaceSearch::Client do
     it 'gets user permissions' do
       clear_user_permissions
 
-      VCR.use_cassette(:user_permissions_empty) do
-        response = client.user_permissions(content_source_key, { user: user })
+      VCR.use_cassette('workplace_search/user_permissions_empty') do
+        response = client.user_permissions(content_source_id, { user: user })
 
         expect(response.status).to eq 200
 
@@ -117,18 +65,18 @@ describe Elastic::EnterpriseSearch::WorkplaceSearch::Client do
     end
 
     def clear_user_permissions
-      VCR.use_cassette(:clear_user_permissions) do
+      VCR.use_cassette('workplace_search/clear_user_permissions') do
         client.put_user_permissions(
-          content_source_key,
+          content_source_id,
           { permissions: [], user: user }
         )
       end
     end
 
     it 'updates user permissions' do
-      VCR.use_cassette(:put_user_permissions) do
+      VCR.use_cassette('workplace_search/put_user_permissions') do
         response = client.add_user_permissions(
-          content_source_key,
+          content_source_id,
           { permissions: ['testing', 'more', 'permissions'], user: user }
         )
 
@@ -140,7 +88,7 @@ describe Elastic::EnterpriseSearch::WorkplaceSearch::Client do
           )
 
         response = client.put_user_permissions(
-          content_source_key,
+          content_source_id,
           { permissions: [], user: user }
         )
 
@@ -154,10 +102,10 @@ describe Elastic::EnterpriseSearch::WorkplaceSearch::Client do
     end
 
     it 'adds and removes permissions from a user' do
-      VCR.use_cassette(:add_user_permissions) do
+      VCR.use_cassette('workplace_search/add_user_permissions') do
         permissions = ['permission1', 'permission2']
         response = client.add_user_permissions(
-          content_source_key,
+          content_source_id,
           { permissions: permissions, user: user }
         )
 
@@ -169,10 +117,10 @@ describe Elastic::EnterpriseSearch::WorkplaceSearch::Client do
           )
       end
 
-      VCR.use_cassette(:remove_user_permissions) do
+      VCR.use_cassette('workplace_search/remove_user_permissions') do
         permissions = ['permission1', 'permission2']
         response = client.remove_user_permissions(
-          content_source_key,
+          content_source_id,
           { permissions: permissions, user: user }
         )
 

data/spec/workplace-search/search_spec.rb

@@ -0,0 +1,53 @@
+# 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
+
+  it 'goes through the search OAuth ' 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/search_request') do
+      response = client.search(body: { query: '1984' }, access_token: @oauth_access_token)
+
+      expect(response.status).to eq 200
+      expect(response.body['results'].count).to be > 1
+      expect(response.body['results'][0]['title']['raw']).to eq '1984'
+      expect(response.body['results'][0]['author']['raw']).to eq 'George Orwell'
+    end
+  end
+end

metadata

@@ -1,29 +1,49 @@
 --- !ruby/object:Gem::Specification
 name: elastic-enterprise-search
 version: !ruby/object:Gem::Version
-  version: 7.10.0.beta.1
+  version: 7.11.0
 platform: ruby
 authors:
 - Fernando Briano
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-11 00:00:00.000000000 Z
+date: 2021-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: elasticsearch-transport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.11'
+- !ruby/object:Gem::Dependency
+  name: jwt
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement
@@ -122,10 +142,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 'API client for accessing the Elastic Enterprise APIs. This gem is in
-  a beta state.
+description: 'Official API client for Elastic Enterprise Search APIs.
 
-'
+  '
 email:
 - support@elastic.co
 executables: []
@@ -145,6 +164,7 @@ files:
 - ".ci/functions/imports.sh"
 - ".ci/functions/wait-for-container.sh"
 - ".ci/jobs/defaults.yml"
+- ".ci/jobs/elastic+enterprise-search-ruby+7.10.0.beta.1.yml"
 - ".ci/jobs/elastic+enterprise-search-ruby+master.yml"
 - ".ci/jobs/elastic+enterprise-search-ruby+pull-request.yml"
 - ".ci/run-elasticsearch.sh"
@@ -157,10 +177,19 @@ files:
 - ".github/workflows/testing.yml"
 - ".gitignore"
 - ".rubocop.yml"
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
+- docs/guide/app-search-api.asciidoc
+- docs/guide/connecting.asciidoc
+- docs/guide/development.asciidoc
+- docs/guide/enterprise-search-api.asciidoc
+- docs/guide/index.asciidoc
+- docs/guide/installation.asciidoc
+- docs/guide/overview.asciidoc
+- docs/guide/workplace-search-api.asciidoc
 - elastic-enterprise-search.gemspec
 - lib/data/ca-bundle.crt
 - lib/elastic-enterprise-search.rb
@@ -213,6 +242,7 @@ files:
 - lib/elastic/enterprise-search/version.rb
 - lib/elastic/enterprise_search.rb
 - lib/elastic/workplace-search/api/add_user_permissions.rb
+- lib/elastic/workplace-search/api/create_analytics_event.rb
 - lib/elastic/workplace-search/api/create_external_identity.rb
 - lib/elastic/workplace-search/api/delete_documents.rb
 - lib/elastic/workplace-search/api/delete_external_identity.rb
@@ -226,63 +256,93 @@ files:
 - lib/elastic/workplace-search/api/search.rb
 - lib/elastic/workplace-search/api/user_permissions.rb
 - lib/elastic/workplace-search/workplace_search.rb
-- lib/generator/documentation_helper.rb
-- lib/generator/endpoint_generator.rb
-- lib/generator/parameters_exceptions.rb
-- lib/generator/parameters_helper.rb
-- lib/generator/templates/_license.erb
-- lib/generator/templates/endpoint_template.erb
-- lib/generator/templates/spec_template.erb
-- lib/generator/utils.rb
 - spec/app-search/api_count_analytics_spec.rb
+- spec/app-search/api_curations_spec.rb
 - spec/app-search/api_documents_spec.rb
 - spec/app-search/api_engines_spec.rb
+- spec/app-search/api_log_clickthrough_spec.rb
 - spec/app-search/api_logs_spec.rb
+- spec/app-search/api_meta_engines_spec.rb
+- spec/app-search/api_query_suggestion_spec.rb
 - spec/app-search/api_schema_spec.rb
 - spec/app-search/api_search_and_multi_search_spec.rb
+- spec/app-search/api_search_settings_spec.rb
 - spec/app-search/api_spec_helper.rb
+- spec/app-search/api_synonyms_spec.rb
 - spec/app-search/api_top_clicks_analytics_spec.rb
 - spec/app-search/api_top_queries_analytics_spec.rb
 - spec/app-search/client_spec.rb
 - spec/enterprise-search/client_spec.rb
 - spec/enterprise-search/request_spec.rb
-- spec/fixtures/vcr/add_user_permissions.yml
+- spec/enterprise-search/utils_spec.rb
+- spec/fixtures/vcr/app_search/add_meta_engine_source.yml
+- spec/fixtures/vcr/app_search/api_documents.yml
+- spec/fixtures/vcr/app_search/api_index_documents.yml
+- spec/fixtures/vcr/app_search/api_log_clickthrough.yml
 - spec/fixtures/vcr/app_search/api_logs.yml
+- spec/fixtures/vcr/app_search/api_put_schema.yml
+- spec/fixtures/vcr/app_search/api_put_search_settings.yml
+- spec/fixtures/vcr/app_search/api_query_suggestion.yml
+- spec/fixtures/vcr/app_search/api_reset_search_settings.yml
+- spec/fixtures/vcr/app_search/api_schema.yml
+- spec/fixtures/vcr/app_search/api_search_settings.yml
 - spec/fixtures/vcr/app_search/api_top_clicks_analytics.yml
 - spec/fixtures/vcr/app_search/api_top_clicks_analytics_query.yml
 - spec/fixtures/vcr/app_search/api_top_queries_analytics.yml
 - spec/fixtures/vcr/app_search/count_analytics.yml
 - spec/fixtures/vcr/app_search/create_and_update_document.yml
+- spec/fixtures/vcr/app_search/create_curation.yml
+- spec/fixtures/vcr/app_search/create_engine.yml
+- spec/fixtures/vcr/app_search/create_meta_engine.yml
+- spec/fixtures/vcr/app_search/create_synonym_set.yml
+- spec/fixtures/vcr/app_search/delete_curation.yml
+- spec/fixtures/vcr/app_search/delete_engine.yml
+- spec/fixtures/vcr/app_search/delete_meta_engine_source.yml
+- spec/fixtures/vcr/app_search/delete_synonym_set.yml
+- spec/fixtures/vcr/app_search/get_curation.yml
+- spec/fixtures/vcr/app_search/get_engine.yml
 - spec/fixtures/vcr/app_search/index_and_delete_document.yml
-- spec/fixtures/vcr/app_search/index_documents.yml
+- spec/fixtures/vcr/app_search/list_curations.yml
 - spec/fixtures/vcr/app_search/list_documents.yml
+- spec/fixtures/vcr/app_search/list_engines.yml
+- spec/fixtures/vcr/app_search/list_synonym_sets.yml
 - spec/fixtures/vcr/app_search/multi_query_search.yml
-- spec/fixtures/vcr/app_search/schema.yml
+- spec/fixtures/vcr/app_search/put_curation.yml
+- spec/fixtures/vcr/app_search/put_synonym_set.yml
 - spec/fixtures/vcr/app_search/search.yml
 - spec/fixtures/vcr/app_search/single_query_search.yml
-- spec/fixtures/vcr/clear_user_permissions.yml
-- spec/fixtures/vcr/create_document.yml
-- spec/fixtures/vcr/create_engine.yml
-- spec/fixtures/vcr/delete_documents.yml
-- spec/fixtures/vcr/delete_engine.yml
-- spec/fixtures/vcr/get_engine.yml
-- spec/fixtures/vcr/index_documents.yml
-- spec/fixtures/vcr/list_engines.yml
-- spec/fixtures/vcr/list_permissions.yml
-- spec/fixtures/vcr/put_user_permissions.yml
-- spec/fixtures/vcr/remove_user_permissions.yml
-- spec/fixtures/vcr/user_permissions_empty.yml
+- spec/fixtures/vcr/app_search/synonym_set.yml
+- spec/fixtures/vcr/workplace_search/add_user_permissions.yml
+- spec/fixtures/vcr/workplace_search/clear_user_permissions.yml
+- spec/fixtures/vcr/workplace_search/create_analytics_event.yml
+- spec/fixtures/vcr/workplace_search/create_external_identity.yml
+- spec/fixtures/vcr/workplace_search/delete_documents.yml
+- spec/fixtures/vcr/workplace_search/delete_external_identity.yml
+- spec/fixtures/vcr/workplace_search/index_documents.yml
+- spec/fixtures/vcr/workplace_search/list_external_identities.yml
+- spec/fixtures/vcr/workplace_search/list_permissions.yml
+- spec/fixtures/vcr/workplace_search/oauth_request_token.yml
+- spec/fixtures/vcr/workplace_search/put_external_identity.yml
+- spec/fixtures/vcr/workplace_search/put_user_permissions.yml
+- spec/fixtures/vcr/workplace_search/remove_user_permissions.yml
+- spec/fixtures/vcr/workplace_search/retrieve_external_identity.yml
+- spec/fixtures/vcr/workplace_search/search_request.yml
+- spec/fixtures/vcr/workplace_search/user_permissions_empty.yml
 - spec/integration/enterprise_search_api_spec.rb
 - spec/spec_helper.rb
 - spec/webmock_requires.rb
-- spec/workplace-search/api_spec.rb
 - spec/workplace-search/client_spec.rb
+- spec/workplace-search/create_analytics_event_spec.rb
+- spec/workplace-search/documents_spec.rb
+- spec/workplace-search/external_identities_spec.rb
+- spec/workplace-search/permissions_spec.rb
+- spec/workplace-search/search_spec.rb
 homepage: https://github.com/elastic/enterprise-search-ruby
 licenses:
 - Apache-2.0
 metadata:
   bug_tracker_uri: https://github.com/elastic/enterprise-search-ruby/issues
-  documentation_uri: https://github.com/elastic/enterprise-search-ruby/blob/master/README.md
+  documentation_uri: https://www.elastic.co/guide/en/enterprise-search-clients/ruby/current/index.html
   homepage_uri: https://www.elastic.co/enterprise-search
   source_code_uri: https://github.com/elastic/enterprise-search-ruby
 post_install_message: 
@@ -296,12 +356,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
-summary: Official gem for accessing the Elastic Enterprise Search APIs
+summary: Official API client for Elastic Enterprise Search
 test_files: []