micro-rb 0.1.0.rc1 → 0.1.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d9e8d90ef1eb8db2bb2cdfe7dbfa5db6e3d81ef1
-  data.tar.gz: 18b14c46e6b068473b66773f46cc179f1b356868
+  metadata.gz: d4214b295604dcf084cac803a951262200ec128b
+  data.tar.gz: e345620800f3507ba539a95ed35c703fd0643229
 SHA512:
-  metadata.gz: 64425c6cc425855a34acf18dfba7f7a674e18af87a0f40c4d5ba48f88a595922b7c25efd5715a1b4b683899e88275014e91f54efca6a97daf5a5adbc46973c96
-  data.tar.gz: 5cd749e57fc0b960167c32e7fcc090399bfb503591c4ebfbd1a79dcb8579e7b843efbae130a130ec87c0d84aa224ca361549cff06d9caffa8177af1a72422fc7
+  metadata.gz: 06afa4711aa6ea7414a3974c1f84a09dc31f325dd5e107cfefb702c5febbc054064e652ac6ca7acad8b3b117e9baa8326341f69fb5c40d5a64a4aa1d6b0d487f
+  data.tar.gz: 74063eab50bcd01092800c9003f6ee30bb53a657537b0607f18528dbf006708f1918791d79b1f595927b0f31c65c5c98245157056ae8f0d080d4931e3f2981c2

data/Gemfile

@@ -5,7 +5,6 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in microrb.gemspec
 gemspec
 
-group :development, :test do
-  gem 'awesome_print'
-  gem 'rubocop', '~> 0.48.1', require: false
-end
+gem 'awesome_print'
+gem 'puma'
+gem 'rubocop', '~> 0.48.1', require: false

data/README.md

@@ -1,4 +1,4 @@
-[![Build Status](https://travis-ci.org/amedeiros/micro-rb.svg?branch=master)](https://travis-ci.org/amedeiros/micro-rb)
+[![Build Status](https://travis-ci.org/amedeiros/micro-rb.svg?branch=master)](https://travis-ci.org/amedeiros/micro-rb) [![Gem Version](https://badge.fury.io/rb/micro-rb.svg)](https://badge.fury.io/rb/micro-rb)
 
 # MicroRb
 
@@ -7,12 +7,6 @@ MicroRb uses the [sidecar](https://github.com/micro/micro/tree/master/car) that
 
 ## Installation
 
-Currently not on rubygems install with bundler and git
-
-```ruby
-gem 'micro-rb', github: 'amedeiros/micro-rb'
-````
-
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -25,7 +19,7 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install micro-rb
+    $ gem install micro-rb -v '0.1.0.rc2'
 
 ## Status
 
@@ -87,6 +81,13 @@ Configuration has the following defaults for sidecar endpoint.
 
 `Registy: "/registry"`
 
+Configuration has the following defaults for api gateway.
+
+`Host: http://127.0.0.1`
+
+`Port: 3002`
+
+`Rpc: "/rpc"`
 
 Configuration can be changed.
 
@@ -95,6 +96,10 @@ MicroRb::Configuration.configure do |c|
   c.sidecar_host     = 'http://mysite.com'
   c.sidecar_port     = '8080'
   c.sidecar_registry = '/awesome_registry'
+  
+  c.gateway_host  = 'http://mysite.com'
+  c.gateway_port  = '8080'
+  c.gateway_rpc   = '/awesome_micro_rb'
 end
 ```
 
@@ -137,6 +142,14 @@ Date: Tue, 09 May 2017 17:50:47 GMT
 }
 ```
 
+```ruby
+result = MicroRb::Clients::Rpc.call(service: 'test', method: 'MyHandler.sum', params: {a:1, b:2})
+ap result
+{
+    "total" => 3
+}
+```
+
 ## Calling the service directly
 
 ```
@@ -150,6 +163,19 @@ Server: WEBrick/1.3.1 (Ruby/2.4.0/2016-12-24)
 {"result":{"total":3},"id":"1"}
 ```
 
+
+```ruby
+result = MicroRb::Clients::Http.call(uri: 'http://0.0.0.0:3000', service: 'test', method: 'MyHandler.sum', params: {a:1, b:2})
+ap result
+
+{
+    "result" => {
+        "total" => 3
+    },
+        "id" => nil
+}
+```
+
 ## Project Generator
 
 ```

data/lib/micro/{sidecar → clients}/base.rb

@@ -4,7 +4,7 @@
 require 'httparty'
 
 module MicroRb
-  module Sidecar
+  module Clients
     module Base
       extend ActiveSupport::Concern
 
@@ -17,8 +17,8 @@ module MicroRb
           { body: body.to_json, headers: { 'Content-Type' => CONTENT_TYPE } }
         end
 
-        def self.registry_uri
-          MicroRb::Configuration.instance.sidecar_registry_uri
+        def self.decode(json)
+          MultiJson.decode(json)
         end
       end
     end

data/lib/micro/clients/http.rb

@@ -0,0 +1,18 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+module MicroRb
+  module Clients
+    class Http
+      include Base
+
+      def self.call(uri:, service:, method:, params:, klass_response: nil)
+        response = decode(post(uri, options(service: service, method: method, params: Array.wrap(params))))
+
+        return klass_response.new(response.to_h.symbolize_keys!) if klass_response
+
+        response
+      end
+    end
+  end
+end

data/lib/micro/clients/rpc.rb

@@ -0,0 +1,21 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+module MicroRb
+  module Clients
+    class Rpc
+      include Base
+
+      base_uri MicroRb::Configuration.instance.gateway_uri
+
+      def self.call(service:, method:, params:, klass_response: nil)
+        response = post(MicroRb::Configuration.instance.gateway_rpc,
+                        options(service: service, method: method, request: params))
+
+        return klass_response.new(response.to_h.symbolize_keys!) if klass_response
+
+        response
+      end
+    end
+  end
+end

data/lib/micro/clients/sidecar.rb

@@ -0,0 +1,24 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+module MicroRb
+  module Clients
+    class Sidecar
+      include Base
+
+      base_uri MicroRb::Configuration.instance.sidecar_uri
+
+      def self.register(service)
+        post(registry_path, options(service))
+      end
+
+      def self.remove(service)
+        delete(registry_path, options(service))
+      end
+
+      def self.registry_path
+        MicroRb::Configuration.instance.sidecar_registry
+      end
+    end
+  end
+end

data/lib/micro/configuration.rb

@@ -5,9 +5,11 @@ module MicroRb
   class Configuration
     include Singleton
 
-    attr_accessor :sidecar_registry
-    attr_accessor :sidecar_host
-    attr_accessor :sidecar_port
+    # Sidecar settings
+    attr_accessor :sidecar_registry, :sidecar_host, :sidecar_port
+
+    # API gateway settings
+    attr_accessor :gateway_host, :gateway_port, :gateway_rpc
 
     def self.configure
       yield(instance) if block_given?
@@ -21,14 +23,28 @@ module MicroRb
       "#{sidecar_uri}#{sidecar_registry}"
     end
 
+    def gateway_uri
+      "#{gateway_host}:#{gateway_port}"
+    end
+
+    def gateway_rpc_uri
+      "#{gateway_uri}#{gateway_rpc}"
+    end
+
     private
 
     def initialize
       yield(self) if block_given?
 
+      # Default sidecar settings
       self.sidecar_host     ||= 'http://127.0.0.1'
       self.sidecar_registry ||= '/registry'
       self.sidecar_port     ||= '8081'
+
+      # Default API gateway settings
+      self.gateway_host ||= 'http://127.0.0.1'
+      self.gateway_rpc  ||= '/rpc'
+      self.gateway_port ||= '3002'
     end
   end
 end

data/lib/micro/examples/fib.rb

@@ -0,0 +1,47 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+require_relative '../../../lib/microrb'
+require_relative '../examples/proto/fib_pb'
+require 'rack/handler/puma'
+
+# This example was to show the usage of puma as well as making RPC calls to services.
+class FibHandler
+  include MicroRb::Handler
+  include MicroRb::FibPb
+
+  handler name: :fibonacci, metadata: { hello: 'Micro-Rb' }, rpc_method: :fibonacci
+
+  def fibonacci(request: Request.new, response: Response.new)
+    if (0..1).cover?(request.n)
+      response.n = request.n
+
+      return response
+    end
+
+    left  = rpc_call(Request.new(n: request.n - 1))
+    right = rpc_call(Request.new(n: request.n - 2))
+
+    response.n = left + right
+
+    response
+  end
+
+  private
+
+  def rpc_call(request)
+    MicroRb::Clients::Rpc.call(service: :test,
+                               method: 'FibHandler.fibonacci',
+                               params: request,
+                               klass_response: Response).n
+  end
+end
+
+server = MicroRb::Servers::Web.new(:test, debug: true, metadata: { example: 'Fib Service' }, server: :puma)
+server.add_handler FibHandler.new
+server.start!
+
+# MicroRb::Clients::Rpc.call(service: :test, method: 'FibHandler.fibonacci', params: { n:  15 } )
+# {
+#     "n" => 610
+# }

data/lib/micro/examples/proto/fib.proto

@@ -0,0 +1,13 @@
+// protoc --ruby_out=. fib.proto
+
+syntax = "proto3";
+
+package micro_rb.fib_pb;
+
+message Request {
+    int32 n = 1;
+}
+
+message Response {
+    int32 n = 1;
+}

data/lib/micro/examples/proto/fib_pb.rb

@@ -0,0 +1,20 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: fib.proto
+
+require 'google/protobuf'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_message "micro_rb.fib_pb.Request" do
+    optional :n, :int32, 1
+  end
+  add_message "micro_rb.fib_pb.Response" do
+    optional :n, :int32, 1
+  end
+end
+
+module MicroRb
+  module FibPb
+    Request = Google::Protobuf::DescriptorPool.generated_pool.lookup("micro_rb.fib_pb.Request").msgclass
+    Response = Google::Protobuf::DescriptorPool.generated_pool.lookup("micro_rb.fib_pb.Response").msgclass
+  end
+end

data/lib/micro/handler_manager.rb

@@ -20,7 +20,7 @@ module MicroRb
     end
 
     def rpc_method(method)
-      rpc_methods[method.to_sym]
+      rpc_methods[method.to_sym].clone
     end
 
     def rpc_method?(method)
@@ -35,17 +35,17 @@ module MicroRb
       rpc_method(method).owner::Request.new(*params)
     end
 
+    def call_rpc_method(method, params)
+      rpc_method(method)
+        .call(request: rpc_method_request(method, params),
+              response: rpc_method_response(method))
+    end
+
     private
 
     def validate_handler(handler)
-      unless handler.is_a?(MicroRb::Handler)
-        raise "Handler must be of type MicroRb::Handler got #{handler.class}"
-      end
-
-      if handlers.include?(handler.name)
-        raise "Handler #{handler.name} has already been registered."
-      end
-
+      raise "Handler must be of type MicroRb::Handler got #{handler.class}" unless handler.is_a?(MicroRb::Handler)
+      raise "Handler #{handler.name} has already been registered." if handlers.include?(handler.name)
       raise "Handler #{handler.name} is invalid." unless handler.valid?
     end
 

data/lib/micro/proto/debug.proto

@@ -1,3 +1,5 @@
+// protoc --ruby_out=. debug.proto
+
 syntax = "proto3";
 
 package micro_rb.debug;

data/lib/micro/servers/web.rb

@@ -9,8 +9,8 @@ require 'multi_json'
 module MicroRb
   module Servers
     class Web
-      attr_accessor :host, :port, :show_errors, :debug, :metadata, :version
-      attr_accessor :handler_manager, :name, :node_id, :server
+      attr_accessor :host, :port, :show_errors, :debug, :metadata, :version,
+                    :handler_manager, :name, :node_id, :server
 
       REQUIRED_TYPES = { method: [String], params: [Hash, Array],
                          id: [String, Integer, NilClass] }.freeze
@@ -18,10 +18,10 @@ module MicroRb
       REQUIRED_KEYS  = ['method'].freeze
 
       def initialize(name, opts = {})
-        self.port     = opts.delete(:port)  || 3000
-        self.host     = opts.delete(:host)  || '0.0.0.0'
+        self.port     = opts.delete(:port)     || 3000
+        self.host     = opts.delete(:host)     || '0.0.0.0'
         self.metadata = opts.delete(:metadata) || {}
-        self.version  = opts.delete(:version) || '0.0.1'
+        self.version  = opts.delete(:version)  || '0.0.1'
         self.debug    = opts.delete(:debug)
         self.name     = name
         self.node_id  = "#{name}-#{SecureRandom.uuid}"
@@ -40,7 +40,7 @@ module MicroRb
         add_handler(MicroRb::Handlers::Debug.new)
 
         # Value will raise an error on anything not 2XX
-        MicroRb::Sidecar::Register.notify(self).response.value
+        MicroRb::Clients::Sidecar.register(self).response.value
 
         if debug
           MicroRb.logger
@@ -79,27 +79,17 @@ module MicroRb
 
         return resp.finish unless req.post?
 
-        resp.write process(req.body.read)
+        resp.write handle_request(req.body.read)
         resp.finish
       end
 
-      def process(content)
-        response = handle_request(content)
-
-        MultiJson.encode(response)
-      end
-
       def create_response(request)
         method  = request['method'].strip.to_sym
         params  = request['params'].map(&:symbolize_keys!)
 
-        unless handler_manager.rpc_method?(method)
-          return error_response(Error::MethodNotFound.new(method), request)
-        end
+        return error_response(Error::MethodNotFound.new(method), request) unless handler_manager.rpc_method?(method)
 
-        rpc_method = handler_manager.rpc_method(method)
-        response   = rpc_method.call(request: handler_manager.rpc_method_request(method, params),
-                                     response: handler_manager.rpc_method_response(method))
+        response = handler_manager.call_rpc_method(method, params)
 
         success_response(request, response)
       end
@@ -119,7 +109,7 @@ module MicroRb
           response = error_response(Error::InternalError.new(e), request)
         end
 
-        response
+        MultiJson.encode(response)
       end
 
       private
@@ -150,7 +140,7 @@ module MicroRb
       def add_finalizer_hook!
         at_exit do
           MicroRb.logger.debug("Shutting down #{name}:#{host}:#{port}") if debug
-          MicroRb::Sidecar::Register.remove(self)
+          MicroRb::Clients::Sidecar.remove(self)
         end
       end
 

data/lib/micro/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module MicroRb
-  VERSION = '0.1.0.rc1'
+  VERSION = '0.1.0.rc2'
 end

data/lib/microrb.rb

@@ -15,9 +15,10 @@ end
 
 require 'micro/version'
 require 'micro/configuration'
-require 'micro/sidecar/base'
-require 'micro/sidecar/register'
-require 'micro/sidecar/call'
+require 'micro/clients/base'
+require 'micro/clients/sidecar'
+require 'micro/clients/rpc'
+require 'micro/clients/http'
 require 'micro/handler'
 require 'micro/handler_manager'
 require 'micro/servers/web'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: micro-rb
 version: !ruby/object:Gem::Version
-  version: 0.1.0.rc1
+  version: 0.1.0.rc2
 platform: ruby
 authors:
 - Andrew Medeiros
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-10 00:00:00.000000000 Z
+date: 2017-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -217,7 +217,14 @@ files:
 - bin/setup
 - lib/micro-rb.rb
 - lib/micro/cli.rb
+- lib/micro/clients/base.rb
+- lib/micro/clients/http.rb
+- lib/micro/clients/rpc.rb
+- lib/micro/clients/sidecar.rb
 - lib/micro/configuration.rb
+- lib/micro/examples/fib.rb
+- lib/micro/examples/proto/fib.proto
+- lib/micro/examples/proto/fib_pb.rb
 - lib/micro/examples/proto/sum.proto
 - lib/micro/examples/proto/sum_pb.rb
 - lib/micro/examples/sum.rb
@@ -229,9 +236,6 @@ files:
 - lib/micro/proto/debug_pb.rb
 - lib/micro/servers/error.rb
 - lib/micro/servers/web.rb
-- lib/micro/sidecar/base.rb
-- lib/micro/sidecar/call.rb
-- lib/micro/sidecar/register.rb
 - lib/micro/version.rb
 - lib/microrb.rb
 - micro-rb.gemspec

data/lib/micro/sidecar/call.rb

@@ -1,18 +0,0 @@
-# coding: utf-8
-# frozen_string_literal: true
-
-module MicroRb
-  module Sidecar
-    class Call
-      include MicroRb::Sidecar::Base
-
-      def self.rpc(path, request)
-        post(path, options(request))
-      end
-
-      def self.http(path, request)
-        post(path, query: request)
-      end
-    end
-  end
-end

data/lib/micro/sidecar/register.rb

@@ -1,18 +0,0 @@
-# coding: utf-8
-# frozen_string_literal: true
-
-module MicroRb
-  module Sidecar
-    class Register
-      include MicroRb::Sidecar::Base
-
-      def self.notify(service)
-        post(registry_uri, options(service))
-      end
-
-      def self.remove(service)
-        delete(registry_uri, options(service))
-      end
-    end
-  end
-end