elastomer-client 3.1.5 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3a92c72bbd6205383dc51f6f1886c59b6dcd80c6
-  data.tar.gz: 5461381ed8be4b188ab38517365abcc35f2b6c8a
+SHA256:
+  metadata.gz: a3abce6a0da503d9a912b1f444cfb1911aa230db717c703d3eba42d31122295f
+  data.tar.gz: 5ad2807d576cf3a48665217ad8601a531d308de10a1264ee63b131779014bdda
 SHA512:
-  metadata.gz: 62e6218d00e3a0957af8be8f1e5cc2bcb13bfdc275bd6ab75dc88cdb79564f416abf5e606561dcb3d9226032a4fc03d56b585cb0c8ae6c0c07e74d2e2b7040cc
-  data.tar.gz: 1612c188db262177c9a2d11cc4982165ab42057538d62a073f5a80e9a257b3d415be108fb5de52b3a19ceec1864d2193db289371d5740433e86f8e70d38fc513
+  metadata.gz: 8c390f6c7fb21ae298beacd9eac8d471a897b7e6f53a642c4db2024b011f1f8b07118edcb0e3df6ce217509a86a05735c51424c46eb7bda537c8d4e213512c71
+  data.tar.gz: b4ff217cd41090457e10cbb70b0beabfc5f672745d626afe4552f618ddb69367ff070691cc0743f00325ef06e8808e03a5c1509ff7da3e0e9fb9bcf1b983d8d8

data/.travis.yml

@@ -1,17 +1,21 @@
 language: ruby
 rvm:
-  - 2.3.3
+  - 2.3.8
 env:
   # NOTE: Ancient versions of Elasticsearch have different download URLs
   - ES_VERSION=2.3.5 ES_DOWNLOAD_URL=https://download.elastic.co/elasticsearch/release/org/elasticsearch/distribution/tar/elasticsearch/${ES_VERSION}/elasticsearch-${ES_VERSION}.tar.gz
-  - ES_VERSION=5.6.4 ES_DOWNLOAD_URL=https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-${ES_VERSION}.tar.gz
+  - ES_VERSION=2.4.6 ES_DOWNLOAD_URL=https://download.elastic.co/elasticsearch/release/org/elasticsearch/distribution/tar/elasticsearch/${ES_VERSION}/elasticsearch-${ES_VERSION}.tar.gz
+  - ES_VERSION=5.6.15 ES_DOWNLOAD_URL=https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-${ES_VERSION}.tar.gz
 
 # Configure a specific version of Elasticsearch
 # See: https://docs.travis-ci.com/user/database-setup/#Installing-ElasticSearch-on-trusty-container-based-infrastructure
 install:
+  # - sudo apt install openjdk-8-jdk
+  # - sudo update-java-alternatives -l
   - wget ${ES_DOWNLOAD_URL}
   - tar -xzf elasticsearch-${ES_VERSION}.tar.gz
   - ./elasticsearch-${ES_VERSION}/bin/elasticsearch &
+  - gem install bundler
   - bundle install
   - wget --quiet --waitretry=1 --retry-connrefused --timeout=10 --output-document=- http://127.0.0.1:9200
 
@@ -21,3 +25,10 @@ notifications:
   email: false
 
 sudo: false
+dist: trusty
+jdk:
+ - oraclejdk8
+addons:
+  apt:
+    packages:
+    - oracle-java8-installer

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 3.2.0 (2019-08-22)
+- Add config based basic and token auth to `Elastomer::Client#connection`
+- Filter `Elastomer::Client#inspect` output to hide basic and token auth info,
+  and reduce noisiness when debugging
+
 ## 3.1.5 (2019-06-26)
 - Add new more granular exception type
 

data/README.md

@@ -10,7 +10,7 @@ Get started by cloning and running a few scripts:
 $ git clone https://github.com/github/elastomer-client.git
 $ cd elastomer-client
 $ script/bootstrap
-$ rake test
+$ bundle exec rake test
 ```
 
 ## Client
@@ -105,3 +105,17 @@ thusly:
 ```ruby
 Elastomer::Client.new(url: YOUR_ES_URL, adapter: :excon)
 ```
+
+## Releasing
+
+1. Create a new branch from `master`
+2. Bump the version number in `lib/elastomer/version.rb`
+3. Update `CHANGELOG.md` with info about the new version
+4. Execute `bin/rake build`. This will place a new gem file in the `pkg/` folder.
+5. Run `gem install pkg/elastomer-client-{VERSION}.gem` to install the new gem locally
+6. Start an `irb` session, `require "elastomer/client"` and make sure things work as you expect
+7. Once everything is working as you expect, commit the version bump and open a PR
+8. Once you get approval and merge it to master, pull down a fresh copy of master and then...
+9. Run `rake release`
+10. If necessary, manually push the new version to rubygems.org
+11. 🕺 💃 🎉

data/elastomer-client.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "multi_json",  "~> 1.12"
   spec.add_dependency "semantic",    "~> 1.6"
 
-  spec.add_development_dependency "bundler",            "~> 1.14"
+  spec.add_development_dependency "bundler",            "~> 2.0"
   spec.add_development_dependency "activesupport",      ">= 3.0"
   spec.add_development_dependency "minitest",           "~> 5.10"
   spec.add_development_dependency "minitest-fail-fast", "~> 0.1.0"
@@ -33,5 +33,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "webmock",            "~> 2.3"
   spec.add_development_dependency "awesome_print",      "~> 1.8"
   spec.add_development_dependency "pry-byebug",         "~> 3.4"
+  spec.add_development_dependency "spy",                "~> 1.0"
   spec.add_development_dependency "rake"
 end

data/lib/elastomer/client.rb

@@ -3,6 +3,7 @@ require "faraday"
 require "faraday_middleware"
 require "multi_json"
 require "semantic"
+require "zlib"
 
 require "elastomer/version"
 require "elastomer/version_support"
@@ -10,6 +11,9 @@ require "elastomer/version_support"
 module Elastomer
 
   class Client
+    IVAR_BLACK_LIST = [:@basic_auth, :@token_auth]
+    IVAR_NOISY_LIST = [:@api_spec, :@cluster]
+
     MAX_REQUEST_SIZE = 250 * 2**20  # 250 MB
 
     RETRYABLE_METHODS = %i[get head].freeze
@@ -36,11 +40,14 @@ module Elastomer
     #   :es_version       - set to the Elasticsearch version (example: "5.6.6") to avoid an HTTP request to get the version.
     #   :compress_body    - set to true to enable request body compression (default: false)
     #   :compression      - The compression level (0-9) when request body compression is enabled (default: Zlib::DEFAULT_COMPRESSION)
+    #   :basic_auth       - a Hash containing basic authentication :username and :password values to use on connections
+    #   :token_auth       - an authentication token as a String to use on connections (overrides :basic_auth)
     #
     def initialize(host: "localhost", port: 9200, url: nil,
                    read_timeout: 5, open_timeout: 2, max_retries: 0, retry_delay: 0.075,
                    opaque_id: false, adapter: Faraday.default_adapter, max_request_size: MAX_REQUEST_SIZE,
-                   strict_params: false, es_version: nil, compress_body: false, compression: Zlib::DEFAULT_COMPRESSION)
+                   strict_params: false, es_version: nil, compress_body: false, compression: Zlib::DEFAULT_COMPRESSION,
+                   basic_auth: nil, token_auth: nil)
 
       @url = url || "http://#{host}:#{port}"
 
@@ -59,6 +66,8 @@ module Elastomer
       @es_version       = es_version
       @compress_body    = compress_body
       @compression      = compression
+      @basic_auth       = basic_auth
+      @token_auth       = token_auth
     end
 
     attr_reader :host, :port, :url
@@ -79,7 +88,9 @@ module Elastomer
           open_timeout:     open_timeout,
           adapter:          @adapter,
           opaque_id:        @opaque_id,
-          max_request_size: max_request_size
+          max_request_size: max_request_size,
+          basic_auth:       @basic_auth,
+          token_auth:       @token_auth
     end
 
     # Returns true if the server is available; returns false otherwise.
@@ -133,14 +144,20 @@ module Elastomer
         conn.request(:limit_size, max_request_size: max_request_size) if max_request_size
         conn.request(:elastomer_compress, compression: compression) if compress_body
 
+        conn.options[:timeout]      = read_timeout
+        conn.options[:open_timeout] = open_timeout
+
+        if @token_auth.present?
+          conn.token_auth(@token_auth)
+        elsif @basic_auth.present?
+          conn.basic_auth(@basic_auth.fetch(:username), @basic_auth.fetch(:password))
+        end
+
         if @adapter.is_a?(Array)
           conn.adapter(*@adapter)
         else
           conn.adapter(@adapter)
         end
-
-        conn.options[:timeout]      = read_timeout
-        conn.options[:open_timeout] = open_timeout
       end
     end
 
@@ -458,6 +475,14 @@ module Elastomer
       @version_support ||= VersionSupport.new(version)
     end
 
+    def inspect
+      public_vars = self.instance_variables.reject do |var|
+        IVAR_NOISY_LIST.include?(var)
+      end.map do |var|
+        "#{var}=#{IVAR_BLACK_LIST.include?(var) ? "[FILTERED]" : instance_variable_get(var).inspect}"
+      end.join(", ")
+      "<##{self.class}:#{self.object_id.to_s(16)} #{public_vars}>"
+    end
   end  # Client
 end  # Elastomer
 

data/lib/elastomer/version.rb

@@ -1,5 +1,5 @@
 module Elastomer
-  VERSION = "3.1.5"
+  VERSION = "3.2.0"
 
   def self.version
     VERSION

data/script/bootstrap

@@ -1,7 +1,7 @@
 #!/bin/sh
 set -e
 
-cd "$(dirname "$0")/.."
+cd "$(dirname "$0:a")/.."
 if bundle check 1>/dev/null 2>&1; then
     echo "Gem environment up-to-date"
 else

data/script/cibuild-elastomer-client

@@ -1 +1 @@
-cibuild-elastomer-client-es24
+script/cibuild-elastomer-client-es24

data/test/client_test.rb

@@ -88,6 +88,71 @@ describe Elastomer::Client do
     }
   end
 
+  it "hides basic_auth and token_auth params from inspection" do
+    client_params = $client_params.merge(basic_auth: {
+      username: "my_user",
+      password: "my_secret_password"
+    }, token_auth: "my_secret_token")
+    client = Elastomer::Client.new client_params
+    refute_match(/my_user/, client.inspect)
+    refute_match(/my_secret_password/, client.inspect)
+    refute_match(/my_secret_token/, client.inspect)
+    assert_match(/@basic_auth=\[FILTERED\]/, client.inspect)
+    assert_match(/@token_auth=\[FILTERED\]/, client.inspect)
+  end
+
+  describe "authorization" do
+    it "can use basic authentication" do
+      client_params = $client_params.merge(basic_auth: {
+        username: "my_user",
+        password: "my_secret_password"
+      })
+      client = Elastomer::Client.new client_params
+
+      connection = Faraday::Connection.new
+      basic_auth_spy = Spy.on(connection, :basic_auth).and_return(nil)
+
+      Faraday.stub(:new, $client_params[:url], connection) do
+        client.ping
+      end
+
+      assert basic_auth_spy.has_been_called_with?("my_user", "my_secret_password")
+    end
+
+    it "can use token authentication" do
+      client_params = $client_params.merge(token_auth: "my_secret_token")
+      client = Elastomer::Client.new client_params
+
+      connection = Faraday::Connection.new
+      token_auth_spy = Spy.on(connection, :token_auth).and_return(nil)
+
+      Faraday.stub(:new, $client_params[:url], connection) do
+        client.ping
+      end
+
+      assert token_auth_spy.has_been_called_with?("my_secret_token")
+    end
+
+    it "prefers token authentication over basic" do
+      client_params = $client_params.merge(basic_auth: {
+        username: "my_user",
+        password: "my_secret_password"
+      }, token_auth: "my_secret_token")
+      client = Elastomer::Client.new client_params
+
+      connection = Faraday::Connection.new
+      basic_auth_spy = Spy.on(connection, :basic_auth).and_return(nil)
+      token_auth_spy = Spy.on(connection, :token_auth).and_return(nil)
+
+      Faraday.stub(:new, $client_params[:url], connection) do
+        client.ping
+      end
+
+      refute basic_auth_spy.has_been_called?
+      assert token_auth_spy.has_been_called_with?("my_secret_token")
+    end
+  end
+
   describe "when extracting and converting :body params" do
     it "deletes the :body from the params (or it gets the hose)" do
       params = { :body => nil, :q => "what what?" }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: elastomer-client
 version: !ruby/object:Gem::Version
-  version: 3.1.5
+  version: 3.2.0
 platform: ruby
 authors:
 - Tim Pease
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-26 00:00:00.000000000 Z
+date: 2019-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -87,14 +87,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -199,6 +199,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: spy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -340,8 +354,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A library for interacting with Elasticsearch