elastic-site-search 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 783fde51a3b94285bcc1516c0305807d1298ca1430cefc878c9503faeb516b11
+  data.tar.gz: bd640f5a1896286dae00d682143b33d312ded42e88497515af1f969b6d6c806f
+SHA512:
+  metadata.gz: 8488aea312a337ce19a5ec5908da0a1ce6b96a047a435bca29b79ea770495038be508dec2202365cfd1374a6bb536b1a1a2fc413927a66aa7ccfd93e586c2fcc
+  data.tar.gz: d5a5a8094eb77c15f59421b0401e19f259a630c0ee747625a3e7ae49c27b1c1f9340eaa14dd730a405a2ebfe06059c4facd011ecdaf3951a5431927df84e3b82

data/.circleci/config.yml

@@ -0,0 +1,58 @@
+# Ruby CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+      # specify the version you desire here
+      - image: circleci/ruby:2.4.1-node-browsers
+
+      # Specify service dependencies here if necessary
+      # CircleCI maintains a library of pre-built images
+      # documented at https://circleci.com/docs/2.0/circleci-images/
+      # - image: circleci/postgres:9.4
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+            - v1-dependencies-{{ checksum "Gemfile" }}
+            # fallback to using the latest cache if no exact match is found
+            - v1-dependencies-
+
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "Gemfile" }}
+
+      # run tests!
+      - run:
+          name: run tests
+          command: |
+            mkdir /tmp/test-results
+            TEST_FILES="$(circleci tests glob "spec/**/*_spec.rb" | \
+              circleci tests split --split-by=timings)"
+
+            bundle exec rspec \
+              --format progress \
+              --out /tmp/test-results/rspec.xml \
+              --format progress \
+              $TEST_FILES
+
+      # collect reports
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results

data/.gitignore

@@ -0,0 +1,10 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.DS_Store
+.rvmrc
+.ruby-version
+.ruby-gemset
+.yardoc
+doc

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in elastic-site-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 Site Search Ruby client.
+
+Copyright 2012-2019 Elasticsearch B.V.

data/README.md

@@ -0,0 +1,418 @@
+<p align="center"><img src="https://github.com/elastic/site-search-ruby/blob/master/logo-site-search.png?raw=true" alt="Elastic Site Search Logo"></p>
+
+<p align="center"><a href="https://circleci.com/gh/elastic/site-search-ruby"><img src="https://circleci.com/gh/elastic/site-search-ruby.svg?style=svg" alt="CircleCI build"></a></p>
+
+> A first-party Ruby client for the [Elastic Site Search API](https://swiftype.com/documentation/site-search/overview).
+
+## Contents
+
+- [Getting started](#getting-started-)
+- [Usage](#usage)
+- [Migrating from pervious versions](#migrating-from-previous-versions)
+- [Development](#development)
+- [FAQ](#faq-)
+- [Contribute](#contribute-)
+- [License](#license-)
+
+---
+
+## Getting started 🐣
+
+Before beginning with the `elastic-site-search` gem, you should be familiar with the concepts behind the Elastic Site Search API:
+
+1. **Engines**
+2. **DocumentTypes**
+3. **Documents**
+
+An **Engine** is a search engine.
+
+It can contain one or more **DocumentTypes** which are collections of **Documents**.
+
+A **Document** is a collection of fields that can be queried using the Site Search API.
+
+Documents have a special **external_id** field that ties a Document in Site Search to a record in your system. The layout of fields of the Documents belonging to a DocumentType is called a **schema**. Fields may be strings, integers, geographic locations, and so forth.
+
+The Documents in your Engine can be searched two ways: **full-text** (`search`) or **autocomplete** (`suggest`). The difference is that autocomplete queries work on prefixes (for example, "gla" will match "glass"). This is less accurate in general, but is useful for implementing type-ahead search drop downs.
+
+You can think of an Engine as a database, DocumentTypes as tables, and Documents as rows. Using the API, you can search an Engine for all Documents containing a word. You can also search an individual DocumentType, or any subset of DocumentTypes.
+
+The examples in this documentation use the schema defined in the [site-search-api-example](https://github.com/swiftype/swiftype-api-example) project, which is based on YouTube. It has two DocumentTypes, **videos** and **channels**. Using the script found in the site-search-api-example project, you can create your own search engine that matches the examples and try the queries for yourself.
+
+To learn more about the Site Search API, read the [API overview](https://swiftype.com/documentation/site-search/overview) and our [schema design tutorial](https://swiftype.com/documentation/site-search/guides/schema-design).
+
+Depends on Ruby.
+
+To install the gem, execute:
+
+    gem install elastic-site-search
+
+Or place `gem 'elastic-site-search', '~> 2.0.0` in your `Gemfile` and run `bundle install`.
+
+> **Note:** This client has been developed for the [Elastic Site Search](https://www.elastic.co/products/site-search/service) API endpoints only.
+
+## Usage
+
+### Configuration:
+
+Before issuing commands to the API, configure the client with your API key:
+
+    Elastic::SiteSearch.api_key = 'YOUR_API_KEY'
+
+You can find your API key in your [Account Settings](https://app.swiftype.com/settings/account).
+
+### Create a client
+
+    client = Elastic::SiteSearch::Client.new
+
+You can also provide the API key when creating the client instance:
+
+    client = Elastic::SiteSearch::Client.new(:api_key => 'different_api_key')
+
+If the API key is provided as an option to constructor, it will override the globally configured Elastic::SiteSearch API key (if any).
+
+### Specifying an HTTP Proxy
+
+    client = Elastic::SiteSearch::Client.new(:api_key => 'api_key', :proxy => 'http://localhost:8888')
+
+This client will also support configuring a proxy via the environment variable `http_proxy`.
+
+### Full-text search
+
+If you want to search for `cat` on your engine, you can use:
+
+    results = client.search('site-search-api-example', 'cat')
+    results['videos']   # => [{'external_id' => 'QH2-TGUlwu4', 'title' => 'Nyan Cat [original]', ... }, ... ]
+    results['channels'] # => [{'external_id' => 'UC3VHfy8e1jbDnT5TG2pjP1w', 'title' => 'saraj00n', ... }, ... ]
+
+To limit the search to only the `videos` DocumentType:
+
+    results = client.search_document_type('site-search-api-example', 'videos', 'cat')
+    results['videos']   # => [{'external_id' => 'QH2-TGUlwu4', 'title' => 'Nyan Cat [original]', ... }, ... ]
+    results['channels'] # => nil
+
+Both search methods allow you to specify options to filter or sort on fields, boost the weight of certain fields, calculate faceted counts, and so on. For more details on these options, review the [Search Options](https://swiftype.com/documentation/site-search/searching).
+
+Here is an example for showing only videos in the "Pets & Animals" category (which has ID 23):
+
+    results = client.search_document_type('site-search-api-example', 'videos', 'cat', {:filters => {'videos' => {:category_id => '23'}}})
+
+### Autocomplete search
+
+Autocomplete (also known as suggest, prefix, or type-ahead) searches can be used to implement autocompletion. They have the same functionality as full-text searches, but work on prefixes instead of all the text. Because of this, autocomplete queries only search string fields.
+
+You can perform a suggest query across all of your Engine's Documents:
+
+    results = client.suggest("site-search-api-example", "gla")
+    results['videos'] # => [{'external_id' => 'v1uyQZNg2vE', 'title' => 'How It Feels [through Glass]', ...}, ...]
+
+or just for one DocumentType:
+
+    results = client.suggest_document_type("site-search-api-example", "videos", "gla")
+    results['videos'] # => [{'external_id' => 'v1uyQZNg2vE', 'title' => 'How It Feels [through Glass]', ...}, ...]
+
+or add options to have more control over the results:
+
+    results = client.suggest('site-search-api-example', 'glass', {:sort_field => {'videos' => 'view_count'}, :sort_direction => {'videos' => 'desc'}})
+
+### Engines
+
+Retrieve every Engine:
+
+    engines = client.engines
+
+Create a new Engine with the name `site-search-api-example`:
+
+    engine = client.create_engine('site-search-api-example')
+
+Retrieve an Engine by `slug` or `id`:
+
+    engine = client.engine('site-search-api-example')
+    engine = client.engine('5230b9102ed960ba20000021')
+
+Delete an Engine by `slug` or the `id`:
+
+    client.destroy_engine('site-search-api-example')
+
+### Document Types
+
+List all the
+
+Retrieve `DocumentTypes`s of the Engine with the `slug` field `site-search-api-example`:
+
+    document_types = client.document_types('site-search-api-example')
+
+Show the second batch of documents:
+
+    document_types = client.document_types('site-search-api-example', 2)
+
+Create a new DocumentType for an Engine with the name `videos`:
+
+    document_type = client.create_document_type('site-search-api-example', 'videos')
+
+Retrieve an DocumentType by `slug` or `id`:
+
+    document_type = client.document_type('site-search-api-example', 'videos')
+
+Delete a DocumentType using the `slug` or `id` of it:
+
+    client.destroy_document_type('site-search-api-example', 'videos')
+
+### Documents
+
+Retrieve the first page of Documents of Engine `site-search-api-example` and DocumentType `videos`:
+
+    documents = client.documents('site-search-api-example', 'videos')
+
+Retrieve a specific Document using its `id` or `external_id`:
+
+    document = client.document('site-search-api-example', 'videos', 'FHtvDA0W34I')
+
+To create or update. single or multiple documents, we use the method `index_documents`.
+
+Create a new Document with mandatory `external_id` and user-defined fields:
+
+    document = client.index_documents('site-search-api-example', 'videos', {
+        :external_id => 'FHtvDA0W34I',
+        :fields => [
+            {:name => 'title', :value => "Felix Baumgartner's supersonic freefall from 128k' - Mission Highlights", :type => 'string'},
+            {:name => 'url', :value => 'http://www.youtube.com/watch?v=FHtvDA0W34I', :type => 'enum'},
+            {:name => 'chanel_id', :value => 'UCblfuW_4rakIf2h6aqANefA', :type => 'enum'}
+        ]})
+
+Create multiple Documents at once and return status for each Document creation:
+
+    response = client.index_documents('site-search-api-example', 'videos', [{
+        :external_id => 'FHtvDA0W34I',
+        :fields => [
+            {:name => 'title', :value => "Felix Baumgartner's supersonic freefall from 128k' - Mission Highlights", :type => 'string'},
+            {:name => 'url', :value => 'http://www.youtube.com/watch?v=FHtvDA0W34I', :type => 'enum'},
+            {:name => 'chanel_id', :value => 'UCblfuW_4rakIf2h6aqANefA', :type => 'enum'}
+        ]}, {
+        :external_id => 'dMH0bHeiRNg',
+        :fields => [
+            {:name => 'title', :value => 'Evolution of Dance - By Judson Laipply', :type => 'string'},
+            {:name => 'url', :value => 'http://www.youtube.com/watch?v='dMH0bHeiRNg', :type => 'enum'},
+            {:name => 'chanel_id', :value => UC5B9H4l2vtgo7cAoExcFh-w', :type => 'enum'}
+        ]}])
+
+Update fields of an existing Document specified by `id` or `external_id`:
+
+    client.index_documents('site-search-api-example', 'videos', 'FHtvDA0W34I', {:title =>'New Title'})
+
+**NOTE:** A field must already exist on a Document in order to update it.
+
+Update multiple Documents at once:
+
+    response = client.index_documents('site-search-api-example','videos', [
+        {:external_id => 'FHtvDA0W34I', :fields => {:view_count => 32874417}},
+        {:external_id => 'dMH0bHeiRNg', :fields => {:view_count => 98323493}}
+    ])
+
+All methods above will have a return in the following format:
+
+    [
+      {
+        "id": "5473d6142ed96065a9000001",
+        "external_id": "FHtvDA0W34I",
+        "status": "complete",
+        "errors": [],
+        "links": {
+          "receipt": "https://api.swiftype.com/api/v1/document_receipts/5473d6142ed96065a9000001.json",
+          "document": "https://api.swiftype.com/api/v1/engine/xyz/document_type/abc/document/5473d6142ed96065a9000001.json"
+        }
+      },
+      {
+        "id": "5473d6142ed96065a9000002",
+        "external_id": "dMH0bHeiRNg",
+        "status": "complete",
+        "errors": [],
+        "links": {
+          "receipt": "https://api.swiftype.com/api/v1/document_receipts/5473d6142ed96065a9000001.json",
+          "document": "https://api.swiftype.com/api/v1/engine/xyz/document_type/abc/document/5473d6142ed96065a9000002.json"
+        }
+      }
+    ]
+
+**NOTE:** If you'd like to create or update documents asynchronously, simply pass the option `:async => true` as the last argument.
+
+For instance, to Create multiple Documents at once:
+
+    response = client.index_documents('site-search-api-example', 'videos', [{
+        :external_id => 'FHtvDA0W34I',
+        :fields => [
+            {:name => 'title', :value => "Felix Baumgartner's supersonic freefall from 128k' - Mission Highlights", :type => 'string'},
+            {:name => 'url', :value => 'http://www.youtube.com/watch?v=FHtvDA0W34I', :type => 'enum'},
+            {:name => 'chanel_id', :value => 'UCblfuW_4rakIf2h6aqANefA', :type => 'enum'}
+        ]}, {
+        :external_id => 'dMH0bHeiRNg',
+        :fields => [
+            {:name => 'title', :value => 'Evolution of Dance - By Judson Laipply', :type => 'string'},
+            {:name => 'url', :value => 'http://www.youtube.com/watch?v='dMH0bHeiRNg', :type => 'enum'},
+            {:name => 'chanel_id', :value => UC5B9H4l2vtgo7cAoExcFh-w', :type => 'enum'}
+        ]}],
+        :async => true )
+        #=> {
+          "batch_link": "https://api.swiftype.com/api/v1/document_receipts.json?ids=5473d6142ed96065a9000001,5473d6142ed96065a9000002",
+          "document_receipts": [
+            {
+              "id": "5473d6142ed96065a9000001",
+              "external_id": "FHtvDA0W34I",
+              "status": "pending",
+              "errors": [],
+              "links": {
+                "receipt": "https://api.swiftype.com/api/v1/document_receipts/5473d6142ed96065a9000001.json",
+                "document": null
+              }
+            },
+            {
+              "id": "5473d6342ed96065a9000002",
+              "external_id": "dMH0bHeiRNg",
+              "status": "pending",
+              "errors": [],
+              "links": {
+                "receipt": "https://api.swiftype.com/api/v1/document_receipts/5473d6142ed96065a9000002.json",
+                "document": null
+              }
+            }
+          ]
+        }
+
+To check the status of documents with their document_receipt ids:
+
+    response = client.document_receipts(["5473d6142ed96065a9000001", "5473d6342ed96065a9000002"])
+    #=> [
+      {
+        "id": "5473d6142ed96065a9000001",
+        "external_id": "FHtvDA0W34I",
+        "status": "complete",
+        "errors": [],
+        "links": {
+          "receipt": "https://api.swiftype.com/api/v1/document_receipts/5473d6142ed96065a9000001.json",
+          "document": "https://api.swiftype.com/api/v1/engine/xyz/document_type/abc/document/5473d6142ed96065a9000001.json"
+        }
+      },
+      {
+        "id": "5473d6142ed96065a9000002",
+        "external_id": "dMH0bHeiRNg",
+        "status": "complete",
+        "errors": [],
+        "links": {
+          "receipt": "https://api.swiftype.com/api/v1/document_receipts/5473d6142ed96065a9000001.json",
+          "document": "https://api.swiftype.com/api/v1/engine/xyz/document_type/abc/document/5473d6142ed96065a9000002.json"
+        }
+      }
+    ]
+
+Destroy a Document by external_id:
+
+    client.destroy_document('site-search-api-example','videos','dFs9WO2B8uI')
+
+Destroy multiple Documents at once:
+
+    response = client.destroy_documents('site-search-api-example', 'videos', ['QH2-TGUlwu4, 'v1uyQZNg2vE', 'ik5sdwYZ01Q'])
+    #=> [true, true, true]
+
+### Domains
+
+**Domains** are a feature of crawler-based engines that represent a web site to index with the Swiftype web crawler.
+
+Retrieve all Domains of Engine `websites`:
+
+    domains = client.domains('websites')
+    #=> [{"id"=>"513fcc042ed960c186000001", "engine_id"=>"513fcc042ed960114400000d", "submitted_url"=>"http://example.com/", "start_crawl_url"=>"http://www.example.com/", "crawling"=>false, "document_count"=>337, "updated_at"=>"2013-03-13T00:48:32Z"}, ...]
+
+Retrieve a specific Domain by `id`:
+
+    domain = client.domain('websites', '513fcc042ed960c186000001'')
+    #=> {"id"=>"513fcc042ed960c186000001", "engine_id"=>"513fcc042ed960114400000d", "submitted_url"=>"http://example.com/", "start_crawl_url"=>"http://www.example.com/", "crawling"=>false, "document_count"=>337, "updated_at"=>"2013-03-13T00:48:32Z"}
+
+Create a new Domain with the URL `https://swiftype.com` and start crawling:
+
+    domain = client.create_domain('websites', 'https://swiftype.com')
+
+Delete a Domain using its `id`:
+
+    client.destroy_domain('websites', '513fcc042ed960c186000001')
+
+Initiate a recrawl of a specific Domain using its `id`:
+
+    client.recrawl_domain('websites', '513fcc042ed960c186000001')
+
+Add or update a URL for a Domain:
+
+    client.crawl_url('websites', '513fcc042ed960c186000001', 'https://swiftype.com/new/path.html')
+
+### Analytics
+
+Site Search records the number of searches, autoselects (when a user clicks a link from a suggest result), and clickthroughs (when a user clicks through to an item from a search result list. You can view this information in your Site Search Dashboard, but you can also export it using the API.
+
+To get the number of searches per day from an Engine in the last 14 days:
+
+    searches = client.analytics_searches('site-search-api-example')
+    #=> [['2013-09-13', '123'], [2013-09-12', '94'], ... ]
+
+You can also use a specific start and/or end date:
+
+    searches = client.analytics_searches('site-search-api-example', {:start_date => '2013-01-01', :end_date => '2013-01-07'})
+
+To get the number of autoselects in the past 14 days:
+
+    autoselects = client.analytics_autoselects('site-search-api-example')
+
+As with searches you can also limit by start and/or end date:
+
+    autoselects = client.analytics_autoselects('site-search-api-example', {:start_date => '2013-01-01', :end_date => '2013-01-07'})
+
+If you are interested in the top queries for your Engine you can use:
+
+    top_queries = client.analytics_top_queries('site-search-api-example')
+    # => [['query term', 123], ['another query', 121], ['yet another query', 92], ...]
+
+To see more top queries you can paginate through them using:
+
+    top_queries = client.analytics_top_queries('site-search-api-example', {:page => 2})
+
+Or you can get the top queries in a specific date range:
+
+    top_queries = client.analytics_top_queries('site-search-api-example', {:start_date => '2013-01-01', :end_date => '2013-01-07'})
+
+If you want to improve you search results, you should always have a look at search queries, that return no results and perhaps add some Documents that match for this query or use our pining feature to add Documents for this query:
+
+    top_no_result_queries = client.analytics_top_no_result_queries('site-search-api-example')
+
+You can also specifiy a date range for queries without results:
+
+    top_no_result_queries = client.analytics_top_no_result_queries('site-search-api-example', {:start_date => '2013-01-01', :end_date => '2013-01-07'})
+
+## Development
+
+You can run tests with `rspec`.
+
+All HTTP interactions are stubbed out using VCR.
+
+## FAQ 🔮
+
+### Where do I report issues with the client?
+
+If something is not working as expected, please open an [issue](https://github.com/elastic/site-search-ruby/issues/new).
+
+### Where can I learn more about Site Search?
+
+Your best bet is to read the [documentation](https://swiftype.com/documentation/site-search).
+
+### Where else can I go to get help?
+
+You can checkout the [Elastic Site Search community discuss forums](https://discuss.elastic.co/c/site-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/site-search-ruby/issues).
+- Please write simple code and concise documentation, when appropriate.
+
+## License 📗
+
+[Apache 2.0](https://github.com/elastic/site-search-ruby/blob/master/LICENSE.txt) © [Elastic](https://github.com/elastic)
+
+Thank you to all the [contributors](https://github.com/elastic/site-search-ruby/graphs/contributors)!