micro_common 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3a057f7feca71df1af402ee3ade5e03fa4dd6ee13461809684bb52de765df0b0
+  data.tar.gz: cf5ede4234377b19b553764ff1a10bbfc4ef8b44d5faffced9e1e6434244e0e4
+SHA512:
+  metadata.gz: 62f407bbb7debe5d82b815df9ab353343459c265eb9e71a7b03e47ab1aede693a857ef38a1cfc4dc4ffab3517e70229e81c5c02fc8bbe7b2e11612db9c62c56f
+  data.tar.gz: 95c9bf3e58efa893afb11f2503e739ad463ab59173154fb24294e7435b53f63557d9246184fd4d1aaae0225deec4a5cd0185ce56cda6769caf62602ff2acce44

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,10 @@
+AllCops:
+  Exclude:
+    - bin/**/*
+    - db/**/*
+
+Metrics/LineLength:
+  Max: 120
+
+Style/Documentation:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 1.16.6

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in micro_common.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Francesco Boffa
+
+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 @@
+# MicroCommon

data/Rakefile

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

data/lib/micro_common.rb

@@ -0,0 +1,33 @@
+require 'ougai'
+require 'lograge'
+
+require 'micro_common/meta_middleware'
+require 'micro_common/store_request_id'
+
+require 'micro_common/version'
+
+module MicroCommon
+  class Railtie < Rails::Railtie
+    initializer 'add_middlewares' do |app|
+      app.middleware.insert_after Rails::Rack::Logger, MicroCommon::MetaMiddleware
+      app.middleware.insert_before ActionDispatch::RemoteIp, MicroCommon::StoreRequestId
+    end
+
+    config.logger = Ougai::Logger.new(STDOUT)
+    config.logger.formatter = Ougai::Formatters::Readable.new if ENV['SIMPLE_LOGS']
+    config.logger.before_log = lambda do |data|
+      data[:request_id] = RequestStore.store[:request_id]
+    end
+
+    config.lograge.enabled = true
+    config.lograge.base_controller_class = 'ActionController::API'
+    config.lograge.formatter = Class.new do |fmt|
+      def fmt.call(data)
+        data
+      end
+    end
+
+    Rails.logger = config.logger
+    ActiveRecord::Base.logger = config.logger
+  end
+end

data/lib/micro_common/meta_middleware.rb

@@ -0,0 +1,49 @@
+module MicroCommon
+  class MetaMiddleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      uri = env['PATH_INFO']
+
+      if uri == '/meta/about'
+        about
+      elsif uri == '/meta/ping'
+        ping
+      elsif uri == '/meta/status'
+        status
+      else
+        @app.call(env)
+      end
+    end
+
+    def about
+      response = JSON.pretty_generate(YAML.safe_load(File.read(Rails.root.join('config', 'about.yaml'))))
+      [200, { 'Content-Type' => 'application/json' }, [response]]
+    end
+
+    def ping
+      [200, {}, ['PONG']]
+    end
+
+    def status
+      checks = run_checks
+      status = checks.all? { |_, v| v } ? 200 : 503
+      [status, { 'Content-Type' => 'application/json' }, [checks.to_json]]
+    end
+
+    def run_checks
+      {
+        database: check_database
+      }
+    end
+
+    def check_database
+      ActiveRecord::Base.connection.execute('SELECT 1')
+      true
+    rescue PG::Error, PG::ConnectionBad, ActiveRecord::NoDatabaseError
+      false
+    end
+  end
+end

data/lib/micro_common/store_request_id.rb

@@ -0,0 +1,12 @@
+module MicroCommon
+  class StoreRequestId
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      RequestStore.store[:request_id] = env['action_dispatch.request_id']
+      @app.call(env)
+    end
+  end
+end

data/lib/micro_common/version.rb

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

data/micro_common.gemspec

@@ -0,0 +1,33 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'micro_common/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'micro_common'
+  spec.version       = MicroCommon::VERSION
+  spec.authors       = ['Francesco Boffa']
+  spec.email         = ['fra.boffa@gmail.com']
+
+  spec.summary       = 'Microservice common utilities'
+  spec.description   = 'Microservice common utilities'
+  spec.homepage      = 'https://github.com'
+  spec.license       = 'MIT'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'awesome_print'
+  spec.add_dependency 'ougai'
+  spec.add_dependency 'lograge'
+  spec.add_dependency 'request_store'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: micro_common
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Francesco Boffa
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ougai
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: lograge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: request_store
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Microservice common utilities
+email:
+- fra.boffa@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/micro_common.rb
+- lib/micro_common/meta_middleware.rb
+- lib/micro_common/store_request_id.rb
+- lib/micro_common/version.rb
+- micro_common.gemspec
+homepage: https://github.com
+licenses:
+- MIT
+metadata: {}
+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.7.8
+signing_key: 
+specification_version: 4
+summary: Microservice common utilities
+test_files: []