elastic-site-search 2.0.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 783fde51a3b94285bcc1516c0305807d1298ca1430cefc878c9503faeb516b11
-  data.tar.gz: bd640f5a1896286dae00d682143b33d312ded42e88497515af1f969b6d6c806f
+  metadata.gz: 5981e7c63cf7474d20008bbf06886e770e155428379de2a873499b8e5bda4e26
+  data.tar.gz: 4ab08fab6691807b3a6d2e25798ddece63c6635e091bd659b77d38a0522ab916
 SHA512:
-  metadata.gz: 8488aea312a337ce19a5ec5908da0a1ce6b96a047a435bca29b79ea770495038be508dec2202365cfd1374a6bb536b1a1a2fc413927a66aa7ccfd93e586c2fcc
-  data.tar.gz: d5a5a8094eb77c15f59421b0401e19f259a630c0ee747625a3e7ae49c27b1c1f9340eaa14dd730a405a2ebfe06059c4facd011ecdaf3951a5431927df84e3b82
+  metadata.gz: 79a6075cd55f86e9dccaeaa31d306a9c1ea4b0b90708239cd6439b3515b1d42a7d74c7acbf30a52a89faae3dfed03dd645afa17ac540c5c6137c717ab0ad2dc3
+  data.tar.gz: ae1d85615cfe15a7f4c70866faf0650226aefb6101e86754d8ece73e710f74cd33532f21545e5a43572d4bef771d18751d590e7f6b09c338426ac115562e014d

data/.circleci/config.yml

@@ -2,17 +2,20 @@
 #
 # Check https://circleci.com/docs/2.0/language-ruby/ for more details
 #
-version: 2
+version: 2.1
+
+executors:
+  ruby-24: { docker: [{ image: "ruby:2.4" }] }
+  ruby-25: { docker: [{ image: "ruby:2.5" }] }
+  ruby-26: { docker: [{ image: "ruby:2.6" }] }
+  jruby-92: { docker: [{ image: "jruby:9.2.7-jdk" }] }
+
 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
+    parameters:
+      executor:
+        type: executor
+    executor: << parameters.executor >>
 
     working_directory: ~/repo
 
@@ -56,3 +59,11 @@ jobs:
       - store_artifacts:
           path: /tmp/test-results
           destination: test-results
+
+workflows:
+  run-tests:
+    jobs:
+      - build: { name: run-tests-ruby-2.4, executor: ruby-24 }
+      - build: { name: run-tests-ruby-2.5, executor: ruby-25 }
+      - build: { name: run-tests-ruby-2.6, executor: ruby-26 }
+      - build: { name: run-tests-jruby-92, executor: jruby-92 }

data/README.md

@@ -44,9 +44,11 @@ Depends on Ruby.
 
 To install the gem, execute:
 
-    gem install elastic-site-search
+```shell
+gem install elastic-site-search
+```
 
-Or place `gem 'elastic-site-search', '~> 2.0.0` in your `Gemfile` and run `bundle install`.
+Or place `gem 'elastic-site-search', '~> 2.2.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.
 
@@ -56,23 +58,31 @@ Or place `gem 'elastic-site-search', '~> 2.0.0` in your `Gemfile` and run `bundl
 
 Before issuing commands to the API, configure the client with your API key:
 
-    Elastic::SiteSearch.api_key = 'YOUR_API_KEY'
+```ruby
+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
+```ruby
+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')
+```ruby
+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')
+```ruby
+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`.
 
@@ -80,21 +90,27 @@ This client will also support configuring a proxy via the environment variable `
 
 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', ... }, ... ]
+```ruby
+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
+```ruby
+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'}}})
+```ruby
+results = client.search_document_type('site-search-api-example', 'videos', 'cat', {:filters => {'videos' => {:category_id => '23'}}})
+```
 
 ### Autocomplete search
 
@@ -102,36 +118,50 @@ Autocomplete (also known as suggest, prefix, or type-ahead) searches can be used
 
 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]', ...}, ...]
+```ruby
+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]', ...}, ...]
+```ruby
+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'}})
+```ruby
+results = client.suggest('site-search-api-example', 'glass', {:sort_field => {'videos' => 'view_count'}, :sort_direction => {'videos' => 'desc'}})
+```
 
 ### Engines
 
 Retrieve every Engine:
 
-    engines = client.engines
+```ruby
+engines = client.engines
+```
 
 Create a new Engine with the name `site-search-api-example`:
 
-    engine = client.create_engine('site-search-api-example')
+```ruby
+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')
+```ruby
+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')
+```ruby
+client.destroy_engine('site-search-api-example')
+```
 
 ### Document Types
 
@@ -139,77 +169,100 @@ 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')
+```ruby
+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)
+```ruby
+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')
+```ruby
+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')
+```ruby
+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')
+```ruby
+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')
+```ruby
+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')
+```ruby
+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'}
-        ]})
+```ruby
+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'}
-        ]}])
+```ruby
+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'})
+```ruby
+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}}
-    ])
+```ruby
+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:
 
+```ruby
     [
       {
         "id": "5473d6142ed96065a9000001",
@@ -232,85 +285,96 @@ All methods above will have a return in the following format:
         }
       }
     ]
+```
 
 **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
-              }
-            }
-          ]
-        }
+```ruby
+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:
 
+```ruby
     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"
-        }
-      }
-    ]
+    #=>
+    # [
+    #   {
+    #     "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')
+```ruby
+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]
+```ruby
+response = client.destroy_documents('site-search-api-example', 'videos', ['QH2-TGUlwu4, 'v1uyQZNg2vE', 'ik5sdwYZ01Q'])
+#=> [true, true, true]
+```
 
 ### Domains
 
@@ -318,29 +382,41 @@ Destroy multiple Documents at once:
 
 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"}, ...]
+```ruby
+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"}
+```ruby
+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')
+```ruby
+domain = client.create_domain('websites', 'https://swiftype.com')
+```
 
 Delete a Domain using its `id`:
 
-    client.destroy_domain('websites', '513fcc042ed960c186000001')
+```ruby
+client.destroy_domain('websites', '513fcc042ed960c186000001')
+```
 
 Initiate a recrawl of a specific Domain using its `id`:
 
-    client.recrawl_domain('websites', '513fcc042ed960c186000001')
+```ruby
+client.recrawl_domain('websites', '513fcc042ed960c186000001')
+```
 
 Add or update a URL for a Domain:
 
-    client.crawl_url('websites', '513fcc042ed960c186000001', 'https://swiftype.com/new/path.html')
+```ruby
+client.crawl_url('websites', '513fcc042ed960c186000001', 'https://swiftype.com/new/path.html')
+```
 
 ### Analytics
 
@@ -348,41 +424,59 @@ Site Search records the number of searches, autoselects (when a user clicks a li
 
 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'], ... ]
+```ruby
+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'})
+```ruby
+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')
+```ruby
+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'})
+```ruby
+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], ...]
+```ruby
+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})
+```ruby
+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'})
+```ruby
+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')
+```ruby
+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'})
+```ruby
+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
 

data/lib/elastic/site-search/exceptions.rb

@@ -7,5 +7,11 @@ module Elastic
     class BadRequest < ClientException; end
     class Forbidden < ClientException; end
     class UnexpectedHTTPException < ClientException; end
+
+    class ServerException < StandardError; end
+    class InternalServerError < ServerException; end
+    class BadGateway < ServerException; end
+    class ServiceUnavailable < ServerException; end
+    class GatewayTimeout < ServerException; end
   end
 end

data/lib/elastic/site-search/request.rb

@@ -93,21 +93,29 @@ module Elastic
         case response
         when Net::HTTPSuccess
           response
-        when Net::HTTPUnauthorized
-          raise Elastic::SiteSearch::InvalidCredentials, error_message_from_response(response)
-        when Net::HTTPNotFound
-          raise Elastic::SiteSearch::NonExistentRecord, error_message_from_response(response)
-        when Net::HTTPConflict
-          raise Elastic::SiteSearch::RecordAlreadyExists, error_message_from_response(response)
-        when Net::HTTPBadRequest
-          raise Elastic::SiteSearch::BadRequest, error_message_from_response(response)
-        when Net::HTTPForbidden
-          raise Elastic::SiteSearch::Forbidden, error_message_from_response(response)
         else
+          EXCEPTION_MAP.each do |response_class, exception_class|
+            if response.is_a?(response_class)
+              raise exception_class, error_message_from_response(response)
+            end
+          end
+
           raise Elastic::SiteSearch::UnexpectedHTTPException, "#{response.code} #{response.body}"
         end
       end
 
+      EXCEPTION_MAP = {
+        Net::HTTPUnauthorized => Elastic::SiteSearch::InvalidCredentials,
+        Net::HTTPNotFound => Elastic::SiteSearch::NonExistentRecord,
+        Net::HTTPConflict => Elastic::SiteSearch::RecordAlreadyExists,
+        Net::HTTPBadRequest => Elastic::SiteSearch::BadRequest,
+        Net::HTTPForbidden => Elastic::SiteSearch::Forbidden,
+        Net::HTTPInternalServerError => Elastic::SiteSearch::InternalServerError,
+        Net::HTTPBadGateway => Elastic::SiteSearch::BadGateway,
+        Net::HTTPServiceUnavailable => Elastic::SiteSearch::ServiceUnavailable,
+        Net::HTTPGatewayTimeOut => Elastic::SiteSearch::GatewayTimeout
+      }.freeze
+
       def error_message_from_response(response)
         body = response.body
         json = JSON.parse(body) if body && body.strip != ''

data/lib/elastic/site-search/sso.rb

@@ -1,4 +1,4 @@
-require 'digest/sha1'
+require 'digest/sha2'
 
 module Elastic
   module SiteSearch
@@ -15,7 +15,7 @@ module Elastic
       end
 
       def self.token(user_id, timestamp)
-        Digest::SHA1.hexdigest("#{user_id}:#{Elastic::SiteSearch.platform_client_secret}:#{timestamp}")
+        Digest::SHA256.hexdigest("#{user_id}:#{Elastic::SiteSearch.platform_client_secret}:#{timestamp}")
       end
     end
   end

data/lib/elastic/site-search/version.rb

@@ -1,5 +1,5 @@
 module Elastic
   module SiteSearch
-    VERSION = "2.0.0"
+    VERSION = "2.2.0"
   end
 end

data/lib/elastic-site-search.rb

@@ -0,0 +1 @@
+require 'elastic/site-search'

data/spec/sso_spec.rb

@@ -11,14 +11,14 @@ describe Elastic::SiteSearch::SSO do
   end
 
   context '.token' do
-    it 'generates an SSO token' do
-      expect(Elastic::SiteSearch::SSO.token(user_id, timestamp)).to eq('81033d182ad51f231cc9cda9fb24f2298a411437')
+    it 'generates a proper SHA256 SSO token' do
+      expect(Elastic::SiteSearch::SSO.token(user_id, timestamp)).to eq('3da93f6d82efc8530614966ab847fd6d0b6d158ef02e4e65a8f731e299c28d86')
     end
   end
 
   context '.url' do
     it 'generates an SSO URL' do
-      expect(Elastic::SiteSearch::SSO.url(user_id)).to eq('https://swiftype.com/sso?user_id=5064a7de2ed960e715000276&client_id=3e4fd842fc99aecb4dc50e5b88a186c1e206ddd516cdd336da3622c4afd7e2e9&timestamp=1379382520&token=81033d182ad51f231cc9cda9fb24f2298a411437')
+      expect(Elastic::SiteSearch::SSO.url(user_id)).to eq('https://swiftype.com/sso?user_id=5064a7de2ed960e715000276&client_id=3e4fd842fc99aecb4dc50e5b88a186c1e206ddd516cdd336da3622c4afd7e2e9&timestamp=1379382520&token=3da93f6d82efc8530614966ab847fd6d0b6d158ef02e4e65a8f731e299c28d86')
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: elastic-site-search
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Quin Hoxie
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-08 00:00:00.000000000 Z
+date: 2023-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -77,7 +77,6 @@ extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
 - ".gitignore"
-- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - NOTICE.txt
@@ -85,6 +84,7 @@ files:
 - Rakefile
 - elastic-site-search.gemspec
 - lib/data/ca-bundle.crt
+- lib/elastic-site-search.rb
 - lib/elastic/site-search.rb
 - lib/elastic/site-search/client.rb
 - lib/elastic/site-search/configuration.rb
@@ -193,7 +193,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Official gem for accessing the Elastic Site Search API

data/.travis.yml

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