tpt-rails 1.0.0

data/lib/generators/tpt_rails/postman/postman.yaml.tt

@@ -0,0 +1,2 @@
+- name: contract
+  collection: '?????'

data/lib/tasks/tpt/rails_tasks.rake

@@ -0,0 +1,23 @@
+namespace :tpt_rails do
+
+  desc "Gets the credentials key from Kubernetes and puts it in config/master.key"
+  task get_master_key: :environment do
+    command = <<~CMD
+      kubectl get secret #{Tpt::Rails.app_name}-secrets --output=json --context=kubernetes-eks-poc \
+        | jq --raw-output '.data."rails-master-key" | @base64d'
+    CMD
+
+    puts "Running command:\n#{command}"
+    result = `#{command}`
+
+    if $CHILD_STATUS.success?
+      puts 'Success'
+      File.open(::Rails.root.join('config/master.key'), 'w') do |file|
+        file.print(result.strip)
+      end
+    else
+      raise "Error: #{result}"
+    end
+  end
+
+end

data/lib/tpt/rails.rb

@@ -0,0 +1,65 @@
+require 'tpt/rails/engine'
+require 'tpt/rails/internal'
+require 'tpt/rails/config'
+
+module Tpt::Rails
+  class NotConfigured < StandardError; end
+
+  class << self
+    # USAGE:
+    #
+    # In your app in `config/initializers/tpt_rails.rb`:
+    #
+    #   Tpt::Rails.configure do |config|
+    #     config.app_name = '…'
+    #     config.app_env = '…'
+    #     config.rollbar_access_token = '…'
+    #     config.datadog_statsd_url = '…'
+    #     config.health_check(:foo) { … }
+    #     …
+    #   end
+    #
+    # See Tpt::Rails::Config in `lib/tpt/rails/config.rb` for a list of all configs.
+    def configure
+      @config = Tpt::Rails::Config.new
+
+      yield @config if block_given?
+
+      @configured = true
+      @config.setup
+    end
+
+    # Whether the `Tpt::Rails.configure` block has been run yet by the host application.
+    def configured?
+      @configured
+    end
+
+    # Returns the app name of the application. E.g. 'earnings'.
+    delegate :app_name, to: :config
+
+    # Returns the app environment of the application. E.g. 'production'/'integration'/'jordan123'.
+    delegate :app_env, to: :config
+
+    # Access to the `Datadog::Statsd` instance for this app.
+    #
+    # Examples:
+    #
+    #   Tpt::Rails.statsd.increment('foo', tags: ['a:b', 'c:d'])
+    #   Tpt::Rails.statsd.event('Some title', 'Some text', alert_type: 'warning', tags: ['a:b'])
+    #
+    delegate :statsd, to: :config
+
+    # Report an exception via an exception-reporting tool (e.g. Busgnag/Rollbar)
+    #
+    # Example:
+    #
+    #   rescue => e
+    #     Tpt::Rails.report(e)
+    #
+    delegate :report, to: :config
+
+    def config # :nodoc:
+      configured? ? @config : raise(NotConfigured)
+    end
+  end
+end

data/lib/tpt/rails/config.rb

@@ -0,0 +1,77 @@
+require 'tpt/rails/internal/datadog'
+require 'tpt/rails/internal/error_reporter'
+require 'tpt/rails/internal/health_checks'
+
+class Tpt::Rails::Config
+  #
+  # You can set the following configs in your `Tpt::Rails.configure do |config|` block:
+  #
+
+  # E.g. production/integration/jordan123
+  attr_accessor :app_env
+  # E.g. earnings/resource-write/tpt-data
+  attr_accessor :app_name
+  # A project-specific api key from Bugsnag
+  attr_accessor :bugsnag_api_key
+  # Set this in the form of: statsd://[host]:[port]'
+  attr_accessor :datadog_statsd_url
+  # Set this in the form of: datadog://[host]:[port]'
+  attr_accessor :datadog_trace_url
+  # Set this in the form of: redis://:[password]@[hostname]:[port]/[db]
+  attr_accessor :redis_url
+  # A project-specific access token from rollbar
+  attr_accessor :rollbar_access_token
+
+  # Add a health check to the endpoint provided at `/internal/health-check` by
+  # Tpt::Rails::HealthChecksController.
+  #
+  # The block provided to this method should return a truthy/falsey value for success/failure.
+  #
+  # Example:
+  #
+  #   config.health_check(:foo) { 'foo' == 'foo' }
+  #
+  def health_check(name, &block)
+    @health_checks.add(name, &block)
+  end
+
+  #
+  # Internal code
+  #
+
+  attr_reader :health_checks # :nodoc:
+
+  def initialize # :nodoc:
+    @health_checks = Tpt::Rails::Internal::HealthChecks.new
+  end
+
+  def setup # :nodoc:
+    if redis_url
+      # Ensure that redis has been added to the app's Gemfile if a `redis_url` has been set
+      gem 'redis', '>= 4', '< 5'
+      gem 'hiredis'
+
+      Redis.current = Redis.new(url: redis_url, driver: :hiredis)
+    end
+
+    @datadog = Tpt::Rails::Internal::Datadog.new(
+      statsd_url: datadog_statsd_url,
+      trace_url: datadog_trace_url,
+    )
+
+    @health_checks.setup
+
+    @error_reporter = Tpt::Rails::Internal::ErrorReporter.new(
+      bugsnag_api_key: bugsnag_api_key.presence,
+      rollbar_access_token: rollbar_access_token.presence,
+    )
+  end
+
+  def statsd # :nodoc:
+    @datadog.statsd
+  end
+
+  def report(error) # :nodoc:
+    @error_reporter.report(error)
+  end
+end

data/lib/tpt/rails/engine.rb

@@ -0,0 +1,7 @@
+module Tpt::Rails
+  # This turns this library into a Rails Engine.
+  # See https://guides.rubyonrails.org/engines.html
+  class Engine < ::Rails::Engine
+    isolate_namespace Tpt::Rails
+  end
+end

data/lib/tpt/rails/internal.rb

@@ -0,0 +1,3 @@
+module Tpt::Rails::Internal
+  # Items in this namespace are only meant for direct access inside of this gem.
+end

data/lib/tpt/rails/internal/datadog.rb

@@ -0,0 +1,66 @@
+#
+# Configures Datadog metrics and tracing, based on Tpt::Rails.config
+#
+
+require 'datadog/statsd'
+require 'ddtrace'
+
+class Tpt::Rails::Internal::Datadog # :nodoc:
+  DEFAULT_STATSD_PORT = 8125
+  DEFAULT_TRACE_PORT = 8126
+
+  attr_reader :statsd
+
+  def initialize(statsd_url: nil, trace_url: nil)
+    @statsd_url = statsd_url
+    @trace_url = trace_url
+
+    @statsd = create_statsd
+
+    if @trace_url
+      configure_tracing
+    end
+  end
+
+  private
+
+  def create_statsd
+    # Fall back to a dummy client so callers don't have to worry about null checking the client
+    url = @statsd_url || 'statsd://localhost'
+    uri = URI.parse(url)
+
+    ::Datadog::Statsd.new(
+      uri.host,
+      uri.port || DEFAULT_STATSD_PORT,
+      {
+        namespace: Tpt::Rails.app_name,
+        tags: ["env:#{Tpt::Rails.app_env}"],
+      }
+    )
+  end
+
+  def configure_tracing
+    uri = URI.parse(@trace_url)
+
+    ::Datadog.configure do |c|
+      # This will activate auto-instrumentation for Rails
+      c.use :rails, {
+        analytics_enabled: true,
+        service_name: Tpt::Rails.app_name,
+      }
+
+      c.tracer(
+        enabled: true,
+        hostname: uri.host,
+        port: uri.port || DEFAULT_TRACE_PORT,
+        tags: { 'env' => Tpt::Rails.app_env },
+      )
+    end
+
+    ::Datadog::Pipeline.before_flush(
+      ::Datadog::Pipeline::SpanFilter.new { |span|
+        span.resource =~ /TptRails::HealthChecksController/
+      },
+    )
+  end
+end

data/lib/tpt/rails/internal/error_reporter.rb

@@ -0,0 +1,68 @@
+class Tpt::Rails::Internal::ErrorReporter # :nodoc:
+  def initialize(bugsnag_api_key: nil, rollbar_access_token: nil)
+    @bugsnag_api_key = bugsnag_api_key
+    @rollbar_access_token = rollbar_access_token
+
+    configure_bugsnag if bugsnag?
+    configure_rollbar if rollbar?
+  end
+
+  def report(error)
+    if bugsnag?
+      Bugsnag.notify(error)
+    end
+
+    if rollbar?
+      Rollbar.error(error)
+    end
+
+    Tpt::Rails.statsd.increment(
+      'error',
+      tags: [
+        "error_class:#{error.class.name.underscore}",
+        'type:reported',
+      ],
+    )
+
+    ::Rails.logger.info("Error: class=#{error.class} message=#{error.message.inspect}")
+
+    if !bugsnag? && !rollbar?
+      ::Rails.logger.info('Warning: No error reporter configured for Tpt::Rails. Please add one.')
+      ::Rails.logger.info(error.backtrace)
+    end
+  end
+
+  private
+
+  def bugsnag?
+    @bugsnag_api_key
+  end
+
+  def rollbar?
+    @rollbar_access_token
+  end
+
+  def configure_bugsnag
+    # Ensure that bugsnag has been added to the app's Gemfile
+    gem 'bugsnag', '>= 6.12.2', '< 7'
+
+    Bugsnag.configure do |config|
+      config.api_key = @bugsnag_api_key
+    end
+  end
+
+  def configure_rollbar
+    # Ensure that rollbar has been added to the app's Gemfile
+    gem 'rollbar', '>= 2.23.2', '< 3'
+
+    Rollbar.configure do |config|
+      config.access_token = @rollbar_access_token
+
+      if ::Rails.env.test? || ::Rails.env.development?
+        config.enabled = false
+      end
+
+      config.environment = Tpt::Rails.app_env
+    end
+  end
+end

data/lib/tpt/rails/internal/health_checks.rb

@@ -0,0 +1,32 @@
+class Tpt::Rails::Internal::HealthChecks # :nodoc:
+  def initialize
+    @checks = {}
+  end
+
+  def add(name, &block)
+    @checks[name] = block
+  end
+
+  def check
+    @checks.transform_values(&:call)
+  end
+
+  def setup
+    setup_active_record
+    setup_redis
+  end
+
+  private
+
+  def setup_active_record
+    if defined?(ActiveRecord::Base) && ActiveRecord::Base.configurations.any?
+      add(:database) { ::ApplicationRecord.connection.select_value('select 1') == 1 }
+    end
+  end
+
+  def setup_redis
+    if Tpt::Rails.config.redis_url.present?
+      add(:redis) { Redis.current.ping == 'PONG' }
+    end
+  end
+end

data/lib/tpt/rails/version.rb

@@ -0,0 +1,5 @@
+module Tpt
+  module Rails
+    VERSION = '1.0.0'
+  end
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: tpt-rails
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- TpT
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-03-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.2.1
+- !ruby/object:Gem::Dependency
+  name: dogstatsd-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+- !ruby/object:Gem::Dependency
+  name: ddtrace
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.30'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.30'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- app/assets/config/tpt_rails_manifest.js
+- app/assets/stylesheets/tpt/rails/application.css
+- app/controllers/tpt/rails/application_controller.rb
+- app/controllers/tpt/rails/error_tests_controller.rb
+- app/controllers/tpt/rails/health_checks_controller.rb
+- app/helpers/tpt/rails/application_helper.rb
+- app/jobs/tpt/rails/application_job.rb
+- app/mailers/tpt/rails/application_mailer.rb
+- app/models/tpt/rails/application_record.rb
+- app/views/layouts/tpt/rails/application.html.erb
+- config/routes.rb
+- lib/generators/tpt_rails/configuration/configuration_generator.rb
+- lib/generators/tpt_rails/configuration/templates/config/initializers/tpt_rails.rb
+- lib/generators/tpt_rails/continuous_integration/continuous_integration_generator.rb
+- lib/generators/tpt_rails/continuous_integration/templates/ci/Dockerfile.tt
+- lib/generators/tpt_rails/continuous_integration/templates/ci/docker-compose.yaml.tt
+- lib/generators/tpt_rails/continuous_integration/templates/ci/tasks/project.test.unit
+- lib/generators/tpt_rails/continuous_integration/templates/ci/test.Jenkinsfile.tt
+- lib/generators/tpt_rails/continuous_integration/templates/ci/test.config.xml.tt
+- lib/generators/tpt_rails/continuous_integration/templates/ci/tptcd.Jenkinsfile.tt
+- lib/generators/tpt_rails/continuous_integration/templates/ci/tptci.Jenkinsfile.tt
+- lib/generators/tpt_rails/kubernetes/kubernetes_generator.rb
+- lib/generators/tpt_rails/kubernetes/templates/Dockerfile.tt
+- lib/generators/tpt_rails/kubernetes/templates/entrypoint.sh
+- lib/generators/tpt_rails/kubernetes/templates/kubernetes/helm/Chart.yaml.tt
+- lib/generators/tpt_rails/kubernetes/templates/kubernetes/helm/README.md
+- lib/generators/tpt_rails/kubernetes/templates/kubernetes/helm/requirements.yaml.tt
+- lib/generators/tpt_rails/kubernetes/templates/kubernetes/helm/templates/NOTES.txt.tt
+- lib/generators/tpt_rails/kubernetes/templates/kubernetes/helm/templates/_env.yaml
+- lib/generators/tpt_rails/kubernetes/templates/kubernetes/helm/templates/_helpers.tpl.tt
+- lib/generators/tpt_rails/kubernetes/templates/kubernetes/helm/templates/autoscaler.yaml.tt
+- lib/generators/tpt_rails/kubernetes/templates/kubernetes/helm/templates/deployment.yaml.tt
+- lib/generators/tpt_rails/kubernetes/templates/kubernetes/helm/templates/hooks/db-migrate.yaml.tt
+- lib/generators/tpt_rails/kubernetes/templates/kubernetes/helm/templates/service.yaml.tt
+- lib/generators/tpt_rails/kubernetes/templates/kubernetes/helm/values.prod.yaml.tt
+- lib/generators/tpt_rails/kubernetes/templates/kubernetes/helm/values.staging.yaml.tt
+- lib/generators/tpt_rails/kubernetes/templates/kubernetes/helm/values.yaml.tt
+- lib/generators/tpt_rails/postman/postman.yaml.tt
+- lib/tasks/tpt/rails_tasks.rake
+- lib/tpt/rails.rb
+- lib/tpt/rails/config.rb
+- lib/tpt/rails/engine.rb
+- lib/tpt/rails/internal.rb
+- lib/tpt/rails/internal/datadog.rb
+- lib/tpt/rails/internal/error_reporter.rb
+- lib/tpt/rails/internal/health_checks.rb
+- lib/tpt/rails/version.rb
+homepage: https://github.com/TeachersPayTeachers/tpt-rails
+licenses:
+- None
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Utils for TpT Rails apps
+test_files: []