elastic-app-search 7.6.0 → 7.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1effdc4efc72a9c098033c0d8b034b40d1ed7e84a8f9ffc4b57cf1e684facdba
-  data.tar.gz: 4ed84fe6c73f2613009843a42bea47e1dc768c6a78ce2ef677febfdac049b017
+  metadata.gz: 6c0cd8147b4d6680f795a5bce7c7762904d455ffdde64aa97dbf54e3dc3ee441
+  data.tar.gz: dbc4687de2395b7537f1358c78fb08e7d5f9ff5508af3bfe3776d91b0f8ee4d5
 SHA512:
-  metadata.gz: 65e3675e3767ae71702ee73ddd440f5675dc881ebded19ec652bec8df6f2f0e327028f9d09169d3e070f488cb5175fc049bd8211445b02b659c59d39b8ad1118
-  data.tar.gz: 4b5e6ceaa5b122573daea52c08e704ad4f740dec458fc10a5b14bf414b1092ee0c61f31ba6c16deba58b97a4f99a97c0f23b7e3e3dad338157f7a9138103833c
+  metadata.gz: de8c65f62112e437c59f7a6920ac0b6dedb15a7773d90ce508facb68637485e2e0f88fa9f6022edc8a47fb612f9b213543f5366958c00be0ebec9decc1fc7cf3
+  data.tar.gz: '0676845f7195fb8bfcc1ed486dde287136e8f9313765b07722f99cabf43491437f3a9c5e83128260561f1f5ada3f4bb057402296b8d8eda66c92a0b168f03488'

data/README.md

@@ -25,7 +25,7 @@ To install the gem, execute:
 gem install elastic-app-search
 ```
 
-Or place `gem 'elastic-app-search', '~> 7.6.0'` in your `Gemfile` and run `bundle install`.
+Or place `gem 'elastic-app-search', '~> 7.7.0'` in your `Gemfile` and run `bundle install`.
 
 ## Versioning
 
@@ -55,12 +55,12 @@ Note:
 
 The `[API_KEY]` authenticates requests to the API.
 You can use any key type with the client, however each has a different scope.
-For more information on keys, check out the [documentation](https://swiftype.com/documentation/app-search/credentials).
+For more information on keys, check out the [documentation](https://swiftype.com/documentation/app-search/api/credentials).
 
 ##### Swiftype.com App Search users:
 
 When using the [SaaS version available on swiftype.com](https://app.swiftype.com/as) of App Search, you can configure the client using your `[HOST_IDENTIFIER]` instead of the `[API_ENDPOINT]`.
-The `[HOST_IDENTIFIER]` can be found within the [Credentials](https://app.swiftype.com/ascredentials) menu.
+The `[HOST_IDENTIFIER]` can be found within the [Credentials](https://app.swiftype.com/as#/credentials) menu.
 
 ```ruby
 require 'elastic-app-search'
@@ -315,7 +315,8 @@ enforced_options = {
 
 signed_search_key = Elastic::AppSearch::Client.create_signed_search_key(public_search_key, public_search_key_name, enforced_options)
 
-client = Elastic::AppSearch::Client.new(host_identifier: 'host-c5s2mj', api_key: signed_search_key)
+client = Elastic::AppSearch::Client.new(:api_key => signed_search_key, :api_endpoint => 'http://localhost:3002/api/as/v1/')
+
 client.search('national-parks-demo', 'everglade')
 ```
 

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

@@ -1,5 +1,5 @@
 module Elastic
   module AppSearch
-    VERSION = '7.6.0'
+    VERSION = '7.7.0'
   end
 end

data/spec/client_spec.rb

@@ -27,17 +27,33 @@ describe Elastic::AppSearch::Client do
 
   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 => {
-            'X-Swiftype-Client' => 'elastic-app-search-ruby',
-            'X-Swiftype-Client-Version' => Elastic::AppSearch::VERSION
-          }
+      if (client_options[:api_endpoint])
+        stub_request(:any, "#{client_options[:api_endpoint]}engines")
+        client.list_engines
+        expect(WebMock).to(
+          have_requested(:get, "#{client_options[:api_endpoint]}engines")
+          .with(
+            :headers => {
+              'X-Swiftype-Client' => 'elastic-app-search-ruby',
+              'X-Swiftype-Client-Version' => Elastic::AppSearch::VERSION
+            }
+          )
         )
-      )
+      else
+        # CI runs against saas, so we keep this around for now. CI should be updated
+        # to use slef-managed and we should drop support "host_identifier" this.
+        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 => {
+              'X-Swiftype-Client' => 'elastic-app-search-ruby',
+              'X-Swiftype-Client-Version' => Elastic::AppSearch::VERSION
+            }
+          )
+        )
+      end
     end
   end
 

data/spec/documents_spec.rb

@@ -126,34 +126,5 @@ describe Elastic::AppSearch::Client::Documents do
         expect(response[1]['id']).to(eq(second_document_id))
       end
     end
-
-    describe '#list_documents' do
-      let(:documents) { [first_document, second_document] }
-      let(:first_document_id) { 'id' }
-      let(:first_document) { { 'id' => first_document_id, 'url' => 'https://www.youtube.com/watch?v=v1uyQZNg2vE' } }
-      let(:second_document_id) { 'another_id' }
-      let(:second_document) { { 'id' => second_document_id, 'url' => 'https://www.youtube.com/watch?v=9T1vfsHYiKY' } }
-
-      before do
-        client.index_documents(engine_name, documents)
-      end
-
-      context 'when no options are specified' do
-        it 'will return all documents' do
-          response = client.list_documents(engine_name)
-          expect(response['results'].size).to(eq(2))
-          expect(response['results'][0]['id']).to(eq(first_document_id))
-          expect(response['results'][1]['id']).to(eq(second_document_id))
-        end
-      end
-
-      context 'when options are specified' do
-        it 'will return all documents' do
-          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
-      end
-    end
   end
 end

data/spec/list_documents_spec.rb

@@ -0,0 +1,25 @@
+describe Elastic::AppSearch::Client::Documents do
+  include_context 'App Search Credentials'
+  include_context 'Static Test Engine'
+
+  let(:client) { Elastic::AppSearch::Client.new(client_options) }
+
+  context 'Documents' do
+    describe '#list_documents' do
+      context 'when no options are specified' do
+        it 'will return all documents' do
+          response = client.list_documents(engine_name)
+          expect(response['results'].size).to(eq(2))
+          expect(response['results'].map { |d| d['id'] }).to(include(document1['id'], document2['id']))
+        end
+      end
+
+      context 'when options are specified' do
+        it 'will return all documents' do
+          response = client.list_documents(engine_name, :page => { :size => 1, :current => 2 })
+          expect(response['results'].size).to(eq(1))
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elastic-app-search
 version: !ruby/object:Gem::Version
-  version: 7.6.0
+  version: 7.7.0
 platform: ruby
 authors:
 - Quin Hoxie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-13 00:00:00.000000000 Z
+date: 2020-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -135,6 +135,7 @@ files:
 - spec/documents_spec.rb
 - spec/engines_spec.rb
 - spec/exceptions_spec.rb
+- spec/list_documents_spec.rb
 - spec/logs_spec.rb
 - spec/meta_engines_spec.rb
 - spec/query_suggestion_spec.rb
@@ -176,6 +177,7 @@ test_files:
 - spec/documents_spec.rb
 - spec/engines_spec.rb
 - spec/exceptions_spec.rb
+- spec/list_documents_spec.rb
 - spec/logs_spec.rb
 - spec/meta_engines_spec.rb
 - spec/query_suggestion_spec.rb