opbeat 0.5.2 → 0.6.0

data/README.md

@@ -45,13 +45,14 @@ Basic RackUp file.
 ```ruby
 require 'opbeat'
 
+use Opbeat::Rack
+
 Opbeat.configure do |config|
   config.organization_id = '094e250818f44e82bfae13919f55fb35'
   config.app_id = '094e250818'
   config.secret_token = 'f0f5237a221637f561a15614f5fef218f8d6317d'
 end
 
-use Opbeat::Rack
 ```
 
 ### Sinatra
@@ -60,14 +61,14 @@ use Opbeat::Rack
 require 'sinatra'
 require 'opbeat'
 
+use Opbeat::Rack
+
 Opbeat.configure do |config|
   config.organization_id = '094e250818f44e82bfae13919f55fb35'
   config.app_id = '094e250818'
   config.secret_token = 'f0f5237a221637f561a15614f5fef218f8d6317d'
 end
 
-use Opbeat::Rack
-
 get '/' do
   1 / 0
 end

data/lib/opbeat.rb

@@ -10,8 +10,11 @@ require 'opbeat/interfaces/stack_trace'
 require 'opbeat/interfaces/http'
 require 'opbeat/processors/sanitizedata'
 
+require 'opbeat/integrations/delayed_job'
+
 require 'opbeat/railtie' if defined?(Rails::Railtie)
 
+
 module Opbeat
   class << self
     # The client object is responsible for delivering formatted data to the Opbeat server.
@@ -56,7 +59,7 @@ module Opbeat
     #   evt = Opbeat::Event.new(:message => "An error")
     #   Opbeat.send(evt)
     def send(evt)
-      @client.send(evt) if @client
+      @client.send_event(evt) if @client
     end
 
     # Capture and process any exceptions from the given block, or globally if

data/lib/opbeat/capistrano.rb

@@ -0,0 +1,9 @@
+require 'capistrano'
+require 'capistrano/version'
+
+is_cap3 = Capistrano.constants.include? :VERSION
+if is_cap3
+  load File.expand_path('../capistrano/capistrano3.rb', __FILE__)
+else
+  require_relative 'capistrano/capistrano2'
+end

data/lib/opbeat/capistrano/capistrano2.rb

@@ -0,0 +1,45 @@
+require 'capistrano'
+
+module Opbeat
+  module Capistrano
+    def self.load_into(configuration)
+
+      configuration.load do
+        after "deploy", "opbeat:notify"
+        namespace :opbeat do
+          desc "Notifies Opbeat of new deployments"
+          task :notify, :except => { :no_release => true } do
+
+            scm = fetch(:scm)
+            if scm.to_s != "git"
+              puts "Skipping Opbeat deployment notification because scm is not git."
+              next
+            end
+          
+            branches = capture("cd #{current_release}; /usr/bin/env git branch --contains #{current_revision}").split
+            if branches.length == 1
+              branch = branch[0].sub("* ")
+            else
+              branch = nil
+            end  
+
+            notify_command = "cd #{current_release}; REV=#{current_revision} "
+            notify_command << "BRANCH=#{branch} " if branch
+
+            rails_env = fetch(:rails_env, "production")
+            notify_command << "RAILS_ENV=#{rails_env} "
+
+            executable = fetch(:rake, 'bundle exec rake ')
+            notify_command << "#{executable} opbeat:deployment"
+            capture notify_command, :once => true
+          
+          end
+        end
+      end
+    end
+  end
+end
+
+if Capistrano::Configuration.instance
+  Opbeat::Capistrano.load_into(Capistrano::Configuration.instance)
+end

data/lib/opbeat/capistrano/capistrano3.rb

@@ -0,0 +1,38 @@
+namespace :opbeat do
+  desc "Notifies Opbeat of new deployments"
+  task :notify do
+    on roles(:app) do
+
+      scm = fetch(:scm)
+      if scm.to_s != "git"
+        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} "
+
+        executable = fetch(:rake, 'bundle exec rake ')
+        notify_command << "#{executable} opbeat:deployment"
+        capture ("cd #{release_path};" + notify_command), :once => true
+      end
+    end
+  end
+end
+
+namespace :deploy do
+  after :publishing, "opbeat:notify"
+end

data/lib/opbeat/client.rb

@@ -60,8 +60,11 @@ module Opbeat
       raise Error.new('No app ID specified') unless self.configuration[:app_id]
 
       Opbeat.logger.debug "Opbeat client connecting to #{self.configuration[:server]}"
-      @url =  self.configuration[:server] + "/api/v1/organizations/" + self.configuration[:organization_id] +  "/apps/" + self.configuration[:app_id] + "/errors/"
-      @conn ||=  Faraday.new(:url => @url, :ssl => {:verify => self.configuration.ssl_verification}) do |builder|
+      @base_url = self.configuration[:server] + 
+                            "/api/v1/organizations/" +
+                            self.configuration[:organization_id] +
+                            "/apps/" + self.configuration[:app_id]
+      @conn ||=  Faraday.new(:url => @base_url, :ssl => {:verify => self.configuration.ssl_verification}) do |builder|
         builder.adapter  Faraday.default_adapter
       end
 
@@ -84,19 +87,11 @@ module Opbeat
       return MultiJson.encode(event_hash)
     end
 
-    def send(event)
-      return unless configuration.send_in_current_environment?
-      return unless state.should_try?
-
-      # Set the organization ID correctly
-      event.organization = self.configuration[:organization_id]
-      event.app = self.configuration[:app_id]
-      Opbeat.logger.debug "Sending event #{event.id} to Opbeat"
-      
+    def send(url_postfix, message)
       begin
-        response = self.conn.post @url do |req|
+        response = self.conn.post @base_url + url_postfix do |req|
           req.headers['Content-Type'] = 'application/json'
-          req.body = self.encode(event)
+          req.body = self.encode(message)
           req.headers[AUTH_HEADER_KEY] = self.generate_auth_header(req.body)
           req.headers["User-Agent"] = USER_AGENT
         end
@@ -113,6 +108,24 @@ module Opbeat
       response
     end
 
+    def send_event(event)
+      return unless configuration.send_in_current_environment?
+      unless state.should_try?
+        Opbeat.logger.info "Temporarily skipping sending to Opbeat due to previous failure."
+        return
+      end
+
+      # Set the organization ID correctly
+      event.organization = self.configuration[:organization_id]
+      event.app = self.configuration[:app_id]
+      Opbeat.logger.debug "Sending event #{event.id} to Opbeat"
+      send("/errors/", event)
+    end
+
+    def send_release(release)
+      Opbeat.logger.debug "Sending release to Opbeat"
+      send("/releases/", release)
+    end
   end
 
 end

data/lib/opbeat/configuration.rb

@@ -48,8 +48,8 @@ module Opbeat
       self.organization_id = ENV['OPBEAT_ORGANIZATION_ID'] if ENV['OPBEAT_ORGANIZATION_ID']
       self.app_id = ENV['OPBEAT_APP_ID'] if ENV['OPBEAT_APP_ID']
       @context_lines = 3
-      self.environments = %w[ production ]
-      self.current_environment = ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'development'
+      self.environments = %w[ development production default ]
+      self.current_environment = ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'default'
       self.excluded_exceptions = []
       self.processors = [Opbeat::Processor::SanitizeData]
       self.timeout = 1

data/lib/opbeat/event.rb

@@ -22,6 +22,7 @@ module Opbeat
     attr_reader :id
     attr_accessor :organization, :app, :message, :timestamp, :level
     attr_accessor :logger, :culprit, :hostname, :modules, :extra
+    attr_accessor :environment
 
     def initialize(options={}, configuration=nil, &block)
       @configuration = configuration || Opbeat.configuration
@@ -33,6 +34,7 @@ module Opbeat
       @level = options[:level] || :error
       @logger = options[:logger] || 'root'
       @culprit = options[:culprit]
+      @environment = @configuration[:current_environment]
       @extra = options[:extra]
 
       # Try to resolve the hostname to an FQDN, but fall back to whatever the load name is
@@ -77,6 +79,7 @@ module Opbeat
       }
       data['culprit'] = self.culprit if self.culprit
       data['machine'] = {'hostname' => self.hostname } if self.hostname
+      data['environment'] = self.environment if self.environment
       data['extra'] = self.extra if self.extra
       @interfaces.each_pair do |name, int_data|
         data[name] = int_data.to_hash

data/lib/opbeat/integrations/delayed_job.rb

@@ -0,0 +1,32 @@
+begin
+  require 'delayed_job'
+rescue LoadError
+end
+
+# Based on the Sentry equivalent.
+if defined?(Delayed)
+
+  module Delayed
+    module Plugins
+      class Opbeat < ::Delayed::Plugin
+        callbacks do |lifecycle|
+          lifecycle.around(:invoke_job) do |job, *args, &block|
+            begin
+              # Forward the call to the next callback in the callback chain
+              block.call(job, *args)
+
+            rescue Exception => exception
+              # Log error to Opbeat
+              ::Opbeat.captureException(exception)
+              # Make sure we propagate the failure!
+              raise exception
+            end
+          end
+        end
+      end
+    end
+  end
+
+  # Register DelayedJob Opbeat plugin
+  Delayed::Worker.plugins << Delayed::Plugins::Opbeat
+end

data/lib/opbeat/railtie.rb

@@ -19,5 +19,8 @@ module Opbeat
         ::ActionDispatch::ShowExceptions.send(:include, Opbeat::Rails::Middleware::DebugExceptionsCatcher)
       end
     end
+    rake_tasks do
+      require 'opbeat/tasks'
+    end
   end
 end

data/lib/opbeat/tasks.rb

@@ -0,0 +1,24 @@
+# Capistrano tasks for notifying Opbeat of deploys
+namespace :opbeat do
+  desc "Notify Opbeat of a new deploy."
+  task :deployment do
+    if defined?(Rails.root)
+      initializer_file = Rails.root.join('config', 'initializers','opbeat.rb')
+
+      if initializer_file.exist?
+        load initializer_file
+      else
+        Rake::Task[:environment].invoke
+      end
+    end
+    rev = ENV['REV']
+
+    unless rev
+      puts "No revision given. Set environment variable REV."
+    else
+      data = {'rev' => ENV['REV'], 'branch' => ENV['BRANCH'], 'status' => 'completed'}
+      Opbeat::client.send_release(data)
+    end
+  end
+end
+

data/lib/opbeat/version.rb

@@ -1,3 +1,3 @@
 module Opbeat
-  VERSION = "0.5.2"
+  VERSION = "0.6.0"
 end

metadata

@@ -1,72 +1,61 @@
 --- !ruby/object:Gem::Specification
 name: opbeat
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.0
+  prerelease: 
 platform: ruby
 authors:
 - Noah Kantrowitz
-- Ron Cohen
+- Opbeat
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-06 00:00:00.000000000 Z
+date: 2014-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &11261960 !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.8.0.rc2
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.8.0.rc2
+  version_requirements: *11261960
 - !ruby/object:Gem::Dependency
   name: uuidtools
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &11261420 !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.1.4
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *11261420
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &11256860 !ruby/object:Gem::Requirement
+    none: false
     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'
+  version_requirements: *11256860
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &11255580 !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.1.1
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *11255580
 description: 
 email: ron@opbeat.com
 executables: []
@@ -75,10 +64,14 @@ extra_rdoc_files:
 - README.md
 - LICENSE
 files:
+- lib/opbeat/capistrano/capistrano2.rb
+- lib/opbeat/capistrano/capistrano3.rb
+- lib/opbeat/capistrano.rb
 - lib/opbeat/client.rb
 - lib/opbeat/configuration.rb
 - lib/opbeat/error.rb
 - lib/opbeat/event.rb
+- lib/opbeat/integrations/delayed_job.rb
 - lib/opbeat/interfaces/exception.rb
 - lib/opbeat/interfaces/http.rb
 - lib/opbeat/interfaces/message.rb
@@ -91,31 +84,33 @@ files:
 - lib/opbeat/rack.rb
 - lib/opbeat/rails/middleware/debug_exceptions_catcher.rb
 - lib/opbeat/railtie.rb
+- lib/opbeat/tasks.rb
 - lib/opbeat/version.rb
 - lib/opbeat.rb
 - README.md
 - LICENSE
 homepage: http://github.com/opbeat/opbeat_ruby
 licenses: []
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 1.8.11
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: A gem that provides a client interface for the Opbeat error logger
 test_files: []

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: dfe15681e252c3094e3511bf20dbafe757f9e342
-  data.tar.gz: b8c85cf5621ca9e675f56480416d661773569adc
-SHA512:
-  metadata.gz: 219eddda6bdccc4a1e4eb52c292c527c650c7fdab9f53db68388a24a8f64aee5dbae331fa9ab15f67a97b6cdba4c89f669ab42eea1c56788afd5c9b4f1bb88df
-  data.tar.gz: b788d34646fb4cbb258a9fbd4cff8bb23723e9803553e6af51112adf3a3888f7975c2d072268a587c5daa6e621f7bb130113d09c185de148872a7fd5f2c034ce