runivedo 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 43460292ce7c5b583ebf0ddaeb46a1049efebbb1
+  data.tar.gz: 76101f17ccee144a1d8a9a6d453861d3c36e9fc8
+SHA512:
+  metadata.gz: 3164087316cf788bce75733234a91ef251bff97fb8fa592ae0241905f4d972483a93e85590962d9e779b81e07ffbc09ca87c569d8d6c429705790976237bcfda
+  data.tar.gz: 4df3cc67fdade3ef41debb681becbf81ce8b129d60ae960e7dfbed4e5e2314f63291e86668690296a17eb0c7edb3800858e930328beea0833851e90639773b49

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012-2014 Lucas Clemente
+
+MIT License
+
+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,13 @@
+# Runivedo - Univedo Ruby Binding
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'runivedo'
+```
+
+## Usage
+
+TODO

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.pattern = "test/*_test.rb"
+  t.libs.push "test"
+end
+
+task default: :test

data/lib/runivedo/error.rb

@@ -0,0 +1,4 @@
+module Runivedo
+  class SqlError < RuntimeError; end
+  class ConnectionError < RuntimeError; end
+end

data/lib/runivedo/future.rb

@@ -0,0 +1,43 @@
+require 'thread'
+
+module Runivedo
+  class Future
+    def initialize
+      @mutex = Mutex.new
+      @cond = ConditionVariable.new
+      @success = nil
+      @value = nil
+    end
+
+    def get
+      @mutex.synchronize do
+        @cond.wait(@mutex) while @success.nil?
+      end
+      if @success
+        @value
+      else
+        raise @value
+      end
+    end
+
+    def fail(exception)
+      @mutex.synchronize do
+        @success = false
+        @value = exception
+        @cond.broadcast
+      end
+    end
+
+    def complete(value)
+      @mutex.synchronize do
+        @success = true
+        @value = value
+        @cond.broadcast
+      end
+    end
+
+    def is_complete?
+      !@success.nil?
+    end
+  end
+end

data/lib/runivedo/remote_object.rb

@@ -0,0 +1,119 @@
+module Runivedo
+  class RemoteObject
+    OPERATION_CALL_ROM = 1
+    OPERATION_ANSWER_CALL = 2
+    OPERATION_NOTIFY = 3
+    OPERATION_DELETE = 4
+
+    module MethodMissing
+      def method_missing(name, *args, &block)
+        camelizedName = name.to_s.gsub(/_([a-z])/) { $1.capitalize }
+        if camelizedName.start_with?('set')
+          send_notification(camelizedName, *args)
+        else
+          call_rom(camelizedName, *args, &block)
+        end
+      end
+    end
+
+    def initialize(session, id)
+      @session = session
+      @open = true
+      @id = id
+      @call_id = 0
+      @calls = {}
+      @notifications = {}
+      @mutex = Mutex.new
+    end
+
+    def send_notification(name, *args)
+      @mutex.synchronize do
+        check_open
+        @session.send :send_message, [@id, OPERATION_NOTIFY, name.to_s, args]
+      end
+    end
+
+    def call_rom(name, *args)
+      call_result = nil
+      @mutex.synchronize do
+        check_open
+        call_result = Future.new
+        @calls[@call_id] = call_result
+        @session.send :send_message, [@id, OPERATION_CALL_ROM, @call_id, name, args]
+        @call_id += 1
+      end
+      result = call_result.get
+      if result.is_a?(RemoteObject) && block_given?
+        begin
+          yield result
+        ensure
+          result.close
+        end
+      else
+        result
+      end
+    end
+
+    def on(notification_name, &block)
+      @notifications[notification_name.to_s] = block
+    end
+
+    def closed?
+      !@open
+    end
+
+    def close
+      @session.send :delete_ro, @id
+      onclose(Runivedo::ConnectionError.new("remote object closed"))
+      @session.send :send_message, [@id, OPERATION_DELETE]
+    end
+
+    private
+
+    def check_open
+      raise Runivedo::ConnectionError.new("remote object closed") unless @open
+    end
+
+    def onclose(reason)
+      @mutex.synchronize do
+        return unless @open
+        @open = false
+        @calls.each_value do |c|
+          c.fail(reason)
+        end
+      end
+    end
+
+    def receive(data)
+      opcode = data.shift
+      case opcode
+      when OPERATION_ANSWER_CALL
+        call_id = data.shift
+        future = @calls[call_id]
+        raise Runivedo::ConnectionError.new("unknown call id #{call_id}") unless future
+        @calls.delete(call_id)
+        status = data.shift
+        case status
+        when 0
+          result = data.shift
+          future.complete(result)
+        when 2
+          error = data.shift
+          future.fail Runivedo::SqlError.new(error)
+        else
+          raise Runivedo::ConnectionError.new("unknown status #{status}")
+        end
+      when OPERATION_NOTIFY
+        name = data.shift
+        args = data.shift
+        if block = @notifications[name]
+          block.call(*args)
+        else
+          raise Runivedo::ConnectionError.new("unknown notification #{name}")
+        end
+      else
+        raise Runivedo::ConnectionError.new("received invalid opcode #{opcode}")
+      end
+    end
+  end
+end

data/lib/runivedo/session.rb

@@ -0,0 +1,109 @@
+require "rfc-ws-client"
+require "uuidtools"
+require "cbor"
+
+# Record Id Tag
+# https://github.com/lucas-clemente/cbor-specs/blob/master/db_id.md
+CBOR.register_tag(38) {|raw| raw}
+
+module Runivedo
+  @@ro_classes = {}
+
+  def self.register_ro_class(name, klass)
+    @@ro_classes[name] = klass
+  end
+
+  def self.ro_classes
+    @@ro_classes
+  end
+
+  class Session
+    attr_reader :error
+
+    def initialize(url, args = {})
+      @remote_objects = {}
+      @ws = RfcWebSocket::WebSocket.new(url)
+      Thread.new { handle_ws }
+      @urologin = RemoteObject.new(self, 0)
+      @remote_objects[0] = @urologin
+      @session_remote = @urologin.call_rom('getSession', args)
+    end
+
+    def ping(v)
+      @session_remote.ping(v)
+    end
+
+    def get_perspective(name, &block)
+      @session_remote.get_perspective name, &block
+    end
+
+    def apply_uts(uts)
+      @session_remote.apply_uts uts
+    end
+
+    def close
+      @ws.close
+      close_ros(Runivedo::ConnectionError.new("connection closed"))
+    end
+
+    def closed?
+      @ws.closed?
+    end
+
+    private
+
+    def handle_ws
+      loop do
+        msg, binary = @ws.receive
+        raise Runivedo::ConnectionError.new("connection closed") if msg.nil?
+        raise Runivedo::ConnectionError.new("received empty message") if msg.empty?
+
+        # Read message to an array
+        io = StringIO.new(msg)
+        data = []
+        session = self
+        data << CBOR.load(io, 27 => method(:receive_ro)) while !io.eof?
+
+        # Find remote object
+        ro_id = data.shift
+        ro = @remote_objects[ro_id]
+        if ro.nil?
+          # We cannot detect whether this is an unknown ro_id or a
+          # previously closed one, so we just ignore it.
+          next
+        else
+          ro.send :receive, data
+        end
+      end
+    rescue => e
+      @error = e
+      close_ros(e)
+    end
+
+    def close_ros(reason)
+      @remote_objects.each_value {|ro| ro.send :onclose, reason}
+    end
+
+    def send_message(data)
+      @ws.send_message(data.map{|d| CBOR.dump(d)}.join, binary: true)
+    end
+
+    def receive_ro(raw)
+      name, id = raw
+      if klass = Runivedo.ro_classes[name]
+        ro = klass.new(self, id)
+      else
+        ro = RemoteObject.new(self, id)
+        ro.extend RemoteObject::MethodMissing
+        ro
+      end
+      @remote_objects[id] = ro
+      ro
+    end
+
+    # Sent from RemoteObject.close
+    def delete_ro(id)
+      @remote_objects.delete(id)
+    end
+  end
+end

data/lib/runivedo/sql.rb

@@ -0,0 +1,72 @@
+module Runivedo
+  class Statement < RemoteObject
+    Runivedo.register_ro_class('com.univedo.statement', self)
+    include Runivedo::RemoteObject::MethodMissing
+
+    def initialize(*args)
+      super(*args)
+      @column_names = Future.new
+      on('setColumnNames') {|cols| @column_names.complete(cols)}
+    end
+
+    def column_names
+      @column_names.get
+    end
+
+    def execute(binds = {}, &block)
+      call_rom("execute", binds, &block)
+    end
+  end
+
+  class Result < RemoteObject
+    Runivedo.register_ro_class('com.univedo.result', self)
+    include Enumerable
+
+    def initialize(*args)
+      super(*args)
+      @rows = Queue.new
+      @record_id = Future.new
+      @n_affected = Future.new
+
+      self.on('setError') do |msg|
+        err = RunivedoSqlError.new(msg)
+        @rows << err
+        @record_id.fail(err)
+        @n_affected.fail(err)
+      end
+
+      # SELECT
+      self.on('setComplete') { complete_futures }
+      self.on('setTuple') { |t| @rows << t }
+
+      # UPDATE, DELETE, LINK
+      self.on('setNAffectedRecords') { |n| complete_futures(n_affected: n) }
+
+      # INSERT
+      self.on('setId') { |id| complete_futures(record_id: id) }
+    end
+
+    def num_affected_rows
+      @n_affected.get
+    end
+
+    def last_inserted_id
+      @record_id.get
+    end
+
+    def each(&block)
+      while row = @rows.pop
+        raise row if row.is_a? Exception
+        block.call(row)
+      end
+    end
+
+    private
+
+    def complete_futures(values = {})
+      @n_affected.complete(values[:n_affected]) unless @n_affected.is_complete?
+      @record_id.complete(values[:record_id]) unless @record_id.is_complete?
+      @rows << nil
+    end
+  end
+end

data/lib/runivedo/version.rb

@@ -0,0 +1,3 @@
+module Runivedo
+  VERSION = "0.1.0"
+end

data/lib/runivedo.rb

@@ -0,0 +1,6 @@
+require "runivedo/version"
+require "runivedo/error"
+require "runivedo/future"
+require "runivedo/remote_object"
+require "runivedo/session"
+require "runivedo/sql"

data/runivedo.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'runivedo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "runivedo"
+  spec.version       = Runivedo::VERSION
+  spec.authors       = ["Lucas Clemente"]
+  spec.email         = ["lucas@univedo.com"]
+  spec.summary       = %q{Ruby binding for Univedo}
+  spec.homepage      = "https://github.com/univedo/runivedo"
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rfc-ws-client", '~> 1.2'
+  spec.add_dependency "cbor-simple", "~> 1.2.0"
+  spec.add_dependency "uuidtools", "~> 2.1"
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'minitest-emoji'
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+end

data/test/remote_object_test.rb

@@ -0,0 +1,55 @@
+require "test_helper"
+
+class MockSession
+  attr_accessor :msg, :onmsg
+
+  def send_message(msg)
+    @msg = msg
+    @onmsg.call if @onmsg
+  end
+
+  def delete_ro(id); end
+end
+
+class RemoteObjectTest < MiniTest::Test
+  def test_sending_notifications
+    session = MockSession.new
+    ro = Runivedo::RemoteObject.new(session, 23)
+    ro.send_notification "foo", 1, "2", 3
+    assert_equal [23, 3, "foo", [1, "2", 3]], session.msg
+  end
+
+  def test_receiving_notifications
+    res = nil
+    session = MockSession.new
+    ro = Runivedo::RemoteObject.new(session, 23)
+    ro.on("foo") {|a, b, c| res = [a, b, c]}
+    ro.send :receive, [3, "foo", [1, "2", 3]]
+    assert_equal [1, "2", 3], res
+  end
+
+  def test_rom_calls
+    session = MockSession.new
+    ro = Runivedo::RemoteObject.new(session, 23)
+    session.onmsg = -> {ro.send :receive, [2, 0, 0, 42]}
+    assert_equal 42, ro.call_rom("foo", 1, "2", 3)
+    assert_equal [23, 1, 0, "foo", [1, "2", 3]], session.msg
+  end
+
+  def test_rom_errors
+    assert_raises Runivedo::SqlError do
+      session = MockSession.new
+      ro = Runivedo::RemoteObject.new(session, 23)
+      session.onmsg = -> {ro.send :receive, [2, 0, 2, "boom"]}
+      assert_equal 42, ro.call_rom("foo", 1, "2", 3)
+      assert_equal [23, 1, 0, "foo", [1, "2", 3]], session.msg
+    end
+  end
+
+  def test_closes
+    session = MockSession.new
+    ro = Runivedo::RemoteObject.new(session, 23)
+    ro.close
+    assert_equal [23, 4], session.msg
+  end
+end

data/test/session_test.rb

@@ -0,0 +1,43 @@
+require "test_helper"
+
+class SessionTest < MiniTest::Test
+  def setup
+    @session = Runivedo::Session.new TEST_URL, TEST_AUTH
+  end
+
+  def teardown
+    @session.close unless @session.closed?
+  end
+
+  def ping(v)
+    assert_equal v, @session.ping(v), "pings #{v.inspect}"
+  end
+
+  def test_connect
+    assert !@session.closed?
+  end
+
+  def test_pings_null
+    ping nil
+    ping true
+    ping false
+    ping 42
+    ping -42
+    ping 1.1
+    ping "foobar"
+    ping [1, 2]
+    ping Time.now
+  end
+
+  def test_close
+    @session.close
+    assert @session.closed?
+  end
+
+  def test_error_closed
+    @session.close
+    assert_raises Runivedo::ConnectionError do
+      @session.ping("foo")
+    end
+  end
+end

data/test/sql_test.rb

@@ -0,0 +1,75 @@
+require "test_helper"
+
+class SqlTest < MiniTest::Test
+  def setup
+    @session = Runivedo::Session.new TEST_URL, TEST_AUTH
+    @perspective = @session.get_perspective "cefb4ed2-4ce3-4825-8550-b68a3c142f0a"
+  end
+
+  def teardown
+    @session.close
+  end
+
+  def test_connection
+    assert !@perspective.closed?
+  end
+
+  def test_empty_select
+    @perspective.query do |query|
+      query.prepare "select * from dummy where dummy_uuid = '1AF6B99E-5908-4516-A5FA-B22AFD27E003'" do |stmt|
+        stmt.execute do |result|
+          assert [], result.to_a
+        end
+      end
+    end
+  end
+
+  def test_column_names
+    @perspective.query do |query|
+      query.prepare "select dummy_id, dummy_int8 from dummy" do |stmt|
+        assert %w(dummy_id dummy_int8), stmt.column_names
+      end
+    end
+  end
+
+  def test_system_select
+    @session.get_perspective("6e5a3a08-9bb0-4d92-ad04-7c6fed3874fa") do |persp|
+      persp.query do |query|
+        query.prepare "select * from fields" do |stmt|
+          stmt.execute do |result|
+            assert result.to_a.count > 100
+          end
+        end
+      end
+    end
+  end
+
+  def test_selects
+    @perspective.query do |query|
+      query.prepare "select * from fields_inclusive" do |stmt|
+        stmt.execute do |result|
+          assert result.to_a.count > 100
+          assert result.last_inserted_id.nil?
+          assert result.num_affected_rows.nil?
+        end
+      end
+    end
+  end
+
+  def test_inserts
+    id = nil
+    @perspective.query do |query|
+      query.prepare "insert into dummy (dummy_int8) values (?)" do |stmt|
+        stmt.execute(0 => 42) do |result|
+          id = result.last_inserted_id
+        end
+      end
+      assert !id.nil?
+      query.prepare "select id, dummy_int8 from dummy where id = ?" do |stmt|
+        stmt.execute(0 => id) do |result|
+          assert_equal [[id, 42]], result.to_a
+        end
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,8 @@
+Thread.abort_on_exception = true
+
+require "minitest/autorun"
+require "minitest/emoji"
+require "runivedo"
+
+TEST_URL = "ws://vagrant/f8018f09-fb75-4d3d-8e11-44b2dc796130"
+TEST_AUTH = {username: "marvin"}

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: runivedo
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lucas Clemente
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rfc-ws-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: cbor-simple
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: uuidtools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-emoji
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- lucas@univedo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/runivedo.rb
+- lib/runivedo/error.rb
+- lib/runivedo/future.rb
+- lib/runivedo/remote_object.rb
+- lib/runivedo/session.rb
+- lib/runivedo/sql.rb
+- lib/runivedo/version.rb
+- runivedo.gemspec
+- test/remote_object_test.rb
+- test/session_test.rb
+- test/sql_test.rb
+- test/test_helper.rb
+homepage: https://github.com/univedo/runivedo
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Ruby binding for Univedo
+test_files:
+- test/remote_object_test.rb
+- test/session_test.rb
+- test/sql_test.rb
+- test/test_helper.rb