rollday 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad34763ae84ecaefbd8febab644f790d10a0cd18fe0cd425004e8c8b6464c10b
-  data.tar.gz: 64474e52fb56a31a4cff7e4b11736d75163783b543bea30a6ca64b8054a5b366
+  metadata.gz: d2c78b5cc1611bf2a6d2766ffbd66df911882fc62e2fbcf3575450113c71e4b2
+  data.tar.gz: 2bc833d5d56efe20e819c66ec503074fe058444dc65f7640b393fab268782c04
 SHA512:
-  metadata.gz: fbb72f7c5446af3d674925b453bc92c978fc9db212a5ee36e905bc8775da81df6d91a477128f0cc0c0b0033f0a150ed58e017e5dd49b2af099502381d80bc57c
-  data.tar.gz: 53b16030723f41849ec4271d55d5073b7dea6cb36b3e178b28dd24e8247abb5feb64f71385dce67b4b0d099d3fb7a3097f9d8cdbbc77722bd186509d1d2d65cd
+  metadata.gz: 8f6a73ebb75e6854044f29da60c3cb98c68efd6f7dae56b66efbbe66c55847fbfdf08016c6dfacd520e261cec4162c263c7c227802c64303085e8260211cc2bc
+  data.tar.gz: f80905eebdc8af2e5dcff399dc3ad5ff42de2c3c75fbaf7b20b5139d8cec527237bb0a14acc6b32d90b337ef57b4254c5a7ee8fedf011db0ee9fde709af55373

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/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,36 @@ Add this line to your application's Gemfile:
 gem 'rollday'
 ```
 
-And then execute:
+## Usage
+
+### Initialization
 
-    $ bundle install
+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(...))
 
-Or install it yourself as:
+  config.use_default_client_middleware! # [Not default option] set middleware for all Faraday clients.
 
-    $ gem install rollday
+  config.status_code_regex = /[45]\d\d$/ # If status code matches, will attempt to send a rollbar
 
-## Usage
+  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
 
-TODO: Write usage instructions here
+  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
+```
 
 ## Development
 

data/lib/rollday/client_middleware.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Rollday
+  module FaradayConnectionOptions
+    def new_builder(block)
+      super.tap do |builder|
+        builder.use(Rollday::FARADAY_NAME)
+      end
+    end
+  end
+end

data/lib/rollday/configuration.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require "rollday/use_middleware"
+require "rollbar"
+
+module Rollday
+  class Configuration
+    ROLLBAR_LEVELS = [
+      DEBUG = :debug,
+      INFO = :info,
+      WARNING = :warning,
+      ERROR = :error,
+      CRITICAL = :critical
+    ]
+
+    DEFAULT_STATUS_CODE_REGEX = /[45]\d\d$/
+    DEFAULT_MESSAGE_PROC = ->(status, phrase, domain) { "[#{status}]: #{domain}" }
+    DEFAULT_LEVEL_PROC = ->(_status) { WARNING }
+
+    attr_accessor :use_person_scope, :use_params_scope, :params_scope_sanitizer, :use_query_scope, :params_query_sanitizer, :use_message_exception
+
+    def initialize(options = {})
+      @status_code_regex = DEFAULT_STATUS_CODE_REGEX
+      @use_person_scope = true
+
+      @use_params_scope = true
+      @params_scope_sanitizer = []
+
+      @use_query_scope = true
+      @params_query_sanitizer = []
+
+      @message = DEFAULT_MESSAGE_PROC
+      @use_message_exception = true
+
+      @rollbar_level = DEFAULT_LEVEL_PROC
+    end
+
+    def rollbar_level=(level)
+      raise ConfigError, "level= must be passed a Proc or #{ROLLBAR_LEVELS}. But was passed a #{level} instead"
+
+      @rollbar_level = level
+    end
+
+    def rollbar_level
+      @rollbar_level
+    end
+
+    def message=(message)
+      raise ConfigError, "message= must be passed a Proc but was passed a #{message.class} instead"
+
+      @message = message
+    end
+
+    def message
+      @message
+    end
+
+    def status_code_regex
+      @status_code_regex
+    end
+
+    def status_code_regex=(regex)
+      raise ConfigError, "status_code_regex= must be passed a regex but was passed a #{regex.class} instead"
+
+      @status_code_regex = regex
+    end
+
+    def person_scope=(person_scope)
+      raise ConfigError, "person_scope= must be passed a Proc but was passed a #{person_scope.class} instead"
+
+      @person_scope = person_scope
+    end
+
+    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
+  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,56 @@
+# 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::Faraday.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
+
+      query_scope = CGI::parse(URI(result.env.url).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,39 @@
+# 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
+
+      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::FARADAY_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.3.0"
 end

data/lib/rollday.rb

@@ -1,8 +1,47 @@
 # frozen_string_literal: true
 
 require "rollday/version"
+require "faraday"
+require "rollday/configuration"
+require "rollday/middleware"
 
 module Rollday
   class Error < StandardError; end
-  # Your code goes here...
+  class Faraday < Error; end # used to create backtrace for rollbar
+  class ConfigError < Error; end
+
+  FARADAY_NAME = :rollday.freeze
+
+  def self.configure
+    yield configuration if block_given?
+  end
+
+  def self.configuration
+    @configuration ||= Rollday::Configuration.new
+  end
+
+  class << self
+    alias_method :config, :configuration
+  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.use_middleware!
+
+  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.with_scope()
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rollday
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Matt Taylor
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-06-18 00:00:00.000000000 Z
+date: 2022-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -117,6 +117,11 @@ files:
 - bin/setup
 - docker-compose.yml
 - lib/rollday.rb
+- lib/rollday/client_middleware.rb
+- lib/rollday/configuration.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