elastomer-client 0.7.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 067c35156016c954c5bffa66b9f1eba92f977410
-  data.tar.gz: a49152e69e1b33ac13f6fef6404cb219a35448e6
+  metadata.gz: 9539ab968e233a1329b616dfd377bf7fe9c73905
+  data.tar.gz: e7cdb14136521443f70f6eb7f7d7f5d747dcd521
 SHA512:
-  metadata.gz: 09e1f8f14d809b1c475216620ae2fffc7dd2aa712eead86811dcfd81288078cd25d9507ee66453729a7fe82eba3296525395587044d9bbb9c605e656eae4869d
-  data.tar.gz: 876a476bf1d9cbdb46c4524dad8bc097813eec062d6757e7be046777a162d097f696240a14de83a256ab93d16ab8ec3f53c427ebb68242ee9b9b35ef008ceb96
+  metadata.gz: 1346de81716c760aa851e323617cd7318941a41636a32351ac498975c7a7714e283c2d0fcaaaf14d5f0ba4bd6dadbcd2913c4a590d30f558cd3d657f37c274d3
+  data.tar.gz: 0610f7decbac4ba346017093fccd95b75bfb429ec885a6412995fb3367fee06fc075acdd738d50bff54f417dce133681f62390dcc798526d7d10757a66907f19

data/.overcommit.yml

@@ -0,0 +1,5 @@
+PreCommit:
+  RuboCop:
+    enabled: true
+    problem_on_unmodified_line: ignore
+    flags: ['--fail-level', 'error', '--format', 'emacs']

data/.rubocop.yml

@@ -0,0 +1,83 @@
+# Ruby linting configuration.
+# We only worry about two kinds of issues: 'error' and anything less than that.
+# Error is not about severity, but about taste. Simple style choices that
+# never have a great excuse to be broken, such as 1.9 JSON-like hash syntax,
+# are errors. Choices that tend to have good exceptions in practice, such as
+# line length, are warnings.
+
+# If you'd like to make changes, a full list of available issues is at
+#   https://github.com/bbatsov/rubocop/blob/master/config/enabled.yml
+# A list of configurable issues is at:
+#   https://github.com/bbatsov/rubocop/blob/master/config/default.yml
+#
+# If you disable a check, document why.
+
+AllCops:
+  DisabledByDefault: true
+
+StringLiterals:
+  EnforcedStyle: double_quotes
+  Severity: error
+
+HashSyntax:
+  EnforcedStyle: hash_rockets
+  Severity: error
+
+AlignHash:
+  SupportedLastArgumentHashStyles: always_ignore
+
+AlignParameters:
+  Enabled: false # This is usually true, but we often want to roll back to
+                 # the start of a line.
+
+Attr:
+  Enabled: false # We have no styleguide guidance here, and it seems to be
+                 # in frequent use.
+
+ClassAndModuleChildren:
+  Enabled: false # module X<\n>module Y is just as good as module X::Y.
+
+Documentation:
+  Exclude:
+    - !ruby/regexp /test\/*.rb/
+
+ClassLength:
+  Exclude:
+    - !ruby/regexp /test\/*.rb/
+
+PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%w': '{}'
+
+LineLength:
+  Max: 79
+  Severity: warning
+
+MultilineTernaryOperator:
+  Severity: error
+
+UnreachableCode:
+  Severity: error
+
+AndOr:
+  Severity: error
+
+EndAlignment:
+  Severity: error
+
+IndentationWidth:
+  Severity: error
+
+MethodLength:
+  CountComments: false  # count full line comments?
+  Max: 20
+  Severity: error
+
+Alias:
+  Enabled: false # We have no guidance on alias vs alias_method
+
+RedundantSelf:
+  Enabled: false # Sometimes a self.field is a bit more clear
+
+IfUnlessModifier:
+  Enabled: false

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 0.8.1 (2015-11-04)
+- Replace yanked 0.8.0
+- Fix code style based on Rubocop recommendations
+
+## 0.8.0 (2015-09-23) yanked due to invalid build
+- BREAKING: Remove `Client#warmer` method
+- Add the Percolate API
+
 ## 0.7.0 (2015-09-18)
 - Add streaming bulk functionality via `bulk_stream_items`
 - Make Delete by Query compatible with Elasticsearch 2.0

data/Gemfile

@@ -1,5 +1,5 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 gemspec
 
-gem 'simplecov', :require => false, :group => :development, :platform => :ruby_19
+gem "simplecov", :require => false, :group => :development, :platform => :ruby_19

data/README.md

@@ -102,6 +102,6 @@ ElasticSearch. You may find that Excon performs better for your use. To enable
 Excon, add it to your bundle and then change your Elastomer initialization
 thusly:
 
-```
+```ruby
 Elastomer::Client.new(url: YOUR_ES_URL, adapter: :excon)
 ```

data/Rakefile

@@ -1,9 +1,9 @@
 require "bundler/gem_tasks"
 
-require 'rake/testtask'
+require "rake/testtask"
 
 Rake::TestTask.new do |t|
-    t.test_files = FileList["test/**/*_test.rb"]
+  t.test_files = FileList["test/**/*_test.rb"]
 end
 
 task :default => :test

data/elastomer-client.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'elastomer/version'
+require "elastomer/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "elastomer-client"
@@ -29,4 +29,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "minitest","~> 4.7"
   spec.add_development_dependency "webmock","~> 1.21"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "overcommit"
+  spec.add_development_dependency "rubocop"
 end

data/lib/elastomer/client.rb

@@ -1,9 +1,9 @@
-require 'addressable/template'
-require 'faraday'
-require 'multi_json'
-require 'semantic'
+require "addressable/template"
+require "faraday"
+require "multi_json"
+require "semantic"
 
-require 'elastomer/version'
+require "elastomer/version"
 
 module Elastomer
 
@@ -22,7 +22,7 @@ module Elastomer
     #   :opaque_id    - set to `true` to use the 'X-Opaque-Id' request header
     #
     def initialize( opts = {} )
-      host = opts.fetch :host, 'localhost'
+      host = opts.fetch :host, "localhost"
       port = opts.fetch :port, 9200
       @url = opts.fetch :url,  "http://#{host}:#{port}"
 
@@ -41,7 +41,7 @@ module Elastomer
 
     # Returns true if the server is available; returns false otherwise.
     def ping
-      response = head '/', :action => 'cluster.ping'
+      response = head "/", :action => "cluster.ping"
       response.success?
     rescue StandardError
       false
@@ -50,7 +50,7 @@ module Elastomer
 
     # Returns the version String of the attached ElasticSearch instance.
     def version
-      @version ||= info['version']['number']
+      @version ||= info["version"]["number"]
     end
 
     # Returns a Semantic::Version for the attached ElasticSearch instance.
@@ -61,7 +61,7 @@ module Elastomer
 
     # Returns the information Hash from the attached ElasticSearch instance.
     def info
-      response = get '/', :action => 'cluster.info'
+      response = get "/", :action => "cluster.info"
       response.body
     end
 
@@ -75,9 +75,11 @@ module Elastomer
         conn.response :parse_json
         conn.request  :opaque_id if @opaque_id
 
-        @adapter.is_a?(Array) ?
-          conn.adapter(*@adapter) :
+        if @adapter.is_a?(Array)
+          conn.adapter(*@adapter)
+        else
           conn.adapter(@adapter)
+        end
 
         conn.options[:timeout]      = read_timeout
         conn.options[:open_timeout] = open_timeout
@@ -150,6 +152,7 @@ module Elastomer
     #
     # Returns a Faraday::Response
     # Raises an Elastomer::Client::Error on 4XX and 5XX responses
+    # rubocop:disable Metrics/MethodLength
     def request( method, path, params )
       read_timeout = params.delete :read_timeout
       body = extract_body params
@@ -157,42 +160,44 @@ module Elastomer
 
       instrument(path, body, params) do
         begin
-          response = case method
-          when :head
-            connection.head(path) { |req| req.options[:timeout] = read_timeout if read_timeout }
+          response =
+            case method
+            when :head
+              connection.head(path) { |req| req.options[:timeout] = read_timeout if read_timeout }
 
-          when :get
-            connection.get(path) { |req|
-              req.body = body if body
-              req.options[:timeout] = read_timeout if read_timeout
-            }
+            when :get
+              connection.get(path) { |req|
+                req.body = body if body
+                req.options[:timeout] = read_timeout if read_timeout
+              }
 
-          when :put
-            connection.put(path, body) { |req| req.options[:timeout] = read_timeout if read_timeout }
+            when :put
+              connection.put(path, body) { |req| req.options[:timeout] = read_timeout if read_timeout }
 
-          when :post
-            connection.post(path, body) { |req| req.options[:timeout] = read_timeout if read_timeout }
+            when :post
+              connection.post(path, body) { |req| req.options[:timeout] = read_timeout if read_timeout }
 
-          when :delete
-            connection.delete(path) { |req|
-              req.body = body if body
-              req.options[:timeout] = read_timeout if read_timeout
-            }
+            when :delete
+              connection.delete(path) { |req|
+                req.body = body if body
+                req.options[:timeout] = read_timeout if read_timeout
+              }
 
-          else
-            raise ArgumentError, "unknown HTTP request method: #{method.inspect}"
-          end
+            else
+              raise ArgumentError, "unknown HTTP request method: #{method.inspect}"
+            end
 
           handle_errors response
 
         # wrap Faraday errors with appropriate Elastomer::Client error classes
         rescue Faraday::Error::ClientError => boom
-          error_name = boom.class.name.split('::').last
+          error_name = boom.class.name.split("::").last
           error_class = Elastomer::Client.const_get(error_name) rescue Elastomer::Client::Error
           raise error_class.new(boom, method.upcase, path)
         end
       end
     end
+    # rubocop:enable Metrics/MethodLength
 
     # Internal: Extract the :body from the params Hash and convert it to a
     # JSON String format. If the params Hash does not contain a :body then no
@@ -290,7 +295,7 @@ module Elastomer
     # containing and 'error' field.
     def handle_errors( response )
       raise ServerError, response if response.status >= 500
-      raise RequestError, response if response.body.is_a?(Hash) && response.body['error']
+      raise RequestError, response if response.body.is_a?(Hash) && response.body["error"]
 
       response
     end
@@ -310,7 +315,7 @@ module Elastomer
     #
     # Returns the validated param as a String.
     # Raises an ArgumentError if the param is not valid.
-    def assert_param_presence( param, name = 'input value' )
+    def assert_param_presence( param, name = "input value" )
       case param
       when String, Symbol, Numeric
         param = param.to_s.strip
@@ -318,7 +323,7 @@ module Elastomer
         param
 
       when Array
-        param.flatten.map { |item| assert_param_presence(item, name) }.join(',')
+        param.flatten.map { |item| assert_param_presence(item, name) }.join(",")
 
       when nil
         raise ArgumentError, "#{name} cannot be nil"
@@ -332,7 +337,7 @@ module Elastomer
 end  # Elastomer
 
 # require all files in the `client` sub-directory
-Dir.glob(File.expand_path('../client/*.rb', __FILE__)).each { |fn| require fn }
+Dir.glob(File.expand_path("../client/*.rb", __FILE__)).each { |fn| require fn }
 
 # require all files in the `middleware` sub-directory
-Dir.glob(File.expand_path('../middleware/*.rb', __FILE__)).each { |fn| require fn }
+Dir.glob(File.expand_path("../middleware/*.rb", __FILE__)).each { |fn| require fn }

data/lib/elastomer/client/bulk.rb

@@ -35,10 +35,10 @@ module Elastomer
         bulk_obj.call
 
       else
-        raise 'bulk request body cannot be nil' if body.nil?
+        raise "bulk request body cannot be nil" if body.nil?
         params ||= {}
 
-        response = self.post '{/index}{/type}/_bulk', params.merge(:body => body, :action => 'bulk')
+        response = self.post "{/index}{/type}/_bulk", params.merge(:body => body, :action => "bulk")
         response.body
       end
     end

data/lib/elastomer/client/cluster.rb

@@ -34,7 +34,7 @@ module Elastomer
       #
       # Returns the response as a Hash
       def health( params = {} )
-        response = client.get '/_cluster/health{/index}', params.merge(:action => 'cluster.health')
+        response = client.get "/_cluster/health{/index}", params.merge(:action => "cluster.health")
         response.body
       end
 
@@ -52,7 +52,7 @@ module Elastomer
       #
       # Returns the response as a Hash
       def state( params = {} )
-        response = client.get '/_cluster/state{/metrics}{/indices}', params.merge(:action => 'cluster.state')
+        response = client.get "/_cluster/state{/metrics}{/indices}", params.merge(:action => "cluster.state")
         response.body
       end
 
@@ -67,7 +67,7 @@ module Elastomer
       #
       # Returns the response as a Hash
       def stats( params = {} )
-        response = client.get '/_cluster/stats', params.merge(:action => 'cluster.stats')
+        response = client.get "/_cluster/stats", params.merge(:action => "cluster.stats")
         response.body
       end
 
@@ -80,7 +80,7 @@ module Elastomer
       #
       # Returns the response as a Hash
       def pending_tasks( params = {} )
-        response = client.get '/_cluster/pending_tasks', params.merge(:action => 'cluster.pending_tasks')
+        response = client.get "/_cluster/pending_tasks", params.merge(:action => "cluster.pending_tasks")
         response.body
       end
 
@@ -101,7 +101,7 @@ module Elastomer
       #
       # Returns the response as a Hash
       def get_settings( params = {} )
-        response = client.get '/_cluster/settings', params.merge(:action => 'cluster.get_settings')
+        response = client.get "/_cluster/settings", params.merge(:action => "cluster.get_settings")
         response.body
       end
       alias_method :settings, :get_settings
@@ -117,7 +117,7 @@ module Elastomer
       #
       # Returns the response as a Hash
       def update_settings( body, params = {} )
-        response = client.put '/_cluster/settings', params.merge(:body => body, :action => 'cluster.update_settings')
+        response = client.put "/_cluster/settings", params.merge(:body => body, :action => "cluster.update_settings")
         response.body
       end
 
@@ -157,7 +157,7 @@ module Elastomer
           body = {:commands => Array(commands)}
         end
 
-        response = client.post '/_cluster/reroute', params.merge(:body => body, :action => 'cluster.reroute')
+        response = client.post "/_cluster/reroute", params.merge(:body => body, :action => "cluster.reroute")
         response.body
       end
 
@@ -170,7 +170,7 @@ module Elastomer
       #
       # Returns the response as a Hash
       def shutdown( params = {} )
-        response = client.post '/_shutdown', params.merge(:action => 'cluster.shutdown')
+        response = client.post "/_shutdown", params.merge(:action => "cluster.shutdown")
         response.body
       end
 
@@ -191,7 +191,7 @@ module Elastomer
       #
       # Returns the response body as a Hash
       def get_aliases( params = {} )
-        response = client.get '{/index}/_aliases', params.merge(:action => 'cluster.get_aliases')
+        response = client.get "{/index}/_aliases", params.merge(:action => "cluster.get_aliases")
         response.body
       end
       alias_method :aliases, :get_aliases
@@ -227,7 +227,7 @@ module Elastomer
           body = {:actions => Array(actions)}
         end
 
-        response = client.post '/_aliases', params.merge(:body => body, :action => 'cluster.update_aliases')
+        response = client.post "/_aliases", params.merge(:body => body, :action => "cluster.update_aliases")
         response.body
       end
 
@@ -238,8 +238,8 @@ module Elastomer
       def templates
         # ES 1.x supports state filtering via a path segment called metrics.
         # ES 0.90 uses query parameters instead.
-        if client.semantic_version >= '1.0.0'
-          h = state(:metrics => 'metadata')
+        if client.semantic_version >= "1.0.0"
+          h = state(:metrics => "metadata")
         else
           h = state(
             :filter_blocks        => true,
@@ -247,7 +247,7 @@ module Elastomer
             :filter_routing_table => true,
           )
         end
-        h['metadata']['templates']
+        h["metadata"]["templates"]
       end
 
       # List all indices currently defined. This is just a convenience method
@@ -257,8 +257,8 @@ module Elastomer
       def indices
         # ES 1.x supports state filtering via a path segment called metrics.
         # ES 0.90 uses query parameters instead.
-        if client.semantic_version >= '1.0.0'
-          h = state(:metrics => 'metadata')
+        if client.semantic_version >= "1.0.0"
+          h = state(:metrics => "metadata")
         else
           h = state(
             :filter_blocks        => true,
@@ -266,7 +266,7 @@ module Elastomer
             :filter_routing_table => true,
           )
         end
-        h['metadata']['indices']
+        h["metadata"]["indices"]
       end
 
       # List all nodes currently part of the cluster. This is just a convenience
@@ -277,8 +277,8 @@ module Elastomer
       def nodes
         # ES 1.x supports state filtering via a path segment called metrics.
         # ES 0.90 uses query parameters instead.
-        if client.semantic_version >= '1.0.0'
-          h = state(:metrics => 'nodes')
+        if client.semantic_version >= "1.0.0"
+          h = state(:metrics => "nodes")
         else
           h = state(
             :filter_blocks        => true,
@@ -286,7 +286,7 @@ module Elastomer
             :filter_routing_table => true,
           )
         end
-        h['nodes']
+        h["nodes"]
       end
 
     end