opbeat 2.0.0 → 3.0.0

data/spec/opbeat/trace_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+module Opbeat
+  describe Trace, mock_time: true do
+
+    describe "#initialize" do
+      it "has a timestamp" do
+        trace = Trace.new nil, 'test'
+        expect(trace.timestamp).to eq Time.now.utc.to_i
+      end
+    end
+
+    describe "#start" do
+      it "has a relative and absolute start time with a transaction" do
+        transaction = Transaction.new(nil, 'Test')
+        travel 400
+        trace = transaction.trace 'test-1' do
+          travel 100
+          transaction.trace 'test-2' do |t|
+            travel 100
+            t
+          end
+        end
+
+        expect(trace.signature).to eq 'test-2'
+        expect(trace.relative_start).to eq 100_000_000
+      end
+    end
+
+    describe "#done" do
+      it "sets duration" do
+        transaction = Transaction.new nil, 'Test'
+        trace = Trace.new(transaction, 'test').start transaction.start_time
+        travel 100
+        trace.done
+
+        expect(trace.duration).to eq 100_000_000
+        expect(trace).to be_done
+      end
+    end
+
+  end
+end

data/spec/opbeat/transaction_spec.rb

@@ -0,0 +1,98 @@
+require 'spec_helper'
+require 'opbeat'
+
+module Opbeat
+  describe Transaction, mock_time: true do
+
+    describe "#initialize" do
+      it "has a root trace, timestamp and start time" do
+        transaction = Transaction.new nil, 'Test'
+        expect(transaction.traces.length).to be 1
+        expect(transaction.timestamp).to eq 694224000
+        expect(transaction.start_time).to eq 694224000000000000
+      end
+    end
+
+    describe "#release" do
+      it "sets clients current transaction to nil" do
+        client = Struct.new(:current_transaction).new(1)
+        transaction = Transaction.new client, 'Test'
+        transaction.release
+        expect(client.current_transaction).to be_nil
+      end
+    end
+
+    describe "#done" do
+      it "it sets result, durations and ends root trace" do
+        transaction = Transaction.new nil, 'Test'
+
+        travel 100
+        transaction.done(200)
+
+        expect(transaction.result).to be 200
+        expect(transaction.traces.first).to be_done
+        expect(transaction.duration).to eq 100_000_000
+      end
+    end
+
+    describe "#submit" do
+      it "ends transaction and submits it to the client" do
+        client = double('client', submit_transaction: true, :current_transaction= => true)
+        transaction = Transaction.new client, 'Test'
+
+        travel 100
+        transaction.submit 200
+
+        expect(transaction.result).to be 200
+        expect(transaction).to be_done
+        expect(client).to have_received(:current_transaction=)
+        expect(client).to have_received(:submit_transaction).with transaction
+      end
+    end
+
+    describe "#running_traces" do
+      it "returns running traces" do
+        transaction = Transaction.new nil, 'Test'
+
+        transaction.trace 'test' do
+          travel 100
+        end
+
+        running_trace = transaction.trace 'test2'
+        travel 100
+
+        expect(transaction.running_traces).to eq [transaction.root_trace, running_trace]
+      end
+    end
+
+    describe "#trace" do
+      subject do
+        transaction = Transaction.new nil, 'Test'
+
+        travel 100
+
+        transaction.trace 'test' do
+          travel 100
+        end
+
+        transaction.done
+      end
+      it "creates a new trace" do
+        expect(subject.traces.length).to be 2
+      end
+      it "has root as a parent" do
+        expect(subject.traces.last.parents).to eq [subject.traces.first]
+      end
+      it "has a duration" do
+        expect(subject.traces.last.duration).to eq 100_000_000
+      end
+      it "has a relative start" do
+        expect(subject.traces.last.relative_start).to eq 100_000_000
+      end
+      it "has a total duration" do
+        expect(subject.duration).to eq 200_000_000
+      end
+    end
+
+  end
+end

data/spec/opbeat/util/inspector_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+module Opbeat
+  RSpec.describe Util::Inspector, start_without_worker: true, mock_time: true do
+
+    let(:transaction) do
+      Opbeat.transaction 'Test' do |transaction|
+        travel 10
+        Opbeat.trace('test 1', 'trace.test') do
+          travel 100
+          Opbeat.trace('test 2', 'trace.test') { travel 150 }
+          travel 50
+        end
+        travel 50
+        Opbeat.trace('test 3', 'trace.test') do
+          travel 100
+        end
+        travel 1
+
+        transaction
+      end
+    end
+    subject do
+      Util::Inspector.new.transaction(transaction, include_parents: true)
+    end
+
+    it "doesn't explode" do
+      expect { subject }.to_not raise_error
+    end
+
+    it "doesn't exceed it's length" do
+      expect(subject.split("\n").map(&:length).find { |l| l < 100 })
+    end
+
+    # preview
+    it "is beautiful" do
+      puts subject
+    end
+  end
+end

data/spec/opbeat/util_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+module Opbeat
+  RSpec.describe Util do
+
+    describe "#nearest_minute", mock_time: true do
+      it "normalizes to nearest minute" do
+        travel 125_000 # two minutes five secs
+        expect(Util.nearest_minute).to eq Time.utc(1992, 1, 1, 0, 2, 0)
+      end
+    end
+
+    describe "#ms", mock_time: true do
+      it "returns current ms since unix epoch" do
+        expect(Util.nanos).to eq 694224000000000000
+      end
+    end
+
+  end
+end

data/spec/opbeat/worker_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+module Opbeat
+  RSpec.describe Worker do
+
+    before do
+      @queue = Queue.new
+    end
+
+    let :worker do
+      config = build_config
+      Worker.new config, @queue, HttpClient.new(config)
+    end
+
+    describe "#run" do
+      context "during a loop" do
+        before { allow(worker).to receive(:loop).and_yield }
+
+        subject { Thread.new { worker.run }.join 0.01 }
+
+        it "does nothing with an empty queue" do
+          subject
+          expect(WebMock).to_not have_requested(:any, /.*/)
+        end
+
+        it "pops the queue" do
+          @queue << Worker::PostRequest.new('/errors/', {id: 1}.to_json)
+          @queue << Worker::PostRequest.new('/errors/', {id: 2}.to_json)
+
+          subject
+
+          expect(WebMock).to have_requested(:post, %r{/errors/$}).with(body: {id: 1})
+          expect(WebMock).to have_requested(:post, %r{/errors/$}).with(body: {id: 2})
+        end
+      end
+
+      context "can be stopped by sending a message" do
+        it "loops until stopped" do
+          thread = Thread.new do
+            worker.run
+          end
+
+          @queue << Worker::StopMessage.new
+
+          thread.join
+
+          expect(thread).to_not be_alive
+          expect(@queue).to be_empty
+        end
+      end
+    end
+
+  end
+end

data/spec/opbeat_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+RSpec.describe Opbeat do
+
+  it { should_not be_started }
+
+  describe "self.start!" do
+    it "delegates to client" do
+      conf = Opbeat::Configuration.new app_id: 'x', organization_id: 'y', secret_token: 'z'
+      expect(Opbeat::Client).to receive(:start!).with(conf) { true }
+      Opbeat.start! conf
+    end
+  end
+
+  it { should delegate :stop!, to: Opbeat }
+
+  describe "when Opbeat is started", start: true do
+    it { should be_started }
+
+    it { should delegate :transaction, to: Opbeat::Client.inst, args: ['Test', nil, nil] }
+    it { should delegate :trace, to: Opbeat::Client.inst, args: ['test', nil, {}] }
+    it { should delegate :report, to: Opbeat::Client.inst, args: [Exception.new, nil] }
+    it { should delegate :report_message, to: Opbeat::Client.inst, args: ["My message", nil] }
+    it { should delegate :release, to: Opbeat::Client.inst, args: [{}, {}] }
+    it { should delegate :capture, to: Opbeat::Client.inst }
+
+    describe "a block example", mock_time: true do
+      it "is done" do
+        transaction = Opbeat.transaction 'Test' do
+          travel 100
+          Opbeat.trace 'test1' do
+            travel 100
+            Opbeat.trace 'test1-1' do
+              travel 100
+            end
+            Opbeat.trace 'test1-2' do
+              travel 100
+            end
+            travel 100
+          end
+        end.done(true)
+
+        expect(transaction).to be_done
+        expect(transaction.duration).to eq 500_000_000
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -1,10 +1,83 @@
-require 'simplecov'
+ENV['RACK_ENV'] = 'test'
+
+require 'bundler/setup'
+Bundler.require :default
+require 'timecop'
+require 'webmock/rspec'
+
 SimpleCov.start
 
-def build_exception()
-  begin
-    1 / 0
-  rescue ZeroDivisionError => exception
-    return exception
+require 'opbeat'
+
+module Opbeat
+  class Configuration
+    # Override defaults to enable http (caught by WebMock) in test env
+    defaults = DEFAULTS.dup.merge enabled_environments: %{test}
+    remove_const(:DEFAULTS)
+    const_set(:DEFAULTS, defaults.freeze)
   end
 end
+
+RSpec.configure do |config|
+  config.before :each do
+    @request_stub = stub_request(:post, /intake\.opbeat\.com/)
+  end
+
+  config.around :each, mock_time: true do |example|
+    @date = Time.utc(1992, 1, 1)
+
+    def travel distance
+      Timecop.freeze(@date += distance / 1_000.0)
+    end
+
+    travel 0
+    example.run
+    Timecop.return
+  end
+
+  def build_config attrs = {}
+    Opbeat::Configuration.new({
+      app_id: 'x',
+      organization_id: 'y',
+      secret_token: 'z'
+    }.merge(attrs))
+  end
+
+  config.around :each, start: true do |example|
+    Opbeat.start! build_config
+    example.call
+    Opbeat::Client.inst.current_transaction = nil
+    Opbeat.stop!
+  end
+
+  config.around :each, start_without_worker: true do |example|
+    Opbeat.start! build_config(disable_worker: true)
+    example.call
+    Opbeat::Client.inst.current_transaction = nil
+    Opbeat.stop!
+  end
+end
+
+RSpec::Matchers.define :delegate do |method, opts|
+  to = opts[:to]
+  args = opts[:args]
+
+  match do |delegator|
+    unless to.respond_to?(method)
+      raise NoMethodError.new("no method :#{method} on #{to}")
+    end
+
+    if args
+      allow(to).to receive(method).with(*args) { true }
+    else
+      allow(to).to receive(method).with(no_args) { true }
+    end
+
+    delegator.send method, *args
+  end
+
+  description do
+    "delegate :#{method} to #{to}"
+  end
+end
+

metadata

@@ -1,135 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: opbeat
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
-- Thomas Watson Steen
-- Ron Cohen
-- Noah Kantrowitz
+- Mikkel Malmberg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-05 00:00:00.000000000 Z
+date: 2016-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: faraday
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.6
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '0.10'
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.6
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '0.10'
-- !ruby/object:Gem::Dependency
-  name: multi_json
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.7'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '2.14'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '2.14'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  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: delayed_job
-  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: sidekiq
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.17.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.17.0
+        version: 3.0.0
 description: 
 email: support@opbeat.com
 executables: []
@@ -141,59 +35,105 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- ".yardopts"
 - Gemfile
+- HISTORY.md
 - LICENSE
-- Makefile
 - README.md
 - Rakefile
-- gemfiles/rails30.gemfile
-- gemfiles/rails31.gemfile
-- gemfiles/rails32.gemfile
-- gemfiles/rails40.gemfile
-- gemfiles/rails41.gemfile
-- gemfiles/rails42.gemfile
-- gemfiles/ruby192_rails31.gemfile
-- gemfiles/ruby192_rails32.gemfile
-- gemfiles/sidekiq31.gemfile
+- gemfiles/Gemfile.base
+- gemfiles/Gemfile.rails-3.2.x
+- gemfiles/Gemfile.rails-4.0.x
+- gemfiles/Gemfile.rails-4.1.x
+- gemfiles/Gemfile.rails-4.2.x
 - lib/opbeat.rb
-- lib/opbeat/better_attr_accessor.rb
 - lib/opbeat/capistrano.rb
-- lib/opbeat/capistrano/capistrano2.rb
-- lib/opbeat/capistrano/capistrano3.rb
 - lib/opbeat/client.rb
 - lib/opbeat/configuration.rb
+- lib/opbeat/data_builders.rb
+- lib/opbeat/data_builders/error.rb
+- lib/opbeat/data_builders/transactions.rb
 - lib/opbeat/error.rb
-- lib/opbeat/event.rb
+- lib/opbeat/error_message.rb
+- lib/opbeat/error_message/exception.rb
+- lib/opbeat/error_message/http.rb
+- lib/opbeat/error_message/stacktrace.rb
+- lib/opbeat/error_message/user.rb
 - lib/opbeat/filter.rb
-- lib/opbeat/integrations/delayed_job.rb
-- lib/opbeat/integrations/resque.rb
-- lib/opbeat/integrations/sidekiq.rb
-- lib/opbeat/interfaces.rb
-- lib/opbeat/interfaces/exception.rb
-- lib/opbeat/interfaces/http.rb
-- lib/opbeat/interfaces/message.rb
-- lib/opbeat/interfaces/stack_trace.rb
-- lib/opbeat/linecache.rb
-- lib/opbeat/logger.rb
-- lib/opbeat/rack.rb
-- lib/opbeat/rails/middleware/debug_exceptions_catcher.rb
-- lib/opbeat/railtie.rb
+- lib/opbeat/http_client.rb
+- lib/opbeat/injections.rb
+- lib/opbeat/injections/json.rb
+- lib/opbeat/injections/net_http.rb
+- lib/opbeat/injections/redis.rb
+- lib/opbeat/injections/sequel.rb
+- lib/opbeat/injections/sinatra.rb
+- lib/opbeat/integration/capistrano2.rb
+- lib/opbeat/integration/capistrano3.rb
+- lib/opbeat/integration/delayed_job.rb
+- lib/opbeat/integration/rails/inject_exceptions_catcher.rb
+- lib/opbeat/integration/railtie.rb
+- lib/opbeat/integration/resque.rb
+- lib/opbeat/integration/sidekiq.rb
+- lib/opbeat/line_cache.rb
+- lib/opbeat/logging.rb
+- lib/opbeat/middleware.rb
+- lib/opbeat/normalizers.rb
+- lib/opbeat/normalizers/action_controller.rb
+- lib/opbeat/normalizers/action_view.rb
+- lib/opbeat/normalizers/active_record.rb
+- lib/opbeat/sql_summarizer.rb
+- lib/opbeat/subscriber.rb
 - lib/opbeat/tasks.rb
+- lib/opbeat/trace.rb
+- lib/opbeat/trace_helpers.rb
+- lib/opbeat/transaction.rb
+- lib/opbeat/util.rb
+- lib/opbeat/util/constantize.rb
+- lib/opbeat/util/inspector.rb
 - lib/opbeat/version.rb
+- lib/opbeat/worker.rb
 - opbeat.gemspec
-- spec/opbeat/better_attr_accessor_spec.rb
 - spec/opbeat/client_spec.rb
 - spec/opbeat/configuration_spec.rb
-- spec/opbeat/event_spec.rb
+- spec/opbeat/data_builders/error_spec.rb
+- spec/opbeat/data_builders/transactions_spec.rb
+- spec/opbeat/error_message/exception_spec.rb
+- spec/opbeat/error_message/http_spec.rb
+- spec/opbeat/error_message/stacktrace_spec.rb
+- spec/opbeat/error_message/user_spec.rb
+- spec/opbeat/error_message_spec.rb
 - spec/opbeat/filter_spec.rb
-- spec/opbeat/integrations/delayed_job_spec.rb
-- spec/opbeat/logger_spec.rb
-- spec/opbeat/opbeat_spec.rb
-- spec/opbeat/rack_spec.rb
+- spec/opbeat/http_client_spec.rb
+- spec/opbeat/injections/net_http_spec.rb
+- spec/opbeat/injections/sequel_spec.rb
+- spec/opbeat/injections/sinatra_spec.rb
+- spec/opbeat/injections_spec.rb
+- spec/opbeat/integration/delayed_job_spec.rb
+- spec/opbeat/integration/json_spec.rb
+- spec/opbeat/integration/rails_spec.rb
+- spec/opbeat/integration/redis_spec.rb
+- spec/opbeat/integration/resque_spec.rb
+- spec/opbeat/integration/sidekiq_spec.rb
+- spec/opbeat/integration/sinatra_spec.rb
+- spec/opbeat/line_cache_spec.rb
+- spec/opbeat/logging_spec.rb
+- spec/opbeat/middleware_spec.rb
+- spec/opbeat/normalizers/action_controller_spec.rb
+- spec/opbeat/normalizers/action_view_spec.rb
+- spec/opbeat/normalizers/active_record_spec.rb
+- spec/opbeat/normalizers_spec.rb
+- spec/opbeat/sql_summarizer_spec.rb
+- spec/opbeat/subscriber_spec.rb
+- spec/opbeat/trace_spec.rb
+- spec/opbeat/transaction_spec.rb
+- spec/opbeat/util/inspector_spec.rb
+- spec/opbeat/util_spec.rb
+- spec/opbeat/worker_spec.rb
+- spec/opbeat_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/opbeat/opbeat_ruby
+homepage: https://github.com/opbeat/opbeat-ruby
 licenses:
-- Apache-2.0
+- BSD-3-Clause
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -211,8 +151,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: The official Opbeat Ruby client
+summary: The official Opbeat Ruby client library
 test_files: []