opbeat 0.9.1 → 0.9.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 157acc9610fffbf878154cc1ba1e7312a9b1f77f
+  data.tar.gz: 50476185d45bfafca5ce68cb542e1abb0ffbef7b
+SHA512:
+  metadata.gz: 5ca3600ea88cae6d689c4a22cd5f25cb56a6a7682d374401b7010066e508201d03eb8d03756af6c2be4023153ccad7e7d50f9ef323ff8647562d8d79b1fdef8c
+  data.tar.gz: 6a689d1070878453e1e4132c4a722177663c15f14c100dd3ee9d5c0c4f9ab5fc80d2fbb06f69bcf8a12d69ec7b5d4149ed0ea979e1cac3bbaa6d06f163809532

data/.gitignore

@@ -0,0 +1,5 @@
+coverage
+pkg
+ruby/
+.bundle
+Gemfile.lock

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format documentation

data/.travis.yml

@@ -0,0 +1,25 @@
+language: ruby
+rvm:
+- 1.9.2
+- 1.9.3
+- 2.0.0
+- 2.1.1
+gemfile:
+- gemfiles/rails30.gemfile
+- gemfiles/rails31.gemfile
+- gemfiles/rails32.gemfile
+matrix:
+  include:
+    - rvm: 1.9.2
+      gemfile: gemfiles/ruby192_rails31.gemfile
+    - rvm: 1.9.2
+      gemfile: gemfiles/ruby192_rails32.gemfile
+  exclude:
+    - rvm: 1.9.2
+      gemfile: gemfiles/rails31.gemfile
+    - rvm: 1.9.2
+      gemfile: gemfiles/rails32.gemfile
+bundler_args: "--without development"
+notifications:
+  slack:
+    secure: IniiL3PdFsht2zykTwd/z5Et/L1U6GzsmMC1LrgccKCrvLsdcdlBU3VrAgIb1GT9FPEFpb5sl7FEBN80p6uW15uO57onUawFaSWDhSA3eXG1ImmunVPJ20U4NkJvMbnUdZXQ9XXqOw1ggkR7GrD0PM9Nzr4puWaaGq42UJjdaq0=

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org/"
+gemspec

data/Makefile

@@ -0,0 +1,3 @@
+test:
+	bundle install
+	rake spec

data/README.md

@@ -204,6 +204,19 @@ Opbeat.set_context :extra => {:device_id => my_device_id}
 Opbeat.capture_message("Hello world")  # will include the context
 ```
 
+## Timeouts
+
+Opbeat uses a low default timeout. If you frequently experience timeouts, try increasing it in the following manner:
+
+```ruby
+Opbeat.configure do |config|
+  ...
+  config.timeout = 5
+  config.open_timeout = 5
+end
+```
+
+
 
 ## Testing
 

data/Rakefile

@@ -0,0 +1,19 @@
+require 'rake'
+require 'rubygems/package_task'
+
+gemspec = Gem::Specification.load(Dir['*.gemspec'].first)
+
+Gem::PackageTask.new(gemspec).define
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec) do |spec|
+    spec.pattern = 'spec/**/*_spec.rb'
+  end
+rescue LoadError
+  task :spec do
+    abort "Rspec is not available. bundle install to run unit tests"
+  end
+end
+
+task :default => :spec

data/gemfiles/rails30.gemfile

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+
+gem "rails", "~> 3.0.15"
+gem "rake"
+gem "rspec"
+gem "simplecov"
+gem "delayed_job"
+gem "sidekiq", "~> 2.17.0"
+gem "opbeat", :path => "../"
+
+gemspec :path => "../"

data/gemfiles/rails31.gemfile

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+
+gem "rails", "~> 3.1.6"
+gem "rake"
+gem "rspec"
+gem "simplecov"
+gem "delayed_job"
+gem "sidekiq", "~> 2.17.0"
+gem "opbeat", :path => "../"
+
+gemspec :path => "../"

data/gemfiles/rails32.gemfile

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+
+gem "rails", "~> 3.2.6"
+gem "rake"
+gem "rspec"
+gem "simplecov"
+gem "delayed_job"
+gem "sidekiq", "~> 2.17.0"
+gem "opbeat", :path => "../"
+
+gemspec :path => "../"

data/gemfiles/rails40.gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+
+gem "rails", "~> 4.0.0"
+gem "rake"
+gem "rspec"
+gem "simplecov"
+gem "delayed_job"
+gem "sidekiq", "~> 2.17.0"
+
+gem "opbeat", :path => "../"
+
+gemspec :path => "../"

data/gemfiles/rails41.gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+
+gem "rails", "~> 4.1.0"
+gem "rake"
+gem "rspec"
+gem "simplecov"
+gem "delayed_job"
+gem "sidekiq", "~> 2.17.0"
+
+gem "opbeat", :path => "../"
+
+gemspec :path => "../"

data/gemfiles/ruby192_rails31.gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+
+gem "i18n", "~> 0.6.11" # pin to <0.7 to support ruby 1.9.2
+gem "rails", "~> 3.1.6"
+gem "rake"
+gem "rspec"
+gem "simplecov"
+gem "delayed_job"
+gem "sidekiq", "~> 2.17.0"
+gem "opbeat", :path => "../"
+
+gemspec :path => "../"

data/gemfiles/ruby192_rails32.gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+
+gem "i18n", "~> 0.6.11" # pin to <0.7 to support ruby 1.9.2
+gem "rails", "~> 3.2.6"
+gem "rake"
+gem "rspec"
+gem "simplecov"
+gem "delayed_job"
+gem "sidekiq", "~> 2.17.0"
+gem "opbeat", :path => "../"
+
+gemspec :path => "../"

data/gemfiles/sidekiq31.gemfile

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+
+gem "rails", "~> 3.2.6"
+gem "rake"
+gem "rspec"
+gem "simplecov"
+gem "delayed_job"
+gem "sidekiq", "~> 3.1.0"
+gem "opbeat", :path => "../"
+
+gemspec :path => "../"

data/lib/opbeat/better_attr_accessor.rb

@@ -0,0 +1,44 @@
+require 'set'
+
+module Opbeat
+  module BetterAttrAccessor
+
+    def attributes
+      Hash[
+        self.class.attributes.map do |attr|
+          [attr, send(attr)]
+        end
+      ]
+    end
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def attributes
+        @attributes ||= Set.new
+
+        if superclass.include? BetterAttrAccessor
+          @attributes + superclass.attributes
+        else
+          @attributes
+        end
+      end
+
+      def attr_accessor(attr, options = {})
+        @attributes ||= Set.new
+        @attributes << attr.to_s
+
+        define_method attr do
+          if instance_variable_defined? "@#{attr}"
+            instance_variable_get "@#{attr}"
+          elsif options.key? :default
+            instance_variable_set "@#{attr}", options[:default].dup
+          end
+        end
+        attr_writer attr
+      end
+    end
+  end
+end

data/lib/opbeat/capistrano/capistrano3.rb

@@ -8,26 +8,14 @@ namespace :opbeat do
         info "Skipping Opbeat deployment because scm is not git."
         next
       end
-      
-      within repo_path do
-        rev = fetch(:current_revision)
 
-        branches = capture("cd #{repo_path}; /usr/bin/env git branch --contains #{rev}").split
-        if branches.length == 1
-          branch = branches[0].sub("* ", "")
-        else
-          branch = nil
-        end
-
-        notify_command = "REV=#{rev} "
-        notify_command << "BRANCH=#{branch} " if branch
-
-        rails_env = fetch(:rails_env, "production")
-        notify_command << "RAILS_ENV=#{rails_env} "
+      rev = fetch(:current_revision)
+      branch = fetch(:branch, 'master')
 
-        executable = fetch(:rake, 'bundle exec rake ')
-        notify_command << "#{executable} opbeat:deployment"
-        capture ("cd #{release_path};" + notify_command), :once => true
+      within release_path do
+        with rails_env: fetch(:rails_env), rev: rev, branch: branch do
+          capture :rake, 'opbeat:deployment'
+        end
       end
     end
   end
@@ -35,4 +23,4 @@ end
 
 namespace :deploy do
   after :publishing, "opbeat:notify"
-end
+end

data/lib/opbeat/client.rb

@@ -17,7 +17,7 @@ module Opbeat
 
     def should_try?
       return true if @status == :online
-        
+
       interval = ([@retry_number, 6].min() ** 2) * @configuration[:backoff_multiplier]
       return true if Time.now - @last_check > interval
 
@@ -40,7 +40,7 @@ module Opbeat
   class Client
 
     PROTOCOL_VERSION = '1.0'
-    USER_AGENT = "opbeat/#{Opbeat::VERSION}"
+    USER_AGENT = "opbeat-ruby/#{Opbeat::VERSION}"
     AUTH_HEADER_KEY = 'Authorization'
 
     attr_accessor :configuration
@@ -79,11 +79,11 @@ module Opbeat
 
     def encode(event)
       event_hash = event.to_hash
-      
+
       @processors.each do |p|
         event_hash = p.process(event_hash)
       end
-      
+
       return MultiJson.encode(event_hash)
     end
 
@@ -95,7 +95,7 @@ module Opbeat
           req.headers[AUTH_HEADER_KEY] = self.generate_auth_header(req.body)
           req.headers["User-Agent"] = USER_AGENT
         end
-        unless response.status == 202
+        if !response.status.between?(200, 299)
           raise Error.new("Error from Opbeat server (#{response.status}): #{response.body}")
         end
       rescue

data/lib/opbeat/event.rb

@@ -1,6 +1,5 @@
 require 'rubygems'
 require 'socket'
-require 'uuidtools'
 
 require 'opbeat/error'
 require 'opbeat/linecache'
@@ -28,7 +27,7 @@ module Opbeat
       @configuration = configuration || Opbeat.configuration
       @interfaces = {}
 
-      @id = options[:id] || UUIDTools::UUID.random_create.hexdigest
+      @id = options[:id]
       @message = options[:message]
       @timestamp = options[:timestamp] || Time.now.utc
       @level = options[:level] || :error
@@ -72,12 +71,12 @@ module Opbeat
 
     def to_hash
       data = {
-        'client_supplied_id' => self.id,
         'message' => self.message,
         'timestamp' => self.timestamp,
         'level' => self.level,
         'logger' => self.logger,
       }
+      data['client_supplied_id'] = self.id if self.id
       data['culprit'] = self.culprit if self.culprit
       data['machine'] = {'hostname' => self.hostname } if self.hostname
       data['environment'] = self.environment if self.environment
@@ -87,6 +86,7 @@ module Opbeat
         if self.user[:id] or self.user[:email] or self.user[:username]
           data['user'][:is_authenticated] = true
         end
+        data['user'][:is_authenticated] = false if !data['user'][:is_authenticated]
       end
       @interfaces.each_pair do |name, int_data|
         data[name] = int_data.to_hash

data/lib/opbeat/interfaces/exception.rb

@@ -5,9 +5,9 @@ module Opbeat
   class ExceptionInterface < Interface
 
     name 'exception'
-    property :type, :required => true
-    property :value, :required => true
-    property :module
+    attr_accessor :type
+    attr_accessor :value
+    attr_accessor :module
 
   end
 

data/lib/opbeat/interfaces/http.rb

@@ -5,15 +5,15 @@ module Opbeat
   class HttpInterface < Interface
 
     name 'http'
-    property :url, :required => true
-    property :method, :required => true
-    property :data
-    property :query_string
-    property :cookies
-    property :headers
-    property :remote_host
-    property :http_host
-    property :env
+    attr_accessor :url
+    attr_accessor :method
+    attr_accessor :data
+    attr_accessor :query_string
+    attr_accessor :cookies
+    attr_accessor :headers
+    attr_accessor :remote_host
+    attr_accessor :http_host
+    attr_accessor :env
 
     def initialize(*arguments)
       self.headers = {}

data/lib/opbeat/interfaces/message.rb

@@ -5,8 +5,8 @@ module Opbeat
   class MessageInterface < Interface
 
     name 'param_message'
-    property :message, :required => true
-    property :params
+    attr_accessor :message
+    attr_accessor :params
 
     def initialize(*arguments)
       self.params = []

data/lib/opbeat/interfaces/stack_trace.rb

@@ -1,5 +1,3 @@
-require 'hashie'
-
 require 'opbeat/interfaces'
 
 module Opbeat
@@ -7,7 +5,7 @@ module Opbeat
   class StacktraceInterface < Interface
 
     name 'stacktrace'
-    property :frames, :default => []
+    attr_accessor :frames, :default => []
 
     def initialize(*arguments)
       self.frames = []
@@ -26,21 +24,14 @@ module Opbeat
 
     # Not actually an interface, but I want to use the same style
     class Frame < Interface
-      property :abs_path
-      property :filename, :required => true
-      property :function
-      property :vars
-      property :pre_context
-      property :post_context
-      property :context_line
-      property :lineno, :required => true
-
-      def initialize(*arguments)
-        self.vars= {}
-        self.pre_context = []
-        self.post_context = []
-        super(*arguments)
-      end
+      attr_accessor :abs_path
+      attr_accessor :filename
+      attr_accessor :function
+      attr_accessor :vars, :default => {}
+      attr_accessor :pre_context, :default => []
+      attr_accessor :post_context, :default => []
+      attr_accessor :context_line
+      attr_accessor :lineno
 
       def to_hash
         data = super

data/lib/opbeat/interfaces.rb

@@ -1,25 +1,23 @@
-require 'hashie'
+require 'opbeat/better_attr_accessor'
 
 module Opbeat
 
   INTERFACES = {}
 
-  class Interface < Hashie::Dash
-    def initialize(attributes={}, &block)
-      @check_required = false
-      super(attributes)
-      block.call(self) if block
-      @check_required = true
-      assert_required_properties_set!
-    end
+  class Interface
+    include BetterAttrAccessor
+    alias_method :to_hash, :attributes
+
+    def initialize(attributes = nil)
+      attributes.each do |attr, value|
+        send "#{attr}=", value
+      end if attributes
 
-    def assert_required_properties_set!
-      super if @check_required
+      yield self if block_given?
     end
 
-    def self.name(value=nil)
-      @interface_name = value if value
-      @interface_name
+    def self.name(value = nil)
+      @interface_name ||= value
     end
   end
 

data/lib/opbeat/version.rb

@@ -1,3 +1,3 @@
 module Opbeat
-  VERSION = "0.9.1"
+  VERSION = "0.9.2"
 end

data/opbeat.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'opbeat/version'
+
+Gem::Specification.new do |gem|
+  gem.name             = "opbeat"
+  gem.version          = Opbeat::VERSION
+  gem.authors          = ["Thomas Watson Steen", "Ron Cohen", "Noah Kantrowitz"]
+  gem.email            = "support@opbeat.com"
+  gem.summary          = "The official Opbeat Ruby client"
+  gem.homepage         = "https://github.com/opbeat/opbeat_ruby"
+  gem.license          = "Apache-2.0"
+
+  gem.files            = `git ls-files -z`.split("\x0")
+  gem.require_paths    = ["lib"]
+  gem.extra_rdoc_files = ["README.md", "LICENSE"]
+
+  gem.add_dependency "faraday", [">= 0.7.6", "< 0.10"]
+  gem.add_dependency "multi_json", "~> 1.0"
+
+  gem.add_development_dependency "bundler", "~> 1.7"
+  gem.add_development_dependency "rake", "~> 10.0"
+  gem.add_development_dependency "rspec", ">= 2.14"
+  gem.add_development_dependency "simplecov"
+  gem.add_development_dependency "delayed_job"
+  gem.add_development_dependency "sidekiq", "~> 2.17.0"
+end

data/spec/opbeat/better_attr_accessor_spec.rb

@@ -0,0 +1,99 @@
+require File::expand_path('../../spec_helper', __FILE__)
+require 'opbeat'
+
+describe Opbeat::BetterAttrAccessor do
+
+  let :klass do
+    Class.new do
+      include Opbeat::BetterAttrAccessor
+
+      attr_accessor :a
+      attr_accessor :b, :default => []
+      attr_accessor :c
+    end
+  end
+
+  let :child do
+    Class.new klass do
+      attr_accessor :d
+    end
+  end
+
+  subject{ klass.new }
+
+  describe 'the reader method' do
+    context 'when a value is not set' do
+      it 'should default to nil' do
+        expect(subject.a).to eq nil
+      end
+      it 'should use a default value if provided' do
+        expect(subject.b).to eq []
+        expect(subject.instance_variable_get '@b').to eq []
+      end
+    end
+
+    context 'when a value is set' do
+      before do
+        subject.a = 'foo'
+        subject.b = :bar
+        subject.c = false
+      end
+
+      it 'should save the value' do
+        expect(subject.a).to eq 'foo'
+      end
+      it 'should save a boolean `false` value' do
+        expect(subject.c).to eq false
+      end
+      it 'should no longer return the default' do
+        expect(subject.b).to eq :bar
+      end
+    end
+
+    context 'when a default value is directly modified' do
+      before { subject.b << 9 }
+      it 'should not affect a new instance' do
+        expect(klass.new.b).to eq []
+      end
+    end
+  end
+
+  describe '.attributes' do
+    it 'should be a Set of all attributes set up' do
+      expect(klass.attributes).to be_a Set
+      expect(klass.attributes).to eq %w[a b c].to_set
+    end
+    it 'should work with inheritance' do
+      expect(child.attributes).to eq %w[d a b c].to_set
+    end
+  end
+
+  describe '#attributes' do
+    it 'should return a hash of all attributes' do
+      subject.a = {'foo' => :bar}
+      subject.b << 8
+      expect(subject.attributes).to eq \
+        'a' => {'foo' => :bar},
+        'b' => [8],
+        'c' => nil
+    end
+
+    describe 'inheritance' do
+      subject{ child.new }
+
+      before do
+        subject.a = 21
+        subject.d = true
+      end
+
+      it 'should work' do
+        expect(subject.attributes).to eq \
+          'a' => 21,
+          'b' => [],
+          'c' => nil,
+          'd' => true
+      end
+    end
+  end
+
+end

data/spec/opbeat/client_spec.rb

@@ -0,0 +1,25 @@
+require File::expand_path('../../spec_helper', __FILE__)
+require 'opbeat'
+
+describe Opbeat::Client do
+  before do
+
+    @configuration = Opbeat::Configuration.new
+    @configuration.environments = ["test"]
+    @configuration.current_environment = :test
+    @client = Opbeat::Client.new(@configuration)
+    allow(@client).to receive(:send)
+  end
+
+  it 'send_release should send' do
+    message = "Test message"
+    expect(@client).to receive(:send).with("/releases/", message)
+    @client.send_release(message)
+  end
+
+  it 'send_message should send' do
+    event = Opbeat::Event.new :message => "my message"
+    expect(@client).to receive(:send).with("/errors/", event)
+    @client.send_event(event)
+  end
+end