swiftype 1.3.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 609560031bf1a36701d32f22fbc01c0ed04db4df4543f500bc792d25a2d07f42
-  data.tar.gz: 84faa09349226885040f1dada03ae7d9908e1ff7e116dff07d7a7db9dc1975f1
+  metadata.gz: f63edc94df155455010fd47771121ec305c74be186603f962e59757d55cde739
+  data.tar.gz: 4e2a84363c431549d456c61ab289a6f6432b802a29e28776a22da65836c2021b
 SHA512:
-  metadata.gz: 0d1ae4174700c37367c252bcbbadc19e145c5b93490a21f43af8cb1c44be2f93709c034e8ca84ace786155c202809e5d1ed1e84352e1a8f9f282306f9c2c5cbc
-  data.tar.gz: 77f6252035f93a12806153bc17ace03f5fad21a048e67c9e84cce760b8126d075c5ac99004b1f594f4cafa70a2035a6e5a6b0f2d612ddf5aa4a5f92005a68e0f
+  metadata.gz: 87b788844121f6292ed1a30a0a3c0daef5bf557412f63d7be20d99ad89c7296e9e6c85c7aeb6a38661e9160aa3e6618fd76872df906e7a6a551a26b5a6a0317e
+  data.tar.gz: da6a6ac73e6539c5453121157b31f8767bb57a3a10a02c0c37f0e657662b4b0cd5f4ffa8f861ebf553c69d7434caa073aea200af96be0406fc99359941716526

data/.travis.yml

@@ -1,7 +1,6 @@
 language: ruby
 script: rspec
 rvm:
-  - 1.9
   - 2.0
   - 2.1
   - 2.2
@@ -10,6 +9,5 @@ jdk:
   - oraclejdk8
 
 before_install:
-  - gem update --system
   - gem --version
   - gem update bundler

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Elastic Inc
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -1,32 +1,56 @@
-# Ruby Client for Swiftype Site Search API
 
-[![Build Status](https://travis-ci.org/swiftype/swiftype-rb.png)](https://travis-ci.org/swiftype/swiftype-rb)
+<p align="center"><img src="https://github.com/swiftype/swiftype-rb/blob/master/logo-site-search.png?raw=true" alt="Elastic Site Search Logo"></p>
 
-This is a simple client for the [Swiftype Site Search API](https://swiftype.com/documentation/site-search/overview) with no dependencies outside core Ruby (for 1.9 and 2.0; Ruby 1.8 requires the JSON gem).
+<p align="center"><a href="https://travis-ci.org/swiftype/swiftype-rb"><img src="https://travis-ci.org/swiftype/swiftype-rb.png" alt="Travis build"></a>
+<a href="https://github.com/swiftype/swiftype-rb/releases"><img src="https://img.shields.io/github/release/swiftype/swiftype-rb/all.svg?style=flat-square" alt="GitHub release" /></a></p>
 
-> **Note:** This client has been developed for the [Swiftype Site Search](https://www.swiftype.com/site-search) API endpoints only.
+> 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 Swiftype gem, you should be familar with the concepts behind the Swiftype API:
 
-## Getting Started
+1. **Engines**
+2. **DocumentTypes**
+3. **Documents**
 
-Before beginning with the Swiftype gem, you should be familar with the concepts behind the Swiftype API: **Engines**, **DocumentTypes**, and **Documents**.
+An **Engine** is a search engine.
 
-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 Swiftype API. Documents have a special **external_id** field that ties a Document in Swiftype 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.
+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 Swiftype API.
+
+Documents have a special **external_id** field that ties a Document in Swiftype 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.
+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 [swiftype-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 swiftype-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 Swiftype API, read the [API overview](https://swiftype.com/documentation/overview) and our [schema design tutorial](https://swiftype.com/documentation/tutorials/schema_design).
 
-## Installation
+Depends on Ruby.
 
 To install the gem, execute:
 
     gem install swiftype
 
-Or place `gem 'swiftype', '~> 1.3.1` in your `Gemfile` and run `bundle install`.
+Or place `gem 'swiftype', '~> 1.4.0` in your `Gemfile` and run `bundle install`.
+
+> **Note:** This client has been developed for the [Swiftype Site Search](https://www.swiftype.com/site-search) API endpoints only.
 
 ## Usage
 
@@ -413,6 +437,33 @@ or simply `Swiftype.api_key = 'your_api_key'`.
 
 ## Development
 
-You can run tests with `rspec`. All HTTP interactions are stubbed out using VCR.
+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/swiftype/swiftype-rb/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/swiftype/swiftype-rb/issues).
++ Please write simple code and concise documentation, when appropriate.
+
+## License 📗
+
+[MIT](https://github.com/swiftype/swiftype-rb/blob/master/LICENSE) © [Elastic](https://github.com/elastic)
 
-To contribute code to this gem, please fork the repository and submit a pull request.
+Thank you to all the [contributors](https://github.com/swiftype/swiftype-rb/graphs/contributors)!

data/lib/swiftype/request.rb

@@ -90,20 +90,29 @@ module Swiftype
       when Net::HTTPSuccess
         response
       when Net::HTTPUnauthorized
-        raise Swiftype::InvalidCredentials
+        raise Swiftype::InvalidCredentials, error_message_from_response(response)
       when Net::HTTPNotFound
-        raise Swiftype::NonExistentRecord
+        raise Swiftype::NonExistentRecord, error_message_from_response(response)
       when Net::HTTPConflict
-        raise Swiftype::RecordAlreadyExists
+        raise Swiftype::RecordAlreadyExists, error_message_from_response(response)
       when Net::HTTPBadRequest
-        raise Swiftype::BadRequest
+        raise Swiftype::BadRequest, error_message_from_response(response)
       when Net::HTTPForbidden
-        raise Swiftype::Forbidden
+        raise Swiftype::Forbidden, error_message_from_response(response)
       else
         raise Swiftype::UnexpectedHTTPException, "#{response.code} #{response.body}"
       end
     end
 
+    def error_message_from_response(response)
+      body = response.body
+      json = JSON.parse(body) if body && body.strip != ''
+      return json['error'] if json && json.key?('error')
+      body
+    rescue JSON::ParserError
+      body
+    end
+
     def build_request(method, uri, params)
       klass = case method
               when :get

data/lib/swiftype/version.rb

@@ -1,3 +1,3 @@
 module Swiftype
-  VERSION = "1.3.1"
+  VERSION = "1.4.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: swiftype
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.0
 platform: ruby
 authors:
 - Quin Hoxie
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-18 00:00:00.000000000 Z
+date: 2019-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -78,7 +78,7 @@ files:
 - ".gitignore"
 - ".travis.yml"
 - Gemfile
-- LICENSE.txt
+- LICENSE
 - README.md
 - Rakefile
 - lib/data/ca-bundle.crt
@@ -91,6 +91,7 @@ files:
 - lib/swiftype/result_set.rb
 - lib/swiftype/sso.rb
 - lib/swiftype/version.rb
+- logo-site-search.png
 - spec/client_spec.rb
 - spec/configuration_spec.rb
 - spec/deprecated_spec.rb

data/LICENSE.txt

@@ -1,21 +0,0 @@
-Copyright 2012  Swiftype, Inc.
-http://swiftype.com/
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.