swiftype-enterprise 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: f4ca1438be2d0d405b2636dee9f8f3246a172363520954ab8f657cea15c437af
-  data.tar.gz: 993f393f196d9ebc0205f8ef25a322c5dbc0eca5d3bfc8d3382ef0c303c104f4
+SHA1:
+  metadata.gz: 0d73928e6d01ff6eec555c4579ec5dd576b64e39
+  data.tar.gz: d6de4d034cf9fd60ed7578cb888b145b15c28237
 SHA512:
-  metadata.gz: 0a9b55da2d0ddd9fb92a28268561f0c645e16702b1c91ace38533d86a85835223e84b1b6f02fed4718402733d3345452fd12a01ccf5826a8bf83887d2693a73e
-  data.tar.gz: d61bc6a04940221f82ecb0f5d681c454554398f3a73cd362b0b2ba403795c5090f952c51b23fa0960fd9d290d2ad863035d8185e9bfd71b1a1f042efd6caa992
+  metadata.gz: 006d6f3aeec117d7323e02517590e88f608efcdf45bb687e1f5013fcf6b6050484837e18650725053954c14790cb5e2103b8e73448d84cdcc4de3a5da919c0a5
+  data.tar.gz: 5603ef92625268c22c1fc007713e64b5590458a823c042e71d2ca80c4b27db8520aa869d81aec39ba58c1635f9125c0420c54ebc810517e5c41e7e4c3030fc83

data/README.md

@@ -31,6 +31,14 @@ Create a new instance of the Swiftype Enterprise Client with your access token:
     SwiftypeEnterprise.access_token = '' # your access token
     swiftype = SwiftypeEnterprise::Client.new
 
+### Change API endpoint
+
+ ```
+swiftype = SwiftypeEnterprise::Client.new
+SwiftypeEnterprise.endpoint = 'https://your-server.example.com/api/v1'
+```
+
+
 ### Indexing Documents
 
 This example shows how to use the index_documents method:
@@ -38,13 +46,13 @@ This example shows how to use the index_documents method:
     content_source_key = '' # your content source key
     documents = [
       {
-        'external_id' => 'INscMGmhmX4',
+        'id' => 'INscMGmhmX4',
         'url' => 'http://www.youtube.com/watch?v=v1uyQZNg2vE',
         'title' => 'The Original Grumpy Cat',
         'body' => 'this is a test'
       },
       {
-        'external_id' => 'JNDFojsd02',
+        'id' => 'JNDFojsd02',
         'url' => 'http://www.youtube.com/watch?v=tsdfhk2j',
         'title' => 'Another Grumpy Cat',
         'body' => 'this is also a test'
@@ -61,10 +69,10 @@ This example shows how to use the index_documents method:
 ### Destroying Documents
 
     content_source_key = '' # your content source key
-    document_external_ids = ['INscMGmhmX4', 'JNDFojsd02']
+    document_ids = ['INscMGmhmX4', 'JNDFojsd02']
 
     begin
-      destroy_document_results = swiftype.destroy_documents(content_source_key, document_external_ids)
+      destroy_document_results = swiftype.destroy_documents(content_source_key, document_ids)
       # handle destroy document results
     rescue SwiftypeEnterprise::ClientException => e
       # handle error

data/lib/swiftype-enterprise/client.rb

@@ -41,18 +41,6 @@ module SwiftypeEnterprise
     #
     # For more information on indexing documents, see the {Content Source documentation}[https://app.swiftype.com/ent/docs/custom_sources].
     module ContentSourceDocuments
-      REQUIRED_TOP_LEVEL_KEYS = [
-        'external_id',
-        'url',
-        'title',
-        'body'
-      ].map!(&:freeze).to_set.freeze
-      OPTIONAL_TOP_LEVEL_KEYS = [
-        'created_at',
-        'updated_at',
-        'type',
-      ].map!(&:freeze).to_set.freeze
-      CORE_TOP_LEVEL_KEYS = (REQUIRED_TOP_LEVEL_KEYS + OPTIONAL_TOP_LEVEL_KEYS).freeze
 
       # Index a batch of documents using the {Content Source API}[https://app.swiftype.com/ent/docs/custom_sources].
       #
@@ -64,7 +52,7 @@ module SwiftypeEnterprise
       # @raise [SwiftypeEnterprise::InvalidDocument] when a single document is missing required fields or contains unsupported fields
       # @raise [Timeout::Error] when timeout expires waiting for results
       def index_documents(content_source_key, documents)
-        documents = Array(documents).map! { |document| validate_and_normalize_document(document) }
+        documents = Array(documents).map! { |document| normalize_document(document) }
 
         async_create_or_update_documents(content_source_key, documents)
       end
@@ -87,16 +75,8 @@ module SwiftypeEnterprise
         post("ent/sources/#{content_source_key}/documents/bulk_create.json", documents)
       end
 
-      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 SwiftypeEnterprise::InvalidDocument.new("missing required fields (#{missing_keys.to_a.join(', ')})") if missing_keys.any?
-
-        surplus_keys = document_keys - CORE_TOP_LEVEL_KEYS
-        raise SwiftypeEnterprise::InvalidDocument.new("unsupported fields supplied (#{surplus_keys.to_a.join(', ')}), supported fields are (#{CORE_TOP_LEVEL_KEYS.to_a.join(', ')})") if surplus_keys.any?
-
-        document
+      def normalize_document(document)
+        Utils.stringify_keys(document)
       end
     end
 

data/lib/swiftype-enterprise/configuration.rb

@@ -3,7 +3,7 @@ require 'swiftype-enterprise/version'
 
 module SwiftypeEnterprise
   module Configuration
-    DEFAULT_ENDPOINT = "https://api.swiftype.com/api/v1/"
+    DEFAULT_ENDPOINT = "http://localhost:3002/api/v1/"
     DEFAULT_USER_AGENT = "swiftype-enterprise-ruby/#{SwiftypeEnterprise::VERSION}"
 
     VALID_OPTIONS_KEYS = [

data/lib/swiftype-enterprise/version.rb

@@ -1,3 +1,3 @@
 module SwiftypeEnterprise
-  VERSION = '2.0.0'
+  VERSION = '3.0.0'
 end

data/spec/client_spec.rb

@@ -12,19 +12,19 @@ describe SwiftypeEnterprise::Client do
     def check_receipt_response_format(response, options = {})
       expect(response.keys).to match_array(["document_receipts", "batch_link"])
       expect(response["document_receipts"]).to be_a_kind_of(Array)
-      expect(response["document_receipts"].first.keys).to match_array(["id", "external_id", "links", "status", "errors"])
-      expect(response["document_receipts"].first["external_id"]).to eq(options[:external_id]) if options[:external_id]
+      expect(response["document_receipts"].first.keys).to match_array(["id", "id", "links", "status", "errors"])
+      expect(response["document_receipts"].first["id"]).to eq(options[:id]) if options[:id]
       expect(response["document_receipts"].first["status"]).to eq(options[:status]) if options[:status]
       expect(response["document_receipts"].first["errors"]).to eq(options[:errors]) if options[:errors]
     end
 
     let(:content_source_key) { '59542d332139de0acacc7dd4' }
     let(:documents) do
-      [{'external_id'=>'INscMGmhmX4',
+      [{'id'=>'INscMGmhmX4',
         'url' => 'http://www.youtube.com/watch?v=v1uyQZNg2vE',
         'title' => 'The Original Grumpy Cat',
         'body' => 'this is a test'},
-       {'external_id'=>'JNDFojsd02',
+       {'id'=>'JNDFojsd02',
                'url' => 'http://www.youtube.com/watch?v=tsdfhk2j',
                'title' => 'Another Grumpy Cat',
                'body' => 'this is also a test'}]
@@ -45,7 +45,7 @@ describe SwiftypeEnterprise::Client do
           VCR.use_cassette(:document_receipts_multiple_complete) do
             client.index_documents(content_source_key, documents)
             VCR.use_cassette(:destroy_documents_success) do
-              response = client.destroy_documents(content_source_key, [documents.first['external_id']])
+              response = client.destroy_documents(content_source_key, [documents.first['id']])
               expect(response.size).to eq(1)
               expect(response.first['success']).to eq(true)
             end

data/spec/fixtures/vcr/async_create_or_update_document_success.yml

@@ -5,8 +5,8 @@ http_interactions:
     uri: http://localhost:3002/api/v1/ent/sources/59542d332139de0acacc7dd4/documents/bulk_create.json
     body:
       encoding: UTF-8
-      string: '[{"external_id":"INscMGmhmX4","url":"http://www.youtube.com/watch?v=v1uyQZNg2vE","title":"The
-        Original Grumpy Cat","body":"this is a test"},{"external_id":"JNDFojsd02","url":"http://www.youtube.com/watch?v=tsdfhk2j","title":"Another
+      string: '[{"id":"INscMGmhmX4","url":"http://www.youtube.com/watch?v=v1uyQZNg2vE","title":"The
+        Original Grumpy Cat","body":"this is a test"},{"id":"JNDFojsd02","url":"http://www.youtube.com/watch?v=tsdfhk2j","title":"Another
         Grumpy Cat","body":"this is also a test"}]'
     headers:
       Accept-Encoding:
@@ -47,7 +47,7 @@ http_interactions:
       - thin 1.5.0 codename Knife
     body:
       encoding: UTF-8
-      string: '[{"id":null,"external_id":"1234","errors":[]},{"id":null,"external_id":"1235","errors":[]}]'
+      string: '[{"id":null,"id":"1234","errors":[]},{"id":null,"id":"1235","errors":[]}]'
     http_version:
   recorded_at: Wed, 05 Jul 2017 17:52:09 GMT
 recorded_with: VCR 3.0.3

data/spec/fixtures/vcr/destroy_documents_success.yml

@@ -47,7 +47,7 @@ http_interactions:
       - thin 1.5.0 codename Knife
     body:
       encoding: UTF-8
-      string: '[{"external_id":"INscMGmhmX4","success":true}]'
-    http_version: 
+      string: '[{"id":"INscMGmhmX4","success":true}]'
+    http_version:
   recorded_at: Wed, 05 Jul 2017 17:52:12 GMT
 recorded_with: VCR 3.0.3

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swiftype-enterprise
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Quin Hoxie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-03 00:00:00.000000000 Z
+date: 2019-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -114,7 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.5.2.3
 signing_key: 
 specification_version: 4
 summary: Official gem for accessing the Swiftype Enterprise API