From 8c616a2790284377565f8bbf090ee312e4478961 Mon Sep 17 00:00:00 2001 From: Nate Berkopec Date: Mon, 4 May 2015 13:32:28 -0400 Subject: [PATCH] Deprecate #send overrides --- lib/raven/base.rb | 10 ++++++++-- lib/raven/client.rb | 10 ++++++++-- lib/raven/transports.rb | 2 +- lib/raven/transports/http.rb | 9 +++++++-- lib/raven/transports/udp.rb | 9 +++++++-- spec/raven/integration_spec.rb | 5 ++--- 6 files changed, 33 insertions(+), 12 deletions(-) diff --git a/lib/raven/base.rb b/lib/raven/base.rb index 871b6c1bf..2590f79db 100644 --- a/lib/raven/base.rb +++ b/lib/raven/base.rb @@ -79,8 +79,14 @@ def configure # @example # evt = Raven::Event.new(:message => "An error") # Raven.send(evt) - def send(evt) - client.send(evt) + def send_event(event) + client.send_event(event) + end + + def send(event) + Raven.logger.warn "DEPRECATION WARNING: Calling #send on Raven::Base will be \ + removed in Raven-Ruby 0.14! Use #send_event instead!" + client.send_event(event) end # Capture and process any exceptions from the given block, or globally if diff --git a/lib/raven/client.rb b/lib/raven/client.rb index c5245ba28..14338ccd0 100644 --- a/lib/raven/client.rb +++ b/lib/raven/client.rb @@ -21,7 +21,7 @@ def initialize(configuration) @state = ClientState.new end - def send(event) + def send_event(event) return false unless configuration_allows_sending # Convert to hash @@ -37,7 +37,7 @@ def send(event) content_type, encoded_data = encode(event) begin - transport.send(generate_auth_header, encoded_data, + transport.send_event(generate_auth_header, encoded_data, :content_type => content_type) rescue => e failed_send(e, event) @@ -49,6 +49,12 @@ def send(event) event end + def send(event) + Raven.logger.warn "DEPRECATION WARNING: Calling #send on a Client will be \ + removed in Raven-Ruby 0.14! Use #send_event instead!" + send_event(event) + end + private def configuration_allows_sending diff --git a/lib/raven/transports.rb b/lib/raven/transports.rb index bc274c5ed..0986dcba9 100644 --- a/lib/raven/transports.rb +++ b/lib/raven/transports.rb @@ -10,7 +10,7 @@ def initialize(configuration) @configuration = configuration end - def send#(auth_header, data, options = {}) + def send_event#(auth_header, data, options = {}) raise NotImplementedError.new('Abstract method not implemented') end diff --git a/lib/raven/transports/http.rb b/lib/raven/transports/http.rb index 3fca2037a..a82fbe7d2 100644 --- a/lib/raven/transports/http.rb +++ b/lib/raven/transports/http.rb @@ -6,8 +6,7 @@ module Raven module Transports class HTTP < Transport - - def send(auth_header, data, options = {}) + def send_event(auth_header, data, options = {}) project_id = self.configuration[:project_id] path = self.configuration[:path] + "/" @@ -20,6 +19,12 @@ def send(auth_header, data, options = {}) response end + def send(auth_header, data, options = {}) + Raven.logger.warn "DEPRECATION WARNING: Calling #send on a Transport will be \ + removed in Raven-Ruby 0.14! Use #send_event instead!" + send_event(auth_header, data, options) + end + private def conn diff --git a/lib/raven/transports/udp.rb b/lib/raven/transports/udp.rb index c9135529a..88eb0d748 100644 --- a/lib/raven/transports/udp.rb +++ b/lib/raven/transports/udp.rb @@ -6,11 +6,16 @@ module Raven module Transports class UDP < Transport - - def send(auth_header, data, _options = {}) + def send_event(auth_header, data, _options = {}) conn.send "#{auth_header}\n\n#{data}", 0 end + def send(auth_header, data, options = {}) + Raven.logger.warn "DEPRECATION WARNING: Calling #send on a Transport will be \ + removed in Raven-Ruby 0.14! Use #send_event instead!" + send_event(auth_header, data, options) + end + private def conn diff --git a/spec/raven/integration_spec.rb b/spec/raven/integration_spec.rb index 545906eed..8b7fb8bb4 100644 --- a/spec/raven/integration_spec.rb +++ b/spec/raven/integration_spec.rb @@ -55,11 +55,10 @@ config.http_adapter = [:test, stubs] end - expect(Raven.logger).to receive(:warn).exactly(1).times + expect(Raven.logger).to receive(:warn).exactly(2).times expect { Raven.capture_exception(build_exception) }.not_to raise_error stubs.verify_stubbed_calls - end example "timed backoff should prevent sends" do @@ -72,7 +71,7 @@ config.logger = Logger.new(io) end - expect_any_instance_of(Raven::Transports::HTTP).to receive(:send).exactly(1).times.and_raise(Faraday::Error::ConnectionFailed, "conn failed") + expect_any_instance_of(Raven::Transports::HTTP).to receive(:send_event).exactly(1).times.and_raise(Faraday::Error::ConnectionFailed, "conn failed") expect { Raven.capture_exception(build_exception) }.not_to raise_error expect(Raven.logger).to receive(:error).exactly(1).times