micro-rb 0.1.0.rc1

data/.ruby-gemset

@@ -0,0 +1 @@
+micro-rb

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.4.0

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.14.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at andrew@amedeiros.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 amedeiros
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,204 @@
+[![Build Status](https://travis-ci.org/amedeiros/micro-rb.svg?branch=master)](https://travis-ci.org/amedeiros/micro-rb)
+
+# MicroRb
+
+MicroRb allows you to develop micro services for the [micro](https://github.com/micro/micro) framework.
+MicroRb uses the [sidecar](https://github.com/micro/micro/tree/master/car) that comes with micro. If you want to write services in Go see [go-micro](https://github.com/micro/go-micro) or in java see [ja-micro](https://github.com/Sixt/ja-micro).
+
+## 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
+gem 'micro-rb'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install micro-rb
+
+## Status
+
+Currently in development. If I can get some pull requests that would be much appreciated.
+
+## Google Protobufs
+
+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`
+
+
+```proto
+syntax = "proto3";
+
+package micro_rb.sum_handler;
+
+message Request {
+    int32 a = 1;
+    int32 b = 2;
+}
+
+message Response {
+    int32 total = 1;
+}
+
+```
+
+## Usage
+
+```ruby
+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
+
+server = MicroRb::Servers::Web.new(:test, debug: true)
+server.add_handler MyHandler.new
+server.start!
+
+```
+
+Configuration has the following defaults for sidecar endpoint.
+
+`Host: "http://127.0.0.1"`
+
+`Port: 8081`
+
+`Registy: "/registry"`
+
+
+Configuration can be changed.
+
+```ruby
+MicroRb::Configuration.configure do |c|
+  c.sidecar_host     = 'http://mysite.com'
+  c.sidecar_port     = '8080'
+  c.sidecar_registry = '/awesome_registry'
+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!
+
+```ruby
+require 'rack/handler/puma'
+server = MicroRb::Servers::Web.new(:test, debug: true, server: :puma)
+```
+
+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.
+
+
+![alt text](https://github.com/amedeiros/micro-rb/blob/master/registry.png)
+![alt text](https://github.com/amedeiros/micro-rb/blob/master/sum.png)
+
+
+## Micro API Gateway
+
+`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
+}
+```
+
+## Calling the service directly
+
+```
+$ 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"}
+```
+
+## Project Generator
+
+```
+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](https://github.com/rocketjob/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
+```
+
+## Development
+
+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](https://rubygems.org).
+
+## Contributing
+
+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](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'microrb'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/microrb

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# coding: utf-8
+# frozen_string_literal: true
+
+require 'micro/cli'
+
+MicroRb::CLI.new(ARGV).run!

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/micro/cli.rb

@@ -0,0 +1,69 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+require 'optparse'
+require 'micro/project_generator'
+
+module MicroRb
+  class CLI
+    attr_reader :parser, :options
+
+    def initialize(argv)
+      setup
+      @options = {}
+      parser.parse! argv.dup
+    end
+
+    def run!
+      if options.empty?
+        puts parser
+        exit
+      end
+
+      generate_new if options.key?(:new)
+    end
+
+    private
+
+    def setup
+      @parser = OptionParser.new do |opts|
+        opts.banner = 'microrb <options>'
+
+        opts.on '-n', '--new NAME', 'Generate a new skeleton service.' do |name|
+          options[:new] = name
+        end
+
+        opts.on '-e', '--encryption', 'Adds Symmetric Encryption gem to your new service.' do |encryption|
+          options[:encryption] = encryption
+        end
+
+        opts.on '-a', '--activerecord', 'Adds ActiveRecord to your gemfile and a default DB setup.' do |ar|
+          options[:active_record] = ar
+        end
+
+        opts.on '-h', '--help', 'Display this help screen' do
+          puts opts
+          exit
+        end
+      end
+    end
+
+    def generate_new
+      puts "Generating new service called #{options[:new]}..."
+      active_record = options[:active_record]
+      encryption    = options[:encryption]
+      name          = options[:new]
+
+      ProjectGenerator.new(name, encryption, active_record).create!
+
+      puts 'Complete...'
+      if options[:encryption]
+        puts 'Please see https://rocketjob.github.io/symmetric-encryption/standalone.html'\
+' for setting up SymmetricEncryption'
+      end
+      puts 'Run sidecar: micro sidecar'
+      puts 'Run micro web: micro --web_address 0.0.0.0:8080 web'
+      puts "Run me:  ./#{name}/bin/#{name}"
+    end
+  end
+end

data/lib/micro/configuration.rb

@@ -0,0 +1,34 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+module MicroRb
+  class Configuration
+    include Singleton
+
+    attr_accessor :sidecar_registry
+    attr_accessor :sidecar_host
+    attr_accessor :sidecar_port
+
+    def self.configure
+      yield(instance) if block_given?
+    end
+
+    def sidecar_uri
+      "#{sidecar_host}:#{sidecar_port}"
+    end
+
+    def sidecar_registry_uri
+      "#{sidecar_uri}#{sidecar_registry}"
+    end
+
+    private
+
+    def initialize
+      yield(self) if block_given?
+
+      self.sidecar_host     ||= 'http://127.0.0.1'
+      self.sidecar_registry ||= '/registry'
+      self.sidecar_port     ||= '8081'
+    end
+  end
+end

data/lib/micro/examples/proto/sum.proto

@@ -0,0 +1,12 @@
+syntax = "proto3";
+
+package micro_rb.sum_handler;
+
+message Request {
+    int32 a = 1;
+    int32 b = 2;
+}
+
+message Response {
+    int32 total = 1;
+}

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

@@ -0,0 +1,21 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: sum.proto
+
+require 'google/protobuf'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_message 'micro_rb.sum_handler.Request' do
+    optional :a, :int32, 1
+    optional :b, :int32, 2
+  end
+  add_message 'micro_rb.sum_handler.Response' do
+    optional :total, :int32, 1
+  end
+end
+
+module MicroRb
+  module SumHandler
+    Request  = Google::Protobuf::DescriptorPool.generated_pool.lookup('micro_rb.sum_handler.Request').msgclass
+    Response = Google::Protobuf::DescriptorPool.generated_pool.lookup('micro_rb.sum_handler.Response').msgclass
+  end
+end

data/lib/micro/examples/sum.rb

@@ -0,0 +1,22 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+require_relative '../../../lib/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
+
+server = MicroRb::Servers::Web.new(:test, debug: true, metadata: { example: 'Service' })
+server.add_handler MyHandler.new
+server.start!

data/lib/micro/handler.rb

@@ -0,0 +1,63 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+module MicroRb
+  module Handler
+    extend ActiveSupport::Concern
+
+    included do
+      include SemanticLogger::Loggable
+
+      def self.handler(options)
+        raise 'Missing name' unless options.key?(:name)
+        raise 'Missing rpc_method' unless options.key?(:rpc_method)
+        raise 'Metadata should be a Hash' if options.key?(:metadata) && !options.is_a?(Hash)
+
+        class_attribute :name
+        public_send('name=', options[:name])
+
+        class_attribute :metadata
+        public_send('metadata=', options[:metadata] || {})
+
+        class_attribute :rpc_method
+        public_send('rpc_method=', options[:rpc_method].to_sym)
+      end
+
+      def full_rpc_name
+        "#{self.class.to_s.split('::').last}.#{rpc_method}"
+      end
+
+      def request_structure
+        build_structure(self.class::Request)
+      end
+
+      def response_structure
+        build_structure(self.class::Response)
+      end
+
+      def endpoint_structure
+        { name: full_rpc_name, request: request_structure,
+          response: response_structure, metadata: metadata }
+      end
+
+      def valid?
+        self.class.constants.include?(:Request) &&
+          self.class.constants.include?(:Response) &&
+          name.present? &&
+          rpc_method.present?
+      end
+
+      private
+
+      def build_structure(type)
+        structure_values = []
+
+        type.descriptor.entries.each do |descriptor|
+          structure_values << { name: descriptor.name, type: descriptor.type }
+        end
+
+        { values: structure_values }
+      end
+    end
+  end
+end

data/lib/micro/handler_manager.rb

@@ -0,0 +1,60 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+module MicroRb
+  class HandlerManager
+    attr_reader :handlers, :rpc_methods, :endpoints
+
+    def initialize
+      @handlers    = []
+      @rpc_methods = {}
+      @endpoints   = []
+    end
+
+    def add_handler(handler)
+      validate_handler(handler)
+      add_rpc_method(handler)
+      add_endpoints(handler)
+
+      handlers << handler.name
+    end
+
+    def rpc_method(method)
+      rpc_methods[method.to_sym]
+    end
+
+    def rpc_method?(method)
+      rpc_methods.key?(method.to_sym)
+    end
+
+    def rpc_method_response(method)
+      rpc_method(method).owner::Response.new
+    end
+
+    def rpc_method_request(method, params)
+      rpc_method(method).owner::Request.new(*params)
+    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 #{handler.name} is invalid." unless handler.valid?
+    end
+
+    def add_rpc_method(handler)
+      rpc_methods[handler.full_rpc_name.to_sym] = handler.method(handler.rpc_method)
+    end
+
+    def add_endpoints(handler)
+      @endpoints << handler.endpoint_structure
+    end
+  end
+end

data/lib/micro/handlers/debug.rb

@@ -0,0 +1,26 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+require 'micro/proto/debug_pb'
+
+module MicroRb
+  module Handlers
+    class Debug
+      include MicroRb::Handler
+      include MicroRb::Debug
+
+      handler name: :debug, metadata: { about: 'Health check endpoint' }, rpc_method: :health
+
+      def health(request: Request.new, response: Response.new)
+        response.status = 'ok' # default
+
+        response
+      end
+
+      # Override this to set Health capital.
+      def full_rpc_name
+        "#{self.class.to_s.split('::').last}.Health"
+      end
+    end
+  end
+end