rexpro 0.0.6 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 308c2cbddd465d7c79555e519b7a9af6c2fb8f0a
+  data.tar.gz: 811346f26a03c3a18d68d8b8cf870fd5d032aca8
+SHA512:
+  metadata.gz: d1a0595fec310bcbb61116ccda3110298b7567c437f49856c428bdfc15c52bd25f03a70f0f9541b296ead55a1a8cdfd7fe09d11e691dc3e61ff841540f6ed959
+  data.tar.gz: 7b89cc9bf3fb18f963d016e76bcfe77ba1065c6ce5bebc41d79cbfd8b1538b0f66968021da2f8ef9c91a3f6044609c0b4020ee892a20cf4bc16129c85d32c5ec

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+before_script: rake run_rexster && sleep 10
+script: rake test
+rvm:
+  - 1.9.3
+  - 2.0.0

data/README.md

@@ -1,11 +1,18 @@
 # Rexpro
 
-*This is an early release and should not be considered stable!*
+[![Build Status](https://travis-ci.org/lann/rexpro-ruby.png)](https://travis-ci.org/lann/rexpro-ruby)
+
+Tested against rexster-server-2.4.0 on Ruby 1.9.3 and 2.0.0.
 
 https://github.com/tinkerpop/rexster/wiki/RexPro
 
 ## Installation
 
+**NOTE: Version 1.0.0 breaks compatibility with rexster-server <2.4!**
+
+Use gem versions <1.0.0 for older versions of rexster, or follow the protocol-0
+branch, which may still recieve critical updates.
+
 Add this line to your application's Gemfile:
 
     gem 'rexpro'

data/Rakefile

@@ -21,3 +21,26 @@ Rake::TestTask.new do |test|
   test.verbose = true
   test.test_files = ['spec/**/*_spec.rb']
 end
+
+REXSTER_SERVER_URL = 'http://tinkerpop.com/downloads/rexster/rexster-server-2.4.0.zip'
+
+desc 'Install and run rexster-server'
+task :run_rexster do
+  tmpdir = File.expand_path('../tmp', __FILE__)
+  rexster_filename = File.join(tmpdir, 'rexster-server.zip')
+  
+  unless File.exists? rexster_filename
+	FileUtils.mkdir_p tmpdir
+	sh "wget '#{REXSTER_SERVER_URL}' -O '#{rexster_filename}'"
+  end
+
+  rexster_glob = File.join(tmpdir, 'rexster-server-*/bin')
+
+  if Dir[rexster_glob].empty?
+    sh "unzip '#{rexster_filename}' -d '#{tmpdir}'"
+  end
+
+  Dir.chdir(File.join(Dir[rexster_glob].first, '..')) do
+    sh 'nohup bin/rexster.sh -s > rexster.log &'
+  end
+end

data/lib/rexpro/client.rb

@@ -15,7 +15,7 @@ module Rexpro
       @port = opts.delete(:port) || DEFAULT_PORT
 
       @request_opts = {}
-      [:channel, :graph_name, :graph_obj_name].each do |key|
+      [:graph_name, :graph_obj_name].each do |key|
         value = opts.delete(key)
         @request_opts[key] = value if value
       end
@@ -62,7 +62,7 @@ module Rexpro
       opts = @request_opts.merge(opts)
       req = Rexpro::Message::SessionRequest.new(opts)
       resp = request(req)
-      Rexpro::Session.new(self, resp.session_uuid, req.channel, resp.languages)
+      Rexpro::Session.new(self, resp.session_uuid, resp.languages)
     end
 
     def execute(script, opts = {})

data/lib/rexpro/message.rb

@@ -5,21 +5,18 @@ require 'uuid'
 
 module Rexpro
   module Message
-    PROTOCOL_VERSION = 0
+    PROTOCOL_VERSION = 1
 
-    ZERO_UUID = [0, 0, 0, 0].pack('NNNN')
+    SERIALIZER_MSGPACK = 0
+    SERIALIZER_JSON    = 1
 
-    TYPE_ERROR                    = 0
-    TYPE_SESSION_REQUEST          = 1
-    TYPE_SESSION_RESPONSE         = 2
-    TYPE_SCRIPT_REQUEST           = 3
-    TYPE_CONSOLE_SCRIPT_RESPONSE  = 4
-    TYPE_MSGPACK_SCRIPT_RESPONSE  = 5
-    TYPE_GRAPHSON_SCRIPT_RESPONSE = 6
+    ZERO_UUID = [0, 0, 0, 0].pack('NNNN')
 
-    CHANNEL_CONSOLE  = 1
-    CHANNEL_MSGPACK  = 2
-    CHANNEL_GRAPHSON = 3
+    TYPE_ERROR            = 0
+    TYPE_SESSION_REQUEST  = 1
+    TYPE_SESSION_RESPONSE = 2
+    TYPE_SCRIPT_REQUEST   = 3
+    TYPE_SCRIPT_RESPONSE  = 5
 
     class << self
       def generate_uuid
@@ -39,12 +36,12 @@ module Rexpro
           raise RexproException, "Unknown protocol version #{version}"
         end
 
-        header = io.read(5)
-        if header.nil? || header.size < 5
+        header = io.read(10)
+        if header.nil? || header.size < 10
           raise RexproException, "Unexpected EOF: #{header.inspect}"
         end
 
-        type, size = header.unpack('CN')
+        serializer_type, reserved, type, size = header.unpack('CNCN')
         type_class = types[type]
         unless type_class
           raise RexproException, "Unknown message type #{type}"
@@ -65,6 +62,8 @@ module Rexpro
           memo
         end
 
+        attrs[:serializer_type] = serializer_type
+
         type_class.new(attrs)
       end
     end
@@ -113,14 +112,21 @@ module Rexpro
         end
       end
 
+      attr_reader :serializer_type
+
       def initialize(attrs = {})
+        @serializer_type = attrs.delete(:serializer_type) || SERIALIZER_MSGPACK
         self.meta ||= {}
         attrs.each { |k, v| send("#{k}=", v) }
         self.session_uuid ||= ZERO_UUID
         self.request_uuid ||= Message.generate_uuid
       end
 
-      def to_msgpack(*args)
+      def serialize_body(*args)
+        if serializer_type != SERIALIZER_MSGPACK
+          raise NotImplementedError, 'only MsgPack serialization is supported'
+        end
+
         self.class.fields.map do |field|
           value = send(field)
           field_method = self.class.field_methods[field]
@@ -130,8 +136,10 @@ module Rexpro
       end
 
       def write_to(io)
-        body = to_msgpack
-        header = [PROTOCOL_VERSION, self.class.type, body.size].pack('CCN')
+        body = serialize_body
+        header = [
+          PROTOCOL_VERSION, serializer_type, 0, self.class.type, body.size
+          ].pack('CCNCN')
         io.write(header)
         io.write(body)
       end
@@ -147,13 +155,8 @@ module Rexpro
     class SessionRequest
       include Base
       self.type = TYPE_SESSION_REQUEST
-      define_fields channel: :to_i, username: :to_s, password: :to_s
+      define_fields username: :to_s, password: :to_s
       define_meta_fields :graph_name, :graph_obj_name, :kill_session
-
-      def initialize(*_)
-        super
-        self.channel ||= CHANNEL_MSGPACK
-      end
     end
 
     class SessionResponse
@@ -167,33 +170,20 @@ module Rexpro
       include Base
       self.type = TYPE_SCRIPT_REQUEST
       define_fields language_name: :to_s, script: :to_s, bindings: :to_hash
-      define_meta_fields :channel, :in_session, :isolate, :transaction,
+      define_meta_fields :in_session, :isolate, :transaction,
                          :graph_name, :graph_obj_name
 
       def initialize(*_)
         super
         self.language_name ||= 'groovy'
         self.bindings ||= {}
-        self.channel ||= CHANNEL_MSGPACK
       end
     end
 
-    class ConsoleScriptResponse
-      include Base
-      self.type = TYPE_CONSOLE_SCRIPT_RESPONSE
-      define_fields console_lines: :to_a, bindings: :to_hash
-    end
-
-    class MsgpackScriptResponse
+    class ScriptResponse
       include Base
-      self.type = TYPE_MSGPACK_SCRIPT_RESPONSE
+      self.type = TYPE_SCRIPT_RESPONSE
       define_fields results: nil, bindings: :to_hash
     end
-
-    class GraphsonScriptResponse
-      include Base
-      self.type = TYPE_GRAPHSON_SCRIPT_RESPONSE
-      define_fields results: :to_s, bindings: :to_hash
-    end
   end
 end

data/lib/rexpro/session.rb

@@ -1,10 +1,10 @@
 require 'rexpro'
 
 class Rexpro::Session
-  attr_reader :client, :uuid, :channel, :languages
+  attr_reader :client, :uuid, :languages
 
-  def initialize(client, uuid, channel, languages = nil)
-    @client, @uuid, @channel, @languages = client, uuid, channel, languages
+  def initialize(client, uuid, languages = nil)
+    @client, @uuid, @languages = client, uuid, languages
   end
 
   def kill
@@ -15,7 +15,7 @@ class Rexpro::Session
 
   def execute(script, attrs = {})
     attrs = attrs.merge(
-      session_uuid: uuid, channel: channel, in_session: true, script: script)
+      session_uuid: uuid, in_session: true, script: script)
     msg = Rexpro::Message::ScriptRequest.new(attrs)
     client.request(msg)
   end

data/lib/rexpro/version.rb

@@ -1,3 +1,3 @@
 module Rexpro
-  VERSION = "0.0.6"
+  VERSION = "1.0.0"
 end

data/rexpro.gemspec

@@ -16,6 +16,14 @@ DESC
   spec.homepage      = "https://github.com/lann/rexpro-ruby"
   spec.license       = "MIT"
 
+  spec.post_install_message = <<-MESSAGE
+
+!   ***UPDGRADE WARNING***
+!   rexpro-ruby 1.x breaks compatibility with rexster-server-2.3 and below.
+!   Continue using 0.x versions if you cannot upgrade rexster.
+
+  MESSAGE
+
   spec.files         = `git ls-files`.split($/)
   spec.test_files    = spec.files.grep(%r{^spec/})
   spec.require_paths = ["lib"]

data/spec/message_spec.rb

@@ -19,8 +19,8 @@ describe Rexpro::Message do
   end
 
   describe '.read_from' do
-    let(:data) { "\x00\x00\x00\x00\x00/\x94\xB01234567812345678" +
-                 "\xB0abcdefghijklmnop\x81\xA4flag\a\xA4boom" }
+    let(:data) { "\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00/\x94\xB0" +
+                 "1234567812345678\xB0abcdefghijklmnop\x81\xA4flag\a\xA4boom" }
     let(:io) { StringIO.new data }
     let(:msg) { Rexpro::Message.read_from(io) }
 
@@ -50,8 +50,8 @@ describe Rexpro::Message::SessionRequest do
     it 'correctly writes to the io object' do
       subject.session_uuid = 'abcdefghijklmnop'
       subject.write_to(io)
-      io.string.must_equal "\x00\x01\x00\x00\x00'\x96\xB0abcdefghijklmnop" +
-                           "\xB01234567812345678\x80\x02\xA0\xA0"
+      io.string.must_equal "\x01\x00\x00\x00\x00\x00\x01\x00\x00\x00&\x95\xB0abcdefghijklmnop" +
+                           "\xB01234567812345678\x80\xA0\xA0"
     end
 
     it 'is symmetrical with .read_from' do

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: rexpro
 version: !ruby/object:Gem::Version
-  version: 0.0.6
-  prerelease: 
+  version: 1.0.0
 platform: ruby
 authors:
 - Lann Martin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-13 00:00:00.000000000 Z
+date: 2013-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: uuid
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -46,7 +41,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: tcp_timeout
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -54,7 +48,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -62,7 +55,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -70,7 +62,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -78,17 +69,15 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: RexPro, a binary protocol for Rexster
@@ -99,6 +88,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -117,27 +107,31 @@ files:
 homepage: https://github.com/lann/rexpro-ruby
 licenses:
 - MIT
-post_install_message: 
+metadata: {}
+post_install_message: |2+
+
+  !   ***UPDGRADE WARNING***
+  !   rexpro-ruby 1.x breaks compatibility with rexster-server-2.3 and below.
+  !   Continue using 0.x versions if you cannot upgrade rexster.
+
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: RexPro is a binary protocol for Rexster that can be used to send Gremlin
   scripts to a remote Rexster instance.
 test_files: