rollday 0.1.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad34763ae84ecaefbd8febab644f790d10a0cd18fe0cd425004e8c8b6464c10b
-  data.tar.gz: 64474e52fb56a31a4cff7e4b11736d75163783b543bea30a6ca64b8054a5b366
+  metadata.gz: 02476ca50a8cb131cd458cffe10428026cee831d1c6ec555cc605541ebc20d9c
+  data.tar.gz: e4e0c9c14d3f02ea831fe77efe9a4142291c995d955200dd00085a136e6deba6
 SHA512:
-  metadata.gz: fbb72f7c5446af3d674925b453bc92c978fc9db212a5ee36e905bc8775da81df6d91a477128f0cc0c0b0033f0a150ed58e017e5dd49b2af099502381d80bc57c
-  data.tar.gz: 53b16030723f41849ec4271d55d5073b7dea6cb36b3e178b28dd24e8247abb5feb64f71385dce67b4b0d099d3fb7a3097f9d8cdbbc77722bd186509d1d2d65cd
+  metadata.gz: 9fc90d8d766d8687322349b6fae4bf8dc12fa7f0f1b40b81476b90a15c1980737879f92947b431d064c6e24f9da3a0cfae91c08340dbeefff4ceddda0463075a
+  data.tar.gz: 443ca20fde67b2447dc734c9bd3fba8b37f6373b35149cc52d5e824fc4432a59c2964cd0bd8d18e74171be934b875a85aa9a86033843404c14fd1499230508f5

data/CHANGELOG.md

@@ -7,7 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-## [0.1.0] - YYYY-MM-DD
+## [0.2.0] - 2022-06-18
 
 ### Added
 - New feature 1

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    rollday (0.1.0)
+    rollday (0.5.0)
+      class_composer
       faraday
       rollbar
 
@@ -9,6 +10,7 @@ GEM
   remote: https://rubygems.org/
   specs:
     byebug (11.1.3)
+    class_composer (1.0.0)
     coderay (1.1.3)
     concurrent-ruby (1.1.10)
     diff-lcs (1.5.0)

data/README.md

@@ -1,11 +1,9 @@
 # Rollday
 
-Welcome to your new gem! In this directory, you'll find the files you need to be
-able to package up your Ruby library into a gem. Put your Ruby code in the file
-`lib/rollday`. To experiment with that code, run
-`bin/console` for an interactive prompt.
+Rollday is a a gem to integrate with Faraday requests. It adds a default middleware for your projecrts Faraday client to send a rollbar for configurable response status codes.
+
+It can be configured once for th eentire project, or customized per Faraday request
 
-TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
@@ -15,17 +13,95 @@ Add this line to your application's Gemfile:
 gem 'rollday'
 ```
 
-And then execute:
+## Usage
 
-    $ bundle install
+### Initialization
 
-Or install it yourself as:
+Intialization should happen in `app/initializers/rollday.rb`. All options below are the current defaults unless stated
+```ruby
+Rollday.configure do |config|
+  config.use_default_middleware! # [Not default option] set middleware for all Faraday requests (Faraday.get(...)). Caution when used with Default Client Middleware
 
-    $ gem install rollday
+  config.use_default_client_middleware! # [Not default option] set middleware for all Faraday instances. Caution when used with Default Middleware
 
-## Usage
+  config.status_code_regex = /[45]\d\d$/ # If status code matches, will attempt to send a rollbar
+
+  config.use_person_scope = true # Assign a person scope to the rollbar scope
+
+  config.use_params_scope = true # Assign a params scope to the rollbar scope. Configured from Faraday params for request
+
+  config.params_scope_sanitizer = [] # Array of Procs to sanitize params. Can remove params or call Rollbar::Scrubbers.scrub_value(*) to assign value
+
+  config.use_query_scope = true # Assign the url queries to the scope
+
+  config.params_query_sanitizer = [] # Array of Procs to sanitize query params. Can remove params or call Rollbar::Scrubbers.scrub_value(*) to assign value
+
+  config.message = ->(status, phrase, body, path, domain) { "[#{status}]: #{domain} - #{path}" } # Message to set for the Rollbar item. Value can be a proc or a static message
+
+  config.use_message_exception = true # When set to true, Exception will be used to establish a backtrace
+
+  config.rollbar_level = ->(_status) { :warning } # Rollbar level can be configurable based on the status code
+end
+```
+
+### Ex: Default Faraday Client
 
-TODO: Write usage instructions here
+```ruby
+# Rollday initializer
+Rollday.configure do |config|
+  config.use_default_middleware!
+  config.status_code_regex = /[2345]\d\d$/
+  config.message = -> (s, phrase, b, path, domain) { "[#{domain}] via #{path} returned #{status}" }
+end
+
+Farady.get("http://httpstat.us/207") # => 200 status code returned
+# Will send a rollbar because Status code matches regex
+```
+
+### Ex: Default Faraday Instance
+
+```ruby
+# Rollday initializer
+Rollday.configure do |config|
+  config.use_default_client_middleware!
+  config.message = -> (s, phrase, b, path, domain) { "[#{domain}] via #{path} returned #{status} using default client middleware" }
+end
+Farady.get("http://httpstat.us/500") # => 500 status code returned
+# Rollbar will not get sent because `use_default_middleware!` is not set
+
+client = Faraday.new(url: base_url)
+client.get("404") # => 404 status code returned
+# Will send a rollbar because Status code matches regex
+```
+
+### Ex: Custom Faraday Instance
+
+```ruby
+# Rollday initializer
+Rollday.configure do |config|
+  config.status_code_regex = /[2]\d\d$/
+  config.message = -> (s, phrase, b, path, domain) { "[#{domain}] via #{path} returned #{status} using custom client middleware" }
+end
+Farady.get("http://httpstat.us/500") # => 500 status code returned
+# Rollbar will not get sent because `use_default_middleware!` is not set
+
+client = Faraday.new(url: base_url) do |conn|
+  conn.use Rollday::MIDDLEWARE_NAME
+end
+client.get("209") # => 209 status code returned
+# Will send a rollbar because Status code matches regex
+```
+
+### Use Caution
+```ruby
+# Rollday initializer
+Rollday.configure do |config|
+  # Do not do this!
+  config.use_default_middleware!
+  config.use_default_client_middleware!
+end
+```
+Adding both the `use_default_middleware!` and the `use_default_client_middleware!` will cause double reporting of all default Faraday builders.
 
 ## Development
 

data/lib/rollday/client_middleware.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Rollday
+  module FaradayConnectionOptions
+    def new_builder(block)
+      super.tap do |builder|
+        # allow scope to remove usage of middleware for a request
+        # after it has been injected into the Connection
+        if Rollday.config.allow_client_middleware
+          builder.use(Rollday::MIDDLEWARE_NAME)
+        end
+      end
+    end
+  end
+end

data/lib/rollday/configuration.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require "class_composer"
+require "rollbar"
+require "rollday/errors"
+require "rollday/use_middleware"
+
+module Rollday
+  class Configuration
+    include ClassComposer::Generator
+
+    ROLLBAR_LEVELS = [
+      DEBUG = :debug,
+      INFO = :info,
+      WARNING = :warning,
+      ERROR = :error,
+      CRITICAL = :critical
+    ]
+    DEFAULT_ROLLBAR_LEVEL = WARNING
+
+    DEFAULT_STATUS_CODE_REGEX = /[45]\d\d$/
+    DEFAULT_MESSAGE_PROC = ->(status, phrase, body, path, domain) { "[#{status}]: #{domain} - #{path}" }
+    DEFAULT_LEVEL_PROC = ->(_status) { DEFAULT_ROLLBAR_LEVEL }
+    ROLLBAR_VALIDATOR = Proc.new do |value|
+      value.is_a?(Proc) || ROLLBAR_LEVELS.include?(value)
+    end
+
+    add_composer :message, allowed: [Proc, String], default: DEFAULT_MESSAGE_PROC
+    add_composer :params_query_sanitizer, allowed: Array, default: []
+    add_composer :params_scope_sanitizer, allowed: Array, default: []
+    add_composer :person_scope, allowed: Proc
+    add_composer :rollbar_level, allowed: [Proc, Symbol], default: DEFAULT_LEVEL_PROC, validator: ROLLBAR_VALIDATOR, invalid_message: -> (val) { "Value must be a Proc or one of #{ROLLBAR_LEVELS}" }
+    add_composer :status_code_regex, allowed: Regexp, default: DEFAULT_STATUS_CODE_REGEX
+    add_composer :use_message_exception, allowed: [TrueClass, FalseClass], default: true
+    add_composer :use_params_scope, allowed: [TrueClass, FalseClass], default: true
+    add_composer :use_person_scope, allowed: [TrueClass, FalseClass], default: true
+    add_composer :use_query_scope, allowed: [TrueClass, FalseClass], default: true
+    add_composer :exception_class, allowed: Class, default: Rollday::Faraday
+    add_composer :allow_client_middleware, allowed: [TrueClass, FalseClass], default: true
+
+    def person_scope
+      return -> {} unless @use_person_scope
+
+      @person_scope || Rollbar.scope.scope_object.raw[:person] || -> {}
+    end
+
+    def use_default_middleware!
+      Rollday.use_default_middleware!
+    end
+
+    def use_default_client_middleware!
+      Rollday.use_default_client_middleware!
+    end
+
+    def register_middleware!
+      Rollday.register_middleware!
+    end
+  end
+end

data/lib/rollday/errors.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Rollday
+  class Error < StandardError; end
+  class Faraday < Error; end # used to create backtrace for rollbar
+  class ConfigError < Error; end
+end

data/lib/rollday/middleware.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "rollday/rollbar_helper"
+
+module Rollday
+  class Middleware < ::Faraday::Middleware
+    include RollbarHelper
+
+    def initialize(app, **)
+      super(app)
+
+      @app = app
+    end
+
+    def call(env)
+      result = @app.(env)
+      if ship_to_rollbar?(result.status)
+        send_rollbar(result)
+      end
+
+      result
+    end
+
+    private
+
+    def ship_to_rollbar?(status)
+      status.to_s =~ Rollday.config.status_code_regex
+    end
+
+    def send_rollbar(result)
+      scope = rollbar_scope(result)
+      message = rollbar_message(result)
+      level = rollbar_level(result)
+      ::Rollbar.log(level, message, **scope)
+    end
+  end
+end

data/lib/rollday/rollbar_helper.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'rollbar'
+
+module Rollday
+  module RollbarHelper
+
+    def rollbar_level(result)
+      level = Rollday.config.rollbar_level
+      level.is_a?(Proc) ? level.(result.status) : level
+    end
+
+    def rollbar_message(result)
+      message = Rollday.config.message.(result.status, result.reason_phrase, result.body, URI(result.env.url).path, URI(result.env.url).host)
+      return message unless Rollday.config.use_message_exception
+
+      Rollday.config.exception_class.new(message)
+    end
+
+    def rollbar_scope(result)
+      {
+        framework: "Faraday: #{::Faraday::VERSION}; Rollday: #{Rollday::VERSION}",
+        host: URI(result.env.url).host,
+        method: result.env.method,
+        params: params_scope(result),
+        path: URI(result.env.url).path,
+        body: result.body,
+        person: person_scope,
+        query: query_scope(result),
+        status: result.status,
+        status_phrase: result.reason_phrase,
+      }
+    end
+
+    private
+
+    def query_scope(result)
+      return {} unless  Rollday.config.use_query_scope
+      raw_query = URI(result.env.url).query
+      return if raw_query.nil?
+
+      query_scope = CGI::parse(raw_query)
+      Rollday.config.params_scope_sanitizer.each do |sanitizer|
+        query_scope = sanitizer.(query_params)
+      end
+
+      query_scope
+    end
+
+    def params_scope(result)
+
+    end
+
+    def person_scope
+      Rollday.config.person_scope.()
+    end
+  end
+end

data/lib/rollday/use_middleware.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Rollday
+  module UseMiddleware
+    # https://github.com/lostisland/faraday/blob/816d824bc18453e86027c9c5fcf8427020566e50/lib/faraday/rack_builder.rb#L83-L86
+    # https://github.com/lostisland/faraday/blob/816d824bc18453e86027c9c5fcf8427020566e50/lib/faraday/rack_builder.rb#L156-L169
+    # Once the default middleware is crated and the Faraday Rack app has been built,
+    # it can not be removed from the middleware Faraday stack
+    # If removal is needed, then use the middleware per request instead of defaulted
+    # or use the `with_scope` to modify the parameters of the rollday gem
+    def self.use_default_middleware!
+      register_middleware!
+
+      return false if @add_default_middleware
+
+      idx = ::Faraday.default_connection.builder.handlers.size - 1
+      ::Faraday.default_connection.builder.insert(idx, Middleware)
+      @add_default_middleware = true
+    end
+
+    # https://github.com/lostisland/faraday/issues/946#issuecomment-500607890
+    # Monkey patch to force this middleware into every single Faraday.new client
+    def self.use_default_client_middleware!
+      return false if @use_default_client_middleware
+
+      register_middleware!
+      require "rollday/client_middleware"
+      ::Faraday::ConnectionOptions.prepend(Rollday::FaradayConnectionOptions)
+
+      @use_default_client_middleware = true
+    end
+
+    def self.register_middleware!
+      return false if @register_middleware
+
+      ::Faraday::Middleware.register_middleware(Rollday::MIDDLEWARE_NAME => Middleware)
+      @register_middleware = true
+    end
+  end
+end

data/lib/rollday/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Rollday
-  VERSION = "0.1.0"
+  VERSION = "0.5.0"
 end

data/lib/rollday.rb

@@ -1,8 +1,50 @@
 # frozen_string_literal: true
 
+require "faraday"
+require "rollday/configuration"
+require "rollday/errors"
+require "rollday/middleware"
 require "rollday/version"
 
 module Rollday
-  class Error < StandardError; end
-  # Your code goes here...
+  MIDDLEWARE_NAME = :rollday.freeze
+
+  def self.configure
+    yield configuration if block_given?
+  end
+
+  def self.configuration
+    @configuration ||= Rollday::Configuration.new
+  end
+
+  def self.configuration=(object)
+    raise ConfigError, "Expected configuration to be a Rollday::Configuration" unless object.is_a?(Rollday::Configuration)
+
+    @configuration = object
+  end
+
+  def self.reset_configuration!
+    @configuration = Rollday::Configuration.new
+  end
+
+  class << self
+    alias_method :config, :configuration
+    alias_method :config=, :configuration=
+    alias_method :reset_config!, :reset_configuration!
+  end
+
+  def self.use_default_middleware!
+    Rollday::UseMiddleware.use_default_middleware!
+  end
+
+  def self.use_default_client_middleware!
+    Rollday::UseMiddleware.use_default_client_middleware!
+  end
+
+  def self.register_middleware!
+    Rollday::UseMiddleware.register_middleware!
+  end
+
+  def self.with_scope()
+  end
 end

data/rollday.gemspec

@@ -29,6 +29,7 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "class_composer"
   spec.add_dependency "faraday"
   spec.add_dependency "rollbar"
 

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: rollday
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Matt Taylor
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-06-18 00:00:00.000000000 Z
+date: 2022-07-09 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: class_composer
+  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: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -117,6 +131,12 @@ files:
 - bin/setup
 - docker-compose.yml
 - lib/rollday.rb
+- lib/rollday/client_middleware.rb
+- lib/rollday/configuration.rb
+- lib/rollday/errors.rb
+- lib/rollday/middleware.rb
+- lib/rollday/rollbar_helper.rb
+- lib/rollday/use_middleware.rb
 - lib/rollday/version.rb
 - rollday.gemspec
 homepage: https://github.com/matt-taylor/rollday