swiftype-app-search 0.4.0 → 0.4.1

data/README.md

@@ -10,7 +10,7 @@ To install the gem, execute:
 gem install swiftype-app-search
 ```
 
-Or place `gem 'swiftype-app-search', '~> 0.4.0` in your `Gemfile` and run `bundle install`.
+Or place `gem 'swiftype-app-search', '~> 0.4.1` in your `Gemfile` and run `bundle install`.
 
 ## Usage
 

data/lib/swiftype-app-search/exceptions.rb

@@ -3,7 +3,11 @@ module SwiftypeAppSearch
     attr_reader :errors
 
     def initialize(response)
-      @errors = response['errors'] || [ response ]
+      @errors = if response.is_a?(Array)
+        response.flat_map { |r| r['errors'] }
+      else
+        response['errors'] || [response]
+      end
       message = (errors.count == 1) ? "Error: #{errors.first}" : "Errors: #{errors.inspect}"
       super(message)
     end

data/lib/swiftype-app-search/version.rb

@@ -1,3 +1,3 @@
 module SwiftypeAppSearch
-  VERSION = '0.4.0'
+  VERSION = '0.4.1'
 end

data/spec/client_spec.rb

@@ -1,17 +1,49 @@
+require 'config_helper'
 
 describe SwiftypeAppSearch::Client do
   let(:engine_name) { "ruby-client-test-#{Time.now.to_i}" }
 
-  include_context "App Search Credentials"
+  include_context 'App Search Credentials'
   let(:client) { SwiftypeAppSearch::Client.new(client_options) }
 
+  before(:all) do
+    # Bootstraps a static engine for 'read-only' options that require indexing
+    # across the test suite
+    @static_engine_name = "ruby-client-test-static-#{Time.now.to_i}"
+    as_api_key = ConfigHelper.get_as_api_key
+    as_host_identifier = ConfigHelper.get_as_host_identifier
+    as_api_endpoint = ConfigHelper.get_as_api_endpoint
+    client_options = ConfigHelper.get_client_options(as_api_key, as_host_identifier, as_api_endpoint)
+    @static_client = SwiftypeAppSearch::Client.new(client_options)
+    @static_client.create_engine(@static_engine_name)
+
+    @document1 = { 'id' => '1', 'title' => 'The Great Gatsby' }
+    @document2 = { 'id' => '2', 'title' => 'Catcher in the Rye' }
+    @documents = [@document1, @document2]
+    @static_client.index_documents(@static_engine_name, @documents)
+
+    # Wait until documents are indexed
+    start = Time.now
+    ready = false
+    until (ready)
+      sleep(3)
+      results = @static_client.search(@static_engine_name, '')
+      ready = true if results['results'].length == 2
+      ready = true if (Time.now - start).to_i >= 120 # Time out after 2 minutes
+    end
+  end
+
+  after(:all) do
+    @static_client.destroy_engine(@static_engine_name)
+  end
+
   describe 'Requests' do
     it 'should include client name and version in headers' do
       stub_request(:any, "#{client_options[:host_identifier]}.api.swiftype.com/api/as/v1/engines")
       client.list_engines
-      expect(WebMock).to have_requested(:get, "https://#{client_options[:host_identifier]}.api.swiftype.com/api/as/v1/engines").
-        with(
-          headers: {
+      expect(WebMock).to have_requested(:get, "https://#{client_options[:host_identifier]}.api.swiftype.com/api/as/v1/engines")
+        .with(
+          :headers => {
             'X-Swiftype-Client' => 'swiftype-app-search-ruby',
             'X-Swiftype-Client-Version' => SwiftypeAppSearch::VERSION
           }
@@ -81,20 +113,24 @@ describe SwiftypeAppSearch::Client do
       subject { client.index_documents(engine_name, documents) }
 
       it 'should return an array of document status hashes' do
-        expect(subject).to match([
-          { 'id' => anything, 'errors' => [] },
-          { 'id' => second_document_id, 'errors' => [] }
-        ])
+        expect(subject).to match(
+          [
+            { 'id' => anything, 'errors' => [] },
+            { 'id' => second_document_id, 'errors' => [] }
+          ]
+        )
       end
 
       context 'when one of the documents has processing errors' do
         let(:second_document) { { 'id' => 'too long' * 100 } }
 
         it 'should return respective errors in an array of document processing hashes' do
-          expect(subject).to match([
-            { 'id' => anything, 'errors' => [] },
-            { 'id' => anything, 'errors' => ['Invalid field type: id must be less than 800 characters'] },
-          ])
+          expect(subject).to match(
+            [
+              { 'id' => anything, 'errors' => [] },
+              { 'id' => anything, 'errors' => ['Invalid field type: id must be less than 800 characters'] },
+            ]
+          )
         end
       end
     end
@@ -103,10 +139,14 @@ describe SwiftypeAppSearch::Client do
       let(:documents) { [document, second_document] }
       let(:second_document_id) { 'another_id' }
       let(:second_document) { { 'id' => second_document_id, 'url' => 'https://www.youtube.com/watch?v=9T1vfsHYiKY' } }
-      let(:updates) { [ {
-        'id' => second_document_id,
-        'url' => 'https://www.example.com'
-      } ] }
+      let(:updates) do
+        [
+          {
+            'id' => second_document_id,
+            'url' => 'https://www.example.com'
+          }
+        ]
+      end
 
       subject { client.update_documents(engine_name, updates) }
 
@@ -119,7 +159,6 @@ describe SwiftypeAppSearch::Client do
       # the request responded with the correct 'id', even though
       # the 'errors' object likely contains errors.
       it 'should update existing documents' do
-        response = subject
         expect(subject).to match(['id' => second_document_id, 'errors' => anything])
       end
     end
@@ -167,7 +206,7 @@ describe SwiftypeAppSearch::Client do
 
       context 'when options are specified' do
         it 'will return all documents' do
-          response = client.list_documents(engine_name, {page: { size: 1, current: 2}})
+          response = client.list_documents(engine_name, :page => { :size => 1, :current => 2 })
           expect(response['results'].size).to eq(1)
           expect(response['results'][0]['id']).to eq(second_document_id)
         end
@@ -176,62 +215,90 @@ describe SwiftypeAppSearch::Client do
   end
 
   context 'Search' do
-    # Note that since indexing a document takes up to a minute,
-    # don't actually expect results to be present, just that
-    # the request was made
-
-    before do
-      client.create_engine(engine_name) rescue SwiftypeAppSearch::BadRequest
-    end
-
-    after do
-      client.destroy_engine(engine_name) rescue SwiftypeAppSearch::NonExistentRecord
-    end
-
     describe '#search' do
-      subject { client.search(engine_name, query, options) }
-      let (:query) { '' }
-      let (:options) { { 'page' => { 'size' => 1 } } }
+      subject { @static_client.search(@static_engine_name, query, options) }
+      let(:query) { '' }
+      let(:options) { { 'page' => { 'size' => 2 } } }
 
       it 'should execute a search query' do
-        response = subject
-        expect(response).to have_key('meta')
-        expect(response).to have_key('results')
+        expect(subject).to match(
+          'meta' => anything,
+          'results' => [anything, anything]
+        )
       end
     end
 
     describe '#multi_search' do
-      subject { client.multi_search(engine_name, queries) }
+      subject { @static_client.multi_search(@static_engine_name, queries) }
 
       context 'when options are provided' do
-        let (:queries) { [
-          {'query': 'foo', 'options' => { 'page' => { 'size' => 1 } }},
-          {'query': 'bar', 'options' => { 'page' => { 'size' => 1 } }}
-        ] }
+        let(:queries) do
+          [
+            { 'query' => 'gatsby', 'options' => { 'page' => { 'size' => 1 } } },
+            { 'query' => 'catcher', 'options' => { 'page' => { 'size' => 1 } } }
+          ]
+        end
 
         it 'should execute a multi search query' do
           response = subject
-          expect(response.size).to eq(2)
-          expect(response[0]).to have_key('results')
-          expect(response[0]).to have_key('meta')
-          expect(response[1]).to have_key('results')
-          expect(response[1]).to have_key('meta')
+          expect(response).to match(
+            [
+              {
+                'meta' => anything,
+                'results' => [{ 'id' => { 'raw' => '1' }, 'title' => anything, '_meta' => anything }]
+              },
+              {
+                'meta' => anything,
+                'results' => [{ 'id' => { 'raw' => '2' }, 'title' => anything, '_meta' => anything }]
+              }
+            ]
+          )
         end
       end
 
       context 'when options are omitted' do
-        let (:queries) { [
-          {'query': 'foo' },
-          {'query': 'bar' }
-        ] }
+        let(:queries) do
+          [
+            { 'query' => 'gatsby' },
+            { 'query' => 'catcher' }
+          ]
+        end
 
         it 'should execute a multi search query' do
           response = subject
-          expect(response.size).to eq(2)
-          expect(response[0]).to have_key('results')
-          expect(response[0]).to have_key('meta')
-          expect(response[1]).to have_key('results')
-          expect(response[1]).to have_key('meta')
+          expect(response).to match(
+            [
+              {
+                'meta' => anything,
+                'results' => [{ 'id' => { 'raw' => '1' }, 'title' => anything, '_meta' => anything }]
+              },
+              {
+                'meta' => anything,
+                'results' => [{ 'id' => { 'raw' => '2' }, 'title' => anything, '_meta' => anything }]
+              }
+            ]
+          )
+        end
+      end
+
+      context 'when a search is bad' do
+        let(:queries) do
+          [
+            {
+              'query' => 'cat',
+              'options' => { 'search_fields' => { 'taco' => {} } }
+            }, {
+              'query' => 'dog',
+              'options' => { 'search_fields' => { 'body' => {} } }
+            }
+          ]
+        end
+
+        it 'should throw an appropriate error' do
+          expect { subject }.to raise_error do |e|
+            expect(e).to be_a(SwiftypeAppSearch::BadRequest)
+            expect(e.errors).to eq(['Search fields contains invalid field: taco', 'Search fields contains invalid field: body'])
+          end
         end
       end
     end

data/spec/config_helper.rb

@@ -0,0 +1,22 @@
+module ConfigHelper
+  def ConfigHelper.get_as_api_key
+    ENV.fetch('AS_API_KEY', 'API_KEY')
+  end
+
+  def ConfigHelper.get_as_host_identifier
+    ENV['AS_ACCOUNT_HOST_KEY'] || ENV['AS_HOST_IDENTIFIER'] || 'ACCOUNT_HOST_KEY'
+  end
+
+  def ConfigHelper.get_as_api_endpoint
+    ENV.fetch('AS_API_ENDPOINT', nil)
+  end
+
+  def ConfigHelper.get_client_options(as_api_key, as_host_identifier, as_api_endpoint)
+    {
+      :api_key => as_api_key,
+      :host_identifier => as_host_identifier
+    }.tap do |opts|
+      opts[:api_endpoint] = as_api_endpoint unless as_api_endpoint.nil?
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -3,21 +3,17 @@ require 'rspec'
 require 'webmock/rspec'
 require 'awesome_print'
 require 'swiftype-app-search'
+require 'config_helper'
 
 WebMock.allow_net_connect!
 
-RSpec.shared_context "App Search Credentials" do
-  let(:as_api_key) { ENV.fetch('AS_API_KEY', 'API_KEY') }
+RSpec.shared_context 'App Search Credentials' do
+  let(:as_api_key) { ConfigHelper.get_as_api_key }
   # AS_ACCOUNT_HOST_KEY is deprecated
-  let(:as_host_identifier) { ENV['AS_ACCOUNT_HOST_KEY'] || ENV['AS_HOST_IDENTIFIER'] || 'ACCOUNT_HOST_KEY' }
-  let(:as_api_endpoint) { ENV.fetch('AS_API_ENDPOINT', nil) }
+  let(:as_host_identifier) { ConfigHelper.get_as_host_identifier }
+  let(:as_api_endpoint) { ConfigHelper.get_as_api_endpoint }
   let(:client_options) do
-    {
-      :api_key => as_api_key,
-      :host_identifier => as_host_identifier
-    }.tap do |opts|
-      opts[:api_endpoint] = as_api_endpoint unless as_api_endpoint.nil?
-    end
+    ConfigHelper.get_client_options(as_api_key, as_host_identifier, as_api_endpoint)
   end
 end
 
@@ -26,5 +22,5 @@ RSpec.configure do |config|
   # order dependency and want to debug it, you can fix the order by providing
   # the seed, which is printed after each run.
   #     --seed 1234
-  config.order = "random"
+  config.order = 'random'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swiftype-app-search
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Quin Hoxie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-17 00:00:00.000000000 Z
+date: 2018-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -90,6 +90,7 @@ files:
 - ".circleci/config.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
@@ -107,6 +108,7 @@ files:
 - lib/swiftype-app-search/version.rb
 - script/console
 - spec/client_spec.rb
+- spec/config_helper.rb
 - spec/spec_helper.rb
 - swiftype-app-search.gemspec
 homepage: https://swiftype.com
@@ -135,4 +137,5 @@ specification_version: 4
 summary: Official gem for accessing the Swiftype App Search API
 test_files:
 - spec/client_spec.rb
+- spec/config_helper.rb
 - spec/spec_helper.rb