crate_ruby 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 89005d37bce3036b7cc74a9cf521a85493f8695e
-  data.tar.gz: d92405d8c41d5c191cd6a943cc45a3227fd2c01b
+  metadata.gz: 4a726eb5a922ba00e842ae5128897f44ebc348ed
+  data.tar.gz: 0d3d601ffb7c5bbecfd3c6f80a55905b434559e7
 SHA512:
-  metadata.gz: 7fc3c5596813c4de4565c91f4d4a8b8ff5447143a66734956fbf342d997209cde01b042949721184868948c916e0beabd0a985353722bbc7c5d7e17b5afce279
-  data.tar.gz: f7dd74c16239b2e5f6bb5811529c44513b184c77a4849bf45431c4e3ddfa1bf6ebcb121ca71c4b044886f545ee48d1b02bf8cfdff7374b064877e50dcfec3d40
+  metadata.gz: 5a55318fc2253b2244ffe7ec3fa88496903ed9f42171b7b1b036f002ffd69e3e7781836678e5e7a1362cc2f20e79c44e3f2c6b69c5dbf5114ec26eade980c578
+  data.tar.gz: b09c8a6e7d4449746105721e8cc3903f7c18cd2231f2359c5e749cdc43f3af5c5c01a3197356d8e04d14c060b20ec2b6bc550ee912c32c723f8590e5650768e8

data/.gitignore

@@ -18,3 +18,4 @@ tmp
 .idea/*
 .rvmrc
 log/crate.log
+crate_test_server.*

data/README.md

@@ -1,6 +1,6 @@
 # CrateRuby
 
-Official ruby library to access a (Crate)[http://crate.io] database.
+Official Ruby library to access a [Crate](http://crate.io) database.
 
 ## Installation
 
@@ -8,10 +8,6 @@ Add this line to your application's Gemfile:
 
     gem 'crate_ruby'
 
-And then execute:
-
-    $ bundle
-
 Or install it yourself as:
 
     $ gem install crate_ruby
@@ -21,13 +17,15 @@ Or install it yourself as:
 ### 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]
+      puts row.inspect
     end
+     => [1, "test", 5]
 
     result.cols
      => ["id", "my_column", "my_integer_col"]
@@ -48,11 +46,26 @@ Or install it yourself as:
     #deletion
     client.blob_delete(table_name, digest)
 
+## Tests
+
+To run the tests start up the crate server first
+
+    ruby spec/test_server.rb
+
 ## Contributing
 
-1. Fork it ( http://github.com/<my-github-username>/crate_ruby/fork )
+1. Fork it ( `http://github.com/crate       /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
+
+##Maintainer
+
+* [Christoph Klocker](http://www.vedanova.com), [@corck](http://www.twitter.com/corck)
+
+##License
+
+MIT License. Copyright 2014 Vedanova. [http://vedanova.com](http://vedanova.com)
+

data/lib/crate_ruby.rb

@@ -10,7 +10,7 @@ module CrateRuby
     @logger ||= begin
       require 'logger'
       log = Logger.new(File.join(File.dirname(__FILE__), "../log/crate.log"), 10, 1024000)
-      log.level = Logger::DEBUG
+      log.level = Logger::INFO
       log
     end
   end

data/lib/crate_ruby/client.rb

@@ -11,6 +11,7 @@ module CrateRuby
     # @param [Array] servers An Array of servers including ports [127.0.0.1:4200, 10.0.0.1:4201]
     # @param [opts] Optional paramters
     # * logger: Custom Logger
+    # @return [CrateRuby::Client]
     def initialize(servers = [], opts = {})
       @servers = servers
       @servers << "#{DEFAULT_HOST}:#{DEFAULT_PORT}" if servers.empty?
@@ -18,7 +19,7 @@ module CrateRuby
     end
 
     def inspect
-      %Q{#<CrateRuby::Client:#{object_id}, @uri="#{@uri}">}
+      %Q{#<CrateRuby::Client:#{object_id}>}
     end
 
     # Creates a table
@@ -26,7 +27,7 @@ module CrateRuby
     # @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]
+    # @return [ResultSet]
     #
     def create_table(table_name, column_definition = {}, blob=false)
       cols = column_definition.to_a.map { |a| a.join(' ') }.join(', ')
@@ -38,7 +39,7 @@ module CrateRuby
     # @param [String] name Table name
     # @param [Integer] shard Shard count, defaults to 5
     # @param [Integer] number Number of replicas, defaults to 0
-    # @return [Boolean]
+    # @return [ResultSet]
     #
     # client.create_blob_table("blob_table")
     def create_blob_table(name, shard_count=5, replicas=0)
@@ -49,7 +50,7 @@ module CrateRuby
     # 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]
+    # @return [ResultSet]
     def drop_table(table_name, blob=false)
       tbl = blob ? "BLOB TABLE" : "TABLE"
       stmt = %Q{DROP #{tbl} "#{table_name}"}
@@ -59,25 +60,30 @@ module CrateRuby
     # List all user tables
     # @return [ResultSet]
     def show_tables
-      execute("select * from information_schema.tables where schema_name = 'doc'")
+      execute("select table_name from information_schema.tables where schema_name = 'doc'")
+    end
+
+    # Returns all tables in schema 'doc'
+    # @return [Array] Array of table names
+    def tables
+      execute("select table_name from information_schema.tables where schema_name = 'doc'").map(&:first)
     end
 
     # Executes a SQL statement against the Crate HTTP REST endpoint.
     # @param [String] sql statement to execute
-    # @return [ResultSet, false]
+    # @return [ResultSet]
     def execute(sql)
+      @logger.debug sql
       req = Net::HTTP::Post.new("/_sql", initheader = {'Content-Type' => 'application/json'})
       req.body = {"stmt" => sql}.to_json
       response = request(req)
+      @logger.debug response.body
       success = case response.code
-                  when "200"
+                  when /^2\d{2}/
                     ResultSet.new response.body
-                  when "400"
-                    @logger.info(response.body)
-                    false
                   else
                     @logger.info(response.body)
-                    false
+                    raise CrateRuby::CrateError.new(response.body)
                 end
       success
     end
@@ -141,6 +147,30 @@ module CrateRuby
       success
     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 schema_name = 'doc' AND table_name = '#{table_name}'")
+    end
+
+
+    def insert(table_name, attributes)
+      vals = attributes.values.map { |x| x.is_a?(String) ? "'#{x}'" : x }.join(', ')
+      stmt = %Q{INSERT INTO "#{table_name}" (#{attributes.keys.join(', ')}) VALUES (#{vals})}
+      execute(stmt)
+    end
+
+    # Crate is eventually consistent, If you don't query by primary key,
+    # it is not guaranteed that an insert record is found on the next
+    # query. Default refresh value is 1000ms.
+    # Using refresh_table you can force a refresh
+    # @param [String] table_name Name of table to refresh
+    def refresh_table(table_name)
+      execute "refresh table #{table_name}"
+    end
+
     private
 
     def blob_path(table, digest)
@@ -151,7 +181,7 @@ module CrateRuby
       host, port = @servers.first.split(':');
       Net::HTTP.new(host, port)
     end
-    
+
     def request(req)
       connection.start { |http| http.request(req) }
     end

data/lib/crate_ruby/result_set.rb

@@ -4,7 +4,7 @@ module CrateRuby
 
     attr_reader :rowcount, :duration, :cols
 
-    # @param [String] Crate result
+    # @param [String]  result
     def initialize(result)
       result = JSON.parse(result)
       @cols = result['cols']
@@ -23,13 +23,17 @@ module CrateRuby
 
     def each(&block)
       @rows.each(&block)
-      nil
     end
 
     def [](val)
       @rows[val]
     end
 
+    # @return [Array] Returns all rows as Array of arrays
+    def values
+      @rows
+    end
+
     # @param [Array] ary Column names to filer on
     # @return [Array] Filtered rows
     def select_columns(ary, &block)

data/lib/crate_ruby/version.rb

@@ -1,3 +1,3 @@
 module CrateRuby
-  VERSION = "0.0.2"
+  VERSION = "0.0.4"
 end

data/spec/crate_ruby/client_spec.rb

@@ -1,47 +1,46 @@
 require_relative '../spec_helper'
 
 describe CrateRuby::Client do
+  TABLE_NAME = 'blob_table'
   describe '#create_table' do
-    let(:client) { CrateRuby::Client.new }
+    let(:client) { CrateRuby::Client.new(["localhost:#{TEST_PORT}"]) }
 
-    describe 'blob mangament' do
-      let(:table_name) { 'blob_table' }
+    describe 'blob management' do
       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}")
+      before(:all) do
+        CrateRuby::Client.new(["localhost:#{TEST_PORT}"]).execute("create blob TABLE #{TABLE_NAME}")
       end
 
-      after do
-        client.execute("drop blog TABLE #{table_name}")
+      after(:all) do
+        CrateRuby::Client.new(["localhost:#{TEST_PORT}"]).execute("drop blob TABLE #{TABLE_NAME}")
       end
 
       describe '#blob_put' do
 
         after do
-          client.blob_delete(table_name, digest)
+          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
+            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)}
+          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
+            client.blob_delete(TABLE_NAME, digest)
+            client.blob_put TABLE_NAME, digest, string
           end
         end
       end
@@ -50,11 +49,11 @@ describe CrateRuby::Client do
 
         before do
           f = File.read(file_path)
-          client.blob_put(table_name, digest, f)
+          client.blob_put(TABLE_NAME, digest, f)
         end
 
         it 'should download a blob' do
-          data = client.blob_get(table_name, digest)
+          data = client.blob_get(TABLE_NAME, digest)
           data.should_not be_false
           open(store_location, "wb") { |file|
             file.write(data)
@@ -62,31 +61,31 @@ describe CrateRuby::Client do
         end
 
         after do
-          client.blob_delete(table_name, digest)
+          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)
+          client.blob_put(TABLE_NAME, digest, f)
         end
 
         it 'should delete a blob' do
-          client.blob_delete(table_name, digest)
+          client.blob_delete(TABLE_NAME, digest)
         end
       end
     end
 
     describe '#execute' do
-      let(:table_name) { "post" }
+      let(:TABLE_NAME) { "post" }
 
       after do
-        client.execute("drop TABLE #{table_name}").should be_true
+        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
+        client.execute("CREATE TABLE #{TABLE_NAME} (id int)").should be_true
       end
 
     end
@@ -96,10 +95,54 @@ describe CrateRuby::Client do
 
       it 'should use host and ports parameters' do
         logger = double()
-        client = CrateRuby::Client.new ["10.0.0.1:5000"],logger: logger
+        client = CrateRuby::Client.new ["10.0.0.1:5000"], logger: logger
         client.instance_variable_get(:@servers).should eq(["10.0.0.1:5000"])
       end
+    end
+
+    describe '#tables' do
+      before do
+        client.create_table "posts", id: :integer
+        client.create_table "comments", id: :integer
+      end
+
+      after do
+        client.drop_table "posts"
+        client.drop_table "comments"
+      end
+
+      it 'should return all user tables as an array of string values' do
+        client.tables.should eq ['posts', 'comments']
+      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
+          client.insert('posts', id: SecureRandom.uuid, title: "Test" )
+          sleep(1)
+          result_set = client.execute("Select * from posts where title = 'Test'")
+          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

data/spec/crate_ruby/result_set_spec.rb

@@ -56,6 +56,12 @@ describe ResultSet do
     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 +1,2 @@
 require_relative '../lib/crate_ruby'
+TEST_PORT = 4209

data/spec/test_server.rb

@@ -0,0 +1,70 @@
+require 'net/http'
+class TestServer
+  CRATE_PATH = "~/crate"
+  TEST_PORT = 4209
+  NAME = "TestCluster"
+
+
+  def initialize(crate_home = nil, port = nil, host = "127.0.0.1")
+    @crate_home = crate_home || CRATE_PATH
+    @port = port || TEST_PORT
+    @host = host
+  end
+
+  def start
+    cmd = "sh #{CRATE_PATH}/bin/crate #{start_params}"
+    @pid = spawn(cmd, :out => "/tmp/crate_test_server.out", :err => "/tmp/crate_test_server.err")
+    Process.detach(@pid)
+    puts 'starting'
+    time_slept = 0
+    while true
+      puts "Crate not yet fully available. Waiting since #{time_slept} seconds..." unless alive?
+      sleep(2)
+      time_slept += 2
+    end
+  end
+
+  def stop
+    Process.kill("HUP", @pid)
+  end
+
+  private
+
+
+  def crate_exec
+  end
+
+  def crate_config
+  end
+
+  def start_params
+    "-Des.index.storage.type=memory " +
+        "-Des.node.name=#{NAME} " +
+        "-Des.cluster.name=Testing#{@port} " +
+        "-Des.http.port=#{@port}-#{@port} " +
+        "-Des.network.host=localhost " +
+        "-Des.discovery.type=zen " +
+        "-Des.discovery.zen.ping.multicast.enabled=false"
+  end
+
+  def alive?
+    req = Net::HTTP::Get.new('/')
+    resp = Net::HTTP.new(@host, @port)
+    begin
+      response = resp.start { |http| http.request(req) }
+      response.code == "200" ? true : false
+    rescue Errno::ECONNREFUSED
+      false
+    end
+  end
+
+end
+
+server = TestServer.new.start *ARGV
+
+trap("INT") do
+  puts "Script terminated by user."
+  server.stop
+  puts "Server stopped"
+  exit
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: crate_ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - Christoph Klocker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-09 00:00:00.000000000 Z
+date: 2014-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -74,6 +74,7 @@ files:
 - spec/crate_ruby/client_spec.rb
 - spec/crate_ruby/result_set_spec.rb
 - spec/spec_helper.rb
+- spec/test_server.rb
 - spec/uploads/get_logo-crate.png
 - spec/uploads/logo-crate.png
 - spec/uploads/text.txt
@@ -105,6 +106,7 @@ test_files:
 - spec/crate_ruby/client_spec.rb
 - spec/crate_ruby/result_set_spec.rb
 - spec/spec_helper.rb
+- spec/test_server.rb
 - spec/uploads/get_logo-crate.png
 - spec/uploads/logo-crate.png
 - spec/uploads/text.txt