MicroRb

MicroRb allows you to develop micro services for the micro framework. MicroRb uses the proxy (previously called sidecar) that comes with micro. If you want to write services in Go see go-micro or in java see ja-micro.

Add this line to your application's Gemfile:

gem 'micro-rb'

And then execute:

$ bundle

Or install it yourself as:

$ gem install micro-rb -v '0.1.0.rc2'

Currently in development. If I can get some pull requests that would be much appreciated.

Currently supporting protobufs where each handler includes the module generated with requiring a Response and Request type. The example below is for the sum handler.

$ protoc --ruby_out=. sum.proto

syntax = "proto3";

package micro_rb.sum_handler;

message Request {
    int32 a = 1;
    int32 b = 2;
}

message Response {
    int32 total = 1;
}

require 'microrb'
require_relative '../examples/proto/sum_pb'

class MyHandler
  include MicroRb::Handler
  include MicroRb::SumHandler

  handler name: :test, metadata: { hello: 'Micro-Rb' }, rpc_method: :sum

  def sum(request: Request.new, response: Response.new)
    response.total = request.a + request.b

    response
  end
end

service_config = MicroRb::ServiceConfiguration.new(name: :test)
service_config.add_handler(MyHandler.new)

server = MicroRb::Servers::Web.new(service_config)
server.start!

Configuration has the following defaults for sidecar endpoint.

Host: "http://127.0.0.1"

Port: 8081

Registy: "/registry"

Configuration has the following defaults for the micro api.

Host: http://127.0.0.1

Port: 3002

Rpc: "/rpc"

Configuration can be changed.

MicroRb::Configuration.configure do |c|
  c.sidecar_host     = 'http://mysite.com'
  c.sidecar_port     = '8080'
  c.sidecar_registry = '/awesome_registry'
  
  c.api_host  = 'http://mysite.com'
  c.api_port  = '8080'
  c.api_rpc   = '/awesome_micro_rb'
end

Want to run puma? No problem just add puma to your Gemfile and require the rack handler and tell the web server to use puma. This works with thin etc because we just pass the options along to the rack server. Try it with the sum example!

require 'rack/handler/puma'
service_config = MicroRb::ServiceConfiguration.new(name: :test, server: :puma)
server = MicroRb::Servers::Web.new(service_config)

Every handler must setup the following requirements at a minimum. handler name: :my_name, rpc_method: :some_method

The :rpc_method must accept named parameters of request: and response:

Every handler must include a prtobuf module that has Request and Response constanst generated from protoc.

micro api --address 0.0.0.0:3002

$ http POST 0.0.0.0:3002/rpc method=MyHandler.sum service=test request='{"a": 1, "b": 2}'
HTTP/1.1 200 OK
Access-Control-Allow-Credentials: true
Access-Control-Allow-Headers: Content-Type, Content-Length, Accept-Encoding, X-CSRF-Token, Authorization
Access-Control-Allow-Methods: POST, GET, OPTIONS, PUT, DELETE
Content-Length: 11
Content-Type: application/json
Date: Tue, 09 May 2017 17:50:47 GMT

{
    "total": 3
}

result = MicroRb::Clients::Rpc.call(service: 'test', method: 'MyHandler.sum', params: {a:1, b:2})
ap result
{
    "total" => 3
}

$ http POST 0.0.0.0:3000 service=test method=MyHandler.sum id=1 params:='[{"a": 1, "b": 2}]'
HTTP/1.1 200 OK
Connection: Keep-Alive
Content-Length: 31
Date: Tue, 09 May 2017 18:08:25 GMT
Server: WEBrick/1.3.1 (Ruby/2.4.0/2016-12-24)

{"result":{"total":3},"id":"1"}

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
}

microrb <options>
    -n, --new NAME                   Generate a new skeleton service.
    -e, --encryption                 Adds Symmetric Encryption gem to your new service.
    -a, --activerecord               Adds ActiveRecord to your gemfile and a default DB setup.
    -h, --help                       Display this help screen

To generate a new micro service project run the following. Note this also adds Symmetric Encryption gem with the -e flag.

microrb -n myservice -e

This will output a new project with the example sum service ready to run.

Generating new service called myservice...
Fetching gem metadata from https://rubygems.org/.............
Fetching version metadata from https://rubygems.org/.
Resolving dependencies...
...... More bundler stuff here
Complete...
Please see https://rocketjob.github.io/symmetric-encryption/standalone.html for setting up SymmetricEncryption
Run sidecar: micro sidecar
Run micro web: micro --web_address 0.0.0.0:8080 web
Run me:  ./myservice/bin/myservice

./myservice/bin/myservice
[2017-05-05 14:28:52] INFO  WEBrick 1.3.1
[2017-05-05 14:28:52] INFO  ruby 2.3.1 (2017-03-06) [java]
[2017-05-05 14:28:52] INFO  WEBrick::HTTPServer#start: pid=48485 port=3000

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Bug reports and pull requests are welcome on GitHub at https://github.com/amedeiros/micro-rb. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

The gem is available as open source under the terms of the MIT License.