mu-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8f0ec48050129702f841631856f087e9ed43a400
+  data.tar.gz: 3d8d6b2b0203ca56f1a1e1595841d3bb115a9467
+SHA512:
+  metadata.gz: 17064e9306c060115a9f0868073aefba580fcc7fb3e52101c82e0895b358670dee8292653eb28628dd229d169f6b2339ed1bdb847137e585a0ce0010d5333af3
+  data.tar.gz: e1fff4414f7edf36b71da219d39c99d64d60779c9899fd6d392d8adf99cf3879a9f3e096d5125cee1e01cfe1fd9317c06ce3d5840a1621c295d0dd6b817238cf

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,31 @@
+AllCops:
+  Exclude:
+    - 'tmp/**/*'
+    - 'vendor/**/*'
+    - 'bin/**/*'
+    - 'log/**/*'
+    - 'lib/mu/logger/version.rb'
+    - '*.gemspec'
+
+#Metrics/ClassLength:
+#  Max: 110
+#
+Metrics/AbcSize:
+  Max: 20
+
+Metrics/LineLength:
+  Max: 130
+Metrics/MethodLength:
+  Max: 30
+
+#Metrics/ModuleLength:
+#  Max: 300
+#
+#Metrics/CyclomaticComplexity:
+#  Max: 15
+#
+#Metrics/PerceivedComplexity:
+#  Max: 15
+#
+Documentation:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mu.gemspec
+gemspec

data/README.md

@@ -0,0 +1,104 @@
+# Mu (µ)
+
+Welcome to the Ruby edition of ___Microservices Unbound___!
+
+This gem serves as the base component for building Ruby microservices. It will eventually provide a full
+complement of straightforward and easy to use APIs that will serve as a "running start" for building a distributed
+service-oriented architecture of small services.
+
+## Features
+
+From experience, I have discovered that there is a small but essential set of behaviors that microservices must
+implement for this architecture to succeed. The fundamental reason for this is that increasing the number of moving
+parts in a system does, by its very definition, increase complexity. This complexity is manageable, but only if steps
+are taken to insure that all services can be viewed, scaled, monitored and maintained in a similar fashion.
+
+### Logging
+
+Provide a simple, easy-to-understand API that will:
+
+  * Capture key-value sets for all log events rather than simple strings
+  * Uniformly include discriminating attributes in all events (service name, host, instance)
+  * Provide easy to read formatting for local use by developers
+  * Provide formatting as JSON for subsequent filtering, processing, and/or indexing by a log aggregator
+  * Cross-service session identification
+
+### Configuration
+
+  * Make it easy to specify configuration across a multiple dimensions: service, environment, local overrides.
+  * Log all configuration data when a service starts up
+
+### Inter-Service Communication
+
+  * Simple data marshalling
+  * Synchronous Communication via REST utilizing JSON API
+    * REST-ful endpoint implementation skeletons
+    * Middleware to handle logging and security
+    * REST client abstraction for JSON API compliant services (e.g. other Mu-enabled services)
+    * Generic HTTP client abstraction for external and other non-standard REST APIs
+  * Asynchronous Communication via AMQP
+    * Broadcast (event bus)
+    * Service-to-Service (psuedo-synchronous messaging)
+    * Backchannel (control bus)
+
+### Authentication / Authorization
+
+  * Authenticate all incoming requests
+  * Provide role-based authorization requirements by endpoint
+  * Pass credentials of incoming requests on with subsequent requests
+
+### Storage
+
+  * RDBMS
+  * Key-Value Stores (e.g. Riak, Redis)
+  * File/Bulk Storage (e.g. S3)
+
+## Additional Components
+
+The converse of these simple APIs for services is to provide components that enable these capabilities across a
+ distributed system. For example, a good logging API needs a centralized log aggregator. Here are some of the
+ infrastructure components that I have in mind to provide as starting points:
+
+  * Log Aggregator: Elasticsearch/Logstash/Kibana (ELK stack)
+  * Basic admin/monitoring service
+    * Serves as an example implementation service using the mu-ruby gem.
+    * Monitors service availability using the AMQP backchannel
+    * Provides visibility of the configuration in use for any given service
+  * Sample deployment template for AWS using Terraform and Ansible
+  * Sample single-machine development environment using Docker
+  * Sample cross-service integration tests using Cucumber
+
+
+
+
+## Installation
+
+**None of this is valid yet, this gem has not been pushed to Rubygems.**
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mu'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mu
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/goneflyin/mu-ruby.

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mu"
+
+# 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

data/bin/setup

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

data/lib/mu/logger.rb

@@ -0,0 +1,114 @@
+require 'json'
+require 'logger'
+require 'socket'
+require 'mu/logging/colored_log_formatter'
+require 'mu/logging/json_log_formatter'
+
+VALID_RUBY_CONST = /\A[A-Z][a-zA-Z_]*\Z/
+
+module Mu
+  class Logger
+    LEVELS = %w(debug info warn error fatal).freeze
+
+    LEVELS.each do |method|
+      define_method(method.to_sym) do |event, data = {}, &block|
+        log_event(method.to_sym, event, data, &block)
+      end
+    end
+
+    def initialize(*args)
+      @logger = create_logger(args)
+
+      @logger.formatter =
+        if ['colored'].include?(ENV['LOG_FORMAT'])
+        then Mu::Logging::Formatting.colored_format
+        else Mu::Logging::Formatting.json_format
+        end
+
+      self.level = LEVELS.index(ENV['LOG_LEVEL']) || ::Logger::INFO
+    end
+
+    def for_event(event)
+      RubyCompatibleLogger.new(event, @logger)
+    end
+
+    private
+
+    def create_logger(args)
+      return ::Logger.new(STDOUT)                    if args.empty? # Default to STDOUT
+      return args[0]                                 if logger?(args[0])
+      return ::Logger.new(Kernel.const_get(args[0])) if const_io_stream?(args[0])
+
+      ::Logger.new(*args)
+    end
+
+    def logger?(logger_param)
+      # Allow use of pre-existing Logger
+      logger_param.is_a?(::Logger)
+    end
+
+    # Allow STDOUT or STDERR to be explicitly specified
+    def const_io_stream?(logger_param)
+      logger_param.is_a?(String) &&
+        logger_param =~ VALID_RUBY_CONST &&
+        Kernel.const_defined?(logger_param)
+    end
+
+    def log_event(method, event, data = {})
+      extra = { 'event' => event }
+      data.is_a?(Hash) ? extra.merge!(data) : extra['message'] = data
+
+      if block_given?
+        t0 = now
+        begin
+          yield(extra)
+        rescue Exception => e
+          extra['exception'] = [e.class.name, e.message]
+          raise
+        ensure
+          extra['duration'] = (now - t0)
+          @logger.send(method, prefix_and_flatten_hash(extra))
+        end
+      else
+        @logger.send(method, prefix_and_flatten_hash(extra))
+      end
+    end
+
+    def method_missing(meth, *args, &block)
+      @logger.send(meth, *args, &block)
+    end
+
+    def now
+      Time.now.to_f * 1000
+    end
+
+    MAX_NESTED_LEVELS = 7
+
+    def prefix_and_flatten_hash(hash, prefix = '', level = 1)
+      if level > MAX_NESTED_LEVELS
+        return { "#{prefix}TRUNCATED" => "data nested deeper than #{MAX_NESTED_LEVELS} levels has been truncated" }
+      end
+
+      hash.inject({}) do |ret, (k, v)|
+        key = prefix + k.to_s
+        if v && v.is_a?(Hash)
+        then ret.merge(prefix_and_flatten_hash(v, key + '.', level + 1))
+        else ret.merge(key => v)
+        end
+      end
+    end
+
+    class RubyCompatibleLogger < Mu::Logger
+      LEVELS.each do |method|
+        define_method(method.to_sym) do |data = {}, &block|
+          log_event(method.to_sym, @event, data, &block)
+        end
+      end
+
+      def initialize(event, logger)
+        @event = event
+        super logger
+      end
+    end
+  end
+end

data/lib/mu/logging/colored_log_formatter.rb

@@ -0,0 +1,26 @@
+module Mu
+  module Logging
+    module Formatting
+      def self.colored_format
+        ColoredLogFormatter.method(:format_log)
+      end
+    end
+
+    class ColoredLogFormatter
+      def self.format_log(_severity, datetime, _progname, data)
+        event    = data.delete('event')    || data.delete(:event)
+        duration = data.delete('duration') || data.delete(:duration)
+        sql      = data.delete('sql')      || data.delete(:sql)
+
+        str = [
+          "\e[35m[#{datetime.strftime('%T.%L')}]\e[0m",                 # magenta
+          "\e[32m#{event}\e[0m",                                        # green
+          data.map { |k, v| ["\e[34m#{k}\e[0m", v].join('=') }.join(' ') # blue=white
+        ].join(' ')
+        str << " \e[31m(#{duration.to_f.round(2)}ms)\e[0m" if duration # red
+        str << "\n" << sql if sql
+        str << "\n"
+      end
+    end
+  end
+end

data/lib/mu/logging/json_log_formatter.rb

@@ -0,0 +1,26 @@
+module Mu
+  module Logging
+    module Formatting
+      def self.json_format
+        JsonLogFormatter.method(:format_log)
+      end
+    end
+
+    class JsonLogFormatter
+      def self.format_log(_severity, datetime, _progname, data)
+        json = {
+          '@timestamp' => datetime.iso8601(3),
+          app: Mu.app,
+          environment: Mu.env,
+          host: hostname,
+          event: data.delete('event') || data.delete(:event)
+        }.merge(data)
+        JSON.generate(json) + "\n"
+      end
+
+      def self.hostname
+        @hostname ||= Socket.gethostname
+      end
+    end
+  end
+end

data/lib/mu/logging/ruby_compatible_logger.rb

@@ -0,0 +1,17 @@
+require 'mu/logger'
+
+module Mu
+  module Logging
+    class RubyCompatibleLogger < Mu::Logger
+      LEVELS.each do |method|
+        define_method(method.to_sym) do |data = {}, &block|
+          log_event(method.to_sym, @event, data, &block)
+        end
+      end
+      def initialize(event, logger)
+        @event = event
+        super logger
+      end
+    end
+  end
+end

data/lib/mu/version.rb

@@ -0,0 +1,3 @@
+module Mu
+  VERSION = '0.1.0'.freeze
+end

data/lib/mu.rb

@@ -0,0 +1,48 @@
+require 'mu/version'
+require 'mu/logger'
+require 'dotenv'
+
+module Mu
+  def self.app
+    @_app ||= 'application'
+  end
+
+  def self.app=(application_name)
+    @_app = application_name
+  end
+
+  def self.env
+    @_env ||= ENV['RACK_ENV'] || 'development'
+  end
+
+  def self.env=(environment)
+    @_env = environment
+  end
+
+  def self.logger
+    @_logger ||= Mu::Logger.new(STDOUT)
+  end
+
+  def self.logger=(logger)
+    @_logger = logger
+  end
+
+  def self.report_error(_e)
+    # TODO: Add call to abstraction for reporting service
+    raise NotImplementedError, 'Abstraction for reporting errors not yet implemented.'
+  end
+
+  def self.report_error!(_e)
+    # TODO: Add call to abstraction for reporting service
+    raise NotImplementedError, 'Abstraction for reporting errors not yet implemented.'
+  end
+
+  def self.init(app = nil)
+    self.app = app if app
+
+    # Dotenv gives precedence to files loaded earlier in the list
+    Dotenv.load("#{Mu.env}.env", '.env')
+  end
+end
+
+MU = Mu unless defined?(MU)

data/mu-ruby.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mu/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'mu-ruby'
+  spec.version       = Mu::VERSION
+  spec.authors       = ['Scott Pfister']
+  spec.email         = ['scott.pfister@gmail.com']
+
+  spec.summary       = 'A library that provides simple, generic behavior that greatly increase success with µ-services.'
+  spec.description   = 'A library that provides simple, generic behavior that greatly increase success with µ-services.'
+  spec.homepage      = 'http://github.com/goneflyin/mu-ruby'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'dotenv', '~> 2.1', '>= 2.1.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.5', '>= 3.5.0'
+  spec.add_development_dependency 'rubocop', '~> 0.43', '>= 0.43.0'
+  spec.add_development_dependency 'pry', '~> 0.10', '>= 0.10.4'
+  spec.add_development_dependency 'pry-nav', '~> 0.2', '>= 0.2.4'
+end

metadata

@@ -0,0 +1,192 @@
+--- !ruby/object:Gem::Specification
+name: mu-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Scott Pfister
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.43'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.43.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.43'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.43.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+description: A library that provides simple, generic behavior that greatly increase
+  success with µ-services.
+email:
+- scott.pfister@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/mu.rb
+- lib/mu/logger.rb
+- lib/mu/logging/colored_log_formatter.rb
+- lib/mu/logging/json_log_formatter.rb
+- lib/mu/logging/ruby_compatible_logger.rb
+- lib/mu/version.rb
+- mu-ruby.gemspec
+homepage: http://github.com/goneflyin/mu-ruby
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A library that provides simple, generic behavior that greatly increase success
+  with µ-services.
+test_files: []