rollbar 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3f2c782eb71538b4fa602e2e56c56233559858f7
-  data.tar.gz: 6ad6c0a6b66963dc0b0a2bdb0705df9d95e4f468
+  metadata.gz: 26233ef7ffa02228b4777c5ef26655f9208541e9
+  data.tar.gz: 14feffe767b5d9764afc4508ed139a9d2394ada3
 SHA512:
-  metadata.gz: fddd828f6ff42f93a0211e4967baf4a99ff1c93f1b5c1ee1a231004627b80c5b18dfbf6684d94a141144e29bebd17e5d9e6d977844506fb62cd7524272e29ebe
-  data.tar.gz: f6820508de41ddc3fcb9ff89bab83da096a6b778d97bdca10297982561f139d6f1c7591d120bb9165a3bcc3601d7ca5f17c89a137cb49f114b00c8c01273f77c
+  metadata.gz: c38f8b6ea8dbdafe38b68cbc5b1902b21e7a55f29ebc154fe23d4a9a2a50d4bba01e623b917f4ba6e3ee17611cbb4d55b07035e40d83ae35eaa90b7ed4fab326
+  data.tar.gz: 08a2f63d80dd45c48eb297e6cfbfc0f551004ad7c4280b2b6a71bb79b3887c814910307c83b742f5ad420586e795f95cf52e4bf7f1a00561e54d3cb4ef671c7e

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Change Log
 
+**1.0.1**
+- Use the payload's access token for the X-Rollbar-Access-Token header, instead of the configured access token. Fixes an issue where payloads would be reported into the wrong project when sent via Resque. See [#128](https://github.com/rollbar/rollbar-gem/pull/128). Thanks to [@jondeandres](https://github.com/jondeandres) for the fix.
+
 **1.0.0**
 - Clean up some unused requires
 - Strip out invalid UTF-8 characters from payload keys/values, fixes [#85](https://github.com/rollbar/rollbar-gem/issues/85)
@@ -94,7 +97,7 @@
 - Fix syntax error in `config.use_sidekiq` usage example
 
 **0.12.0**
-- Added [#73](https://github.com/rollbar/rollbar-gem/pull/73), enhanced Sidekiq and SuckerPunch configuration. NOTE: The old `Rollbar::Configuration#use_sidekiq=` and `Rollbar::Configuration#use_sucker_punch=` methods are now depricated, see the docs for updated usage information.
+- Added [#73](https://github.com/rollbar/rollbar-gem/pull/73), enhanced Sidekiq and SuckerPunch configuration. NOTE: The old `Rollbar::Configuration#use_sidekiq=` and `Rollbar::Configuration#use_sucker_punch=` methods are now deprecated, see the docs for updated usage information.
 
 **0.11.8**
 - Make sure the person method exists for the controller before trying to extract person data

data/README.md

@@ -9,7 +9,7 @@ Ruby gem for reporting exceptions, errors, and log messages to [Rollbar](https:/
 
 Add this line to your application's Gemfile:
 
-    gem 'rollbar'
+    gem 'rollbar', '~> 1.0.0'
 
 And then execute:
 

data/lib/rollbar.rb

@@ -374,7 +374,10 @@ module Rollbar
     end
 
     def send_payload_using_eventmachine(payload)
-      req = EventMachine::HttpRequest.new(configuration.endpoint).post(:body => payload)
+      body = dump_payload(payload)
+      headers = { 'X-Rollbar-Access-Token' => payload['access_token'] }
+      req = EventMachine::HttpRequest.new(configuration.endpoint).post(:body => body, :head => headers)
+
       req.callback do
         if req.response_header.status == 200
           log_info '[Rollbar] Success'
@@ -391,11 +394,14 @@ module Rollbar
 
     def send_payload(payload)
       log_info '[Rollbar] Sending payload'
+      payload = MultiJson.load(payload) if payload.is_a?(String)
 
       if configuration.use_eventmachine
         send_payload_using_eventmachine(payload)
         return
       end
+
+      body = dump_payload(payload)
       uri = URI.parse(configuration.endpoint)
       http = Net::HTTP.new(uri.host, uri.port)
       http.read_timeout = configuration.request_timeout
@@ -406,8 +412,8 @@ module Rollbar
       end
 
       request = Net::HTTP::Post.new(uri.request_uri)
-      request.body = payload
-      request.add_field('X-Rollbar-Access-Token', configuration.access_token)
+      request.body = body
+      request.add_field('X-Rollbar-Access-Token', payload['access_token'])
       response = http.request(request)
 
       if response.code == '200'
@@ -444,12 +450,15 @@ module Rollbar
 
     def build_payload(data)
       payload = {
-        :access_token => configuration.access_token,
-        :data => data
+        'access_token' => configuration.access_token,
+        'data' => data
       }
-      
+
       enforce_valid_utf8(payload)
-      
+      payload
+    end
+
+    def dump_payload(payload)
       result = MultiJson.dump(payload)
 
       # Try to truncate strings in the payload a few times if the payload is too big
@@ -589,18 +598,16 @@ module Rollbar
       config = configuration
       environment = config.environment
 
-      failsafe_payload = <<-eos
-      {"access_token": "#{config.access_token}",
-       "data": {
-         "level": "error",
-         "environment": "#{config.environment}",
-         "body": { "message": { "body": "Failsafe from rollbar-gem: #{message}" } },
-         "notifier": { "name": "rollbar-gem", "version": "#{VERSION}" },
-         "internal": true,
-         "failsafe": true
-       }
+      failsafe_data = {
+        :level => 'error',
+        :environment => "#{environment}",
+        :body => { :message => { :body => "Failsafe from rollbar-gem: #{message}" } },
+        :notifier => { :name => 'rollbar-gem', :version => "#{VERSION}" },
+        :internal => true,
+        :failsafe => true
       }
-      eos
+
+      failsafe_payload = build_payload(failsafe_data)
 
       begin
         schedule_payload(failsafe_payload)
@@ -608,7 +615,7 @@ module Rollbar
         log_error "[Rollbar] Error sending failsafe : #{e}"
       end
     end
-    
+
     def enforce_valid_utf8(payload)
       normalizer = Proc.new do |value|
         if value.is_a?(String)

data/lib/rollbar/version.rb

@@ -1,3 +1,3 @@
 module Rollbar
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/rollbar.gemspec

@@ -2,8 +2,8 @@
 require File.expand_path('../lib/rollbar/version', __FILE__)
 
 Gem::Specification.new do |gem|
-  gem.authors       = ["Brian Rue"]
-  gem.email         = ["brian@rollbar.com"]
+  gem.authors       = ["Rollbar, Inc."]
+  gem.email         = ["support@rollbar.com"]
   gem.description   = %q{Rails plugin to catch and send exceptions to Rollbar}
   gem.summary       = %q{Reports exceptions to Rollbar}
   gem.homepage      = "https://github.com/rollbar/rollbar-gem"

data/spec/requests/home_spec.rb

@@ -6,7 +6,7 @@ describe HomeController do
   before(:each) do
     reset_configuration
     Rollbar.configure do |config|
-      config.access_token = 'aaaabbbbccccddddeeeeffff00001111'
+      config.access_token = 'bfec94a1ede64984b862880224edd0ed'
       config.environment = ::Rails.env
       config.root = ::Rails.root
       config.framework = "Rails: #{::Rails::VERSION::STRING}"

data/spec/rollbar_spec.rb

@@ -13,7 +13,7 @@ end
 
 describe Rollbar do
 
-  context 'report_exception' do
+  describe '.report_exception' do
     before(:each) do
       configure
       Rollbar.configure do |config|
@@ -208,12 +208,12 @@ describe Rollbar do
     it 'should report exception objects with no backtrace' do
       payload = nil
       Rollbar.stub(:schedule_payload) do |*args|
-        payload = MultiJson.load(args[0])
+        payload = args[0]
       end
       Rollbar.report_exception(StandardError.new("oops"))
-      payload["data"]["body"]["trace"]["frames"].should == []
-      payload["data"]["body"]["trace"]["exception"]["class"].should == "StandardError"
-      payload["data"]["body"]["trace"]["exception"]["message"].should == "oops"
+      payload["data"][:body][:trace][:frames].should == []
+      payload["data"][:body][:trace][:exception][:class].should == "StandardError"
+      payload["data"][:body][:trace][:exception][:message].should == "oops"
     end
 
     it 'should return the exception data with a uuid, on platforms with SecureRandom' do
@@ -227,7 +227,7 @@ describe Rollbar do
     it 'should report exception objects with nonstandard backtraces' do
       payload = nil
       Rollbar.stub(:schedule_payload) do |*args|
-        payload = MultiJson.load(args[0])
+        payload = args[0]
       end
 
       class CustomException < StandardError
@@ -240,22 +240,22 @@ describe Rollbar do
 
       Rollbar.report_exception(exception)
 
-      payload["data"]["body"]["trace"]["frames"][0]["method"].should == "custom backtrace line"
+      payload["data"][:body][:trace][:frames][0][:method].should == "custom backtrace line"
     end
 
     it 'should report exceptions with a custom level' do
       payload = nil
       Rollbar.stub(:schedule_payload) do |*args|
-        payload = MultiJson.load(args[0])
+        payload = args[0]
       end
 
       Rollbar.report_exception(@exception)
 
-      payload["data"]["level"].should == 'error'
+      payload["data"][:level].should == 'error'
 
       Rollbar.report_exception(@exception, nil, nil, 'debug')
 
-      payload["data"]["level"].should == 'debug'
+      payload["data"][:level].should == 'debug'
     end
   end
 
@@ -475,6 +475,31 @@ describe Rollbar do
       end
     end
 
+    # We should be able to send String payloads, generated
+    # by a previous version of the gem. This can happend just
+    # after a deploy with an gem upgrade.
+    context 'with a payload generated as String' do
+      let(:async_handler) do
+        proc do |payload|
+          # simulate previous gem version
+          string_payload = MultiJson.dump(payload)
+
+          Rollbar.process_payload(string_payload)
+        end
+      end
+
+      before do
+        Rollbar.configuration.stub(:use_async).and_return(true)
+        Rollbar.configuration.stub(:async_handler).and_return(async_handler)
+      end
+
+      it 'sends a payload generated as String, not as a Hash' do
+        logger_mock.should_receive(:info).with('[Rollbar] Success')
+
+        Rollbar.report_exception(@exception)
+      end
+    end
+
     describe "#use_sucker_punch", :if => defined?(SuckerPunch) do
       it "should send the payload to sucker_punch delayer" do
         logger_mock.should_receive(:info).with('[Rollbar] Scheduling payload')
@@ -662,13 +687,13 @@ describe Rollbar do
     let(:logger_mock) { double("Rails.logger").as_null_object }
 
     it 'should build valid json' do
-      json = Rollbar.send(:build_payload, {:foo => {:bar => "baz"}})
-      hash = MultiJson.load(json)
-      hash["data"]["foo"]["bar"].should == "baz"
+      data = { :foo => { :bar => 'baz'}}
+      payload = Rollbar.send(:build_payload, data)
+      payload["data"][:foo][:bar].should == "baz"
     end
-    
+
     it 'should strip out invalid utf-8' do
-      json = Rollbar.send(:build_payload, {
+      payload = Rollbar.send(:build_payload, {
         :good_key => "\255bad value",
         "bad\255 key" => "good value",
         "bad key 2\255" => "bad \255value",
@@ -676,18 +701,20 @@ describe Rollbar do
           "bad array \255key" => ["bad\255 array element", "good array element"]
         }
       })
-      
-      hash = MultiJson.load(json)
-      hash["data"]["good_key"].should == 'bad value'
-      hash["data"]["bad key"].should == 'good value'
-      hash["data"]["bad key 2"].should == 'bad value'
-      hash["data"]["hash"].should == {
+
+      payload["data"][:good_key].should == 'bad value'
+      payload["data"]["bad key"].should == 'good value'
+      payload["data"]["bad key 2"].should == 'bad value'
+      payload["data"][:hash].should == {
         "bad array key" => ["bad array element", "good array element"]
       }
     end
 
     it 'should truncate large strings if the payload is too big' do
-      json = Rollbar.send(:build_payload, {:foo => {:bar => "baz"}, :large => 'a' * (128 * 1024), :small => 'b' * 1024})
+      data = {:foo => {:bar => "baz"}, :large => 'a' * (128 * 1024), :small => 'b' * 1024}
+      payload = Rollbar.send(:build_payload, data)
+      json = Rollbar.send(:dump_payload, payload)
+
       hash = MultiJson.load(json)
       hash["data"]["large"].should == '%s...' % ('a' * 1021)
       hash["data"]["small"].should == 'b' * 1024
@@ -698,14 +725,18 @@ describe Rollbar do
       logger_mock.should_receive(:info).with('[Rollbar] Success')
 
       orig_max = Rollbar::MAX_PAYLOAD_SIZE
-
       Rollbar::MAX_PAYLOAD_SIZE = 1
-      Rollbar.report_exception(@exception)
+      orig_send_failsafe = Rollbar.method(:send_failsafe)
 
-      Rollbar::MAX_PAYLOAD_SIZE = orig_max
+      Rollbar.stub(:send_failsafe) do |message, exception|
+        Rollbar::MAX_PAYLOAD_SIZE = orig_max
+        orig_send_failsafe.call(message, exception)
+      end
+
+      Rollbar.report_exception(@exception)
     end
   end
-  
+
   context 'enforce_valid_utf8' do
     it 'should replace invalid utf8 values' do
       payload = {
@@ -716,7 +747,7 @@ describe Rollbar do
           :inner_bad_value => "\255\255bad value 3",
           "inner \255bad key" => 'inner good value',
           "bad array key\255" => [
-            'good array value 1', 
+            'good array value 1',
             "bad\255 array value 1\255",
             {
               :inner_inner_bad => "bad inner \255inner value"
@@ -727,7 +758,7 @@ describe Rollbar do
 
       payload_copy = payload.clone
       Rollbar.send(:enforce_valid_utf8, payload_copy)
-      
+
       payload_copy[:bad_value].should == "bad value 1"
       payload_copy[:bad_value_2].should == "bad value 2"
       payload_copy["bad key"].should == "good value"
@@ -735,8 +766,8 @@ describe Rollbar do
       payload_copy[:hash][:inner_bad_value].should == "bad value 3"
       payload_copy[:hash]["inner bad key"].should == 'inner good value'
       payload_copy[:hash]["bad array key"].should == [
-        'good array value 1', 
-        'bad array value 1', 
+        'good array value 1',
+        'bad array value 1',
         {
           :inner_inner_bad => 'bad inner inner value'
         }
@@ -881,7 +912,7 @@ describe Rollbar do
 
       gem_paths = gems.map{|gem| Gem::Specification.find_all_by_name(gem).map(&:gem_dir) }.flatten.compact.uniq
       gem_paths.length.should > 1
-    
+
       gem_paths.any?{|path| path.include? 'rollbar-gem'}.should == true
       gem_paths.any?{|path| path.include? 'rspec-rails'}.should == true
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rollbar
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
-- Brian Rue
+- Rollbar, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-17 00:00:00.000000000 Z
+date: 2014-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -124,7 +124,7 @@ dependencies:
         version: 0.2.7
 description: Rails plugin to catch and send exceptions to Rollbar
 email:
-- brian@rollbar.com
+- support@rollbar.com
 executables: []
 extensions: []
 extra_rdoc_files: []