ruby-hbase 0.0.4

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2007-10-25
+
+* 1 major enhancement:
+  * Initial release

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2007 FIXME full name
+
+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,29 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+config/hoe.rb
+config/requirements.rb
+lib/ruby-hbase.rb
+lib/ruby-hbase/version.rb
+lib/ruby-hbase/xml_decoder.rb
+lib/ruby-hbase/hbase_table.rb
+lib/ruby-hbase/scanner.rb
+log/debug.log
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/website.rake
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.rhtml
+spec/spec_helper.rb
+spec/htable_spec.rb
+spec/scanner_spec.rb
+spec/spec_helper.rb

data/README.txt

@@ -0,0 +1 @@
+README

data/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/config/hoe.rb

@@ -0,0 +1,70 @@
+require 'ruby-hbase/version'
+
+AUTHOR = 'Bryan Duxbury'  # can also be an array of Authors
+EMAIL = "bryan@rapleaf.com"
+DESCRIPTION = "Client library for interacting with HBase the Hadoop database."
+GEM_NAME = 'ruby-hbase' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'rapleaf' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "unknown"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil 
+# UNCOMMENT IF REQUIRED: 
+# REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
+VERS = RubyHbase::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'ruby-hbase documentation',
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' } 
+    @extra_deps
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.author = AUTHOR 
+  p.description = DESCRIPTION
+  p.email = EMAIL
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\\n\\n")
+  #p.extra_deps = []     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
+  
+  #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  
+end
+
+CHANGES = hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')

data/config/requirements.rb

@@ -0,0 +1,17 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))
+
+require 'ruby-hbase'

data/lib/ruby-hbase.rb

@@ -0,0 +1,10 @@
+$:.unshift File.dirname(__FILE__)
+
+require "rubygems"
+require "net/http"
+require "erb"
+require "xml/libxml"
+
+require "ruby-hbase/xml_decoder"
+require "ruby-hbase/hbase_table"
+require "ruby-hbase/scanner"

data/lib/ruby-hbase/hbase_table.rb

@@ -0,0 +1,167 @@
+module HBase
+  class RowNotFound < Exception
+    def initialize(msg=nil)
+      super
+    end
+  end
+  
+  class HTable    
+    include XmlDecoder
+    
+    def initialize(table_uri)
+      @table_uri = table_uri
+
+      @uri = URI.parse(table_uri)
+      
+      @host, @table_name = @uri.host, @uri.path.split("/").last
+    end
+
+    def name
+      @table_name
+    end
+
+    ######################
+    # Meta-type requests
+
+    def start_keys
+      raise NotImplementedError
+    end
+
+
+    def column_descriptors
+      column_families = []
+      
+      # get the xml for the column descriptors
+      response = Net::HTTP.get_response(@uri.host, "/api/#{@table_name}", @uri.port)
+      body = response.body
+      
+      # parse the xml into a document
+      doc = XML::Parser.string(body).parse
+      
+      doc.find("/table/columnfamilies/columnfamily").each do |node|
+        colfam = {}
+        colfam[:name] = node.find_first("name").content.strip.chop
+        column_families << colfam
+      end
+      column_families
+    end    
+
+    
+    #####################
+    # Standard CRUD ops
+    
+    DEFAULT_GET_OPTIONS = {:timestamp => nil, :columns => nil}
+    
+    def get(key, options = {})
+      opts = DEFAULT_GET_OPTIONS.merge(options)
+      
+      columns = Array(opts.delete(:columns)).compact
+      timestamp = opts.delete(:timestamp)
+      timestamp = (timestamp.to_f * 1000).to_i.to_s if timestamp
+      
+      Net::HTTP.start(@uri.host, @uri.port) do |session|
+        columns_query = columns.map{ |name| "column=#{name}" }.join("&")
+
+        ts_section = timestamp ? "/#{timestamp}" : ""
+
+        query_string = "?" + columns_query
+                      
+        query = "/api/#{@table_name}/row/#{url_encode(key)}#{ts_section}#{query_string}"
+        response = session.get(query, {"Accept" => "*/*"})
+
+        case response.code.to_i
+          when 200 #success!
+            body = response.body
+          
+            parse_row_result(body).last
+          when 204 #no data - probably an incorrect colname
+            raise "Didn't get any data back - check your column names!"
+          when 404
+            raise RowNotFound, "Could not find row '#{key}'"
+          else
+            nil
+        end
+      end
+    end
+    
+    def put(key, keys_and_values, timestamp = nil)
+      Net::HTTP.start(@uri.host, @uri.port) do |session|
+        xml = "<columns>"
+        
+        ts_section = timestamp ? "/#{(timestamp.to_f * 1000).to_i}" : ""
+        
+        keys_and_values.each do |name, value|
+          xml << "<column><name>#{name}</name><value>#{[value.to_s].pack("m")}</value></column>"          
+        end
+        
+        xml << "</columns>"
+        
+        query = "/api/#{@table_name}/row/#{url_encode(key)}#{ts_section}"
+        response = session.post(query, xml, {"Content-type" => "text/xml"})
+        
+        case response.code.to_i
+          when 200
+            true
+          else
+            unexpected_response(response)
+        end
+      end
+    end
+        
+    def delete(row, columns = nil, timestamp = nil)
+      Net::HTTP.start(@uri.host, @uri.port) do |session|
+        columns_query = Array(columns).compact.map{ |name| "column=#{name}" }.join("&")
+        
+        response = session.delete("/api/#{@table_name}/row/#{row}?#{columns_query}")  
+        case response.code.to_i
+          when 202
+            return true
+          else
+            unexpected_response(response)
+        end
+
+      end
+    end
+    
+    #######################
+    # Scanning interface
+    
+    def get_scanner(start_row, end_row, timestamp = nil, columns = nil)
+      start_row_query = start_row ? "start_row=#{start_row}" : nil
+      end_row_query = end_row ? "end_row=#{end_row}" : nil      
+      timestamp_section = timestamp ? "/#{(timestamp.to_f * 1000).to_i}" : nil
+      columns_section = columns ? columns.map{ |col| "column=#{col}" }.join("&") : nil
+
+      query_string = [start_row_query, end_row_query, 
+                      timestamp_section, columns_section].compact.join("&")
+
+      path = ""
+
+      # open the scanner
+      Net::HTTP.start(@uri.host, @uri.port) do |session|
+        response = session.post("/api/#{@table_name}/scanner?#{query_string}", 
+          "", {"Accept" => "text/xml"}
+        )
+        
+        case response.code.to_i
+          when 201
+            # redirect - grab the path and send
+            Scanner.new(self, "http://#{@uri.host}:#{@uri.port}" + response["Location"])
+          else
+            unexpected_response(response)
+        end
+      end      
+    end
+    
+    
+    private
+      
+    def url_encode(str)
+      ERB::Util.url_encode(str)
+    end
+    
+    def unexpected_response(response)
+      raise "Unexpected response code #{response.code.to_i}:\n#{response.body}"
+    end
+  end
+end

data/lib/ruby-hbase/scanner.rb

@@ -0,0 +1,55 @@
+module HBase
+  class Scanner
+    include XmlDecoder
+    
+    def initialize(table, scanner_uri)
+      @table, @scanner_uri = table, scanner_uri
+    end
+    
+    def close
+      
+    end
+    
+    def next
+      
+    end
+    
+    def each
+      parsed_uri = URI.parse(@scanner_uri)
+      Net::HTTP.start(parsed_uri.host, parsed_uri.port) do |session|
+        while true
+          response = session.post(@scanner_uri, "")
+
+          case response.code.to_i
+            when 404
+              # over
+              break
+            when 200
+              # item
+              yield *parse_row_result(response.body)
+            else
+              # error
+              raise "Unexpected response code #{response.code}, body:\n#{response.body}"
+          end
+        end
+      end
+    end
+
+    private
+    
+    # def parse_row(xml)
+    #   doc = REXML::Document.new(xml)
+    # 
+    #   result = {}
+    # 
+    #   doc.root.each_element("/row/column") do |column|
+    #     name = column.get_elements("name")[0].text.strip
+    #     value = column.get_elements("value")[0].text.strip.unpack("m").first
+    #     result[name] = value
+    #   end
+    #   
+    #   [doc.root.get_elements("name")[0].text.strip, result]
+    # end
+    
+  end
+end

data/lib/ruby-hbase/version.rb

@@ -0,0 +1,9 @@
+module RubyHbase #:nodoc:
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 4
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/lib/ruby-hbase/xml_decoder.rb

@@ -0,0 +1,18 @@
+module HBase
+  module XmlDecoder
+    def parse_row_result(xml)
+      doc = XML::Parser.string(xml).parse
+
+      name_node = doc.root.find_first("/row/name")
+      name = name_node ? name_node.content.strip : nil
+      
+      values = {}
+      
+      doc.find("/row/column").each do |node|
+        values[node.find_first("name").content.strip] = node.find_first("value").content.strip.unpack("m").first
+      end
+      
+      [name, values]
+    end
+  end
+end

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.join(File.dirname(__FILE__), '..')
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.join(File.dirname(__FILE__), '..')
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme]
+RubiGen::Scripts::Generate.new.run(ARGV)