rails-service 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2110edea5108743293e9c6e159508122699f94c5
+  data.tar.gz: 2b018c9fe11832e3b44388f15f734db36f6fe5b4
+SHA512:
+  metadata.gz: 1a22e7839a01fd32021f6a3d6d15e6f447bf9413330ba67abbeae61084b95d3a75caf64ea7718a368c1edfd3168454fc5fd8bc4f86051a61317dbbea18da81b7
+  data.tar.gz: b5f1931efc7f5118bc4021b49377701d7389564fbf6cfaf8d4839a4ccd06c7c4d1e633dc249beca4354b0010a590924eeadeb0676954a7d1180943cdb9b63a52

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,99 @@
+AllCops:
+  RunRailsCops: true
+  Exclude:
+    - 'bin/**/*'
+    - '*.gemspec'
+
+Lint/EndAlignment:
+  AlignWith: variable
+
+Lint/Loop:
+  Enabled: false
+
+Metrics/BlockNesting:
+  Max: 4
+
+Metrics/ClassLength:
+  Max: 1045
+
+Metrics/MethodLength:
+  Max: 418
+
+# We'd like to get this down to 120. But we have to start somewhere.
+Metrics/LineLength:
+  Max: 300
+
+Metrics/AbcSize:
+  Max: 40
+
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+Metrics/PerceivedComplexity:
+  Max: 10
+
+Rails/ActionFilter:
+  EnforcedStyle: filter
+
+Style/CaseIndentation:
+  IndentWhenRelativeTo: end
+
+Style/CollectionMethods:
+  PreferredMethods:
+    find: detect
+
+Style/DotPosition:
+  EnforcedStyle: trailing
+
+Style/EmptyLineBetweenDefs:
+  AllowAdjacentOneLineDefs: true
+
+Style/Encoding:
+  EnforcedStyle: when_needed
+
+Style/HashSyntax:
+  EnforcedStyle: ruby19
+
+Style/IndentHash:
+  EnforcedStyle: consistent
+
+Style/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Style/Semicolon:
+  AllowAsExpressionSeparator: true
+
+Style/TrailingComma:
+  EnforcedStyleForMultiline: comma
+
+Style/TrivialAccessors:
+  AllowDSLWriters: true
+  AllowPredicates: true
+  ExactNameMatch: true
+
+Documentation:
+  Enabled: false
+
+Style/SignalException:
+  EnforcedStyle: only_raise
+
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Style/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Style/FirstParameterIndentation:
+  EnforcedStyle: consistent
+
+Style/TrailingUnderscoreVariable:
+  Enabled: false
+
+Style/ParallelAssignment:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Style/AccessorMethodName:
+  Enabled: false

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'pry'
+
+group :test do
+  gem 'rspec'
+  gem 'rspec-rails'
+  gem 'sqlite3'
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Łukasz Strzałkowski
+
+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,71 @@
+# Microservices on Rails
+
+Rails::Service is an opinioned Rails Engine providing boiler plate needed for
+making microservice  Rails application.
+
+## Note on Microservices
+
+Microservices architecture is a great way to build and scale huge distributed
+applications. It implies though that it's not for everybody and you're probably better
+off sticking with your monolith and considering microservices in the future when
+the need arise or even maybe never if you'll lucky.
+
+Microservices are not for everybody, they're hard and infact thery're not a good
+solution for everybody.
+
+Before choosing and investing in microservices architecture, I advise you to
+strongly considering it from every angle.
+
+Recommended reads/videos:
+
+  * [Microservices](http://martinfowler.com/articles/microservices.html) by Martin Fowler
+  * [RailsConf 2015 Keynote](https://www.youtube.com/watch?v=KJVTM7mE1Cc) by David Heinemeier Hansson (video)
+  * [Ruby On Ales 2015 - The Recipe for the Worlds Largest Rails Monolith](https://www.youtube.com/watch?v=naTRzjHaIhE) by Akira Matsuda (video)
+
+## Rails::Service Overview
+
+If you choose to go with microservice architecture or you're already working on such application(s)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails-service'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rails-service
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Todo
+
+  * Rake task to generate Rails::Service skeleton (app-manifest.yaml, app-config.yaml etc.)
+  * Docs
+  * Add app-manifest page to admin panel
+  * Add logging everywhere
+  * KV Logger
+  * GRPC
+  * Endpoint ACL (Guard Dog)
+  * Exception notification abstraction
+  * on_fork hooks abstraction
+  * exceptions_app for engines (not sure if it's possible to have one)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` 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/strzalek/rails-service.

data/Rakefile

@@ -0,0 +1,16 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+desc 'Run Rails::Service unit tests.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+  t.warning = false
+end

data/app/controller/rails/service/admin_controller.rb

@@ -0,0 +1,32 @@
+# TODO: Should this support JSON format too?
+class Rails::Service::AdminController < Rails::Service::BaseController # rubocop:disable Style/ClassAndModuleChildren
+  if Rails::Service.config.admin_action_modules.present?
+    Rails::Service.config.admin_action_modules.each do |mod|
+      prepend mod
+    end
+  end
+
+  layout 'admin'
+
+  append_view_path Rails::Service.config.admin_view_resolvers
+
+  before_filter do
+    @service_context ||= Rails::Service.context
+  end
+
+  def environment
+    @env = ENV.sort
+  end
+
+  def routing; end
+
+  def rails_properties; end
+
+  def manifest
+    @manifest = Rails::Service.manifest
+  end
+
+  def config
+    @config = Rails::Service.app_config
+  end
+end

data/app/controller/rails/service/base_controller.rb

@@ -0,0 +1,3 @@
+class Rails::Service::BaseController < ActionController::Base # rubocop:disable Style/ClassAndModuleChildren
+  protect_from_forgery with: :exception
+end

data/app/controller/rails/service/status_controller.rb

@@ -0,0 +1,44 @@
+class Rails::Service::StatusController < Rails::Service::BaseController # rubocop:disable Style/ClassAndModuleChildren
+  if Rails::Service.config.status_action_modules.present?
+    Rails::Service.config.status_action_modules.each do |mod|
+      prepend mod
+    end
+  end
+
+  def index
+    render_status :ok, time: Time.current
+  end
+
+  SELECT_ONE = 'SELECT 1'.freeze
+
+  def db
+    begin
+      sql_result = nil
+      status = :ok
+      time = Benchmark.realtime { sql_result = ActiveRecord::Base.connection.execute(SELECT_ONE).first }
+
+      time = (time * 1_000).round(4)
+    rescue
+      status = :critical
+    end
+
+    render_status status, time: time
+  end
+
+  protected
+
+  STATUS_TYPES = [:ok, :warning, :critical].freeze
+
+  def render_status(status, params = {})
+    raise ArgumentError unless STATUS_TYPES.include?(status)
+
+    status_hash = {
+      status: status,
+    }.merge(params)
+
+    http_status = status == :critical ? :service_unavailable : :ok
+    response.headers['Server-Status'] = status.to_s.capitalize
+
+    render status: http_status, json: status_hash
+  end
+end

data/app/helpers/rails/service/admin_helper.rb

@@ -0,0 +1,27 @@
+module Rails
+  module Service
+    module AdminHelper
+      def render_sidebar
+        li = []
+        Rails::Service::AdminController.action_methods.sort.each do |method|
+          text = method.split('_').map(&:capitalize).join(' ')
+          li << content_tag(:li, link_to(text, admin_path(action: method)).html_safe)
+        end
+        content_tag(:ul, li.join.html_safe, class: 'nav nav-stacked')
+      end
+
+      def render_rails_iframe(opts = {})
+        attrs = {
+          name: opts.fetch(:name),
+          id: opts.fetch(:name),
+          src: opts.fetch(:src),
+          frameborder: '0',
+          scrolling: 'no',
+          onload: 'javascript:resizeIframe(this);',
+        }
+
+        content_tag(:iframe, nil, attrs)
+      end
+    end
+  end
+end

data/app/views/layouts/admin.html

@@ -0,0 +1,100 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Services</title>
+  <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.5/css/bootstrap.min.css">
+  <%= csrf_meta_tags %>
+  <style>
+    body {
+      margin: 0;
+      padding: 0;
+    }
+
+    iframe {
+      overflow: auto;
+      border: 0;
+      width: 100%;
+      height: 100%;
+    }
+
+    .wrapper {
+      display: block;
+      width: 80%;
+      margin: auto;
+      overflow: auto;
+    }
+
+    #top {
+      color: white;
+      margin-bottom: 10px;
+    }
+
+    #top h1 {
+      margin-left: 160px;
+    }
+
+    #top li span {
+      text-align: right;
+      display: block;
+      float: left;
+      color: #d6d6d6;
+      width: 150px;
+      margin-right: 10px;
+    }
+
+    .production #top {
+      background: #CA0000; // red
+    }
+
+    .staging #top {
+      background: #518e16; // green
+    }
+
+    .development #top {
+      background: #006EFF; // blue
+    }
+
+    #sidebar {
+      width: 15%;
+      float: left;
+    }
+
+    #content {
+      float: left;
+      width: 85%;
+      padding-left: 10px;
+    }
+  </style>
+  <script language="javascript" type="text/javascript">
+    function resizeIframe(obj) {
+      obj.style.height = obj.contentWindow.document.body.scrollHeight + 'px';
+    }
+  </script>
+</head>
+<body class="<%= Rails.env %>">
+  <div id="top">
+    <div class="wrapper">
+      <h1><%= @service_context.app %></h1>
+      <ul class="list-unstyled">
+        <li><span>Datacenter</span> <%= @service_context.dc %></li>
+        <li><span>Host</span> <%= @service_context.host %></li>
+        <li><span>Environment</span> <%= @service_context.env %></li>
+        <li><span>PID</span> <%= @service_context.pid %></li>
+        <li><span>Revision</span> <%= @service_context.rev %></li>
+      </ul>
+    </div>
+  </div>
+
+  <div id="page">
+    <div class="wrapper">
+      <div id="sidebar">
+        <%= render_sidebar %>
+      </div>
+
+      <div id="content">
+        <%= yield %>
+      </div>
+    </div>
+  </div>
+</body>
+</html>