voltrb 0.0.2 → 0.1.0

data/README.rdoc

@@ -4,7 +4,7 @@ VoltRB is a gem client for VoltDB that uses the JSON interface.
 
 = Installing VoltRb
 
-Get from RubyForge.
+Get from RubyGems.org:
 
   % gem install voltrb
 
@@ -40,12 +40,12 @@ Or we can specify options as a hash.
 
   client = VoltRb::Client.new({:host => "voltdbhost", :port => 8888})
 
-Right now, VoltRb only knows two:
+The following options are recognized:
 
 * host - should point to the name or IP address of the VoltDB instance.
 * port - in case the instance isn't listening on the default port (8080).
-
-There are no options yet for authentication since the JSON interface doesn't implement any. See Notes for more.
+* username
+* password
 
 == Stored Procedure Invocation
 
@@ -113,30 +113,6 @@ Standard Ruby errors will be raised in case of network connection problems. Volt
   
       at Insert.run(Insert.java:19)
   ========================================================
- 
-= Notes
-
-== User Authentication
-
-As of VoltDB v1.1, the JSON interface does not implement any form of authentication. 
-
-The following text was taken from VoltDB's JSON documentation:
-
-<em>Note that there is currently no way to authenticate the client interface using JSON. In other words, the JSON interface operates as an "anonymous" client. If security is enabled for the database, use of the JSON interface is essentially disabled because any attempt to execute a stored procedure will result in a protection violation.</em>
-
-This forum thread says they expect to have the feature in v1.2
-
-http://community.voltdb.com/node/241
-
-== Unicode Strings
-
-As of v1.1 VoltDB's JSON interface does not properly return UTF-8 strings so non-Latin characters don't display correctly.
-
-http://community.voltdb.com/node/263
-
-The fix is now in their trunk version. It'll be included in the next official release of VoltDB (v1.2). Or you can build directly from trunk.
-
-  svn checkout http://svnmirror.voltdb.com/eng/trunk/
 
 = License
 

data/lib/voltrb.rb

@@ -9,4 +9,5 @@ require 'voltrb/exceptions'
 require 'voltrb/volt_table'
 require 'voltrb/procedure_response'
 require 'voltrb/client'
+require 'voltrb/version'
 

data/lib/voltrb/client.rb

@@ -3,6 +3,7 @@ require 'rest_client'
 require 'date'
 require 'time'
 require 'bigdecimal'
+require 'digest/sha1'
 
 module VoltRb
   # This is the main class we use to interact with the VoltDB instance.
@@ -48,7 +49,7 @@ module VoltRb
   # We can find the details of the error by inspecting status_string or app_status_string.
   # See VoltError for more.
   class Client
-    attr_reader :host, :port
+    attr_reader :host, :port, :username
     attr_accessor :api_root
 
     # Calling new without any arguments will create a client and have it connect to the VoltDB instance running 
@@ -56,16 +57,17 @@ module VoltRb
     # Pass an options hash to modify these defaults. 
     #   client = VoltRb::Client.new({:host => "voltdb_server", :port => 8888})
     #
-    # Right now, only two options are recognized:
+    # The following options are recognized:
     # * host - the machine name or IP address
     # * port - other than the default
+    # * username 
+    # * password
     #
-    # <em>Note on user authentication:</em>
-    # As of v1.1, the VoltDB JSON interface does not implement any form of authentication. 
-    # See the README[link:files/README.html] for more.
     def initialize(options = {})
       @host = options[:host] || "localhost"
       @port = options[:port] || 8080
+      @username= options[:username]
+      @hashed_password = Digest::SHA1.hexdigest(options[:password]) if options[:password]
       @api_root = "http://#{@host}:#{@port}/api/1.0/"
     end
 
@@ -87,12 +89,20 @@ module VoltRb
     # In case of errors, handle the usual Ruby errors and the VoltDB-specfic VoltError (this inherits from StandardError).
     def call_procedure(procedure_name, *args)
       params = args.inject([]) { |o,e| o << prep_param(e); o }
-      response = RestClient.post(@api_root, :Procedure => procedure_name.to_s, :Parameters => params.to_json, :content_type => "text/plain; charset=UTF-8", :accept => :json)
+      payload = {:Procedure => procedure_name.to_s, :Parameters => params.to_json}
+      if @username
+        payload[:User] = @username
+        payload[:Hashedpassword] = @hashed_password
+      end 
+      response = RestClient.post(@api_root, payload, :content_type => "text/plain; charset=UTF-8", :accept => :json)
       proc_resp = ProcedureResponse.new(response)
       raise(VoltError.new(proc_resp.status, proc_resp.status_string, proc_resp.app_status, proc_resp.app_status_string), "A VoltDB procedure error occurred. See the exception object for details.") if proc_resp.raw["status"] != 1 or proc_resp.raw["appstatus"] != -128
       proc_resp
     end
 
+    # Alias for call_procedure.  Term used in other client libraries.
+    alias :invoke :call_procedure
+
   private
     def prep_param(val)
       case val

data/lib/voltrb/version.rb

@@ -1,5 +1,5 @@
 module VoltRb
   # This gem's version.
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end
 

metadata

@@ -5,9 +5,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
+  - 1
   - 0
-  - 2
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors: 
 - Junjun Olympia
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-07 00:00:00 +08:00
+date: 2010-11-01 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency