pliny 1.2.0 → 2.0.0

data/lib/pliny/middleware/request_id.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # please add changes here to core's Instruments as well
 
 module Pliny::Middleware
@@ -47,8 +49,8 @@ module Pliny::Middleware
       # field as to whether it should be prefixed with `X-` or not. API went
       # with no prefix, but Hermes went with one. Support both formats on
       # input.
-      %w(HTTP_REQUEST_ID HTTP_X_REQUEST_ID).inject([]) do |request_ids, key|
-        if ids = env[key]
+      %w[HTTP_REQUEST_ID HTTP_X_REQUEST_ID].inject([]) do |request_ids, key|
+        if (ids = env[key])
           request_ids += ids.split(",")
         end
         request_ids

data/lib/pliny/middleware/request_store/clear.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module Pliny::Middleware::RequestStore
   class Clear
-    def initialize(app, options={})
+    def initialize(app, options = {})
       @app = app
       @store = options[:store] || Pliny::RequestStore
     end

data/lib/pliny/middleware/request_store/seed.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module Pliny::Middleware::RequestStore
   class Seed
-    def initialize(app, options={})
+    def initialize(app, options = {})
       @app = app
       @store = options[:store] || Pliny::RequestStore
     end

data/lib/pliny/middleware/rescue_errors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Pliny::Middleware
   class RescueErrors
     def initialize(app, options = {})

data/lib/pliny/middleware/versioning.rb

@@ -1,8 +1,10 @@
-require 'http_accept'
+# frozen_string_literal: true
+
+require "http_accept"
 
 module Pliny::Middleware
   class Versioning
-    def initialize(app, options={})
+    def initialize(app, options = {})
       @app = app
       @default = options[:default] || raise("missing=default")
       @app_name = options[:app_name] || raise("missing=app_name")
@@ -22,17 +24,15 @@ module Pliny::Middleware
       version = nil
       media_types.map! do |media_type|
         if accept_headers.include?(media_type.format)
-          unless media_type.params['version']
-            error = { id: :bad_version, message: <<-eos }
-Please specify a version along with the MIME type. For example, `Accept: application/vnd.#{@app_name}+json; version=1`.
-            eos
+          unless media_type.params["version"]
+            error = { id: :bad_version, message: <<~EOS }
+              Please specify a version along with the MIME type. For example, `Accept: application/vnd.#{@app_name}+json; version=1`.
+            EOS
             return [400, { "content-type" => "application/json; charset=utf-8" },
-              [JSON.generate(error)]]
+              [JSON.generate(error)],]
           end
 
-          unless version
-            version = media_type.params["version"]
-          end
+          version ||= media_type.params["version"]
 
           # replace the MIME with a simplified version for easier
           # parsing down the stack
@@ -41,7 +41,7 @@ Please specify a version along with the MIME type. For example, `Accept: applica
         end
         media_type.to_s
       end
-      env['HTTP_ACCEPT'] = media_types.join(', ')
+      env["HTTP_ACCEPT"] = media_types.join(", ")
 
       version ||= @default
       set_api_version(env, version)

data/lib/pliny/request_store.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Pliny
   module RequestStore
     def self.clear!
@@ -6,12 +8,12 @@ module Pliny
 
     def self.seed(env)
       store[:request_id] =
-        env["REQUEST_IDS"] ? env["REQUEST_IDS"].join(",") : nil
+        env["REQUEST_IDS"]&.join(",")
 
       # a global context that evolves over the lifetime of the request, and is
       # used to tag all log messages that it produces
       store[:log_context] = {
-        request_id: store[:request_id]
+        request_id: store[:request_id],
       }
     end
 

data/lib/pliny/rollbar_logger.rb

@@ -1,19 +1,21 @@
+# frozen_string_literal: true
+
 module Pliny
   class RollbarLogger
     def debug(message)
-      log('debug', message)
+      log("debug", message)
     end
 
     def info(message)
-      log('info', message)
+      log("info", message)
     end
 
     def warn(message)
-      log('warn', message)
+      log("warn", message)
     end
 
     def error(message)
-      log('error', message)
+      log("error", message)
     end
 
     def log(level, message)

data/lib/pliny/router.rb

@@ -1,8 +1,9 @@
-require 'sinatra/router'
+# frozen_string_literal: true
+
+require "sinatra/router"
 
 module Pliny
   class Router < Sinatra::Router
-
     # yield to a builder block in which all defined apps will only respond for
     # the given version
     def version(*versions, &block)

data/lib/pliny/tasks/db.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "logger"
 require "uri"
 require "pliny/utils"
@@ -165,7 +167,7 @@ begin
     end
 
     def name_from_uri(uri)
-      URI.parse(uri).path[1..-1]
+      URI.parse(uri).path[1..]
     end
   end
 rescue LoadError

data/lib/pliny/tasks/schema.rake

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 desc "Rebuild schema.json"
 task :schema do
-  require 'pliny/commands/generator/schema'
+  require "pliny/commands/generator/schema"
   Pliny::Commands::Generator::Schema.new(nil).rebuild
 end

data/lib/pliny/tasks.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Dir[File.expand_path("../tasks", __FILE__) + "/*.rake"].sort.each do |f|
   load(f)
 end

data/lib/pliny/utils.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module Pliny
   module Utils
     def self.parse_env(file)
       env = {}
       File.open(file).each do |line|
-        line = line.gsub(/#.*$/, '').strip
+        line = line.gsub(/#.*$/, "").strip
         next if line.empty?
         var, value = line.split("=", 2)
         value.gsub!(/^['"](.*)['"]$/, '\1')
@@ -27,7 +29,7 @@ module Pliny
     end
 
     class << self
-      alias :require_relative_glob :require_glob
+      alias_method :require_relative_glob, :require_glob
     end
   end
 end

data/lib/pliny/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Pliny
-  VERSION = "1.2.0"
+  VERSION = "2.0.0"
 end

data/lib/pliny.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "json"
 require "sinatra/base"
 

data/lib/template/{.rubocop.yml → .rubocop_template.yml}

@@ -1,7 +1,6 @@
 require:
  - rubocop-rspec
-AllCops:
-  TargetRubyVersion: 2.3
+
 # Offense count: 8
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives.
 # URISchemes: http, https
@@ -24,6 +23,3 @@ Style/Documentation:
 Style/StringLiterals:
   Enabled: true
   EnforcedStyle: double_quotes
-
-Style/FrozenStringLiteralComment:
-  Enabled: false

data/lib/template/Gemfile

@@ -1,18 +1,21 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
-ruby "2.4.0"
+ruby "3.4.6"
 
 gem "pg"
-gem "pliny", "~> 0.32"
+gem "pliny", "~> 2"
 gem "pry"
-gem "puma", "~> 6"
+gem "puma", "~> 7"
 gem "rack-ssl"
 gem "rack-timeout", "~> 0.6"
 gem "rake"
 gem "rollbar"
+gem "sentry-ruby"
 gem "sequel", "~> 5.73"
 gem "sequel-paranoid"
 gem "sequel_pg", "~> 1.17", require: "sequel"
-gem "sinatra", [">= 2.0", "< 3.0"], require: "sinatra/base"
+gem "sinatra", "~> 4.0", require: "sinatra/base"
 gem "sinatra-contrib", require: ["sinatra/namespace", "sinatra/reloader"]
 gem "sinatra-router"
 gem "sucker_punch"

data/lib/template/Rakefile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 require "pliny/tasks"
 

data/lib/template/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require_relative "../lib/application"
 
@@ -15,7 +16,7 @@ Pry.prompt = [
 
   proc do |target_self, nest_level, pry|
     basic_prompt(target_self, nest_level, pry) + "* "
-  end
+  end,
 ]
 
 Pry.start

data/lib/template/bin/run

@@ -1,7 +1,10 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-# rubocop:disable Lint/Eval
+# rubocop:disable Security/Eval
 
 require_relative "../lib/application"
 
 eval ARGV.join(" ")
+
+# rubocop:enable Security/Eval

data/lib/template/config/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "pliny/config_helpers"
 
 # Access all config keys like the following:
@@ -13,23 +15,23 @@ module Config
   mandatory :database_url, string
 
   # Optional -- value is returned or `nil` if it wasn't present.
-  optional :app_name,            string
-  optional :versioning_default,  string
+  optional :app_name, string
+  optional :versioning_default, string
   optional :versioning_app_name, string
 
   # Override -- value is returned or the set default.
-  override :database_timeout, 10,           int
-  override :db_pool,          5,            int
-  override :deployment,       "production", string
-  override :force_ssl,        true,         bool
-  override :app_env,          "production", string
-  override :port,             5000,         int
-  override :pretty_json,      false,        bool
-  override :puma_max_threads, 16,           int
-  override :puma_min_threads, 1,            int
-  override :puma_workers,     3,            int
-  override :raise_errors,     false,        bool
-  override :root,             File.expand_path("../../", __FILE__), string
-  override :timeout,          10,           int
-  override :versioning,       false,        bool
+  override :database_timeout, 10, int
+  override :db_pool, 5, int
+  override :deployment, "production", string
+  override :force_ssl, true, bool
+  override :app_env, "production", string
+  override :port, 5000, int
+  override :pretty_json, false, bool
+  override :puma_max_threads, 16, int
+  override :puma_min_threads, 1, int
+  override :puma_workers, 3, int
+  override :raise_errors, false, bool
+  override :root, File.expand_path("../../", __FILE__), string
+  override :timeout, 10, int
+  override :versioning, false, bool
 end

data/lib/template/config/initializers/database.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 database_setup_proc = lambda do |conn|
   # identify postgres connections coming from this process in pg_stat_activity
   process_identifier = ENV["DYNO"] || File.basename($PROGRAM_NAME).gsub(/\W+/, "_")
@@ -6,5 +8,5 @@ database_setup_proc = lambda do |conn|
 end
 
 DB = Sequel.connect(Config.database_url,
-                    max_connections: Config.db_pool,
-                    after_connect: database_setup_proc)
+  max_connections: Config.db_pool,
+  after_connect: database_setup_proc,)

data/lib/template/config/initializers/log.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Pliny.default_context = {}
 Pliny.default_context[:app] = Config.app_name if Config.app_name
 Pliny.default_context[:deployment] = Config.deployment

data/lib/template/config/initializers/metrics.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 Pliny::Metrics.backends = [Pliny::Metrics::Backends::Logger]

data/lib/template/config/initializers/sentry.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "pliny/error_reporters/sentry"
+
+Pliny::ErrorReporters.error_reporters << Pliny::ErrorReporters::Sentry
+
+Sentry.init do |config|
+  config.dsn = ENV["SENTRY_DSN"]
+  config.environment = ENV["SENTRY_ENV"] || ENV["RACK_ENV"]
+  config.enabled_environments = ENV["SENTRY_ENABLED_ENVIRONMENTS"]&.split(",") || %w[production staging]
+  config.traces_sample_rate = ENV["SENTRY_TRACES_SAMPLE_RATE"]&.to_f || 0.1
+end
+
+Pliny.use Sentry::Rack::CaptureExceptions

data/lib/template/config/puma.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "./config/config"
 
 environment Config.rack_env
@@ -6,7 +8,7 @@ quiet
 threads Config.puma_min_threads, Config.puma_max_threads
 workers Config.puma_workers
 
-on_worker_boot do
+before_worker_boot do
   # force Sequel's thread pool to be refreshed
   Sequel::DATABASES.each(&:disconnect)
 end

data/lib/template/config.ru

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "lib/application"
 
 $stdout.sync = true

data/lib/template/db/seeds.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This file should contain all the record creation needed to seed the database
 # with its default values.
 # The data can then be loaded with the rake db:seed (or created alongside the

data/lib/template/lib/application.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "bundler"
 Bundler.require
 

data/lib/template/lib/endpoints/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Endpoints
   # The base class for all Sinatra-based endpoints. Use sparingly.
   class Base < Sinatra::Base

data/lib/template/lib/endpoints/health.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Endpoints
   class Health < Base
     namespace "/health" do

data/lib/template/lib/endpoints/root.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Endpoints
   class Root < Base
     get "/" do

data/lib/template/lib/endpoints/schema.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Endpoints
   class Schema < Base
     get "/schema.json" do

data/lib/template/lib/initializer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Initializer
   def self.run
     require_config
@@ -11,7 +13,7 @@ module Initializer
   end
 
   def self.require_lib
-    require! %w(
+    require! %w[
       lib/serializers/base
       lib/serializers/**/*
       lib/endpoints/base
@@ -19,13 +21,13 @@ module Initializer
       lib/mediators/base
       lib/mediators/**/*
       lib/routes
-    )
+    ]
   end
 
   def self.require_models
-    require! %w(
+    require! %w[
       lib/models/**/*
-    )
+    ]
   end
 
   def self.require_initializers

data/lib/template/lib/mediators/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mediators
   class Base
     def self.run(options = {})

data/lib/template/lib/routes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Routes = Rack::Builder.new do
   use Pliny::Middleware::RequestStore::Clear, store: Pliny::RequestStore
   use Pliny::Middleware::CORS
@@ -6,18 +8,18 @@ Routes = Rack::Builder.new do
   use Pliny::Middleware::Metrics
   use Pliny::Middleware::Instruments
   use Pliny::Middleware::CanonicalLogLine,
-      emitter: -> (data) {
-        Pliny.log_with_default_context({ canonical_log_line: true }.merge(data))
-      }
+    emitter: ->(data) {
+      Pliny.log_with_default_context({ canonical_log_line: true }.merge(data))
+    }
   use Pliny::Middleware::RescueErrors, raise: Config.raise_errors?
   if Config.timeout.positive?
     use Rack::Timeout,
-        service_timeout: Config.timeout
+      service_timeout: Config.timeout
   end
   if Config.versioning?
     use Pliny::Middleware::Versioning,
-        default: Config.versioning_default,
-        app_name: Config.versioning_app_name
+      default: Config.versioning_default,
+      app_name: Config.versioning_app_name
   end
   use Rack::Deflater
   use Rack::MethodOverride

data/lib/template/lib/serializers/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Serializers
   class Base
     extend Pliny::Helpers::ZuluTime

data/lib/template/lib/tasks/rubocop.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 if Gem.loaded_specs.has_key?("rubocop-rspec")
   require "rubocop/rake_task"
 

data/lib/template/lib/tasks/spec.rake

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 # define our own version of the spec task because rspec might not be available
 # in the production environment, so we can't rely on RSpec::Core::RakeTask
@@ -6,7 +7,7 @@ task :spec do
   require "rspec/core"
   code = RSpec::Core::Runner.run(
     ["./spec"],
-    $stderr, $stdout
+    $stderr, $stdout,
   )
   exit(code) unless code.zero?
 end

data/lib/template/spec/endpoints/health_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 RSpec.describe Endpoints::Health do

data/lib/template/spec/endpoints/schema_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 RSpec.describe Endpoints::Schema do

data/lib/template/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This file was generated by the `rspec --init` command. Conventionally, all
 # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
 # Require this file using `require "spec_helper"` to ensure that it is only

data/lib/template/spec/spec_support/auto_define_rack_app.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 RSpec.configure do |config|
   config.before(:context) do |spec|
     # weird ruby syntax, but test if the described_class inherits Sinatra::Base:

data/lib/template/spec/spec_support/coverage.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # setting ENV["CI"] configures simplecov for continuous integration output
 # setting ENV["COVERAGE"] generates a report when running tests locally
 if ENV["COVERAGE"] || ENV["CI"]

data/lib/template/spec/spec_support/log.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 unless ENV["TEST_LOGS"] == "true"
   module Pliny
     module Log

data/spec/canonical_log_line_helpers_spec.rb

@@ -1,14 +1,16 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
-describe Pliny::CanonicalLogLineHelpers do
-  class TestCanonicalLogLine
-    include Pliny::CanonicalLogLineHelpers
+class TestCanonicalLogLine
+  include Pliny::CanonicalLogLineHelpers
 
-    log_field :field_float, Float
-    log_field :field_integer, Integer
-    log_field :field_string, String
-  end
+  log_field :field_float, Float
+  log_field :field_integer, Integer
+  log_field :field_string, String
+end
 
+describe Pliny::CanonicalLogLineHelpers do
   it "allows a field to be set" do
     line = TestCanonicalLogLine.new
     line.field_string = "foo"
@@ -34,6 +36,6 @@ describe Pliny::CanonicalLogLineHelpers do
     line.field_integer = 42
     line.field_string = "foo"
     assert_equal({ field_float: 3.14, field_integer: 42, field_string: "foo" },
-      line.to_h)
+      line.to_h,)
   end
 end

data/spec/commands/creator_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "pliny/commands/creator"
 require "spec_helper"
 
@@ -19,6 +21,7 @@ describe Pliny::Commands::Creator do
       @gen.run!
       assert File.exist?("./foobar")
       assert File.exist?("./foobar/Gemfile")
+      assert File.exist?("./foobar/.rubocop.yml")
     end
 
     it "deletes the .git from it" do