airbrake-ruby 4.6.0

data/spec/time_truncate_spec.rb

@@ -0,0 +1,13 @@
+RSpec.describe Airbrake::TimeTruncate do
+  describe "#utc_truncate_minutes" do
+    it "truncates time to the floor minute and returns an RFC3339 timestamp" do
+      time = Time.new(2018, 1, 1, 0, 0, 20, 0)
+      expect(subject.utc_truncate_minutes(time)).to eq('2018-01-01T00:00:00+00:00')
+    end
+
+    it "converts time with zone to UTC" do
+      time = Time.new(2018, 1, 1, 0, 0, 20, '-05:00')
+      expect(subject.utc_truncate_minutes(time)).to eq('2018-01-01T05:00:00+00:00')
+    end
+  end
+end

data/spec/timed_trace_spec.rb

@@ -0,0 +1,125 @@
+RSpec.describe Airbrake::TimedTrace do
+  describe ".span" do
+    it "returns a timed trace" do
+      expect(described_class.span('operation') {}).to be_a(described_class)
+    end
+
+    it "returns a timed trace with a stopped span" do
+      timed_trace = described_class.span('operation') {}
+      expect(timed_trace.spans).to match('operation' => be > 0)
+    end
+  end
+
+  describe "#span" do
+    it "captures a span" do
+      subject.span('operation') {}
+      expect(subject.spans).to match('operation' => be > 0)
+    end
+  end
+
+  describe "#start_span" do
+    context "when called once" do
+      it "returns true" do
+        expect(subject.start_span('operation')).to eq(true)
+      end
+    end
+
+    context "when called multiple times" do
+      before { subject.start_span('operation') }
+
+      it "returns false" do
+        expect(subject.start_span('operation')).to eq(false)
+      end
+    end
+
+    context "when another span was started" do
+      before { subject.start_span('operation') }
+
+      it "returns true" do
+        expect(subject.start_span('another operation')).to eq(true)
+      end
+    end
+
+    context "when #spans was called" do
+      before { subject.start_span('operation') }
+
+      it "returns spans with zero values" do
+        expect(subject.spans).to eq('operation' => 0.0)
+      end
+    end
+  end
+
+  describe "#stop_span" do
+    context "when #start_span wasn't invoked" do
+      it "returns false" do
+        expect(subject.stop_span('operation')).to eq(false)
+      end
+    end
+
+    context "when #start_span was invoked" do
+      before { subject.start_span('operation') }
+
+      it "returns true" do
+        expect(subject.stop_span('operation')).to eq(true)
+      end
+    end
+
+    context "when multiple spans were started" do
+      before do
+        subject.start_span('operation')
+        subject.start_span('another operation')
+      end
+
+      context "and when stopping in LIFO order" do
+        it "returns true for all spans" do
+          expect(subject.stop_span('another operation')).to eq(true)
+          expect(subject.stop_span('operation')).to eq(true)
+        end
+      end
+
+      context "and when stopping in FIFO order" do
+        it "returns true for all spans" do
+          expect(subject.stop_span('operation')).to eq(true)
+          expect(subject.stop_span('another operation')).to eq(true)
+        end
+      end
+    end
+  end
+
+  describe "#spans" do
+    context "when no spans were captured" do
+      it "returns an empty hash" do
+        expect(subject.spans).to eq({})
+      end
+    end
+
+    context "when a span was captured" do
+      before do
+        subject.start_span('operation')
+        subject.stop_span('operation')
+      end
+
+      it "returns a Hash with the corresponding span" do
+        subject.stop_span('operation')
+        expect(subject.spans).to match('operation' => be > 0)
+      end
+    end
+
+    context "when multiple spans were captured" do
+      before do
+        subject.start_span('operation')
+        subject.stop_span('operation')
+
+        subject.start_span('another operation')
+        subject.stop_span('another operation')
+      end
+
+      it "returns a Hash with all spans" do
+        expect(subject.spans).to match(
+          'operation' => be > 0,
+          'another operation' => be > 0
+        )
+      end
+    end
+  end
+end

data/spec/truncator_spec.rb

@@ -0,0 +1,238 @@
+RSpec.describe Airbrake::Truncator do
+  def multiply_by_2_max_len(chr)
+    chr * 2 * max_len
+  end
+
+  describe "#truncate" do
+    let(:max_size) { 3 }
+    let(:truncated) { '[Truncated]' }
+    let(:max_len) { max_size + truncated.length }
+
+    subject { described_class.new(max_size).truncate(object) }
+
+    context "given a frozen string" do
+      let(:object) { multiply_by_2_max_len('a') }
+
+      it "returns a new truncated frozen string" do
+        expect(subject.length).to eq(max_len)
+        expect(subject).to be_frozen
+      end
+    end
+
+    context "given a frozen hash of strings" do
+      let(:object) do
+        {
+          banana: multiply_by_2_max_len('a'),
+          kiwi: multiply_by_2_max_len('b'),
+          strawberry: 'c',
+          shrimp: 'd'
+        }.freeze
+      end
+
+      it "returns a new truncated frozen hash" do
+        expect(subject.size).to eq(max_size)
+        expect(subject).to be_frozen
+
+        expect(subject).to eq(
+          banana: 'aaa[Truncated]', kiwi: 'bbb[Truncated]', strawberry: 'c'
+        )
+        expect(subject[:banana]).to be_frozen
+        expect(subject[:kiwi]).to be_frozen
+        expect(subject[:strawberry]).not_to be_frozen
+      end
+    end
+
+    context "given a frozen array of strings" do
+      let(:object) do
+        [
+          multiply_by_2_max_len('a'),
+          'b',
+          multiply_by_2_max_len('c'),
+          'd'
+        ].freeze
+      end
+
+      it "returns a new truncated frozen array" do
+        expect(subject.size).to eq(max_size)
+        expect(subject).to be_frozen
+
+        expect(subject).to eq(['aaa[Truncated]', 'b', 'ccc[Truncated]'])
+        expect(subject[0]).to be_frozen
+        expect(subject[1]).not_to be_frozen
+        expect(subject[2]).to be_frozen
+      end
+    end
+
+    context "given a frozen set of strings" do
+      let(:object) do
+        Set.new([
+          multiply_by_2_max_len('a'),
+          'b',
+          multiply_by_2_max_len('c'),
+          'd'
+        ]).freeze
+      end
+
+      it "returns a new truncated frozen array" do
+        expect(subject.size).to eq(max_size)
+        expect(subject).to be_frozen
+
+        expect(subject).to eq(
+          Set.new(['aaa[Truncated]', 'b', 'ccc[Truncated]'])
+        )
+        expect(subject).to be_frozen
+      end
+    end
+
+    context "given an arbitrary frozen object that responds to #to_json" do
+      let(:object) do
+        obj = Object.new
+        def obj.to_json
+          '{"object":"shrimp"}'
+        end
+        obj.freeze
+      end
+
+      it "converts the object to truncated JSON" do
+        expect(subject.length).to eq(max_len)
+        expect(subject).to be_frozen
+
+        expect(subject).to eq('{"o[Truncated]')
+      end
+    end
+
+    context "given an arbitrary object that doesn't respond to #to_json" do
+      let(:object) do
+        obj = Object.new
+        allow(obj).to receive(:to_json)
+          .and_raise(Airbrake::Notice::JSON_EXCEPTIONS.first)
+        obj
+      end
+
+      it "converts the object to a truncated string" do
+        expect(subject.length).to eq(max_len)
+        expect(subject).to eq('#<O[Truncated]')
+      end
+    end
+
+    shared_examples 'self returning objects' do |object|
+      it "returns the passed object" do
+        expect(described_class.new(max_size).truncate(object)).to eql(object)
+      end
+    end
+
+    [1, true, false, :symbol, nil].each do |object|
+      include_examples 'self returning objects', object
+    end
+
+    context "given a recursive array" do
+      let(:object) do
+        a = %w[aaaaa bb]
+        a << a
+        a << 'c'
+        a
+      end
+
+      it "prevents recursion" do
+        expect(subject).to eq(['aaa[Truncated]', 'bb', '[Circular]'])
+      end
+    end
+
+    context "given a recursive array with recursive hashes" do
+      let(:object) do
+        a = []
+        a << a
+
+        h = {}
+        h[:k] = h
+        a << h << 'aaaa'
+      end
+
+      it "prevents recursion" do
+        expect(subject).to eq(['[Circular]', { k: '[Circular]' }, 'aaa[Truncated]'])
+        expect(subject).to be_frozen
+      end
+    end
+
+    context "given a recursive set with recursive arrays" do
+      let(:object) do
+        s = Set.new
+        s << s
+
+        h = {}
+        h[:k] = h
+        s << h << 'aaaa'
+      end
+
+      it "prevents recursion" do
+        expect(subject).to eq(
+          Set.new(['[Circular]', { k: '[Circular]' }, 'aaa[Truncated]'])
+        )
+        expect(subject).to be_frozen
+      end
+    end
+
+    context "given a hash with long strings" do
+      let(:object) do
+        {
+          a: multiply_by_2_max_len('a'),
+          b: multiply_by_2_max_len('b'),
+          c: { d: multiply_by_2_max_len('d'), e: 'e' }
+        }
+      end
+
+      it "truncates the long strings" do
+        expect(subject).to eq(
+          a: 'aaa[Truncated]', b: 'bbb[Truncated]', c: { d: 'ddd[Truncated]', e: 'e' }
+        )
+        expect(subject).to be_frozen
+      end
+    end
+
+    context "given a string with valid unicode characters" do
+      let(:object) { "€€€€€" }
+
+      it "truncates the string" do
+        expect(subject).to eq("€€€[Truncated]")
+      end
+    end
+
+    context "given an ASCII-8BIT string with invalid characters" do
+      let(:object) do
+        # Shenanigans to get a bad ASCII-8BIT string. Direct conversion raises error.
+        encoded = Base64.encode64("\xD3\xE6\xBC\x9D\xBA").encode!('ASCII-8BIT')
+        Base64.decode64(encoded).freeze
+      end
+
+      it "converts and truncates the string to UTF-8" do
+        expect(subject).to eq("���[Truncated]")
+        expect(subject).to be_frozen
+      end
+    end
+
+    context "given an array with hashes and hash-like objects with identical keys" do
+      let(:hashie) { Class.new(Hash) }
+
+      let(:object) do
+        {
+          errors: [
+            { file: 'a' },
+            { file: 'a' },
+            hashie.new.merge(file: 'bcde')
+          ]
+        }
+      end
+
+      it "truncates values" do
+        expect(subject).to eq(
+          errors: [
+            { file: 'a' },
+            { file: 'a' },
+            hashie.new.merge(file: 'bcd[Truncated]')
+          ]
+        )
+        expect(subject).to be_frozen
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,213 @@
+--- !ruby/object:Gem::Specification
+name: airbrake-ruby
+version: !ruby/object:Gem::Version
+  version: 4.6.0
+platform: ruby
+authors:
+- Airbrake Technologies, Inc.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-08-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rbtree3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+description: |
+  Airbrake Ruby is a plain Ruby notifier for Airbrake (https://airbrake.io), the
+  leading exception reporting service. Airbrake Ruby provides minimalist API that
+  enables the ability to send any Ruby exception to the Airbrake dashboard. The
+  library is extremely lightweight and it perfectly suits plain Ruby applications.
+  For apps that are built with Rails, Sinatra or any other Rack-compliant web
+  framework we offer the airbrake gem (https://github.com/airbrake/airbrake). It
+  has additional features such as reporting of any unhandled exceptions
+  automatically, integrations with Resque, Sidekiq, Delayed Job and many more.
+email: support@airbrake.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/airbrake-ruby.rb
+- lib/airbrake-ruby/async_sender.rb
+- lib/airbrake-ruby/backtrace.rb
+- lib/airbrake-ruby/benchmark.rb
+- lib/airbrake-ruby/code_hunk.rb
+- lib/airbrake-ruby/config.rb
+- lib/airbrake-ruby/config/validator.rb
+- lib/airbrake-ruby/deploy_notifier.rb
+- lib/airbrake-ruby/file_cache.rb
+- lib/airbrake-ruby/filter_chain.rb
+- lib/airbrake-ruby/filters/context_filter.rb
+- lib/airbrake-ruby/filters/dependency_filter.rb
+- lib/airbrake-ruby/filters/exception_attributes_filter.rb
+- lib/airbrake-ruby/filters/gem_root_filter.rb
+- lib/airbrake-ruby/filters/git_last_checkout_filter.rb
+- lib/airbrake-ruby/filters/git_repository_filter.rb
+- lib/airbrake-ruby/filters/git_revision_filter.rb
+- lib/airbrake-ruby/filters/keys_blacklist.rb
+- lib/airbrake-ruby/filters/keys_filter.rb
+- lib/airbrake-ruby/filters/keys_whitelist.rb
+- lib/airbrake-ruby/filters/root_directory_filter.rb
+- lib/airbrake-ruby/filters/sql_filter.rb
+- lib/airbrake-ruby/filters/system_exit_filter.rb
+- lib/airbrake-ruby/filters/thread_filter.rb
+- lib/airbrake-ruby/hash_keyable.rb
+- lib/airbrake-ruby/ignorable.rb
+- lib/airbrake-ruby/inspectable.rb
+- lib/airbrake-ruby/loggable.rb
+- lib/airbrake-ruby/monotonic_time.rb
+- lib/airbrake-ruby/nested_exception.rb
+- lib/airbrake-ruby/notice.rb
+- lib/airbrake-ruby/notice_notifier.rb
+- lib/airbrake-ruby/performance_breakdown.rb
+- lib/airbrake-ruby/performance_notifier.rb
+- lib/airbrake-ruby/promise.rb
+- lib/airbrake-ruby/query.rb
+- lib/airbrake-ruby/request.rb
+- lib/airbrake-ruby/response.rb
+- lib/airbrake-ruby/stashable.rb
+- lib/airbrake-ruby/stat.rb
+- lib/airbrake-ruby/sync_sender.rb
+- lib/airbrake-ruby/tdigest.rb
+- lib/airbrake-ruby/time_truncate.rb
+- lib/airbrake-ruby/timed_trace.rb
+- lib/airbrake-ruby/truncator.rb
+- lib/airbrake-ruby/version.rb
+- spec/airbrake_spec.rb
+- spec/async_sender_spec.rb
+- spec/backtrace_spec.rb
+- spec/benchmark_spec.rb
+- spec/code_hunk_spec.rb
+- spec/config/validator_spec.rb
+- spec/config_spec.rb
+- spec/deploy_notifier_spec.rb
+- spec/file_cache.rb
+- spec/filter_chain_spec.rb
+- spec/filters/context_filter_spec.rb
+- spec/filters/dependency_filter_spec.rb
+- spec/filters/exception_attributes_filter_spec.rb
+- spec/filters/gem_root_filter_spec.rb
+- spec/filters/git_last_checkout_filter_spec.rb
+- spec/filters/git_repository_filter.rb
+- spec/filters/git_revision_filter_spec.rb
+- spec/filters/keys_blacklist_spec.rb
+- spec/filters/keys_whitelist_spec.rb
+- spec/filters/root_directory_filter_spec.rb
+- spec/filters/sql_filter_spec.rb
+- spec/filters/system_exit_filter_spec.rb
+- spec/filters/thread_filter_spec.rb
+- spec/fixtures/notroot.txt
+- spec/fixtures/project_root/code.rb
+- spec/fixtures/project_root/empty_file.rb
+- spec/fixtures/project_root/long_line.txt
+- spec/fixtures/project_root/short_file.rb
+- spec/fixtures/project_root/vendor/bundle/ignored_file.rb
+- spec/helpers.rb
+- spec/ignorable_spec.rb
+- spec/inspectable_spec.rb
+- spec/monotonic_time_spec.rb
+- spec/nested_exception_spec.rb
+- spec/notice_notifier_spec.rb
+- spec/notice_notifier_spec/options_spec.rb
+- spec/notice_spec.rb
+- spec/performance_breakdown_spec.rb
+- spec/performance_notifier_spec.rb
+- spec/promise_spec.rb
+- spec/query_spec.rb
+- spec/request_spec.rb
+- spec/response_spec.rb
+- spec/spec_helper.rb
+- spec/stashable_spec.rb
+- spec/stat_spec.rb
+- spec/sync_sender_spec.rb
+- spec/tdigest_spec.rb
+- spec/time_truncate_spec.rb
+- spec/timed_trace_spec.rb
+- spec/truncator_spec.rb
+homepage: https://airbrake.io
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14.4
+signing_key: 
+specification_version: 4
+summary: Ruby notifier for https://airbrake.io
+test_files:
+- spec/truncator_spec.rb
+- spec/benchmark_spec.rb
+- spec/helpers.rb
+- spec/filters/exception_attributes_filter_spec.rb
+- spec/filters/root_directory_filter_spec.rb
+- spec/filters/sql_filter_spec.rb
+- spec/filters/keys_whitelist_spec.rb
+- spec/filters/system_exit_filter_spec.rb
+- spec/filters/thread_filter_spec.rb
+- spec/filters/dependency_filter_spec.rb
+- spec/filters/context_filter_spec.rb
+- spec/filters/git_last_checkout_filter_spec.rb
+- spec/filters/git_revision_filter_spec.rb
+- spec/filters/keys_blacklist_spec.rb
+- spec/filters/gem_root_filter_spec.rb
+- spec/filters/git_repository_filter.rb
+- spec/spec_helper.rb
+- spec/notice_spec.rb
+- spec/config_spec.rb
+- spec/performance_breakdown_spec.rb
+- spec/tdigest_spec.rb
+- spec/async_sender_spec.rb
+- spec/stat_spec.rb
+- spec/backtrace_spec.rb
+- spec/notice_notifier_spec.rb
+- spec/time_truncate_spec.rb
+- spec/promise_spec.rb
+- spec/config/validator_spec.rb
+- spec/sync_sender_spec.rb
+- spec/ignorable_spec.rb
+- spec/deploy_notifier_spec.rb
+- spec/performance_notifier_spec.rb
+- spec/airbrake_spec.rb
+- spec/nested_exception_spec.rb
+- spec/timed_trace_spec.rb
+- spec/request_spec.rb
+- spec/filter_chain_spec.rb
+- spec/response_spec.rb
+- spec/file_cache.rb
+- spec/code_hunk_spec.rb
+- spec/fixtures/notroot.txt
+- spec/fixtures/project_root/long_line.txt
+- spec/fixtures/project_root/empty_file.rb
+- spec/fixtures/project_root/code.rb
+- spec/fixtures/project_root/short_file.rb
+- spec/fixtures/project_root/vendor/bundle/ignored_file.rb
+- spec/monotonic_time_spec.rb
+- spec/inspectable_spec.rb
+- spec/stashable_spec.rb
+- spec/query_spec.rb
+- spec/notice_notifier_spec/options_spec.rb