crate_ruby 0.2.0 → 0.2.1

data/DEVELOP.rst

@@ -1,46 +0,0 @@
-===============
-Developer Guide
-===============
-
-Tests
-=====
-
-First, download and install CrateDB locally::
-
-    $ ruby spec/bootstrap.rb
-
-Then, run tests like so::
-
-    $ bundle exec rspec spec
-
-Preparing a Release
-===================
-
-To create a new release, you must:
-
-- Update ``CrateRuby.version`` in ``lib/crate_ruby/version.rb``
-
-- Add a section for the new version in the ``history.txt`` file
-
-- Commit your changes with a message like "prepare release x.y.z"
-
-- Push to ``origin/master``
-
-- Create a tag by running ``./devtools/create_tag.sh``
-
-RubyGems Deployment
-===================
-
-Update your package manager::
-
-    $ gem update --system
-
-Build the new gem::
-
-    $ gem build crate_ruby.gemspec
-
-Publish the new gem::
-
-    $ gem push crate_ruby-<VERISON>.gem
-
-Here, ``<VERISON>`` is the version you are releasing.

data/Gemfile

@@ -1,4 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in crate_ruby.gemspec
-gemspec

data/Rakefile

@@ -1,7 +0,0 @@
-require "bundler/gem_tasks"
-
-desc "Open an irb session preloaded with this library"
-task :console do
-  sh "irb -rubygems -I lib -r ./lib/crate_ruby.rb"
-end
-

data/crate_ruby.gemspec

@@ -1,44 +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.
-
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'crate_ruby/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "crate_ruby"
-  spec.version       = CrateRuby::VERSION
-  spec.authors       = ["Christoph Klocker", "CRATE Technology GmbH"]
-  spec.email         = ["office@crate.io"]
-  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-2.0"
-  spec.required_ruby_version = '>= 2.0'
-
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec", "~> 2.99"
-end

data/devtools/create_tag.sh

@@ -1,77 +0,0 @@
-#!/bin/bash
-#
-# 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.
-
-# check if everything is committed
-CLEAN=`git status -s`
-if [ ! -z "$CLEAN" ]
-then
-   echo "Working directory not clean. Please commit all changes before tagging"
-   echo "Aborting."
-   exit -1
-fi
-
-echo "Fetching origin..."
-git fetch origin > /dev/null
-
-# get current branch
-BRANCH=`git branch | grep "^*" | cut -d " " -f 2`
-echo "Current branch is $BRANCH."
-
-# check if master == origin/master
-LOCAL_COMMIT=`git show --format="%H" $BRANCH`
-ORIGIN_COMMIT=`git show --format="%H" origin/$BRANCH`
-
-if [ "$LOCAL_COMMIT" != "$ORIGIN_COMMIT" ]
-then
-   echo "Local $BRANCH is not up to date. "
-   echo "Aborting."
-   exit -1
-fi
-
-# get version from version.rb
-VERSION=$(grep "VERSION =" lib/crate_ruby/version.rb | \
-    cut -d' ' -f5 | tr -d "\'" | sed -e "s/.freeze//")
-echo "Version: $VERSION"
-
-# check if tag to create has already been created
-EXISTS=`git tag | grep $VERSION`
-
-if [ "$VERSION" == "$EXISTS" ]
-then
-   echo "Revision $VERSION already tagged."
-   echo "Aborting."
-   exit -1
-fi
-
-# check if VERSION is in head of CHANGES.txt
-REV_NOTE=`grep "=== $VERSION" history.txt`
-if [ -z "$REV_NOTE" ]
-then
-    echo "No notes for revision $VERSION found in history.txt"
-    echo "Aborting."
-    exit -1
-fi
-
-echo "Creating tag $VERSION..."
-git tag -a "$VERSION" -m "Tag release for revision $VERSION"
-git push --tags
-echo "Done."
-

data/history.txt

@@ -1,32 +0,0 @@
-# coding: UTF-8
-=== 0.2.0
-  * Added SSL support.
-
-=== 0.1.0
-  * HTTP Basic Authentication support that comes with 2.3.0
-
-=== 0.0.9
-
-  * fixed breaking changes that kept driver from working with crate > v2.0
-  * removed ruby 1.9.3 from travis.yml
-  * client now supports HTTP options
-  * update travis.yml and fix broken test
-
-=== 0.0.8
-
-  * undocumented gem release
-
-=== 0.0.7
-
-  * use prepared statements for insert
-
-=== 0.0.6
-
-  * now officially supported by Crate Data and available under the
-    Apache 2.0 License
-
-=== 0.0.5
-
-Enhancements:
-
-  * #execute now supports parameter substitution

data/spec/bootstrap.rb

@@ -1,74 +0,0 @@
-#!/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 'rubygems/package'
-require 'net/http'
-require 'zlib'
-
-class Bootstrap
-  VERSION = '2.3.0'.freeze
-
-  def initialize
-    @fname = "crate-#{VERSION}.tar.gz"
-    @crate_bin = File.join('parts', 'crate' 'bin', 'crate')
-  end
-
-  def run
-    unless File.file?(@crate_bin)
-      download unless File.file?(@fname)
-      extract
-    end
-  end
-
-  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|
-      request = Net::HTTP::Get.new uri
-      resp = http.request request
-      open(@fname, 'wb') do |file|
-        file.write(resp.body)
-      end
-    end
-  end
-
-  def extract
-    tar_extract = Gem::Package::TarReader.new(Zlib::GzipReader.open(@fname))
-    tar_extract.rewind # The extract has to be rewinded after every iteration
-    tar_extract.each do |entry|
-      dest_file = File.join 'parts', entry.full_name.gsub(/^(crate)(\-\d+\.\d+\.\d+)(.*)/, '\1\3')
-      puts dest_file
-      if entry.directory?
-        FileUtils.mkdir_p dest_file
-      else
-        dest_dir = File.dirname(dest_file)
-        FileUtils.mkdir_p dest_dir unless File.directory?(dest_dir)
-        File.open dest_file, 'wb' do |f|
-          f.print entry.read
-        end
-      end
-    end
-    tar_extract.close
-  end
-end
-
-bootstrap = Bootstrap.new(*ARGV)
-bootstrap.run

data/spec/crate_ruby/client_spec.rb

@@ -1,252 +0,0 @@
-#
-# 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_relative '../spec_helper'
-require 'securerandom'
-
-describe CrateRuby::Client do
-  let(:client) { CrateRuby::Client.new(['localhost:44200']) }
-  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/') }
-      let(:file_path) { File.join(path, file) }
-      let(:digest) { Digest::SHA1.file(file_path).hexdigest }
-      let(:store_location) { File.join(path, "get_#{file}") }
-
-      before do
-        @blob_table = 'my_blobs'
-        client.execute("create blob table #{@blob_table} clustered into 1 shards with (number_of_replicas=0)")
-      end
-
-      after do
-        client.execute("drop blob table #{@blob_table}")
-      end
-
-      describe '#blob_put' do
-        context 'file' do
-          it 'should upload a file to the blob table' do
-            f = File.read(file_path)
-            client.blob_put(@blob_table, digest, f).should be_truthy
-          end
-        end
-        context '#string' do
-          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
-          end
-        end
-      end
-
-      describe '#blob_get' do
-        before do
-          f = File.read(file_path)
-          client.blob_put(@blob_table, digest, f)
-        end
-        it 'should download a blob' do
-          data = client.blob_get(@blob_table, digest)
-          data.should_not be_falsey
-          open(store_location, 'wb') do |file|
-            file.write(data)
-          end
-        end
-      end
-
-      describe '#blob_delete' do
-        before do
-          f = File.read(file_path)
-          client.blob_put(@blob_table, digest, f)
-        end
-        it 'should delete a blob' do
-          client.blob_delete(@blob_table, digest)
-        end
-      end
-    end
-
-    describe '#execute' do
-      let(:table_name) { 't_test' }
-
-      before do
-        client.execute("create table #{table_name} " \
-           '(id integer primary key, name string, address object, tags array(string)) ')
-      end
-
-      after do
-        client.execute("drop table #{table_name}")
-      end
-
-      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' },
-                        %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' }, %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.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 do
-          client.execute("select * from #{table_name}", nil, nil,
-                         'read_timeout' => 0)
-        end.to raise_error Net::ReadTimeout
-      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'])
-      end
-      it 'should use default request parameters' do
-        client = CrateRuby::Client.new
-        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)
-      end
-    end
-
-    describe '#tables' do
-      before do
-        client.create_table 'posts', id: :integer
-        client.create_table 'comments', id: :integer
-      end
-
-      after do
-        client.tables.each do |table|
-          client.drop_table table
-        end
-      end
-
-      it 'should return all user tables as an array of string values' do
-        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)
-      end
-
-      after do
-        client.drop_table 'posts'
-      end
-
-      it 'should insert the record' do
-        expect do
-          id = SecureRandom.uuid
-          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
-        end.not_to raise_exception
-      end
-    end
-
-    describe '#refresh table' do
-      it 'should issue the proper refresh statment' do
-        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,93 +0,0 @@
-#
-# 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_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) { %({"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
-
-    it 'should set duration' do
-      result_set.duration.should eq 4
-    end
-
-    it 'should set cols' do
-      result_set.cols.should eq json_result['cols']
-    end
-
-    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(%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')
-    end
-  end
-
-  describe '#each' do
-    it 'should loop over the result rows' do
-      result_set.each_with_index do |r, i|
-        r.should eq json_result['rows'][i]
-      end
-    end
-  end
-
-  describe '#[]' do
-    it 'should return the row at index' do
-      result_set[1][0].should eq('Bar')
-    end
-  end
-
-  describe '#values_at' do
-    it 'should only return the columns specified' do
-      a = []
-      result_set.select_columns(['my_column']) do |res|
-        a << res
-      end
-      a.should eq [['Foo'], ['Bar']]
-    end
-    it 'should not raise error on invalid column name' do
-      expect do
-        result_set.select_columns(%w[my_column invalid]) do |row|
-        end
-      end.to_not raise_error
-    end
-  end
-
-  describe '#values' do
-    it 'should return all rows as an array of arrays' do
-      result_set.values.should eq json_result['rows']
-    end
-  end
-end

data/spec/spec_helper.rb

@@ -1,43 +0,0 @@
-#
-# 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_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