micro-rb 0.1.0.rc1

data/lib/micro/project_generator.rb

@@ -0,0 +1,75 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+require 'active_support/core_ext/string/inflections'
+require 'fileutils'
+require 'erb'
+
+module MicroRb
+  class ProjectGenerator
+    attr_reader :name, :class_name, :username,
+                :year, :encryption, :active_record, :engine
+
+    def initialize(name, encryption, active_record)
+      @active_record = active_record
+      @class_name    = name.classify
+      @encryption    = encryption
+      @username      = ENV['USERNAME'] || ENV['USER']
+      @name          = name
+      @year          = Time.new.year
+      @engine        = RUBY_ENGINE == 'jruby' ? 'activerecord-jdbcmysql-adapter' : 'mysql2'
+    end
+
+    def create!
+      move_files
+      render_templates
+      install
+    end
+
+    private
+
+    def move_files
+      template_path = File.expand_path('../../../templates', __FILE__)
+
+      FileUtils.cp_r(template_path, name)
+      FileUtils.mv File.join(name, 'lib', 'app'), File.join(name, 'lib', name)
+      FileUtils.mv File.join(name, 'lib', 'app.rb'), File.join(name, 'lib', "#{name}.rb")
+      FileUtils.mv File.join(name, 'test', 'app_test.rb'),
+                   File.join(name, 'test', "#{name}_test.rb")
+      FileUtils.mv File.join(name, 'bin', 'app'), File.join(name, 'bin', name)
+      FileUtils.chmod 'u=wrx', File.join(name, 'bin', name)
+    end
+
+    def render_templates
+      [
+        File.join(name, 'bin', name),
+        File.join(name, 'lib', "#{name}.rb"),
+        File.join(name, 'lib', name, 'version.rb'),
+        File.join(name, 'lib', name, 'handlers', 'example_handler.rb'),
+        File.join(name, 'lib', name, 'proto', 'sum_pb.rb'),
+        File.join(name, 'lib', name, 'proto', 'sum.proto'),
+        File.join(name, 'test', "#{name}_test.rb"),
+        File.join(name, 'README.md'),
+        File.join(name, 'LICENSE'),
+        File.join(name, 'Gemfile'),
+        File.join(name, 'Dockerfile')
+      ].each { |file| render_template(file, binding) }
+    end
+
+    def install
+      Dir.chdir(name) do
+        Bundler.with_clean_env do
+          system('bundle')
+        end
+      end
+    end
+
+    def render_template(template, context)
+      t = File.read(template)
+
+      File.open(template, 'w') do |f|
+        f << ERB.new(t, nil, '-').result(context)
+      end
+    end
+  end
+end

data/lib/micro/proto/debug.proto

@@ -0,0 +1,10 @@
+syntax = "proto3";
+
+package micro_rb.debug;
+
+message Request {}
+
+message Response {
+    // default: ok
+    string status = 1;
+}

data/lib/micro/proto/debug_pb.rb

@@ -0,0 +1,19 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: debug.proto
+
+require 'google/protobuf'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_message 'micro_rb.debug.Request' do
+  end
+  add_message 'micro_rb.debug.Response' do
+    optional :status, :string, 1
+  end
+end
+
+module MicroRb
+  module Debug
+    Request  = Google::Protobuf::DescriptorPool.generated_pool.lookup('micro_rb.debug.Request').msgclass
+    Response = Google::Protobuf::DescriptorPool.generated_pool.lookup('micro_rb.debug.Response').msgclass
+  end
+end

data/lib/micro/servers/error.rb

@@ -0,0 +1,58 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+module MicroRb
+  module Servers
+    class Error < StandardError
+      attr_accessor :code, :message
+
+      def initialize(code, message)
+        self.code    = code
+        self.message = message
+
+        super(message)
+      end
+
+      def to_h
+        { code: code, message: message }
+      end
+
+      class ParseError < Error
+        def initialize
+          super(-32_700, 'Invalid JSON was received by the server. '\
+              'An error occurred on the server while parsing the JSON text.')
+        end
+      end
+
+      class InvalidParams < Error
+        def initialize
+          super(-32_602, 'Invalid method parameter(s).')
+        end
+      end
+
+      class ServerError < Error
+        def initialize(code, message)
+          super(code, message)
+        end
+      end
+
+      class InvalidRequest < Error
+        def initialize
+          super(-32_600, 'The JSON sent is not a valid Request object.')
+        end
+      end
+
+      class InternalError < Error
+        def initialize(e)
+          super(-32_603, "Internal server error: #{e}")
+        end
+      end
+
+      class MethodNotFound < Error
+        def initialize(method)
+          super(-32_601, "Method '#{method}' not found.")
+        end
+      end
+    end
+  end
+end

data/lib/micro/servers/web.rb

@@ -0,0 +1,162 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+require 'rack'
+require 'rack/request'
+require 'rack/response'
+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
+
+      REQUIRED_TYPES = { method: [String], params: [Hash, Array],
+                         id: [String, Integer, NilClass] }.freeze
+
+      REQUIRED_KEYS  = ['method'].freeze
+
+      def initialize(name, opts = {})
+        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.debug    = opts.delete(:debug)
+        self.name     = name
+        self.node_id  = "#{name}-#{SecureRandom.uuid}"
+        self.handler_manager = MicroRb::HandlerManager.new
+
+        server_opts = opts.merge(Host: host, Port: port, app: self)
+        self.server = Rack::Server.new(server_opts)
+      end
+
+      def add_handler(handler)
+        handler_manager.add_handler(handler)
+      end
+
+      def start!
+        # Register the debug handler. This is kinda poor.
+        add_handler(MicroRb::Handlers::Debug.new)
+
+        # Value will raise an error on anything not 2XX
+        MicroRb::Sidecar::Register.notify(self).response.value
+
+        if debug
+          MicroRb.logger
+                 .debug("Registered #{name}:#{host}:#{port} with sidecar.")
+        end
+
+        add_finalizer_hook!
+        server.start
+      rescue Net::HTTPFatalError => e
+        msg = "Sidecar error: #{e.message}"
+        MicroRb.logger.warn(msg)
+
+        raise MicroRb::Servers::Error::ServerError.new(-32_000, msg)
+      end
+
+      def to_h
+        {
+          version: version,
+          metadata: metadata,
+          name: name,
+          nodes: [{ id: node_id, address: host, port: port }],
+          endpoints: handler_manager.endpoints
+        }
+      end
+
+      def to_json
+        to_h.to_json
+      end
+
+      #
+      # Entry point for Rack
+      #
+      def call(env)
+        req  = Rack::Request.new(env)
+        resp = Rack::Response.new
+
+        return resp.finish unless req.post?
+
+        resp.write process(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
+
+        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))
+
+        success_response(request, response)
+      end
+
+      def handle_request(request)
+        request  = parse_request(request)
+        response = nil
+
+        begin
+          response = create_response(request) if valid_request?(request)
+          response ||= error_response(Error::InvalidRequest.new, request)
+        rescue MultiJson::ParseError => e
+          MicroRb.logger.warn(e)
+          response = error_response(Error::ParseError.new)
+        rescue StandardError => e
+          MicroRb.logger.warn(e)
+          response = error_response(Error::InternalError.new(e), request)
+        end
+
+        response
+      end
+
+      private
+
+      def valid_request?(request)
+        return false unless request.is_a?(Hash)
+
+        REQUIRED_KEYS.each do |key|
+          return false unless request.key?(key)
+        end
+
+        REQUIRED_TYPES.each do |key, types|
+          return false if request.key?(key) &&
+                          types.none? { |type| request[key].is_a?(type) }
+        end
+
+        true
+      end
+
+      def success_response(request, result)
+        { result: result, id: request['id'] }
+      end
+
+      def error_response(error, request = {})
+        { error: error.to_h, id: request['id'] }
+      end
+
+      def add_finalizer_hook!
+        at_exit do
+          MicroRb.logger.debug("Shutting down #{name}:#{host}:#{port}") if debug
+          MicroRb::Sidecar::Register.remove(self)
+        end
+      end
+
+      def parse_request(request)
+        MultiJson.decode(request)
+      end
+    end
+  end
+end

data/lib/micro/sidecar/base.rb

@@ -0,0 +1,26 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+require 'httparty'
+
+module MicroRb
+  module Sidecar
+    module Base
+      extend ActiveSupport::Concern
+
+      CONTENT_TYPE = 'application/json'
+
+      included do
+        include HTTParty
+
+        def self.options(body)
+          { body: body.to_json, headers: { 'Content-Type' => CONTENT_TYPE } }
+        end
+
+        def self.registry_uri
+          MicroRb::Configuration.instance.sidecar_registry_uri
+        end
+      end
+    end
+  end
+end

data/lib/micro/sidecar/call.rb

@@ -0,0 +1,18 @@
+# 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

@@ -0,0 +1,18 @@
+# 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

data/lib/micro/version.rb

@@ -0,0 +1,6 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+module MicroRb
+  VERSION = '0.1.0.rc1'
+end

data/lib/micro-rb.rb

@@ -0,0 +1,4 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+require 'microrb'

data/lib/microrb.rb

@@ -0,0 +1,25 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'active_support/all'
+require 'semantic_logger'
+
+module MicroRb
+  include SemanticLogger::Loggable
+
+  def self.env
+    ActiveSupport::StringInquirer.new(ENV['MICRO_ENV'] || 'development')
+  end
+end
+
+require 'micro/version'
+require 'micro/configuration'
+require 'micro/sidecar/base'
+require 'micro/sidecar/register'
+require 'micro/sidecar/call'
+require 'micro/handler'
+require 'micro/handler_manager'
+require 'micro/servers/web'
+require 'micro/servers/error'
+require 'micro/handlers/debug'

data/micro-rb.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'micro/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'micro-rb'
+  spec.version       = MicroRb::VERSION
+  spec.authors       = ['Andrew Medeiros']
+  spec.email         = ['andrew@amedeiros.com']
+
+  spec.summary       = 'Write micro services in Ruby for the Micro framework'
+  spec.homepage      = 'https://github.com/amedeiros/micro-rb'
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.bindir        = 'bin'
+  spec.executables   = ['microrb']
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake',     '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'minitest-reporters', '~> 1.1'
+  spec.add_development_dependency 'shoulda', '~> 3.5'
+
+  spec.add_runtime_dependency 'activesupport', '~> 5.1', '>= 5.1.0'
+  spec.add_runtime_dependency 'httparty', '~> 0.14.0'
+  spec.add_runtime_dependency 'multi_json', '~> 1.12', '>= 1.12.1'
+  spec.add_runtime_dependency 'rack', '~> 1.6', '>= 1.6.5'
+  spec.add_runtime_dependency 'semantic_logger', '~> 4.0', '>= 4.0.0'
+  spec.add_runtime_dependency 'google-protobuf', '~> 3.3', '>= 3.3.0'
+end

data/templates/Dockerfile

@@ -0,0 +1,3 @@
+FROM alpine:3.2
+ADD <%= @name %>-srv /<%= @name %>-srv
+ENTRYPOINT [ "/<%= @name %>-srv" ]

data/templates/Gemfile

@@ -0,0 +1,18 @@
+source 'https://rubygems.org'
+
+gem 'rake'
+
+gem 'bundler'
+gem 'micro-rb'
+<% if @encryption %>
+gem 'symmetric-encryption'
+<%end%>
+<% if @active_record %>
+gem 'activerecord'
+gem <%= "'#{@engine}'" %>
+<% end %>
+
+group :test do
+  gem 'minitest'
+  gem 'minitest-reporters'
+end

data/templates/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) <%= @year %> <%= @username %>
+
+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/templates/README.md

@@ -0,0 +1,17 @@
+# <%= @name %>
+
+This readme was generated by MircoRb.
+
+## Installation
+
+## Usage
+
+## Contributing
+
+## Changelog
+
+### Version 0.0.1
+
+## License
+
+See LICENSE

data/templates/Rakefile

@@ -0,0 +1,9 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose    = true
+end
+
+task default: :test

data/templates/bin/app

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH << File.expand_path(File.dirname(__FILE__) + '/../lib')
+require '<%= @name %>'
+<% if @active_record %>
+# Change the following to reflect your database settings
+ActiveRecord::Base.establish_connection(
+    adapter:  <%= "'#{@engine}'" %>,
+    host:     ENV[:DB_HOST],
+    database: ENV[:DB_NAME],
+    username: ENV[:DB_USERNAME],
+    password: ENV[:DB_PASSWORD]
+)
+<% end %>
+server = MicroRb::Servers::Web.new(:example_service, debug: true)
+server.add_handler <%= @class_name %>::ExampleHandler.new
+server.start!

data/templates/lib/app/handlers/example_handler.rb

@@ -0,0 +1,16 @@
+require_relative '../proto/sum_pb'
+
+module <%= @class_name %>
+  # Example MicroRb handler
+  class ExampleHandler
+    include MicroRb::Handler
+    include <%= @class_name %>::SumHandler
+    handler name: :example, metadata: { hello: 'Micro-Rb' }, rpc_method: :sum
+
+    def sum(request: Request.new, response: Response.new)
+      response.total = request.a + request.b
+
+      response
+    end
+  end
+end

data/templates/lib/app/proto/sum.proto

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

data/templates/lib/app/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 '<%= @name %>.sum_handler.Request' do
+    optional :a, :int32, 1
+    optional :b, :int32, 2
+  end
+  add_message '<%= @name %>.sum_handler.Response' do
+    optional :total, :int32, 1
+  end
+end
+
+module <%= @class_name %>
+  module SumHandler
+    Request  = Google::Protobuf::DescriptorPool.generated_pool.lookup('<%= @name %>.sum_handler.Request').msgclass
+    Response = Google::Protobuf::DescriptorPool.generated_pool.lookup('<%= @name %>.sum_handler.Response').msgclass
+  end
+end

data/templates/lib/app/version.rb

@@ -0,0 +1,4 @@
+
+module <%= @class_name %>
+  VERSION = '0.0.1'
+end

data/templates/lib/app.rb

@@ -0,0 +1,14 @@
+# Load Bundler and load all your gems
+require 'bundler/setup'
+
+# Explicitly load any gems you need.
+require 'microrb'
+require '<%= @name %>/version'
+require '<%= @name %>/handlers/example_handler'
+
+module <%= @class_name %>
+  # Your code goes here...
+  # Good place for your main application logic if this is a library.
+
+  # be sure to create unit tests for them too.
+end

data/templates/test/app_test.rb

@@ -0,0 +1,11 @@
+require 'test_helper'
+
+require '<%= @name %>'
+
+class <%= @class_name %>Test < Minitest::Test
+
+  def test_it_does_something_useful
+    assert false
+  end
+
+end

data/templates/test/test_helper.rb

@@ -0,0 +1,9 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+# Your tests should require this file which sets up the test harness.
+require 'minitest/autorun'
+require 'minitest/reporters'
+
+reporter_options = { color: true }
+Minitest::Reporters.use! [Minitest::Reporters::DefaultReporter.new(reporter_options)]