elastic-enterprise-search 0.3.0 → 7.13.0.pre

data/spec/app-search/client_spec.rb

@@ -0,0 +1,88 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Elastic::EnterpriseSearch::AppSearch::Client do
+  let(:host) { 'https://localhost:8080' }
+  let(:api_key) { 'api_key' }
+
+  context 'dependant on EnterpriseSearch' do
+    let(:ent_client) { Elastic::EnterpriseSearch::Client.new(host: host) }
+    let(:app_client) { ent_client.app_search }
+
+    it 'initializes an app search client' do
+      expect(app_client).not_to be nil
+      expect(app_client).to be_a(Elastic::EnterpriseSearch::AppSearch::Client)
+      expect(app_client.host).to eq(host)
+    end
+
+    it 'sets up authentication during initialization' do
+      ent_client = Elastic::EnterpriseSearch::Client.new(host: host)
+      app_client = ent_client.app_search(http_auth: api_key)
+      expect(app_client.http_auth).to eq api_key
+    end
+
+    it 'sets up authentication as a parameter' do
+      app_client.http_auth = api_key
+      expect(app_client.http_auth).to eq api_key
+    end
+  end
+
+  context 'independent from EnterpriseSearch client' do
+    let(:app_client) { Elastic::EnterpriseSearch::AppSearch::Client.new(host: host) }
+
+    it 'initializes a workplace search client' do
+      expect(app_client).not_to be nil
+      expect(app_client).to be_a(Elastic::EnterpriseSearch::AppSearch::Client)
+      expect(app_client.host).to eq(host)
+    end
+
+    it 'sets up authentication during initialization' do
+      ent_client = Elastic::EnterpriseSearch::Client.new(host: host)
+      app_client = ent_client.app_search(http_auth: api_key)
+      expect(app_client.http_auth).to eq api_key
+    end
+
+    it 'sets up authentication as a parameter' do
+      app_client.http_auth = api_key
+      expect(app_client.http_auth).to eq api_key
+    end
+  end
+
+  describe '#create_signed_search_key' do
+    let(:key) { 'private-key-value' }
+    let(:api_key_name) { 'private-key' }
+    let(:enforced_options) { { query: 'cat' } }
+
+    subject do
+      Elastic::EnterpriseSearch::AppSearch::Client.create_signed_search_key(
+        key,
+        api_key_name,
+        enforced_options
+      )
+    end
+
+    it 'should build a valid jwt' do
+      decoded_token = JWT.decode(subject, key, true, algorithm: 'HS256')
+      expect(decoded_token[0]['api_key_name']).to(eq(api_key_name))
+      expect(decoded_token[0]['query']).to(eq('cat'))
+    end
+  end
+end

data/spec/app-search/date_spec.rb

@@ -0,0 +1,69 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Elastic::EnterpriseSearch::AppSearch::Client do
+  let(:host) { 'https://localhost:8080' }
+  let(:api_key) { 'api_key' }
+  let(:client) { Elastic::EnterpriseSearch::AppSearch::Client.new(host: host) }
+  let(:subject) { client.date_to_rfc3339(date) }
+
+  context 'Date (year=2020, month=1, day=2)' do
+    let(:date) { Date.new(2020, 1, 2) }
+    it 'serializes' do
+      expect(subject).to eq('2020-01-02T00:00:00+00:00')
+    end
+  end
+
+  context 'Date (year=1995, month=12, day=29)' do
+    let(:date) { Date.new(1995, 12, 29) }
+    it 'serializes' do
+      expect(subject).to eq('1995-12-29T00:00:00+00:00')
+    end
+  end
+
+  context 'Date (year=2020, month=1, day=2, hour=3, minute=4, second=5)' do
+    let(:date) { DateTime.new(2020, 1, 2, 3, 4, 5, '+00:00') }
+    it 'serializes' do
+      expect(subject).to eq('2020-01-02T03:04:05+00:00')
+    end
+  end
+
+  context 'Date (year=1995, month=12, day=29, hour=23, minute=44, second=55)' do
+    let(:date) { DateTime.new(1995, 12, 29, 23, 44, 55, '-05:00') }
+    it 'serializes' do
+      expect(subject).to eq('1995-12-29T23:44:55-05:00')
+    end
+  end
+
+  context 'Date (year=1995, month=12, day=29, hour=23, minute=44, second=55) with Asia/Kolkata (UTC+5:30) Timezone' do
+    let(:date) { DateTime.new(1995, 12, 29, 23, 44, 55, '+5:30') }
+    it 'serializes' do
+      expect(subject).to eq('1995-12-29T23:44:55+05:30')
+    end
+  end
+
+  context 'Date (year=1995, month=12, day=29, hour=23, minute=44, second=55) with HST (UTC-10:00) Timezone' do
+    let(:date) { DateTime.new(2020, 1, 2, 3, 4, 5, '-10:00') }
+    it 'serializes' do
+      expect(subject).to eq('2020-01-02T03:04:05-10:00')
+    end
+  end
+end

data/spec/enterprise-search/client_spec.rb

@@ -0,0 +1,107 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+# frozen_string_literal: true
+
+require 'spec_helper'
+require_relative './../webmock_requires'
+
+describe Elastic::EnterpriseSearch::Client do
+  let(:host) { 'https://localhost:8080' }
+  let(:http_auth) { { user: 'elasticenterprise', password: 'password' } }
+
+  context 'initialization' do
+    it 'sets up options' do
+      client = Elastic::EnterpriseSearch::Client.new(
+        host: host
+      )
+      expect(client.host).to eq host
+    end
+
+    it 'uses the default host' do
+      client = Elastic::EnterpriseSearch::Client.new
+
+      expect(client.host).to eq 'http://localhost:3002'
+    end
+
+    it 'raises an exception for invalid host' do
+      expect do
+        Elastic::EnterpriseSearch::Client.new(host: 'localhost')
+      end.to raise_exception(URI::InvalidURIError)
+    end
+  end
+
+  context 'logging' do
+    require 'logger'
+    # rubocop:disable all
+    class FakeLogger < Logger
+      def initialize; @strio = StringIO.new; super(@strio); end
+      def messages; @strio.string; end
+    end
+    # rubocop:enable all
+
+    let(:logger) { FakeLogger.new }
+
+    it 'sets log' do
+      client = Elastic::EnterpriseSearch::Client.new(log: true)
+
+      expect(client.log)
+    end
+
+    it 'sets a logger' do
+      client = Elastic::EnterpriseSearch::Client.new(logger: logger)
+      stub_request(:get, 'http://localhost:3002/api/ent/v1/internal/health/')
+      client.health
+      expect(logger.messages).to include('INFO -- : GET http://localhost:3002/api/ent/v1/internal/health/')
+    end
+  end
+
+  context 'basic authentication' do
+    it 'sets up authentication on initialization' do
+      client = Elastic::EnterpriseSearch::Client.new(
+        http_auth: http_auth
+      )
+      expect(client.http_auth).to eq http_auth
+    end
+
+    it 'sets authentication after initialization' do
+      http_auth = { user: 'test', password: 'testing' }
+      client = Elastic::EnterpriseSearch::Client.new
+      client.http_auth = http_auth
+      expect(client.http_auth).to eq http_auth
+    end
+  end
+
+  context 'workplace search instantiation from enterprise search' do
+    let(:client) { Elastic::EnterpriseSearch::Client.new(host: host) }
+
+    it 'instantiates workplace search with default endpoint' do
+      expect(client.workplace_search.host).to eq host
+    end
+  end
+
+  context 'meta-header' do
+    let(:transport) { Elastic::EnterpriseSearch::Client.new.instance_variable_get('@transport') }
+    let(:subject) { transport.transport.connections.first.connection.headers }
+    let(:regexp) { /^[a-z]{1,}=[a-z0-9.\-]{1,}(?:,[a-z]{1,}=[a-z0-9._-]+)*$/ }
+
+    it 'sends the correct meta header to transport' do
+      expect(subject['x-elastic-client-meta']).to match(regexp)
+      expect(subject['x-elastic-client-meta']).to match(/^ent=[0-9]+\.[0-9]+\.[0-9]+(p)?,/)
+    end
+  end
+end

data/spec/enterprise-search/request_spec.rb

@@ -0,0 +1,136 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'ostruct'
+require_relative './../webmock_requires'
+
+describe Elastic::EnterpriseSearch::Client do
+  let(:client) { Elastic::EnterpriseSearch::Client.new(http_auth: http_auth) }
+  let(:stub_response) { OpenStruct.new(status: 200) }
+  let(:host) { 'http://localhost:3002' }
+  let(:http_auth) { { user: 'elastic', password: 'password' } }
+  let(:user_agent) do
+    [
+      "#{Elastic::EnterpriseSearch::CLIENT_NAME}/#{Elastic::EnterpriseSearch::VERSION} ",
+      "(RUBY_VERSION: #{RUBY_VERSION}; ",
+      "#{RbConfig::CONFIG['host_os'].split('_').first[/[a-z]+/i].downcase} ",
+      "#{RbConfig::CONFIG['target_cpu']}; ",
+      "elasticsearch-transport: #{Elasticsearch::Transport::VERSION})"
+    ].join
+  end
+
+  let(:headers) do
+    {
+      'Authorization' => 'Basic ZWxhc3RpYzpwYXNzd29yZA==',
+      'Content-Type' => 'application/json',
+      'User-Agent' => user_agent
+    }
+  end
+
+  context 'builds request' do
+    context 'get' do
+      it 'builds the right request' do
+        stub_request(:get, "#{host}/test")
+          .with(
+            query: { 'params' => 'test' },
+            headers: headers
+          ).to_return(stub_response)
+
+        expect(client.get('test', params: 'test').status).to eq(200)
+      end
+    end
+
+    context 'delete' do
+      it 'builds the right request' do
+        stub_request(:delete, "#{host}/test")
+          .with(
+            query: { 'params' => 'test' },
+            headers: headers
+          ).to_return(stub_response)
+
+        expect(client.delete('test', params: 'test').status).to eq(200)
+      end
+    end
+
+    context 'post' do
+      it 'builds the right request' do
+        stub_request(:post, "#{host}/test")
+          .with(
+            body: { some: 'value' },
+            headers: headers
+          ).to_return(stub_response)
+
+        expect(client.post('test', {}, { some: 'value' }).status).to eq(200)
+      end
+    end
+
+    context 'put' do
+      it 'builds the right request' do
+        stub_request(:put, "#{host}/test")
+          .with(body: { 'params' => 'test' }, headers: headers)
+          .to_return(stub_response)
+
+        expect(client.put('test', {}, { 'params' => 'test' }).status).to eq(200)
+      end
+    end
+
+    context 'with custom headers' do
+      let(:custom_header) { { 'x-custom-header' => 'Custom Header Value' } }
+
+      it 'builds the right request' do
+        stub_request(:get, "#{host}/test")
+          .with(body: { 'params' => 'test' })
+          .with(headers: headers.merge(custom_header))
+          .to_return(stub_response)
+
+        expect(client.request(:get, 'test', {}, { 'params' => 'test' }, custom_header).status).to eq(200)
+      end
+
+      it 'builds the right request for put' do
+        stub_request(:put, "#{host}/test")
+          .with(body: { 'params' => 'test' })
+          .with(headers: headers.merge(custom_header))
+          .to_return(stub_response)
+
+        expect(client.put('test', {}, { 'params' => 'test' }, custom_header).status).to eq(200)
+      end
+    end
+  end
+
+  context 'with ssl' do
+    let(:host) { 'https://localhost:3002/api/ws/v1' }
+    let(:client) do
+      Elastic::EnterpriseSearch::Client.new(
+        http_auth: http_auth,
+        host: host
+      )
+    end
+
+    it 'sends the request correctly' do
+      stub_request(:get, "#{host}/test")
+        .with(
+          query: { 'params' => 'test' },
+          headers: headers
+        ).to_return(stub_response)
+
+      expect(client.get('test', { 'params' => 'test' }).status).to eq(200)
+    end
+  end
+end

data/spec/enterprise-search/utils_spec.rb

@@ -0,0 +1,46 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+# frozen_string_literal: true
+
+require 'spec_helper'
+require_relative './../webmock_requires'
+
+describe Elastic::EnterpriseSearch::Utils do
+  let(:subject) { Class.new { extend Elastic::EnterpriseSearch::Utils } }
+  let(:symbolized_hash) do
+    { title: 'This is the title',
+
+      year: 1985,
+      description: 'A generic description' }
+  end
+  let(:stringified_hash) do
+    {
+      'title' => 'This is the title',
+      'year' => 1985,
+      'description' => 'A generic description'
+    }
+  end
+
+  it 'stringifies keys in a hash' do
+    expect(subject.stringify_keys(symbolized_hash)).to eq stringified_hash
+  end
+
+  it 'symbolizes keys in a hash' do
+    expect(described_class.symbolize_keys(stringified_hash)).to eq symbolized_hash
+  end
+end