rollday 0.3.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d2c78b5cc1611bf2a6d2766ffbd66df911882fc62e2fbcf3575450113c71e4b2
-  data.tar.gz: 2bc833d5d56efe20e819c66ec503074fe058444dc65f7640b393fab268782c04
+  metadata.gz: 1dcbfc77cb4787f580d9c4b6cde2f8b85949686c33c38cfe8cc5e7f111774785
+  data.tar.gz: b3b50b20c3261233417a8b2e890773a6ed64567a7c06a8d050ed8c367b907faa
 SHA512:
-  metadata.gz: 8f6a73ebb75e6854044f29da60c3cb98c68efd6f7dae56b66efbbe66c55847fbfdf08016c6dfacd520e261cec4162c263c7c227802c64303085e8260211cc2bc
-  data.tar.gz: f80905eebdc8af2e5dcff399dc3ad5ff42de2c3c75fbaf7b20b5139d8cec527237bb0a14acc6b32d90b337ef57b4254c5a7ee8fedf011db0ee9fde709af55373
+  metadata.gz: '029ad6bf6bf727a915a3db8e6dc3d9c89650eb5603af6f5b1d774df6fd90ab57777a81eb723d9f7aa7cc2498e712cd4dec6bc08e7a38d9e4103909501c9c0f3f'
+  data.tar.gz: 78cf9981e07d0dde0197749416e086e7499d27d459e5edf40d7b99b9ba97a26b08fa4d84a5262e7722878d4c287c70baa04d15d53a5666ffe77d2990642dc934

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

@@ -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,10 +1,14 @@
 # frozen_string_literal: true
 
-require "rollday/use_middleware"
+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,
@@ -12,67 +16,30 @@ module Rollday
       ERROR = :error,
       CRITICAL = :critical
     ]
+    DEFAULT_ROLLBAR_LEVEL = WARNING
 
     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
+    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
+      return -> {} unless use_person_scope
 
       @person_scope || Rollbar.scope.scope_object.raw[:person] || -> {}
     end
@@ -84,5 +51,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

@@ -14,7 +14,7 @@ module Rollday
       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)
+      Rollday.config.exception_class.new(message)
     end
 
     def rollbar_scope(result)
@@ -36,8 +36,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.3.0"
+  VERSION = "0.5.1"
 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

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.3.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Matt Taylor
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-06-24 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
@@ -119,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