airbrake-ruby 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ab4ce2485ab1b938a76f15f2b71d92db0fe6e0e2
-  data.tar.gz: a48ae79d2523577c1400d2ed6b914e5340e9f5ff
+  metadata.gz: 4447483250d34ac608ceac9356647902e55a8c58
+  data.tar.gz: 550d498d5f8f36b5cff9a4f02a45e813646c2833
 SHA512:
-  metadata.gz: 05d26b46d931156979aa32411b8d722c46023056eee2d0545be53df86a26e5ee565640a59999ddd37d1b947db44f113ac6dc636df5e9b6cb800682d66ef87c55
-  data.tar.gz: ec26b798eb2c9139ffbd44a0bd42385886663fade0ddcab147ea0b6d68b94c4635813398fe9c2b0b4e87398d26099751d016900e3b026cfac79acd0dc29d9998
+  metadata.gz: 4913a170dcebd29645730f83bba8135a251b07f77f57933eefcaa596b22ad44db84599dbe444ea8bd6fcee57407351f4e1caab8c9d71b292506aa8a89242894e
+  data.tar.gz: d471bba8e00eb16117d6eb8a8842becff961f69d7e3fedfe878fa94939c2aad5919bf9ed5393c91e875995b07de2c4c3c4ae72839b1c600ac4a97f021d651176

data/lib/airbrake-ruby.rb

@@ -8,6 +8,7 @@ require 'socket'
 require 'airbrake-ruby/version'
 require 'airbrake-ruby/config'
 require 'airbrake-ruby/config/validator'
+require 'airbrake-ruby/promise'
 require 'airbrake-ruby/sync_sender'
 require 'airbrake-ruby/async_sender'
 require 'airbrake-ruby/response'
@@ -55,6 +56,7 @@ require 'airbrake-ruby/notifier'
 #   Airbrake.notify('Oops', params, :my_other_project)
 #
 # @see Airbrake::Notifier
+# @since v1.0.0
 module Airbrake
   ##
   # The general error that this library uses when it wants to raise.
@@ -64,11 +66,6 @@ module Airbrake
   # @return [String] the label to be prepended to the log output
   LOG_LABEL = '**Airbrake:'.freeze
 
-  ##
-  # @return [Boolean] true if current Ruby is Ruby 1.9.*. The result is used
-  #   for special cases where we need to work around older implementations
-  RUBY_19 = RUBY_VERSION.start_with?('1.9')
-
   ##
   # @return [Boolean] true if current Ruby is Ruby 2.0.*. The result is used
   #   for special cases where we need to work around older implementations
@@ -140,7 +137,7 @@ module Airbrake
     # @param [Hash] params The additional payload to be sent to Airbrake. Can
     #   contain any values. The provided values will be displayed in the Params
     #   tab in your project's dashboard
-    # @return [nil]
+    # @return [Airbrake::Promise]
     # @see .notify_sync
     def notify(exception, params = {}, notifier = :default)
       call_notifier(notifier, __method__, exception, params)
@@ -156,7 +153,6 @@ module Airbrake
     #
     # @return [Hash{String=>String}] the reponse from the server
     # @see .notify
-    # @since v5.0.0
     def notify_sync(exception, params = {}, notifier = :default)
       call_notifier(notifier, __method__, exception, params)
     end
@@ -187,7 +183,6 @@ module Airbrake
     # @yieldparam [Airbrake::Notice]
     # @yieldreturn [void]
     # @return [void]
-    # @since v5.0.0
     # @note Once a filter was added, there's no way to delete it
     def add_filter(filter = nil, notifier = :default, &block)
       call_notifier(notifier, __method__, filter, &block)
@@ -209,7 +204,6 @@ module Airbrake
     # @param [Hash] params The additional params attached to the notice
     # @return [Airbrake::Notice] the notice built with help of the given
     #   arguments
-    # @since v5.0.0
     def build_notice(exception, params = {}, notifier = :default)
       call_notifier(notifier, __method__, exception, params)
     end
@@ -225,7 +219,6 @@ module Airbrake
     #   Airbrake.notify('App crashed!') #=> raises Airbrake::Error
     #
     # @return [void]
-    # @since v5.0.0
     def close(notifier = :default)
       call_notifier(notifier, __method__)
     end
@@ -242,8 +235,6 @@ module Airbrake
     # @option deploy_params [Symbol] :revision
     # @option deploy_params [Symbol] :version
     # @return [void]
-    # @since v5.0.0
-    # @api private
     def create_deploy(deploy_params, notifier = :default)
       call_notifier(notifier, __method__, deploy_params)
     end

data/lib/airbrake-ruby/async_sender.rb

@@ -5,6 +5,8 @@ module Airbrake
   # (both values are configurable).
   #
   # @see SyncSender
+  # @api private
+  # @since v1.0.0
   class AsyncSender
     ##
     # @param [Airbrake::Config] config
@@ -23,12 +25,12 @@ module Airbrake
     #
     # @param [Airbrake::Notice] notice A notice that was generated by the
     #   library
-    # @return [nil]
-    def send(notice)
+    # @return [Airbrake::Promise]
+    def send(notice, promise)
       return will_not_deliver(notice) if @unsent.size >= @unsent.max
 
-      @unsent << notice
-      nil
+      @unsent << [notice, promise]
+      promise
     end
 
     ##
@@ -48,7 +50,7 @@ module Airbrake
           @config.logger.debug(msg + ' (Ctrl-C to abort)')
         end
 
-        @config.workers.times { @unsent << :stop }
+        @config.workers.times { @unsent << [:stop, Airbrake::Promise.new] }
         @closed = true
         @workers.list.dup
       end
@@ -100,8 +102,9 @@ module Airbrake
 
     def spawn_worker
       Thread.new do
-        while (notice = @unsent.pop) != :stop
-          @sender.send(notice)
+        while (message = @unsent.pop)
+          break if message.first == :stop
+          @sender.send(*message)
         end
       end
     end

data/lib/airbrake-ruby/backtrace.rb

@@ -10,6 +10,9 @@ module Airbrake
   #   rescue
   #     Backtrace.parse($!, Logger.new(STDOUT))
   #   end
+  #
+  # @api private
+  # @since v1.0.0
   module Backtrace
     module Patterns
       ##
@@ -32,6 +35,8 @@ module Airbrake
           (?<file>
             (?:uri:classloader:/.+(?=:)) # Matches '/META-INF/jruby.home/protocol.rb'
             |
+            (?:uri_3a_classloader_3a_.+(?=:)) # Matches 'uri_3a_classloader_3a_/gems/...'
+            |
             [^:]+        # Matches 'NewlineNode.java'
           )
           :?
@@ -151,8 +156,8 @@ module Airbrake
         return false unless defined?(ExecJS::RuntimeError)
         return true if exception.is_a?(ExecJS::RuntimeError)
 
-        if Airbrake::RUBY_19 || Airbrake::RUBY_20
-          # Ruby 1.9 doesn't support Exception#cause. We work around this by
+        if Airbrake::RUBY_20
+          # Ruby <2.1 doesn't support Exception#cause. We work around this by
           # parsing backtraces. It's slow, so we check only a few first frames.
           exception.backtrace[0..2].each do |frame|
             return true if frame =~ Patterns::EXECJS_SIMPLIFIED

data/lib/airbrake-ruby/config.rb

@@ -2,6 +2,9 @@ module Airbrake
   ##
   # Represents the Airbrake config. A config contains all the options that you
   # can use to configure an Airbrake instance.
+  #
+  # @api private
+  # @since v1.0.0
   class Config
     ##
     # @return [Integer] the project identificator. This value *must* be set.
@@ -103,7 +106,7 @@ module Airbrake
       @endpoint ||=
         begin
           self.host = ('https://' << host) if host !~ %r{\Ahttps?://}
-          api = "/api/v3/projects/#{project_id}/notices?key=#{project_key}"
+          api = "api/v3/projects/#{project_id}/notices?key=#{project_key}"
           URI.join(host, api)
         end
     end
@@ -163,10 +166,5 @@ module Airbrake
     rescue NoMethodError
       raise Airbrake::Error, "unknown option '#{option}'"
     end
-
-    def set_endpoint(id, key, host)
-      host = ('https://' << host) if host !~ %r{\Ahttps?://}
-      @endpoint = URI.join(host, "/api/v3/projects/#{id}/notices?key=#{key}")
-    end
   end
 end

data/lib/airbrake-ruby/filter_chain.rb

@@ -2,7 +2,10 @@ module Airbrake
   ##
   # Represents the mechanism for filtering notices. Defines a few default
   # filters.
+  #
   # @see Airbrake.add_filter
+  # @api private
+  # @since v1.0.0
   class FilterChain
     ##
     # Replaces paths to gems with a placeholder.

data/lib/airbrake-ruby/nested_exception.rb

@@ -2,6 +2,9 @@ module Airbrake
   ##
   # A class that is capable of unwinding nested exceptions and representing them
   # as JSON-like hash.
+  #
+  # @api private
+  # @since v1.0.4
   class NestedException
     ##
     # @return [Integer] the maximum number of nested exceptions that a notice

data/lib/airbrake-ruby/notice.rb

@@ -2,6 +2,8 @@ module Airbrake
   ##
   # Represents a chunk of information that is meant to be either sent to
   # Airbrake or ignored completely.
+  #
+  # @since v1.0.0
   # rubocop:disable Metrics/ClassLength
   class Notice
     ##
@@ -54,6 +56,12 @@ module Airbrake
     # @return [String] the name of the host machine
     HOSTNAME = Socket.gethostname.freeze
 
+    ##
+    # @since v1.7.0
+    # @return [Hash{Symbol=>Object}] the hash with arbitrary objects to be used
+    #   in filters
+    attr_reader :stash
+
     def initialize(config, exception, params = {})
       @config = config
 
@@ -64,6 +72,7 @@ module Airbrake
         session: {},
         params: params
       }
+      @stash = {}
 
       extract_custom_attributes(exception)
 
@@ -140,6 +149,17 @@ module Airbrake
     private
 
     def context(params)
+      # DEPRECATION: remove the following code in the next MINOR release.
+      if params.key?(:component) || params.key?(:action)
+        @config.logger.warn(
+          "#{LOG_LABEL} passing component/action keys in the params hash is " \
+          "deprecated and will be removed soon. Please update your code to use " \
+          "`Airbrake.build_notice` and set these keys like this:\n" \
+          "  notice[:context][:component] = 'mycomponent'\n" \
+          "  notice[:context][:action] = 'myaction'"
+        )
+      end
+
       ctx = {
         version: @config.app_version,
         # We ensure that root_directory is always a String, so it can always be
@@ -148,6 +168,7 @@ module Airbrake
         rootDirectory: @config.root_directory.to_s,
         environment: @config.environment,
 
+        # DEPRECATION: remove the following code in the next MINOR release.
         # Legacy Airbrake v4 behaviour.
         component: params.delete(:component),
         action: params.delete(:action),

data/lib/airbrake-ruby/notifier.rb

@@ -5,7 +5,7 @@ module Airbrake
   #
   # @see Airbrake::Config The list of options
   # @api private
-  # @since v5.0.0
+  # @since v1.0.0
   class Notifier
     ##
     # @return [String] the label to be prepended to the log output
@@ -49,14 +49,13 @@ module Airbrake
     ##
     # @macro see_public_api_method
     def notify(exception, params = {})
-      send_notice(exception, params)
-      nil
+      send_notice(exception, params, default_sender)
     end
 
     ##
     # @macro see_public_api_method
     def notify_sync(exception, params = {})
-      send_notice(exception, params, @sync_sender)
+      send_notice(exception, params, @sync_sender).value
     end
 
     ##
@@ -95,7 +94,9 @@ module Airbrake
       host = @config.endpoint.to_s.split(@config.endpoint.path).first
       path = "/api/v4/projects/#{@config.project_id}/deploys?key=#{@config.project_key}"
 
-      @sync_sender.send(deploy_params, URI.join(host, path))
+      promise = Airbrake::Promise.new
+      @sync_sender.send(deploy_params, promise, URI.join(host, path))
+      promise
     end
 
     private
@@ -114,14 +115,19 @@ module Airbrake
       e
     end
 
-    def send_notice(exception, params, sender = default_sender)
-      return if @config.ignored_environment?
+    def send_notice(exception, params, sender)
+      promise = Airbrake::Promise.new
+      if @config.ignored_environment?
+        return promise.reject("The '#{@config.environment}' environment is ignored")
+      end
 
       notice = build_notice(exception, params)
       @filter_chain.refine(notice)
-      return if notice.ignored?
+      if notice.ignored?
+        return promise.reject("#{notice} was marked as ignored")
+      end
 
-      sender.send(notice)
+      sender.send(notice, promise)
     end
 
     def default_sender

data/lib/airbrake-ruby/payload_truncator.rb

@@ -2,6 +2,9 @@ module Airbrake
   ##
   # This class is responsible for truncation of too big objects. Mainly, you
   # should use it for simple objects such as strings, hashes, & arrays.
+  #
+  # @api private
+  # @since v1.0.0
   class PayloadTruncator
     ##
     # @return [Hash] the options for +String#encode+
@@ -10,7 +13,7 @@ module Airbrake
     ##
     # @return [String] the temporary encoding to be used when fixing invalid
     #   strings with +ENCODING_OPTIONS+
-    TEMP_ENCODING = (RUBY_VERSION == '1.9.2' ? 'iso-8859-1' : 'utf-16')
+    TEMP_ENCODING = 'utf-16'.freeze
 
     ##
     # @param [Integer] max_size maximum size of hashes, arrays and strings
@@ -99,12 +102,6 @@ module Airbrake
     ##
     # Replaces invalid characters in string with arbitrary encoding.
     #
-    # For Ruby 1.9.2 the method converts encoding of +str+ to +iso-8859-1+ to
-    # avoid a bug when encoding options are no-op, when `#encode` is given the
-    # same encoding as the receiver's encoding.
-    #
-    # For modern Rubies we use UTF-16 as a safe alternative.
-    #
     # @param [String] str The string to replace characters
     # @return [String] a UTF-8 encoded string
     # @note This method mutates +str+ unless it's frozen,

data/lib/airbrake-ruby/promise.rb

@@ -0,0 +1,103 @@
+module Airbrake
+  ##
+  # Represents a simplified promise object (similar to promises found in
+  # JavaScript), which allows chaining callbacks that are executed when the
+  # promise is either resolved or rejected.
+  #
+  # @see https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Promise
+  # @see https://github.com/ruby-concurrency/concurrent-ruby/blob/master/lib/concurrent/promise.rb
+  # @since v1.7.0
+  class Promise
+    ##
+    # @return [Hash<String,String>] either successful response containing the
+    #   `id` key or unsuccessful response containing the `error` key
+    attr_reader :value
+
+    def initialize
+      @on_resolved = []
+      @on_rejected = []
+      @value = {}
+      @mutex = Mutex.new
+    end
+
+    ##
+    # Attaches a callback to be executed when the promise is resolved.
+    #
+    # @example
+    #   Airbrake::Promise.new.then { |response| puts response }
+    #   #=> {"id"=>"00054415-8201-e9c6-65d6-fc4d231d2871",
+    #   #    "url"=>"http://localhost/locate/00054415-8201-e9c6-65d6-fc4d231d2871"}
+    #
+    # @yield [response]
+    # @yieldparam response [Hash<String,String>] Contains the `id` & `url` keys
+    # @return [self]
+    def then(&block)
+      @mutex.synchronize do
+        if @value.key?('id')
+          yield(@value)
+          return self
+        end
+
+        @on_resolved << block
+      end
+
+      self
+    end
+
+    ##
+    # Attaches a callback to be executed when the promise is rejected.
+    #
+    # @example
+    #   Airbrake::Promise.new.rescue { |error| raise error }
+    #
+    # @yield [error] The error message from the API
+    # @yieldparam error [String]
+    # @return [self]
+    def rescue(&block)
+      @mutex.synchronize do
+        if @value.key?('error')
+          yield(@value['error'])
+          return self
+        end
+
+        @on_rejected << block
+      end
+
+      self
+    end
+
+    ##
+    # Resolves the promise.
+    #
+    # @example
+    #   Airbrake::Promise.new.resolve('id' => '123')
+    #
+    # @param response [Hash<String,String>]
+    # @return [self]
+    def resolve(response)
+      @mutex.synchronize do
+        @value = response
+        @on_resolved.each { |callback| callback.call(response) }
+      end
+
+      self
+    end
+
+    ##
+    # Rejects the promise.
+    #
+    # @example
+    #   Airbrake::Promise.new.reject('Something went wrong')
+    #
+    # @param error [String]
+    # @return [self]
+    def reject(error)
+      @mutex.synchronize do
+        @value['error'] = error
+        @on_rejected.each { |callback| callback.call(error) }
+      end
+
+      self
+    end
+  end
+end

data/lib/airbrake-ruby/response.rb

@@ -2,6 +2,9 @@ module Airbrake
   ##
   # Parses responses coming from the Airbrake API. Handles HTTP errors by
   # logging them.
+  #
+  # @api private
+  # @since v1.0.0
   module Response
     ##
     # @return [Integer] the limit of the response body
@@ -35,7 +38,7 @@ module Airbrake
       rescue => ex
         body_msg = truncated_body(body)
         logger.error("#{LOG_LABEL} error while parsing body (#{ex}). Body: #{body_msg}")
-        { 'error' => ex }
+        { 'error' => ex.inspect }
       end
     end
 

data/lib/airbrake-ruby/sync_sender.rb

@@ -3,6 +3,8 @@ module Airbrake
   # Responsible for sending notices to Airbrake synchronously. Supports proxies.
   #
   # @see AsyncSender
+  # @api private
+  # @since v1.0.0
   class SyncSender
     ##
     # @return [String] body for HTTP requests
@@ -20,15 +22,14 @@ module Airbrake
     # @param [Airbrake::Notice] notice
     # @param [Airbrake::Notice] endpoint
     # @return [Hash{String=>String}] the parsed HTTP response
-    def send(notice, endpoint = @config.endpoint)
+    def send(notice, promise, endpoint = @config.endpoint)
       response = nil
       req = build_post_request(endpoint, notice)
 
       if req.body.nil?
-        @config.logger.error(
-          "#{LOG_LABEL} notice was not sent because of missing body"
-        )
-        return
+        reason = "#{LOG_LABEL} notice was not sent because of missing body"
+        @config.logger.error(reason)
+        return promise.reject(reason)
       end
 
       https = build_https(endpoint)
@@ -36,11 +37,14 @@ module Airbrake
       begin
         response = https.request(req)
       rescue => ex
-        @config.logger.error("#{LOG_LABEL} HTTP error: #{ex}")
-        return
+        reason = "#{LOG_LABEL} HTTP error: #{ex}"
+        @config.logger.error(reason)
+        return promise.reject(reason)
       end
 
-      Response.parse(response, @config.logger)
+      parsed_resp = Response.parse(response, @config.logger)
+      return promise.reject(parsed_resp['error']) if parsed_resp.key?('error')
+      promise.resolve(parsed_resp)
     end
 
     private

data/lib/airbrake-ruby/version.rb

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

data/spec/async_sender_spec.rb

@@ -17,7 +17,7 @@ RSpec.describe Airbrake::AsyncSender do
       expect(sender).to have_workers
 
       notice = Airbrake::Notice.new(config, AirbrakeTestError.new)
-      notices_count.times { sender.send(notice) }
+      notices_count.times { sender.send(notice, Airbrake::Promise.new) }
       sender.close
 
       log = stdout.string.split("\n")
@@ -49,7 +49,7 @@ RSpec.describe Airbrake::AsyncSender do
     context "when there are some unsent notices" do
       before do
         notice = Airbrake::Notice.new(Airbrake::Config.new, AirbrakeTestError.new)
-        300.times { @sender.send(notice) }
+        300.times { @sender.send(notice, Airbrake::Promise.new) }
         expect(@sender.instance_variable_get(:@unsent).size).not_to be_zero
         @sender.close
       end

data/spec/backtrace_spec.rb

@@ -80,14 +80,18 @@ RSpec.describe Airbrake::Backtrace do
       let(:backtrace) do
         # rubocop:disable Metrics/LineLength
         ['uri_3a_classloader_3a_.META_minus_INF.jruby_dot_home.lib.ruby.stdlib.net.protocol.rbuf_fill(uri:classloader:/META-INF/jruby.home/lib/ruby/stdlib/net/protocol.rb:158)',
-         'bin.processors.image_uploader.block in make_streams(bin/processors/image_uploader.rb:21)']
+         'bin.processors.image_uploader.block in make_streams(bin/processors/image_uploader.rb:21)',
+         'uri_3a_classloader_3a_.gems.faye_minus_websocket_minus_0_dot_10_dot_5.lib.faye.websocket.api.invokeOther13:dispatch_event(uri_3a_classloader_3a_/gems/faye_minus_websocket_minus_0_dot_10_dot_5/lib/faye/websocket/uri:classloader:/gems/faye-websocket-0.10.5/lib/faye/websocket/api.rb:109)',
+         'tmp.jruby9022301782566983632extract.$dot.META_minus_INF.rails.file(/tmp/jruby9022301782566983632extract/./META-INF/rails.rb:13)']
         # rubocop:enable Metrics/LineLength
       end
 
       let(:parsed_backtrace) do
         # rubocop:disable Metrics/LineLength
         [{ file: 'uri:classloader:/META-INF/jruby.home/lib/ruby/stdlib/net/protocol.rb', line: 158, function: 'uri_3a_classloader_3a_.META_minus_INF.jruby_dot_home.lib.ruby.stdlib.net.protocol.rbuf_fill' },
-         { file: 'bin/processors/image_uploader.rb', line: 21, function: 'bin.processors.image_uploader.block in make_streams' }]
+         { file: 'bin/processors/image_uploader.rb', line: 21, function: 'bin.processors.image_uploader.block in make_streams' },
+         { file: 'uri_3a_classloader_3a_/gems/faye_minus_websocket_minus_0_dot_10_dot_5/lib/faye/websocket/uri:classloader:/gems/faye-websocket-0.10.5/lib/faye/websocket/api.rb', line: 109, function: 'uri_3a_classloader_3a_.gems.faye_minus_websocket_minus_0_dot_10_dot_5.lib.faye.websocket.api.invokeOther13:dispatch_event' },
+         { file: '/tmp/jruby9022301782566983632extract/./META-INF/rails.rb', line: 13, function: 'tmp.jruby9022301782566983632extract.$dot.META_minus_INF.rails.file' }]
         # rubocop:enable Metrics/LineLength
       end
 
@@ -242,12 +246,12 @@ RSpec.describe Airbrake::Backtrace do
            function: 'realtime' }]
       end
 
-      context "when not on Ruby 1.9" do
+      context "when not on Ruby 2.0" do
         let(:ex) { ExecJS::RuntimeError.new.tap { |e| e.set_backtrace(bt) } }
 
         it "returns a properly formatted array of hashes" do
           stub_const('ExecJS::RuntimeError', AirbrakeTestError)
-          stub_const('Airbrake::RUBY_19', false)
+          stub_const('Airbrake::RUBY_20', false)
 
           expect(
             described_class.parse(ex, Logger.new('/dev/null'))
@@ -255,7 +259,7 @@ RSpec.describe Airbrake::Backtrace do
         end
       end
 
-      context "when on Ruby 1.9" do
+      context "when on Ruby 2.0" do
         context "and when exception's class isn't ExecJS" do
           let(:ex) do
             ActionView::Template::Error.new.tap { |e| e.set_backtrace(bt) }
@@ -264,7 +268,7 @@ RSpec.describe Airbrake::Backtrace do
           it "returns a properly formatted array of hashes" do
             stub_const('ActionView::Template::Error', AirbrakeTestError)
             stub_const('ExecJS::RuntimeError', NameError)
-            stub_const('Airbrake::RUBY_19', true)
+            stub_const('Airbrake::RUBY_20', true)
 
             expect(
               described_class.parse(ex, Logger.new('/dev/null'))

data/spec/config_spec.rb

@@ -229,4 +229,29 @@ RSpec.describe Airbrake::Config do
       end
     end
   end
+
+  describe "#endpoint" do
+    context "when host is configured with a URL with a slug" do
+      before do
+        config.project_id = 1
+        config.project_key = '2'
+      end
+
+      context "and with a trailing slash" do
+        it "sets the endpoint with the slug" do
+          config.host = 'https://localhost/bingo/'
+          expect(config.endpoint.to_s).
+            to eq('https://localhost/bingo/api/v3/projects/1/notices?key=2')
+        end
+      end
+
+      context "and without a trailing slash" do
+        it "sets the endpoint without the slug" do
+          config.host = 'https://localhost/bingo'
+          expect(config.endpoint.to_s).
+            to eq('https://localhost/api/v3/projects/1/notices?key=2')
+        end
+      end
+    end
+  end
 end

data/spec/notice_spec.rb

@@ -237,4 +237,12 @@ RSpec.describe Airbrake::Notice do
         to raise_error(Airbrake::Error, 'Got Object value, wanted a Hash')
     end
   end
+
+  describe "#stash" do
+    it "returns a hash" do
+      obj = Object.new
+      notice.stash[:bingo_object] = obj
+      expect(notice.stash[:bingo_object]).to eql(obj)
+    end
+  end
 end

data/spec/notifier_spec.rb

@@ -23,7 +23,10 @@ RSpec.describe Airbrake::Notifier do
   let(:ex) { AirbrakeTestError.new }
 
   before do
-    stub_request(:post, endpoint).to_return(status: 201, body: '{}')
+    # rubocop:disable Metrics/LineLength
+    body = '{"id":"00054414-b147-6ffa-85d6-1524d83362a6","url":"http://localhost/locate/00054414-b147-6ffa-85d6-1524d83362a6"}'
+    # rubocop:enable Metrics/LineLength
+    stub_request(:post, endpoint).to_return(status: 201, body: body)
     @airbrake = described_class.new(airbrake_params)
   end
 
@@ -58,6 +61,15 @@ RSpec.describe Airbrake::Notifier do
   end
 
   describe "#notify_sync" do
+    it "returns a hash with error id & url" do
+      expect(@airbrake.notify_sync(ex)).to(
+        eq(
+          'id' => '00054414-b147-6ffa-85d6-1524d83362a6',
+          'url' => 'http://localhost/locate/00054414-b147-6ffa-85d6-1524d83362a6'
+        )
+      )
+    end
+
     describe "first argument" do
       context "when it is a Notice" do
         it "sends the argument" do
@@ -372,8 +384,8 @@ RSpec.describe Airbrake::Notifier do
       expect_a_request_with_body(/params":{"bingo":"bango"}/)
     end
 
-    it "returns nil" do
-      expect(@airbrake.notify(ex)).to be_nil
+    it "returns a promise" do
+      expect(@airbrake.notify(ex)).to be_an(Airbrake::Promise)
       sleep 1
     end
 

data/spec/notifier_spec/options_spec.rb

@@ -143,7 +143,7 @@ RSpec.describe Airbrake::Notifier do
       it "is being used if configured" do
         @airbrake.notify_sync(ex)
 
-        proxied_request = requests.pop
+        proxied_request = requests.pop(true)
 
         expect(proxied_request.header['proxy-authorization'].first).
           to eq('Basic dXNlcjpwYXNzd29yZA==')
@@ -210,7 +210,8 @@ RSpec.describe Airbrake::Notifier do
           airbrake = described_class.new(airbrake_params.merge(params))
 
           expect(Airbrake::Notice).not_to receive(:new)
-          expect(airbrake.notify_sync(ex)).to be_nil
+          expect(airbrake.notify_sync(ex)).
+            to eq('error' => "The 'development' environment is ignored")
           expect(a_request(:post, endpoint)).not_to have_been_made
         end
       end

data/spec/payload_truncator_spec.rb

@@ -409,12 +409,7 @@ RSpec.describe Airbrake::PayloadTruncator do
           @truncator.truncate_object(params)
 
           expect(params[:unicode].length).to eq(max_len - 1)
-
-          if RUBY_VERSION == '1.9.2'
-            expect(params[:unicode]).to match(/\A?{#{max_size - 1}}\[Truncated\]\z/)
-          else
-            expect(params[:unicode]).to match(/\A€{#{max_size - 1}}\[Truncated\]\z/)
-          end
+          expect(params[:unicode]).to match(/\A€{#{max_size - 1}}\[Truncated\]\z/)
         end
       end
 
@@ -425,12 +420,7 @@ RSpec.describe Airbrake::PayloadTruncator do
         it "converts strings to valid UTF-8" do
           @truncator.truncate_object(params)
 
-          if RUBY_VERSION == '1.9.2'
-            expect(params[:unicode]).to eq('bad string??')
-          else
-            expect(params[:unicode]).to match(/\Abad string€[�\?]\z/)
-          end
-
+          expect(params[:unicode]).to match(/\Abad string€[�\?]\z/)
           expect { params.to_json }.not_to raise_error
         end
 

data/spec/promise_spec.rb

@@ -0,0 +1,169 @@
+require 'spec_helper'
+
+RSpec.describe Airbrake::Promise do
+  subject { described_class.new }
+
+  describe ".then" do
+    let(:resolved_with) { [] }
+    let(:rejected_with) { [] }
+
+    context "when it is not resolved" do
+      it "returns self" do
+        expect(subject.then {}).to eq(subject)
+      end
+
+      it "doesn't call the resolve callbacks yet" do
+        subject.then { resolved_with << 1 }.then { resolved_with << 2 }
+        expect(resolved_with).to be_empty
+      end
+    end
+
+    context "when it is resolved" do
+      shared_examples "then specs" do
+        it "returns self" do
+          expect(subject.then {}).to eq(subject)
+        end
+
+        it "yields the resolved value" do
+          yielded = nil
+          subject.then { |value| yielded = value }
+          expect(yielded).to eq('id' => '123')
+        end
+
+        it "calls the resolve callbacks" do
+          expect(resolved_with).to match_array([1, 2])
+        end
+
+        it "doesn't call the reject callbacks" do
+          expect(rejected_with).to be_empty
+        end
+      end
+
+      context "and there are some resolve and reject callbacks in place" do
+        before do
+          subject.then { resolved_with << 1 }.then { resolved_with << 2 }
+          subject.rescue { rejected_with << 1 }.rescue { rejected_with << 2 }
+          subject.resolve('id' => '123')
+        end
+
+        include_examples "then specs"
+
+        it "registers the resolve callbacks" do
+          subject.resolve('id' => '456')
+          expect(resolved_with).to match_array([1, 2, 1, 2])
+        end
+      end
+
+      context "and additional then callbacks are added" do
+        before do
+          subject.resolve('id' => '123')
+          subject.then { resolved_with << 1 }.then { resolved_with << 2 }
+        end
+
+        include_examples "then specs"
+
+        it "doesn't register new resolve callbacks" do
+          subject.resolve('id' => '456')
+          expect(resolved_with).to match_array([1, 2])
+        end
+      end
+    end
+  end
+
+  describe ".rescue" do
+    let(:resolved_with) { [] }
+    let(:rejected_with) { [] }
+
+    context "when it is not rejected" do
+      it "returns self" do
+        expect(subject.then {}).to eq(subject)
+      end
+
+      it "doesn't call the reject callbacks yet" do
+        subject.rescue { rejected_with << 1 }.rescue { rejected_with << 2 }
+        expect(rejected_with).to be_empty
+      end
+    end
+
+    context "when it is rejected" do
+      shared_examples "rescue specs" do
+        it "returns self" do
+          expect(subject.rescue {}).to eq(subject)
+        end
+
+        it "yields the rejected value" do
+          yielded = nil
+          subject.rescue { |value| yielded = value }
+          expect(yielded).to eq('bingo')
+        end
+
+        it "doesn't call the resolve callbacks" do
+          expect(resolved_with).to be_empty
+        end
+
+        it "calls the reject callbacks" do
+          expect(rejected_with).to match_array([1, 2])
+        end
+      end
+
+      context "and there are some resolve and reject callbacks in place" do
+        before do
+          subject.then { resolved_with << 1 }.then { resolved_with << 2 }
+          subject.rescue { rejected_with << 1 }.rescue { rejected_with << 2 }
+          subject.reject('bingo')
+        end
+
+        include_examples "rescue specs"
+
+        it "registers the reject callbacks" do
+          subject.reject('bingo again')
+          expect(rejected_with).to match_array([1, 2, 1, 2])
+        end
+      end
+
+      context "and additional reject callbacks are added" do
+        before do
+          subject.reject('bingo')
+          subject.rescue { rejected_with << 1 }.rescue { rejected_with << 2 }
+        end
+
+        include_examples "rescue specs"
+
+        it "doesn't register new reject callbacks" do
+          subject.reject('bingo again')
+          expect(rejected_with).to match_array([1, 2])
+        end
+      end
+    end
+  end
+
+  describe ".resolve" do
+    it "returns self" do
+      expect(subject.resolve(1)).to eq(subject)
+    end
+
+    it "executes callbacks attached with .then" do
+      array = []
+      subject.then { |notice_id| array << notice_id }.rescue { array << 999 }
+
+      expect(array.size).to be_zero
+      subject.resolve(1)
+      expect(array).to match_array([1])
+    end
+  end
+
+  describe ".reject" do
+    it "returns self" do
+      expect(subject.reject(1)).to eq(subject)
+    end
+
+    it "executes callbacks attached with .rescue" do
+      array = []
+      subject.then { array << 1 }.rescue { |error| array << error }
+
+      expect(array.size).to be_zero
+      subject.reject(999)
+      expect(array).to match_array([999])
+    end
+  end
+end

data/spec/sync_sender_spec.rb

@@ -12,7 +12,9 @@ RSpec.describe Airbrake::SyncSender do
   end
 
   describe "#send" do
-    it "catches exceptions raised when sending" do
+    let(:promise) { Airbrake::Promise.new }
+
+    it "catches exceptions raised while sending" do
       stdout = StringIO.new
       config = Airbrake::Config.new(logger: Logger.new(stdout))
       sender = described_class.new(config)
@@ -20,7 +22,8 @@ RSpec.describe Airbrake::SyncSender do
       https = double("foo")
       allow(sender).to receive(:build_https).and_return(https)
       allow(https).to receive(:request).and_raise(StandardError.new('foo'))
-      expect(sender.send(notice)).to be_nil
+      expect(sender.send(notice, promise)).to be_an(Airbrake::Promise)
+      expect(promise.value).to eq('error' => '**Airbrake: HTTP error: foo')
       expect(stdout.string).to match(/ERROR -- : .+ HTTP error: foo/)
     end
 
@@ -43,7 +46,9 @@ RSpec.describe Airbrake::SyncSender do
         sender = described_class.new(config)
         notice = Airbrake::Notice.new(config, ex)
 
-        expect(sender.send(notice)).to be_nil
+        expect(sender.send(notice, promise)).to be_an(Airbrake::Promise)
+        expect(promise.value).
+          to match('error' => '**Airbrake: notice was not sent because of missing body')
         expect(stdout.string).to match(/ERROR -- : .+ notice was not sent/)
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: airbrake-ruby
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Airbrake Technologies, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-18 00:00:00.000000000 Z
+date: 2017-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '2.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: benchmark-ips
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.47'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.47'
 description: |
   Airbrake Ruby is a plain Ruby notifier for Airbrake (https://airbrake.io), the
   leading exception reporting service. Airbrake Ruby provides minimalist API that
@@ -109,6 +123,7 @@ files:
 - lib/airbrake-ruby/notice.rb
 - lib/airbrake-ruby/notifier.rb
 - lib/airbrake-ruby/payload_truncator.rb
+- lib/airbrake-ruby/promise.rb
 - lib/airbrake-ruby/response.rb
 - lib/airbrake-ruby/sync_sender.rb
 - lib/airbrake-ruby/version.rb
@@ -125,6 +140,7 @@ files:
 - spec/notifier_spec/options_spec.rb
 - spec/notifier_spec/whitelist_keys_spec.rb
 - spec/payload_truncator_spec.rb
+- spec/promise_spec.rb
 - spec/spec_helper.rb
 - spec/sync_sender_spec.rb
 homepage: https://airbrake.io
@@ -139,7 +155,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -147,7 +163,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Ruby notifier for https://airbrake.io
@@ -165,5 +181,6 @@ test_files:
 - spec/notifier_spec/whitelist_keys_spec.rb
 - spec/notifier_spec.rb
 - spec/payload_truncator_spec.rb
+- spec/promise_spec.rb
 - spec/spec_helper.rb
 - spec/sync_sender_spec.rb