elastic-enterprise-search 0.3.1 → 7.12.1

data/CONTRIBUTING.md

@@ -0,0 +1,43 @@
+# Contributing to enterprise-search-ruby
+
+## Contributing Code Changes
+
+1. Please make sure you have signed the [Contributor License
+   Agreement](http://www.elastic.co/contributor-agreement/). We are not
+   asking you to assign copyright to us, but to give us the right to distribute
+   your code without restriction. We ask this of all contributors in order to
+   assure our users of the origin and continuing existence of the code. You only
+   need to sign the CLA once.
+ 
+2. Run rubocop and the test suite to ensure your changes do not break existing
+   code:
+   
+   ```
+   $ bundle exec rubocop
+   ```
+   
+   Check [Running
+   tests](https://github.com/elastic/enterprise-search-ruby/#run-tests) on the
+   README for instructions on how to run all the tests.
+
+3. Rebase your changes. Update your local repository with the most recent code
+   from the main `enterprise-search-ruby` repository and rebase your branch
+   on top of the latest `master` branch. All of your changes will be squashed
+   into a single commit so don't worry about pushing multiple times.
+   
+4. Submit a pull request. Push your local changes to your forked repository
+   and [submit a pull request](https://github.com/elastic/enterprise-search-python/pulls)
+   and mention the issue number if any (`Closes #123`) Make sure that you
+   add or modify tests related to your changes so that CI will pass.
+   
+5. Sit back and wait. There may be some discussion on your pull request and
+   if changes are needed we would love to work with you to get your pull request
+   merged into enterprise-search-ruby.
+
+## API Code Generation
+
+All the API methods within
+`lib/elastic/[app-search|enterprise-search|workplace-search]/api/*.rb` are
+generated from an API specification that is not available publicly currently.
+Because these files are generated, changes should instead be suggested in an
+issue or as part of the description in your Pull Request.

data/Gemfile

@@ -1,4 +1,26 @@
-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'
+gem 'simplecov', require: false, group: :test

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,53 @@
-<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).
+Official Ruby API client for [Elastic Enterprise Search](https://www.elastic.co/enterprise-search). Use this gem to integrate App Search and Workplace Search into your Ruby code.
 
-## Contents
+## Documentation
 
-+ [Getting started](#getting-started-)
-+ [Usage](#usage)
-+ [FAQ](#faq-)
-+ [Contribute](#contribute-)
-+ [License](#license-)
+[See the documentation](https://www.elastic.co/guide/en/enterprise-search-clients/ruby/current/index.html) for compatibility info, configuring, and an API reference.
 
-***
+## Development
 
-## Getting started 🐣
+### Run Stack locally
 
-To install the gem, execute:
+A rake task is included to run the Elastic Enterprise Search stack locally via Docker:
 
-```bash
-gem install elastic-enterprise-search
 ```
-
-Or place `gem 'elastic-enterprise-search', '~> 0.3.1` in your `Gemfile` and run `bundle install`.
-
-## Usage
-
-Create a new instance of the Enterprise Search Client with your access token:
-
-```ruby
-Elastic::EnterpriseSearch.access_token = '' # your access token
-client = Elastic::EnterpriseSearch::Client.new
+$ rake stack[7.10.0]
 ```
 
-### Change API endpoint
+This will run Elastic Enterprise Search in http://localhost:3002
+- Username: `enterprise_search`
+- Password: `changeme`
 
-```ruby
-client = Elastic::EnterpriseSearch::Client.new
-Elastic::EnterpriseSearch.endpoint = 'https://your-server.example.com/api/v1'
-```
+The version of the Elastic Enterprise Search Stack to use should be the same as tags of `https://www.docker.elastic.co/r/enterprise-search`. You can also use SNAPSHOT builds such as `8.0.0-SNAPSHOT`, `7.11-SNAPSHOT`, etc.
 
-### Specifying an HTTP Proxy
+### Running Tests
 
-```ruby
-client = Elastic::EnterpriseSearch::Client.new(:proxy => 'http://localhost:8888')
-```
+Unit tests for the clients:
 
-### Documents
-
-#### Indexing Documents
-
-This example shows how to use the index_documents method:
-
-```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
-
-```ruby
-content_source_key = '' # your content source key
-document_ids = ['INscMGmhmX4', 'JNDFojsd02']
-
-begin
-  destroy_document_results = client.destroy_documents(content_source_key, document_ids)
-  # handle destroy document results
-rescue Elastic::EnterpriseSearch::ClientException => e
-  # handle error
-end
+$ rake spec:client
 ```
 
-### Permissions
+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:
 
-#### Listing all permissions
-
-```ruby
-content_source_key = '' # your content source key
-
-client.list_all_permissions(content_source_key)
 ```
-
-#### Listing all permissions with paging
-
-```ruby
-content_source_key = '' # your content source key
-
-client.list_all_permissions(content_source_key, :current => 2, :size => 20)
+$ ELASTIC_ENTERPRISE_HOST='http://localhost:3002' \
+  ELASTIC_ENTERPRISE_USER='elastic' \
+  ELASTIC_ENTERPRISE_PASSWORD='changeme' \
+  rake spec:integration
 ```
 
-#### Retrieve a User's permissions
-
-```ruby
-content_source_key = '' # your content source key
-user = 'enterprise_search'
-
-client.get_user_permissions(content_source_key, user)
+Run integration tests completely within containers, the way we run them on our CI:
 ```
-
-#### Add permissions to a User
-```ruby
-content_source_key = '' # your content source key
-user = 'enterprise_search'
-permissions = ['permission1']
-
-client.add_user_permissions(content_source_key, user, :permissions => permissions)
+RUNSCRIPTS=enterprise-search STACK_VERSION=7.10.0 ./.ci/run-tests
 ```
 
-#### Update a User's permissions
-```ruby
-content_source_key = '' # your content source key
-user = 'enterprise_search'
-permissions = ['permission2']
-
-client.update_user_permissions(content_source_key, user, :permissions => permissions)
-```
-
-#### Remove permissions from a User
-```ruby
-content_source_key = '' # your content source key
-user = 'enterprise_search'
-permissions = ['permission2']
-
-client.remove_user_permissions(content_source_key, user, :permissions => permissions)
-```
-
-## Running tests
-
-Run tests via rspec:
-
-```bash
-$ ENDPOINT=http://localhost:3002/api/v1 bundle exec rspec
-```
-
-## FAQ 🔮
-
-### Where do I report issues with the client?
-
-If something is not working as expected, please open an [issue](https://github.com/elastic/enterprise-search-ruby/issues/new).
-
-## Contribute 🚀
-
-We welcome contributors to the project. Before you begin, a couple notes...
-
-+ 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.
-
-## License 📗
-
-[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