hbase-stargate 1.5.5 → 1.6.0

data/README.textile

@@ -1,7 +1,6 @@
 h1. hbase-stargate
 
-A Ruby client for HBase (http://hadoop.apache.org/hbase) that works with the Stargate interface.
-Stargate is the RESTful web service front end for HBase that can serve up a number of formats including XML, JSON, and protobufs.
+A Ruby client for HBase (http://hadoop.apache.org/hbase) that works with the REST (previously known as Stargate) interface. The RESTful web service front end for HBase can serve up a number of formats including XML, JSON, and protobufs.
 
 This project is based off the work of Dingding Ye <yedingding@gmail.com> at http://github.com/sishen/hbase-ruby
 
@@ -9,11 +8,11 @@ This project is based off the work of Dingding Ye <yedingding@gmail.com> at http
 h2. Installation
 
 <pre>
-<code>$ gem install hbase-stargate -s http://gemcutter.org</code>
+<code>$ gem install hbase-stargate</code>
 </pre>
 
 To work with this gem in your Rails application, add this to the environment.rb file:
-<pre><code>config.gem 'hbase-stargate', :lib => "stargate", :source => "http://gemcutter.org"</code></pre>
+<pre><code>config.gem 'hbase-stargate', :lib => "stargate"</code></pre>
 
 To build the gem yourself:
 <pre><code>$ rake build</code></pre>
@@ -24,12 +23,10 @@ h2. Getting Started
  # Download and unpack the most recent release of HBase from http://hadoop.apache.org/hbase/releases.html#Download
  # Edit <hbase-dir>/conf/hbase-env.sh and uncomment/modify the following line to correspond to your Java home path:
 export JAVA_HOME=/usr/lib/jvm/java-6-sun
- # Copy <hbase-dir>/contrib/stargate/hbase-<version>-stargate.jar into <hbase-dir>/lib
- # Copy all the files in the <hbase-dir>/contrib/stargate/lib folder into <hbase-dir>/lib
  # Start up HBase:
 $ <hbase-dir>/bin/start-hbase.sh
  # Start up Stargate (append "-p 1234" at the end if you want to change the port):
-$ <hbase-dir>/bin/hbase org.apache.hadoop.hbase.stargate.Main
+$ <hbase-dir>/bin/hbase rest start
 
 
 h2. Usage

data/Rakefile

@@ -4,6 +4,5 @@ require 'bundler/gem_helper'
 Bundler::GemHelper.install_tasks
 
 RSpec::Core::RakeTask.new do |t|
-  t.rspec_opts = ["-c", "-f progress", "-r ./spec/spec_helper.rb"]
   t.pattern = 'spec/**/*_spec.rb'
 end

data/hbase-stargate.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+require 'stargate/version'
+
+Gem::Specification.new do |s|
+  s.name = "hbase-stargate"
+  s.version     = Stargate::VERSION
+  s.authors = ["Hopper"]
+  s.summary = %q{Ruby client for HBase's Stargate web service}
+  s.description = %q{A Ruby client used to interact with HBase through its Stargate web service front-end}
+  s.email = %q{greg.lu@gmail.com}
+  s.homepage = %q{http://github.com/greglu/hbase-stargate}
+
+  s.platform    = Gem::Platform::RUBY
+  s.required_rubygems_version = ">= 1.3.6"
+
+  s.files = Dir.glob("lib/**/*") + %w(LICENSE README.textile Rakefile hbase-stargate.gemspec)
+  s.test_files = Dir.glob("spec/**/*")
+  s.require_paths = ["lib"]
+
+  s.add_dependency(%q<yajl-ruby>, [">= 0"])
+  s.add_dependency(%q<patron>, [">= 0"])
+
+  s.add_development_dependency "rspec"
+end

data/lib/stargate/client.rb

@@ -1,8 +1,8 @@
-require 'net/http'
-require File.dirname(__FILE__) + '/operation/meta_operation'
-require File.dirname(__FILE__) + '/operation/table_operation'
-require File.dirname(__FILE__) + '/operation/row_operation'
-require File.dirname(__FILE__) + '/operation/scanner_operation'
+require 'patron'
+require 'stargate/operation/meta_operation'
+require 'stargate/operation/table_operation'
+require 'stargate/operation/row_operation'
+require 'stargate/operation/scanner_operation'
 
 module Stargate
   class Client
@@ -19,14 +19,12 @@ module Stargate
         raise "invalid http url: #{url}"
       end
 
+      @connection = Patron::Session.new
+      @connection.base_url = url
+      @connection.timeout = opts[:timeout] unless opts[:timeout].nil?
+
       # Not actually opening the connection yet, just setting up the persistent connection.
-      if opts[:proxy]
-        proxy_address, proxy_port = opts[:proxy].split(':')
-        @connection = Net::HTTP.Proxy(proxy_address, proxy_port).new(@url.host, @url.port)
-      else
-        @connection = Net::HTTP.new(@url.host, @url.port)
-      end
-      @connection.read_timeout = opts[:timeout] if opts[:timeout]
+      @connection.proxy = opts[:proxy] unless opts[:proxy].nil?
     end
 
     def get(path, options = {})
@@ -66,22 +64,19 @@ module Stargate
       def safe_response(&block)
         begin
           yield
-        rescue Errno::ECONNREFUSED
-          raise ConnectionNotEstablishedError, "can't connect to #{@url}"
-        rescue Timeout::Error => e
-          puts e.backtrace.join("\n")
-          raise ConnectionTimeoutError, "execution expired. Maybe query disabled tables"
+        rescue => e
+          raise ConnectionNotEstablishedError, "Connection problem with HBase rest server #{@url}:\n#{e.message}"
         end
       end
 
       def safe_request(&block)
         response = safe_response{ yield block }
 
-        case response
-        when Net::HTTPSuccess
+        case response.status
+        when 200
           response.body
         else
-          response.error!
+          raise response.status_line
         end
       end
 

data/lib/stargate/model/row.rb

@@ -5,14 +5,6 @@ module Stargate
       attr_accessor :name
       attr_accessor :total_count
       attr_accessor :columns
-
-      def timestamp
-        warn "[DEPRECATION] timestamp attribute will be removed from the Row model. "
-      end
-
-      def timestamp=
-        timestamp
-      end
     end
   end
 end

data/lib/stargate/model/scanner.rb

@@ -8,9 +8,6 @@ module Stargate
       attr_accessor :table_name
       attr_accessor :scanner_url
       attr_accessor :batch_size
-
-      # Deprecation: scanner_url is used instead of just the ID
-      attr_accessor :scanner_id
     end
   end
 end

data/lib/stargate/model.rb

@@ -11,9 +11,9 @@ module Stargate
   end
 end
 
-require File.dirname(__FILE__) + '/model/column'
-require File.dirname(__FILE__) + '/model/column_descriptor'
-require File.dirname(__FILE__) + '/model/region_descriptor'
-require File.dirname(__FILE__) + '/model/row'
-require File.dirname(__FILE__) + '/model/table_descriptor'
-require File.dirname(__FILE__) + '/model/scanner'
+require 'stargate/model/column'
+require 'stargate/model/column_descriptor'
+require 'stargate/model/region_descriptor'
+require 'stargate/model/row'
+require 'stargate/model/table_descriptor'
+require 'stargate/model/scanner'

data/lib/stargate/operation/row_operation.rb

@@ -29,7 +29,7 @@ module Stargate
             end
             rows
           end
-        rescue Net::ProtocolError => e
+        rescue => e
           # TODO: Use better handling instead of this.
           if e.to_s.include?("Table")
             raise TableNotFoundError, "Table '#{table_name}' Not Found"
@@ -49,7 +49,7 @@ module Stargate
             elsif columns.instance_of? Hash
               data = [columns]
             else
-              raise StandardError, "Only Array or Hash data accepted"
+              raise ArgumentError, "Column data should be given as an Array or Hash"
             end
           end
 
@@ -66,7 +66,7 @@ module Stargate
           xml_data << "</Row></CellSet>"
 
           Response::RowResponse.new(post_response(request.create(data.map{|col| col[:name]}), xml_data), :create_row).parse
-        rescue Net::ProtocolError => e
+        rescue => e
           if e.to_s.include?("Table")
             raise TableNotFoundError, "Table '#{table_name}' Not Found"
           elsif e.to_s.include?("Row")
@@ -81,7 +81,7 @@ module Stargate
         begin
           request = Request::RowRequest.new(table_name, name, timestamp)
           Response::RowResponse.new(delete_response(request.delete(columns)), :delete_row).parse
-        rescue Net::ProtocolError => e
+        rescue => e
           if e.to_s.include?("Table")
             raise TableNotFoundError, "Table '#{table_name}' Not Found"
           elsif e.to_s.include?("Row")

data/lib/stargate/operation/scanner_operation.rb

@@ -43,7 +43,7 @@ module Stargate
           scanner.table_name = table_name
           scanner.batch_size = batch
           scanner
-        rescue Net::ProtocolError => e
+        rescue => e
           raise StandardError, e.to_s
         end
       end
@@ -56,7 +56,7 @@ module Stargate
           rows = []
           begin
             # Loop until we've reached the limit, or the scanner was exhausted (HTTP 204 returned)
-            until (limit && rows.size >= limit) || (response = get_response(request_url)).code == "204"
+            until (limit && rows.size >= limit) || (response = get_response(request_url)).status == 204
               rows.concat Response::ScannerResponse.new(response.body, :get_rows).parse
 
               rows.each do |row|
@@ -69,7 +69,7 @@ module Stargate
 
           # Prune the last few rows if the limit was passed.
           (limit) ? rows.slice(0, limit) : rows
-        rescue StandardError => e
+        rescue => e
           if e.to_s.include?("TableNotFoundException")
             raise TableNotFoundError, "Table #{table_name} Not Found!"
           else
@@ -82,7 +82,7 @@ module Stargate
         begin
           request = Request::ScannerRequest.new(scanner.table_name)
           Response::ScannerResponse.new(delete_response(request.close(scanner)), :close_scanner).parse
-        rescue StandardError => e
+        rescue => e
           if e.to_s.include?("TableNotFoundException")
             raise TableNotFoundError, "Table #{table_name} Not Found!"
           else

data/lib/stargate/operation/table_operation.rb

@@ -5,16 +5,15 @@ module Stargate
         begin
           request = Request::TableRequest.new(name)
           Response::TableResponse.new(get(request.show)).parse
-        rescue Net::ProtocolError
+        rescue => e
           raise TableNotFoundError, "Table '#{name}' Not found"
         end
       end
 
       def create_table(name, *args)
-        request = Request::TableRequest.new(name)
-
         raise StandardError, "Table name must be of type String" unless name.instance_of? String
 
+        request = Request::TableRequest.new(name)
         begin
           xml_data = "<?xml version='1.0' encoding='UTF-8' standalone='yes'?><TableSchema name='#{name}' IS_META='false' IS_ROOT='false'>"
           for arg in args
@@ -35,17 +34,16 @@ module Stargate
             end
           end
           xml_data << "</TableSchema>"
-          Response::TableResponse.new(post(request.create, xml_data))
-        rescue Net::ProtocolError => e
-          if e.to_s.include?("TableExistsException")
-            raise TableExistsError, "Table '#{name}' already exists"
-          else
-            raise TableFailCreateError, e.message
-          end
+
+          put_response(request.create, xml_data).status == 201
+        rescue => e
+          raise TableFailCreateError, e.message
         end
       end
 
       def alter_table(name, *args)
+        raise NotImplementedError, "Altering the table is not supported yet"
+
         raise StandardError, "Table name must be of type String" unless name.instance_of? String
 
         request = Request::TableRequest.new(name)
@@ -53,7 +51,7 @@ module Stargate
         begin
           xml_data = construct_xml_stream(name, *args)
           Response::TableResponse.new(put(request.update, xml_data))
-        rescue Net::ProtocolError => e
+        rescue => e
           if e.to_s.include?("TableNotFoundException")
             raise TableNotFoundError, "Table '#{name}' not exists"
           else
@@ -66,7 +64,7 @@ module Stargate
         begin
           request = Request::TableRequest.new(name)
           Response::TableResponse.new(delete(request.delete(columns)))
-        rescue Net::ProtocolError => e
+        rescue => e
           if e.to_s.include?("TableNotFoundException")
             raise TableNotFoundError, "Table '#{name}' not exists"
           elsif e.to_s.include?("TableNotDisabledException")

data/lib/stargate/request.rb

@@ -1,7 +1,7 @@
 module Stargate module Request; end; end
 
-require File.dirname(__FILE__) + '/request/basic_request'
-require File.dirname(__FILE__) + '/request/meta_request'
-require File.dirname(__FILE__) + '/request/table_request'
-require File.dirname(__FILE__) + '/request/row_request'
-require File.dirname(__FILE__) + '/request/scanner_request'
+require 'stargate/request/basic_request'
+require 'stargate/request/meta_request'
+require 'stargate/request/table_request'
+require 'stargate/request/row_request'
+require 'stargate/request/scanner_request'

data/lib/stargate/response/basic_response.rb

@@ -1,8 +1,12 @@
 begin
-  require 'json'
+  require 'yajl/json_gem'
 rescue LoadError => e
-  puts "[hbase-stargate] json is required. Install it with 'gem install json' (or json-jruby for JRuby)"
-  raise e
+  begin
+    require 'json'
+  rescue LoadError => e
+    puts "[hbase-stargate] json is required. Install it with 'gem install json' (or json-jruby for JRuby)"
+    raise e
+  end
 end
 
 module Stargate
@@ -18,8 +22,8 @@ module Stargate
       end
 
       def verify_success(response)
-        case response
-        when Net::HTTPSuccess
+        case response.status
+        when 200
           true
         else
           false

data/lib/stargate/response/scanner_response.rb

@@ -11,26 +11,24 @@ module Stargate
       def parse_content(raw_data)
         case @method
         when :open_scanner
-          case raw_data
-          when Net::HTTPCreated
-            Stargate::Model::Scanner.new(:scanner_url => raw_data["Location"])
+          case raw_data.status
+          when 201
+            Stargate::Model::Scanner.new(:scanner_url => raw_data.headers["Location"])
+          when 404
+            raise TableNotFoundError, "Table #{table_name} Not Found!"
           else
-            if raw_data.message.include?("TableNotFoundException")
-              raise TableNotFoundError, "Table #{table_name} Not Found!"
-            else
-              raise StandardError, "Unable to open scanner. Received the following message: #{raw_data.message}"
-            end
+            raise StandardError, "Unable to open scanner. Received the following message: #{raw_data.status_line}"
           end
         when :get_rows
           # Dispatch it to RowResponse, since that method is made
           # to deal with rows already.
           RowResponse.new(raw_data, :show_row).parse
         when :close_scanner
-          case raw_data
-          when Net::HTTPOK
+          case raw_data.status
+          when 200
             return true
           else
-            raise StandardError, "Unable to close scanner. Received the following message: #{raw_data.message}"
+            raise StandardError, "Unable to close scanner. Received the following message: #{raw_data.status_line}"
           end
         else
           puts "method '#{@method}' not supported yet"

data/lib/stargate/response.rb

@@ -1,7 +1,7 @@
 module Stargate module Response; end; end
 
-require File.dirname(__FILE__) + '/response/basic_response'
-require File.dirname(__FILE__) + '/response/meta_response'
-require File.dirname(__FILE__) + '/response/table_response'
-require File.dirname(__FILE__) + '/response/row_response'
-require File.dirname(__FILE__) + '/response/scanner_response'
+require 'stargate/response/basic_response'
+require 'stargate/response/meta_response'
+require 'stargate/response/table_response'
+require 'stargate/response/row_response'
+require 'stargate/response/scanner_response'

data/lib/stargate/version.rb

@@ -1,3 +1,3 @@
 module Stargate
-  VERSION = "1.5.5"
+  VERSION = "1.6.0"
 end

data/lib/stargate.rb

@@ -1,7 +1,11 @@
 module Stargate end
 
-require File.join(File.dirname(__FILE__), "stargate", "client")
-require File.join(File.dirname(__FILE__), "stargate", "exception")
-require File.join(File.dirname(__FILE__), "stargate", "model")
-require File.join(File.dirname(__FILE__), "stargate", "request")
-require File.join(File.dirname(__FILE__), "stargate", "response")
+require 'pathname'
+pwd = Pathname(__FILE__).dirname
+$:.unshift(pwd.to_s) unless $:.include?(pwd.to_s) || $:.include?(pwd.expand_path.to_s)
+
+require 'stargate/client'
+require 'stargate/exception'
+require 'stargate/model'
+require 'stargate/request'
+require 'stargate/response'

data/spec/hbase-stargate/operation/meta_operation_spec.rb

@@ -7,6 +7,12 @@ describe Stargate::Operation::MetaOperation do
     @client = Stargate::Client.new(url)
   end
 
+  it "should return ConnectionNotEstablishedError when server cannot be connected to" do
+    lambda {
+      Stargate::Client.new("http://doesntexist.local:8080").list_tables
+    }.should raise_error(Stargate::ConnectionNotEstablishedError)
+  end
+
   it "should return tables" do
     tables = @client.list_tables
     tables.should respond_to(:size)

data/spec/hbase-stargate/operation/row_operation_spec.rb

@@ -3,6 +3,7 @@ require File.join(File.dirname(__FILE__), "..", "..", "spec_helper")
 describe Stargate::Operation::RowOperation do
   before :all do
     url = ENV["STARGATE_URL"].nil? ? "http://localhost:8080" : ENV["STARGATE_URL"]
+
     @client = Stargate::Client.new(url)
 
     table = @client.create_table("test-hbase-stargate", "col1")

data/spec/hbase-stargate/operation/table_operation_spec.rb

@@ -7,16 +7,16 @@ describe Stargate::Operation::TableOperation do
   end
 
   it "should create a table called test-hbase-stargate" do
-    table = @client.create_table('test-hbase-stargate', { :name => 'habbit',
-                                   :max_version => 3,
-                                   :compression => Stargate::Model::CompressionType::NONE,
-                                   :in_memory => false,
-                                   :block_cache => false,
-                                   :ttl => -1,
-                                   :max_cell_size => 2147483647,
-                                   :bloomfilter => false
-                                 })
-    table.should.is_a? Stargate::Model::TableDescriptor
+    @table_options = { :name => 'habbit',
+                       :max_version => 3,
+                       :compression => Stargate::Model::CompressionType::NONE,
+                       :in_memory => false,
+                       :block_cache => false,
+                       :ttl => -1,
+                       :max_cell_size => 2147483647,
+                       :bloomfilter => false
+                     }
+    @client.create_table('test-hbase-stargate', @table_options).should be_true
   end
 
   it "should show the table info of 'test-hbase-stargate'" do
@@ -26,10 +26,19 @@ describe Stargate::Operation::TableOperation do
     table.column_families.should respond_to(:each)
     table.column_families.map(&:name).should include("habbit")
     table.column_families.each do |cf|
-      cf.should.is_a? Stargate::Model::ColumnDescriptor
+      cf.should be_a_kind_of Stargate::Model::ColumnDescriptor
+      cf.max_versions.should == 3
+      cf.bloomfilter.should be_false
+      cf.compression.should == "NONE"
     end
   end
 
+  it "should throw an error when trying to run alter_table" do
+    lambda {
+      @client.alter_table("test-hbase-stargate")
+    }.should raise_error(NotImplementedError)
+  end
+
   it "should delete the table 'test-hbase-stargate'" do
     lambda {
       table = @client.destroy_table("test-hbase-stargate")

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
 require 'rubygems'
 require 'rspec'
-require File.expand_path(File.join(File.dirname(__FILE__), "..", "lib", "stargate"))
+
+$:.unshift File.dirname(__FILE__) + '/../lib'
+require 'stargate'

metadata

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: hbase-stargate
 version: !ruby/object:Gem::Version 
-  hash: 9
   prerelease: 
-  segments: 
-  - 1
-  - 5
-  - 5
-  version: 1.5.5
+  version: 1.6.0
 platform: ruby
 authors: 
 - Hopper
@@ -15,37 +10,41 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-27 00:00:00 -05:00
-default_executable: 
+date: 2011-11-04 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: json
+  name: yajl-ruby
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: patron
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
-  type: :development
+  type: :runtime
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id003
 description: A Ruby client used to interact with HBase through its Stargate web service front-end
 email: greg.lu@gmail.com
 executables: []
@@ -85,6 +84,7 @@ files:
 - LICENSE
 - README.textile
 - Rakefile
+- hbase-stargate.gemspec
 - spec/hbase-stargate/model/column_descriptor_spec.rb
 - spec/hbase-stargate/model/column_spec.rb
 - spec/hbase-stargate/model/region_descriptor_spec.rb
@@ -104,9 +104,7 @@ files:
 - spec/hbase-stargate/response/row_response_spec.rb
 - spec/hbase-stargate/response/scanner_response_spec.rb
 - spec/hbase-stargate/response/table_response_spec.rb
-- spec/spec.opts
 - spec/spec_helper.rb
-has_rdoc: true
 homepage: http://github.com/greglu/hbase-stargate
 licenses: []
 
@@ -120,25 +118,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 23
-      segments: 
-      - 1
-      - 3
-      - 6
       version: 1.3.6
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.5.3
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: Ruby client for HBase's Stargate web service
@@ -162,5 +152,4 @@ test_files:
 - spec/hbase-stargate/response/row_response_spec.rb
 - spec/hbase-stargate/response/scanner_response_spec.rb
 - spec/hbase-stargate/response/table_response_spec.rb
-- spec/spec.opts
 - spec/spec_helper.rb

data/spec/spec.opts

@@ -1,4 +0,0 @@
---color
---format specdoc
---loadby mtime
---reverse