team_fastlane-base_service 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 195fc359676df3324652ec431e1ca0ad5443816ab8009bb2068eb07d0dca78e9
+  data.tar.gz: c55fb78490e3e26f353ba669072b4227e7d87b96f24e5f38b4de572e5659cd82
+SHA512:
+  metadata.gz: '094b279ed57eda10e552dd02a2c0e7fd5978ee8a8184f8facd5a808c5658be58513e2158618bfcc49400e00374628dfc36aaab051af64d3b12668e057b9fe8f3'
+  data.tar.gz: 8c79dbfb2e36760f9a60f6d5dae5290caa7d4508255e4230ddae592c19a3f83832c254d8bcb1de5e75e2b6f64961e453638c8709f5d16d5c095b47ee6e3cbfc1

data/CHANGELOG.adoc

@@ -0,0 +1,64 @@
+= Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on https://keepachangelog.com[Keep a Changelog],
+and this project adheres to https://semver.org[Semantic Versioning].
+
+== Unreleased
+
+== [1.0.0] - 2023-08-01
+=== Changed
+Renamed and restructured for release on rubygems
+
+== [0.3.0] - 2023-06-20
+=== Added
+- New method for handling validation errors
+
+== [0.2.1] - 2022-10-13
+=== Changed
+- Health check uses the connection pool now instead of creating a new connection
+
+== [0.2.0] - 2022-06-03
+=== Added
+- Default behavior for parameter filtering
+
+== [0.1.1] - 2022-03-29
+=== Updated
+- olive_branch version updated to 4.0.1
+
+== [0.1.0]- 2022-01-03
+=== Removed
+- the rubymine debug mode fix seems to be no longer necessary
+
+== [0.0.7]- 2021-09-07
+=== Changed
+- Revert change of 0.0.6 and inherit from ActionController::Base again. It wasn't working correctly in our setup.
+
+== [0.0.6]- 2021-05-17
+=== Changed
+- Inherit from ApplicationController instead of ActionController::Base
+(link:https://docs.rubocop.org/rubocop-rails/cops_rails.html#railsapplicationcontroller[Rubocop]).
+
+== [0.0.5]- 2021-04-27
+=== Changed
+- Updated olive_branch dependency to v4.0.0.
+
+== [0.0.4] - 2020-01-13
+=== Added
+- Save from ArgumentError with `unprocessable_entity` method.
+
+== [0.0.3] - 2020-07-22
+=== Added
+- Added response method `no_content`.
+
+=== Changed
+- Use json instead of raw text body for error responses `not_found` and `unprocessable_entity`.
+
+== [0.0.2] - 2020-07-21
+=== Added
+- Added response methods `created` and `unprocessable_entity`.
+
+== [0.0.1] - 2020-06-16
+=== Added
+- Initial gem version with the extracted api controllers and health check.

data/README.adoc

@@ -0,0 +1,39 @@
+= Team Fastlane Base Service
+
+A service base for a ruby micro service
+
+== Installation
+
+As described by the link:../README.adoc[main readme].
+
+== Usage
+
+=== Health Check
+
+You can use the link:../bin/health_check[health_check] executable to provide a method of checking the health of the server (database included).
+For example within a docker file like this:
+
+[source, Dockerfile]
+----
+HEALTHCHECK --interval=30s --timeout=30s --start-period=30s --retries=3 CMD [ "bundle", "exec", "health_check" ]
+----
+
+This makes use of an exposed endpoint called `/health_check`, which you can only use for a custom ping to check for it.
+
+=== Performance Logging
+
+There is an easy to use performance logging (please only use in development) included. Simply add `with_measure` around the block you want to measure.
+
+The result will be added to the rails time stamp log output.
+
+=== Default responses
+
+This also provides some default json responses to be used in your controller. See link:./app/controllers/concerns/responses.rb[responses.rb] for more details.
+
+To use these responses let your `ApplicationController` inherit from `ApiBaseController` and you are set.
+
+=== Parameter handling
+
+You get automatically camelCase to snake_case transformation for the request and the reverse for responses via the olive_branch gem.
+
+There will be a default parameter filtering enabled. It filters passwords of various key names in development and everything in production.

data/app/controllers/api_base_controller.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class ApiBaseController < ActionController::Base
+  include PerformanceLogging
+  include Responses
+
+  rescue_from ArgumentError, with: :unprocessable_entity
+  rescue_from StandardError, with: :technical_error
+end

data/app/controllers/concerns/performance_logging.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module PerformanceLogging
+  extend ActiveSupport::Concern
+
+  attr_internal :runtimes
+
+  protected
+
+  def with_measure(key)
+    result = nil
+    self.runtimes ||= {}
+    runtimes[key] = Benchmark.ms { result = yield }
+    result
+  end
+end

data/app/controllers/concerns/responses.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Responses
+  extend ActiveSupport::Concern
+
+  protected
+
+  def bad_request(errors = {})
+    render json: errors, status: :bad_request
+  end
+
+  def created(body = {})
+    render json: body, status: :created
+  end
+
+  def no_content
+    render json: {}, status: :no_content
+  end
+
+  def not_found(body = {})
+    render json: body, status: :not_found
+  end
+
+  def ok(content = {})
+    render json: content, status: :ok
+  end
+
+  def technical_error(error, status: :internal_server_error)
+    Rails.logger.error("#{error.message}\n#{error.backtrace.join("\n")}")
+    response = {error: 'Something technical went wrong. Please try again later'}
+    if Rails.env.development?
+      response[:exception] = "#{error.class.name} : #{error.message}"
+      response[:trace] = error.backtrace[0, 10]
+    end
+    render json: response, status: status
+  end
+
+  def unprocessable_entity(body = {})
+    render json: body, status: :unprocessable_entity
+  end
+
+  def unauthorized(error)
+    technical_error(error, status: :unauthorized)
+  end
+
+  def validation_error(error)
+    Rails.logger.warn("Malformed Request: #{error.message}") if Rails.env.production?
+    unprocessable_entity(exception: "#{error.class.name}: #{error.message}")
+  end
+end

data/app/controllers/health_check_controller.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+class HealthCheckController < ApiBaseController
+  def check
+    return bad_request unless ActiveRecord::Base.connection_pool.with_connection(&:active?)
+
+    ok
+  end
+
+  private
+
+  def bad_request(_errors = {})
+    render plain: 'Health Check failed', status: :bad_request
+  end
+
+  def ok(_content = {})
+    render plain: 'Health Check OK', status: :ok
+  end
+end

data/bin/health_check

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'net/http'
+
+port = ENV.fetch('PORT', 3000)
+
+health_check = Net::HTTP.get_response(URI("http://127.0.0.1:#{port}/health_check"))
+raise health_check.body if health_check.code.to_i != 200

data/config/initializers/camelizer.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'olive_branch'
+
+rails_routes = ->(env) { env['PATH_INFO'].match(%r{^/rails}) }
+
+Rails.application.middleware.use OliveBranch::Middleware,
+                                 inflection: 'camel',
+                                 exclude_params: rails_routes,
+                                 exclude_response: rails_routes,
+                                 content_type_check: ->(_) { true }

data/config/initializers/filter_parameter_logging.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# Be sure to restart your server when you modify this file.
+
+# Configure sensitive parameters which will be filtered from the log file.
+Rails.application.config.filter_parameters += %i[passw secret token _key crypt salt certificate otp ssn]
+
+Rails.application.config.filter_parameters += [/.*/] if Rails.env.production?

data/config/initializers/performance_logger.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module PerformanceLogger
+  extend ActiveSupport::Concern
+
+  private
+
+  def append_info_to_payload(payload)
+    super
+    payload[:runtimes] = runtimes
+  end
+
+  class_methods do
+    def log_process_action(payload)
+      super.concat(runtime_messages(payload[:runtimes]))
+    end
+
+    def runtime_messages(runtimes)
+      runtimes&.map { |key, runtime| format("#{key.to_s.camelize}: %.1fms", runtime.to_f) } || []
+    end
+  end
+end
+
+ActiveSupport.on_load(:action_controller) { include PerformanceLogger }

data/config/routes.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+Rails.application.routes.draw do
+  get '/health_check', to: 'health_check#check'
+end

data/lib/team_fastlane/base_service/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module TeamFastlane
+  module BaseService
+    VERSION = '1.0.0'
+  end
+end

data/lib/team_fastlane/base_service.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'team_fastlane/base_service/version'
+
+module TeamFastlane
+  module BaseService
+    class Engine < Rails::Engine
+    end
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: team_fastlane-base_service
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Team Fastlane
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-08-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: olive_branch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.0.1
+description:
+email:
+executables:
+- health_check
+extensions: []
+extra_rdoc_files:
+- README.adoc
+- CHANGELOG.adoc
+files:
+- CHANGELOG.adoc
+- README.adoc
+- app/controllers/api_base_controller.rb
+- app/controllers/concerns/performance_logging.rb
+- app/controllers/concerns/responses.rb
+- app/controllers/health_check_controller.rb
+- bin/health_check
+- config/initializers/camelizer.rb
+- config/initializers/filter_parameter_logging.rb
+- config/initializers/performance_logger.rb
+- config/routes.rb
+- lib/team_fastlane/base_service.rb
+- lib/team_fastlane/base_service/version.rb
+homepage:
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Gem for an internal project
+test_files: []