drill-sergeant 0.1.4 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9a45ee9fd9196539d55c04641748ea43915edc39b2de7a57acc066ec829a493
-  data.tar.gz: d38d61d15324267e96a19d93284cece7fdf37a035dccdc5eb7f3a73e0872c9fa
+  metadata.gz: 5f879931453d91603853f983a38e6ccbed7d15f6a3c4f4d83d0a92fa1b1bedf7
+  data.tar.gz: a9baa8c79b3edd26cc57836540129b591a789c4accbb8cb2881a8d2930a877fd
 SHA512:
-  metadata.gz: 7bd8f5dc9e71be3bb905f092794ea5d91effae2dd80420f11d998382d5cee12d2945b856d06ae1f8248f27b7fbae4261a5280a72d53ea6c5501c479bdd538799
-  data.tar.gz: f4fc88b864649e84dbb3115e15703897bd24e50f0eefc9c956b4163fbe6da8bb4c20a89f5008b06a915ad611f0a5539c35ba1096d314305c6c1d19190471c043
+  metadata.gz: ed5aa7562167c1fef98d29a72b805064180c9ad12296a75e66e6346dc71abc27c4cf4173e508c2c5510c73c39958ec9b278c64bc1885b012a64360c19105398f
+  data.tar.gz: d84e6181c5282c2f10a948d71f07169a8dfcb9f99c3d68f2edbbe8cc2bc3882af78ecb5ea82c4d99268fb7dac14f311608f34cf8cb1e926d2a76c7a1218de639

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## 0.3.0 (2024-10-22)
+
+- Dropped support for Ruby < 3.1
+
+## 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

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2017-2020 Andrew Kane
+Copyright (c) 2017-2022 Andrew Kane
 
 MIT License
 

data/README.md

@@ -1,12 +1,12 @@
-# Drill Sergeant
+# Drill Ruby
 
 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)
+[![Build Status](https://github.com/ankane/drill-ruby/actions/workflows/build.yml/badge.svg)](https://github.com/ankane/drill-ruby/actions)
 
 ## Installation
 
-First, [install Apache Drill](https://drill.apache.org/docs/installing-drill-on-linux-and-mac-os-x/). For Homebrew, use:
+First, [install Apache Drill](https://drill.apache.org/docs/install-drill-introduction/). For Homebrew, use:
 
 ```sh
 brew install apache-drill
@@ -19,12 +19,12 @@ And add this line to your application’s Gemfile:
 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
@@ -37,30 +37,86 @@ drill.query("SELECT * FROM dfs.`/path/to/some/file.csvh`")
 
 [API docs](https://drill.apache.org/docs/rest-api-introduction/)
 
-Get profiles
+### 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 profile by query id
+Get the profile of a query
 
 ```ruby
 drill.profiles(query_id)
 ```
 
-Get storage
+Cancel a query
+
+```ruby
+drill.cancel_query(query_id)
+```
+
+### Storage
+
+List storage plugins
 
 ```ruby
 drill.storage
 ```
 
-Get storage by name
+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
@@ -84,27 +140,27 @@ drill.options
 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-sergeant.git
-cd drill-sergeant
+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.4"
+module Drill
+  VERSION = "0.3.0"
 end

data/lib/drill-sergeant.rb

@@ -1,119 +1,16 @@
-# dependencies
+# stdlib
 require "cgi"
 require "json"
 require "net/http"
 
 # modules
-require "drill/version"
+require_relative "drill/client"
+require_relative "drill/version"
 
-# TODO make module and move to client
-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"
-    # 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")
+  def self.new(**options)
+    Client.new(**options)
   end
 end

metadata

@@ -1,59 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: drill-sergeant
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.3.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-16 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'
+date: 2024-10-23 00:00:00.000000000 Z
+dependencies: []
 description:
-email: andrew@chartkick.com
+email: andrew@ankane.org
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -62,8 +20,9 @@ files:
 - 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: {}
@@ -75,14 +34,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: Ruby client for Apache Drill