hbasegate 0.1.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/Gemfile

@@ -0,0 +1,5 @@
+source 'http://rubygems.org'
+
+group :development do
+  gem 'minitest-reporters', '>= 0.5.0'
+end

data/Gemfile.lock

@@ -0,0 +1,21 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ansi (1.4.3)
+    builder (3.2.0)
+    hashie (2.0.3)
+    minitest (4.7.1)
+    minitest-reporters (0.14.16)
+      ansi
+      builder
+      minitest (>= 2.12, < 5.0)
+      powerbar
+    powerbar (1.0.11)
+      ansi (~> 1.4.0)
+      hashie (>= 1.1.0)
+
+PLATFORMS
+  java
+
+DEPENDENCIES
+  minitest-reporters (>= 0.5.0)

data/README.md

@@ -0,0 +1,62 @@
+hbasegate
+=========
+
+JRuby gem wrapping Java API for HBase
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hbasegate'
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install hbasegate
+
+## Usage
+
+Require the gem
+
+    $ require 'hbasegate'
+
+Create your configuration. This is optional since you can also define the config in a hbase-site.xml file as
+shown in <a href"http://hbase.apache.org/book/config.files.html#client_dependencies">the hbase book</a>. The
+minimal configuration is the specification of one or more ZooKeeper servers. This is used to find the HBase
+API.
+
+    $ config = HBaseGate::HBaseConfiguration.create
+    $ config['hbase.zookeeper.quorum'] = 'zk1.test.com, zk2.test.com'
+
+Get a handle to the table:
+
+    $ table = HBaseGate::HTable.new(config, 'test_db')
+
+And use it:
+
+    $ r = table.get('me')
+    $ puts r
+
+You specify column families, columns and values in an array of arrays. Each element of the inner array specifies on
+item.
+
+    $ r = table.get('me', [['family']])
+    $ r = table.get('me', [['family', 'column']])
+    $ r = table.get('me', [['family1', 'column1'], ['family2', 'column2']])
+    $ r = table.put('me', [['family1', 'column1', 'value1'], ['family2', 'column2', 'value2']])
+    $ r = table.delete('me')
+    $ r = table.delete('me', [['family']])
+    $ r = table.delete('me', [['family', 'column']])
+
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/hbasegate.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hbasegate/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hbasegate"
+  spec.version       = HBaseGate::VERSION
+  spec.authors       = ["Knut O. Hellan"]
+  spec.email         = ["knut.hellan@gmail.com"]
+  spec.description   = %q{JRuby gem wrapping Java API for HBase}
+  spec.summary       = %q{More ruby friendly API than using Java directly}
+  spec.homepage      = "http://github.com/khellan/hbasegate"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.3"
+end

data/lib/hbasegate/hbase_configuration.rb

@@ -0,0 +1,16 @@
+module HBaseGate
+  java_import 'org.apache.hadoop.conf.Configuration'
+  java_import 'org.apache.hadoop.hbase.HBaseConfiguration'
+
+  class Configuration
+    # Retrieve the value stored for name.
+    def [](name)
+      get(name)
+    end
+
+    # Store value for name.
+    def []=(name, value)
+      set(name, value)
+    end
+  end
+end

data/lib/hbasegate/htable.rb

@@ -0,0 +1,48 @@
+module HBaseGate
+  java_import 'org.apache.hadoop.hbase.client.Delete'
+  java_import 'org.apache.hadoop.hbase.client.Get'
+  java_import 'org.apache.hadoop.hbase.client.HTable'
+  java_import 'org.apache.hadoop.hbase.client.Put'
+
+  class HTable
+    alias_method :original_delete, :delete
+    alias_method :original_get, :get
+    alias_method :original_put, :put
+
+    # Read row key with an array of family, column arrays.
+    def get(key, entries = nil)
+      get = Get.new(key.to_java_bytes)
+      augment_action(entries, get.method(:add_family), get.method(:add_column))
+      original_get(get).to_h
+    end
+
+    # Store row key with an array of family, column, value arrays.
+    def put(key, entries = nil)
+      put = Put.new(key.to_java_bytes)
+      (entries || []).each.each do |family, qualifier, value|
+        put.add(family.to_java_bytes, qualifier.to_java_bytes, value.to_java_bytes)
+      end
+      original_put(put)
+    end
+
+    # Delete row key with an array of family, column arrays.
+    def delete(key, entries = nil)
+      delete = Delete.new(key.to_java_bytes)
+      augment_action(entries, delete.method(:delete_family), delete.method(:delete_column))
+      original_delete(delete)
+    end
+
+    private
+    # Iterate over the entries and use the given functions on them.
+    def augment_action(entries, family_do, qualifier_do)
+      (entries || []).each do |family, qualifier|
+        case
+          when qualifier
+            qualifier_do.call(family.to_java_bytes, qualifier.to_java_bytes)
+          when family
+            family_do.call(family.to_java_bytes)
+        end
+      end
+    end
+  end
+end

data/lib/hbasegate/result.rb

@@ -0,0 +1,16 @@
+module HBaseGate
+  java_import 'org.apache.hadoop.hbase.client.Result'
+
+  class Result
+    # Return a nested hash of the result.
+    def to_h
+      get_no_version_map.entry_set.reduce({}) do |families, family_entries|
+        columns = family_entries.get_value.entry_set.reduce({}) do |columns, column_entry|
+          columns.update(
+              String.from_java_bytes(column_entry.get_key) => String.from_java_bytes(column_entry.get_value))
+        end
+        families.update(String.from_java_bytes(family_entries.get_key) =>  columns)
+      end
+    end
+  end
+end

data/lib/hbasegate/version.rb

@@ -0,0 +1,3 @@
+module HBaseGate
+  VERSION = '0.1.0'
+end

data/lib/hbasegate.rb

@@ -0,0 +1,20 @@
+require 'java'
+
+$: << File.dirname(__FILE__)
+
+require 'commons-configuration-1.6'
+require 'commons-lang-2.5'
+require 'commons-logging-1.1.1'
+require 'guava-11.0.2'
+require 'hadoop-auth'
+require 'hadoop-common'
+require 'hbase'
+require 'slf4j-api-1.6.1.jar'
+require 'zookeeper-3.4.5'
+
+require 'hbasegate/hbase_configuration'
+require 'hbasegate/htable'
+require 'hbasegate/result'
+require 'hbasegate/version'
+
+$:.pop

data/test/htable_spec.rb

@@ -0,0 +1,102 @@
+require 'minitest/autorun'
+require 'minitest/spec'
+
+require_relative '../lib/hbasegate'
+
+class HBaseGate::Get
+  def to_h
+    self
+  end
+end
+
+describe HBaseGate::HTable do
+  table = HBaseGate::HTable.new(nil, 't')
+  table.set_write_buffer_size(2097152)
+
+  describe '#get_write_buffer_size' do
+    it 'has default value' do
+      table.get_write_buffer_size.must_equal 2097152
+    end
+  end
+
+  describe '#original_put' do
+    it 'responds to original put' do
+      table.respond_to?(:original_put).must_equal true
+    end
+  end
+
+  describe '#put' do
+    it 'writes to the table' do
+      table.put('a', [['b', 'c', 'd']])
+      expected = HBaseGate::Put.new('a'.to_java_bytes)
+      expected.add('b'.to_java_bytes, 'c'.to_java_bytes, 'd'.to_java_bytes)
+      result = table.get_write_buffer
+      result.get(0).must_equal expected
+      result.size.must_equal 1
+    end
+  end
+
+  describe '#original_get' do
+    it 'responds to original get' do
+      table.respond_to?(:original_get).must_equal true
+    end
+  end
+
+  describe '#get' do
+    my_table = table.dup
+    def my_table.original_get(get)
+      get
+    end
+    it 'reads a full row' do
+      expected = HBaseGate::Get.new('a'.to_java_bytes)
+      my_table.get('a').must_equal expected
+    end
+
+    it 'reads a specific column' do
+      expected = HBaseGate::Get.new('a'.to_java_bytes)
+      expected.add_column('b'.to_java_bytes, 'c'.to_java_bytes)
+      my_table.get('a', [['b', 'c']]).must_equal expected
+    end
+
+    it 'reads a complete column family' do
+      expected = HBaseGate::Get.new('a'.to_java_bytes)
+      expected.add_family('b'.to_java_bytes)
+      my_table.get('a', [['b']]).must_equal expected
+    end
+  end
+
+  describe '#original_delete' do
+    it 'responds to original delete' do
+      table.respond_to?(:original_delete).must_equal true
+    end
+  end
+
+  describe '#delete' do
+    my_table = table.dup
+    def my_table.original_delete(delete)
+      @action = delete
+    end
+    def my_table.action
+      @action
+    end
+    it 'deletes a full row' do
+      expected = HBaseGate::Delete.new('a'.to_java_bytes)
+      my_table.delete('a')
+      my_table.action.must_equal expected
+    end
+
+    it 'deletes a specific column' do
+      expected = HBaseGate::Delete.new('a'.to_java_bytes)
+      expected.delete_column('b'.to_java_bytes, 'c'.to_java_bytes)
+      my_table.delete('a', [['b', 'c']])
+      my_table.action.must_equal expected
+    end
+
+    it 'deletes a complete column family' do
+      expected = HBaseGate::Delete.new('a'.to_java_bytes)
+      expected.delete_family('b'.to_java_bytes)
+      my_table.delete('a', [['b']])
+      my_table.action.must_equal expected
+    end
+  end
+end

data/test/result_spec.rb

@@ -0,0 +1,41 @@
+require 'minitest/autorun'
+require 'minitest/spec'
+
+require_relative '../lib/hbasegate'
+
+java_import 'org.apache.hadoop.hbase.KeyValue'
+
+describe HBaseGate::Result do
+  describe '#to_h' do
+    result = HBaseGate::Result.new(
+        [
+            KeyValue.new('a'.to_java_bytes, 'b'.to_java_bytes, 'c'.to_java_bytes, 'd'.to_java_bytes),
+            KeyValue.new('a'.to_java_bytes, 'b'.to_java_bytes, 'e'.to_java_bytes, 'f'.to_java_bytes)
+        ])
+    actual = result.to_h
+    it 'returns a hash' do
+      actual.class.must_equal Hash
+    end
+
+    it 'has family b' do
+      actual.has_key?('b').must_equal true
+    end
+
+    it 'has a column c in the family b' do
+      actual['b'].has_key?('c').must_equal true
+    end
+
+    it 'has a column e in the family b' do
+      actual['b'].has_key?('e').must_equal true
+    end
+
+    it 'has a value d for column c in family b' do
+      actual['b']['c'].must_equal 'd'
+    end
+
+    it 'has a value f for column e in family b' do
+      actual['b']['e'].must_equal 'f'
+    end
+  end
+end
+

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: hbasegate
+version: !ruby/object:Gem::Version
+  prerelease:
+  version: 0.1.0
+platform: ruby
+authors:
+- Knut O. Hellan
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2013-04-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    none: false
+  prerelease: false
+  type: :development
+description: JRuby gem wrapping Java API for HBase
+email:
+- knut.hellan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.md
+- hbasegate.gemspec
+- lib/hbasegate.rb
+- lib/hbasegate/hbase_configuration.rb
+- lib/hbasegate/htable.rb
+- lib/hbasegate/result.rb
+- lib/hbasegate/version.rb
+- test/htable_spec.rb
+- test/result_spec.rb
+homepage: http://github.com/khellan/hbasegate
+licenses:
+- MIT
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+requirements: []
+rubyforge_project:
+rubygems_version: 1.8.24
+signing_key:
+specification_version: 3
+summary: More ruby friendly API than using Java directly
+test_files:
+- test/htable_spec.rb
+- test/result_spec.rb
+...