voltdbjruby 0.5.0-java

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eaaab5d2c7a8236503024c7f6ee4499582ae63be
+  data.tar.gz: 064dab498dcf9ad47fe7ecee78e44ca6d6ea0119
+SHA512:
+  metadata.gz: 203959588f2cb4192d490d732104b5c01f80a11751be0a7889561466141635f03fbdee66aced11cce3ade8568195baaf829b7d766a5a2b7bb5c28f009b955aa9
+  data.tar.gz: 2748fd2b03f2dc0b323d5fa0d7f066984b54fba07107c99e70700a320916296f8c8f1f5aeb55846ca78ca9a75a7bd5d6d0cd82d4579ed8a057910847c3c21e8b

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.ruby-version
+examples.txt
+*.gem
+Jarfile
+Jarfile.lock
+.jbundler

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,12 @@
+dist: trusty
+sudo: false
+
+language: ruby
+cache: bundler
+rvm:
+  - jruby-9.1.8.0
+jdk:
+  - openjdk8
+
+install: bin/setup
+script: jruby -G -S rake

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+## next
+
+- Remove `pry` as a development dependency
+- Add the examples dir with the Hello World example
+  [#5](https://github.com/full360/voltdb-client-jruby/pull/5)
+- Set Platform to Java for the Gem and Vendor the `voltdbclient-6.8.jar` using
+  `jar-dependencies` [#6](https://github.com/full360/voltdb-client-jruby/pull/6)
+
+## 0.4.1
+
+- Remove `voltdbclient-6.8.jar` as a dependency from the Gem
+- Update development dependencies

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at alberto@albertogrespan.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in voltdb.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Alberto Grespan
+
+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/README.md

@@ -0,0 +1,126 @@
+# Voltdb JRuby Client
+
+A thin wrapper around the VoltDB Java client.
+
+## Versions
+
+We've decided that vendoring the `voltdbclient-x.x.jar` in the Gem as a
+dependency is the right way to do it. We are using VoltDB 6.8 and for that
+reason that's the one that's vendored. We are open on doing a different thing if
+it's the right solution.
+
+If required we could do multiple releases with different vendored clients. Just
+open an issue.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem "voltdbjruby"
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install voltdbjruby
+
+## Usage
+
+### Basic example
+
+```ruby
+require "voltdb"
+
+# Create a config
+config = Voltdb::ClientConfig.new()
+
+# Create a client and pass the config
+voltdb_client = Voltdb::Client.create_client(config)
+
+# Create a connection
+voltdb_client.create_connection("localhost")
+
+# Synchronous example
+response = voltdb_client.call_procedure("SampleProc", 123, "abc")
+
+# Asynchronous example
+queued = voltdb_client.call_procedure("SampleProc", 123, "abc") do |response|
+  # interact with the async response...
+end
+```
+
+### Utilities
+
+Utilities are a custom addition from Full 360 to DRY things a little and add
+some Ruby idioms.
+
+#### ClientResponse utilities
+
+```ruby
+...
+
+User = Struct.new(:id, :name)
+
+# Synchronous example
+response = voltdb_client.call_procedure("GetUsers")
+
+response.map(0) do |row|
+  User.new(row.get_long(0), row.get_string(1))
+end
+
+response = voltdb_client.call_procedure("GetUser", 1)
+
+response.map_first_row(0) do |row|
+  User.new(row.get_long(0), row.get_string(1))
+end
+
+# Asynchronous example
+queued = voltdb_client.call_procedure("GetUsers") do |response|
+  response.map(0) do |row|
+    User.new(row.get_long(0), row.get_string(1))
+  end
+end
+```
+
+#### VoltTableRow utilities
+
+```ruby
+User = Struct.new(:id, :name, :active, :created_at)
+
+response = voltdb_client.call_procedure("GetUser", 1)
+
+response.map_first_row(0) do |row|
+  User.new(
+    row.get_long(0),
+    row.get_string(1),
+    row.get_long_as_boolean(2),
+    row.get_timestamp_as_ruby_time(3)
+  )
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can
+also run `bin/console` for an interactive prompt that will allow you to
+experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/full360/voltdb-client-jruby. This project is intended to be a
+safe, welcoming space for collaboration, and contributors are expected to adhere
+to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT
+License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+
+Dir["tasks/**/*.rake"].each { |task| load task }
+
+task default: %w(spec)

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "voltdb"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+IRB.start

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/voltdb/callbacks.rb

@@ -0,0 +1,48 @@
+module Voltdb
+  class ProcCallback
+    include Java::OrgVoltdbClient::ClientResponse
+    include Java::OrgVoltdbClient::ProcedureCallback
+
+    def initialize(&block)
+      @block = block
+    end
+
+    def client_callback(client_response)
+      client_response.extend(ClientResponseUtils)
+      @block.call(client_response)
+    end
+  end
+
+  class BulkLoaderFailureCallback
+    java_import "org.voltdb.client.VoltBulkLoader.BulkLoaderFailureCallBack"
+    include Java::OrgVoltdbClient::ClientResponse
+    include Java::OrgVoltdbClientVoltBulkLoader::BulkLoaderFailureCallBack
+
+    def initialize(&block)
+      @block = block
+    end
+
+    def failure_callback(row_handle, field_list, client_response)
+      client_response.extend(ClientResponseUtils)
+      @block.call(row_handle, field_list.to_ary, client_response)
+    end
+  end
+
+  class AllPartitionProcCallback
+    java_import Java::OrgVoltdbClient::ClientResponseWithPartitionKey
+    include Java::OrgVoltdbClient::AllPartitionProcedureCallback
+
+    def initialize(&block)
+      @block = block
+    end
+
+    def client_callback(client_response_with_partition_key)
+      response = client_response_with_partition_key.map do |partition|
+        partition.response.extend(ClientResponseUtils)
+        partition
+      end
+
+      @block.call(response)
+    end
+  end
+end

data/lib/voltdb/client.rb

@@ -0,0 +1,198 @@
+module Voltdb
+  class Client
+    include ClientUtils
+    extend Forwardable
+
+    java_import Java::OrgVoltdbClient::Client
+    java_import Java::OrgVoltdbClient::ClientFactory
+
+    # Persist ClientResponseImpl to avoid the warning when we extend the object
+    Java::OrgVoltdb::ClientResponseImpl.__persistent__ = true
+
+    attr_reader :java_client
+
+    # Factory of Voltdb::Client
+    #
+    # @param config Voltdb::ClientConfig
+    # @return Voltdb::Client
+    def self.create_client(config)
+      client = ClientFactory.create_client(config)
+
+      self.new(client)
+    end
+
+    def initialize(java_client)
+      @java_client = java_client
+    end
+
+    # Invokes a voltdb stored procedure based on its procedure name, a list of
+    # params and a block only if an asynchronous call is required
+    #
+    # @param proc_name [String] the stored procedure name
+    # @param *params [Array<Object>] a list of params
+    # @return [Java::OrgVoltdbClient::ClientResponse, True, False] Voltdb
+    #   client response if the procedure was called synchronously, else will
+    #   return true if the procedure was properly queued or false if it was not
+    # @raise [ProcCallException, NoConnectionsException, IOException]
+    #   ProcCallException will be returned if called synchronously
+    def call_procedure(proc_name, *params, &block)
+      if block_given?
+        cb = ProcCallback.new(&block)
+        java_client.call_procedure(cb, proc_name, *params_to_java_objects(*params))
+      else
+        response = java_client.call_procedure(proc_name, *params_to_java_objects(*params))
+        response.extend(ClientResponseUtils)
+        response
+      end
+    end
+
+    # Invokes a voltdb stored procedure with an specific timeout a procedure
+    # name, a list of params and a block only if an asynchronous call is
+    # required
+    #
+    # @param query_timeout [Fixnum] the stored procedure timeout
+    # @param proc_name [String] the stored procedure name
+    # @param *params [Array<Object>] a list of params
+    # @return [Java::OrgVoltdbClient::ClientResponse, True, False] Voltdb
+    #   client response if the procedure was called synchronously, else will
+    #   return true if the procedure was properly queued or false if it was not
+    # @raise [ProcCallException, NoConnectionsException, IOException]
+    #   ProcCallException will be returned if called synchronously
+    def call_procedure_with_timeout(query_timeout, proc_name, *params, &block)
+      if block_given?
+        cb = ProcCallback.new(&block)
+        java_client.call_procedure_with_timeout(cb, query_timeout, proc_name, *params_to_java_objects(*params))
+      else
+        response = java_client.call_procedure_with_timeout(query_timeout, proc_name, *params_to_java_objects(*params))
+        response.extend(ClientResponseUtils)
+        response
+      end
+    end
+
+    # This method is a convenience method that is equivalent to reading the
+    # catalog file into a byte array in Java code, then calling call_procedure
+    # with "@UpdateApplicationCatalog" as the procedure name, followed by they
+    # bytes of the catalog and the string value of the deployment file. If a
+    # block is passed to the method an asyncronous call will be made
+    #
+    # @param catalog_path [String] the path to the voltdb catalog
+    # @param deployment_path [String] deployment_path the path to the
+    #   deployment.xml file
+    # @return [Java::OrgVoltdbClient::ClientResponse, True, False] Voltdb
+    #   client response if the procedure was called synchronously, else will
+    #   return true if the procedure was properly queued or false if it was not
+    # @raise [ProcCallException, NoConnectionsException, IOException]
+    #   ProcCallException will be returned if called synchronously
+    def update_application_catalog(catalog_path, deployment_path, &block)
+      if block_given?
+        cb = ProcCallback.new(&block)
+        java_client.update_application_catalog(cb, catalog_path, deployment_path)
+      else
+        response = java_client.update_application_catalog(catalog_path, deployment_path)
+        response.extend(ClientResponseUtils)
+        response
+      end
+    end
+
+    # This method is a convenience method that is equivalent to reading a
+    # jarfile containing to be added/updated into a byte array in Java code,
+    # then calling call_procedure with "@UpdateClasses" as the procedure name,
+    # followed by the bytes of the jarfile and a string containing a
+    # comma-separates list of classes to delete from the catalog.If a block is
+    # passed to the method an asyncronous call will be made
+    #
+    # @param jar_path [String] path to the jar file with new/update clases
+    # @param classes_to_delete [String,String] comma-separated list of classes
+    #   to delete
+    # @return [Java::OrgVoltdbClient::ClientResponse, True, False] Voltdb
+    #   client response if the procedure was called synchronously, else will
+    #   return true if the procedure was properly queued or false if it was not
+    # @raise [ProcCallException, NoConnectionsException, IOException]
+    #   ProcCallException will be returned if called synchronously
+    def update_classes(jar_path, classes_to_delete, &block)
+      if block_given?
+        cb = ProcCallback.new(&block)
+        java_client.update_classes(cb, jar_path, classes_to_delete)
+      else
+        response = java_client.update_classes(jar_path, classes_to_delete)
+        response.extend(ClientResponseUtils)
+        response
+      end
+    end
+
+    # Get an identifier for the cluster that this client is currently connected
+    # to. This will be null if the client has not been connected. Currently
+    # these values have logical meaning, but they should just be interpreted as
+    # a unique per-cluster value
+    #
+    # @return [Array<Fixnum>] An array of Fixnum containing the millisecond
+    #   timestamp when the cluster was started and the leader IP address
+    def get_instance_id
+      java_client.get_instance_id.to_ary
+    end
+
+    # Get the instantaneous values of the rate limiting values for this client
+    #
+    # @return [Array<Fixnum>] Array of Fixnum representing max throughput/sec
+    #   and max outstanding txns
+    def get_throughput_and_outstanding_txn_limits
+      java_client.get_throughput_and_outstanding_txn_limits.to_ary
+    end
+
+    # Get the list of VoltDB server hosts that this client has open TCP
+    # connections to
+    #
+    # @return [Array<InetSocketAddress>] An list of InetSocketAddress
+    #   representing the connected hosts
+    def get_connected_host_list
+      java_client.get_connected_host_list.to_ary
+    end
+
+    # Creates a new instance of a VoltBulkLoader that is bound to this Client.
+    # Multiple instances of a VoltBulkLoader created by a single Client will
+    # share some resources, particularly if they are inserting into the same
+    # table
+    #
+    # @param table_name [String] that bulk inserts are to be applied to
+    # @param max_batch_size [Fixnum] to collect for the table before pushing a
+    #   bulk insert
+    # @param [Boolean] upsert true if want upsert instead of insert
+    # @return [VoltBulkLoader]
+    # @raise [Exception] if tableName can't be found in the catalog
+    def get_new_bulk_loader(table_name, max_batch_size, upsert, &block)
+      cb = BulkLoaderFailureCallback.new(&block)
+
+      if upsert
+        java_client.get_new_bulk_loader(table_name, max_batch_size, upsert, cb)
+      else
+        java_client.get_new_bulk_loader(table_name, max_batch_size, cb)
+      end
+    end
+
+    # The method uses system procedure @GetPartitionKeys to get a set of
+    # partition values and then execute the stored procedure one partition at a
+    # time, and return an aggregated response. If a block is passed to the
+    # method an asyncronous call will be made
+    #
+    # @param proc_name [String] proc_name the stored procedure name
+    # @param *param [Array<Object>] a list of params
+    # @return [ClientResponseWithPartitionKey, True, False] instances of
+    #   procedure call results
+    # @raise [ProcCallException, NoConnectionsException, IOException]
+    def call_all_partition_procedure(proc_name, *params, &block)
+      if block_given?
+        cb = AllPartitionProcCallback.new(&block)
+        java_client.call_all_partition_procedure(cb, proc_name, *params_to_java_objects(*params))
+      else
+        java_client.call_all_partition_procedure(proc_name, *params_to_java_objects(*params)).map do |partition|
+          partition.response.extend(ClientResponseUtils)
+          partition
+        end
+      end
+    end
+
+    def_delegators :java_client,
+      :create_connection, :drain, :close, :create_stats_context,
+      :get_build_string, :write_summary_csv
+  end
+end

data/lib/voltdb/client_config.rb

@@ -0,0 +1,3 @@
+module Voltdb
+  class ClientConfig < Java::OrgVoltdbClient::ClientConfig; end
+end

data/lib/voltdb/client_response_utils.rb

@@ -0,0 +1,85 @@
+module Voltdb
+  module ClientResponseUtils
+    java_import Java::OrgVoltdbClient::Client
+    java_import Java::OrgVoltdbClient::ClientResponse
+    java_import Java::OrgVoltdb::VoltTableRow
+
+    # This method is used for mapping VoltTableRows to an object. It receives
+    # the index of the VoltTable that we want to map and a block that will be
+    # executed in that context
+    #
+    # @param client_response [ClientResponseImpl] a voltdb ClientResponse
+    #   interface implementation
+    # @param index [Fixnum] VoltTable index
+    # @param validate_status [Boolean] validate status of the client response
+    # @yield [VoltTableRow]
+    # @return [Array<Object, Object>]
+    def self.map_client_response_result(client_response, index, validate_status = true, &block)
+      validate_client_response_status(client_response) if (validate_status)
+      VoltTableUtils.map_volt_table(client_response.get_results[index], &block)
+    end
+
+    # This method is used for mapping the first row from a VoltTableRow to an
+    # object.  It receives the index of the VoltTable that we want to map and a
+    # block that will be executed in that context
+    #
+    # @param client_response [ClientResponseImpl] a voltdb ClientResponse
+    #   interface implementation
+    # @param index [Fixnum] VoltTable index
+    # @param validate_status [Boolean] validate status of the client response
+    # @yield [VoltTableRow]
+    # @return [Array<Object>]
+    def self.map_first_row_from_client_response_result(client_response, index, validate_status = true, &block)
+      validate_client_response_status(client_response) if (validate_status)
+      VoltTableUtils.map_first_row_from_volt_table(client_response.get_results[index], &block)
+    end
+
+    # Checks that the status of the client response is SUCCESS. If not, it
+    # throws an exception
+    #
+    # @param client_response [ClientResponseImpl] a voltdb ClientResponse
+    #   interface implementation
+    # @return the same client response passed in when its status is equal to
+    #   <code>ClientResponse.SUCCESS</code>
+    # @raise [ClientResponseStatusError] if the status is not SUCCESS
+    def self.validate_client_response_status(client_response)
+      unless ClientResponse.SUCCESS == client_response.get_status
+        raise ClientResponseStatusError.new(client_response)
+      end
+
+      client_response
+    end
+
+    # This method is used when we extend the Voltdb ClientResponse interface
+    # and it's used for mapping VoltTableRows to an object. It receives the
+    # index of the VoltTable that we want to map and a block that will be
+    # executed in that context
+    #
+    # @param index [Fixnum] VoltTable index
+    # @yield [VoltTableRow]
+    # @return [Array<Object, Object>]
+    def map(index, validate_status = true, &block)
+      ClientResponseUtils.map_client_response_result(self, index, validate_status, &block)
+    end
+
+    # This method is used when we extend the Voltdb ClientResponse interface
+    # and it's used for mapping the first row from a VoltTableRow to an object.
+    # It receives the index of the VoltTable that we want to map and a block
+    # that will be executed in that context
+    #
+    # @param index [Fixnum] VoltTable index
+    # @yield [VoltTableRow]
+    # @return [Array<Object>]
+    def map_first_row(index, validate_status = true, &block)
+      ClientResponseUtils.map_first_row_from_client_response_result(self, index, validate_status, &block)
+    end
+
+    # This method is used when we extend the Voltdb ClientResponse interface
+    # and it's used for valitation on the client response
+    #
+    # @return [client_response]
+    def validate_status
+      ClientResponseUtils.validate_client_response_status(self)
+    end
+  end
+end

data/lib/voltdb/client_utils.rb

@@ -0,0 +1,39 @@
+module Voltdb
+  module ClientUtils
+    java_import Java::OrgVoltdbTypes::TimestampType
+    java_import Java::OrgVoltdbClient::Client
+
+    # Transform Ruby objects to Java objects that VoltDB understands
+    #
+    # @param *params [Array<Object>] list of params
+    # @return [Array<JavaObjects>]
+    def params_to_java_objects(*params)
+      params.map do |param|
+        case param
+        when DateTime, Date, Time
+          TimestampType.new(param.strftime("%F %T.%L"))
+        else
+          param
+        end
+      end
+    end
+
+    # Transform a host:port or a host into an array of host and port
+    #
+    # @param address [String] voltdb server address
+    # @param default_port [Fixnum] override the default voltdb server port
+    # @return [Array<String, Fixnum>] represents host address and port
+    def host_and_port_from_address(address, default_port = Client.VOLTDB_SERVER_PORT)
+      s = address.split(":")
+
+      case s.size
+      when 1
+        ["#{s[0]}", default_port]
+      when 2
+        ["#{s[0]}", s[1].to_i]
+      else
+        ["", 0]
+      end
+    end
+  end
+end

data/lib/voltdb/exceptions.rb

@@ -0,0 +1,10 @@
+module Voltdb
+  class ClientResponseStatusError < StandardError
+    attr_reader :client_response
+
+    def initialize(client_response, message = "Client response not successful")
+      @client_response = client_response
+      super(message)
+    end
+  end
+end

data/lib/voltdb/version.rb

@@ -0,0 +1,3 @@
+module Voltdb
+  VERSION = "0.5.0"
+end

data/lib/voltdb/volt_table_row_utils.rb

@@ -0,0 +1,58 @@
+module Voltdb
+  module VoltTableRowUtils
+
+    # Get a long value from a VoltTableRow as a boolean value
+    #
+    # @param column_index_or_name [Fixnum, String]
+    # @return [Boolean]
+    def get_long_as_boolean(column_index_or_name)
+      self.get_long(column_index_or_name) == 1
+    end
+
+    # Get the value of the column or nil
+    #
+    # @param column_index_or_name [Fixnum, String]
+    # @return [VoltType, Boolean]
+    def get_long_or_nil(column_index_or_name)
+      value = self.get_long(column_index_or_name)
+
+      self.was_null? ? nil : value
+    end
+
+    # Get a Ruby DateTime from a VoltTableRow timestamp type value
+    #
+    # @param column_index_or_name [Fixnum, String]
+    # @return [DateTime]
+    def get_timestamp_as_ruby_date_time(column_index_or_name)
+      timestamp = get_timestamp_for_ruby(column_index_or_name)
+
+      timestamp ? DateTime.parse(timestamp.to_s) : timestamp
+    end
+
+    # Get a Ruby Date from a VoltTableRow timestamp type value
+    #
+    # @param column_index_or_name [Fixnum, String]
+    # @return [Date]
+    def get_timestamp_as_ruby_date(column_index_or_name)
+      timestamp = get_timestamp_for_ruby(column_index_or_name)
+
+      timestamp ? Date.parse(timestamp.to_s) : timestamp
+    end
+
+    # Get a Ruby Time from a VoltTableRow timestamp type value
+    #
+    # @param column_index_or_name [Fixnum, String]
+    # @return [Time]
+    def get_timestamp_as_ruby_time(column_index_or_name)
+      timestamp = get_timestamp_for_ruby(column_index_or_name)
+
+      timestamp ? Time.parse(timestamp.to_s) : timestamp
+    end
+
+    private
+
+    def get_timestamp_for_ruby(column_index_or_name)
+      self.get_timestamp_as_sql_timestamp(column_index_or_name)
+    end
+  end
+end

data/lib/voltdb/volt_table_utils.rb

@@ -0,0 +1,68 @@
+module Voltdb
+  module VoltTableUtils
+    java_import Java::OrgVoltdb::VoltTable
+    java_import Java::OrgVoltdb::VoltTableRow
+
+    # Persist VoltTable to avoid the warning when we duplicate the object to
+    # extend it
+    Java::OrgVoltdb::VoltTable.__persistent__ = true
+
+    # This method is used when we extend the VoltDB VoltTable interface and
+    # it's used to iterate over a VoltTableRow while also adding VoltTableRow
+    # Ruby Utils
+    #
+    # @param volt_table [VoltTable]
+    # @yield [VoltTableRow]
+    # @return [Array<Object, Object>]
+    def self.map_volt_table(volt_table, &block)
+      results = []
+
+      volt_table.reset_row_position
+      volt_table.extend(VoltTableRowUtils)
+
+      while(volt_table.advance_row) do
+        results << block.call(volt_table)
+      end
+
+      results
+    end
+
+    # This method is used when we extend the VoltDB VoltTable interface and
+    # it's used to iterate over the first row of a VoltTableRow while also
+    # adding VoltTableRow Ruby Utils
+    #
+    # @param volt_table [VoltTable]
+    # @yield [VoltTableRow]
+    # @return [Object, nil]
+    def self.map_first_row_from_volt_table(volt_table, &block)
+      volt_table.reset_row_position
+      volt_table.extend(VoltTableRowUtils)
+
+      if(volt_table.advance_row)
+        block.call(volt_table)
+      else
+        nil
+      end
+    end
+
+    # This method is used when we extend the VoltDB VoltTable interface and
+    # it's used to iterate over a VoltTableRow while also adding VoltTableRow
+    # Ruby Utils
+    #
+    # @yield [VoltTableRow]
+    # @return [Array<Object, Object>]
+    def map
+      VoltTableUtils.map_volt_table(self, &block)
+    end
+
+    # This method is used when we extend the VoltDB VoltTable interface and
+    # it's used to iterate over the first row of a VoltTableRow while also
+    # adding VoltTableRow Ruby Utils
+    #
+    # @yield [VoltTableRow]
+    # @return [Object, nil]
+    def map_first_row
+      VoltTableUtils.map_first_row_from_volt_table(self, &block)
+    end
+  end
+end

data/lib/voltdb.rb

@@ -0,0 +1,17 @@
+require "voltdbjruby_jars"
+require "forwardable"
+require "date"
+
+module Voltdb
+  autoload :ClientResponseStatusError, "voltdb/exceptions"
+  autoload :ClientConfig,              "voltdb/client_config"
+  autoload :ClientUtils,               "voltdb/client_utils"
+  autoload :Client,                    "voltdb/client"
+  autoload :ProcCallback,              "voltdb/callbacks"
+  autoload :BulkLoaderFailureCallback, "voltdb/callbacks"
+  autoload :AllPartitionProcCallback,  "voltdb/callbacks"
+  autoload :ClientResponseUtils,       "voltdb/client_response_utils"
+  autoload :VoltTableUtils,            "voltdb/volt_table_utils"
+  autoload :VoltTableRowUtils,         "voltdb/volt_table_row_utils"
+  autoload :VERSION,                   "voltdb/version"
+end

data/lib/voltdbjruby_jars.rb

@@ -0,0 +1,10 @@
+# this is a generated file, to avoid over-writing it just delete this comment
+begin
+  require 'jar_dependencies'
+rescue LoadError
+  require 'org/voltdb/voltdbclient/6.8/voltdbclient-6.8.jar'
+end
+
+if defined? Jars
+  require_jar( 'org.voltdb', 'voltdbclient', '6.8' )
+end

data/tasks/rspec.rake

@@ -0,0 +1,3 @@
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new

data/voltdb.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'voltdb/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "voltdbjruby"
+  spec.version       = Voltdb::VERSION
+  spec.authors       = ["Alberto Grespan"]
+  spec.email         = ["alberto@albertogrespan.com"]
+
+  spec.summary       = %q{JRuby VoltDB Client}
+  spec.description   = %q{A thin wrapper around the VoltDB Java client}
+  spec.homepage      = "https://github.com/full360/voltdb-client-jruby"
+  spec.license       = "MIT"
+
+  # This is important to get the jars installed
+  spec.platform      = "java"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(examples|test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.requirements << "jar org.voltdb, voltdbclient, 6.8"
+
+  spec.add_development_dependency "jar-dependencies", "~> 0.3"
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 12"
+  spec.add_development_dependency "rspec", "~> 3.5"
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: voltdbjruby
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: java
+authors:
+- Alberto Grespan
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2017-04-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  name: jar-dependencies
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  name: bundler
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12'
+  name: rake
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  name: rspec
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+description: A thin wrapper around the VoltDB Java client
+email:
+- alberto@albertogrespan.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/org/voltdb/voltdbclient/6.8/voltdbclient-6.8.jar
+- lib/voltdb.rb
+- lib/voltdb/callbacks.rb
+- lib/voltdb/client.rb
+- lib/voltdb/client_config.rb
+- lib/voltdb/client_response_utils.rb
+- lib/voltdb/client_utils.rb
+- lib/voltdb/exceptions.rb
+- lib/voltdb/version.rb
+- lib/voltdb/volt_table_row_utils.rb
+- lib/voltdb/volt_table_utils.rb
+- lib/voltdbjruby_jars.rb
+- tasks/rspec.rake
+- voltdb.gemspec
+homepage: https://github.com/full360/voltdb-client-jruby
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- jar org.voltdb, voltdbclient, 6.8
+rubyforge_project:
+rubygems_version: 2.6.11
+signing_key:
+specification_version: 4
+summary: JRuby VoltDB Client
+test_files: []