elastic-app-search 0.7.0

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+script: rspec
+rvm:
+  - 2.0
+  - 2.1
+  - 2.2
+  - 2.4
+  - jruby
+jdk:
+  - oraclejdk8
+
+before_install:
+  - gem update --system
+  - gem --version
+  - gem update bundler

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in elastic-app-search-ruby.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "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
+      the copyright owner that is granting the License.
+
+      "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
+      direction or management of such entity, whether by contract or
+      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
+      exercising permissions granted by this License.
+
+      "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
+      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
+      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
+      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
+      of this License, Derivative Works shall not include works that remain
+      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
+      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
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      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
+      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
+      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
+      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,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      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
+      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
+          Derivative Works a copy of this License; and
+
+      (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
+          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
+          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
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      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,
+      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.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      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
+      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
+      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
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      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,
+      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
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      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
+      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
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      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
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2019 Elasticsearch B.V.
+
+   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
+
+   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.

data/NOTICE.txt

@@ -0,0 +1,3 @@
+Elastic App Search Ruby client.
+
+Copyright 2012-2019 Elasticsearch B.V.

data/README.md

@@ -0,0 +1,320 @@
+<p align="center"><img src="https://github.com/elastic/app-search-ruby/blob/master/logo-app-search.png?raw=true" alt="Elastic App Search Logo"></p>
+
+<p align="center"><a href="https://circleci.com/gh/elastic/app-search-ruby"><img src="https://circleci.com/gh/elastic/app-search-ruby.svg?style=svg" alt="CircleCI build"></a></p>
+
+> A first-party Ruby client for building excellent, relevant search experiences with Elastic App Search.
+
+## Contents
+
+- [Getting started](#getting-started-)
+- [Usage](#usage)
+- [Running Tests](#running-tests)
+- [Debugging API Calls](#debugging-api-calls)
+- [FAQ](#faq-)
+- [Contribute](#contribute-)
+- [License](#license-)
+
+---
+
+## Getting started 🐣
+
+To install the gem, execute:
+
+```bash
+gem install elastic-app-search
+```
+
+Or place `gem 'elastic-app-search', '~> 0.7.0'` in your `Gemfile` and run `bundle install`.
+
+## Usage
+
+### Setup: Configuring the client and authentication
+
+Create a new instance of the Elastic App Search Client. This requires your `[HOST_IDENTIFIER]`, which
+identifies the unique hostname of the App Search API that is associated with your App Search account.
+It also requires a valid `[API_KEY]`, which authenticates requests to the API. You can use any key type with the client, however each has a different scope. For more information on keys, check out the [documentation](https://swiftype.com/documentation/app-search/credentials).
+
+You can find your `[API_KEY]` and your `[HOST_IDENTIFIER]` within the [Credentials](https://app.swiftype.com/as/credentials) menu:
+
+```ruby
+require 'elastic/app-search'
+
+client = Elastic::AppSearch::Client.new(:host_identifier => 'host-c5s2mj', :api_key => 'private-mu75psc5egt9ppzuycnc2mc3')
+```
+
+### Using with App Search Managed Deploys
+
+The client can be configured to use a managed deploy by using the
+`api_endpoint` parameter. Since managed deploys do not rely on a `[HOST_IDENTIFIER]`
+, it can be omitted.
+
+```ruby
+require 'elastic/app-search'
+
+client = Elastic::AppSearch::Client.new(:api_key => 'private-mu75psc5egt9ppzuycnc2mc3', :api_endpoint => 'http://localhost:3002/api/as/v1/')
+```
+
+### API Methods
+
+This client is a thin interface to the Elastic App Search Api. Additional details for requests and responses can be
+found in the [documentation](https://swiftype.com/documentation/app-search).
+
+#### Indexing: Creating or Updating a Single Document
+
+```ruby
+engine_name = 'favorite-videos'
+document = {
+  :id => 'INscMGmhmX4',
+  :url => 'https://www.youtube.com/watch?v=INscMGmhmX4',
+  :title => 'The Original Grumpy Cat',
+  :body => 'A wonderful video of a magnificent cat.'
+}
+
+client.index_document(engine_name, document)
+```
+
+#### Indexing: Creating or Replacing Documents
+
+```ruby
+engine_name = 'favorite-videos'
+documents = [
+  {
+    :id => 'INscMGmhmX4',
+    :url => 'https://www.youtube.com/watch?v=INscMGmhmX4',
+    :title => 'The Original Grumpy Cat',
+    :body => 'A wonderful video of a magnificent cat.'
+  },
+  {
+    :id => 'JNDFojsd02',
+    :url => 'https://www.youtube.com/watch?v=dQw4w9WgXcQ',
+    :title => 'Another Grumpy Cat',
+    :body => 'A great video of another cool cat.'
+  }
+]
+
+client.index_documents(engine_name, documents)
+```
+
+#### Indexing: Updating Documents (Partial Updates)
+
+```ruby
+engine_name = 'favorite-videos'
+documents = [
+  {
+    :id => 'INscMGmhmX4',
+    :title => 'Updated title'
+  }
+]
+
+client.update_documents(engine_name, documents)
+```
+
+#### Retrieving Documents
+
+```ruby
+engine_name = 'favorite-videos'
+document_ids = ['INscMGmhmX4', 'JNDFojsd02']
+
+client.get_documents(engine_name, document_ids)
+```
+
+#### Listing Documents
+
+```ruby
+engine_name = 'favorite-videos'
+
+client.list_documents(engine_name)
+```
+
+#### Destroying Documents
+
+```ruby
+engine_name = 'favorite-videos'
+document_ids = ['INscMGmhmX4', 'JNDFojsd02']
+
+client.destroy_documents(engine_name, document_ids)
+```
+
+#### Listing Engines
+
+```ruby
+client.list_engines
+```
+
+#### Retrieving Engines
+
+```ruby
+engine_name = 'favorite-videos'
+
+client.get_engine(engine_name)
+```
+
+#### Creating Engines
+
+```ruby
+engine_name = 'favorite-videos'
+
+client.create_engine(engine_name)
+```
+
+#### Destroying Engines
+
+```ruby
+engine_name = 'favorite-videos'
+
+client.destroy_engine(engine_name)
+```
+
+#### Searching
+
+```ruby
+engine_name = 'favorite-videos'
+query = 'cat'
+search_fields = { :title => {} }
+result_fields = { :title => { :raw => {} } }
+options = { :search_fields => search_fields, :result_fields => result_fields }
+
+client.search(engine_name, query, options)
+```
+
+#### Multi-Search
+
+```ruby
+engine_name = 'favorite-videos'
+
+queries = [{
+  :query => 'cat',
+  :options => { :search_fields => { :title => {} }}
+},{
+  :query => 'dog',
+  :options => { :search_fields => { :body => {} }}
+}]
+
+client.multi_search(engine_name, queries)
+```
+
+#### Query Suggestion
+
+```ruby
+engine_name = 'favorite-videos'
+
+options = {
+  :size => 3,
+  :types => {
+    :documents => {
+      :fields => ['title']
+    }
+  }
+}
+
+client.query_suggestion(engine_name, 'cat', options)
+```
+
+#### Show Search Settings
+
+```ruby
+engine_name = 'favorite-videos'
+
+client.show_settings(engine_name)
+```
+
+#### Update Search Settings
+
+```ruby
+engine_name = 'favorite-videos'
+
+settings = {
+  "search_fields" => {
+    "id" => {
+      "weight" => 1
+    },
+    "url" => {
+      "weight" => 1
+    },
+    "title" => {
+      "weight" => 1
+    },
+    "body" => {
+      "weight" => 1
+    },
+  },
+  "boosts" => {
+    "title" => [
+      {
+        "type" => "value",
+        "factor" => 9.5,
+        "operation" => "multiply",
+        "value" => [
+          "Titanic"
+        ]
+      }
+    ]
+  }
+}
+
+client.update_settings(engine_name, settings)
+```
+
+#### Reset Search Settings
+
+```ruby
+engine_name = 'favorite-videos'
+
+client.reset_settings(engine_name)
+```
+
+## Running Tests
+
+```bash
+export AS_API_KEY="[API_KEY]"
+export AS_HOST_IDENTIFIER="[HOST_IDENTIFIER]"
+bundle exec rspec
+```
+
+You can also run tests against a local environment by passing a `AS_API_ENDPOINT` environment variable
+
+```bash
+export AS_API_KEY="[API_KEY]"
+export AS_API_ENDPOINT="http://[HOST_IDENTIFIER].api.127.0.0.1.ip.es.io:3002/api/as/v1"
+bundle exec rspec
+```
+
+## Debugging API calls
+
+If you need to debug an API call made by the client, there are a few things you could do:
+
+1. Setting `AS_DEBUG` environment variable to `true` would enable HTTP-level debugging and you would
+   see all requests generated by the client on your console.
+
+2. You could use our API logs feature in App Search console to see your requests and responses live.
+
+3. In your debug logs you could find a `X-Request-Id` header value. That could be used when talking
+   to Elastic Customer Support to help us quickly find your API request and help you troubleshoot
+   your issues.
+
+## FAQ 🔮
+
+### Where do I report issues with the client?
+
+If something is not working as expected, please open an [issue](https://github.com/elastic/app-search-ruby/issues/new).
+
+### Where can I learn more about App Search?
+
+Your best bet is to read the [documentation](https://swiftype.com/documentation/app-search).
+
+### Where else can I go to get help?
+
+You can checkout the [Elastic App Search community discuss forums](https://discuss.elastic.co/c/app-search).
+
+## 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/app-search-ruby/issues).
+- Please write simple code and concise documentation, when appropriate.
+
+## License 📗
+
+[Apache 2.0](https://github.com/elastic/app-search-ruby/blob/master/LICENSE.txt) © [Elastic](https://github.com/elastic)
+
+Thank you to all the [contributors](https://github.com/elastic/app-search-ruby/graphs/contributors)!