drill-sergeant 0.1.0 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5cdb7282b775f1c7230459d0a2479c1e555f951d
-  data.tar.gz: 1233bc819be136fccf7a3016cd703dc7b84835d1
+SHA256:
+  metadata.gz: a9a45ee9fd9196539d55c04641748ea43915edc39b2de7a57acc066ec829a493
+  data.tar.gz: d38d61d15324267e96a19d93284cece7fdf37a035dccdc5eb7f3a73e0872c9fa
 SHA512:
-  metadata.gz: e3f4a2c584488f9cdd57d99d847d735bd705422c912abdf8c6be59e5c363d8b814b6d9497f99b3d29c407207065062bd6f7941a3fe5cd3a21992f621c5f78831
-  data.tar.gz: a34d46fd69ceb73ebcc876a8bb9dc24c8f2df2e62513c597d5ab9804dc6fc35e65cb8e4158e3bb12370f42471565d2d936f9f790f1cb699a6dba459e27ad4262
+  metadata.gz: 7bd8f5dc9e71be3bb905f092794ea5d91effae2dd80420f11d998382d5cee12d2945b856d06ae1f8248f27b7fbae4261a5280a72d53ea6c5501c479bdd538799
+  data.tar.gz: f4fc88b864649e84dbb3115e15703897bd24e50f0eefc9c956b4163fbe6da8bb4c20a89f5008b06a915ad611f0a5539c35ba1096d314305c6c1d19190471c043

data/CHANGELOG.md

@@ -1,3 +1,21 @@
-## 0.1.0
+## 0.1.4 (2022-01-16)
+
+- Added `server_version` method
+- Fixed error with failed queries with Drill 1.19+
+
+## 0.1.3 (2019-08-10)
+
+- Added more endpoints
+
+## 0.1.2 (2018-07-22)
+
+- Added support for HTTPS
+- Added `open_timeout` and `read_timeout` options
+
+## 0.1.1 (2017-03-24)
+
+- Return columns in correct order
+
+## 0.1.0 (2017-03-24)
 
 - First release

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2017-2020 Andrew Kane
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -2,27 +2,91 @@
 
 Ruby client for Apache Drill
 
+[![Build Status](https://github.com/ankane/drill-sergeant/workflows/build/badge.svg?branch=master)](https://github.com/ankane/drill-sergeant/actions)
+
 ## Installation
 
-First, [download Apache Drill](https://drill.apache.org/docs/installing-drill-on-linux-and-mac-os-x/). Start it with:
+First, [install Apache Drill](https://drill.apache.org/docs/installing-drill-on-linux-and-mac-os-x/). For Homebrew, use:
 
 ```sh
-bin/drill-embedded
+brew install apache-drill
+drill-embedded
 ```
 
-Then add this line to your application’s Gemfile:
+And add this line to your application’s Gemfile:
 
 ```ruby
-gem 'drill-sergeant'
+gem "drill-sergeant"
 ```
 
 ## How to Use
 
+Create a client
+
 ```ruby
 drill = Drill.new(url: "http://localhost:8047")
+```
+
+And query away
+
+```ruby
 drill.query("SELECT * FROM dfs.`/path/to/some/file.csvh`")
 ```
 
+## Endpoints
+
+[API docs](https://drill.apache.org/docs/rest-api-introduction/)
+
+Get profiles
+
+```ruby
+drill.profiles
+```
+
+Get profile by query id
+
+```ruby
+drill.profiles(query_id)
+```
+
+Get storage
+
+```ruby
+drill.storage
+```
+
+Get storage by name
+
+```ruby
+drill.storage(name)
+```
+
+Get cluster info
+
+```ruby
+drill.cluster
+```
+
+Get metrics
+
+```ruby
+drill.metrics
+```
+
+Get options
+
+```ruby
+drill.options
+```
+
+## Reference
+
+Set timeouts
+
+```ruby
+Drill.new(open_timeout: 5, read_timeout: 120)
+```
+
 ## History
 
 View the [changelog](https://github.com/ankane/drill-sergeant/blob/master/CHANGELOG.md)
@@ -35,3 +99,12 @@ Everyone is encouraged to help improve this project. Here are a few ways you can
 - Fix bugs and [submit pull requests](https://github.com/ankane/drill-sergeant/pulls)
 - Write, clarify, or fix documentation
 - Suggest or add new features
+
+To get started with development:
+
+```sh
+git clone https://github.com/ankane/drill-sergeant.git
+cd drill-sergeant
+bundle install
+bundle exec rake test
+```

data/lib/drill/version.rb

@@ -1,3 +1,3 @@
 class Drill
-  VERSION = "0.1.0"
+  VERSION = "0.1.4"
 end

data/lib/drill-sergeant.rb

@@ -0,0 +1,119 @@
+# dependencies
+require "cgi"
+require "json"
+require "net/http"
+
+# modules
+require "drill/version"
+
+# TODO make module and move to client
+class Drill
+  class Error < StandardError; end
+
+  HEADERS = {
+    "Content-Type" => "application/json",
+    "Accept" => "application/json"
+  }
+
+  def initialize(url: nil, open_timeout: 3, read_timeout: nil)
+    url ||= ENV["DRILL_URL"] || "http://localhost:8047"
+    # remove trailing slash
+    @uri = URI.parse(url.chomp("/"))
+    @http = Net::HTTP.new(@uri.host, @uri.port)
+    @http.use_ssl = true if @uri.scheme == "https"
+    @http.open_timeout = open_timeout if open_timeout
+    @http.read_timeout = read_timeout if read_timeout
+  end
+
+  def query(statement)
+    options = {}
+    if Gem::Version.new(server_version) >= Gem::Version.new("1.19.0")
+      options["drill.exec.http.rest.errors.verbose"] = true
+    end
+    run_query(statement, options)
+  end
+
+  def profiles(query_id = nil)
+    path = query_id ? "profiles/#{escape_path(query_id)}.json" : "profiles.json"
+    get(path)
+  end
+
+  def storage(name = nil)
+    path = name ? "storage/#{escape_path(name)}.json" : "storage.json"
+    get(path)
+  end
+
+  def cluster
+    get("cluster.json")
+  end
+
+  def metrics
+    # no .json suffix
+    get("status/metrics")
+  end
+
+  def options
+    get("options.json")
+  end
+
+  def server_version
+    @server_version ||= run_query("SELECT version FROM sys.version", {})[0]["version"]
+  end
+
+  private
+
+  def run_query(statement, options)
+    data = {
+      queryType: "sql",
+      query: statement,
+      options: options
+    }
+
+    body = post("query.json", data)
+
+    # errors return 200 with Drill 1.19+
+    if body["queryState"] != "COMPLETED"
+      raise Error, body["errorMessage"] || "Bad state: #{body["queryState"]}"
+    end
+
+    # return columns in order
+    result = []
+    columns = body["columns"]
+    body["rows"].each do |row|
+      result << columns.each_with_object({}) { |c, memo| memo[c] = row[c] }
+    end
+    result
+  end
+
+  def get(path)
+    handle_response do
+      @http.get("#{@uri.request_uri}#{path}", HEADERS)
+    end
+  end
+
+  def post(path, data)
+    handle_response do
+      @http.post("#{@uri.request_uri}#{path}", data.to_json, HEADERS)
+    end
+  end
+
+  def handle_response
+    begin
+      response = yield
+    rescue Errno::ECONNREFUSED => e
+      raise Error, e.message
+    end
+
+    unless response.kind_of?(Net::HTTPSuccess)
+      body = JSON.parse(response.body) rescue {}
+      message = body["errorMessage"] || "Bad response: #{response.code}"
+      raise Error, message
+    end
+
+    JSON.parse(response.body)
+  end
+
+  def escape_path(path)
+    CGI.escape(path).gsub("+", "%20")
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: drill-sergeant
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.4
 platform: ruby
 authors:
 - Andrew Kane
-autorequire: 
-bindir: exe
+autorequire:
+bindir: bin
 cert_chain: []
-date: 2017-03-24 00:00:00.000000000 Z
+date: 2022-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,26 +52,22 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
-email:
-- andrew@chartkick.com
+description:
+email: andrew@chartkick.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
 - CHANGELOG.md
-- Gemfile
+- LICENSE.txt
 - README.md
-- Rakefile
-- drill-sergeant.gemspec
-- lib/drill.rb
-- lib/drill/sergeant.rb
+- lib/drill-sergeant.rb
 - lib/drill/version.rb
 homepage: https://github.com/ankane/drill-sergeant
-licenses: []
+licenses:
+- MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -79,16 +75,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
 summary: Ruby client for Apache Drill
 test_files: []

data/.gitignore

@@ -1,9 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/

data/Gemfile

@@ -1,3 +0,0 @@
-source "https://rubygems.org"
-
-gemspec

data/Rakefile

@@ -1,11 +0,0 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
-  t.warning = false
-end
-
-task default: :test

data/drill-sergeant.gemspec

@@ -1,25 +0,0 @@
-# coding: utf-8
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "drill/version"
-
-Gem::Specification.new do |spec|
-  spec.name          = "drill-sergeant"
-  spec.version       = Drill::VERSION
-  spec.authors       = ["Andrew Kane"]
-  spec.email         = ["andrew@chartkick.com"]
-
-  spec.summary       = "Ruby client for Apache Drill"
-  spec.homepage      = "https://github.com/ankane/drill-sergeant"
-
-  spec.files = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
-  end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "minitest"
-end

data/lib/drill/sergeant.rb

@@ -1 +0,0 @@
-require "drill"

data/lib/drill.rb

@@ -1,34 +0,0 @@
-require "json"
-require "net/http"
-require "drill/version"
-
-class Drill
-  class Error < StandardError; end
-
-  def initialize(url: nil)
-    url ||= ENV["DRILL_URL"] || "http://localhost:8047"
-    @uri = URI.parse("#{url}/query.json")
-    @http = Net::HTTP.new(@uri.host, @uri.port)
-  end
-
-  def query(statement)
-    header = {"Content-Type" => "application/json", "Accept" => "application/json"}
-    data = {
-      queryType: "sql",
-      query: statement
-    }
-
-    begin
-      response = @http.post(@uri.request_uri, data.to_json, header)
-    rescue Errno::ECONNREFUSED => e
-      raise Drill::Error, e.message
-    end
-
-    body = JSON.parse(response.body)
-    if body["errorMessage"]
-      raise Drill::Error, body["errorMessage"].split("\n")[0]
-    end
-
-    body["rows"]
-  end
-end