grenache-ruby-ws 0.2.2 → 0.2.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: daa23879e8e614041eb0a3b12c1ca2d6ef9af2c0
-  data.tar.gz: 0c7be516fcfdfb2b20a3bf0036a32750f997d3ac
+  metadata.gz: 0d8e09ec7280bce519ad8be70ff54a7c41b527d9
+  data.tar.gz: 3a8cfee41845a3bc5c137a1b03178d229020cfda
 SHA512:
-  metadata.gz: c585bf00d8bffc7af6550f8a4f7f04abf831cfc295bc385869db0b1b87c109dafdf91074e93951c7ecfc55d94d66362eb0b3738f0c3e782955e6340416a94633
-  data.tar.gz: 456565238ad79fd78cf68f0c8b260235872fd6be2f0ed4d9f1abcd05f3b6a64eb2dbe38cb4ad81873fb7b4fa3e1210d2a0f075ff7756807e4a53c71717a64699
+  metadata.gz: d9885efe4809a77e34fab1b2ae6721d87b76025434f8f746efbff3a5c9c5dee92f45d3d946526b1e8841f3d88c39996b96378b6883f6f32a3baa0cb346773589
+  data.tar.gz: 72a476ab7b7fc9b1c9511f41a677aad9fd08751c524e2ec0ea3286bf408bf92470ac0275e66577d89cfb31031488d3083abe6d506a19500772410fa0aefe7108

data/Gemfile

@@ -1,3 +1,5 @@
 source 'https://rubygems.org'
 
 gemspec
+
+gem "grenache-ruby-base", path: "../grenache-ruby-base"

data/README.md

@@ -1 +1,131 @@
-# grenache-ruby-ws
+# grenache-ruby-ws
+
+<img src="logo.png" width="15%" />
+
+Grenache is a micro-framework for connecting microservices. Its simple and optimized for performance.
+
+Internally, Grenache uses Distributed Hash Tables (DHT, known from Bittorrent) for Peer to Peer connections. You can find more details how Grenche internally works at the [Main Project Homepage](https://github.com/bitfinexcom/grenache)
+
+ - [Setup](#setup)
+ - [Examples](#examples)
+ - [API](#api)
+
+## Setup
+
+### Install
+```
+gem install grenache-ruby-ws
+```
+
+### Other Requirements
+
+Install `Grenache Grape`: https://github.com/bitfinexcom/grenache-grape:
+
+```bash
+npm i -g grenache-grape
+```
+
+```
+// Start 2 Grapes
+grape --dp 20001 --aph 30001 --bn '127.0.0.1:20002'
+grape --dp 20002 --aph 40001 --bn '127.0.0.1:20001'
+```
+
+## Examples
+
+#### RPC Server / Client
+
+This RPC Server example announces a service called `rpc_test`
+on the overlay network. When a request from a client is received,
+it replies with `world`. It receives the payload `hello` from the
+client.
+
+The client sends `hello` and receives `world` from the server.
+
+Internally the DHT is asked for the IP of the server and then the
+request is done as Peer-to-Peer request via websockets.
+
+**Grape:**
+
+```bash
+grape --dp 20001 --aph 30001 --bn '127.0.0.1:20002'
+grape --dp 20002 --aph 40001 --bn '127.0.0.1:20001'
+```
+
+**Server:**
+
+```rb
+require "grenache-ruby-ws"
+
+EM.run do
+  Signal.trap("INT")  { EventMachine.stop }
+  Signal.trap("TERM") { EventMachine.stop }
+
+  c = Grenache::Ws.new(grape_address: "http://127.0.0.1:40001/")
+  port = 5001
+
+  c.listen("test_service", port) do |req|
+    error = nil
+    [error,"hello #{req.payload}"]
+  end
+end
+```
+
+**Client:**
+
+```rb
+require "grenache-ruby-ws"
+
+c = Grenache::Ws.new(grape_address: "http://127.0.0.1:40001/")
+
+EM.run do
+  10.times do |n|
+    c.request("test_service","world #{n}") do |err, msg|
+      if err
+        puts "error: #{err}"
+      else
+        puts "response: #{msg}"
+      end
+    end
+  end
+end
+
+
+```
+
+[Code Server](https://github.com/bitfinexcom/grenache-ruby-ws/blob/master/examples/worker.rb)
+[Code Client](https://github.com/bitfinexcom/grenache-ruby-ws/blob/master/examples/client.rb)
+
+## API
+
+### Class: Grenache::Ws
+
+### Grenache::Ws.new(options)
+  - `options`
+    - `:grape_address` &lt;String&gt;
+    - `:timeout` &lt;Number&gt;
+
+    - `:auto_announce_interval` &lt;Number&gt;
+    - `:auto_announce` &lt;Boolean&gt;
+    - `:service_timeout` &lt;Number&gt;
+    - `:service_host` &lt;String&gt;
+
+### client.request(name, payload, options)
+  - `name` &lt;String&gt; Name of the service to address
+  - `payload` Payload to send
+  - `options`
+    - `:timeout` Timeout for the request
+
+Sends a single request to a RPC server/worker.
+[Example](https://github.com/bitfinexcom/grenache-ruby-ws/blob/master/examples/client.rb).
+
+
+### client.listen(key, port, options)
+  - `name` &lt;String&gt; Name of the service to announce
+  - `port` &lt;Number&gt; Port to listen
+  - `options`
+
+Sets up a worker which connects to the DHT.
+Listens on the given `port`.
+
+[Example](https://github.com/bitfinexcom/grenache-ruby-ws/blob/master/examples/worker.rb).

data/examples/client.rb

@@ -1,7 +1,7 @@
 require_relative '../lib/grenache-ruby-ws.rb'
 
 Grenache::Ws.configure do |conf|
-   conf.grape_address = "ws://127.0.0.1:30001"
+   conf.grape_address = "http://127.0.0.1:40002/"
 end
 
 EM.run do
@@ -15,5 +15,4 @@ EM.run do
       end
     end
   end
-
 end

data/examples/worker.rb

@@ -1,16 +1,14 @@
 require_relative '../lib/grenache-ruby-ws.rb'
 
-Grenache::Ws.configure do |conf|
-   conf.grape_address = "ws://127.0.0.1:30001"
-end
-
 EM.run do
 
   Signal.trap("INT")  { EventMachine.stop }
   Signal.trap("TERM") { EventMachine.stop }
-  c = Grenache::Ws.new
 
-  c.listen('rpc_test',5004) do |req|
+  c = Grenache::Ws.new grape_address: "http://127.0.0.1:40002/"
+  port = 5004
+
+  c.listen('rpc_test', port) do |req|
     [nil,"hello #{req.payload}"]
   end
 

data/grenache-ruby-ws.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency "eventmachine", "~> 1.0"
   spec.add_runtime_dependency "faye-websocket", "~> 0.10"
-  spec.add_runtime_dependency "grenache-ruby-base", "~> 0.2.0"
+  spec.add_runtime_dependency "grenache-ruby-base", "~> 0.2.12"
   spec.add_runtime_dependency "oj", "~> 2.18"
   spec.add_runtime_dependency "thin", "~> 1.7"
 

data/lib/grenache/websocket.rb

@@ -42,6 +42,10 @@ module Grenache
       @ws.send(payload)
     end
 
+    def connected?
+      @connected
+    end
+
     private
     def ws_connect
       @ws = Faye::WebSocket::Client.new(@uri)
@@ -68,5 +72,6 @@ module Grenache
     def on_close(ev)
       @connected = false
     end
+
   end
 end

data/lib/grenache/websocket/version.rb

@@ -1,5 +1,5 @@
 module Grenache
   module Websocket
-    VERSION = "0.2.2"
+    VERSION = "0.2.12"
   end
 end

data/lib/grenache/ws.rb

@@ -19,9 +19,8 @@ module Grenache
       if service_cache[key] && service_cache[key].connected?
         service_cache[key].send json
       else
-        service_cache.delete(key)
         lookup key do |services|
-          if services.length > 0
+          if services && services.length > 0
             service = services.sample
             service_cache[key] = WebsocketClient.new(service, &cb)
             service_cache[key].send json

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grenache-ruby-ws
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.12
 platform: ruby
 authors:
 - Bitfinex <info@bitfinex.com>
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-15 00:00:00.000000000 Z
+date: 2017-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.2.12
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.2.12
 - !ruby/object:Gem::Dependency
   name: oj
   requirement: !ruby/object:Gem::Requirement
@@ -98,6 +98,7 @@ files:
 - lib/grenache/websocket.rb
 - lib/grenache/websocket/version.rb
 - lib/grenache/ws.rb
+- logo.png
 homepage: https://github.com/bitfinexcom/grenache-ruby-ws
 licenses:
 - MIT