druid_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d0995de7f57ebb5a4b1b5fb39f3bd08378073d814289f3bc02e530edb3aabd53
+  data.tar.gz: 27330ecf9f06410fa5a30d9b02c6fc9c63dd3a0bbc02f54b3bc88938c633f369
+SHA512:
+  metadata.gz: '081b22325e38beadd31c03636c1f26300a4f8bd8070984de6524206789d15fca97fe9d2691f52b5e15c81fdb5e41934856f8db1eaac58b6b86b20e499ede676c'
+  data.tar.gz: 6a28949b4fcd34210bb5cc7f38aa39d8271ab902e677bd868bc65e23bb250034f9d490bf56caa37cbceadd02cf75444d82b366dd3177a6c151098088325f1b0b

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Thomas Tych
+
+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

@@ -0,0 +1,39 @@
+# DruidClient
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/druid_client`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/druid_client.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'minitest/test_task'
+
+Minitest::TestTask.create(:test) do |t|
+  t.libs << 'test'
+  t.warning = false
+  t.test_globs = ['test/**/*_test.rb', 'test/**/test_*.rb']
+end
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+require 'bump/tasks'
+
+task default: %i[test rubocop]

data/extra/fake_druid_api.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+# rubocop:disable Metrics/BlockLength,Style/GlobalVars
+
+# fake Druid API
+# launch with ruby fake_druid_api.rb
+
+require 'sinatra'
+
+# SQL query
+post '/druid/v2/sql' do
+  auth = Rack::Auth::Basic::Request.new(request.env)
+  username, password = auth.credentials if auth.provided? && auth.basic?
+  headers = request.env.select { |k, v| k.start_with? 'HTTP_' }
+
+  puts "# basic auth: #{username}, #{password}"
+  puts "# headers: #{headers}"
+
+  $call_count ||= 0
+  $call_count += 1
+  case $call_count % 3
+  when 0
+    status 200
+  when 1
+    status 400
+  when 2
+    status 500
+  end
+  content_type :json
+
+  response_headers = {
+    'X-Custom-Header-1' => 'h1',
+    'X-Custom-Header-2' => 'h2',
+    'X-Custom-username' => username,
+    'X-Custom-password' => password
+  }
+
+  headers response_headers
+  [
+    {
+      my_count: {
+        type: 'LONG',
+        sqlType: 'BIGINT'
+      }
+    },
+    {
+      my_count: 123_456_789
+    }
+  ].to_json
+end
+
+# rubocop:enable all

data/lib/druid_client/api/client.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative '../druid_config'
+require_relative 'rest_client'
+require_relative 'sql'
+
+module DruidClient
+  module Api
+    class Client
+      attr_reader :druid_config
+
+      def initialize(druid_config:)
+        @druid_config = druid_config
+        @druid_config.verify!
+      end
+
+      def sql
+        @sql ||= Api::Sql.new(rest_client: rest_client)
+      end
+
+      def rest_client
+        @rest_client ||= RestClient.new(druid_config)
+      end
+
+      class << self
+        def build(**)
+          druid_config = DruidConfig.new(**)
+          new(druid_config: druid_config)
+        end
+      end
+    end
+  end
+end

data/lib/druid_client/api/resource.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+module DruidClient
+  module Api
+    class Resource
+      extend Forwardable
+
+      def_delegators :@rest_client, :get, :post, :patch, :put, :delete
+
+      def initialize(rest_client:)
+        @rest_client = rest_client
+      end
+    end
+  end
+end

data/lib/druid_client/api/response.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module DruidClient
+  module Api
+    class Response
+      attr_reader :status_code, :body, :headers, :elapsed_time
+
+      def initialize(status_code:, body:, headers: {}, elapsed_time: nil)
+        @status_code = status_code
+        @body = body
+        @headers = headers
+        @elapsed_time = elapsed_time
+      end
+
+      def success?
+        return false unless status_code
+
+        200.299.include?(status_code)
+      end
+
+      def error?
+        !success?
+      end
+
+      def to_s
+        "#<Response status_code=#{status_code} elapsed_time=#{elapsed_time}s>"
+      end
+    end
+  end
+end

data/lib/druid_client/api/rest_client.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+require 'faraday'
+
+require_relative 'response'
+
+module DruidClient
+  module Api
+    class RestClient
+      attr_reader :url, :log, :options
+
+      def initialize(options = {})
+        @options = options
+        @url = options[:url]
+        @log = options[:log]
+      end
+
+      def get(path, params: {}, headers: {})
+        request(:get, path, params: params, headers: headers)
+      end
+
+      def post(path, body: nil, headers: {})
+        request(:post, path, body: body, headers: headers)
+      end
+
+      def put(path, body: nil, headers: {})
+        request(:put, path, body: body, headers: headers)
+      end
+
+      def patch(path, body: nil, headers: {})
+        request(:patch, path, body: body, headers: headers)
+      end
+
+      def delete(path, params: {}, headers: {})
+        request(:delete, path, params: params, headers: headers)
+      end
+
+      def request(method, path, body: nil, params: {}, headers: {})
+        File.join(url, path)
+        start_time = Time.now
+        response = client.send(method) do |req|
+          req.url path
+          req.headers.merge!(headers)
+          req.body = body.to_json if body
+        end
+        elapsed_time = Time.now - start_time
+        Response.new(
+          status_code: response.status,
+          headers: response.headers,
+          body: response.body,
+          elapsed_time: elapsed_time
+        )
+      rescue Faraday::Error => e
+        elapsed_time = Time.now - start_time
+        Response.new(status_code: 0, body: e.message, elapsed_time: elapsed_time)
+      end
+
+      def client_options
+        {
+          url: url,
+          headers: { 'User-Agent' => user_agent }.compact,
+          request: { timeout: timeout }.compact,
+          ssl: { ca_file: ca_file,
+                 ca_path: ca_path,
+                 verify: verify_ssl }.compact
+        }
+      end
+
+      def client
+        @client ||= Faraday.new(client_options) do |conn|
+          conn.request :authorization, :basic, basic_username, basic_password if basic_auth?
+          conn.request :json
+          conn.response :json
+          if log
+            conn.response :logger, log, headers: options[:log_headers], bodies: options[:log_bodies],
+                                        log_level: :debug
+          end
+          conn.adapter Faraday.default_adapter
+        end
+      end
+
+      def base_headers
+        options[:headers] || {}
+      end
+
+      def basic_auth?
+        basic_username && basic_password
+      end
+
+      def basic_username
+        options[:username]
+      end
+
+      def basic_password
+        options[:password]
+      end
+
+      def user_agent
+        options[:user_agent]
+      end
+
+      def timeout
+        options[:timeout]
+      end
+
+      def ca_file
+        options[:ca_file]
+      end
+
+      def ca_path
+        options[:ca_path]
+      end
+
+      def verify_ssl
+        options[:verify_ssl]
+      end
+    end
+  end
+end

data/lib/druid_client/api/sql.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require_relative 'resource'
+
+module DruidClient
+  module Api
+    class Sql < Resource
+      SQL_PATH = '/druid/v2/sql'
+
+      QUERY_RESULT_FORMATS = %i[object
+                                array
+                                objectLines
+                                arrayLines
+                                csv].freeze
+      QUERY_RESULT_FORMAT = QUERY_RESULT_FORMATS.first
+      QUERY_HEADER = true
+      QUERY_TYPES_HEADER = true
+      QUERY_SQL_TYPES_HEADER = true
+      QUERY_PARAMETERS = [].freeze
+      QUERY_CONTEXT = {}.freeze
+
+      def query(query:,
+                result_format: QUERY_RESULT_FORMAT,
+                header: QUERY_HEADER,
+                types_header: QUERY_TYPES_HEADER,
+                sql_types_header: QUERY_SQL_TYPES_HEADER,
+                parameters: QUERY_PARAMETERS,
+                context: QUERY_CONTEXT)
+        query_body = {
+          query: query.to_s,
+          parameters: parameters.to_a,
+          resultFormat: result_format.to_s,
+          header: header,
+          typesHeader: types_header,
+          sqlTypesHeader: sql_types_header,
+          context: context.to_h
+        }
+        post(SQL_PATH, body: query_body)
+      end
+
+      def cancel_query(query_id:)
+        delete("#{SQL_PATH}/#{query_id}")
+      end
+    end
+  end
+end

data/lib/druid_client/api.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative 'api/client'
+
+module DruidClient
+  module Api
+    def self.new(...)
+      DruidClient::Api::Client.build(...)
+    end
+  end
+end

data/lib/druid_client/druid_config.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative 'error'
+
+module DruidClient
+  class DruidConfig
+    DEFAULTS = {
+      url: 'http://localhost:8888',
+      user_agent: 'druid_client.rb',
+      timeout: 30,
+      verify_ssl: true,
+      log_headers: false,
+      log_bodies: false
+    }.freeze
+
+    def initialize(**options)
+      @options = DEFAULTS.merge(options)
+
+      yield self if block_given?
+    end
+
+    def verify!
+      return if @options[:url].to_s.size.positive?
+
+      raise ConfigError, 'Missing url in DruidConfig'
+    end
+
+    def keys
+      @options.keys
+    end
+
+    def [](key)
+      @options[key]
+    end
+  end
+end

data/lib/druid_client/error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module DruidClient
+  class Error < StandardError; end
+  class ConfigError < Error; end
+end

data/lib/druid_client/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module DruidClient
+  VERSION = '0.1.0'
+end

data/lib/druid_client.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative 'druid_client/version'
+require_relative 'druid_client/api'
+
+module DruidClient
+  def self.api(...)
+    DruidClient::Api.new(...)
+  end
+end

data/sig/druid_client.rbs

@@ -0,0 +1,4 @@
+module DruidClient
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,276 @@
+--- !ruby/object:Gem::Specification
+name: druid_client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Thomas Tych
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bump
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: irb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.15.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.15.2
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.25'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.25.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.25'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.25.5
+- !ruby/object:Gem::Dependency
+  name: minitest-focus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.81'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.81.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.81'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.81.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.38'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.38.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.38'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.38.2
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: gli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.22'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.22.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.22'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.22.2
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: Apache Druid DB client
+email:
+- thomas.tych@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- extra/fake_druid_api.rb
+- lib/druid_client.rb
+- lib/druid_client/api.rb
+- lib/druid_client/api/client.rb
+- lib/druid_client/api/resource.rb
+- lib/druid_client/api/response.rb
+- lib/druid_client/api/rest_client.rb
+- lib/druid_client/api/sql.rb
+- lib/druid_client/druid_config.rb
+- lib/druid_client/error.rb
+- lib/druid_client/version.rb
+- sig/druid_client.rbs
+homepage: https://gitlab.com/ttych/druid_client.rb
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://gitlab.com/ttych/druid_client.rb
+  source_code_uri: https://gitlab.com/ttych/druid_client.rb
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Apache Druid DB client
+test_files: []