rollbar 2.15.4 → 2.15.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c60966d24610fbe373f854b21535910882d1cd4d
-  data.tar.gz: 1d95ea09dc8976249d707688d6926f7bb9821c42
+  metadata.gz: 9ea41fac2007e3ba3b7b13f63f572cc2c1c9d6e2
+  data.tar.gz: 61e75c88eb2f4f53354450dbec86a09f6f08878b
 SHA512:
-  metadata.gz: 8a342a07440f837a708affbca68d33b49c12d31caf7cff6d8b8aaeeb1ccac7c50294905acf42ee0842b37a9e4dbd1159e3f35f38af4bfeda676fa827ee25479a
-  data.tar.gz: 7d22126d64ae9350f3b7caa1385a5c6c0585097c89bedca2cab7513caa29f23708671b43a97560c10fc375e550ab0875c6ccbb85932e624dab2e346fe22a25c3
+  metadata.gz: bbee402f2d4a50db12cfb30d1f4ccaadaeef12e3e51c71e5363abfe658f1b8362a9985fded59cb01e0f9f48f30bc10fe97cf654934f68ce42fc4a067bc10541c
+  data.tar.gz: 12776611c225ac3cddc5a04054ab0499e1fffdfc80ba72afea3efac838c17ac1c4859355b6687e24690ab709502242f6e1a2c5ba3c9fc974fd536f3b18e3a592

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change Log
 
+## 2.15.5
+
+- Support proxies [#626](https://github.com/rollbar/rollbar-gem/pull/626)
+
 ## 2.15.4
 
 - Fix bug related to dup'ing extra passed in data

data/README.md

@@ -1,4 +1,4 @@
-# Rollbar [![Build Status](https://api.travis-ci.org/rollbar/rollbar-gem.svg?branch=v2.15.4)](https://travis-ci.org/rollbar/rollbar-gem/branches)
+# Rollbar [![Build Status](https://api.travis-ci.org/rollbar/rollbar-gem.svg?branch=v2.15.5)](https://travis-ci.org/rollbar/rollbar-gem/branches)
 
 <!-- RemoveNext -->
 [Rollbar](https://rollbar.com) is an error tracking service for Ruby and other languages. The Rollbar service will alert you of problems with your code and help you understand them in a ways never possible before. We love it and we hope you will too.
@@ -1013,6 +1013,24 @@ Rollbar.configure do |config|
 end
 ```
 
+## Web Proxies
+
+If your application is deployed behind a proxy server, you can set the ```https_proxy``` (note the 's') environment variable and it will be honored, including username and password, if any.
+
+```shell
+export https_proxy='http://some_user:some_password@some.proxy.com:80'
+```
+
+Alternately, you can configure the proxy settings in  ```config/initializers/rollbar.rb```.  If used, ```host``` is mandatory and must include the URL scheme (e.g. ```http://```), all other fields are optional:
+
+```ruby
+config.proxy = {
+  host: 'http://some.proxy.server',
+  port: 80,
+  user: 'username_if_auth_required',
+  password: 'password_if_auth_required'
+}
+```
 
 ## Using with Zeus
 

data/lib/generators/rollbar/templates/initializer.rb

@@ -57,6 +57,18 @@ Rollbar.configure do |config|
   # You can supply custom Sidekiq options:
   # config.use_sidekiq 'queue' => 'default'
 
+  # If your application runs behind a proxy server, you can set proxy parameters here.
+  # If https_proxy is set in your environment, that will be used. Settings here have precedence.
+  # The :host key is mandatory and must include the URL scheme (e.g. 'http://'), all other fields
+  # are optional.
+  #
+  # config.proxy = {
+  #   host: 'http://some.proxy.server',
+  #   port: 80,
+  #   user: 'username_if_auth_required',
+  #   password: 'password_if_auth_required'
+  # }
+
   # If you run your staging application instance in production environment then
   # you'll want to override the environment reported by `Rails.env` with an
   # environment variable like this: `ROLLBAR_ENV=staging`. This is a recommended

data/lib/rollbar/configuration.rb

@@ -56,6 +56,7 @@ module Rollbar
     attr_accessor :write_to_file
     attr_reader :send_extra_frame_data
     attr_accessor :use_exception_level_filters_default
+    attr_accessor :proxy
 
     attr_reader :project_gem_paths
 
@@ -118,6 +119,7 @@ module Rollbar
       @send_extra_frame_data = :none
       @project_gem_paths = []
       @use_exception_level_filters_default = false
+      @proxy = nil
     end
 
     def initialize_copy(orig)

data/lib/rollbar/notifier.rb

@@ -8,6 +8,7 @@ require 'rollbar/delay/girl_friday'
 require 'rollbar/delay/thread'
 require 'rollbar/logger_proxy'
 require 'rollbar/item'
+require 'ostruct'
 
 module Rollbar
   # The notifier class. It has the core functionality
@@ -438,12 +439,13 @@ module Rollbar
 
     ## Delivery functions
 
-    def send_item_using_eventmachine(item)
+    def send_item_using_eventmachine(item, uri)
       body = item.dump
       return unless body
 
       headers = { 'X-Rollbar-Access-Token' => item['access_token'] }
-      req = EventMachine::HttpRequest.new(configuration.endpoint).post(:body => body, :head => headers)
+      options = http_proxy_for_em(uri)
+      req = EventMachine::HttpRequest.new(uri.to_s, options).post(:body => body, :head => headers)
 
       req.callback do
         if req.response_header.status == 200
@@ -463,21 +465,23 @@ module Rollbar
     def send_item(item)
       log_info '[Rollbar] Sending item'
 
-      if configuration.use_eventmachine
-        send_item_using_eventmachine(item)
-        return
-      end
-
       body = item.dump
       return unless body
 
       uri = URI.parse(configuration.endpoint)
 
+      if configuration.use_eventmachine
+        send_item_using_eventmachine(item, uri)
+        return
+      end
+
       handle_response(do_post(uri, body, item['access_token']))
     end
 
     def do_post(uri, body, access_token)
-      http = Net::HTTP.new(uri.host, uri.port)
+      proxy = http_proxy(uri)
+      http  = Net::HTTP.new(uri.host, uri.port, proxy.host, proxy.port, proxy.user, proxy.password)
+
       http.open_timeout = configuration.open_timeout
       http.read_timeout = configuration.request_timeout
 
@@ -496,6 +500,40 @@ module Rollbar
       handle_net_retries { http.request(request) }
     end
 
+    def http_proxy_for_em(uri)
+      proxy = http_proxy(uri)
+      {
+        :proxy => {
+          :host => proxy.host,
+          :port => proxy.port,
+          :authorization => [proxy.user, proxy.password]
+        }
+      }
+    end
+
+    def http_proxy(uri)
+      @http_proxy ||= proxy_from_config || proxy_from_env(uri) || null_proxy
+    end
+
+    def proxy_from_config
+      proxy = configuration.proxy
+      return nil unless proxy
+
+      px = URI.parse(proxy[:host])
+      px.port = proxy[:port]
+      px.user = proxy[:user]
+      px.password = proxy[:password]
+      px
+    end
+
+    def proxy_from_env(uri)
+      uri.find_proxy
+    end
+
+    def null_proxy
+      Struct.new(:host, :port, :user, :password).new
+    end
+
     def handle_net_retries
       return yield if skip_retries?
 

data/lib/rollbar/version.rb

@@ -1,3 +1,3 @@
 module Rollbar
-  VERSION = '2.15.4'
+  VERSION = '2.15.5'
 end

data/spec/rollbar_spec.rb

@@ -8,6 +8,8 @@ require 'active_support/core_ext/object'
 require 'active_support/json/encoding'
 
 require 'rollbar/item'
+require 'ostruct'
+
 begin
   require 'rollbar/delay/sidekiq'
   require 'rollbar/delay/sucker_punch'
@@ -1008,6 +1010,62 @@ describe Rollbar do
     end
   end
 
+  context 'using a proxy server' do
+    before do
+      allow_any_instance_of(Net::HTTP).to receive(:request).and_return(OpenStruct.new(:code => 200, :body => "Success"))
+      @env_vars = clear_proxy_env_vars
+    end
+
+    after do
+     restore_proxy_env_vars(@env_vars)
+    end
+
+    context 'via environment variables' do
+      it 'honors proxy settings in the environment' do
+        ENV['http_proxy']  = 'http://user:pass@example.com:80'
+        ENV['https_proxy'] = 'http://user:pass@example.com:80'
+
+        uri = URI.parse(Rollbar::Configuration::DEFAULT_ENDPOINT)
+        expect(Net::HTTP).to receive(:new).with(uri.host, uri.port, 'example.com', 80, 'user', 'pass').and_call_original
+        Rollbar.info("proxy this")
+      end
+
+      it 'does not use a proxy if no proxy settings in environemnt' do
+        uri = URI.parse(Rollbar::Configuration::DEFAULT_ENDPOINT)
+        expect(Net::HTTP).to receive(:new).with(uri.host, uri.port, nil, nil, nil, nil).and_call_original
+        Rollbar.info("proxy this")
+      end
+    end
+
+    context 'set in configuration file' do
+      before do
+        Rollbar.configure do |config|
+          config.proxy = {
+            :host => 'http://config.com',
+            :port => 8080,
+            :user => 'foo',
+            :password => 'bar'
+          }
+        end
+      end
+
+      it 'honors proxy settings in the config file' do
+        uri = URI.parse(Rollbar::Configuration::DEFAULT_ENDPOINT)
+        expect(Net::HTTP).to receive(:new).with(uri.host, uri.port, 'config.com', 8080, 'foo', 'bar').and_call_original
+        Rollbar.info("proxy this")
+      end
+
+      it 'gives the configuration settings precedence over environment' do
+        ENV['http_proxy']  = 'http://user:pass@example.com:80'
+        ENV['https_proxy'] = 'http://user:pass@example.com:80'
+
+        uri = URI.parse(Rollbar::Configuration::DEFAULT_ENDPOINT)
+        expect(Net::HTTP).to receive(:new).with(uri.host, uri.port, 'config.com', 8080, 'foo', 'bar').and_call_original
+        Rollbar.info("proxy this")
+      end
+    end
+  end
+
   context 'asynchronous_handling' do
     before do
       Rollbar.clear_notifier!

data/spec/support/notifier_helpers.rb

@@ -36,4 +36,22 @@ module NotifierHelpers
     Rollbar.reconfigure do |config|
     end
   end
+
+  def clear_proxy_env_vars
+    env_vars = {}
+    proxy_env_vars.each do |var|
+      env_vars[var] = ENV.delete(var)
+    end
+    env_vars
+  end
+
+  def restore_proxy_env_vars(env_vars)
+    proxy_env_vars.each do |var|
+      ENV[var] = env_vars[var]
+    end
+  end
+
+  def proxy_env_vars
+    %w[http_proxy HTTP_PROXY https_proxy HTTPS_PROXY]
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rollbar
 version: !ruby/object:Gem::Version
-  version: 2.15.4
+  version: 2.15.5
 platform: ruby
 authors:
 - Rollbar, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-19 00:00:00.000000000 Z
+date: 2017-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json