swiftype-app-search 0.1.0 → 0.1.1

data/lib/swiftype-app-search/client/documents.rb

@@ -4,9 +4,6 @@
 module SwiftypeAppSearch
   class Client
     module Documents
-      REQUIRED_TOP_LEVEL_KEYS = [
-        'id'
-      ].map!(&:freeze).to_set.freeze
 
       # Retrieve Documents from the API by IDs for the {App Search API}[https://swiftype.com/documentation/app-search/]
       #
@@ -19,6 +16,22 @@ module SwiftypeAppSearch
         get("engines/#{engine_name}/documents", ids)
       end
 
+      # Index a document using the {App Search API}[https://swiftype.com/documentation/app-search/].
+      #
+      # @param [String] engine_name the unique Engine name
+      # @param [Array] document a Document Hash
+      #
+      # @return [Hash] processed Document Status hash
+      #
+      # @raise [SwiftypeAppSearch::InvalidDocument] when the document has processing errors returned from the api
+      # @raise [Timeout::Error] when timeout expires waiting for statuses
+      def index_document(engine_name, document)
+        response = index_documents(engine_name, [document])
+        errors = response.first['errors']
+        raise InvalidDocument.new(errors.join('; ')) if errors.any?
+        response.first.tap { |h| h.delete('errors') }
+      end
+
       # Index a batch of documents using the {App Search API}[https://swiftype.com/documentation/app-search/].
       #
       # @param [String] engine_name the unique Engine name
@@ -26,10 +39,10 @@ module SwiftypeAppSearch
       #
       # @return [Array<Hash>] an Array of processed Document Status hashes
       #
-      # @raise [SwiftypeAppSearch::InvalidDocument] when a single document is missing required fields or contains unsupported fields
+      # @raise [SwiftypeAppSearch::InvalidDocument] when any documents have processing errors returned from the api
       # @raise [Timeout::Error] when timeout expires waiting for statuses
       def index_documents(engine_name, documents)
-        documents.map! { |document| validate_and_normalize_document(document) }
+        documents.map! { |document| normalize_document(document) }
         post("engines/#{engine_name}/documents", documents)
       end
 
@@ -43,13 +56,9 @@ module SwiftypeAppSearch
       end
 
       private
-      def validate_and_normalize_document(document)
-        document = Utils.stringify_keys(document)
-        document_keys = document.keys.to_set
-        missing_keys = REQUIRED_TOP_LEVEL_KEYS - document_keys
-        raise InvalidDocument.new("missing required fields (#{missing_keys.to_a.join(', ')})") if missing_keys.any?
 
-        document
+      def normalize_document(document)
+        Utils.stringify_keys(document)
       end
     end
   end

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

@@ -14,6 +14,7 @@ module SwiftypeAppSearch
   class BadRequest < ClientException; end
   class Forbidden < ClientException; end
   class InvalidDocument < ClientException; end
+  class RequestEntityTooLarge < ClientException; end
 
   class UnexpectedHTTPException < ClientException
     def initialize(http_response)

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

@@ -67,6 +67,8 @@ module SwiftypeAppSearch
           raise SwiftypeAppSearch::NonExistentRecord, response_json
         when Net::HTTPForbidden
           raise SwiftypeAppSearch::Forbidden, response_json
+        when Net::HTTPRequestEntityTooLarge
+          raise SwiftypeAppSearch::RequestEntityTooLarge, response_json
         else
           raise SwiftypeAppSearch::UnexpectedHTTPException, response
         end

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

@@ -1,3 +1,3 @@
 module SwiftypeAppSearch
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/spec/client_spec.rb

@@ -5,13 +5,64 @@ describe SwiftypeAppSearch::Client do
   let(:client) { SwiftypeAppSearch::Client.new(:account_host_key => as_account_host_key, :api_key => as_api_key) }
 
   context 'Documents' do
-    %i[index_documents].each do |method|
-      context "##{method}" do
-        it 'should validate required document fields' do
-          documents = [{'url' => 'http://www.youtube.com/watch?v=v1uyQZNg2vE'}]
+    let(:document) { { 'url' => 'http://www.youtube.com/watch?v=v1uyQZNg2vE' } }
+
+    before do
+      client.create_engine(engine_name) rescue SwiftypeAppSearch::BadRequest
+    end
+
+    after do
+      client.destroy_engine(engine_name) rescue SwiftypeAppSearch::NonExistentRecord
+    end
+
+    describe '#index_document' do
+      subject { client.index_document(engine_name, document) }
+
+      it 'should return a processed document status hash' do
+        expect(subject).to match('id' => anything)
+      end
+
+      context 'when the document has an id' do
+        let(:id) { 'some_id' }
+        let(:document) { { 'id' => id, 'url' => 'http://www.youtube.com/watch?v=v1uyQZNg2vE' } }
+
+        it 'should return a processed document status hash with the same id' do
+          expect(subject).to eq('id' => id)
+        end
+      end
+
+      context 'when a document has processing errors' do
+        let(:document) { { 'bad' => { 'no' => 'nested hashes' } } }
+
+        it 'should raise an error when the API returns errors in the response' do
           expect do
-            client.public_send(method, engine_name, documents)
-          end.to raise_error(SwiftypeAppSearch::InvalidDocument, 'Error: missing required fields (id)')
+            subject
+          end.to raise_error(SwiftypeAppSearch::InvalidDocument, /Invalid field value/)
+        end
+      end
+    end
+
+    describe '#index_documents' 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' } }
+      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' => [] }
+        ])
+      end
+
+      context 'when one of the documents has processing errors' do
+        let(:second_document) { { 'bad' => { 'no' => 'nested hashes' } } }
+
+        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 value: Value \'{"no"=>"nested hashes"}\' cannot be an object'] },
+          ])
         end
       end
     end
@@ -19,11 +70,7 @@ describe SwiftypeAppSearch::Client do
 
   context 'Engines' do
     after do
-      # Clean up the test engine from our account
-      begin
-        client.destroy_engine(engine_name)
-      rescue SwiftypeAppSearch::NonExistentRecord
-      end
+      client.destroy_engine(engine_name) rescue SwiftypeAppSearch::NonExistentRecord
     end
 
     context '#create_engine' do

data/swiftype-app-search.gemspec

@@ -20,5 +20,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'awesome_print', '~> 1.8'
   s.add_development_dependency 'webmock', '~> 3.3'
 
-  s.add_runtime_dependency 'jwt', '~> 1.5'
+  s.add_runtime_dependency 'jwt', '~> 2.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swiftype-app-search
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Quin Hoxie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-01 00:00:00.000000000 Z
+date: 2018-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '2.1'
 description: API client for accessing the Swiftype App Search API with no dependencies.
 email:
 - support@swiftype.com
@@ -114,7 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.3
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Official gem for accessing the Swiftype App Search API