swiftype 1.2.2 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 13981a414b87f3820b0561ce55e22014311c1766
-  data.tar.gz: 1f68d66bba5aea0b1d5beeed4a253deabd942502
+SHA256:
+  metadata.gz: add2978c79c2494fc993252665bc65af92383ad5a00dc8e86eaae70114059aac
+  data.tar.gz: 5b03ebc6b72eca5793c0264c03db5b18150cc6de88daeabebb6d95fbc352c463
 SHA512:
-  metadata.gz: ec53f7d6df041432268ca9061bb3a49aab3a170a23b43f2d9c4bd0b2e1ea75cf1eac8b13e6d7ecc8de8195a7c4fd3860e206c2c7a28f9766f152ebb0c571fb04
-  data.tar.gz: 1ca58366f50297910aeb7f3086f31c4c561db38ec4c820dd30abcad36eb98e4c8260d16ccd785880c9f4d5a3b46e6f67844e62b2c975938110bdbcea91eb441f
+  metadata.gz: 4b5db4bfafb4975ed03ae34ebcdd86ce13aa8e5ccad65260608626dab59e4a61de4a56fda4731472289a758e0cf2d0a286f496ab90baa4a2841a9e1e9b04634f
+  data.tar.gz: b6d111e80d985366e60ed382d37183bd1fa72dd5fed5e8661f04ef4ef6d9f255cc6ebe121f2e1a96c10fa2532e27126effc4f5969579d841f0fe2e90ef507867

data/README.md

@@ -1,8 +1,10 @@
-# Swiftype Ruby API Client
+# Ruby Client for Swiftype Site Search API
 
 [![Build Status](https://travis-ci.org/swiftype/swiftype-rb.png)](https://travis-ci.org/swiftype/swiftype-rb)
 
-This is a simple client for the [Swiftype API](https://swiftype.com/documentation/overview) with no dependencies outside core Ruby (for 1.9 and 2.0; Ruby 1.8 requires the JSON gem).
+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).
+
+> **Note:** This client has been developed for the [Swiftype Site Search](https://www.swiftype.com/site-search) API endpoints only.
 
 ## Getting Started
 
@@ -10,7 +12,7 @@ Before beginning with the Swiftype gem, you should be familar with the concepts
 
 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.
 
-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 accurage in general, but is useful for implementing type-ahead search drop downs.
+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.
 
@@ -327,7 +329,7 @@ To get the number of searches per day from an Engine in the last 14 days:
 
 You can also use a specific start and/or end date:
 
-    searches = client.analytics_searches('swiftype-api-example', '2013-01-01', '2013-01-07')
+    searches = client.analytics_searches('swiftype-api-example', {:start_date => '2013-01-01', :end_date => '2013-01-07'})
 
 To get the number of autoselects in the past 14 days:
 
@@ -335,7 +337,7 @@ To get the number of autoselects in the past 14 days:
 
 As with searches you can also limit by start and/or end date:
 
-    autoselects = client.analytics_autoselects('swiftype-api-example', '2013-01-01', '2013-01-07')
+    autoselects = client.analytics_autoselects('swiftype-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:
 

data/lib/swiftype/client.rb

@@ -43,6 +43,9 @@ module Swiftype
       (@options[:overall_timeout] || DEFAULT_TIMEOUT).to_f
     end
 
+    def wrap(element)
+      [element].flatten(1)
+    end
 
     # Methods wrapping the Swiftype private search and API endpoints. Using these methods, you can perform full-text
     # and prefix searches over the Documents in your Engine, in a specific DocumentType, or any subset of DocumentTypes.
@@ -356,7 +359,7 @@ module Swiftype
       #
       # @raise [Timeout::Error] when used in :async => false mode and the timeout expires
       def index_documents(engine_id, document_type_id, documents = [], options = {})
-        documents = Array(documents)
+        documents = wrap(documents)
 
         res = async_create_or_update_documents(engine_id, document_type_id, documents)
 

data/lib/swiftype/request.rb

@@ -63,7 +63,10 @@ module Swiftype
 
         if uri.scheme == 'https'
           http.use_ssl = true
-          http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+          # st_ssl_verify_none provides a means to disable SSL verification for debugging purposes. An example
+          # is Charles, which uses a self-signed certificate in order to inspect https traffic. This will
+          # not be part of this client's public API, this is more of a development enablement option
+          http.verify_mode = ENV['st_ssl_verify_none'] == 'true' ? OpenSSL::SSL::VERIFY_NONE : OpenSSL::SSL::VERIFY_PEER
           http.ca_file = File.join(File.dirname(__FILE__), '..', 'data', 'ca-bundle.crt')
           http.ssl_timeout = open_timeout
         end

data/lib/swiftype/version.rb

@@ -1,3 +1,3 @@
 module Swiftype
-  VERSION = "1.2.2"
+  VERSION = "1.2.3"
 end

data/spec/spec_helper.rb

@@ -12,12 +12,13 @@ RSpec.configure do |config|
   config.order = "random"
 
   VCR.configure do |c|
+    c.default_cassette_options = { :record => :once, :match_requests_on => [:host, :path, :method] }
     c.cassette_library_dir = 'spec/fixtures/vcr'
     c.hook_into :webmock
   end
 
   config.before :each do
-    Swiftype.endpoint = "http://localhost:3000/api/v1/"
+    Swiftype.endpoint = "http://hello:@localhost:3000/api/v1/"
   end
 
   config.after :each do

data/swiftype.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency 'rspec', '~> 3.0.0'
   s.add_development_dependency 'awesome_print'
-  s.add_development_dependency 'vcr', '~> 2.9.0'
+  s.add_development_dependency 'vcr', '~> 4.0.0'
   s.add_development_dependency 'webmock'
   if RUBY_VERSION < '1.9'
     s.add_runtime_dependency 'json'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: swiftype
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.2.3
 platform: ruby
 authors:
 - Quin Hoxie
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-20 00:00:00.000000000 Z
+date: 2018-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -45,14 +45,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.9.0
+        version: 4.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.9.0
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -191,7 +191,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Official gem for accessing the Swiftype Search API