faraday-sunset 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0a4675801498e8f952508acc69b12825f110e1a7
-  data.tar.gz: bbb3c14239abbb25c0c24f67f2776d8e1d1b69e8
+  metadata.gz: f6342c56ae356cacca2ee93a523cfd41ae6fb3a2
+  data.tar.gz: 51c570dc5dd9a71c7c4ed7b5429c61f491d4bc19
 SHA512:
-  metadata.gz: ae1f5afed75ae1d006fdec6e9dfb2deb2d5a49cce5993c778e9f12dc29246ab215b8d6f28c36075c82cde1dea3414836748eae5bed5dc48543f75e2679413c09
-  data.tar.gz: ebdbb6af58e65b1154acec7e0afc39c10ad33b3faee4b637fccc19d9846000f8e5098bab3f9ad64160cf2d04212e4e2072e24833c8bda6fc4a8a1c7be16491cb
+  metadata.gz: e0eafaceef2453b4006b6c59431f744b3980779ccf767a8be85cd43a656cc2a08aac97a3a742cec089d1f922cf5ca365f574297738a783f0822dc5e2f7d86a35
+  data.tar.gz: c59f5b3dea7b9f9fcd2400e03e1ba420ddcf06cd8bee220805951c4d82098a9060e10c12226d52176b29d4d56f251a55e90d33329cdd767406c634d2fa40e973

data/README.md

@@ -38,10 +38,24 @@ connection = Faraday.new(url: '...') do |conn|
   conn.response :sunset, active_support: true
   # or
   conn.response :sunset, logger: Rails.logger
+  # or
+  conn.response :sunset, rollbar: true
+  # or combine:
+  conn.response :sunset, rollbar: :auto, active_support: true, logger: Rails.logger
 end
 ```
 
-You can [configure `ActiveSupport::Deprecation`][active-support-deprecation] to warn in a few different ways, or pass in any object that acts a bit like a Rack logger, Rails logger, or anything with a `warn` method that takes a string.
+For `logger`, You can pass in any object that acts a bit like a Rack logger, Rails logger, or anything with a `warn` method that takes a string.
+
+You can [configure `ActiveSupport::Deprecation`][active-support-deprecation] to warn in 3 ways:
+- `true` - throw warnings on sunsetted endpoints, and throw an error if active-support is missing from the project
+- `false` - ignore active-support
+- `:auto` - throw warnings on sunsetted endpoints, and ignore if active-support is missing from the project
+
+You can [configure `Rollbar`][rollbar] in 3 ways:
+- `true` - throw warnings on sunsetted endpoints, and throw an error if active-support is missing from the project
+- `false` - ignore rollbar
+- `:auto` - throw warnings on sunsetted endpoints, and ignore if Rollbar is missing from the project
 
 [active-support-deprecation]: http://api.rubyonrails.org/classes/ActiveSupport/Deprecation/Behavior.html
 

data/lib/faraday/sunset.rb

@@ -9,10 +9,11 @@ module Faraday
     # @param [Type] app describe app
     # @param [Hash] options = {}
     # @return void
-    def initialize(app, active_support: nil, logger: nil)
+    def initialize(app, active_support: nil, logger: nil, rollbar: nil)
       super(app)
       @active_support = active_support
       @logger = logger
+      @rollbar = rollbar
     end
 
     # @param [Faraday::Env] no idea what this does
@@ -46,18 +47,63 @@ module Faraday
 
     def send_warning!(warning)
       warned = false
-      if @active_support
-        ActiveSupport::Deprecation.warn(warning)
-        warned = true
+
+      if @active_support == :auto
+        warned = report_active_support(warned, warning)
+      elsif @active_support == true
+        warned = report_active_support!(warning)
       end
+
       if @logger && @logger.respond_to?(:warn)
         @logger.warn(warning)
         warned = true
       end
+
+      if @rollbar == :auto
+        warned = report_rollbar(warned, warning)
+      elsif @rollbar == true
+        warned = report_rollbar!(warning)
+      end
+
       unless warned
-        raise NoOutputForWarning, "Pass active_support: true, or logger: ::Logger.new when registering middleware"
+        raise NoOutputForWarning, "Pass active_support: (true|false|:auto), rollbar: (true|false|:auto), or logger: ::Logger.new when registering middleware"
       end
     end
+
+    private
+
+    def report_rollbar!(warning)
+      Rollbar.warning(warning)
+      # return true to set :warned
+      true
+    end
+
+    def report_active_support!(warning)
+      ActiveSupport::Deprecation.warn(warning)
+      # return true to set :warned
+      true
+    end
+
+    # :auto methods
+    # do not raise errors if gems are missing
+    def report_rollbar(warned, warning)
+      report_rollbar!(warning)
+
+    rescue NameError 
+      # rollbar is not present!
+      # do not modify warned if an error is raised
+      warned
+    end
+
+    def report_active_support(warned, warning)
+      report_active_support!(warning)
+
+    rescue NameError 
+      # active_support is not present!
+      # do not modify warned if an error is raised - return warned instead
+      warned
+    end
+
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faraday-sunset
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Phil Sturgeon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-20 00:00:00.000000000 Z
+date: 2018-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -44,6 +44,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
+- !ruby/object:Gem::Dependency
+  name: rollbar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -145,7 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Automatically detect deprecated HTTP endpoints