elastic-enterprise-search 7.17.0 → 7.17.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b57d38a9d4bae9ccd2217e1bd94a06b886a394aafef47a15ba645694404f3183
-  data.tar.gz: 3f122a3a3400a56afa448de6d3047df37e897867a2a23be1f24026d76fb31e00
+  metadata.gz: 20d5dc58d956de95e2aa7d0723236fddf174fdbf17bb59685609a3cbeb3115cf
+  data.tar.gz: f343bdbeb2448f5a77750a1bf1f28e54152e56662ce490633e5bd49232695230
 SHA512:
-  metadata.gz: 941c3d7645c1126a267662abaf62993581224ef333ad1c6552b52dbeb24508837362afc6f0c6d030e3043567eaebe2b5caa2972571d2610461f15d7f1cf1c88e
-  data.tar.gz: e85bab13059c21cdade084f4eb6e676be6d091db4b5d8e44326bfa8256b19e76af630ee41d28ecc5ec0a0c52febec826d8fc628d1205d598703b5a2167102363
+  metadata.gz: b7dc1bce350ac51b2061bd1d85037b51d884a31b558aa8d4164a98d4eb18d7d403558029719037f824358788466ad14a050d2c799532fc7505f2d64dc681fb4c
+  data.tar.gz: d5c0604ace9a80dd05c3ec1f0b04d6ef0f48aebda33727632ce01d1a3ce7b217cec72d044b9dd3344ba7f160d4350991f4c61b29b875c0c6c3feff0394bc5048

data/CHANGELOG

@@ -0,0 +1 @@
+See https://www.elastic.co/guide/en/enterprise-search-clients/ruby/current/release_notes.html

data/CODE_OF_CONDUCT

@@ -0,0 +1 @@
+See: https://www.elastic.co/community/codeofconduct

data/CONTRIBUTING.md

@@ -1,5 +1,42 @@
 # Contributing to enterprise-search-ruby
 
+## Run Stack locally
+
+A rake task is included to run the Elastic Enterprise Search stack locally via Docker:
+
+```
+$ rake stack[7.10.0]
+```
+
+This will run Elastic Enterprise Search in http://localhost:3002
+- Username: `enterprise_search`
+- Password: `changeme`
+
+The version of the Elastic Enterprise Search Stack to use should be the same as tags of `https://www.docker.elastic.co/r/enterprise-search`. You can also use SNAPSHOT builds such as `8.0.0-SNAPSHOT`, `7.11-SNAPSHOT`, etc.
+
+## Running Tests
+
+Unit tests for the clients:
+
+```
+$ rake spec:client
+```
+
+Integration tests: you need to have an instance of Enterprise Search running either locally or remotely, and specify the host and credentials in environment variables (see below for a complete dockerized setup). If you're using the included rake task `rake stack[:version]`, you can run the integration tests with the following command:
+
+```
+$ ELASTIC_ENTERPRISE_HOST='http://localhost:3002' \
+  ELASTIC_ENTERPRISE_USER='elastic' \
+  ELASTIC_ENTERPRISE_PASSWORD='changeme' \
+  rake spec:integration
+```
+
+Run integration tests completely within containers, the way we run them on our CI:
+```
+RUNSCRIPTS=enterprise-search STACK_VERSION=7.10.0 ./.ci/run-tests
+```
+
+
 ## Contributing Code Changes
 
 1. Please make sure you have signed the [Contributor License

data/NOTICE

@@ -0,0 +1,2 @@
+Elastic Enterprise Search Ruby Client
+Copyright 2021 Elasticsearch B.V.

data/README.md

@@ -6,48 +6,44 @@
 
 Official Ruby API client for [Elastic Enterprise Search](https://www.elastic.co/enterprise-search). Use this gem to integrate App Search and Workplace Search into your Ruby code.
 
-## Documentation
-
-[See the documentation](https://www.elastic.co/guide/en/enterprise-search-clients/ruby/current/index.html) for compatibility info, configuring, and an API reference.
-
-## Development
-
-### Run Stack locally
+## Installation
 
-A rake task is included to run the Elastic Enterprise Search stack locally via Docker:
+Install the `elastic-enterprise-search` gem from [Rubygems](https://rubygems.org/gems/elastic-enterprise-search):
 
 ```
-$ rake stack[7.10.0]
+$ gem install elastic-enterprise-search
 ```
 
-This will run Elastic Enterprise Search in http://localhost:3002
-- Username: `enterprise_search`
-- Password: `changeme`
+Or add it to your project's Gemfile:
 
-The version of the Elastic Enterprise Search Stack to use should be the same as tags of `https://www.docker.elastic.co/r/enterprise-search`. You can also use SNAPSHOT builds such as `8.0.0-SNAPSHOT`, `7.11-SNAPSHOT`, etc.
+```ruby
+gem 'elastic-enterprise-search', 'VERSION'
+```
 
-### Running Tests
+The Enterprise Search client is implemented with [`elastic-transport`](https://github.com/elastic/elastic-transport-ruby/) as the HTTP layer, which uses [Faraday](https://rubygems.org/gems/faraday). Faraday supports several [adapters](https://lostisland.github.io/faraday/adapters/) and will use `Net::HTTP` by default. For optimal performance with the Enterprise Search API, we suggest using an HTTP library which supports persistent ("keep-alive") connections. For the standard Ruby implementation, this could be https://github.com/drbrain/net-http-persistent[Net::HTTP::Persistent], [patron](https://github.com/toland/patron) or [Typhoeus](https://github.com/typhoeus/typhoeus). For JRuby, [Manticore](https://github.com/cheald/manticore) is a great option as well. Require the library for the adapter in your code and then pass in the `:adapter` parameter to the client when you initialize it:
 
-Unit tests for the clients:
+```ruby
+require 'elastic-enterprise-search'
+require 'faraday/net_http_persistent'
 
+client = Elastic::EnterpriseSearch::Client.new(adapter: :net_http_persistent)
 ```
-$ rake spec:client
-```
+If an adapter is not specified, the client will try to auto-detect available libraries and use the best available HTTP client.
 
-Integration tests: you need to have an instance of Enterprise Search running either locally or remotely, and specify the host and credentials in environment variables (see below for a complete dockerized setup). If you're using the included rake task `rake stack[:version]`, you can run the integration tests with the following command:
+## Documentation
 
-```
-$ ELASTIC_ENTERPRISE_HOST='http://localhost:3002' \
-  ELASTIC_ENTERPRISE_USER='elastic' \
-  ELASTIC_ENTERPRISE_PASSWORD='changeme' \
-  rake spec:integration
-```
+[See the documentation](https://www.elastic.co/guide/en/enterprise-search-clients/ruby/current/index.html) for usage, code examples, configuring the client, and an API reference.
 
-Run integration tests completely within containers, the way we run them on our CI:
-```
-RUNSCRIPTS=enterprise-search STACK_VERSION=7.10.0 ./.ci/run-tests
-```
+See code examples of usage for the [Enterprise Search](https://www.elastic.co/guide/en/enterprise-search-clients/ruby/current/enterprise-search-api.html), [App Search](https://www.elastic.co/guide/en/enterprise-search-clients/ruby/current/app-search-api.html) and [Workplace Search](https://www.elastic.co/guide/en/enterprise-search-clients/ruby/current/workplace-search-api.html) APIs.
+
+## Compatibility
+
+We follow Ruby’s own maintenance policy and officially support all currently maintained versions per [Ruby Maintenance Branches](https://www.ruby-lang.org/en/downloads/branches/).
+
+## Development
+
+See [CONTRIBUTING](https://github.com/elastic/enterprise-search-ruby/blob/main/CONTRIBUTING.md).
 
 ## License
 
-Apache-2.0
+This software is licensed under the [Apache 2 license](./LICENSE). See [NOTICE](./NOTICE).

data/docs/guide/overview.asciidoc

@@ -14,7 +14,15 @@ For **Elastic Enterprise Search 7.0** and later, use the major version 7 (`7.x.y
 
 [discrete]
 === HTTP Library
-This library uses https://github.com/elastic/elasticsearch-ruby/tree/main/elasticsearch-transport[elasticsearch-transport], the low-level Ruby client for connecting to an Elasticsearch cluster - also used in the official https://github.com/elastic/elasticsearch-ruby[Elasticsearch Ruby Client].
+This library uses https://github.com/elastic/elastic-transport-ruby[elastic-transport], the low-level Ruby client for connecting to an Elastic clusters - also used in the official https://github.com/elastic/elasticsearch-ruby[Elasticsearch Ruby Client]. It uses https://rubygems.org/gems/faraday[Faraday], which supports several https://lostisland.github.io/faraday/adapters/[adapters] and will use `Net::HTTP` by default. For optimal performance with the Enterprise Search API, we suggest using an HTTP library which supports persistent ("keep-alive") connections. For the standard Ruby implementation, this could be https://github.com/drbrain/net-http-persistent[Net::HTTP::Persistent], https://github.com/toland/patron[patron] or https://github.com/typhoeus/typhoeus[Typhoeus]. For JRuby, https://github.com/cheald/manticore[Manticore] is a great option as well. Require the library for the adapter in your code and then pass in the `:adapter` parameter to the client when you initialize it:
+
+[source,ruby]
+---------------------------------------------------
+require 'elastic-enterprise-search'
+require 'faraday/net_http_persistent'
+
+client = Elastic::EnterpriseSearch::Client.new(adapter: :net_http_persistent)
+---------------------------------------------------
 
 All requests, if successful, will return an `Elasticsearch::Transport::Transport::Response` instance. You can access the response `body`, `headers` and `status`.
 

data/docs/guide/release_notes/717.asciidoc

@@ -1,6 +1,18 @@
 [[release_notes_717]]
 === 7.17 Release notes
 
+[discrete]
+[[release_notes_7171]]
+=== 7.17.1 Release notes
+
+- Updates in Documentation: CHANGELOG, CODE_OF_CONDUCT, CONTRIBUTING, NOTICE, README
+- Adds the option to specify an adapter for Faraday when initializing a client. See https://github.com/elastic/enterprise-search-ruby/blob/main/README.md#elastic-enterprise-search-client[README]
+- Fixes typo in meta data for CLIENT_NAME.
+
+[discrete]
+[[release_notes_7170]]
+=== 7.17.0 Release notes
+
 [discrete]
 ==== General
 

data/lib/elastic/enterprise-search/client.rb

@@ -58,6 +58,7 @@ module Elastic
       # @option options [String] :proxy url of proxy to use, ex: "http://localhost:8888"
       # @option options [Boolean] :log Use the default logger (disabled by default)
       # @option arguments [Object] :logger An instance of a Logger-compatible object
+      # @option arguments [Symbol] :adapter A specific adapter for Faraday (e.g. `:patron`)
       # @option enable_meta_header [Boolean] :enable_meta_header Enable sending the meta data header to Cloud.
       #                                                          (Default: true)
       def initialize(options = {})
@@ -72,6 +73,7 @@ module Elastic
             log: log,
             logger: logger,
             request_timeout: overall_timeout,
+            adapter: adapter,
             transport_options: {
               request: { open_timeout: open_timeout }
             },
@@ -103,6 +105,10 @@ module Elastic
         @options[:logger]
       end
 
+      def adapter
+        @options[:adapter]
+      end
+
       def host
         return DEFAULT_HOST unless @options[:host]
 

data/lib/elastic/enterprise-search/request.rb

@@ -24,7 +24,7 @@ require 'base64'
 
 module Elastic
   module EnterpriseSearch
-    CLIENT_NAME = 'elastic-enteprise-search-ruby'
+    CLIENT_NAME = 'elastic-enterprise-search-ruby'
     CLIENT_VERSION = Elastic::EnterpriseSearch::VERSION
 
     # Module included in Elastic::Enterprise::Client for http requests.

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

@@ -19,6 +19,6 @@
 
 module Elastic
   module EnterpriseSearch
-    VERSION = '7.17.0'
+    VERSION = '7.17.1'
   end
 end

data/spec/app-search/client_spec.rb

@@ -85,4 +85,33 @@ describe Elastic::EnterpriseSearch::AppSearch::Client do
       expect(decoded_token[0]['query']).to(eq('cat'))
     end
   end
+
+  context 'adapters' do
+    let(:client) { described_class.new }
+    let(:adapter) { client.transport.transport.connections.all.first.connection.builder.adapter }
+
+    context 'when no adapter is specified' do
+      it 'uses Faraday NetHttp' do
+        expect(adapter).to eq Faraday::Adapter::NetHttp
+      end
+    end
+
+    context 'when the adapter is patron' do
+      let(:client) { described_class.new(adapter: :patron) }
+
+      it 'uses Faraday with the adapter' do
+        expect(adapter).to eq Faraday::Adapter::Patron
+      end
+    end
+
+    unless defined?(JRUBY_VERSION)
+      context 'when the adapter is typhoeus' do
+        let(:client) { described_class.new(adapter: :patron) }
+
+        it 'uses Faraday with the adapter' do
+          expect(adapter).to eq Faraday::Adapter::Patron
+        end
+      end
+    end
+  end
 end

data/spec/enterprise-search/client_spec.rb

@@ -103,4 +103,33 @@ describe Elastic::EnterpriseSearch::Client do
       expect(subject['x-elastic-client-meta']).to match(/^ent=[0-9]+\.[0-9]+\.[0-9]+(p)?,/)
     end
   end
+
+  context 'adapters' do
+    let(:client) { described_class.new }
+    let(:adapter) { client.transport.transport.connections.all.first.connection.builder.adapter }
+
+    context 'when no adapter is specified' do
+      it 'uses Faraday NetHttp' do
+        expect(adapter).to eq Faraday::Adapter::NetHttp
+      end
+    end
+
+    context 'when the adapter is patron' do
+      let(:client) { described_class.new(adapter: :patron) }
+
+      it 'uses Faraday with the adapter' do
+        expect(adapter).to eq Faraday::Adapter::Patron
+      end
+    end
+
+    unless defined?(JRUBY_VERSION)
+      context 'when the adapter is typhoeus' do
+        let(:client) { described_class.new(adapter: :patron) }
+
+        it 'uses Faraday with the adapter' do
+          expect(adapter).to eq Faraday::Adapter::Patron
+        end
+      end
+    end
+  end
 end

data/spec/fixtures/vcr/workplace_search/create_analytics_event.yml

@@ -10,7 +10,7 @@ http_interactions:
       X-Elastic-Client-Meta:
       - es=7.11.0.pre.1,rb=2.7.2,t=7.11.0.pre.1,fd=1.3.0,nh=1.1
       User-Agent:
-      - 'elastic-enteprise-search-ruby/7.11.0.pre (RUBY_VERSION: 2.7.2; linux x86_64;
+      - 'elastic-enterprise-search-ruby/7.11.0.pre (RUBY_VERSION: 2.7.2; linux x86_64;
         elasticsearch-transport: 7.11.0.pre.1)'
       Content-Type:
       - application/json

data/spec/fixtures/vcr/workplace_search/oauth_request_token.yml

@@ -10,7 +10,7 @@ http_interactions:
       X-Elastic-Client-Meta:
       - es=7.11.0.pre.1,rb=2.7.2,t=7.11.0.pre.1,fd=1.3.0,nh=1.1
       User-Agent:
-      - 'elastic-enteprise-search-ruby/7.11.0.pre (RUBY_VERSION: 2.7.2; linux x86_64;
+      - 'elastic-enterprise-search-ruby/7.11.0.pre (RUBY_VERSION: 2.7.2; linux x86_64;
         elasticsearch-transport: 7.11.0.pre.1)'
       Content-Type:
       - application/json

data/spec/fixtures/vcr/workplace_search/search_request.yml

@@ -10,7 +10,7 @@ http_interactions:
       X-Elastic-Client-Meta:
       - es=7.11.0.pre.1,rb=2.7.2,t=7.11.0.pre.1,fd=1.3.0,nh=1.1
       User-Agent:
-      - 'elastic-enteprise-search-ruby/7.11.0.pre (RUBY_VERSION: 2.7.2; linux x86_64;
+      - 'elastic-enterprise-search-ruby/7.11.0.pre (RUBY_VERSION: 2.7.2; linux x86_64;
         elasticsearch-transport: 7.11.0.pre.1)'
       Content-Type:
       - application/json

data/spec/workplace-search/client_spec.rb

@@ -96,4 +96,33 @@ describe Elastic::EnterpriseSearch::WorkplaceSearch::Client do
       expect(client.authorization_url('client_id', 'https://localhost:3002')).to eq authorization_url
     end
   end
+
+  context 'adapters' do
+    let(:client) { described_class.new }
+    let(:adapter) { client.transport.transport.connections.all.first.connection.builder.adapter }
+
+    context 'when no adapter is specified' do
+      it 'uses Faraday NetHttp' do
+        expect(adapter).to eq Faraday::Adapter::NetHttp
+      end
+    end
+
+    context 'when the adapter is patron' do
+      let(:client) { described_class.new(adapter: :patron) }
+
+      it 'uses Faraday with the adapter' do
+        expect(adapter).to eq Faraday::Adapter::Patron
+      end
+    end
+
+    unless defined?(JRUBY_VERSION)
+      context 'when the adapter is typhoeus' do
+        let(:client) { described_class.new(adapter: :patron) }
+
+        it 'uses Faraday with the adapter' do
+          expect(adapter).to eq Faraday::Adapter::Patron
+        end
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elastic-enterprise-search
 version: !ruby/object:Gem::Version
-  version: 7.17.0
+  version: 7.17.1
 platform: ruby
 authors:
 - Fernando Briano
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-07 00:00:00.000000000 Z
+date: 2022-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: elasticsearch-transport
@@ -183,9 +183,12 @@ files:
 - ".github/workflows/testing.yml"
 - ".gitignore"
 - ".rubocop.yml"
+- CHANGELOG
+- CODE_OF_CONDUCT
 - CONTRIBUTING.md
 - Gemfile
 - LICENSE
+- NOTICE
 - README.md
 - Rakefile
 - docs/guide/app-search-api.asciidoc
@@ -406,7 +409,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Official API client for Elastic Enterprise Search