swarmclient 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 78b0081e269fca254447d15622cf08ecfa779e17
-  data.tar.gz: '001971af13049e326c9c8bd9096bd5cb40b496a7'
+  metadata.gz: 99f80ba44aa24f9ee3eb4e9ce141e3ecf63e3f94
+  data.tar.gz: 4d428173cc0aa564f57f4022ad50d5f72308764b
 SHA512:
-  metadata.gz: 8021ab7bb29ed5791e95d9850c79cd445a517fd63bdf7ad1673d5e2d8d2a79cf3ebab766098861ee5c51330a494a2242a96aa06714a0581b0f9dddb1e3952e72
-  data.tar.gz: a6eea143378cfb711ad48c80e4d090e7f03788260fbf9959484a01c5f790272492ccd0f3b68abf4ea0b38ec454ea160d15b9786cdcd3710d69aae2541caf79e0
+  metadata.gz: b330011864610edf645f0f2694783726f0247b5f9a79b31ff18f742a434d0b0a9d1f85417330aa5e6e56d41945c6d3c67c9237943a52f943b39f76a68c7a3fbb
+  data.tar.gz: e42427944c2c2f0b88574efe20f07eb9edadd567e3e7918c65db318a46f819641ee323578bbe02f0e48cf3ad7f3aa5fcc475f19767abe297eaec432e6f49c4ca

data/.gitignore

@@ -7,6 +7,7 @@
 /spec/reports/
 /tmp/
 *.gem
+.idea
 
 # rspec failure tracking
 .rspec_status

data/.gitmodules

@@ -0,0 +1,4 @@
+[submodule "proto"]
+	path = proto
+	url = https://github.com/bluzelle/swarmdb
+	branch = devel

data/.travis.yml

@@ -1,7 +1,23 @@
 sudo: false
 language: ruby
+
+addons:
+  apt:
+    sources:
+      - ubuntu-toolchain-r-test
+      - sourceline: 'deb http://ppa.launchpad.net/maarten-fonville/protobuf/ubuntu trusty main'
+    packages:
+      - protobuf-compiler
+
+before_install:
+  # Uncommented until issue is resolved: https://github.com/google/protobuf/issues/4852
+  # - mkdir -p lib/swarmclient/protobuf
+  # - protoc --ruby_out=lib/swarmclient/protobuf --proto_path=proto/proto bluzelle.proto database.proto audit.proto
+  - gem install bundler -v 1.16.0
+
+
 rvm:
   - 2.4.2
+
 script:
-  - bundle exec rake spec
-before_install: gem install bundler -v 1.16.0
+  - bundle exec rake spec

data/README.md

@@ -2,6 +2,8 @@
 
 [![Build Status](https://api.travis-ci.org/wlwanpan/swarmclient-rb.png?branch=master)](https://travis-ci.org/wlwanpan/swarmclient-rb)
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![Twitter](https://img.shields.io/badge/twitter-@bluzelle-blue.svg?style=flat-square)](https://twitter.com/BluzelleHQ)
+[![Gitter chat](https://img.shields.io/gitter/room/nwjs/nw.js.svg?style=flat-square)](https://gitter.im/bluzelle)
 
 ## Installation
 
@@ -25,68 +27,83 @@ Or build and install from src:
 ## Communication API (Swarmclient::Communication)
 
 Require and Initialize
-```
+```ruby
 require 'swarmclient'
 
 bluzelle = Swarmclient::Communication.new endpoint: '127.0.0.1', port: 51010, uuid: '80174b53-2dda-49f1-9d6a-6a780d4'
 ```
 
 Note: The uuid is the unique id of a referenced db hosted in the swarm.
-Generate a new one to generate a new store. The gem will default to:
-'8c073d96-7291-11e8-adc0-fa7ae01bbebc' if none is provided.
-Refer to https://bluzelle.github.io/api/ for more info.
+Generate a new one to generate a new database. The gem will default to:
+"8c073d96-7291-11e8-adc0-fa7ae01bbebc" if none is provided.
 
 Create New Entry (key-value)
-```
+```ruby
 bluzelle.create 'myKey', 'Your Value'
 ```
+- Result
+```ruby
+=> true
+```
 
 Read Key
-```
+```ruby
 bluzelle.read 'myKey'
 ```
 - Result
-```
+```ruby
 => "Your Value"
 ```
 
 Update Key value
-```
+```ruby
 bluzelle.update 'myKey', 'New Value'
 ```
+- Result
+```ruby
+=> true
+```
 
 Remove Key
-```
+```ruby
 bluzelle.remove 'myKey'
 ```
+- Result
+```ruby
+=> true
+```
 
 Check if key exist
-```
+```ruby
 bluzelle.has 'myKey'
 ```
 - Result
-```
+```ruby
 => true
 ```
 
 Read all keys stored
-```
+```ruby
 bluzelle.keys
 ```
 - Result
-```
- => ["myKey1"]
+```ruby
+ => ["myKey"]
 ```
 
 Get size of database
-```
+```ruby
 bluzelle.size
 ```
 - Result
-```
+```ruby
 => 1
 ```
 
+## Reference
+
+Visit the official bluzelle [documentation](https://bluzelle.github.io/api/)
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/swarmclient/communication.rb

@@ -1,23 +1,15 @@
-require 'google/protobuf'
 require 'base64'
-require 'websocket-client-simple'
-require 'eventmachine'
 require 'json'
 
-require_relative './protobuf/bluzelle_pb'
-require_relative './protobuf/database_pb'
-
-DEFAULT_UUID = '8c073d96-7291-11e8-adc0-fa7ae01bbebc'
-DEFAULT_IP = '13.78.131.94' # '127.0.0.1'
-DEFAULT_PORT = 51010 # 8100
+require_relative './constants'
+require_relative './proto_serializer'
+require_relative './connection'
 
 module Swarmclient
   class Communication
-
-    attr_accessor :transaction_id_limit, :ws_set_timeout
-
-    @transaction_id_limit = 100
-    @ws_set_timeout = 5
+    include Constants
+    include ProtoSerializer
+    include Connection
 
     def initialize endpoint: DEFAULT_IP, port: DEFAULT_PORT, uuid: DEFAULT_UUID, secure: false
 
@@ -25,138 +17,88 @@ module Swarmclient
       @_port = port
       @_uuid = uuid
       @_protocol_prefix = secure ? 'wss://' : 'ws://'
+      @_redirect_attempt = 0
 
     end
 
     def create key, value
-      send cmd: 'create', data: { key: key, value: value.to_s }
+      send_request cmd: 'create', data: { key: key, value: value.to_s }
     end
 
     def read key
-      send cmd: 'read', data: { key: key }
+      send_request cmd: 'read', data: { key: key }
     end
 
     def update key, value
-      send cmd: 'update', data: { key: key, value: value.to_s }
+      send_request cmd: 'update', data: { key: key, value: value.to_s }
     end
 
     def remove key
-      send cmd: 'delete', data: { key: key }
+      send_request cmd: 'delete', data: { key: key }
     end
 
     def has key
-      send cmd: 'has', data: { key: key }
+      send_request cmd: 'has', data: { key: key }
     end
 
     def keys
-      send cmd: 'keys', data: nil
+      send_request cmd: 'keys', data: nil
     end
 
     def size
-      send cmd: 'size', data: nil
+      send_request cmd: 'size', data: nil
     end
 
   private
 
-    def encoded_protobuf_msg cmd:, protobuf_cmd_data:
-      db_msg = Database_msg.new
-      db_msg.header = Database_header.new db_uuid: @_uuid, transaction_id: rand(@transaction_id_limit).to_i
-      db_msg[cmd] = protobuf_cmd_data
-      bzn_msg = Bzn_msg.new db: db_msg
-      Bzn_msg.encode bzn_msg
-    end
-
-    def generate_req cmd:, data:
-      protobuf_cmd = cmd_to_protobuf cmd
-      protobuf_cmd_msg = data.nil? ? protobuf_cmd.new : protobuf_cmd.new(data)
-
-      encoded_msg = encoded_protobuf_msg cmd: cmd, protobuf_cmd_data: protobuf_cmd_msg
+    def generate_req **options
+      db_msg = generate_db_msg options.merge db_uuid: @_uuid
+      encoded_msg = encode_msg db_msg
       encoded64_msg = Base64.strict_encode64 encoded_msg
 
       {"bzn-api": "database","msg": encoded64_msg}.to_json
     end
 
-    def cmd_to_protobuf cmd
-      processed_cmd =
-        case cmd
-          when 'keys', 'size' then 'empty'
-          else cmd
-          end
-
-      Object.const_get "Database_#{processed_cmd}"
-    end
-
     def generate_endpoint
       [@_protocol_prefix, @_endpoint, ':', @_port.to_s].join('')
     end
 
-    def send cmd:, data:
-      endpoint, req = [
-        generate_endpoint,
-        generate_req({ cmd: cmd, data: data })
-      ]
+    def send_request **options
+      raise StandardError.new "Max Leader redirect attempt reached" if @_redirect_attempt >= MAX_REDIRECT_ATTEMPT
 
-      err, res = get req: req, endpoint: endpoint
-      return err if err
-      raise 'No Response' if res.nil?
+      endpoint = generate_endpoint
+      req = generate_req options
 
-      db_response = Database_response.decode res
+      err, res = connect_and_send req: req, endpoint: endpoint
+      raise err unless err.nil?
+
+      db_response = decode_res res
 
       if db_response.redirect
         puts 'Switching leader_host: ' + db_response.redirect.leader_name
+        @_redirect_attempt += 1
         @_endpoint, @_port = [
           db_response.redirect.leader_host,
-          db_response.redirect.leader_port
+          db_response.redirect.leader_port,
         ]
 
-        return send cmd: cmd, data: data
+        return send_request options
 
-      elsif !db_response.resp.nil? && !db_response.resp.error.empty?
-        return db_response.resp.error
+      elsif !(db_response.resp.nil? || db_response.resp.error.empty?)
+        raise db_response.resp.error
 
       else
-        case cmd
-        when 'create', 'update', 'delete' then nil
-        when 'read' then db_response.resp.value
-        else db_response.resp[cmd]
-        end
-
-      end
-
-    end
-
-    def get req:, endpoint:
-      res, err = [nil, nil]
-
-      begin
-        EventMachine.run do
-          ws = WebSocket::Client::Simple.connect endpoint
-
-          ws.on :message do |msg|
-            res = msg.data
-            EventMachine::stop_event_loop
-          end
-
-          ws.on :open do
-            ws.send req
-          end
-
-          ws.on :close do |e|
-            EventMachine::stop_event_loop
-          end
-
-          ws.on :error do |e|
-            err ||= e
-            EventMachine::stop_event_loop
-          end
-
-          EventMachine::Timer.new(5) { ws.close }
+        @_redirect_attempt = 0
+        case options[:cmd]
+          when 'create', 'update', 'delete' then true
+          when 'read' then db_response.resp.value
+          else db_response.resp[options[:cmd]]
         end
-      rescue => e
-        err = e
       end
 
-      return [err, res]
+    rescue => e
+      @_redirect_attempt = 0
+      e.message
     end
 
   end

data/lib/swarmclient/connection.rb

@@ -0,0 +1,46 @@
+require 'websocket-client-simple'
+require 'eventmachine'
+
+require_relative './constants'
+
+module Swarmclient
+  module Connection
+    include Constants
+
+  private
+
+    def connect_and_send req:, endpoint:
+      res, err = [nil, nil]
+
+      begin
+        EventMachine.run do
+          ws = WebSocket::Client::Simple.connect endpoint
+
+          ws.on :message do |msg|
+            res = msg.data
+            EventMachine::stop_event_loop
+          end
+
+          ws.on :open do
+            ws.send req
+          end
+
+          ws.on :close do |e|
+            EventMachine::stop_event_loop
+          end
+
+          ws.on :error do |e|
+            err ||= e
+            EventMachine::stop_event_loop
+          end
+
+          EventMachine::Timer.new(CONNECTION_TIMEOUT_LIMIT) { ws.close }
+        end
+      rescue => e
+        err = e
+      end
+
+      return [err, res]
+    end
+  end
+end

data/lib/swarmclient/constants.rb

@@ -0,0 +1,32 @@
+module Swarmclient
+  module Constants
+
+    ##
+    # Randomly generated uuid, will add validation if not initialize in the future.
+    DEFAULT_UUID = '8c073d96-7291-11e8-adc0-fa7ae01bbebc'
+
+    ##
+    # Points default ip to localhost.
+    DEFAULT_IP = '127.0.0.1'
+
+    ##
+    # Points to default swarmDB port
+    # For more details: https://github.com/bluzelle/swarmDB
+    DEFAULT_PORT = 51010
+
+    ##
+    # Set limit in seconds per socket before raising a Timeout Error
+    CONNECTION_TIMEOUT_LIMIT = 3
+
+    ##
+    # Temporary redirect attempt limit.
+    # Track discussion on: https://gitter.im/bluzelle/opensource
+    MAX_REDIRECT_ATTEMPT = 3
+
+    ##
+    # Not yet confirmed the randomness of db_msg.header.transaction_id
+    # https://github.com/wlwanpan/swarmclient-rb/issues/4
+    TRANSATION_ID_UPPER_LIMIT = 1000
+
+  end
+end

data/lib/swarmclient/proto_serializer.rb

@@ -0,0 +1,45 @@
+require 'google/protobuf'
+
+require_relative './constants'
+require_relative './protobuf/bluzelle_pb'
+require_relative './protobuf/database_pb'
+
+module Swarmclient
+  module ProtoSerializer
+    include Constants
+
+  private
+
+    def decode_res res
+      Database_response.decode res
+    end
+
+    def encode_msg msg
+      bzn_msg = Bzn_msg.new db: msg
+      Bzn_msg.encode bzn_msg
+    end
+
+    def generate_db_msg cmd:, data:, db_uuid:
+      protobuf_cmd = cmd_to_protobuf cmd
+      protobuf_cmd_msg = data.nil? ? protobuf_cmd.new : protobuf_cmd.new(data)
+
+      proto_header_msg = Database_header.new db_uuid: db_uuid, transaction_id: rand(TRANSATION_ID_UPPER_LIMIT).to_i
+
+      db_msg = Database_msg.new
+      db_msg.header = proto_header_msg
+      db_msg[cmd] = protobuf_cmd_msg
+      db_msg
+    end
+
+    def cmd_to_protobuf cmd
+      processed_cmd =
+        case cmd
+          when 'keys', 'size' then 'empty'
+          else cmd
+        end
+
+      Object.const_get "Database_#{processed_cmd}"
+    end
+
+  end
+end

data/lib/swarmclient/protobuf/audit_pb.rb

@@ -0,0 +1,28 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: audit.proto
+
+require 'google/protobuf'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_message "audit_message" do
+    oneof :msg do
+      optional :commit, :message, 1, "commit_notification"
+      optional :leader_status, :message, 2, "leader_status"
+    end
+  end
+  add_message "leader_status" do
+    optional :term, :uint64, 1
+    optional :leader, :string, 2
+    optional :current_log_index, :uint64, 3
+    optional :current_commit_index, :uint64, 4
+  end
+  add_message "commit_notification" do
+    optional :sender_uuid, :string, 1
+    optional :log_index, :uint64, 2
+    optional :operation, :string, 3
+  end
+end
+
+Audit_message = Google::Protobuf::DescriptorPool.generated_pool.lookup("audit_message").msgclass
+Leader_status = Google::Protobuf::DescriptorPool.generated_pool.lookup("leader_status").msgclass
+Commit_notification = Google::Protobuf::DescriptorPool.generated_pool.lookup("commit_notification").msgclass

data/lib/swarmclient/protobuf/bluzelle_pb.rb

@@ -4,12 +4,13 @@
 require 'google/protobuf'
 
 require_relative './database_pb'
-
+require_relative './audit_pb'
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_message "bzn_msg" do
     oneof :msg do
       optional :db, :message, 10, "database_msg"
       optional :json, :string, 11
+      optional :audit_message, :message, 12, "audit_message"
     end
   end
 end

data/lib/swarmclient/version.rb

@@ -1,3 +1,3 @@
 module Swarmclient
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/swarmclient.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Warren"]
   spec.email         = ["wlwanpan@uwaterloo.ca"]
 
-  spec.summary       = %q{A gem for the bluzele SwarmDB}
+  spec.summary       = %q{A gem for the CRUD operations on the bluzelle SwarmDB}
   # spec.description   = %q{TODO: Write a longer description or delete this line.}
   spec.homepage      = "https://github.com/wlwanpan/swarmclient-rb"
   spec.license       = "MIT"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swarmclient
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Warren
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-29 00:00:00.000000000 Z
+date: 2018-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -116,6 +116,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".gitmodules"
 - ".rspec"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
@@ -127,12 +128,14 @@ files:
 - bin/setup
 - lib/swarmclient.rb
 - lib/swarmclient/communication.rb
+- lib/swarmclient/connection.rb
+- lib/swarmclient/constants.rb
+- lib/swarmclient/proto_serializer.rb
+- lib/swarmclient/protobuf/audit_pb.rb
 - lib/swarmclient/protobuf/bluzelle_pb.rb
 - lib/swarmclient/protobuf/database_pb.rb
 - lib/swarmclient/pubsub.rb
 - lib/swarmclient/version.rb
-- proto/bluzelle.proto
-- proto/database.proto
 - swarmclient.gemspec
 homepage: https://github.com/wlwanpan/swarmclient-rb
 licenses:
@@ -157,5 +160,5 @@ rubyforge_project:
 rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
-summary: A gem for the bluzele SwarmDB
+summary: A gem for the CRUD operations on the bluzelle SwarmDB
 test_files: []

data/proto/bluzelle.proto

@@ -1,14 +0,0 @@
-syntax = "proto3";
-
-// Bluzelle message definition from:
-// https://github.com/bluzelle/swarmDB/blob/devel/proto/bluzelle.proto
-
-import "database.proto";
-
-message bzn_msg
-{
-    oneof msg {
-        database_msg db = 10;
-        string json = 11;
-    }
-}

data/proto/database.proto

@@ -1,83 +0,0 @@
-syntax = "proto3";
-
-// Database message definition from:
-// https://github.com/bluzelle/swarmDB/blob/devel/proto/database.proto
-
-message database_msg
-{
-    database_header header = 2;
-
-    oneof msg {
-        database_create create = 10;
-        database_read read = 11;
-        database_update update = 12;
-        database_delete delete = 13;
-        database_has has = 14;
-        database_empty keys = 15;
-        database_empty size = 16;
-    }
-}
-
-message database_redirect_response
-{
-    string leader_id = 1;
-    string leader_name = 2;
-    string leader_host = 3;
-    uint32 leader_port = 4;
-    uint32 leader_http_port = 5;
-}
-
-message database_header
-{
-    string db_uuid = 1;
-    uint64 transaction_id = 2;
-}
-
-message database_create
-{
-    string key = 2;
-    bytes value = 3;
-}
-
-message database_read
-{
-    string key = 2;
-}
-
-message database_update
-{
-    string key = 2;
-    bytes value = 3;
-}
-
-message database_delete
-{
-    string key = 2;
-}
-
-message database_has
-{
-    string key = 2;
-}
-
-message database_empty {}
-
-message database_response
-{
-    database_header header = 1;
-
-    oneof success
-    {
-        database_redirect_response redirect = 2;
-        response resp = 3;
-    }
-
-    message response
-    {
-        bytes value = 4;
-        bool has = 5;
-        int32 size = 6;
-        string error = 7;
-        repeated string keys = 8;
-    }
-}