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

data/Gemfile

@@ -1,4 +1,25 @@
-source "https://rubygems.org"
+# 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
+
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in elastic-enterprise-search.gemspec
 gemspec
+
+gem 'rake'

data/{LICENSE.txt → LICENSE}

@@ -1,18 +1,19 @@
+
                                  Apache License
                            Version 2.0, January 2004
                         http://www.apache.org/licenses/
 
-    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
 
-    1. Definitions.
+   1. Definitions.
 
-       "License" shall mean the terms and conditions for use, reproduction,
+      "License" shall mean the terms and conditions for use, reproduction,
       and distribution as defined by Sections 1 through 9 of this document.
 
-       "Licensor" shall mean the copyright owner or entity authorized by
+      "Licensor" shall mean the copyright owner or entity authorized by
       the copyright owner that is granting the License.
 
-       "Legal Entity" shall mean the union of the acting entity and all
+      "Legal Entity" shall mean the union of the acting entity and all
       other entities that control, are controlled by, or are under common
       control with that entity. For the purposes of this definition,
       "control" means (i) the power, direct or indirect, to cause the
@@ -20,24 +21,24 @@
       otherwise, or (ii) ownership of fifty percent (50%) or more of the
       outstanding shares, or (iii) beneficial ownership of such entity.
 
-       "You" (or "Your") shall mean an individual or Legal Entity
+      "You" (or "Your") shall mean an individual or Legal Entity
       exercising permissions granted by this License.
 
-       "Source" form shall mean the preferred form for making modifications,
+      "Source" form shall mean the preferred form for making modifications,
       including but not limited to software source code, documentation
       source, and configuration files.
 
-       "Object" form shall mean any form resulting from mechanical
+      "Object" form shall mean any form resulting from mechanical
       transformation or translation of a Source form, including but
       not limited to compiled object code, generated documentation,
       and conversions to other media types.
 
-       "Work" shall mean the work of authorship, whether in Source or
+      "Work" shall mean the work of authorship, whether in Source or
       Object form, made available under the License, as indicated by a
       copyright notice that is included in or attached to the work
       (an example is provided in the Appendix below).
 
-       "Derivative Works" shall mean any work, whether in Source or Object
+      "Derivative Works" shall mean any work, whether in Source or Object
       form, that is based on (or derived from) the Work and for which the
       editorial revisions, annotations, elaborations, or other modifications
       represent, as a whole, an original work of authorship. For the purposes
@@ -45,7 +46,7 @@
       separable from, or merely link (or bind by name) to the interfaces of,
       the Work and Derivative Works thereof.
 
-       "Contribution" shall mean any work of authorship, including
+      "Contribution" shall mean any work of authorship, including
       the original version of the Work and any modifications or additions
       to that Work or Derivative Works thereof, that is intentionally
       submitted to Licensor for inclusion in the Work by the copyright owner
@@ -59,18 +60,18 @@
       excluding communication that is conspicuously marked or otherwise
       designated in writing by the copyright owner as "Not a Contribution."
 
-       "Contributor" shall mean Licensor and any individual or Legal Entity
+      "Contributor" shall mean Licensor and any individual or Legal Entity
       on behalf of whom a Contribution has been received by Licensor and
       subsequently incorporated within the Work.
 
-    2. Grant of Copyright License. Subject to the terms and conditions of
+   2. Grant of Copyright License. Subject to the terms and conditions of
       this License, each Contributor hereby grants to You a perpetual,
       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
       copyright license to reproduce, prepare Derivative Works of,
       publicly display, publicly perform, sublicense, and distribute the
       Work and such Derivative Works in Source or Object form.
 
-    3. Grant of Patent License. Subject to the terms and conditions of
+   3. Grant of Patent License. Subject to the terms and conditions of
       this License, each Contributor hereby grants to You a perpetual,
       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
       (except as stated in this section) patent license to make, have made,
@@ -86,24 +87,24 @@
       granted to You under this License for that Work shall terminate
       as of the date such litigation is filed.
 
-    4. Redistribution. You may reproduce and distribute copies of the
+   4. Redistribution. You may reproduce and distribute copies of the
       Work or Derivative Works thereof in any medium, with or without
       modifications, and in Source or Object form, provided that You
       meet the following conditions:
 
-       (a) You must give any other recipients of the Work or
+      (a) You must give any other recipients of the Work or
           Derivative Works a copy of this License; and
 
-       (b) You must cause any modified files to carry prominent notices
+      (b) You must cause any modified files to carry prominent notices
           stating that You changed the files; and
 
-       (c) You must retain, in the Source form of any Derivative Works
+      (c) You must retain, in the Source form of any Derivative Works
           that You distribute, all copyright, patent, trademark, and
           attribution notices from the Source form of the Work,
           excluding those notices that do not pertain to any part of
           the Derivative Works; and
 
-       (d) If the Work includes a "NOTICE" text file as part of its
+      (d) If the Work includes a "NOTICE" text file as part of its
           distribution, then any Derivative Works that You distribute must
           include a readable copy of the attribution notices contained
           within such NOTICE file, excluding those notices that do not
@@ -120,14 +121,14 @@
           that such additional attribution notices cannot be construed
           as modifying the License.
 
-       You may add Your own copyright statement to Your modifications and
+      You may add Your own copyright statement to Your modifications and
       may provide additional or different license terms and conditions
       for use, reproduction, or distribution of Your modifications, or
       for any such Derivative Works as a whole, provided Your use,
       reproduction, and distribution of the Work otherwise complies with
       the conditions stated in this License.
 
-    5. Submission of Contributions. Unless You explicitly state otherwise,
+   5. Submission of Contributions. Unless You explicitly state otherwise,
       any Contribution intentionally submitted for inclusion in the Work
       by You to the Licensor shall be under the terms and conditions of
       this License, without any additional terms or conditions.
@@ -135,12 +136,12 @@
       the terms of any separate license agreement you may have executed
       with Licensor regarding such Contributions.
 
-    6. Trademarks. This License does not grant permission to use the trade
+   6. Trademarks. This License does not grant permission to use the trade
       names, trademarks, service marks, or product names of the Licensor,
       except as required for reasonable and customary use in describing the
       origin of the Work and reproducing the content of the NOTICE file.
 
-    7. Disclaimer of Warranty. Unless required by applicable law or
+   7. Disclaimer of Warranty. Unless required by applicable law or
       agreed to in writing, Licensor provides the Work (and each
       Contributor provides its Contributions) on an "AS IS" BASIS,
       WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
@@ -150,7 +151,7 @@
       appropriateness of using or redistributing the Work and assume any
       risks associated with Your exercise of permissions under this License.
 
-    8. Limitation of Liability. In no event and under no legal theory,
+   8. Limitation of Liability. In no event and under no legal theory,
       whether in tort (including negligence), contract, or otherwise,
       unless required by applicable law (such as deliberate and grossly
       negligent acts) or agreed to in writing, shall any Contributor be
@@ -162,7 +163,7 @@
       other commercial damages or losses), even if such Contributor
       has been advised of the possibility of such damages.
 
-    9. Accepting Warranty or Additional Liability. While redistributing
+   9. Accepting Warranty or Additional Liability. While redistributing
       the Work or Derivative Works thereof, You may choose to offer,
       and charge a fee for, acceptance of support, warranty, indemnity,
       or other liability obligations and/or rights consistent with this
@@ -173,11 +174,11 @@
       incurred by, or claims asserted against, such Contributor by reason
       of your accepting any such warranty or additional liability.
 
-    END OF TERMS AND CONDITIONS
+   END OF TERMS AND CONDITIONS
 
-    APPENDIX: How to apply the Apache License to your work.
+   APPENDIX: How to apply the Apache License to your work.
 
-       To apply the Apache License to your work, attach the following
+      To apply the Apache License to your work, attach the following
       boilerplate notice, with the fields enclosed by brackets "[]"
       replaced with your own identifying information. (Don't include
       the brackets!)  The text should be enclosed in the appropriate
@@ -186,15 +187,15 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-    Copyright 2019 Elasticsearch B.V.
+   Copyright [yyyy] [name of copyright owner]
 
-    Licensed under the Apache License, Version 2.0 (the "License");
+   Licensed 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
+       http://www.apache.org/licenses/LICENSE-2.0
 
-    Unless required by applicable law or agreed to in writing, software
+   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

data/README.md

@@ -1,173 +1,271 @@
-<p align="center"><img src="https://github.com/elastic/enterprise-search-ruby/blob/master/logo-enterprise-search.png?raw=true" alt="Elastic Enterprise Search Logo"></p>
+# Elastic Enterprise Search Client
 
-<p align="center"><a href="https://circleci.com/gh/elastic/enterprise-search-ruby"><img src="https://circleci.com/gh/elastic/enterprise-search-ruby.svg?style=svg" alt="CircleCI build"></a></p>
+![build](https://github.com/elastic/enterprise-search-ruby/workflows/master/badge.svg)
+![rubocop](https://github.com/elastic/enterprise-search-ruby/workflows/rubocop/badge.svg)
+[![Ruby Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop-hq/rubocop)
 
-> A first-party Ruby client for [Elastic Enterprise Search](https://www.elastic.co/solutions/enterprise-search).
+This project is in development and in a beta state.
 
 ## Contents
+- [Installation](https://github.com/elastic/enterprise-search-ruby#installation)
+- [Getting Started](https://github.com/elastic/enterprise-search-ruby#getting-started)
+  - [Enterprise Search](https://github.com/elastic/enterprise-search-ruby#enterprise-search)
+  - [Workplace Search](https://github.com/elastic/enterprise-search-ruby#workplace-search)
+  - [App Search](https://github.com/elastic/enterprise-search-ruby#app-search)
+- [HTTP Layer](https://github.com/elastic/enterprise-search-ruby#http-layer)
+  - [Setting the host and port](https://github.com/elastic/enterprise-search-ruby#setting-the-host-and-port)
+  - [Logging](https://github.com/elastic/enterprise-search-ruby#logging)
+- [Development](https://github.com/elastic/enterprise-search-ruby#development)
+  - [Run stack locally](https://github.com/elastic/enterprise-search-ruby#run-stack-locally)
+  - [Run tests](https://github.com/elastic/enterprise-search-ruby#run-tests)
+- [License](https://github.com/elastic/enterprise-search-ruby#license)
+
+## Installation
+
+Install the gem:
 
-+ [Getting started](#getting-started-)
-+ [Usage](#usage)
-+ [FAQ](#faq-)
-+ [Contribute](#contribute-)
-+ [License](#license-)
+```
+$ gem install elastic-enterprise-search --pre
+```
 
-***
+Or add it to your project's Gemfile:
 
-## Getting started 🐣
+```
+gem 'elastic-enterprise-search'
+```
 
-To install the gem, execute:
+The version follows the Elastic Stack version so 7.10.0 is compatible with Enterprise Search released in Elastic Stack 7.10.0.
 
-```bash
-gem install elastic-enterprise-search
-```
+## Getting Started
 
-Or place `gem 'elastic-enterprise-search', '~> 0.3.1` in your `Gemfile` and run `bundle install`.
+### Enterprise Search
 
-## Usage
+The Enterprise Search API uses basic auth with credentials from an Elasticsearch user. You can read about the API, authentication and privileges needed [on the official docs](https://www.elastic.co/guide/en/enterprise-search/current/management-apis.html).
 
-Create a new instance of the Enterprise Search Client with your access token:
+#### Example usage:
 
 ```ruby
-Elastic::EnterpriseSearch.access_token = '' # your access token
-client = Elastic::EnterpriseSearch::Client.new
+http_auth = {user: 'elastic', password: 'password'}
+host = 'https://id.ent-search.europe-west2.gcp.elastic-cloud.com'
+
+ent_client = Elastic::EnterpriseSearch::Client.new(host: host, http_auth: http_auth)
 ```
 
-### Change API endpoint
+#### Health API
 
 ```ruby
-client = Elastic::EnterpriseSearch::Client.new
-Elastic::EnterpriseSearch.endpoint = 'https://your-server.example.com/api/v1'
+> response = ent_client.health
+> response.body
+ => {"name"=>"...",
+     "version"=>{"number"=>"7.10.0", "build_hash"=>"...", "build_date"=>"..."},
+     "jvm"=>{...},
+     "filebeat"=>{...},
+     "system"=>{...}
+    }
 ```
 
-### Specifying an HTTP Proxy
+#### Version API
 
 ```ruby
-client = Elastic::EnterpriseSearch::Client.new(:proxy => 'http://localhost:8888')
+> response = ent_client.version
+> response.body
+ => {"number"=>"7.10.0", "build_hash"=>"...", "build_date"=>"..."}
 ```
 
-### Documents
-
-#### Indexing Documents
-
-This example shows how to use the index_documents method:
+#### Managing Read-Only mode:
 
 ```ruby
-content_source_key = '' # your content source key
-documents = [
-  {
-    'id' => 'INscMGmhmX4',
-    'url' => 'http://www.youtube.com/watch?v=v1uyQZNg2vE',
-    'title' => 'The Original Grumpy Cat',
-    'body' => 'this is a test'
-  },
-  {
-    'id' => 'JNDFojsd02',
-    'url' => 'http://www.youtube.com/watch?v=tsdfhk2j',
-    'title' => 'Another Grumpy Cat',
-    'body' => 'this is also a test'
-  }
-]
-
-begin
-  document_receipts = client.index_documents(content_source_key, documents)
-  # handle results
-rescue Elastic::EnterpriseSearch::ClientException => e
-  # handle error
-end
-```
-
-#### Destroying Documents
+# Set read-only flag state
+ent_client.put_read_only(enabled: false)
+
+# Get read-only flag state
+ent_client.read_only
+```
 
+#### Stats API
 ```ruby
-content_source_key = '' # your content source key
-document_ids = ['INscMGmhmX4', 'JNDFojsd02']
+> ent_client.stats.body
+ => {"app"=>{"pid"=>1, "start"=>"...", "end"=>"", "metrics"=>{...}},
+     "queues"=>{"connectors"=>{...}, "document_destroyer"=>{...}, "engine_destroyer"=>{...}, "index_adder"=>{...}, ...},
+     "connectors"=>{"alive"=>true, "pool"=>{...}, "job_store"=>{...}}}}
 
-begin
-  destroy_document_results = client.destroy_documents(content_source_key, document_ids)
-  # handle destroy document results
-rescue Elastic::EnterpriseSearch::ClientException => e
-  # handle error
-end
 ```
 
-### Permissions
+### Workplace Search
 
-#### Listing all permissions
+In your Elastic Workplace Search dashboard navigate to _Sources/Add a Shared Content Source_ and select _Custom API Source_ to create a new source. Name your source (e.g. `Enterprise Search Ruby Client`) and once it's created you'll get an `access token` and a `key`. You'll need these in the following steps.
 
-```ruby
-content_source_key = '' # your content source key
+#### Instantiation
+
+The Workplace Search client can be accessed from an existing Enterprise Search Client, or you can initialize a new one. If you instantiate the Workplace Search client from an existing Enterprise Search Client, it's going to share the HTTP transport instance, so it's going to connect to the same host, which is a common scenario. However, if you want to connect to a different host, you should instantiate a new Workplace Client on its own:
 
-client.list_all_permissions(content_source_key)
+```ruby
+# Prerequisites
+host = 'https://id.ent-search.europe-west2.gcp.elastic-cloud.com'
+access_token = '<access token>'
+content_source_key = '<content source key>'
+
+# From the Enterprise Search client:
+ent_client = Elastic::EnterpriseSearch::Client.new(host: host)
+ent_client.workplace_search.http_auth = access_token
+ent_client.workplace_search.index_documents(content_source_key, body: documents)
+
+# On its own
+workplace_search_client = Elastic::EnterpriseSearch::WorkplaceSearch::Client.new(
+  host: host,
+  http_auth: access_token
+)
 ```
 
-#### Listing all permissions with paging
+### App Search
+
+In your Elastic App Search dashboard, navigate to Credentials and Create a Key for the client to use. Make sure to read [the documentation on Authentication](https://www.elastic.co/guide/en/app-search/current/authentication.html) to understand which key you want to use. Once you've created your key, you need to copy the key value to use on your client:
+
+#### Instantiation
+
+The App Search client can be accessed from an existing Enterprise Search Client, or you can initialize a new one. If you instantiate the App Search client from an existing Enterprise Search Client, it's going to share the HTTP transport instance, so it's going to connect to the same host which is a common scenario. However, if you want to connect to a different host, you should instantiate a new App Search Client on its own.
 
 ```ruby
-content_source_key = '' # your content source key
+# Prerequisites
+host = 'https://id.ent-search.europe-west2.gcp.elastic-cloud.com'
+api_key = 'private-api-key'
 
-client.list_all_permissions(content_source_key, :current => 2, :size => 20)
+# From the Enterprise Search client:
+ent_client = Elastic::EnterpriseSearch::Client.new(host: host)
+ent_client.app_search.http_auth = api_key
+
+# On its own
+client = Elastic::EnterpriseSearch::AppSearch::Client.new(host: host, http_auth: api_key)
 ```
 
-#### Retrieve a User's permissions
+#### Engines
 
 ```ruby
-content_source_key = '' # your content source key
-user = 'enterprise_search'
+# Create an engine
+client.create_engine(name: 'videogames')
+
+# List all engines
+client.list_engines
+
+# Get an engine
+client.engine('videogames')
 
-client.get_user_permissions(content_source_key, user)
+# Delete an engine
+client.delete_engine('videogames')
 ```
 
-#### Add permissions to a User
+#### Documents
+
 ```ruby
-content_source_key = '' # your content source key
-user = 'enterprise_search'
-permissions = ['permission1']
+engine_name = 'videogames'
+document = {
+  id: 'Mr1064',
+  name: 'Super Luigi 64',
+  body: 'A classic 3D videogame'
+}
+
+# Index documents
+client.index_documents(engine_name, body: document)
+
+# List documents
+client.list_documents(engine_name)
 
-client.add_user_permissions(content_source_key, user, :permissions => permissions)
+# Delete a document
+client.delete_documents(engine_name, body: [document_id])
+
+# Update a document
+client.put_documents(engine_name, body: [{id: document_id, key: value}])
 ```
 
-#### Update a User's permissions
+#### Search
+
 ```ruby
-content_source_key = '' # your content source key
-user = 'enterprise_search'
-permissions = ['permission2']
+query = {
+  query: 'luigi'
+}
 
-client.update_user_permissions(content_source_key, user, :permissions => permissions)
+client.search(engine_name, query)
 ```
 
-#### Remove permissions from a User
+#### Other API Endpoints
+
 ```ruby
-content_source_key = '' # your content source key
-user = 'enterprise_search'
-permissions = ['permission2']
 
-client.remove_user_permissions(content_source_key, user, :permissions => permissions)
+# Count analytics - Returns the number of clicks and total number of queries over a period
+client.count_analytics(engine_name)
+
+# Schema - Retrieve current schema for the engine
+client.schema(engine_name)
+
+# Logs - The API Log displays API request and response data at the Engine level
+client.api_logs(engine_name, from_date: Date.new(2020, 10, 01), to_date: Date.new(2020, 11, 05))
+
+# Queries Analytics - Returns queries analytics by usage count
+client.top_queries_analytics(engine_name)
+
+# Clicks Analytics - Returns the number of clicks received by a document in descending order
+client.top_clicks_analytics(engine_name, query: {})
+
 ```
 
-## Running tests
+## HTTP Layer
+
+This library uses [elasticsearch-transport](https://github.com/elastic/elasticsearch-ruby/tree/master/elasticsearch-transport), the low-level Ruby client for connecting to an Elasticsearch cluster - also used in the official [Elasticsearch Ruby Client](https://github.com/elastic/elasticsearch-ruby).
+
+All requests, if successful, will return an `Elasticsearch::Transport::Transport::Response` instance. You can access the response `body`, `headers` and `status`.
+
+`elasticsearch-transport` defines a [number of exception classes](https://github.com/elasticsearch/elasticsearch-ruby/blob/master/elasticsearch-transport/lib/elasticsearch/transport/transport/errors.rb) for various client and server errors, as well as unsuccessful HTTP responses, making it possible to rescue specific exceptions with desired granularity. More details [here](https://github.com/elastic/elasticsearch-ruby/tree/master/elasticsearch-transport#exception-handling). You can find the full documentation for `elasticsearch-transport` at [RubyDoc](https://rubydoc.info/gems/elasticsearch-transport).
+
+The clients pass different options to transport, you can check them out [in the source code](https://github.com/elastic/enterprise-search-ruby/blob/master/lib/elastic/enterprise-search/client.rb) while we set up RubyDocs.
+
+### Setting the host and port
+
+If you don't specify a host and port, the client will default to `http://localhost:3002`. Otherwise pass in the `:host` parameter as a String.
+
+### Logging
 
-Run tests via rspec:
+You can enable logging with the default logger by passing `log: true` as a parameter to the client's initializer, or pass in a Logger object with the `:logger` parameter:
 
-```bash
-$ ENDPOINT=http://localhost:3002/api/v1 bundle exec rspec
+```ruby
+logger = MyLogger.new
+client = Elastic::EnterpriseSearch::Client.new(logger: logger)
 ```
 
-## FAQ 🔮
+## Development
+
+### Run Stack locally
+
+A rake task is included to run the Elastic Enterprise Search stack locally via Docker:
+
+```
+$ rake stack[7.10.0]
+```
 
-### Where do I report issues with the client?
+This will run Elastic Enterprise Search in http://localhost:3002
+- Username: `enterprise_search`
+- Password: `changeme`
 
-If something is not working as expected, please open an [issue](https://github.com/elastic/enterprise-search-ruby/issues/new).
+### Run Tests
 
-## Contribute 🚀
+Unit tests for the clients:
 
-We welcome contributors to the project. Before you begin, a couple notes...
+```
+$ rake spec:client
+```
 
-+ Before opening a pull request, please create an issue to [discuss the scope of your proposal](https://github.com/elastic/enterprise-search-ruby/issues).
-+ Please write simple code and concise documentation, when appropriate.
+Integration tests: you need to have an instance of Enterprise Search running either locally or remotely, and specify the host and credentials in environment variables (see below for a complete dockerized setup). If you're using the included rake task `rake stack[:version]`, you can run the integration tests with the following command:
+```
+$ ELASTIC_ENTERPRISE_HOST='http://localhost:3002' \
+  ELASTIC_ENTERPRISE_USER='elastic' \
+  ELASTIC_ENTERPRISE_PASSWORD='changeme' \
+  rake spec:integration
+```
 
-## License 📗
+Run integration tests completely within containers, the way we run them on our CI:
+```
+RUNSCRIPTS=enterprise-search STACK_VERSION=7.10.0 ./.ci/run-tests
+```
 
-[Apache 2.0](https://github.com/elastic/enterprise-search-ruby/blob/master/LICENSE.txt) © [Elastic](https://github.com/elastic)
+## License
 
-Thank you to all the [contributors](https://github.com/elastic/enterprise-search-ruby/graphs/contributors)!
+Apache-2.0