airbrake-ruby 2.3.2 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8fedcdefd7e46e06454e468865a2a9a6a5c6d54a
-  data.tar.gz: 870a24b542bd2503c83f62230c4627742bb7891c
+  metadata.gz: c845fb70bdbfade4ce4922090cf89ddb1d31dc8b
+  data.tar.gz: 322b65cb8938b1f8d102736cf0f95ee0a68bb3e6
 SHA512:
-  metadata.gz: a956495373f17953f7b2f587dfdf68e1e4cc1d51719903acde59f35bd8b38f0a7183da2c15e713d9bf13b252f355f54d83b3826e367731003312511d9a4b369a
-  data.tar.gz: 7193c4cbb25da97ed895c83309d3fc9cef392adec7ace13b38097e6caa3d609bb36d06ebc0c16a169668264da6011ccf27a3e0b9efb0c52803e4c4e06558b443
+  metadata.gz: 833738116b0076013905ebe90ac3fe582a3302682fc72037bdf17b1bd7e1eef4879ae3f58c1570b4bb8aa36b548805706e734a92532cc5622647affbfc25258f
+  data.tar.gz: fc6b031950da579efea3de3ea1bd78e08fef5dbf9793a12e39ed6318f8d17d578820c35bee1a99f9248c3a2153effd07ab16ef7f2349ee9e72a0334ed211901f

data/lib/airbrake-ruby/filters/keys_blacklist.rb

@@ -5,7 +5,10 @@ module Airbrake
     # list of parameters in the payload of a notice.
     #
     # @example
-    #   filter = Airbrake::Filters::KeysBlacklist.new(:email, /credit/i, 'password')
+    #   filter = Airbrake::Filters::KeysBlacklist.new(
+    #     Logger.new(STDOUT),
+    #     [:email, /credit/i, 'password']
+    #   )
     #   airbrake.add_filter(filter)
     #   airbrake.notify(StandardError.new('App crashed!'), {
     #     user: 'John'

data/lib/airbrake-ruby/filters/keys_filter.rb

@@ -31,6 +31,7 @@ module Airbrake
       # Creates a new KeysBlacklist or KeysWhitelist filter that uses the given
       # +patterns+ for filtering a notice's payload.
       #
+      # @param [Logger, #error] logger
       # @param [Array<String,Regexp,Symbol>] patterns
       def initialize(logger, patterns)
         @logger = logger

data/lib/airbrake-ruby/filters/keys_whitelist.rb

@@ -5,7 +5,10 @@ module Airbrake
     # notice, but specified keys.
     #
     # @example
-    #   filter = Airbrake::Filters::KeysWhitelist.new(:email, /user/i, 'account_id')
+    #   filter = Airbrake::Filters::KeysBlacklist.new(
+    #     Logger.new(STDOUT),
+    #     [:email, /credit/i, 'password']
+    #   )
     #   airbrake.add_filter(filter)
     #   airbrake.notify(StandardError.new('App crashed!'), {
     #     user: 'John',

data/lib/airbrake-ruby/notice.rb

@@ -70,7 +70,9 @@ module Airbrake
       @payload = {
         errors: NestedException.new(exception, @config.logger).as_json,
         context: context,
-        environment: {},
+        environment: {
+          program_name: $PROGRAM_NAME
+        },
         session: {},
         params: params
       }
@@ -198,7 +200,7 @@ module Airbrake
 
       begin
         attributes = exception.to_airbrake
-      rescue => ex
+      rescue StandardError => ex
         @config.logger.error(
           "#{LOG_LABEL} #{exception.class}#to_airbrake failed: #{ex.class}: #{ex}"
         )

data/lib/airbrake-ruby/response.rb

@@ -10,12 +10,17 @@ module Airbrake
     # @return [Integer] the limit of the response body
     TRUNCATE_LIMIT = 100
 
+    ##
+    # @return [Integer] HTTP code returned when an IP sends over 10k/min notices
+    TOO_MANY_REQUESTS = 429
+
     ##
     # Parses HTTP responses from the Airbrake API.
     #
     # @param [Net::HTTPResponse] response
     # @param [Logger] logger
     # @return [Hash{String=>String}] parsed response
+    # rubocop:disable Metrics/MethodLength
     def self.parse(response, logger)
       code = response.code.to_i
       body = response.body
@@ -26,21 +31,27 @@ module Airbrake
           parsed_body = JSON.parse(body)
           logger.debug("#{LOG_LABEL} #{parsed_body}")
           parsed_body
-        when 400, 401, 403, 429
+        when 400, 401, 403, 420
           parsed_body = JSON.parse(body)
           logger.error("#{LOG_LABEL} #{parsed_body['message']}")
           parsed_body
+        when TOO_MANY_REQUESTS
+          parsed_body = JSON.parse(body)
+          msg = "#{LOG_LABEL} #{parsed_body['message']}"
+          logger.error(msg)
+          { 'error' => msg, 'rate_limit_reset' => rate_limit_reset(response) }
         else
           body_msg = truncated_body(body)
           logger.error("#{LOG_LABEL} unexpected code (#{code}). Body: #{body_msg}")
           { 'error' => body_msg }
         end
-      rescue => ex
+      rescue StandardError => ex
         body_msg = truncated_body(body)
         logger.error("#{LOG_LABEL} error while parsing body (#{ex}). Body: #{body_msg}")
         { 'error' => ex.inspect }
       end
     end
+    # rubocop:enable Metrics/MethodLength
 
     def self.truncated_body(body)
       if body.nil?
@@ -52,5 +63,10 @@ module Airbrake
       end
     end
     private_class_method :truncated_body
+
+    def self.rate_limit_reset(response)
+      Time.now + response['X-RateLimit-Delay'].to_i
+    end
+    private_class_method :rate_limit_reset
   end
 end

data/lib/airbrake-ruby/sync_sender.rb

@@ -14,6 +14,7 @@ module Airbrake
     # @param [Airbrake::Config] config
     def initialize(config)
       @config = config
+      @rate_limit_reset = Time.now
     end
 
     ##
@@ -23,26 +24,28 @@ module Airbrake
     # @param [Airbrake::Notice] endpoint
     # @return [Hash{String=>String}] the parsed HTTP response
     def send(notice, promise, endpoint = @config.endpoint)
+      return promise if rate_limited_ip?(promise)
+
       response = nil
       req = build_post_request(endpoint, notice)
 
-      if req.body.nil?
-        reason = "#{LOG_LABEL} notice was not sent because of missing body"
-        @config.logger.error(reason)
-        return promise.reject(reason)
-      end
+      return promise if missing_body?(req, promise)
 
       https = build_https(endpoint)
 
       begin
         response = https.request(req)
-      rescue => ex
+      rescue StandardError => ex
         reason = "#{LOG_LABEL} HTTP error: #{ex}"
         @config.logger.error(reason)
         return promise.reject(reason)
       end
 
       parsed_resp = Response.parse(response, @config.logger)
+      if parsed_resp.key?('rate_limit_reset')
+        @rate_limit_reset = parsed_resp['rate_limit_reset']
+      end
+
       return promise.reject(parsed_resp['error']) if parsed_resp.key?('error')
       promise.resolve(parsed_resp)
     end
@@ -76,5 +79,23 @@ module Airbrake
       [@config.proxy[:host], @config.proxy[:port], @config.proxy[:user],
        @config.proxy[:password]]
     end
+
+    def rate_limited_ip?(promise)
+      rate_limited = Time.now < @rate_limit_reset
+      promise.reject("#{LOG_LABEL} IP is rate limited") if rate_limited
+      rate_limited
+    end
+
+    def missing_body?(req, promise)
+      missing = req.body.nil?
+
+      if missing
+        reason = "#{LOG_LABEL} notice was not sent because of missing body"
+        @config.logger.error(reason)
+        promise.reject(reason)
+      end
+
+      missing
+    end
   end
 end

data/lib/airbrake-ruby/version.rb

@@ -4,5 +4,5 @@
 module Airbrake
   ##
   # @return [String] the library version
-  AIRBRAKE_RUBY_VERSION = '2.3.2'.freeze
+  AIRBRAKE_RUBY_VERSION = '2.4.0'.freeze
 end

data/spec/notice_spec.rb

@@ -204,6 +204,11 @@ RSpec.describe Airbrake::Notice do
     it "defaults to the error severity" do
       expect(notice.to_json).to match(/"context":{.*"severity":"error".*}/)
     end
+
+    it "always contains environment/program_name" do
+      expect(notice.to_json).
+        to match(%r|"environment":{"program_name":.+/exe/rspec.*|)
+    end
   end
 
   describe "#[]" do

data/spec/notifier_spec.rb

@@ -1,5 +1,3 @@
-# coding: utf-8
-
 require 'spec_helper'
 
 RSpec.describe Airbrake::Notifier do
@@ -225,9 +223,15 @@ RSpec.describe Airbrake::Notifier do
                          /ERROR -- : .+ Project not found or access denied./
       end
 
-      context "the rate-limit message" do
-        include_examples 'HTTP codes', 429, '{"message": "Project is rate limited."}',
-                         /ERROR -- : .+ Project is rate limited.+/
+      context "error 420" do
+        include_examples 'HTTP codes', 420,
+                         '{"message":"Project is rate limited."}',
+                         /ERROR -- : .+ Project is rate limited./
+      end
+
+      context "the IP rate limit message" do
+        include_examples 'HTTP codes', 429, '{"message": "IP is rate limited"}',
+                         /ERROR -- : .+ IP is rate limited/
       end
 
       context "the internal server error" do

data/spec/spec_helper.rb

@@ -43,11 +43,11 @@ class AirbrakeTestError < RuntimeError
     # rubocop:enable Metrics/LineLength
   end
 
-  # rubocop:disable Style/AccessorMethodName
+  # rubocop:disable Naming/AccessorMethodName
   def set_backtrace(backtrace)
     @backtrace = backtrace
   end
-  # rubocop:enable Style/AccessorMethodName
+  # rubocop:enable Naming/AccessorMethodName
 
   def message
     'App crashed!'
@@ -90,9 +90,9 @@ class Ruby21Error < RuntimeError
   end
 end
 
-puts <<EOS
+puts <<BANNER
 #{'#' * 80}
 # RUBY_VERSION: #{RUBY_VERSION}
 # RUBY_ENGINE: #{RUBY_ENGINE}
 #{'#' * 80}
-EOS
+BANNER

data/spec/sync_sender_spec.rb

@@ -13,12 +13,12 @@ RSpec.describe Airbrake::SyncSender do
 
   describe "#send" do
     let(:promise) { Airbrake::Promise.new }
+    let(:stdout) { StringIO.new }
+    let(:config) { Airbrake::Config.new(logger: Logger.new(stdout)) }
+    let(:sender) { described_class.new(config) }
+    let(:notice) { Airbrake::Notice.new(config, AirbrakeTestError.new) }
 
     it "catches exceptions raised while sending" do
-      stdout = StringIO.new
-      config = Airbrake::Config.new(logger: Logger.new(stdout))
-      sender = described_class.new(config)
-      notice = Airbrake::Notice.new(config, AirbrakeTestError.new)
       https = double("foo")
       allow(sender).to receive(:build_https).and_return(https)
       allow(https).to receive(:request).and_raise(StandardError.new('foo'))
@@ -40,10 +40,6 @@ RSpec.describe Airbrake::SyncSender do
         10.times { backtrace << "bin/rails:3:in `<#{bad_string}>'" }
         ex.set_backtrace(backtrace)
 
-        stdout = StringIO.new
-        config = Airbrake::Config.new(logger: Logger.new(stdout))
-
-        sender = described_class.new(config)
         notice = Airbrake::Notice.new(config, ex)
 
         expect(sender.send(notice, promise)).to be_an(Airbrake::Promise)
@@ -52,5 +48,37 @@ RSpec.describe Airbrake::SyncSender do
         expect(stdout.string).to match(/ERROR -- : .+ notice was not sent/)
       end
     end
+
+    context "when IP is rate limited" do
+      let(:endpoint) { %r{https://airbrake.io/api/v3/projects/notices} }
+
+      before do
+        stub_request(:post, endpoint).to_return(
+          status: 429,
+          body: '{"message":"IP is rate limited"}',
+          headers: { 'X-RateLimit-Delay' => '1' }
+        )
+      end
+
+      it "returns error" do
+        p1 = Airbrake::Promise.new
+        sender.send(notice, p1)
+        expect(p1.value).to match('error' => '**Airbrake: IP is rate limited')
+
+        p2 = Airbrake::Promise.new
+        sender.send(notice, p2)
+        expect(p2.value).to match('error' => '**Airbrake: IP is rate limited')
+
+        # Wait for X-RateLimit-Delay and then make a new request to make sure p2
+        # was ignored (no request made for it).
+        sleep 1
+
+        p3 = Airbrake::Promise.new
+        sender.send(notice, p3)
+        expect(p3.value).to match('error' => '**Airbrake: IP is rate limited')
+
+        expect(a_request(:post, endpoint)).to have_been_made.twice
+      end
+    end
   end
 end

data/spec/truncator_spec.rb

@@ -1,5 +1,3 @@
-# coding: utf-8
-
 require 'spec_helper'
 
 RSpec.describe Airbrake::Truncator do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: airbrake-ruby
 version: !ruby/object:Gem::Version
-  version: 2.3.2
+  version: 2.4.0
 platform: ruby
 authors:
 - Airbrake Technologies, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-26 00:00:00.000000000 Z
+date: 2017-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -86,14 +86,34 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.47'
+        version: '0.50'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.47'
+        version: '0.50'
+- !ruby/object:Gem::Dependency
+  name: public_suffix
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: |
   Airbrake Ruby is a plain Ruby notifier for Airbrake (https://airbrake.io), the
   leading exception reporting service. Airbrake Ruby provides minimalist API that