rollday 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88eac5b844d6a7cd87818c350d03f96b5d0d470dd8c044f8bab3da9625720595
-  data.tar.gz: fe85155acaebfb01238ce3530bde4c3b2b9537c3a24389e36dc8466423857831
+  metadata.gz: 836fb01c93ad7c663511d41a10b61ba4ecb7947f8e7fe06973267178181581d7
+  data.tar.gz: dc92f28700124355c7c505ff73e39556c7c7d18c3517335a8818390d8d02eb36
 SHA512:
-  metadata.gz: 7249b1d26e10e71c56fca2355fe8d2f609724f476ba62a8663c55207c6fb508ab59ef455cc436a93ab4aa0cb9db5d9967dcbcc1ce4bfd82e5eabedd2f531ea7e
-  data.tar.gz: 62b0b30259c81d79c601c50ee5b183939da161fef4460d1d668c50d971697050a7ceccb51a5dd50f4bc5062abda367f96823c62a2f7c61db25f343b994990b70
+  metadata.gz: 1feeea482c3827de3f1d2c918aecde8aa9d897c41651b0e0f812edfae52f78cb8b4d2a140b749aca586a7453364b50f40edba73643dd975ea60e86b62fd00926
+  data.tar.gz: f39c7a03087faf86c11e3470be983a1addc265caa62ba29824187ef144a08ff690c9196f2f1dcecffa3190d977b2373702f26ade02007e1eb8a842e7d2b1d163

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rollday (0.4.0)
+    rollday (0.5.0)
       class_composer
       faraday
       rollbar

data/README.md

@@ -20,9 +20,9 @@ gem 'rollday'
 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(...))
+  config.use_default_middleware! # [Not default option] set middleware for all Faraday requests (Faraday.get(...)). Caution when used with Default Client Middleware
 
-  config.use_default_client_middleware! # [Not default option] set middleware for all Faraday clients.
+  config.use_default_client_middleware! # [Not default option] set middleware for all Faraday instances. Caution when used with Default Middleware
 
   config.status_code_regex = /[45]\d\d$/ # If status code matches, will attempt to send a rollbar
 
@@ -44,6 +44,65 @@ Rollday.configure do |config|
 end
 ```
 
+### Ex: Default Faraday Client
+
+```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
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run

data/lib/rollday/client_middleware.rb

@@ -4,7 +4,11 @@ module Rollday
   module FaradayConnectionOptions
     def new_builder(block)
       super.tap do |builder|
-        builder.use(Rollday::FARADAY_NAME)
+        # 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

data/lib/rollday/configuration.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 
-require "rollday/use_middleware"
-require "rollbar"
 require "class_composer"
+require "rollbar"
+require "rollday/errors"
+require "rollday/use_middleware"
 
 module Rollday
   class Configuration
@@ -15,26 +16,32 @@ module Rollday
       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) { WARNING }
+    DEFAULT_LEVEL_PROC = ->(_status) { DEFAULT_ROLLBAR_LEVEL }
     ROLLBAR_VALIDATOR = Proc.new do |value|
       value.is_a?(Proc) || ROLLBAR_LEVELS.include?(value)
     end
 
+    EXCEPTION_CLASS_DEFAULT = -> (status, phrase, body, path, domain) { Rollday::Faraday }
+
     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 :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 :exception_class, allowed: Proc, default: EXCEPTION_CLASS_DEFAULT
+    add_composer :allow_client_middleware, allowed: [TrueClass, FalseClass], default: true
 
     def person_scope
-      return -> {} unless @use_person_scope
+      return -> {} unless use_person_scope
 
       @person_scope || Rollbar.scope.scope_object.raw[:person] || -> {}
     end
@@ -46,5 +53,9 @@ module Rollday
     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

@@ -4,7 +4,7 @@ require "faraday"
 require "rollday/rollbar_helper"
 
 module Rollday
-  class Middleware < Faraday::Middleware
+  class Middleware < ::Faraday::Middleware
     include RollbarHelper
 
     def initialize(app, **)

data/lib/rollday/rollbar_helper.rb

@@ -11,10 +11,12 @@ module Rollday
     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)
+      params = [result.status, result.reason_phrase, result.body, URI(result.env.url).path, URI(result.env.url).host]
+      message = Rollday.config.message.(*params)
       return message unless Rollday.config.use_message_exception
 
-      Rollday::Faraday.new(message)
+      error_klass = Rollday.config.exception_class.(*params)
+      error_klass.new(message)
     end
 
     def rollbar_scope(result)
@@ -36,8 +38,10 @@ module Rollday
 
     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(URI(result.env.url).query)
+      query_scope = CGI::parse(raw_query)
       Rollday.config.params_scope_sanitizer.each do |sanitizer|
         query_scope = sanitizer.(query_params)
       end

data/lib/rollday/use_middleware.rb

@@ -23,6 +23,7 @@ module Rollday
     def self.use_default_client_middleware!
       return false if @use_default_client_middleware
 
+      register_middleware!
       require "rollday/client_middleware"
       ::Faraday::ConnectionOptions.prepend(Rollday::FaradayConnectionOptions)
 
@@ -32,7 +33,7 @@ module Rollday
     def self.register_middleware!
       return false if @register_middleware
 
-      ::Faraday::Middleware.register_middleware(Rollday::FARADAY_NAME => Middleware)
+      ::Faraday::Middleware.register_middleware(Rollday::MIDDLEWARE_NAME => Middleware)
       @register_middleware = true
     end
   end

data/lib/rollday/version.rb

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

data/lib/rollday.rb

@@ -1,16 +1,13 @@
 # frozen_string_literal: true
 
-require "rollday/version"
 require "faraday"
 require "rollday/configuration"
+require "rollday/errors"
 require "rollday/middleware"
+require "rollday/version"
 
 module Rollday
-  class Error < StandardError; end
-  class Faraday < Error; end # used to create backtrace for rollbar
-  class ConfigError < Error; end
-
-  FARADAY_NAME = :rollday.freeze
+  MIDDLEWARE_NAME = :rollday.freeze
 
   def self.configure
     yield configuration if block_given?
@@ -20,18 +17,20 @@ module Rollday
     @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!
+  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!
@@ -42,6 +41,10 @@ module Rollday
     Rollday::UseMiddleware.use_default_client_middleware!
   end
 
+  def self.register_middleware!
+    Rollday::UseMiddleware.register_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.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Matt Taylor
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-07-04 00:00:00.000000000 Z
+date: 2022-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: class_composer
@@ -133,6 +133,7 @@ files:
 - 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