sishen-hbase-ruby 0.2.3 → 0.2.4

data/History.txt

@@ -0,0 +1,2 @@
+v0.1 Jul 29, 2008
+* initial version 

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2007 Dingding Ye
+
+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/Manifest.txt

@@ -0,0 +1,30 @@
+History.txt
+MIT-LICENSE
+Manifest.txt
+README.txt
+Rakefile
+hbase-ruby.gemspec
+lib/hbase.rb
+lib/hbase/client.rb
+lib/hbase/exception.rb
+lib/hbase/model.rb
+lib/hbase/model/column.rb
+lib/hbase/model/column_descriptor.rb
+lib/hbase/model/region_descriptor.rb
+lib/hbase/model/row.rb
+lib/hbase/model/table_descriptor.rb
+lib/hbase/operation/meta_operation.rb
+lib/hbase/operation/row_operation.rb
+lib/hbase/operation/scanner_operation.rb
+lib/hbase/operation/table_operation.rb
+lib/hbase/request.rb
+lib/hbase/request/basic_request.rb
+lib/hbase/request/meta_request.rb
+lib/hbase/request/row_request.rb
+lib/hbase/request/scanner_request.rb
+lib/hbase/request/table_request.rb
+lib/hbase/response.rb
+lib/hbase/response/basic_response.rb
+lib/hbase/response/meta_response.rb
+lib/hbase/response/row_response.rb
+lib/hbase/response/table_response.rb

data/README.txt

@@ -0,0 +1,49 @@
+hbase-ruby is a pure ruby client for HBase using REST interface
+
+== USAGE
+
+First launch HBase:
+
+1.
+{{{
+bin/start-hbase.sh
+}}}
+
+2. ruby code
+{{{
+require 'hbase'
+
+client = HBase::Client.new("http://localhost:60010/api") # this url is the default.
+tables = client.list_tables                              # list available tables
+
+table = client.show_table('users')                       # show the meta info of table users 
+
+row = client.show_row('users', 'sishen')                 # show the data of row 'sishen' in table 'users'
+
+row2 = client.create_row('users', 'sishen', Time.now.to_i, {:name => 'habbit:football', :value => 'i like football'}) # create the row 'sishen' with the data in the table 'users'
+
+client.delete_row('users', 'sishen', nil, 'habbit:football')  # delete the row 'sishen' of table 'users' with the optional column 'habbit:football'
+}}}
+
+3. rails config
+
+For those who wants to use hbase in their rails application, can add this line to the environment.rb
+
+{{{
+config.gem 'sishen-hbase-ruby', :lib => "hbase", :source => "http://gems.github.com"
+}}}
+
+
+== INSTALLTION
+ build the gem:
+
+  rake gem
+
+and install the versioned gem:
+
+  gem install pkg/hbase-ruby-x.x.x.gem 
+
+== Copyright
+
+Copyright (c) 2007 Dingding Ye <yedingding@gmail.com>
+Distributed under MIT License

data/Rakefile

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'hoe'
+
+Hoe.new('hbase-ruby', '0.1') do |p|
+  p.rubyforge_name = 'hbase-ruby'
+  p.author = 'Ye Dingding'
+  p.email = 'yedingding@gmail.com'
+  p.url = 'http://sishen.lifegoo.com'
+  p.summary = 'a pure ruby client for hbase using REST interface'
+  p.description = 'hbase-ruby is a pure ruby client for hbase and enable the ruby app enjoy the power of HBase'
+end

data/hbase-ruby.gemspec

@@ -0,0 +1,31 @@
+Gem::Specification.new do |s|
+  s.name = %q{hbase-ruby}
+  s.version = "0.2.4"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ye Dingding"]
+  s.date = %q{2008-08-09}
+  s.description = %q{hbase-ruby is a pure ruby client for hbase and enable the ruby app enjoy the power of HBase}
+  s.email = %q{yedingding@gmail.com}
+  s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.txt"]
+  s.files = ["History.txt", "MIT-LICENSE", "Manifest.txt", "README.txt", "Rakefile", "hbase-ruby.gemspec", "lib/hbase.rb", "lib/hbase/client.rb", "lib/hbase/exception.rb", "lib/hbase/model.rb", "lib/hbase/model/column.rb", "lib/hbase/model/column_descriptor.rb", "lib/hbase/model/region_descriptor.rb", "lib/hbase/model/row.rb", "lib/hbase/model/table_descriptor.rb", "lib/hbase/operation/meta_operation.rb", "lib/hbase/operation/row_operation.rb", "lib/hbase/operation/scanner_operation.rb", "lib/hbase/operation/table_operation.rb", "lib/hbase/request.rb", "lib/hbase/request/basic_request.rb", "lib/hbase/request/meta_request.rb", "lib/hbase/request/row_request.rb", "lib/hbase/request/scanner_request.rb", "lib/hbase/request/table_request.rb", "lib/hbase/response.rb", "lib/hbase/response/basic_response.rb", "lib/hbase/response/meta_response.rb", "lib/hbase/response/row_response.rb", "lib/hbase/response/table_response.rb"]
+  s.has_rdoc = true
+  s.homepage = %q{http://sishen.lifegoo.com}
+  s.rdoc_options = ["--main", "README.txt"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.2.0}
+  s.summary = %q{a pure ruby client for hbase using REST interface}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if current_version >= 3 then
+      s.add_development_dependency(%q<hoe>, [">= 1.7.0"])
+    else
+      s.add_dependency(%q<hoe>, [">= 1.7.0"])
+    end
+  else
+    s.add_dependency(%q<hoe>, [">= 1.7.0"])
+  end
+end

data/lib/hbase.rb

@@ -0,0 +1,44 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'hbase/client'
+require 'hbase/exception'
+require 'hbase/model'
+require 'hbase/request'
+require 'hbase/response'
+
+module HBase; end
+
+class Object
+  def to_proc
+    proc { |obj, *args| obj.send(self, *args) }
+  end
+
+  def blank?
+    respond_to?(:empty?) ? empty? : !self
+  end
+end
+
+class NilClass #:nodoc:
+  def blank?
+    true
+  end
+end
+
+class Array #:nodoc:
+  alias_method :blank?, :empty?
+end
+
+class Hash #:nodoc:
+  alias_method :blank?, :empty?
+end
+
+class String #:nodoc:
+  def blank?
+    self !~ /\S/
+  end
+
+  def to_b
+    self == "true" ? true : false
+  end
+end

data/lib/hbase/client.rb

@@ -0,0 +1,49 @@
+require 'net/http'
+require 'hbase/operation/meta_operation'
+require 'hbase/operation/table_operation'
+require 'hbase/operation/row_operation'
+require 'hbase/operation/scanner_operation'
+
+module HBase
+  class Client
+    include Operation::MetaOperation
+    include Operation::TableOperation
+    include Operation::RowOperation
+    include Operation::ScannerOperation
+
+    attr_reader :url, :connection
+
+    def initialize(url = "http://localhost:60010/api", opts = {})
+      @url = URI.parse(url)
+      unless @url.kind_of? URI::HTTP
+        raise "invalid http url: #{url}"
+      end
+
+      # Not actually opening the connection yet, just setting up the persistent connection.
+      @connection = Net::HTTP.new(@url.host, @url.port)
+      @connection.read_timeout = opts[:timeout] if opts[:timeout]
+    end
+
+    def get(path)
+      safe_request { @connection.get(@url.path + path) }
+    end
+
+    def post(path, data = nil)
+      safe_request { @connection.post(@url.path + path, data, {'Content-Type' => 'text/xml'}) }
+    end
+
+    def delete(path)
+      safe_request { @connection.delete(@url.path + path) }
+    end
+
+    private
+    def safe_request(&block)
+      response = yield
+      case response
+        when Net::HTTPSuccess then response.body
+      else
+        response.error!
+      end
+    end
+  end
+end

data/lib/hbase/exception.rb

@@ -0,0 +1 @@
+class HBase::Exception < Exception; end

data/lib/hbase/model.rb

@@ -0,0 +1,20 @@
+module HBase
+  module Model
+    class Record
+      def initialize (params)
+        return if params.nil?
+
+        params.each do |key, value|
+          name = key.to_s
+          instance_variable_set("@#{name}", value) if respond_to?(name)
+        end
+      end
+    end
+  end
+end
+
+require 'hbase/model/column'
+require 'hbase/model/column_descriptor'
+require 'hbase/model/region_descriptor'
+require 'hbase/model/row'
+require 'hbase/model/table_descriptor'

data/lib/hbase/model/column.rb

@@ -0,0 +1,9 @@
+module HBase
+  module Model
+    class Column < Record
+      attr_accessor :name
+      attr_accessor :value
+      attr_accessor :timestamp
+    end
+  end
+end

data/lib/hbase/model/column_descriptor.rb

@@ -0,0 +1,32 @@
+module HBase
+  module Model
+    module CompressionType
+      NONE = "NONE"
+      RECORD = "RECORD"
+      BLOCK = "BLOCK"
+
+      def to_compression_type(type_string)
+        case type_string
+        when "NONE"   then NONE
+        when "RECORD" then RECORD
+        when "BLOCK"  then BLOCK
+        else
+          NONE
+        end
+      end
+
+      module_function :to_compression_type
+    end
+
+    class ColumnDescriptor < Record
+      AVAILABLE_OPTS = { :name => "name", :max_versions => "max-versions", :compression => "compression",
+                         :in_memory => "in-memory", :block_cache => "block-cache", :max_cell_size => "max-cell-size",
+                         :ttl => "time-to-live", :bloomfilter => "bloomfilter"}
+      attr_accessor :name
+      attr_accessor :compression
+      attr_accessor :bloomfilter
+      attr_accessor :maximum_cell_size
+      attr_accessor :max_versions
+    end
+  end
+end

data/lib/hbase/model/region_descriptor.rb

@@ -0,0 +1,9 @@
+module HBase
+  module Model
+    class Region < Record
+    end
+
+    class RegionDescriptor < Record
+    end
+  end
+end

data/lib/hbase/model/row.rb

@@ -0,0 +1,10 @@
+module HBase
+  module Model
+    class Row < Record
+      attr_accessor :table_name
+      attr_accessor :name
+      attr_accessor :timestamp
+      attr_accessor :columns
+    end
+  end
+end

data/lib/hbase/model/table_descriptor.rb

@@ -0,0 +1,8 @@
+module HBase
+  module Model
+    class TableDescriptor < Record
+      attr_accessor :name
+      attr_accessor :column_families
+    end
+  end
+end

data/lib/hbase/operation/meta_operation.rb

@@ -0,0 +1,10 @@
+module HBase
+  module Operation
+    module MetaOperation
+      def list_tables
+        request = Request::MetaRequest.new
+        tables = Response::MetaResponse.new(get(request.list_tables), :list_tables).parse
+      end
+    end
+  end
+end

data/lib/hbase/operation/row_operation.rb

@@ -0,0 +1,43 @@
+module HBase
+  module Operation
+    module RowOperation
+      def row_timestamps(table_name, name)
+        raise NotImplementedError, "Currently not supported in native hbase client"
+      end
+
+      def show_row(table_name, name, timestamp = nil, columns = nil, version = nil)
+        request = Request::RowRequest.new(table_name, name, timestamp)
+        row = Response::RowResponse.new(get(request.show(columns, version))).parse
+        row.table_name = table_name
+        row.name = name
+        row.timestamp = timestamp
+        row
+      end
+
+      def create_row(table_name, name, timestamp = nil, *args)
+        request = Request::RowRequest.new(table_name, name, timestamp)
+        data = []
+        if args.instance_of? Array
+          data = args
+        elsif args.instance_of? Hash
+          data = [args]
+        else
+          raise StandardError, "Only Array or Hash data accepted"
+        end
+        xml_data ="<?xml version='1.0' encoding='UTF-8'?><columns>"
+        data.each do |d|
+          xml_data << "<column><name>#{d[:name]}</name>"
+          xml_data << "<value>#{[d[:value]].pack("m") rescue ''}</value></column>"
+        end
+        xml_data << "</columns>"
+
+        Response::RowResponse.new(post(request.create, xml_data))
+      end
+
+      def delete_row(table_name, name, timestamp = nil, columns = nil)
+        request = Request::RowRequest.new(table_name, name, timestamp)
+        Response::RowResponse.new(delete(request.delete(columns)))
+      end
+    end
+  end
+end

data/lib/hbase/operation/scanner_operation.rb

@@ -0,0 +1,6 @@
+module HBase
+  module Operation
+    module ScannerOperation
+    end
+  end
+end

data/lib/hbase/operation/table_operation.rb

@@ -0,0 +1,53 @@
+module HBase
+  module Operation
+    module TableOperation
+      def show_table(name)
+        request = Request::TableRequest.new(name)
+        table_descriptor = Response::TableResponse.new(get(request.show)).parse
+      end
+
+      def create_table(name, *args)
+        request = Request::TableRequest.new(nil)
+
+        raise StandardError, "Table name must be of type String" unless name.instance_of? String
+
+        xml_data = "<?xml version='1.0' encoding='UTF-8'?><table><name>#{name}</name><columnfamilies>"
+        for arg in args
+          if arg.instance_of? String
+            xml_data << "<columnfamily><name>#{arg}</name></columnfamily>"
+          elsif arg.instance_of? Hash
+            xml_data << "<columnfamily>"
+            arg.each do |k,v|
+              if Model::ColumnDescriptor::AVAILABLE_OPTS.include? k
+                xml_data << "<#{Model::ColumnDescriptor::AVAILABLE_OPTS[k]}>#{v}</#{Model::ColumnDescriptor::AVAILABLE_OPTS[k]}>"
+              end
+            end
+            xml_data << "</columnfamily>"
+          else
+            raise StandardError, "#{arg.class.to_s} of #{arg.to_s} is not of Hash Type"
+          end
+        end
+        xml_data << "</columnfamilies></table>"
+        Response::TableResponse.new(post(request.create, xml_data))
+      end
+
+      def delete_table(name)
+        request = Request::TableRequest.new(name)
+        Response::TableResponse.new(delete(request.delete))
+      end
+
+      def enalbe_table(name)
+        request = Request::TableRequest.new(name)
+        Response::TableResponse.new(post(request.enable))
+      end
+
+      def disable_table(name)
+        request = Request::TableRequest.new(name)
+        Response::TableResponse.new(post(request.disable))
+      end
+
+      def table_regions(name, start_row = nil, end_row = nil)
+      end
+    end
+  end
+end

data/lib/hbase/request.rb

@@ -0,0 +1,7 @@
+module HBase; module Request; end; end
+
+require 'hbase/request/basic_request'
+require 'hbase/request/meta_request'
+require 'hbase/request/table_request'
+require 'hbase/request/row_request'
+require 'hbase/request/scanner_request'

data/lib/hbase/request/basic_request.rb

@@ -0,0 +1,13 @@
+require 'cgi'
+
+module HBase
+  module Request
+    class BasicRequest
+      attr_reader :path
+
+      def initialize(path)
+        @path = path
+      end
+    end
+  end
+end

data/lib/hbase/request/meta_request.rb

@@ -0,0 +1,17 @@
+module HBase
+  module Request
+    class MetaRequest < BasicRequest
+      def initialize
+        super("/")
+      end
+
+      def list_tables
+        @path
+      end
+
+      def create_table
+        @path << "/tables"
+      end
+    end
+  end
+end

data/lib/hbase/request/row_request.rb

@@ -0,0 +1,45 @@
+module HBase
+  module Request
+    class RowRequest < BasicRequest
+      attr_reader :table_name
+      attr_reader :name
+      attr_reader :timestamp
+
+      def initialize(table_name, name, timestamp)
+        @table_name, @name, @timestamp = CGI.escape(table_name), CGI.escape(name), timestamp
+        path = "/#{@table_name}/row/#{@name}"
+        path << "/#{@timestamp}" if timestamp
+        super(path)
+      end
+
+      def show(columns = nil, version = nil)
+        if columns
+          if columns.is_a? String
+            columns = [columns]
+          elsif columns.is_a? Array
+          end
+          params = columns.collect { |column| "column=#{column}" }.join('&')
+          @path << "?#{params}"
+          @path << "&version=#{version}" if version
+        end
+        @path
+      end
+
+      def create
+        @path
+      end
+
+      def delete(columns = nil)
+        if columns
+          if columns.is_a? String
+            columns = [columns]
+          elsif columns.is_a? Array
+          end
+          params = columns.collect { |column| "column=#{column}" }.join('&')
+          @path << "?#{params}"
+        end
+        @path
+      end
+    end
+  end
+end

data/lib/hbase/request/scanner_request.rb

@@ -0,0 +1,6 @@
+module HBase
+  module Request
+    class ScannerRequest < BasicRequest
+    end
+  end
+end

data/lib/hbase/request/table_request.rb

@@ -0,0 +1,37 @@
+module HBase
+  module Request
+    class TableRequest < BasicRequest
+      attr_reader :name
+      attr_reader :body
+
+      def initialize(name)
+        super("")
+        @name = CGI.escape(name) if name
+      end
+
+      def show
+        @path << "#{name}"
+      end
+
+      def regions(start_row = nil, end_row = nil)
+        @path << "/#{name}/regions"
+      end
+
+      def create
+        @path << "/"
+      end
+
+      def enable
+        @path << "/#{name}/enable"
+      end
+
+      def disable
+        @path << "/#{name}/disable"
+      end
+
+      def delete
+        @path << "/#{name}"
+      end
+    end
+  end
+end

data/lib/hbase/response.rb

@@ -0,0 +1,6 @@
+module HBase; module Response; end; end
+
+require 'hbase/response/basic_response'
+require 'hbase/response/meta_response'
+require 'hbase/response/table_response'
+require 'hbase/response/row_response'

data/lib/hbase/response/basic_response.rb

@@ -0,0 +1,16 @@
+require 'rexml/document'
+
+module HBase
+  module Response
+    class BasicResponse
+
+      def initialize(raw_data)
+        @raw_data = raw_data
+      end
+
+      def parse
+        parse_content @raw_data
+      end
+    end
+  end
+end

data/lib/hbase/response/meta_response.rb

@@ -0,0 +1,33 @@
+module HBase
+  module Response
+    class MetaResponse < BasicResponse
+      attr_reader :method
+
+      def initialize(raw_data, method)
+        @method = method
+        super(raw_data)
+      end
+
+      def parse_content(raw_data)
+        case @method
+        when :list_tables
+          if raw_data.blank?
+            puts "There are no available tables in the HBase"
+            return nil
+          end
+
+          doc = REXML::Document.new(raw_data)
+          entry = doc.elements["tables"]
+          tables = []
+          entry.elements.each("table") do |table|
+            t = Model::TableDescriptor.new(:name => table.text.strip)
+            tables << t
+          end
+          tables
+        else
+            puts "method '#{@method}' not supported yet"
+        end
+      end
+    end
+  end
+end

data/lib/hbase/response/row_response.rb

@@ -0,0 +1,20 @@
+module HBase
+  module Response
+    class RowResponse < BasicResponse
+      def parse_content(raw_data)
+        doc = REXML::Document.new(raw_data)
+        row = doc.elements["row"]
+        columns = []
+        row.elements.each("column") do |col|
+          name = col.elements["name"].text.strip.unpack("m").first
+          value = col.elements["value"].text.strip.unpack("m").first
+          timestamp = col.elements["timestamp"].text.strip.to_i
+          columns << Model::Column.new(:name => name,
+                                       :value => value,
+                                       :timestamp => timestamp)
+        end
+        Model::Row.new(:columns => columns)
+      end
+    end
+  end
+end

data/lib/hbase/response/table_response.rb

@@ -0,0 +1,28 @@
+module HBase
+  module Response
+    class TableResponse < BasicResponse
+      def parse_content(raw_data)
+        doc = REXML::Document.new(raw_data)
+        table = doc.elements["table"]
+
+        name = table.elements["name"].text.strip
+        column_families = []
+        table.elements["columnfamilies"].elements.each("columnfamily") do |columnfamily|
+          colname = columnfamily.elements["name"].text.strip
+          compression = columnfamily.elements["compression"].text.strip
+          bloomfilter = columnfamily.elements["bloomfilter"].text.strip.to_b
+          max_versions = columnfamily.elements["max-versions"].text.strip.to_i
+          maximum_cell_size = columnfamily.elements["maximum-cell-size"].text.strip.to_i
+
+          column_descriptor = Model::ColumnDescriptor.new(:name => colname,
+                                                          :compression => Model::CompressionType.to_compression_type(compression),
+                                                          :bloomfilter => bloomfilter,
+                                                          :max_versions => max_versions,
+                                                          :maximum_cell_size => maximum_cell_size)
+          column_families << column_descriptor
+        end
+        Model::TableDescriptor.new(:name => name, :column_families => column_families)
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sishen-hbase-ruby
 version: !ruby/object:Gem::Version 
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors: 
 - Ye Dingding