rails-service 0.1.0

data/app/views/rails/service/admin/config.html.erb

@@ -0,0 +1,3 @@
+<h2>App Config</h2>
+
+<pre><%= JSON.pretty_generate(@config.to_h) %></pre>

data/app/views/rails/service/admin/environment.html.erb

@@ -0,0 +1,16 @@
+<table class="table table-bordered">
+  <thead>
+    <tr>
+      <th>Key</th>
+      <th>Value</th>
+    </tr>
+  </thead>
+  <tbody>
+    <% @env.each do |key, value| %>
+      <tr>
+        <td class="key"><%= key %></td>
+        <td class="value"><%= value %></td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>

data/app/views/rails/service/admin/manifest.html.erb

@@ -0,0 +1 @@
+<pre><%= JSON.pretty_generate(@manifest.to_h) %></pre>

data/app/views/rails/service/admin/rails_properties.html.erb

@@ -0,0 +1 @@
+<%= render_rails_iframe(name: "rails-properties", src: "/rails/info/properties") %>

data/app/views/rails/service/admin/routing.html.erb

@@ -0,0 +1 @@
+<%= render_rails_iframe(name: "rails-routes", src: "/rails/info/routes") %>

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rails/all"
+require "rails/service"
+
+require "pry"
+Pry.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/config/routes.rb

@@ -0,0 +1,9 @@
+Rails::Service::Engine.routes.draw do
+  constraints Rails::Service.config.status_routes_constraint do
+    get '/_status(/:action)', to: 'status#index', as: :status
+  end
+
+  constraints Rails::Service.config.admin_routes_constraint do
+    match '/_admin(/:action)', to: 'admin#environment', via: [:get, :post], as: :admin
+  end
+end

data/lib/rails/service.rb

@@ -0,0 +1,29 @@
+require 'rails/service/version'
+require 'rails/service/config'
+require 'rails/service/context'
+require 'rails/service/manifest'
+require 'rails/service/app_config'
+
+module Rails
+  module Service
+    module_function
+
+    def config
+      @config ||= Config.new
+    end
+
+    def context
+      @context ||= Context.new(config._for_context)
+    end
+
+    def manifest
+      @manifest ||= Manifest.new(config._for_manifest)
+    end
+
+    def app_config
+      @app_config ||= AppConfig.new(config._for_app_config)
+    end
+  end
+end
+
+require 'rails/service/engine'

data/lib/rails/service/admin_view_resolver.rb

@@ -0,0 +1,18 @@
+require 'action_view/template/resolver'
+
+module Rails
+  module Service
+    # AdminViewResolver is a custom ActionView resolver which
+    # removes the prefix normally added to path when resolvin templates.
+    # Without it, we can set arbitraty view path for Rails::Service Admin controller
+    class AdminViewResolver < ::ActionView::FileSystemResolver
+      def initialize(path)
+        super(Rails.root.join(path))
+      end
+
+      def find_templates(name, _prefix, partial, details)
+        super(name, '', partial, details)
+      end
+    end
+  end
+end

data/lib/rails/service/app_config.rb

@@ -0,0 +1,28 @@
+require 'yaml'
+require 'erb'
+
+require 'rails/service/core_ext/deep_struct'
+
+module Rails
+  module Service
+    module AppConfig
+      module_function
+
+      def new(options = {})
+        path = options.fetch(:path)
+        logger = options.fetch(:logger)
+        env = options.fetch(:env)
+
+        path = Rails.root.join(path)
+        if File.exist?(path)
+          file = File.read(path)
+          logger.info("loading app config file: #{path}")
+          DeepStruct.new(YAML.load(ERB.new(file).result)[env.to_s])
+        else
+          logger.warn("app config file not found: #{path}")
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/rails/service/boot.rb

@@ -0,0 +1,23 @@
+module Rails
+  module Service
+    module Boot
+      module_function
+
+      STATUS_CONTROLLER = 'Rails::Service::StatusController'.freeze
+
+      def lograge(app)
+        return unless defined?(Lograge) && !app.config.lograge.enable
+
+        app.config.lograge.ignore_custom = lambda  { |event|
+          !app.config.service.status_logs_enabled && event.payload[:controller] == STATUS_CONTROLLER
+        }
+
+        app.config.lograge.custom_options = lambda  { |_event|
+          { dc: app.config.service.dc, host: app.config.service.host, app: app.config.service.app }
+        }
+
+        Lograge.setup(app)
+      end
+    end
+  end
+end

data/lib/rails/service/config.rb

@@ -0,0 +1,128 @@
+require 'socket'
+
+module Rails
+  module Service
+    class Config
+      attr_writer :app, :dc, :host
+
+      attr_accessor :process_id
+
+      attr_writer :status_routes_contraint, :admin_routes_contraint,
+        :admin_view_paths, :status_action_modules, :admin_action_modules,
+        :status_logs_enabled, :manifest_path, :logger, :env, :app_config_path
+
+      def app
+        @app ||= begin
+          if Rails::Service.manifest.respond_to?(:app)
+            Rails::Service.manifest.app
+          else
+            Rails.application.class.parent_name.downcase
+          end
+        end
+      end
+
+      def dc
+        @dc ||= (ENV.key?('DATACENTER') ? ENV.fetch('DATACENTER') : 'local').downcase
+      end
+
+      def host
+        @host ||= Socket.gethostname
+      end
+
+      def process_id
+        @process_id ||= -> (app, dc, host, pid, _rev) { "#{app}:#{dc}:#{host}:#{pid}:#{SecureRandom.uuid}".freeze }
+      end
+
+      def pid
+        @pid ||= Process.pid
+      end
+
+      def rev
+        @rev ||= File.exist?('REVISION') ? File.read('REVISION') : '(none)'
+      end
+
+      def env
+        @env ||= Rails.env
+      end
+
+      def logger
+        @logger ||= Rails.logger
+      end
+
+      def manifest_path
+        @manifest_path ||= Rails.root.join('app-manifest.yaml')
+      end
+
+      def app_config_path
+        @app_conifg_path ||= Rails.root.join('config/app-config.yaml')
+      end
+
+      def status_logs_enabled
+        @status_logs_enabled ||= false
+      end
+
+      def status_routes_constraint
+        @status_routes_constraint ||= -> (_request) { true }
+      end
+
+      def admin_routes_constraint
+        @admin_routes_constraint ||= -> (request) { request.local? }
+      end
+
+      def admin_action_modules
+        @admin_action_modules ||= [_default_action_module(:admin)]
+      end
+
+      def status_action_modules
+        @status_action_modules ||= [_default_action_module(:status)]
+      end
+
+      def admin_view_paths
+        @admin_view_paths ||= ['lib/service/admin/views']
+      end
+
+      def admin_view_resolvers
+        admin_view_paths.map { |admin_view_path| Rails::Service::AdminViewResolver.new(admin_view_path) }
+      end
+
+      def _for_context
+        {
+          app: app,
+          dc: dc,
+          host: host,
+          env: env,
+          pid: pid,
+          rev: rev,
+          process_id: process_id.call(app, dc, host, pid, rev),
+          logger: logger,
+        }
+      end
+
+      def _for_manifest
+        {
+          path: manifest_path,
+          logger: logger,
+        }
+      end
+
+      def _for_app_config
+        {
+          path: app_config_path,
+          logger: logger,
+          env: env,
+        }
+      end
+
+      private
+
+      def _default_action_module(resource)
+        filename = "service/#{resource}/actions"
+        return unless File.exist?(Rails.root.join("lib/#{filename}.rb"))
+
+        require filename
+        mod = "#{Rails.application.class.parent_name}::Service::#{resource.to_s.capitalize}::Actions"
+        mod.constantize if Kernel.const_defined?(mod)
+      end
+    end
+  end
+end

data/lib/rails/service/context.rb

@@ -0,0 +1,13 @@
+require 'ostruct'
+
+module Rails
+  module Service
+    # Context is an object which holds common configuration and informations
+    # about your service/applicaion that your service uses.
+    #
+    # It is very helpful when developing libraries that will be shared between
+    # your services.
+    class Context < OpenStruct
+    end
+  end
+end

data/lib/rails/service/core_ext/deep_struct.rb

@@ -0,0 +1,23 @@
+# Cribbed from http://andreapavoni.com/blog/2013/4/create-recursive-openstruct-from-a-ruby-hash/
+require 'ostruct'
+
+class DeepStruct < OpenStruct
+  def initialize(hash = nil)
+    @table = {}
+    @hash_table = {}
+
+    return unless hash
+
+    hash.each do |k, v|
+      k = k.to_s
+      @table[k.to_sym] = (v.is_a?(Hash) ? self.class.new(v) : v)
+      @hash_table[k] = v
+
+      new_ostruct_member(k)
+    end
+  end
+
+  def to_h
+    @hash_table
+  end
+end

data/lib/rails/service/engine.rb

@@ -0,0 +1,20 @@
+require 'rails/engine'
+require 'rails/service'
+require 'rails/service/context'
+require 'rails/service/boot'
+
+module Rails
+  module Service
+    class Engine < Rails::Engine
+      engine_name 'rails-service'
+      isolate_namespace Rails::Service
+
+      config.autoload_paths << File.expand_path('../../../', __FILE__)
+      config.service = Rails::Service.config
+
+      initializer 'rails.service.lograge' do |app|
+        Rails::Service::Boot.lograge(app)
+      end
+    end
+  end
+end

data/lib/rails/service/manifest.rb

@@ -0,0 +1,27 @@
+require 'yaml'
+require 'erb'
+
+require 'rails/service/core_ext/deep_struct'
+
+module Rails
+  module Service
+    module Manifest
+      module_function
+
+      def new(options = {})
+        path = options.fetch(:path)
+        logger = options.fetch(:logger)
+
+        path = Rails.root.join(path)
+        if File.exist?(path)
+          file = File.read(path)
+          logger.info("loading manifest file: #{path}")
+          DeepStruct.new(YAML.load(ERB.new(file).result))
+        else
+          logger.warn("manifest file not found: #{path}")
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/rails/service/version.rb

@@ -0,0 +1,5 @@
+module Rails
+  module Service
+    VERSION = '0.1.0'
+  end
+end

data/rails-service.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rails/service/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rails-service"
+  spec.version       = Rails::Service::VERSION
+  spec.authors       = ["Łukasz Strzałkowski"]
+  spec.email         = ["lukasz.strzalkowski@gmail.com"]
+
+  spec.summary       = %q{Microservices on Rails}
+
+  spec.files         = `git ls-files`.split("\n")
+  spec.test_files    = `git ls-files -- spec/*`.split("\n")
+
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 2.0.0'
+
+  spec.add_dependency "rails", ">= 3.2.6", "< 5"
+end

data/spec/controllers/admin_controller_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+RSpec.describe Rails::Service::AdminController, type: :controller do
+  routes { Rails::Service::Engine.routes }
+  render_views
+
+  it 'renders environment action' do
+    get :environment
+    expect(response).to have_http_status(:ok)
+    expect(response).to render_template(:environment)
+  end
+
+  it 'renders app manifest' do
+    get :manifest
+    expect(response).to have_http_status :ok
+    expect(response).to render_template 'manifest'
+    expect(assigns(:manifest)).to eq Rails::Service.manifest
+    expect(response.body).to include 'fooxample'
+  end
+
+  it 'renders app config' do
+    get :config
+    expect(response).to have_http_status :ok
+    expect(response).to render_template 'config'
+    expect(assigns(:config)).to eq Rails::Service.app_config
+    expect(response.body).to include 'foobar'
+    expect(response.body).to_not include 'foobar2'
+    expect(response.body).to include 'foobar-overwritten'
+    expect(response.body).to include 'barfoo'
+  end
+
+  describe 'custom resolvers' do
+    describe 'default' do
+      it 'renders custom action included from lib/service/admin/actions' do
+        get :foobar
+        expect(response).to have_http_status :ok
+        expect(response).to render_template 'foobar'
+        expect(assigns(:foo)).to eq 'test'
+        expect(response.body).to include 'OH HAI'
+      end
+    end
+
+    describe 'custom module at custom path (configured in application.rb)' do
+      it 'renders action from custom module' do
+        get :custom
+        expect(response).to have_http_status :ok
+        expect(response.body).to include 'custom action'
+      end
+    end
+  end
+end