click_house 1.0.0

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'click_house'
+require 'pry'
+
+ClickHouse.config do |config|
+  config.logger = Logger.new(STDOUT)
+end
+
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/click_house.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'click_house/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'click_house'
+  spec.version       = ClickHouse::VERSION
+  spec.authors       = ['Aliaksandr Shylau']
+  spec.email         = ['alex.shilov.by@gmail.com']
+  spec.summary       = 'Modern Ruby database driver for ClickHouse'
+  spec.description   = 'Yandex ClickHouse database interface for Ruby'
+  spec.homepage      = 'https://github.com/shlima/click_house'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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_dependency 'faraday'
+  spec.add_dependency 'faraday_middleware'
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-performance'
+end

data/doc/logo.svg

@@ -0,0 +1,37 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg width="150px" height="170px" viewBox="0 0 15 17" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
+    <!-- Generator: Sketch 54.1 (76490) - https://sketchapp.com -->
+    <title>Group</title>
+    <desc>Created with Sketch.</desc>
+    <defs>
+        <linearGradient x1="50%" y1="0%" x2="50%" y2="100%" id="linearGradient-1">
+            <stop stop-color="#FFE800" offset="0%"></stop>
+            <stop stop-color="#FFCC00" stop-opacity="0" offset="100%"></stop>
+        </linearGradient>
+        <linearGradient x1="50%" y1="0%" x2="50%" y2="100%" id="linearGradient-2">
+            <stop stop-color="#FFE800" stop-opacity="0.99" offset="0%"></stop>
+            <stop stop-color="#FFCC00" stop-opacity="0" offset="100%"></stop>
+        </linearGradient>
+    </defs>
+    <g id="Page-1" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd">
+        <g id="Group">
+            <g transform="translate(3.000000, 5.000000)" id="Path">
+                <polygon fill="url(#linearGradient-1)" fill-rule="nonzero" points="0 0 2 0 2 12 0 12"></polygon>
+                <polygon fill="url(#linearGradient-2)" fill-rule="nonzero" points="3 0 5 0 5 12 3 12"></polygon>
+                <polygon fill="url(#linearGradient-1)" fill-rule="nonzero" points="6 0 8 0 8 12 6 12"></polygon>
+            </g>
+            <g id="68747470733a2f2f63646e2e7261776769742e636f6d2f636c61726976652f636c612d727562792d706c7567696e2f6d61737465722f7075626c69632f69636f6e2f727562792e7376673f73616e6974697a653d74727565">
+                <g id="Group-2" fill-rule="nonzero">
+                    <polygon id="Path" fill="#CE0000" points="4.5 3.2 9.8 3.2 7.1 11.2"></polygon>
+                    <polygon id="Path" fill="#7C0000" points="9.7 3.2 14.1 3.2 7.1 11.1"></polygon>
+                    <polygon id="Path" fill="#F87274" points="4.5 3.2 0.1 3.2 7.1 11.1"></polygon>
+                    <polygon id="Path" fill="#F87274" points="2.4 0.1 4.5 3.3 7.1 0.1"></polygon>
+                    <polygon id="Path" fill="#FB191D" points="7.1 0.1 9.7 3.3 11.7 0.1"></polygon>
+                    <polygon id="Path" fill="#CC0001" points="9.7 3.2 11.7 4.4408921e-16 14.2 3.2"></polygon>
+                    <polygon id="Path" fill="#FB191D" points="-8.8817842e-16 3.2 2.4 4.4408921e-16 4.6 3.2"></polygon>
+                    <polygon id="Path" fill="#900000" points="4.5 3.2 7.1 4.4408921e-16 9.8 3.2"></polygon>
+                </g>
+            </g>
+        </g>
+    </g>
+</svg>

data/docker-compose.yml

@@ -0,0 +1,21 @@
+version: '3.5'
+
+services:
+  clickhouse:
+    image: yandex/clickhouse-server
+    ports:
+      - "8123:8123"
+      - "9000:9000"
+      - "9009:9009"
+    ulimits:
+      nproc: 65535
+      nofile:
+        soft: 262144
+        hard: 262144
+    volumes:
+      - ./tmp/clickhouse-data:/opt/clickhouse/data
+    networks:
+      - default
+
+networks:
+  default:

data/lib/click_house.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'date'
+require 'json'
+require 'csv'
+require 'uri'
+require 'logger'
+require 'faraday'
+require 'forwardable'
+require 'bigdecimal'
+require 'faraday_middleware'
+require 'click_house/version'
+require 'click_house/errors'
+require 'click_house/response'
+require 'click_house/type'
+require 'click_house/middleware'
+require 'click_house/extend'
+require 'click_house/util'
+require 'click_house/definition'
+
+module ClickHouse
+  extend Extend::TypeDefinition
+  extend Extend::Configurable
+  extend Extend::Connectible
+
+  autoload :Config, 'click_house/config'
+  autoload :Connection, 'click_house/connection'
+
+  %w[Date].each do |column|
+    add_type column, Type::DateType.new
+    add_type "Nullable(#{column})", Type::NullableType.new(Type::DateType.new)
+  end
+
+  ['DateTime(%s)'].each do |column|
+    add_type column, Type::DateTimeType.new
+    add_type "Nullable(#{column})", Type::NullableType.new(Type::DateTimeType.new)
+  end
+
+  ['Decimal(%s, %s)', 'Decimal32(%s)', 'Decimal64(%s)', 'Decimal128(%s)'].each do |column|
+    add_type column, Type::DecimalType.new
+    add_type "Nullable(#{column})", Type::NullableType.new(Type::DecimalType.new)
+  end
+
+  %w[UInt8 UInt16 UInt32 UInt64 Int8 Int16 Int32 Int64].each do |column|
+    add_type column, Type::IntegerType.new
+    add_type "Nullable(#{column})", Type::NullableType.new(Type::IntegerType.new)
+  end
+
+  %w[Float32 Float64].each do |column|
+    add_type column, Type::FloatType.new
+    add_type "Nullable(#{column})", Type::NullableType.new(Type::IntegerType.new)
+  end
+end

data/lib/click_house/config.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module ClickHouse
+  class Config
+    DEFAULT_SCHEME = 'http'
+    DEFAULT_HOST = 'localhost'
+    DEFAULT_PORT = '8123'
+
+    DEFAULTS = {
+      adapter: Faraday.default_adapter,
+      url: nil,
+      scheme: 'http',
+      host: 'localhost',
+      port: '8123',
+      logger: nil,
+      database: nil,
+      username: nil,
+      password: nil,
+      timeout: nil,
+      open_timeout: nil,
+      ssl_verify: false
+    }.freeze
+
+    attr_accessor :adapter
+    attr_accessor :logger
+    attr_accessor :scheme
+    attr_accessor :host
+    attr_accessor :port
+    attr_accessor :database
+    attr_accessor :url
+    attr_accessor :username
+    attr_accessor :password
+    attr_accessor :timeout
+    attr_accessor :open_timeout
+    attr_accessor :ssl_verify
+
+    def initialize(params = {})
+      assign(DEFAULTS.merge(params))
+      yield(self) if block_given?
+    end
+
+    # @return [self]
+    def assign(params = {})
+      params.each { |k, v| public_send("#{k}=", v) }
+
+      self
+    end
+
+    def auth?
+      !username.nil? || !password.nil?
+    end
+
+    def logger!
+      @logger || Logger.new('/dev/null')
+    end
+
+    def url!
+      @url || "#{scheme}://#{host}:#{port}"
+    end
+  end
+end

data/lib/click_house/connection.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module ClickHouse
+  class Connection
+    include Extend::ConnectionHealthy
+    include Extend::ConnectionDatabase
+    include Extend::ConnectionTable
+    include Extend::ConnectionSelective
+    include Extend::ConnectionInserting
+
+    attr_reader :config
+
+    def initialize(config)
+      @config = config
+    end
+
+    def execute(query, body = nil, database: config.database)
+      post(body, query: { query: query }, database: database)
+    end
+
+    def get(path = '/', query: {}, database: config.database)
+      transport.get(compose(path, query.merge(database: database)))
+    end
+
+    def post(body = nil, query: {}, database: config.database)
+      transport.post(compose('/', query.merge(database: database)), body)
+    end
+
+    def transport
+      @transport ||= Faraday.new(config.url!) do |conn|
+        conn.options.timeout = config.timeout
+        conn.options.open_timeout = config.open_timeout
+        conn.ssl.verify = config.ssl_verify
+        conn.basic_auth(config.username, config.password) if config.auth?
+        conn.response Middleware::Logging, logger: config.logger!
+        conn.response Middleware::RaiseError
+        conn.response :json, content_type: %r{application/json}
+        conn.response Middleware::ParseCsv, content_type: %r{text/csv}
+        conn.adapter config.adapter
+      end
+    end
+
+    def compose(path, query = {})
+      # without <query.compact> "DB::Exception: Empty query" error will occur
+      "#{path}?#{URI.encode_www_form({ send_progress_in_http_headers: 1 }.merge(query).compact)}"
+    end
+  end
+end

data/lib/click_house/definition.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module ClickHouse
+  module Definition
+    autoload :Column, 'click_house/definition/column'
+    autoload :ColumnSet, 'click_house/definition/column_set'
+  end
+end

data/lib/click_house/definition/column.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module ClickHouse
+  module Definition
+    class Column
+      attr_accessor :name
+      attr_accessor :type
+      attr_accessor :nullable
+      attr_accessor :extensions
+      attr_accessor :default
+      attr_accessor :materialized
+      attr_accessor :ttl
+
+      def initialize(params = {})
+        params.each { |k, v| public_send("#{k}=", v) }
+        yield(self) if block_given?
+      end
+
+      def to_s
+        nullable ? "#{name} Nullable(#{extension_type}) #{opts}" : "#{name} #{extension_type} #{opts}"
+      end
+
+      private
+
+      def opts
+        options = {
+          DEFAULT: Util::Statement.ensure(default, default),
+          MATERIALIZED: Util::Statement.ensure(materialized, materialized),
+          TTL: Util::Statement.ensure(ttl, ttl)
+        }.compact
+
+        result = options.each_with_object([]) do |(key, value), object|
+          object << "#{key} #{value}"
+        end
+
+        result.join(' ')
+      end
+
+      def extension_type
+        extensions.nil? ? type : format(type, *extensions)
+      rescue TypeError, ArgumentError
+        raise Exception, "please provide extensions for <#{type}>"
+      end
+    end
+  end
+end

data/lib/click_house/definition/column_set.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module ClickHouse
+  module Definition
+    class ColumnSet
+      TYPES = [
+        'UInt8', 'UInt16', 'UInt32', 'UInt64', 'Int8', 'Int16', 'Int32', 'Int64',
+        'Float32', 'Float64',
+        'Decimal(%d, %d)', 'Decimal32(%d)', 'Decimal64(%d)', 'Decimal128(%d)',
+        'String',
+        'FixedString(%d)',
+        'UUID',
+        'Date',
+        "DateTime('%s')"
+      ].freeze
+
+      class << self
+        # @input "DateTime('%s')"
+        # @output "DateTime"
+        def method_name_for_type(type)
+          type.sub(/\(.+/, '')
+        end
+      end
+
+      TYPES.each do |type|
+        method_name = method_name_for_type(type)
+
+        # t.Decimal :customer_id, nullable: true, default: ''
+        # t.Decimal :money, 1, 2, nullable: true, default: ''
+        class_eval <<-METHODS, __FILE__, __LINE__ + 1
+          def #{method_name}(*definition)
+            name = definition[0]
+            extentions = []
+            options = {}
+            extensions = Array(definition[1..-1]).each do |el|
+              el.is_a?(Hash) ? options.merge!(el) : extentions.push(el)
+            end
+
+            columns << Column.new(type: "#{type}", name: name, extensions: extensions, **options)
+          end
+        METHODS
+      end
+
+      def initialize
+        yield(self) if block_given?
+      end
+
+      def columns
+        @columns ||= []
+      end
+
+      def to_s
+        <<~SQL
+          ( #{columns.map(&:to_s).join(', ')} )
+        SQL
+      end
+
+      # @example
+      #   t.Nested :json do |n|
+      #     n.UInt8 :city_id
+      #   end
+      def nested(name, &block)
+        columns << "#{name} Nested #{ColumnSet.new(&block)}"
+      end
+
+      alias_method :Nested, :nested
+
+      def push(sql)
+        columns << sql
+      end
+
+      alias_method :<<, :push
+    end
+  end
+end
+
+__END__
+
+data = ClickHouse::Definition::ColumnSet.new do |t|
+  t << "words Enum('hello' = 1, 'world' = 2)"
+end
+
+puts data.to_s
+
+data = ClickHouse::Definition::ColumnSet.new do |t|
+  t.Decimal :money
+  t.Float32 :client_id, default: 0
+  t.Float32 :city_id, default: 0, nullable: true
+  t.Nested :json do |n|
+    n.Date :created_at
+    n.Date :updated_at
+  end
+
+  t << "CUSTOM SQL"
+end

data/lib/click_house/errors.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ClickHouse
+  Error = Class.new(StandardError)
+  NetworkException = Class.new(Error)
+  DbException = Class.new(Error)
+end