crate_ruby 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b3ff57320c97fd0469f294c16516f805ac815380
+  data.tar.gz: 15b6f0ea26f2d8b64892f706b45a2f23dc753fda
+SHA512:
+  metadata.gz: 4b887ed5e8bfa23435bfa9ad3eecbf8deee91fc5c95242ce7086a80bcfb9fbed64fd8403cdcf4a0ea95c97f05e54a5104d6620aa8df32d6b875163a2b47d565d
+  data.tar.gz: 338c270195d22fd4fb127cefea310317a2a6b79170f3972f6c597aff6df375ff3e3b6ef4017f0658c2dbb37a019a24e5a13be16c4fc0be1c0296be9d719ffbdf

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea/*
+.rvmrc
+log/crate.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Christoph Klocker
+
+MIT License
+
+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,58 @@
+# CrateRuby
+
+Official ruby library to access a (Crate)[http://crate.io] database.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'crate_ruby'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install crate_ruby
+
+## Usage
+
+### Issueing SQL statements
+    require 'crate_ruby'
+
+    # optional args :host, :port, :logger
+    client = CrateRuby::Client.new
+    result = client.execute("Select * from posts")
+     => #<CrateRuby::ResultSet:0x00000002a9c5e8 @rowcount=1, @duration=5>
+    result.each do |row|
+      puts row.inspect # [1, "test", 5]
+    end
+
+    result.cols
+     => ["id", "my_column", "my_integer_col"]
+
+### Up/Downloading data
+    digest = Digest::SHA1.file(file_path).hexdigest
+
+    #upload
+    f = File.read(file_path)
+    client.blob_put(table_name, digest, f)
+
+    #download
+    data = client.blob_get(table_name, digest)
+    open(file_path, "wb") do |file|
+      file.write(data)
+    end
+
+    #deletion
+    client.blob_delete(table_name, digest)
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/crate_ruby/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Add some tests
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request

data/Rakefile

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

@@ -0,0 +1,25 @@
+# coding: utf-8
+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"]
+  spec.email         = ["christoph@vedanova.com"]
+  spec.summary       = "A simple interface to Crate Data."
+  spec.description   = ""
+  spec.source        = "https://github.com/crate/crate_ruby"
+  spec.homepage      = "http://crate.io"
+  spec.license       = "MIT"
+
+  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 "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.14"
+end

data/lib/crate_ruby.rb

@@ -0,0 +1,22 @@
+require "crate_ruby/version"
+require "crate_ruby/error"
+require 'crate_ruby/result_set'
+require 'crate_ruby/client'
+
+include CrateRuby
+
+module CrateRuby
+  def self.logger
+    @logger ||= begin
+      require 'logger'
+      log = Logger.new(File.join(File.dirname(__FILE__), "../log/crate.log"), 10, 1024000)
+      log.level = Logger::DEBUG
+      log
+    end
+  end
+
+  def self.logger=(logger)
+    @logger = logger
+  end
+
+end

data/lib/crate_ruby/client.rb

@@ -0,0 +1,155 @@
+require 'json'
+require 'net/http'
+module CrateRuby
+  class Client
+    DEFAULT_HOST = "127.0.0.1"
+    DEFAULT_PORT = "4200"
+
+    attr_accessor :logger
+
+    # @param [opts] Optional paramters
+    # * host: ip or host name, defaults to 127.0.0.1
+    # * port: defaults to 4200
+    def initialize(opts = {})
+      @host = opts[:host] || DEFAULT_HOST
+      @port = opts[:port] || DEFAULT_PORT
+      @uri = "http://#{DEFAULT_HOST}:#{DEFAULT_PORT}"
+      @logger = opts[:logger] || CrateRuby.logger
+    end
+
+    def inspect
+      %Q{#<CrateRuby::Client:#{object_id}, @uri="#{@uri}">}
+    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
+    # @return [Boolean]
+    #
+    def create_table(table_name, column_definition = {}, blob=false)
+      cols = column_definition.to_a.map { |a| a.join(' ') }.join(', ')
+      stmt = %Q{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
+    # @return [Boolean]
+    #
+    # 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
+    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 [Boolean]
+    def drop_table(table_name, blob=false)
+      tbl = blob ? "BLOB TABLE" : "TABLE"
+      stmt = %Q{DROP #{tbl} "#{table_name}"}
+      execute(stmt)
+    end
+
+    # List all user tables
+    # @return [ResultSet]
+    def show_tables
+      execute("select * from information_schema.tables where schema_name = 'doc'")
+    end
+
+    # Executes a SQL statement against the Crate HTTP REST endpoint.
+    # @param [String] sql statement to execute
+    # @return [ResultSet, false]
+    def execute(sql)
+      req = Net::HTTP::Post.new("/_sql", initheader = {'Content-Type' => 'application/json'})
+      req.body = {"stmt" => sql}.to_json
+      response = Net::HTTP.new(@host, @port).start { |http| http.request(req) }
+      success = case response.code
+                  when "200"
+                    ResultSet.new response.body
+                  when "400"
+                    @logger.info(response.body)
+                    false
+                  else
+                    @logger.info(response.body)
+                    false
+                end
+      success
+    end
+
+    # Upload a File to a blob table
+    # @param [String] table
+    # @param [String] digest SHA1 hexdigest
+    # @param [Boolean] data Can be any payload object that can be sent via HTTP, e.g. STRING, FILE
+    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.body = data
+      #req["Content-Type"] = "multipart/form-data, boundary=#{boundary}"
+      response = Net::HTTP.new(@host, @port).start { |http| http.request(req) }
+      success = case response.code
+                  when "201"
+                    true
+                  else
+                    @logger.info("Response #{response.code}: " + response.body)
+                    false
+                end
+      success     
+    end
+
+    # Download blob
+    # @param [String] table
+    # @param [String] digest SHA1 hexdigest
+    #
+    # @return [Blob] File data to write to file or use directly
+    def blob_get(table, digest)
+      uri = blob_path(table, digest)
+      @logger.debug("BLOB GET #{uri}")
+      req = Net::HTTP::Get.new(uri)
+      response = Net::HTTP.new(@host, @port).start do |http|
+        http.request(req)
+      end
+      case response.code
+        when "200"
+          response.body
+        else
+          @logger.info("Response #{response.code}: #{response.body}")
+          false
+      end
+    end
+
+    # Delete blob
+    # @param [String] table
+    # @param [String] digest SHA1 hexdigest
+    #
+    # @return [Boolean]
+    def blob_delete(table, digest)
+      uri = blob_path(table, digest)
+      @logger.debug("BLOB DELETE #{uri}")
+      req = Net::HTTP::Delete.new(uri)
+      response = Net::HTTP.new(@host, @port).start { |http| http.request(req) }
+      success = case response.code
+                  when "200"
+                    true
+                  else
+                    @logger.info("Response #{response.code}: #{response.body}")
+                    false
+                end
+      success
+    end
+
+    private
+
+    def blob_path(table, digest)
+      "/_blobs/#{table}/#{digest}"
+    end
+
+
+  end
+end

data/lib/crate_ruby/error.rb

@@ -0,0 +1,6 @@
+module CrateRuby
+  # Base Error class
+  class CrateError < StandardError; end
+  class BlobExistsError < CrateError; end
+
+end

data/lib/crate_ruby/result_set.rb

@@ -0,0 +1,41 @@
+module CrateRuby
+  class ResultSet
+    include Enumerable
+
+    attr_reader :rowcount, :duration, :cols
+
+    # @param [String] Crate result
+    def initialize(result)
+      result = JSON.parse(result)
+      @cols = result['cols']
+      @rows = result['rows']
+      @rowcount = result['rowcount']
+      @duration = result['duration']
+    end
+
+    def inspect
+      %Q{#<CrateRuby::ResultSet:#{object_id}>, @rowcount="#{@rowcount}", @duration=#{@duration}>}
+    end
+
+    def <<(val)
+      @rows << val
+    end
+
+    def each(&block)
+      @rows.each(&block)
+      nil
+    end
+
+    def [](val)
+      @rows[val]
+    end
+
+    # @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)
+    end
+
+  end
+end

data/lib/crate_ruby/version.rb

@@ -0,0 +1,3 @@
+module CrateRuby
+  VERSION = "0.0.1"
+end

data/spec/crate_ruby/client_spec.rb

@@ -0,0 +1,108 @@
+require_relative '../spec_helper'
+
+describe CrateRuby::Client do
+  describe '#create_table' do
+    let(:client) { CrateRuby::Client.new }
+
+    describe 'blob mangament' do
+      let(:table_name) { 'blob_table' }
+      let(:file) { 'logo-crate.png' }
+      #let(:file) { 'text.txt' }
+      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
+        client.execute("create blob TABLE #{table_name}")
+      end
+
+      after do
+        client.execute("drop blog TABLE #{table_name}")
+      end
+
+      describe '#blob_put' do
+
+        after do
+          client.blob_delete(table_name, digest)
+        end
+
+        context 'file' do
+
+          it 'should upload a file to the blob table' do
+            f = File.read(file_path)
+            client.blob_put(table_name, digest, f).should be_true
+          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_delete(table_name, digest)
+            client.blob_put table_name, digest, string
+          end
+        end
+      end
+
+      describe '#blob_get' do
+
+        before do
+          f = File.read(file_path)
+          client.blob_put(table_name, digest, f)
+        end
+
+        it 'should download a blob' do
+          data = client.blob_get(table_name, digest)
+          data.should_not be_false
+          open(store_location, "wb") { |file|
+            file.write(data)
+          }
+        end
+
+        after do
+          client.blob_delete(table_name, digest)
+        end
+      end
+
+      describe '#blob_delete' do
+        before do
+          f = File.read(file_path)
+          client.blob_put(table_name, digest, f)
+        end
+
+        it 'should delete a blob' do
+          client.blob_delete(table_name, digest)
+        end
+      end
+    end
+
+    describe '#execute' do
+      let(:table_name) { "post" }
+
+      after do
+        client.execute("drop TABLE #{table_name}").should be_true
+      end
+
+      it 'should create a new table' do
+        client.execute("CREATE TABLE #{table_name} (id int)").should be_true
+      end
+
+    end
+
+
+    describe '#initialize' do
+
+      it 'should use host and ports parameters' do
+        logger = double()
+        client = CrateRuby::Client.new host: "10.0.0.1", port: 5000, logger: logger
+        client.instance_variable_get(:@host).should eq("10.0.0.1")
+        client.instance_variable_get(:@port).should eq(5000)
+        client.instance_variable_get(:@logger).should == logger
+      end
+
+    end
+
+  end
+end

data/spec/crate_ruby/result_set_spec.rb

@@ -0,0 +1,61 @@
+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_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
+
+  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(['my_column', 'invalid']) do |row|
+        end
+      end.to_not raise_error
+    end
+  end
+
+end
+
+

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require_relative '../lib/crate_ruby'

data/spec/uploads/text.txt

@@ -0,0 +1 @@
+TEST

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: crate_ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Christoph Klocker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+description: ''
+email:
+- christoph@vedanova.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- crate_ruby.gemspec
+- lib/crate_ruby.rb
+- lib/crate_ruby/client.rb
+- lib/crate_ruby/error.rb
+- lib/crate_ruby/result_set.rb
+- lib/crate_ruby/version.rb
+- log/.keep
+- spec/crate_ruby/client_spec.rb
+- spec/crate_ruby/result_set_spec.rb
+- spec/spec_helper.rb
+- spec/uploads/get_logo-crate.png
+- spec/uploads/logo-crate.png
+- spec/uploads/text.txt
+homepage: http://crate.io
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: A simple interface to Crate Data.
+test_files:
+- spec/crate_ruby/client_spec.rb
+- spec/crate_ruby/result_set_spec.rb
+- spec/spec_helper.rb
+- spec/uploads/get_logo-crate.png
+- spec/uploads/logo-crate.png
+- spec/uploads/text.txt