scalaroid 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: caabb3032c072a916a68ac2ce0eea04add8c8dac
-  data.tar.gz: 6101f0516c5ab1b843ea839fcc81a2d2e19c29da
+  metadata.gz: ebb984a4a84bf062f362565b3dcb99024d272133
+  data.tar.gz: 8bf7ab7c403ac124cea9b35734849fa56d3f4abe
 SHA512:
-  metadata.gz: df3b5753c4c179ae421d8d280e186881df86d21efb8cfb626c011572f225c6bda9d540bc7ef20d4d711a351b6e7ebe6bb3a621267834d151117ee23528fbb4d3
-  data.tar.gz: 2c08973fdff5d72b8acaabcfb57654b10dfc5ce3aeb3bb2c74a9675b5a2ba0c0e54888ceb4565ed0bffce5e0c035206bcfcf01fb28d4c5f6aa15ec0a471a6227
+  metadata.gz: ef3074ccc62dce91e386cbd276ee5d209527f66e6d510bae3dc788f566a4db992d3c98522857d328011af2abd48468b121022ad1b3a0e442578ca1801ef9084d
+  data.tar.gz: 8925be104f80a04795d88dbc5f1c4239a558286d9db4d81b3fb2ad2fcfd6f9e25c49917681ba48c085fd2d64ea90a00d2612d0ae5fa8b836557a3597dbe2a896

data/lib/scalaroid/delete_result.rb

@@ -0,0 +1,13 @@
+module Scalaroid
+  # Stores the result of a delete operation.
+  class DeleteResult
+    attr_reader :ok
+    attr_reader :locks_set
+    attr_reader :undefined
+    def initialize(ok, locks_set, undefined)
+      @ok = ok
+      @locks_set = locks_set
+      @undefined = undefined
+    end
+  end
+end

data/lib/scalaroid/json_req_list.rb

@@ -0,0 +1,96 @@
+module Scalaroid
+  # Request list for use with Transaction.req_list()
+  class JSONReqList
+    # Create a new object using a JSON connection.
+    def initialize(other = nil)
+      @requests = []
+      @is_commit = false
+      if not other == nil
+        concat(other)
+      end
+    end
+
+    # Adds a read operation to the request list.
+    def add_read(key)
+      if (@is_commit)
+        raise RuntimeError.new('No further request supported after a commit!')
+      end
+      @requests << {'read' => key}
+      self
+    end
+
+    # Adds a write operation to the request list.
+    def add_write(key, value, binary = false)
+      if (@is_commit)
+        raise RuntimeError.new('No further request supported after a commit!')
+      end
+      @requests << {'write' => {key => JSONConnection.encode_value(value, binary)}}
+      self
+    end
+
+    # Adds a add_del_on_list operation to the request list.
+    def add_add_del_on_list(key, to_add, to_remove)
+      if (@is_commit)
+        raise RuntimeError.new('No further request supported after a commit!')
+      end
+      @requests << {'add_del_on_list' => {'key' => key, 'add' => to_add, 'del'=> to_remove}}
+      self
+    end
+
+    # Adds a add_on_nr operation to the request list.
+    def add_add_on_nr(key, to_add)
+      if (@is_commit)
+        raise RuntimeError.new('No further request supported after a commit!')
+      end
+      @requests << {'add_on_nr' => {key => to_add}}
+      self
+    end
+
+    # Adds a test_and_set operation to the request list.
+    def add_test_and_set(key, old_value, new_value)
+      if (@is_commit)
+        raise RuntimeError.new('No further request supported after a commit!')
+      end
+      @requests << {'test_and_set' => {'key' => key,
+                                       'old' => JSONConnection.encode_value(old_value, false),
+                                       'new' => JSONConnection.encode_value(new_value, false)}}
+      self
+    end
+
+    # Adds a commit operation to the request list.
+    def add_commit
+      if (@is_commit)
+        raise RuntimeError.new('Only one commit per request list allowed!')
+      end
+      @requests << {'commit' => ''}
+      @is_commit = true
+      self
+    end
+
+    # Gets the collected requests.
+    def get_requests
+      @requests
+    end
+
+    # Returns whether the transactions contains a commit or not.
+    def is_commit()
+      @is_commit
+    end
+
+    # Checks whether the request list is empty.
+    def is_empty()
+      @requests.empty?
+    end
+
+    # Gets the number of requests in the list.
+    def size()
+      @requests.length
+    end
+
+    # Adds all requests of the other request list to the end of this list.
+    def concat(other)
+      @requests.concat(other.get_requests())
+      self
+    end
+  end
+end

data/lib/scalaroid/json_req_list_transaction.rb

@@ -0,0 +1,8 @@
+module Scalaroid
+  # Request list for use with Transaction.req_list().
+  class JSONReqListTransaction < JSONReqList
+    def initialize(other = nil)
+      super(other)
+    end
+  end
+end

data/lib/scalaroid/json_req_list_transaction_single_op.rb

@@ -0,0 +1,14 @@
+module Scalaroid
+  # Request list for use with TransactionSingleOp.req_list() which does not
+  # support commits.
+  class JSONReqListTransactionSingleOp < JSONReqList
+    def initialize(other = nil)
+      super(other)
+    end
+
+    # Adds a commit operation to the request list.
+    def add_commit()
+      raise RuntimeError.new('No commit allowed in TransactionSingleOp.req_list()!')
+    end
+  end
+end

data/lib/scalaroid/pub_sub.rb

@@ -0,0 +1,44 @@
+module Scalaroid
+  # Publish and subscribe methods accessing Scalaris' pubsub system
+  class PubSub
+    # Create a new object using the given connection.
+    def initialize(conn = JSONConnection.new())
+      @conn = conn
+    end
+
+    # Publishes content under topic.
+    def publish(topic, content)
+      # note: do NOT encode the content, this is not decoded on the erlang side!
+      # (only strings are allowed anyway)
+      # content = @conn.class.encode_value(content)
+      result = @conn.call(:publish, [topic, content])
+      @conn.class.process_result_publish(result)
+    end
+
+    # Subscribes url for topic.
+    def subscribe(topic, url)
+      # note: do NOT encode the URL, this is not decoded on the erlang side!
+      # (only strings are allowed anyway)
+      # url = @conn.class.encode_value(url)
+      result = @conn.call(:subscribe, [topic, url])
+      @conn.class.process_result_subscribe(result)
+    end
+
+    # Unsubscribes url from topic.
+    def unsubscribe(topic, url)
+      # note: do NOT encode the URL, this is not decoded on the erlang side!
+      # (only strings are allowed anyway)
+      # url = @conn.class.encode_value(url)
+      result = @conn.call(:unsubscribe, [topic, url])
+      @conn.class.process_result_unsubscribe(result)
+    end
+
+    # Gets the list of all subscribers to topic.
+    def get_subscribers(topic)
+      result = @conn.call(:get_subscribers, [topic])
+      @conn.class.process_result_get_subscribers(result)
+    end
+
+    include InternalScalarisNopClose
+  end
+end

data/lib/scalaroid/replicated_dht.rb

@@ -0,0 +1,41 @@
+module Scalaroid
+  # Non-transactional operations on the replicated DHT of Scalaris
+  class ReplicatedDHT
+    # Create a new object using the given connection.
+    def initialize(conn = JSONConnection.new())
+      @conn = conn
+    end
+
+    # Tries to delete the value at the given key.
+    #
+    # WARNING: This function can lead to inconsistent data (e.g. deleted items
+    # can re-appear). Also when re-creating an item the version before the
+    # delete can re-appear.
+    #
+    # returns the number of successfully deleted items
+    # use get_last_delete_result() to get more details
+    def delete(key, timeout = 2000)
+      result_raw = @conn.call(:delete, [key, timeout])
+      result = @conn.class.process_result_delete(result_raw)
+      @lastDeleteResult = result[:results]
+      if result[:success] == true
+        return result[:ok]
+      elsif result[:success] == :timeout
+        raise TimeoutError.new(result_raw)
+      else
+        raise UnknownError.new(result_raw)
+      end
+    end
+
+    # Returns the result of the last call to delete().
+    #
+    # NOTE: This function traverses the result list returned by Scalaris and
+    # therefore takes some time to process. It is advised to store the returned
+    # result object once generated.
+    def get_last_delete_result
+      @conn.class.create_delete_result(@lastDeleteResult)
+    end
+
+    include InternalScalarisNopClose
+  end
+end

data/lib/scalaroid/transaction.rb

@@ -0,0 +1,153 @@
+module Scalaroid
+  # Write or read operations on Scalaris inside a transaction.
+  class Transaction
+    # Create a new object using the given connection
+    def initialize(conn = JSONConnection.new())
+      @conn = conn
+      @tlog = nil
+    end
+
+    # Returns a new ReqList object allowing multiple parallel requests.
+    def new_req_list(other = nil)
+      @conn.class.new_req_list_t(other)
+    end
+
+    # Issues multiple parallel requests to Scalaris.
+    # Request lists can be created using new_req_list().
+    # The returned list has the following form:
+    # [{'status': 'ok'} or {'status': 'ok', 'value': xxx} or
+    # {'status': 'fail', 'reason': 'timeout' or 'abort' or 'not_found'}].
+    # The elements of this list can be processed with process_result_read(),
+    # process_result_write() and process_result_commit().
+    def req_list(reqlist)
+      if @tlog == nil
+        result = @conn.call(:req_list, [reqlist.get_requests()])
+      else
+        result = @conn.call(:req_list, [@tlog, reqlist.get_requests()])
+      end
+      result = @conn.class.process_result_req_list_t(result)
+      @tlog = result[:tlog]
+      result = result[:result]
+      if reqlist.is_commit()
+        _process_result_commit(result[-1])
+        # transaction was successful: reset transaction log
+        @tlog = nil
+      end
+      result
+    end
+
+    # Processes a result element from the list returned by req_list() which
+    # originated from a read operation.
+    # Returns the read value on success.
+    # Raises the appropriate exceptions if a failure occurred during the
+    # operation.
+    # Beware: lists of (small) integers may be (falsely) returned as a string -
+    # use str_to_list() to convert such strings.
+    def process_result_read(result)
+      @conn.class.process_result_read(result)
+    end
+
+    # Processes a result element from the list returned by req_list() which
+    # originated from a write operation.
+    # Raises the appropriate exceptions if a failure occurred during the
+    # operation.
+    def process_result_write(result)
+      @conn.class.process_result_write(result)
+    end
+
+    # Processes a result element from the list returned by req_list() which
+    # originated from a add_del_on_list operation.
+    # Raises the appropriate exceptions if a failure occurred during the
+    # operation.
+    def process_result_add_del_on_list(result)
+      @conn.class.process_result_add_del_on_list(result)
+    end
+
+    # Processes a result element from the list returned by req_list() which
+    # originated from a add_on_nr operation.
+    # Raises the appropriate exceptions if a failure occurred during the
+    # operation.
+    def process_result_add_on_nr(result)
+      @conn.class.process_result_add_on_nr(result)
+    end
+
+    # Processes a result element from the list returned by req_list() which
+    # originated from a test_and_set operation.
+    # Raises the appropriate exceptions if a failure occurred during the
+    # operation.
+    def process_result_test_and_set(result)
+      @conn.class.process_result_test_and_set(result)
+    end
+
+    # Processes a result element from the list returned by req_list() which
+    # originated from a commit operation.
+    # Raises the appropriate exceptions if a failure occurred during the
+    # operation.
+    def _process_result_commit(result)
+      @conn.class.process_result_commit(result)
+    end
+
+    private :_process_result_commit
+
+    # Issues a commit operation to Scalaris validating the previously
+    # created operations inside the transaction.
+    def commit
+      result = req_list(new_req_list().add_commit())[0]
+      _process_result_commit(result)
+      # reset tlog (minor optimization which is not done in req_list):
+      @tlog = nil
+    end
+
+    # Aborts all previously created operations inside the transaction.
+    def abort
+      @tlog = nil
+    end
+
+    # Issues a read operation to Scalaris, adds it to the current
+    # transaction and returns the result.
+    # Beware: lists of (small) integers may be (falsely) returned as a string -
+    # use str_to_list() to convert such strings.
+    def read(key)
+      result = req_list(new_req_list().add_read(key))[0]
+      return process_result_read(result)
+    end
+
+    # Issues a write operation to Scalaris and adds it to the current
+    # transaction.
+    def write(key, value, binary = false)
+      result = req_list(new_req_list().add_write(key, value, binary))[0]
+      _process_result_commit(result)
+    end
+
+    # Issues a add_del_on_list operation to scalaris and adds it to the
+    # current transaction.
+    # Changes the list stored at the given key, i.e. first adds all items in
+    # to_add then removes all items in to_remove.
+    # Both, to_add and to_remove, must be lists.
+    # Assumes en empty list if no value exists at key.
+    def add_del_on_list(key, to_add, to_remove)
+      result = req_list(new_req_list().add_add_del_on_list(key, to_add, to_remove))[0]
+      process_result_add_del_on_list(result)
+    end
+
+    # Issues a add_on_nr operation to scalaris and adds it to the
+    # current transaction.
+    # Changes the number stored at the given key, i.e. adds some value.
+    # Assumes 0 if no value exists at key.
+    def add_on_nr(key, to_add)
+      result = req_list(new_req_list().add_add_on_nr(key, to_add))[0]
+      process_result_add_on_nr(result)
+    end
+
+    # Issues a test_and_set operation to scalaris and adds it to the
+    # current transaction.
+    # Atomic test and set, i.e. if the old value at key is old_value, then
+    # write new_value.
+    def test_and_set(key, old_value, new_value)
+      result = req_list(new_req_list().add_test_and_set(key, old_value, new_value))[0]
+      process_result_test_and_set(result)
+    end
+
+    include InternalScalarisNopClose
+  end
+end

data/lib/scalaroid/transaction_single_op.rb

@@ -0,0 +1,130 @@
+module Scalaroid
+  # Single write or read operations on Scalaris.
+  class TransactionSingleOp
+    # Create a new object using the given connection
+    def initialize(conn = JSONConnection.new())
+      @conn = conn
+    end
+
+    # Returns a new ReqList object allowing multiple parallel requests.
+    def new_req_list(other = nil)
+      @conn.class.new_req_list_t(other)
+    end
+
+    # Issues multiple parallel requests to scalaris; each will be committed.
+    # NOTE: The execution order of multiple requests on the same key is
+    # undefined!
+    # Request lists can be created using new_req_list().
+    # The returned list has the following form:
+    # [{'status': 'ok'} or {'status': 'ok', 'value': xxx} or
+    # {'status': 'fail', 'reason': 'timeout' or 'abort' or 'not_found'}].
+    # Elements of this list can be processed with process_result_read() and
+    # process_result_write().
+    def req_list(reqlist)
+      result = @conn.call(:req_list_commit_each, [reqlist.get_requests()])
+      @conn.class.process_result_req_list_tso(result)
+    end
+
+    # Processes a result element from the list returned by req_list() which
+    # originated from a read operation.
+    # Returns the read value on success.
+    # Raises the appropriate exceptions if a failure occurred during the
+    # operation.
+    # Beware: lists of (small) integers may be (falsely) returned as a string -
+    # use str_to_list() to convert such strings.
+    def process_result_read(result)
+      @conn.class.process_result_read(result)
+    end
+
+    # Processes a result element from the list returned by req_list() which
+    # originated from a write operation.
+    # Raises the appropriate exceptions if a failure occurred during the
+    # operation.
+    def process_result_write(result)
+      # note: we need to process a commit result as the write has been committed
+      @conn.class.check_fail_abort(result)
+      @conn.class.process_result_commit(result)
+    end
+
+    # Processes a result element from the list returned by req_list() which
+    # originated from a add_del_on_list operation.
+    # Raises the appropriate exceptions if a failure occurred during the
+    # operation.
+    def process_result_add_del_on_list(result)
+      @conn.class.check_fail_abort(result)
+      @conn.class.process_result_add_del_on_list(result)
+    end
+
+    # Processes a result element from the list returned by req_list() which
+    # originated from a add_on_nr operation.
+    # Raises the appropriate exceptions if a failure occurred during the
+    # operation.
+    def process_result_add_on_nr(result)
+      @conn.class.check_fail_abort(result)
+      @conn.class.process_result_add_on_nr(result)
+    end
+
+    # Processes a result element from the list returned by req_list() which
+    # originated from a test_and_set operation.
+    # Raises the appropriate exceptions if a failure occurred during the
+    # operation.
+    def process_result_test_and_set(result)
+      @conn.class.check_fail_abort(result)
+      @conn.class.process_result_test_and_set(result)
+    end
+
+    # Read the value at key.
+    # Beware: lists of (small) integers may be (falsely) returned as a string -
+    # use str_to_list() to convert such strings.
+    def read(key)
+      result = @conn.call(:read, [key])
+      @conn.class.process_result_read(result)
+    end
+
+    # Write the value to key.
+    def write(key, value, binary = false)
+      value = @conn.class.encode_value(value, binary)
+      result = @conn.call(:write, [key, value])
+      @conn.class.check_fail_abort(result)
+      @conn.class.process_result_commit(result)
+    end
+
+    # Changes the list stored at the given key, i.e. first adds all items in
+    # to_add then removes all items in to_remove.
+    # Both, to_add and to_remove, must be lists.
+    # Assumes en empty list if no value exists at key.
+    def add_del_on_list(key, to_add, to_remove)
+      result = @conn.call(:add_del_on_list, [key, to_add, to_remove])
+      @conn.class.check_fail_abort(result)
+      @conn.class.process_result_add_del_on_list(result)
+    end
+
+    # Changes the number stored at the given key, i.e. adds some value.
+    # Assumes 0 if no value exists at key.
+    def add_on_nr(key, to_add)
+      result = @conn.call(:add_on_nr, [key, to_add])
+      @conn.class.check_fail_abort(result)
+      @conn.class.process_result_add_on_nr(result)
+    end
+
+    # Atomic test and set, i.e. if the old value at key is old_value, then
+    # write new_value.
+    def test_and_set(key, old_value, new_value)
+      result = @conn.call(:test_and_set, [key, old_value, new_value])
+      @conn.class.check_fail_abort(result)
+      @conn.class.process_result_test_and_set(result)
+    end
+
+    # Atomic test and set, i.e. if the old value at key is oldvalue, then
+    # write newvalue.
+    def test_and_set(key, oldvalue, newvalue)
+      oldvalue = @conn.class.encode_value(oldvalue)
+      newvalue = @conn.class.encode_value(newvalue)
+      result = @conn.call(:test_and_set, [key, oldvalue, newvalue])
+      @conn.class.check_fail_abort(result)
+      @conn.class.process_result_test_and_set(result)
+    end
+
+    include InternalScalarisNopClose
+  end
+end

data/lib/scalaroid/version.rb

@@ -1,3 +1,3 @@
 module Scalaroid
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/scalaroid.gemspec

@@ -6,7 +6,7 @@
 
 Gem::Specification.new do |s|
   s.name = "scalaroid"
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
@@ -26,7 +26,15 @@ Gem::Specification.new do |s|
     "Rakefile",
     "bin/scalaroid",
     "lib/scalaroid.rb",
+    "lib/scalaroid/delete_result.rb",
     "lib/scalaroid/json_connection.rb",
+    "lib/scalaroid/json_req_list.rb",
+    "lib/scalaroid/json_req_list_transaction.rb",
+    "lib/scalaroid/json_req_list_transaction_single_op.rb",
+    "lib/scalaroid/pub_sub.rb",
+    "lib/scalaroid/replicated_dht.rb",
+    "lib/scalaroid/transaction.rb",
+    "lib/scalaroid/transaction_single_op.rb",
     "lib/scalaroid/version.rb",
     "scalaroid.gemspec",
     "test/replicated_dht_test.rb",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scalaroid
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Teodor Pripoae
@@ -95,7 +95,15 @@ files:
 - Rakefile
 - bin/scalaroid
 - lib/scalaroid.rb
+- lib/scalaroid/delete_result.rb
 - lib/scalaroid/json_connection.rb
+- lib/scalaroid/json_req_list.rb
+- lib/scalaroid/json_req_list_transaction.rb
+- lib/scalaroid/json_req_list_transaction_single_op.rb
+- lib/scalaroid/pub_sub.rb
+- lib/scalaroid/replicated_dht.rb
+- lib/scalaroid/transaction.rb
+- lib/scalaroid/transaction_single_op.rb
 - lib/scalaroid/version.rb
 - scalaroid.gemspec
 - test/replicated_dht_test.rb