crate_ruby 0.0.9 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7e341cd1fe4282c3dedd29e547b99d0b21c47dff
-  data.tar.gz: 8bab3933fea54fbaa6026c1226d37842a241803a
+SHA256:
+  metadata.gz: 527d9c75e305c5d0bdff4ad77d5a8268ee2e172926dc252e8f2c7cff19e4189c
+  data.tar.gz: 99454b1e16d97746418602c7c82fb6feeb56dd9dfaddaa4259635928d9a9ffcf
 SHA512:
-  metadata.gz: 4be61df43ff7bfe34d8098523a9096bcb2e6ebdf99913d17834b12a9e372c4ee3a4fc87d772acb052353b87d491a6f6563601b35e0f845346ccdf3bd97bf6b4a
-  data.tar.gz: 79e1e90745e375d1aa8c4aaa7600d18ed6c0e44e708ffd2391e9eeaa855f8024fb00682025015553bb1d7b9aa8c53ca0f2cbaa802b0355d6c64440eafcb0f9e8
+  metadata.gz: 39fc95a25b3efb6630454bb7f6c120f6d8e980d67ab4442a147b48c783ca534fd929e8a0f030c57e22d5a6ca860da9f1ba3dc7fa0471360d48c0c47ad990a8fe
+  data.tar.gz: 6075a190c28ed1ff3b4ad455b9db7413abb67f1afc29bffcb1f61d1ae43fd7e177cee54f5c318545cf17c526f2176a77d179e80765733245fdafc41fe7ec0d9d

data/.travis.yml

@@ -4,11 +4,12 @@ rvm:
   - "2.1.5"
   - "2.2.0"
   - "2.4.2"
-sudo:
-  false
+
 before_script:
   - bundle exec ruby spec/bootstrap.rb
+
 script:
   bundle exec rspec spec
+
 before_install:
   - gem update bundler

data/DEVELOP.rst

@@ -24,7 +24,7 @@ To create a new release, you must:
 
 - Commit your changes with a message like "prepare release x.y.z"
 
-- Push to origin
+- Push to ``origin/master``
 
 - Create a tag by running ``./devtools/create_tag.sh``
 

data/README.rst

@@ -82,6 +82,29 @@ Manipulate BLOBs like so::
     # deletion
     client.blob_delete(table_name, digest)
 
+Schema support
+
+    A default schema can be set by passing in the schema name::
+
+    CrateRuby::Client.new(['localhost:44200'], schema: 'my_schema')
+
+Authentication
+
+    Authentication credentials can be passed to the client if needed::
+
+    CrateRuby::Client.new(['localhost:44200'], username: 'foo', password: 'supersecret')
+
+
+Version matrix
+==============
++--------------+------------+
+| Crate Ruby   | CrateDB    |
++==============+============+
+| < 0.9        | < 0.57     |
++--------------+------------+
+| 0.9          | >= 0.57    |
++--------------+------------+
+
 Contributing
 ============
 

data/crate_ruby.gemspec

@@ -31,7 +31,7 @@ Gem::Specification.new do |spec|
   spec.summary       = "A simple interface for the Crate.IO database."
   spec.description   = "A Ruby interface for Crate.IO. Put your data to work. Simply."
   spec.homepage      = "http://crate.io"
-  spec.license       = "Apache License, v2.0"
+  spec.license       = "Apache-2.0"
   spec.required_ruby_version = '>= 2.0'
 
   spec.files         = `git ls-files -z`.split("\x0")

data/devtools/create_tag.sh

@@ -48,7 +48,7 @@ fi
 
 # get version from version.rb
 VERSION=$(grep "VERSION =" lib/crate_ruby/version.rb | \
-    cut -d' ' -f5 | tr -d "\'")
+    cut -d' ' -f5 | tr -d "\'" | sed -e "s/.freeze//")
 echo "Version: $VERSION"
 
 # check if tag to create has already been created

data/history.txt

@@ -1,4 +1,6 @@
 # coding: UTF-8
+=== 0.1.0
+  * HTTP Basic Authentication support that comes with 2.3.0
 
 === 0.0.9
 

data/lib/crate_ruby.rb

@@ -1,4 +1,3 @@
-# -*- coding: utf-8; -*-
 #
 # Licensed to CRATE Technology GmbH ("Crate") under one or more contributor
 # license agreements.  See the NOTICE file distributed with this work for
@@ -19,16 +18,14 @@
 # with Crate these terms will supersede the license and you may use the
 # software solely pursuant to the terms of the relevant commercial agreement.
 
-require "crate_ruby/version"
-require "crate_ruby/error"
+require 'crate_ruby/version'
+require 'crate_ruby/error'
 require 'crate_ruby/result_set'
 require 'crate_ruby/client'
-require 'crate_ruby/utils'
 
 include CrateRuby
 
 module CrateRuby
-
   def self.logger
     @logger ||= begin
       require 'logger'
@@ -41,5 +38,4 @@ module CrateRuby
   def self.logger=(logger)
     @logger = logger
   end
-
 end

data/lib/crate_ruby/client.rb

@@ -1,4 +1,3 @@
-# -*- coding: utf-8; -*-
 #
 # Licensed to CRATE Technology GmbH ("Crate") under one or more contributor
 # license agreements.  See the NOTICE file distributed with this work for
@@ -21,99 +20,114 @@
 
 require 'json'
 require 'net/http'
+require 'base64'
+
 module CrateRuby
+  # Client to interact with Crate.io DB
   class Client
-    DEFAULT_HOST = "127.0.0.1"
-    DEFAULT_PORT = "4200"
+    DEFAULT_HOST = '127.0.0.1'.freeze
+    DEFAULT_PORT = '4200'.freeze
 
-    attr_accessor :logger
+    attr_accessor :logger, :schema, :username, :password
 
     # Currently only a single server is supported. Fail over will be implemented in upcoming versions
     # @param [Array] servers An Array of servers including ports [127.0.0.1:4200, 10.0.0.1:4201]
-    # @param [opts] Optional paramters
+    # @param [opts] opts Optional parameters
     # * logger: Custom Logger
     # * http_options [Hash]: Net::HTTP options (open_timeout, read_timeout)
+    # * schema [String]: Default schema to search in
     # @return [CrateRuby::Client]
     def initialize(servers = [], opts = {})
       @servers = servers
       @servers << "#{DEFAULT_HOST}:#{DEFAULT_PORT}" if servers.empty?
       @logger = opts[:logger] || CrateRuby.logger
       @http_options = opts[:http_options] || { read_timeout: 3600 }
+      @schema = opts[:schema] || 'doc'
+      @username = opts[:username]
+      @password = opts[:password]
     end
 
     def inspect
-      %Q{#<CrateRuby::Client:#{object_id}>}
+      %(#<CrateRuby::Client:#{object_id}>)
     end
 
     # Creates a table
     #     client.create_table "posts", id: [:integer, "primary key"], my_column: :string, my_integer_col: :integer
     # @param [String] table_name
     # @param [Hash] column_definition
-    # @option column_definition [String] key sets column name, value sets column type. an array passed as value can be used to set options like primary keys
+    # @option column_definition [String] key sets column name, value sets column type. an array passed as value can
+    # be used to set options like primary keys
     # @return [ResultSet]
     #
-    def create_table(table_name, column_definition = {}, blob=false)
+    def create_table(table_name, column_definition = {})
       cols = column_definition.to_a.map { |a| a.join(' ') }.join(', ')
-      stmt = %Q{CREATE TABLE "#{table_name}" (#{cols})}
+      stmt = %{CREATE TABLE "#{table_name}" (#{cols})}
       execute(stmt)
     end
 
     # Creates a table for storing blobs
     # @param [String] name Table name
-    # @param [Integer] shard Shard count, defaults to 5
-    # @param [Integer] number Number of replicas, defaults to 0
+    # @param [Integer] shard_count Shard count, defaults to 5
+    # @param [Integer] replicas Number of replicas, defaults to 0
     # @return [ResultSet]
     #
     # client.create_blob_table("blob_table")
-    def create_blob_table(name, shard_count=5, replicas=0)
-      stmt = "create blob table #{name} clustered into #{shard_count} shards with (number_of_replicas=#{replicas})"
-      execute stmt
+    def create_blob_table(name, shard_count = 5, replicas = 0)
+      stmt = %{CREATE BLOB TABLE "#{name}" CLUSTERED INTO ? SHARDS WITH (number_of_replicas=?)}
+      execute stmt, [shard_count, replicas]
     end
 
     # Drop table
     # @param [String] table_name, Name of table to drop
     # @param [Boolean] blob Needs to be set to true if table is a blob table
     # @return [ResultSet]
-    def drop_table(table_name, blob=false)
-      tbl = blob ? "BLOB TABLE" : "TABLE"
-      stmt = %Q{DROP #{tbl} "#{table_name}"}
+    def drop_table(table_name, blob = false)
+      tbl = blob ? 'BLOB TABLE' : 'TABLE'
+      stmt = %(DROP #{tbl} "#{table_name}")
       execute(stmt)
     end
 
     # List all user tables
     # @return [ResultSet]
     def show_tables
-      execute("select table_name from information_schema.tables where table_schema = 'doc'")
+      execute('select table_name from information_schema.tables where table_schema = ?', [schema])
     end
 
     # Returns all tables in schema 'doc'
-    # @return [Array] Array of table names
+    # @return [Array<String>] Array of table names
     def tables
-      execute("select table_name from information_schema.tables where table_schema = 'doc'").map(&:first)
+      execute('select table_name from information_schema.tables where table_schema = ?', [schema]).map(&:first)
+    end
+
+    # Returns all tables in schema 'blob'
+    # @return [Array<String>] Array of blob tables
+    def blob_tables
+      execute('select table_name from information_schema.tables where table_schema = ?', ['blob']).map(&:first)
     end
 
     # Executes a SQL statement against the Crate HTTP REST endpoint.
     # @param [String] sql statement to execute
     # @param [Array] args Array of values used for parameter substitution
-    # @param [Hash] Net::HTTP options (open_timeout, read_timeout)
+    # @param [Array] bulk_args List of lists containing records to be processed
+    # @param [Hash] http_options Net::HTTP options (open_timeout, read_timeout)
     # @return [ResultSet]
     def execute(sql, args = nil, bulk_args = nil, http_options = {})
       @logger.debug sql
-      req = Net::HTTP::Post.new("/_sql", initheader = {'Content-Type' => 'application/json'})
-      body = {"stmt" => sql}
-      body.merge!({'args' => args}) if args
-      body.merge!({'bulk_args' => bulk_args}) if bulk_args
+      req = Net::HTTP::Post.new('/_sql', headers)
+      body = { 'stmt' => sql }
+      body['args'] = args if args
+      body['bulk_args'] = bulk_args if bulk_args
       req.body = body.to_json
       response = request(req, http_options)
       @logger.debug response.body
-      success = case response.code
-                  when /^2\d{2}/
-                    ResultSet.new response.body
-                  else
-                    @logger.info(response.body)
-                    raise CrateRuby::CrateError.new(response.body)
-                end
-      success
+
+      case response.code
+      when /^2\d{2}/
+        ResultSet.new response.body
+      else
+        @logger.info(response.body)
+        raise CrateRuby::CrateError, response.body
+      end
     end
 
     # Upload a File to a blob table
@@ -123,17 +137,16 @@ module CrateRuby
     def blob_put(table, digest, data)
       uri = blob_path(table, digest)
       @logger.debug("BLOB PUT #{uri}")
-      req = Net::HTTP::Put.new(blob_path(table, digest))
+      req = Net::HTTP::Put.new(blob_path(table, digest), headers)
       req.body = data
       response = request(req)
-      success = case response.code
-                  when "201"
-                    true
-                  else
-                    @logger.info("Response #{response.code}: " + response.body)
-                    false
-                end
-      success
+      case response.code
+      when '201'
+        true
+      else
+        @logger.info("Response #{response.code}: " + response.body)
+        false
+      end
     end
 
     # Download blob
@@ -144,14 +157,14 @@ module CrateRuby
     def blob_get(table, digest)
       uri = blob_path(table, digest)
       @logger.debug("BLOB GET #{uri}")
-      req = Net::HTTP::Get.new(uri)
+      req = Net::HTTP::Get.new(uri, headers)
       response = request(req)
       case response.code
-        when "200"
-          response.body
-        else
-          @logger.info("Response #{response.code}: #{response.body}")
-          false
+      when '200'
+        response.body
+      else
+        @logger.info("Response #{response.code}: #{response.body}")
+        false
       end
     end
 
@@ -163,31 +176,30 @@ module CrateRuby
     def blob_delete(table, digest)
       uri = blob_path(table, digest)
       @logger.debug("BLOB DELETE #{uri}")
-      req = Net::HTTP::Delete.new(uri)
+      req = Net::HTTP::Delete.new(uri, headers)
       response = request(req)
-      success = case response.code
-                  when "200"
-                    true
-                  else
-                    @logger.info("Response #{response.code}: #{response.body}")
-                    false
-                end
-      success
+      case response.code
+      when '200'
+        true
+      else
+        @logger.info("Response #{response.code}: #{response.body}")
+        false
+      end
     end
 
-
     # Return the table structure
     # @param [String] table_name Table name to get structure
     # @param [ResultSet]
     def table_structure(table_name)
-      execute("select * from information_schema.columns where table_schema = 'doc' AND table_name = '#{table_name}'")
+      execute('select * from information_schema.columns where table_schema = ?' \
+              'AND table_name = ?', [schema, table_name])
     end
 
-
     def insert(table_name, attributes)
       vals = attributes.values
-      binds = vals.count.times.map {|i| "$#{i+1}"}.join(',')
-      stmt = %Q{INSERT INTO "#{table_name}" (#{attributes.keys.join(', ')}) VALUES(#{binds})}
+      identifiers = attributes.keys.map {|v| %{"#{v}"} }.join(', ')
+      binds = vals.count.times.map { |i| "$#{i + 1}" }.join(',')
+      stmt = %{INSERT INTO "#{table_name}" (#{identifiers}) VALUES(#{binds})}
       execute(stmt, vals)
     end
 
@@ -207,7 +219,7 @@ module CrateRuby
     end
 
     def connection
-      host, port = @servers.first.split(':');
+      host, port = @servers.first.split(':')
       Net::HTTP.new(host, port)
     end
 
@@ -219,5 +231,16 @@ module CrateRuby
       end
     end
 
+    def headers
+      header = { 'Content-Type' => 'application/json', 'Accept' => 'application/json' }
+      header['Default-Schema'] = schema if schema
+      header['Authorization'] =  "Basic #{encrypted_credentials}" if username
+      header['X-User'] = username if username # for backwards compatibility with Crate 2.2
+      header
+    end
+
+    def encrypted_credentials
+      @encrypted_credentials ||= Base64.encode64 "#{username}:#{password}"
+    end
   end
 end

data/lib/crate_ruby/error.rb

@@ -1,4 +1,3 @@
-# -*- coding: utf-8; -*-
 #
 # Licensed to CRATE Technology GmbH ("Crate") under one or more contributor
 # license agreements.  See the NOTICE file distributed with this work for
@@ -23,5 +22,4 @@ module CrateRuby
   # Base Error class
   class CrateError < StandardError; end
   class BlobExistsError < CrateError; end
-
 end

data/lib/crate_ruby/result_set.rb

@@ -1,4 +1,3 @@
-# -*- coding: utf-8; -*-
 #
 # Licensed to CRATE Technology GmbH ("Crate") under one or more contributor
 # license agreements.  See the NOTICE file distributed with this work for
@@ -35,7 +34,7 @@ module CrateRuby
     end
 
     def inspect
-      %Q{#<CrateRuby::ResultSet:#{object_id}>, @rowcount="#{@rowcount}", @duration=#{@duration}>}
+      %(#<CrateRuby::ResultSet:#{object_id}>, @rowcount="#{@rowcount}", @duration=#{@duration}>)
     end
 
     def <<(val)
@@ -58,9 +57,8 @@ module CrateRuby
     # @param [Array] ary Column names to filer on
     # @return [Array] Filtered rows
     def select_columns(ary, &block)
-      indexes = ary.map {|col| @cols.index(col)}.compact
-      @rows.map{|r| r.values_at(*indexes)}.each(&block)
+      indexes = ary.map { |col| @cols.index(col) }.compact
+      @rows.map { |r| r.values_at(*indexes) }.each(&block)
     end
-
   end
-end
+end

data/lib/crate_ruby/version.rb

@@ -1,4 +1,3 @@
-# -*- coding: utf-8; -*-
 #
 # Licensed to CRATE Technology GmbH ("Crate") under one or more contributor
 # license agreements.  See the NOTICE file distributed with this work for
@@ -20,5 +19,5 @@
 # software solely pursuant to the terms of the relevant commercial agreement.
 
 module CrateRuby
-  VERSION = '0.0.9'
+  VERSION = '0.1.0'.freeze
 end

data/spec/bootstrap.rb

@@ -1,5 +1,4 @@
 #!/usr/bin/env ruby
-# -*- coding: utf-8; -*-
 #
 # Licensed to CRATE Technology GmbH ("Crate") under one or more contributor
 # license agreements.  See the NOTICE file distributed with this work for
@@ -25,8 +24,7 @@ require 'net/http'
 require 'zlib'
 
 class Bootstrap
-
-  VERSION = '2.1.8'
+  VERSION = '2.3.0'.freeze
 
   def initialize
     @fname = "crate-#{VERSION}.tar.gz"
@@ -34,10 +32,8 @@ class Bootstrap
   end
 
   def run
-    if !File.file?(@crate_bin)
-      if !File.file?(@fname)
-        download
-      end
+    unless File.file?(@crate_bin)
+      download unless File.file?(@fname)
       extract
     end
   end
@@ -45,10 +41,10 @@ class Bootstrap
   def download
     uri = URI("https://cdn.crate.io/downloads/releases/#{@fname}")
     puts "Downloading Crate from #{uri} ..."
-    Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
+    Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == 'https') do |http|
       request = Net::HTTP::Get.new uri
       resp = http.request request
-      open(@fname, "wb") do |file|
+      open(@fname, 'wb') do |file|
         file.write(resp.body)
       end
     end
@@ -65,7 +61,7 @@ class Bootstrap
       else
         dest_dir = File.dirname(dest_file)
         FileUtils.mkdir_p dest_dir unless File.directory?(dest_dir)
-        File.open dest_file, "wb" do |f|
+        File.open dest_file, 'wb' do |f|
           f.print entry.read
         end
       end
@@ -75,5 +71,4 @@ class Bootstrap
 end
 
 bootstrap = Bootstrap.new(*ARGV)
-bootstrap.run()
-
+bootstrap.run

data/spec/crate_ruby/client_spec.rb

@@ -1,4 +1,3 @@
-# -*- coding: utf-8; -*-
 #
 # Licensed to CRATE Technology GmbH ("Crate") under one or more contributor
 # license agreements.  See the NOTICE file distributed with this work for
@@ -24,18 +23,9 @@ require 'securerandom'
 
 describe CrateRuby::Client do
   let(:client) { CrateRuby::Client.new(['localhost:44200']) }
-  
-  before(:all) do
-    @cluster = CrateRuby::TestCluster.new(1)
-    @cluster.start_nodes
-  end
-
-  after(:all) do
-    @cluster.stop_nodes
-  end
+  let(:client_w_schema) { CrateRuby::Client.new(['localhost:44200'], schema: 'custom') }
 
   describe '#create_table' do
-
     describe 'blob management' do
       let(:file) { 'logo-crate.png' }
       let(:path) { File.join(File.dirname(__FILE__), '../uploads/') }
@@ -60,7 +50,7 @@ describe CrateRuby::Client do
           end
         end
         context '#string' do
-          let(:string) { "my crazy" }
+          let(:string) { 'my crazy' }
           let(:digest) { Digest::SHA1.hexdigest(string) }
           it 'should upload a string to the blob table' do
             client.blob_put(@blob_table, digest, string).should be_truthy
@@ -76,9 +66,9 @@ describe CrateRuby::Client do
         it 'should download a blob' do
           data = client.blob_get(@blob_table, digest)
           data.should_not be_falsey
-          open(store_location, "wb") { |file|
+          open(store_location, 'wb') do |file|
             file.write(data)
-          }
+          end
         end
       end
 
@@ -93,12 +83,12 @@ describe CrateRuby::Client do
       end
     end
 
-
     describe '#execute' do
-      let(:table_name) { "t_test" }
+      let(:table_name) { 't_test' }
 
       before do
-        client.execute("create table #{table_name} (id integer primary key, name string, address object, tags array(string)) ")
+        client.execute("create table #{table_name} " \
+           '(id integer primary key, name string, address object, tags array(string)) ')
       end
 
       after do
@@ -107,49 +97,70 @@ describe CrateRuby::Client do
 
       it 'should allow parameters' do
         client.execute("insert into #{table_name} (id, name, address, tags) VALUES (?, ?, ?, ?)",
-                       [1, "Post 1", {:street=>'1010 W 2nd Ave', :city=>'Vancouver'}, ['awesome', 'freaky']]).should be_truthy
+                       [1, 'Post 1', { street: '1010 W 2nd Ave', city: 'Vancouver' },
+                        %w[awesome freaky]]).should be_truthy
         client.refresh_table table_name
         client.execute("select * from #{table_name}").rowcount.should eq(1)
       end
 
       it 'should allow bulk parameters' do
         bulk_args = [
-          [1, "Post 1", {:street=>'1010 W 2nd Ave', :city=>'New York'}, ['foo','bar']],
-          [2, "Post 2", {:street=>'1010 W 2nd Ave', :city=>'San Fran'}, []]
+          [1, 'Post 1', { street: '1010 W 2nd Ave', city: 'New York' }, %w[foo bar]],
+          [2, 'Post 2', { street: '1010 W 2nd Ave', city: 'San Fran' }, []]
         ]
-        client.execute("insert into #{table_name} (id, name, address, tags) VALUES (?, ?, ?, ?)", nil, bulk_args).should be_truthy
+        client.execute("insert into #{table_name} (id, name, address, tags) VALUES (?, ?, ?, ?)",
+                       nil, bulk_args).should be_truthy
         client.refresh_table table_name
         client.execute("select * from #{table_name}").rowcount.should eq(2)
         client.execute("select count(*) from #{table_name}")[0][0].should eq(2)
       end
 
       it 'should accept http options' do
-        expect { client.execute("select * from #{table_name}", nil, nil, {'read_timeout'=>0}) }.to raise_error Net::ReadTimeout
+        expect do
+          client.execute("select * from #{table_name}", nil, nil,
+                         'read_timeout' => 0)
+        end.to raise_error Net::ReadTimeout
       end
-    end
 
+      context 'with schema' do
+        before do
+          client_w_schema.execute("create table #{table_name} \n
+                 (id integer primary key, name string, address object, tags array(string)) ")
+        end
+        after { client_w_schema.execute("drop table #{table_name}") }
+
+        it 'should allow parameters' do
+          client_w_schema.execute("insert into #{table_name} (id, name, address, tags) VALUES (?, ?, ?, ?)",
+                                  [1, 'Post 1', { street: '1010 W 2nd Ave', city: 'Vancouver' },
+                                   %w[awesome freaky]]).should be_truthy
+          client_w_schema.refresh_table table_name
+          client.execute("select * from #{table_name}").rowcount.should_not eq(1)
+          client_w_schema.execute("select * from #{table_name}").rowcount.should eq(1)
+        end
+      end
+    end
 
     describe '#initialize' do
       it 'should use host and ports parameters' do
-        logger = double()
-        client = CrateRuby::Client.new ["10.0.0.1:4200"], logger: logger
-        client.instance_variable_get(:@servers).should eq(["10.0.0.1:4200"])
+        logger = double
+        client = CrateRuby::Client.new ['10.0.0.1:4200'], logger: logger
+        client.instance_variable_get(:@servers).should eq(['10.0.0.1:4200'])
       end
       it 'should use default request parameters' do
         client = CrateRuby::Client.new
-        client.instance_variable_get(:@http_options).should eq({:read_timeout=>3600})
+        client.instance_variable_get(:@http_options).should eq(read_timeout: 3600)
       end
       it 'should use request parameters' do
         client = CrateRuby::Client.new ['10.0.0.1:4200'],
-            http_options: {:read_timeout=>60}
-        client.instance_variable_get(:@http_options).should eq({:read_timeout=>60})
+                                       http_options: { read_timeout: 60 }
+        client.instance_variable_get(:@http_options).should eq(read_timeout: 60)
       end
     end
 
     describe '#tables' do
       before do
-        client.create_table "posts", id: :integer
-        client.create_table "comments", id: :integer
+        client.create_table 'posts', id: :integer
+        client.create_table 'comments', id: :integer
       end
 
       after do
@@ -159,26 +170,38 @@ describe CrateRuby::Client do
       end
 
       it 'should return all user tables as an array of string values' do
-        client.tables.should eq %w(comments posts)
+        client.tables.should eq %w[comments posts]
       end
     end
 
+    describe '#blob_tables' do
+      before do
+        client.create_blob_table 'pix'
+      end
+
+      after do
+        client.drop_table 'pix', true
+      end
+
+      it 'should return all user tables as an array of string values' do
+        client.blob_tables.should eq %w(pix)
+      end
+    end
 
     describe '#insert' do
       before do
-        client.create_table("posts", id: [:string, "primary key"],
-                             title: :string,
-                             views: :integer)
+        client.create_table('posts', id: [:string, 'primary key'],
+                                     title: :string, views: :integer)
       end
 
       after do
-        client.drop_table "posts"
+        client.drop_table 'posts'
       end
 
       it 'should insert the record' do
         expect do
           id = SecureRandom.uuid
-          client.insert('posts', id: id, title: "Test")
+          client.insert('posts', id: id, title: 'Test')
           client.refresh_table('posts')
           result_set = client.execute("Select * from posts where id = '#{id}'")
           result_set.rowcount.should eq 1
@@ -188,10 +211,42 @@ describe CrateRuby::Client do
 
     describe '#refresh table' do
       it 'should issue the proper refresh statment' do
-        client.should_receive(:execute).with("refresh table posts")
+        client.should_receive(:execute).with('refresh table posts')
         client.refresh_table('posts')
       end
     end
+  end
+
+  describe 'authentication' do
+    let(:username) { 'matz' }
+    let(:password) { 'ruby' }
+    let(:encrypted_credentials) { Base64.encode64 "#{username}:#{password}" }
 
+    describe 'with password' do
+      let(:auth_client) { CrateRuby::Client.new(['localhost:44200'], username: username, password: password) }
+      it 'sets the basic auth header' do
+        headers = auth_client.send(:headers)
+        expect(headers['Authorization']).to eq "Basic #{encrypted_credentials}"
+      end
+    end
+
+    describe 'without password' do
+      let(:auth_client) { CrateRuby::Client.new(['localhost:44200'], username: username) }
+      let(:enc_creds_wo_pwd) { Base64.encode64 "#{username}:" }
+
+      it 'sets and encodes auth header even without password' do
+        headers = auth_client.send(:headers)
+        expect(headers['Authorization']).to eq "Basic #{enc_creds_wo_pwd}"
+      end
+    end
+
+    describe 'X-User header' do
+      let(:auth_client) { CrateRuby::Client.new(['localhost:44200'], username: username) }
+
+      it 'sets the X-User header' do
+        headers = auth_client.send(:headers)
+        expect(headers['X-User']).to eq username
+      end
+    end
   end
 end

data/spec/crate_ruby/result_set_spec.rb

@@ -1,4 +1,3 @@
-# -*- coding: utf-8; -*-
 #
 # Licensed to CRATE Technology GmbH ("Crate") under one or more contributor
 # license agreements.  See the NOTICE file distributed with this work for
@@ -22,18 +21,15 @@
 require_relative '../spec_helper'
 
 describe ResultSet do
-
-  let(:crate_result) { "{\"cols\":[\"my_column\",\"my_integer_col\"],\"rows\":[[\"Foo\",5],[\"Bar\",5]],\"rowcount\":1,\"duration\":4}" }
-  let(:result_with_array_col) { %Q{{"cols":["id","tags","title"],"rows":[[1,["awesome","freaky"],"My life with crate"]],"rowcount":1,"duration":2}} }
-  let(:result_with_object) { %Q{{"cols":["address","id","name"],"rows":[[{"street":"1010 W 2nd Ave","city":"Vancouver"},"fb7183ac-d049-462c-85a9-732aca59a1c1","Mad Max"]],"rowcount":1,"duration":3}} }
+  let(:crate_result) { '{"cols":["my_column","my_integer_col"],"rows":[["Foo",5],["Bar",5]],"rowcount":1,"duration":4}' }
+  let(:result_with_array_col) { %({"cols":["id","tags","title"],"rows":[[1,["awesome","freaky"],"My life with crate"]],"rowcount":1,"duration":2}) }
+  let(:result_with_object) { %({"cols":["address","id","name"],"rows":[[{"street":"1010 W 2nd Ave","city":"Vancouver"},"fb7183ac-d049-462c-85a9-732aca59a1c1","Mad Max"]],"rowcount":1,"duration":3}) }
 
   let(:result_set) { ResultSet.new(crate_result) }
 
   let(:json_result) { JSON.parse crate_result }
 
   describe '#initialize' do
-
-
     it 'should set rowcount' do
       result_set.rowcount.should eq 1
     end
@@ -49,15 +45,14 @@ describe ResultSet do
     it 'should parse an array column result into an Array' do
       res = ResultSet.new(result_with_array_col)
       res[0][1].should be_a(Array)
-      res[0][1].should eq(["awesome","freaky"])
+      res[0][1].should eq(%w[awesome freaky])
     end
 
     it 'should parse an object column result into an Object' do
       res = ResultSet.new(result_with_object)
       res[0][0].should be_a(Hash)
-      res[0][0].should eq({"street" => "1010 W 2nd Ave","city" => "Vancouver"})
+      res[0][0].should eq('street' => '1010 W 2nd Ave', 'city' => 'Vancouver')
     end
-
   end
 
   describe '#each' do
@@ -80,12 +75,11 @@ describe ResultSet do
       result_set.select_columns(['my_column']) do |res|
         a << res
       end
-      a.should eq [["Foo"], ["Bar"]]
-
+      a.should eq [['Foo'], ['Bar']]
     end
     it 'should not raise error on invalid column name' do
       expect do
-        result_set.select_columns(['my_column', 'invalid']) do |row|
+        result_set.select_columns(%w[my_column invalid]) do |row|
         end
       end.to_not raise_error
     end
@@ -96,7 +90,4 @@ describe ResultSet do
       result_set.values.should eq json_result['rows']
     end
   end
-
 end
-
-

data/spec/spec_helper.rb

@@ -1,4 +1,3 @@
-# -*- coding: utf-8; -*-
 #
 # Licensed to CRATE Technology GmbH ("Crate") under one or more contributor
 # license agreements.  See the NOTICE file distributed with this work for
@@ -21,4 +20,24 @@
 
 require_relative '../lib/crate_ruby'
 require 'net/http'
+require_relative 'support/test_cluster'
 
+HOST = '127.0.0.1'.freeze
+PORT = 44_200
+
+RSpec.configure do |config|
+  config.before(:each) do
+  end
+  config.after(:each) do
+  end
+  config.before(:suite) do
+    @cluster = TestCluster.new(1, PORT)
+    @cluster.start_nodes
+  end
+  config.after(:suite) do
+    pid_file = File.join(__dir__, 'support/testnode.pid')
+    pid = File.read(pid_file)
+    File.delete(pid_file)
+    Process.kill('HUP', pid.to_i)
+  end
+end

data/spec/support/test_cluster.rb

@@ -0,0 +1,107 @@
+#!/usr/bin/env ruby
+#
+# Licensed to CRATE Technology GmbH ("Crate") under one or more contributor
+# license agreements.  See the NOTICE file distributed with this work for
+# additional information regarding copyright ownership.  Crate licenses
+# this file to you under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.  You may
+# obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
+# License for the specific language governing permissions and limitations
+# under the License.
+#
+# However, if you have executed another commercial license agreement
+# with Crate these terms will supersede the license and you may use the
+# software solely pursuant to the terms of the relevant commercial agreement.
+
+require 'net/http'
+
+class TestCluster
+  def initialize(num_nodes = 1, http_port = 44_200)
+    @nodes = []
+    idx = 0
+    while idx < num_nodes
+      name = "crate#{idx - 1}"
+      port = http_port + idx
+      @nodes << TestServer.new(name, port)
+      idx += 1
+    end
+  end
+
+  def start_nodes
+    @nodes.each(&:start)
+  end
+
+  def stop_nodes
+    @nodes.each(&:stop)
+  end
+end
+
+class TestServer
+  STARTUP_TIMEOUT = 30
+
+  def initialize(name, http_port)
+    @node_name = name
+    @http_port = http_port
+
+    @crate_bin = File.join('parts', 'crate', 'bin', 'crate')
+    unless File.file?(@crate_bin)
+      puts "Crate is not available. Please run 'bundle exec ruby spec/bootstrap.rb' first."
+      exit 1
+    end
+  end
+
+  def start
+    cmd = "sh #{@crate_bin} #{start_params}"
+    @pid = spawn(cmd)
+    wait_for
+    Process.detach(@pid)
+
+    File.write(__dir__ + '/testnode.pid', @pid)
+  end
+
+  def wait_for
+    time_slept = 0
+    interval = 1
+    loop do
+      if !alive? && (time_slept > STARTUP_TIMEOUT)
+        puts "Crate hasn't started for #{STARTUP_TIMEOUT} seconds. Giving up now..."
+        exit 1
+      end
+      if alive?
+        break
+      else
+        sleep(interval)
+        time_slept += interval
+      end
+    end
+  end
+
+  def stop
+    Process.kill('HUP', @pid)
+  end
+
+  private
+
+  def start_params
+    "-Cnode.name=#{@node_name} " \
+      "-Chttp.port=#{@http_port} " \
+      '-Cnetwork.host=localhost '
+  end
+
+  def alive?
+    req = Net::HTTP::Get.new('/')
+    resp = Net::HTTP.new('localhost', @http_port)
+    begin
+      response = resp.start { |http| http.request(req) }
+      response.code == '200'
+    rescue Errno::ECONNREFUSED
+      false
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: crate_ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.0
 platform: ruby
 authors:
 - Christoph Klocker
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-31 00:00:00.000000000 Z
+date: 2018-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -62,19 +62,19 @@ files:
 - lib/crate_ruby/client.rb
 - lib/crate_ruby/error.rb
 - lib/crate_ruby/result_set.rb
-- lib/crate_ruby/utils.rb
 - lib/crate_ruby/version.rb
 - log/.keep
 - spec/bootstrap.rb
 - spec/crate_ruby/client_spec.rb
 - spec/crate_ruby/result_set_spec.rb
 - spec/spec_helper.rb
+- spec/support/test_cluster.rb
 - spec/uploads/get_logo-crate.png
 - spec/uploads/logo-crate.png
 - spec/uploads/text.txt
 homepage: http://crate.io
 licenses:
-- Apache License, v2.0
+- Apache-2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -92,7 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.4
 signing_key: 
 specification_version: 4
 summary: A simple interface for the Crate.IO database.
@@ -101,6 +101,7 @@ test_files:
 - spec/crate_ruby/client_spec.rb
 - spec/crate_ruby/result_set_spec.rb
 - spec/spec_helper.rb
+- spec/support/test_cluster.rb
 - spec/uploads/get_logo-crate.png
 - spec/uploads/logo-crate.png
 - spec/uploads/text.txt

data/lib/crate_ruby/utils.rb

@@ -1,117 +0,0 @@
-# -*- coding: utf-8; -*-
-#
-# Licensed to CRATE Technology GmbH ("Crate") under one or more contributor
-# license agreements.  See the NOTICE file distributed with this work for
-# additional information regarding copyright ownership.  Crate licenses
-# this file to you under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.  You may
-# obtain a copy of the License at
-#
-#   http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
-# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
-# License for the specific language governing permissions and limitations
-# under the License.
-#
-# However, if you have executed another commercial license agreement
-# with Crate these terms will supersede the license and you may use the
-# software solely pursuant to the terms of the relevant commercial agreement.
-
-require 'net/http'
-
-module CrateRuby
-
-  class TestCluster
-
-    def initialize(num_nodes = 1, http_port=44200)
-      @nodes = []
-      idx = 0
-      while idx < num_nodes do
-        name = "crate#{idx-1}"
-        port = http_port + idx
-        @nodes << TestServer.new(name, port)
-        idx += 1
-      end
-    end
-
-    def start_nodes
-      @nodes.each do |node|
-        node.start
-      end
-    end
-
-    def stop_nodes
-      @nodes.each do |node|
-        node.stop
-      end
-    end
-
-  end
-
-  class TestServer
-
-    STARTUP_TIMEOUT = 30
-
-    def initialize(name, http_port)
-      @node_name = name
-      @http_port = http_port
-
-      @crate_bin = File.join('parts', 'crate', 'bin', 'crate')
-      if !File.file?(@crate_bin)
-        puts "Crate is not available. Please run 'bundle exec ruby spec/bootstrap.rb' first."
-        exit 1
-      end
-    end
-
-    def start
-      cmd = "sh #{@crate_bin} #{start_params}"
-      @pid = spawn(cmd)
-      wait_for
-      Process.detach(@pid)
-    end
-
-    def wait_for
-      time_slept = 0
-      interval = 1
-      while true
-        if !alive? and time_slept > STARTUP_TIMEOUT
-          puts "Crate hasn't started for #{STARTUP_TIMEOUT} seconds. Giving up now..."
-          exit 1
-        end
-        if alive?
-          break
-        else
-          sleep(interval)
-          time_slept += interval
-        end
-      end
-    end
-
-    def stop
-      Process.kill('HUP', @pid)
-    end
-
-    private
-
-    def start_params
-      "-Cnode.name=#{@node_name} " +
-        "-Chttp.port=#{@http_port} " +
-        "-Cnetwork.host=localhost "
-    end
-
-    def alive?
-      req = Net::HTTP::Get.new('/')
-      resp = Net::HTTP.new('localhost', @http_port)
-      begin
-        response = resp.start { |http| http.request(req) }
-        response.code == "200" ? true : false
-      rescue Errno::ECONNREFUSED
-        false
-      end
-    end
-  end
-
-end
-