pliny 1.2.0 → 2.0.0

data/lib/pliny/db_support.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "logger"
 require "sequel"
 require "sequel/extensions/migration"
@@ -15,12 +17,12 @@ module Pliny
       @db = Sequel.connect(database_url)
       @db.test_connection
       @db.disconnect
-      return true
+      true
     rescue Sequel::DatabaseConnectionError
-      return false
+      false
     end
 
-    def self.run(url, sequel_log_io=StringIO.new)
+    def self.run(url, sequel_log_io = StringIO.new)
       logger = Logger.new(sequel_log_io)
       instance = new(url, logger)
       yield instance
@@ -39,11 +41,11 @@ module Pliny
 
     def exists?(name)
       res = db.fetch("SELECT 1 FROM pg_database WHERE datname = ?", name)
-      return res.count > 0
+      res.count > 0
     end
 
     def create(name)
-      db.run(%{CREATE DATABASE "#{name}"})
+      db.run(%(CREATE DATABASE "#{name}"))
     end
 
     def migrate(target = nil)
@@ -79,32 +81,30 @@ module Pliny
           else
             :down
           end
+        elsif present_in_database
+          :file_missing
         else
-          if present_in_database
-            :file_missing
-          else
-            raise "error" # FIXME: better message
-          end
+          raise "error" # FIXME: better message
         end
       end
     end
 
     class MigrationStatusPresenter
       PADDING = 2
-      UP = "UP".freeze
-      DOWN = "DOWN".freeze
-      FILE_MISSING = "FILE MISSING".freeze
+      UP = "UP"
+      DOWN = "DOWN"
+      FILE_MISSING = "FILE MISSING"
 
       STATUS_MAP = {
         up: UP,
         down: DOWN,
-        file_missing: FILE_MISSING
+        file_missing: FILE_MISSING,
       }.freeze
 
       STATUS_OPTIONS = [
         UP,
         DOWN,
-        FILE_MISSING
+        FILE_MISSING,
       ].freeze
 
       attr_reader :migration_statuses
@@ -125,7 +125,7 @@ module Pliny
         [
           barrier_row,
           header_row,
-          barrier_row
+          barrier_row,
         ]
       end
 
@@ -137,20 +137,20 @@ module Pliny
 
       def footer
         [
-          barrier_row
+          barrier_row,
         ]
       end
 
       def barrier_row
-        "+#{'-' * (longest_status + PADDING)}+#{'-' * (longest_migration_name + PADDING)}+"
+        "+#{"-" * (longest_status + PADDING)}+#{"-" * (longest_migration_name + PADDING)}+"
       end
 
       def header_row
-        "|#{'STATUS'.center(longest_status + PADDING)}|#{'MIGRATION'.center(longest_migration_name + PADDING)}|"
+        "|#{"STATUS".center(longest_status + PADDING)}|#{"MIGRATION".center(longest_migration_name + PADDING)}|"
       end
 
       def status_row(migration_status)
-        "|#{STATUS_MAP[migration_status.status].center(longest_status + PADDING)}|#{' ' * (PADDING / 2)}#{migration_status.filename.ljust(longest_migration_name)}#{' ' * (PADDING / 2)}|"
+        "|#{STATUS_MAP[migration_status.status].center(longest_status + PADDING)}|#{" " * (PADDING / 2)}#{migration_status.filename.ljust(longest_migration_name)}#{" " * (PADDING / 2)}|"
       end
 
       private
@@ -210,7 +210,7 @@ module Pliny
 
     private
 
-    MIGRATION_DIR = "./db/migrate".freeze
+    MIGRATION_DIR = "./db/migrate"
     private_constant :MIGRATION_DIR
   end
 end

data/lib/pliny/error_reporters/rollbar.rb

@@ -1,5 +1,7 @@
-require 'rollbar/exception_reporter'
-require 'rollbar/request_data_extractor'
+# frozen_string_literal: true
+
+require "rollbar/exception_reporter"
+require "rollbar/request_data_extractor"
 
 module Pliny
   module ErrorReporters
@@ -24,7 +26,7 @@ module Pliny
           scope[:person] = proc { extract_person_data_from_controller(rack_env) }
         end
         scope
-      rescue Exception => e
+      rescue Exception => e # rubocop:disable Lint/RescueException
         report_exception_to_rollbar(rack_env, e)
         raise
       end

data/lib/pliny/error_reporters/sentry.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Pliny
+  module ErrorReporters
+    class Sentry
+      def notify(exception, context:, rack_env:)
+        ::Sentry.with_scope do |scope|
+          configure_scope(scope, context: context, rack_env: rack_env)
+          ::Sentry.capture_exception(exception)
+        end
+      rescue Exception => e # rubocop:disable Lint/RescueException
+        ::Sentry.capture_exception(e)
+        raise
+      end
+
+      private
+
+      def configure_scope(scope, context:, rack_env:)
+        scope.set_context("custom", context)
+
+        begin
+          person_data = extract_person_data_from_controller(rack_env)
+          if person_data && !person_data.empty?
+            scope.set_user(
+              id: person_data[:id],
+              email: person_data[:email],
+              username: person_data[:username],
+            )
+          end
+        rescue => e
+          ::Sentry.capture_exception(e)
+        end
+      end
+
+      def extract_person_data_from_controller(env)
+        env["sentry.person_data"] || {}
+      end
+    end
+  end
+end

data/lib/pliny/error_reporters.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Pliny::ErrorReporters
   extend self
 
@@ -9,11 +11,9 @@ module Pliny::ErrorReporters
     Pliny.log_exception(exception)
 
     error_reporters.each do |reporter|
-      begin
-        reporter.new.notify(exception, context: context, rack_env: rack_env)
-      rescue
-        Pliny.log_exception($!)
-      end
+      reporter.new.notify(exception, context: context, rack_env: rack_env)
+    rescue
+      Pliny.log_exception($!)
     end
   end
 end

data/lib/pliny/errors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Pliny
   module Errors
     class Error < StandardError
@@ -19,9 +21,9 @@ module Pliny
       attr_accessor :status
 
       def initialize(message = nil, id = nil, status = nil)
-        meta    = Pliny::Errors::META[self.class]
-        message = message || meta[1] + "."
-        id      = id || meta[1].downcase.tr(' ', '_').to_sym
+        meta = Pliny::Errors::META[self.class]
+        message ||= meta[1] + "."
+        id ||= meta[1].downcase.tr(" ", "_").to_sym
         @status = status || meta[0]
         super(message, id)
       end
@@ -71,47 +73,47 @@ module Pliny
 
     # Messages for nicer exceptions, from rfc2616
     META = {
-      Continue                     => [100, 'Continue'],
-      SwitchingProtocols           => [101, 'Switching protocols'],
-      OK                           => [200, 'OK'],
-      Created                      => [201, 'Created'],
-      Accepted                     => [202, 'Accepted'],
-      NonAuthoritativeInformation  => [203, 'Non-authoritative information'],
-      NoContent                    => [204, 'No content'],
-      ResetContent                 => [205, 'Reset content'],
-      PartialContent               => [206, 'Partial content'],
-      MultipleChoices              => [300, 'Multiple choices'],
-      MovedPermanently             => [301, 'Moved permanently'],
-      Found                        => [302, 'Found'],
-      SeeOther                     => [303, 'See other'],
-      NotModified                  => [304, 'Not modified'],
-      UseProxy                     => [305, 'Use proxy'],
-      TemporaryRedirect            => [307, 'Temporary redirect'],
-      BadRequest                   => [400, 'Bad request'],
-      Unauthorized                 => [401, 'Unauthorized'],
-      PaymentRequired              => [402, 'Payment required'],
-      Forbidden                    => [403, 'Forbidden'],
-      NotFound                     => [404, 'Not found'],
-      MethodNotAllowed             => [405, 'Method not allowed'],
-      NotAcceptable                => [406, 'Not acceptable'],
-      ProxyAuthenticationRequired  => [407, 'Proxy authentication required'],
-      RequestTimeout               => [408, 'Request timeout'],
-      Conflict                     => [409, 'Conflict'],
-      Gone                         => [410, 'Gone'],
-      LengthRequired               => [411, 'Length required'],
-      PreconditionFailed           => [412, 'Precondition failed'],
-      RequestEntityTooLarge        => [413, 'Request entity too large'],
-      RequestURITooLong            => [414, 'Request-URI too long'],
-      UnsupportedMediaType         => [415, 'Unsupported media type'],
-      RequestedRangeNotSatisfiable => [416, 'Requested range not satisfiable'],
-      ExpectationFailed            => [417, 'Expectation failed'],
-      UnprocessableEntity          => [422, 'Unprocessable entity'],
-      TooManyRequests              => [429, 'Too many requests'],
-      InternalServerError          => [500, 'Internal server error'],
-      NotImplemented               => [501, 'Not implemented'],
-      BadGateway                   => [502, 'Bad gateway'],
-      ServiceUnavailable           => [503, 'Service unavailable'],
-      GatewayTimeout               => [504, 'Gateway timeout'],
+      Continue => [100, "Continue"],
+      SwitchingProtocols => [101, "Switching protocols"],
+      OK => [200, "OK"],
+      Created => [201, "Created"],
+      Accepted => [202, "Accepted"],
+      NonAuthoritativeInformation => [203, "Non-authoritative information"],
+      NoContent => [204, "No content"],
+      ResetContent => [205, "Reset content"],
+      PartialContent => [206, "Partial content"],
+      MultipleChoices => [300, "Multiple choices"],
+      MovedPermanently => [301, "Moved permanently"],
+      Found => [302, "Found"],
+      SeeOther => [303, "See other"],
+      NotModified => [304, "Not modified"],
+      UseProxy => [305, "Use proxy"],
+      TemporaryRedirect => [307, "Temporary redirect"],
+      BadRequest => [400, "Bad request"],
+      Unauthorized => [401, "Unauthorized"],
+      PaymentRequired => [402, "Payment required"],
+      Forbidden => [403, "Forbidden"],
+      NotFound => [404, "Not found"],
+      MethodNotAllowed => [405, "Method not allowed"],
+      NotAcceptable => [406, "Not acceptable"],
+      ProxyAuthenticationRequired => [407, "Proxy authentication required"],
+      RequestTimeout => [408, "Request timeout"],
+      Conflict => [409, "Conflict"],
+      Gone => [410, "Gone"],
+      LengthRequired => [411, "Length required"],
+      PreconditionFailed => [412, "Precondition failed"],
+      RequestEntityTooLarge => [413, "Request entity too large"],
+      RequestURITooLong => [414, "Request-URI too long"],
+      UnsupportedMediaType => [415, "Unsupported media type"],
+      RequestedRangeNotSatisfiable => [416, "Requested range not satisfiable"],
+      ExpectationFailed => [417, "Expectation failed"],
+      UnprocessableEntity => [422, "Unprocessable entity"],
+      TooManyRequests => [429, "Too many requests"],
+      InternalServerError => [500, "Internal server error"],
+      NotImplemented => [501, "Not implemented"],
+      BadGateway => [502, "Bad gateway"],
+      ServiceUnavailable => [503, "Service unavailable"],
+      GatewayTimeout => [504, "Gateway timeout"],
     }.freeze
   end
 end

data/lib/pliny/helpers/encode.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module Pliny::Helpers
   module Encode
     def encode(object)
-      content_type :json, charset: 'utf-8'
-      if params[:pretty] == 'true' || Config.pretty_json
+      content_type :json, charset: "utf-8"
+      if params[:pretty] == "true" || Config.pretty_json
         JSON.pretty_generate(object)
       else
         JSON.generate(object)

data/lib/pliny/helpers/params.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Pliny::Helpers
   module Params
     def body_params

data/lib/pliny/helpers/serialize.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Pliny::Helpers
   module Serialize
     def self.registered(base)
@@ -10,17 +12,17 @@ module Pliny::Helpers
         serializer_class = settings.serializer_class
 
         if serializer_class.nil?
-          raise <<~eos.strip
+          raise <<~EOS.strip
             No serializer has been specified for this endpoint. Please specify one with
             `serializer Serializers::ModelName` in the endpoint.
-          eos
+          EOS
         end
 
-        env['pliny.serializer_arity'] = data.respond_to?(:size) ? data.size : 1
+        env["pliny.serializer_arity"] = data.respond_to?(:size) ? data.size : 1
 
         start = Time.now
         serializer_class.new(structure).serialize(data).tap do
-          env['pliny.serializer_timing'] = (Time.now - start).to_f
+          env["pliny.serializer_timing"] = (Time.now - start).to_f
         end
       end
     end

data/lib/pliny/helpers/zulu_time.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module Pliny::Helpers
   module ZuluTime
     def zulu_time(time)
-      time ? time.getutc.strftime("%Y-%m-%dT%H:%M:%SZ") : nil
+      time&.getutc&.strftime("%Y-%m-%dT%H:%M:%SZ")
     end
   end
 end

data/lib/pliny/log.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Pliny
   module Log
     def log(data, &block)
@@ -16,22 +18,20 @@ module Pliny
       exception_id = e.object_id
 
       # Log backtrace in reverse order for easier digestion.
-      if e.backtrace
-        e.backtrace.reverse.each do |backtrace|
-          log_to_stream(stderr || $stderr, merge_log_contexts(
-            exception_id: exception_id,
-            backtrace:    backtrace
-          ))
-        end
+      e.backtrace&.reverse&.each do |backtrace|
+        log_to_stream(stderr || $stderr, merge_log_contexts(
+          exception_id: exception_id,
+          backtrace: backtrace,
+        ),)
       end
 
       # then log the exception message last so that it's as close to the end of
       # a log trace as possible
       data.merge!(
-        exception:    true,
-        class:        e.class.name,
-        message:      e.message,
-        exception_id: exception_id
+        exception: true,
+        class: e.class.name,
+        message: e.message,
+        exception_id: exception_id,
       )
 
       data[:status] = e.status if e.respond_to?(:status)
@@ -42,10 +42,9 @@ module Pliny
     def context(data, &block)
       old = local_context
       self.local_context = old.merge(data)
-      res = block.call
+      block.call
     ensure
       self.local_context = old
-      res
     end
 
     def default_context=(default_context)
@@ -102,24 +101,26 @@ module Pliny
     end
 
     def log_to_stream(stream, data, &block)
-      unless block
-        data = log_scrubber.call(data) if log_scrubber
-        str = unparse(data)
-        stream.print(str + "\n")
-      else
+      if block
         data = data.dup
         start = Time.now
         log_to_stream(stream, data.merge(at: "start"))
         begin
           res = yield
           log_to_stream(stream, data.merge(
-            at: "finish", elapsed: (Time.now - start).to_f))
+            at: "finish", elapsed: (Time.now - start).to_f,
+          ),)
           res
         rescue
           log_to_stream(stream, data.merge(
-            at: "exception", elapsed: (Time.now - start).to_f))
+            at: "exception", elapsed: (Time.now - start).to_f,
+          ),)
           raise $!
         end
+      else
+        data = log_scrubber.call(data) if log_scrubber
+        str = unparse(data)
+        stream.print(str + "\n")
       end
     end
 
@@ -129,11 +130,11 @@ module Pliny
 
     def quote_string(v)
       if !v.include?('"')
-        %{"#{v}"}
+        %("#{v}")
       elsif !v.include?("'")
-        %{'#{v}'}
+        %('#{v}')
       else
-        %{"#{v.gsub(/"/, '\\"')}"}
+        %("#{v.gsub('"', '\\"')}")
       end
     end
 
@@ -144,7 +145,7 @@ module Pliny
     def unparse_pair(k, v)
       v = v.call if v.is_a?(Proc)
 
-      if v == nil
+      if v.nil?
         nil
       elsif v == true
         k
@@ -153,7 +154,7 @@ module Pliny
       elsif v.is_a?(Time)
         "#{k}=#{v.iso8601}"
       else
-        v = "#{v}"
+        v = v.to_s
         v = replace_newlines(v)
         v = quote_string(v) if v =~ /\s/
 

data/lib/pliny/metrics/backends/logger.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Pliny
   module Metrics
     module Backends
@@ -10,11 +12,11 @@ module Pliny
           Pliny.log(add_prefix(:measure, measures))
         end
 
-        private
-
         def self.add_prefix(type, metrics)
-          metrics.map { |k, v| [ "#{type}##{k}", v ] }.to_h
+          metrics.map { |k, v| ["#{type}##{k}", v] }.to_h
         end
+
+        private_class_method :add_prefix
       end
     end
   end

data/lib/pliny/metrics.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Pliny
   module Metrics
     extend self
@@ -7,7 +9,7 @@ module Pliny
     @backends = [Backends::Logger]
 
     def count(*names, value: 1)
-      counts = Hash[names.map { |n| ["#{Config.app_name}.#{n}", value] }]
+      counts = names.map { |n| ["#{Config.app_name}.#{n}", value] }.to_h
 
       backends.each do |backend|
         report_and_catch { backend.report_counts(counts) }
@@ -32,7 +34,7 @@ module Pliny
           0
         end
 
-      measures = Hash[inputs.map { |n| ["#{Config.app_name}.#{n}", measurement] }]
+      measures = inputs.map { |n| ["#{Config.app_name}.#{n}", measurement] }.to_h
 
       backends.each do |backend|
         report_and_catch { backend.report_measures(measures) }

data/lib/pliny/middleware/canonical_log_line.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Pliny::Middleware
   # Emits a "canonical log line", i.e. a single log line that contains as much
   # relevant information about a request as possible and which makes for a
@@ -75,7 +77,7 @@ module Pliny::Middleware
           # error
           #
 
-          if error = env["pliny.error"]
+          if (error = env["pliny.error"])
             line.error_class = error.class.name
             line.error_message = error.message
             if error.is_a?(Pliny::Errors::Error)
@@ -93,7 +95,7 @@ module Pliny::Middleware
           line.request_method = request.request_method
           line.request_path = request.path_info
           line.request_user_agent = request.user_agent
-          if route = env["sinatra.route"]
+          if (route = env["sinatra.route"])
             line.request_route_signature = route.split(" ").last
           end
 
@@ -101,7 +103,7 @@ module Pliny::Middleware
           # response
           #
 
-          if length = headers["Content-Length"]
+          if (length = headers["Content-Length"])
             line.response_length = length.to_i
           end
           line.response_status = status

data/lib/pliny/middleware/cors.rb

@@ -1,12 +1,13 @@
+# frozen_string_literal: true
+
 module Pliny::Middleware
   class CORS
-
-    ALLOW_METHODS  =
-      %w( GET POST PUT PATCH DELETE OPTIONS ).freeze
-    ALLOW_HEADERS  =
-      %w( Content-Type Accept Authorization Cache-Control If-None-Match If-Modified-Since Origin).freeze
+    ALLOW_METHODS =
+      %w[GET POST PUT PATCH DELETE OPTIONS].freeze
+    ALLOW_HEADERS =
+      %w[Content-Type Accept Authorization Cache-Control If-None-Match If-Modified-Since Origin].freeze
     EXPOSE_HEADERS =
-      %w( Cache-Control Content-Language Content-Type Expires Last-Modified Pragma ).freeze
+      %w[Cache-Control Content-Language Content-Type Expires Last-Modified Pragma].freeze
 
     @@additional_headers = []
 
@@ -44,12 +45,12 @@ module Pliny::Middleware
 
     def cors_headers(env)
       {
-        'access-control-allow-origin'      => env["HTTP_ORIGIN"],
-        'access-control-allow-methods'     => ALLOW_METHODS.join(', '),
-        'access-control-allow-headers'     => allow_headers.join(', '),
-        'access-control-allow-credentials' => "true",
-        'access-control-max-age'           => "1728000",
-        'access-control-expose-headers'    => EXPOSE_HEADERS.join(', ')
+        "access-control-allow-origin" => env["HTTP_ORIGIN"],
+        "access-control-allow-methods" => ALLOW_METHODS.join(", "),
+        "access-control-allow-headers" => allow_headers.join(", "),
+        "access-control-allow-credentials" => "true",
+        "access-control-max-age" => "1728000",
+        "access-control-expose-headers" => EXPOSE_HEADERS.join(", "),
       }
     end
   end

data/lib/pliny/middleware/instruments.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Pliny::Middleware
   class Instruments
     def initialize(app)
@@ -9,24 +11,24 @@ module Pliny::Middleware
 
       data = {
         instrumentation: true,
-        method:          env["REQUEST_METHOD"],
-        path:            env["PATH_INFO"]
+        method: env["REQUEST_METHOD"],
+        path: env["PATH_INFO"],
       }
 
       Pliny.log(data.merge(at: "start"))
 
       status, headers, response = @app.call(env)
 
-      if route = env["sinatra.route"]
+      if (route = env["sinatra.route"])
         data.merge!(route_signature: route.split(" ").last)
       end
 
       elapsed = (Time.now - start).to_f
       Pliny.log(data.merge(
-        at:              "finish",
-        status:          status,
-        length:          headers["Content-Length"],
-        elapsed:         elapsed
+        at: "finish",
+        status: status,
+        length: headers["Content-Length"],
+        elapsed: elapsed,
       ))
 
       [status, headers, response]

data/lib/pliny/middleware/metrics.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Pliny::Middleware
   class Metrics
     def initialize(app)
@@ -18,7 +20,7 @@ module Pliny::Middleware
         elapsed = (Time.now - start).to_f
         Pliny::Metrics.measure("requests.latency", value: elapsed)
 
-        status_level = "#{status/100}xx"
+        status_level = "#{status / 100}xx"
         Pliny::Metrics.count("requests.status.#{status_level}")
       end