grenache-ruby-http 0.2.9 → 0.2.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: beaa0126401ee4c897c7b0af26d559672c03cab8
-  data.tar.gz: 3ef82109748a48a409903704ceedbea545409700
+  metadata.gz: 503d3f71f846464f73c9f1faa400598af4d319b4
+  data.tar.gz: 1f31fed062cb4e794df77800e3c50c626bfdcf35
 SHA512:
-  metadata.gz: c34ecc533f8b29ce0da0b3e3f9d6f9cb6658f8f7b8e8150aaaaed9cee0d52bd676f15c992c3ac06e0fbb05c42f45af297b75bf23318c345f11ab4ec9eb04940b
-  data.tar.gz: 1fc334c4d9050dee4541c0f7dd3d904a4f19c9cab76d4d17304838434e9b38f2fb52da6aaaa6a12aa557ebdfae8a44ebc74e188b633a39b58bc16297a1ad25dc
+  metadata.gz: 4095530db6060f70b87056c4caf1ef21759ad22bd0a0d61ebe0db5f2d953311fa5d35add5db3f390dbfccfcd9a4f14411144974f4e74bf37a169429261a78904
+  data.tar.gz: 5a4d9035da3ecc756da66de83164323fd632223c86be26be63c74e0307aabe969d83b7fa6148e3961e5432eea3be1a89484f51cda93a6f5fc348cb1a90f74906

data/Gemfile

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

data/README.md

@@ -1,28 +1,129 @@
 # grenache-ruby-http
 
-# Configuration
+<img src="logo.png" width="15%" />
 
-```ruby
-Grenache::Base.configure do |conf|
-    conf.grape_address = "http://10.0.0.1:30002"
-end
+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-http
+```
+
+### 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'
 ```
 
-# Usage
+**Server:**
+
+```rb
+require "grenache-ruby-http"
 
-## Announce a service
+EM.run do
+  Signal.trap("INT")  { EventMachine.stop }
+  Signal.trap("TERM") { EventMachine.stop }
 
-```ruby
-c = Grenache::BaseHttp.new
+  c = Grenache::Http.new(grape_address: "http://127.0.0.1:40001/")
+  port = 5001
 
-c.listen("test",5001) do |req|
-    "hello #{req.payload}"
+  c.listen("test_service", port) do |req|
+      "hello #{req.payload}"
+  end
 end
 ```
 
-## calling a remote service
+**Client:**
+
+```rb
+require "grenache-ruby-http"
+
+c = Grenache::Http.new(grape_address: "http://127.0.0.1:40001/")
+
+resp, err = c.request("test_service", "world")
+
+puts "response: #{resp}"
 
-```ruby
-c.request('test', 'world')
 ```
 
+[Code Server](https://github.com/bitfinexcom/grenache-ruby-http/blob/master/examples/worker.rb)
+[Code Client](https://github.com/bitfinexcom/grenache-ruby-http/blob/master/examples/client.rb)
+
+## API
+
+### Class: Grenache::Http
+
+### Grenache::Http.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;
+
+    - `:key` &lt;String&gt; SSL: Path to key file
+    - `:cert_pem` &lt;String&gt; SSL: Path to chain file
+    - `:ca` &lt;String&gt; SSL: Path to ca file
+    - `:service_host` &lt;String&gt; SSL: host name, used for worker
+    - `:reject_unauthorized` SSL: Reject unauthorized certs
+    - `:verify_mode` SSL: Verification method, default `Grenache::SSL_VERIFY_PEER`
+
+
+### 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-http/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-http/blob/master/examples/worker.rb).

data/examples/client.rb

@@ -1,7 +1,7 @@
 require_relative '../lib/grenache-ruby-http.rb'
 
 
-c = Grenache::Http.new grape_address: "http://127.0.0.1:40002"
+c = Grenache::Http.new grape_address: "http://127.0.0.1:40002/"
 
 start_time = Time.now
 

data/examples/client_ssl.rb

@@ -1,13 +1,10 @@
 require_relative '../lib/grenache-ruby-http.rb'
 
-Grenache::Http.configure do |conf|
-   conf.grape_address = "http://127.0.0.1:40002/"
-   conf.key = File.expand_path('.') + "/ssl/client1-key.pem"
-   conf.cert_pem = File.expand_path('.') + "/ssl/client1-crt.pem"
-   conf.ca = File.expand_path('.') + "/ssl/ca-crt.pem"
-end
+c = Grenache::Http.new(grape_address: "http://127.0.0.1:40002/",
+                       key:  File.expand_path('.') + "/ssl/client1-key.pem",
+                       cert_pem: File.expand_path('.') + "/ssl/client1-crt.pem",
+                       ca: File.expand_path('.') + "/ssl/ca-crt.pem")
 
-c = Grenache::Http.new
 start_time = Time.now
 
 10.times do |n|

data/examples/worker_ssl.rb

@@ -1,19 +1,15 @@
 require_relative '../lib/grenache-ruby-http.rb'
 
-Grenache::Http.configure do |conf|
-   conf.grape_address = "http://127.0.0.1:40002/"
-   conf.key = File.expand_path('.') + "/ssl/server-key.pem"
-   conf.cert_pem = File.expand_path('.') + "/ssl/server-chain.pem"
-   conf.ca = File.expand_path('.') + "/ssl/ca-crt.pem"
-   conf.service_host = "localhost"
-end
-
 EM.run do
 
   Signal.trap("INT")  { EventMachine.stop }
   Signal.trap("TERM") { EventMachine.stop }
 
-  c = Grenache::Http.new
+c = Grenache::Http.new(grape_address: "http://127.0.0.1:40002/",
+                       key:  File.expand_path('.') + "/ssl/server-key.pem",
+                       cert_pem: File.expand_path('.') + "/ssl/server-chain.pem",
+                       ca: File.expand_path('.') + "/ssl/ca-crt.pem",
+                       service_host: "localhost")
 
   c.listen('rpc_test', 5004) do |msg, fingerprint|
     #[StandardError.new("Error!"),"hello #{msg.payload}"]

data/grenache-ruby-http.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency "eventmachine", "~> 1.2"
   spec.add_runtime_dependency "faye-websocket", "~> 0.10"
-  spec.add_runtime_dependency "grenache-ruby-base", "~> 0.2.9"
+  spec.add_runtime_dependency "grenache-ruby-base", "~> 0.2.11"
   spec.add_runtime_dependency "httparty", "~> 0.14.0"
   spec.add_runtime_dependency "oj", "~> 2.18"
   spec.add_runtime_dependency "thin", "~> 1.7"

data/lib/grenache/http/http_server.rb

@@ -1,4 +1,10 @@
 module Thin
+  module Backends
+    class Base
+      attr_accessor :ca_cert
+    end
+  end
+
   class Connection < EventMachine::Connection
     def ssl_verify_peer cert
       client = OpenSSL::X509::Certificate.new cert
@@ -9,14 +15,10 @@ module Thin
     private
     def store
        @store ||= OpenSSL::X509::Store.new.tap do |store|
-         root = OpenSSL::X509::Certificate.new ca_cert
+         root = OpenSSL::X509::Certificate.new backend.ca_cert
          store.add_cert root
        end
     end
-
-    def ca_cert
-      @ca_cert ||= File.read Grenache::Http.config.ca
-    end
   end
 end
 

data/lib/grenache/http/version.rb

@@ -1,5 +1,5 @@
 module Grenache
   module HTTP
-    VERSION = "0.2.9"
+    VERSION = "0.2.11"
   end
 end

data/lib/grenache/http.rb

@@ -1,6 +1,12 @@
 module Grenache
   class Http < Grenache::Base
 
+    default_conf do |conf|
+      conf.thin_threaded = true
+      conf.threadpool_size = 10
+      conf.verify_mode = Grenache::SSL_VERIFY_PEER
+    end
+
     def listen(key, port,  opts={}, &block)
       start_http_service(port,&block)
 
@@ -32,6 +38,7 @@ module Grenache
             cert_chain_file: config.cert_pem,
             verify_peer: true
           }
+          server.backend.ca_cert = File.read config.ca
         end
         server.start
       }

data/lib/grenache-ruby-http.rb

@@ -8,4 +8,3 @@ require 'grenache/http'
 require 'grenache/http/version'
 require 'grenache/http/http_client'
 require 'grenache/http/http_server'
-require 'grenache/http/configurable'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grenache-ruby-http
 version: !ruby/object:Gem::Version
-  version: 0.2.9
+  version: 0.2.11
 platform: ruby
 authors:
 - Bitfinex <info@bitfinex.com>
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-21 00:00:00.000000000 Z
+date: 2017-06-23 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.9
+        version: 0.2.11
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.9
+        version: 0.2.11
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
@@ -129,10 +129,10 @@ files:
 - grenache-ruby-http.gemspec
 - lib/grenache-ruby-http.rb
 - lib/grenache/http.rb
-- lib/grenache/http/configurable.rb
 - lib/grenache/http/http_client.rb
 - lib/grenache/http/http_server.rb
 - lib/grenache/http/version.rb
+- logo.png
 homepage: https://github.com/bitfinexcom/grenache-ruby-http
 licenses:
 - MIT

data/lib/grenache/http/configurable.rb

@@ -1,6 +0,0 @@
-module Grenache
-  class Configuration
-    # thin server
-    attr_accessor :thin_threaded, :thin_threadpool_size
-  end
-end