drill-sergeant 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49028dfe96747f9e9597e498c53ed2ca72ff2d7af184d4823cc73679998c91c5
-  data.tar.gz: b0d1b5d1da91f2ee15c6f34f8a415fffe8d546e9bdf71c91cf39c38fb5905a52
+  metadata.gz: 4a3ea03aaaf7870b45a5fcf70d42a3dc471f8475daef5322ea988f253ed85f30
+  data.tar.gz: 1f1400fceea93d5a2f17c0ca39df950dc2d0db7fa4048821d9b89e9ac675e088
 SHA512:
-  metadata.gz: 51369b3960b21262523dd62b157cf22af3d8c634c2ef235dc7f67d5ade8443e2e22a52e71945b008ec78661d4fd217900e389ab93a883b1c8e900d5b6b913bea
-  data.tar.gz: 05feeba2d6047c508e9b6c9bb4efeb224940c779010c063bdf81e7ed76713261ccfff3d18f78eaae28af0e724a44c41ae1235a185719a7c7f734f1c8d245a06b
+  metadata.gz: feaa39c2ca86d34d7468a229f8371396b4f26dc560584181975d8fa28d36d8ab3d19456493d9fb92f6953b8f8c4741a66e4922472f62f94c30188017c57ab417
+  data.tar.gz: 486ea96149e0b3cfe321797fd1f0083e6ba83f19afed099476d1eae4d1f54e053c985b6c0963f66d932aad90cfaef2070ef4eb71d1a6ea255cce631352da8ce9

data/CHANGELOG.md

@@ -1,12 +1,29 @@
-## 0.1.2
+## 0.2.0 (2022-08-28)
+
+- Added support for basic authentication
+- Added `update_storage` and `delete_storage` methods
+- Added `enable_storage` and `disable_storage` methods
+- Added `cancel_query` method
+- Dropped support for Ruby < 2.7
+
+## 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
+## 0.1.1 (2017-03-24)
 
 - Return columns in correct order
 
-## 0.1.0
+## 0.1.0 (2017-03-24)
 
 - First release

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2017-2022 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

@@ -1,27 +1,30 @@
-# Drill Sergeant
+# Drill Ruby
 
 Ruby client for Apache Drill
 
+[![Build Status](https://github.com/ankane/drill-ruby/workflows/build/badge.svg?branch=master)](https://github.com/ankane/drill-ruby/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/install-drill-introduction/). 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
+## Getting Started
 
 Create a client
 
 ```ruby
-drill = Drill.new(url: "http://localhost:8047")
+drill = Drill::Client.new(url: "http://localhost:8047")
 ```
 
 And query away
@@ -30,23 +33,134 @@ And query away
 drill.query("SELECT * FROM dfs.`/path/to/some/file.csvh`")
 ```
 
+## Endpoints
+
+[API docs](https://drill.apache.org/docs/rest-api-introduction/)
+
+### Query
+
+Run a query
+
+```ruby
+drill.query(
+  query,
+  limit: nil,
+  default_schema: nil,
+  username: nil
+)
+```
+
+### Profiles
+
+Get profiles of running and completed queries
+
+```ruby
+drill.profiles
+```
+
+Get the profile of a query
+
+```ruby
+drill.profiles(query_id)
+```
+
+Cancel a query
+
+```ruby
+drill.cancel_query(query_id)
+```
+
+### Storage
+
+List storage plugins
+
+```ruby
+drill.storage
+```
+
+Get a storage plugin by name
+
+```ruby
+drill.storage(name)
+```
+
+Enable a storage plugin
+
+```ruby
+drill.enable_storage(name)
+```
+
+Disable a storage plugin
+
+```ruby
+drill.disable_storage(name)
+```
+
+Create or update a storage plugin
+
+```ruby
+drill.update_storage(
+  name,
+  type: nil,
+  enabled: nil,
+  connection: nil,
+  workspaces: nil,
+  formats: nil
+)
+```
+
+Delete a storage plugin
+
+```ruby
+drill.delete_storage(name)
+```
+
+### Info
+
+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)
+Drill::Client.new(open_timeout: 5, read_timeout: 120)
 ```
 
 ## History
 
-View the [changelog](https://github.com/ankane/drill-sergeant/blob/master/CHANGELOG.md)
+View the [changelog](CHANGELOG.md)
 
 ## Contributing
 
 Everyone is encouraged to help improve this project. Here are a few ways you can help:
 
-- [Report bugs](https://github.com/ankane/drill-sergeant/issues)
-- Fix bugs and [submit pull requests](https://github.com/ankane/drill-sergeant/pulls)
+- [Report bugs](https://github.com/ankane/drill-ruby/issues)
+- Fix bugs and [submit pull requests](https://github.com/ankane/drill-ruby/pulls)
 - Write, clarify, or fix documentation
 - Suggest or add new features
+
+To get started with development:
+
+```sh
+git clone https://github.com/ankane/drill-ruby.git
+cd drill-ruby
+bundle install
+bundle exec rake test
+```

data/lib/drill/client.rb

@@ -0,0 +1,164 @@
+module Drill
+  class Client
+    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, limit: nil, default_schema: nil, username: nil)
+      options = {}
+      if Gem::Version.new(server_version) >= Gem::Version.new("1.19.0")
+        options["drill.exec.http.rest.errors.verbose"] = true
+      end
+
+      data = {
+        query: statement,
+        options: options
+      }
+      data[:autoLimit] = limit if limit
+      data[:defaultSchema] = default_schema if default_schema
+      data[:userName] = username if username
+
+      run_query(data)
+    end
+
+    def profiles(query_id = nil)
+      path = query_id ? "profiles/#{escape_path(query_id)}.json" : "profiles.json"
+      get(path)
+    end
+
+    def cancel_query(query_id)
+      get("profiles/cancel/#{escape_path(query_id)}")
+    end
+
+    def storage(name = nil)
+      path = name ? "storage/#{escape_path(name)}.json" : "storage.json"
+      get(path)
+    end
+
+    def enable_storage(name)
+      get("storage/#{escape_path(name)}/enable/true")
+    end
+
+    def disable_storage(name)
+      get("storage/#{escape_path(name)}/enable/false")
+    end
+
+    def update_storage(name, type:, enabled:, connection:, workspaces:, formats:)
+      data = {
+        name: name,
+        config: {
+          type: type,
+          enabled: enabled,
+          connection: connection,
+          workspaces: workspaces,
+          formats: formats
+        }
+      }
+      post("storage/#{escape_path(name)}.json", data)
+    end
+
+    def delete_storage(name)
+      delete("storage/#{escape_path(name)}.json")
+    end
+
+    def cluster
+      get("cluster.json")
+    end
+
+    # status does not return json
+
+    def metrics
+      # no .json suffix
+      get("status/metrics")
+    end
+
+    # threads does not return json
+
+    def options
+      get("options.json")
+    end
+
+    def server_version
+      @server_version ||= run_query({query: "SELECT version FROM sys.version"})[0]["version"]
+    end
+
+    # @uri may contain sensitive info
+    def inspect
+      to_s
+    end
+
+    private
+
+    def run_query(data)
+      data[:queryType] ||= "sql"
+
+      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
+        Net::HTTP::Get.new("#{@uri.request_uri}#{path}", HEADERS)
+      end
+    end
+
+    def post(path, data)
+      handle_response do
+        req = Net::HTTP::Post.new("#{@uri.request_uri}#{path}", HEADERS)
+        req.body = data.to_json
+        req
+      end
+    end
+
+    def delete(path)
+      handle_response do
+        Net::HTTP::Delete.new("#{@uri.request_uri}#{path}", HEADERS)
+      end
+    end
+
+    def handle_response
+      begin
+        req = yield
+        req.basic_auth(@uri.user, @uri.password) if @uri.user || @uri.password
+        response = @http.request(req)
+      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
+end

data/lib/drill/version.rb

@@ -1,3 +1,3 @@
-class Drill
-  VERSION = "0.1.2"
+module Drill
+  VERSION = "0.2.0"
 end

data/lib/drill-sergeant.rb

@@ -1,48 +1,16 @@
+# stdlib
+require "cgi"
 require "json"
 require "net/http"
+
+# modules
+require "drill/client"
 require "drill/version"
 
-class Drill
+module 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"
-    # strip trailing slash if exists
-    @uri = URI.parse("#{url.sub(/\/\z/, "")}/query.json")
-    @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)
-    data = {
-      queryType: "sql",
-      query: statement
-    }
-
-    begin
-      response = @http.post(@uri.request_uri, data.to_json, HEADERS)
-    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
-
-    # 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
+  def self.new(**options)
+    Client.new(**options)
   end
 end

metadata

@@ -1,72 +1,32 @@
 --- !ruby/object:Gem::Specification
 name: drill-sergeant
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Andrew Kane
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-07-23 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-description: 
-email: andrew@chartkick.com
+date: 2022-08-29 00:00:00.000000000 Z
+dependencies: []
+description:
+email: andrew@ankane.org
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
+- LICENSE.txt
 - README.md
 - lib/drill-sergeant.rb
+- lib/drill/client.rb
 - lib/drill/version.rb
-homepage: https://github.com/ankane/drill-sergeant
+homepage: https://github.com/ankane/drill-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -74,16 +34,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.2'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Ruby client for Apache Drill
 test_files: []