airbrake 3.2.1 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0cb7869b6211b8a5c7157ae331b8ef74a08a8517
-  data.tar.gz: d0ca30c369481d71ab97470a4f59936a5cd3ea98
+  metadata.gz: 72e1f83cf5342499992360dfde17b8f6bf0561b0
+  data.tar.gz: f9ef7c0e8b84e83ce225242db2ac6f344664fe94
 SHA512:
-  metadata.gz: 5dd5a7333f1ac94524d0fdf3a11c913a64bc240a61342d6de1109231fb9fc57df82e406f886ca894f190a357a2dabc955390ed429fc5aa5811663cff8116433b
-  data.tar.gz: 1a032859b51b4b957989239f52b8be83272a1fa38ba566bc55ff5e9d797c03e1ec9199d3755e901f53339db89db070b7c92e660f28cb1a9222ab256a564b0e97
+  metadata.gz: 0ce49cf00de6f908dc39b76061926de33500147cb3ac2e91766ed05f22a347c0dcad9704b0bf2535a745b01da96e39d4202dfee8ad46719b9f35e1c5901f64b4
+  data.tar.gz: a6cf1b8bf91759e3e5cfdd6cbc5d752720428f48465d87980522c3cab288b6115613b271a8521ba483a646836e98aa69bd86db03102d2dfdaac6dea8f8a13ea3

data/CHANGELOG

@@ -1,3 +1,10 @@
+Version 4.0.0 - 2014-05-27 16:32:26 -0700
+===============================================================================
+
+Ali Faiz (2):
+      Remove the Airbrake JS notifier for the major release.
+
+
 Version 3.2.1 - 2014-05-27 15:58:24 -0700
 ===============================================================================
 
@@ -1377,5 +1384,6 @@ Nick Quaranto (3):
 
 
 
+
 
 

data/Rakefile

@@ -69,6 +69,10 @@ namespace :changeling do
     end
 
     case args[:part]
+    when /major/
+      major += 1
+      minor = 0
+      patch = 0
     when /minor/
       minor += 1
       patch = 0
@@ -114,6 +118,12 @@ EOF
           "echo '\n\n\033[32mMarked v#{version} /' `git show-ref -s refs/heads/master` 'for release. Run: rake changeling:push\033[0m\n\n'"].join(' && ')
   end
 
+  desc "Bump by a major version (1.2.3 => 2.0.0)"
+  task :major do |t|
+    Rake::Task['changeling:bump'].invoke(t.name)
+    Rake::Task['changeling:change'].invoke
+  end
+
   desc "Bump by a minor version (1.2.3 => 1.3.0)"
   task :minor do |t|
     Rake::Task['changeling:bump'].invoke(t.name)
@@ -158,7 +168,7 @@ def cucumber_opts
 
   case ENV["BUNDLE_GEMFILE"]
   when /rails/
-    opts << "features/rails.feature features/rails_with_js_notifier.feature features/metal.feature features/user_informer.feature"
+    opts << "features/rails.feature features/metal.feature features/user_informer.feature"
   when /rack/
     opts << "features/rack.feature"
   when /sinatra/

data/features/step_definitions/rails_application_steps.rb

@@ -192,32 +192,6 @@ When /^I configure the application to filter parameter "([^\"]*)"$/ do |paramete
   end
 end
 
-Then /^I should see the notifier JavaScript for the following:$/ do |table|
-  hash = table.hashes.first
-  host        = hash['host']        || 'api.airbrake.io'
-  secure      = hash['secure']      || false
-  api_key     = hash['api_key']
-  environment = hash['environment'] || 'production'
-
-  steps %{
-    Then the output should contain "#{host}/javascripts/notifier.js"
-    And the output should contain "Airbrake.setKey('#{api_key}');"
-    And the output should contain "Airbrake.setHost('#{host}');"
-    And the output should contain "Airbrake.setEnvironment('#{environment}');"
-  }
-end
-
-Then /^the notifier JavaScript should provide the following errorDefaults:$/ do |table|
-  hash = table.hashes.first
-  hash.each do |key, value|
-    assert_matching_output("Airbrake\.setErrorDefaults.*#{key}: \"#{value}\"",all_output)
-  end
-end
-
-Then /^I should not see notifier JavaScript$/ do
-  step %{the output should not contain "script[type='text/javascript'][src$='/javascripts/notifier.js']"}
-end
-
 When /^I have set up authentication system in my app that uses "([^\"]*)"$/ do |current_user|
   application_controller = File.join(rails_root, 'app', 'controllers', "application_controller.rb")
   definition =

data/lib/airbrake/configuration.rb

@@ -2,7 +2,7 @@ module Airbrake
   # Used to set up and modify settings for the notifier.
   class Configuration
 
-    OPTIONS = [:api_key, :js_api_key, :backtrace_filters, :development_environments,
+    OPTIONS = [:api_key, :backtrace_filters, :development_environments,
         :development_lookup, :environment_name, :host,
         :http_open_timeout, :http_read_timeout, :ignore, :ignore_by_filters,
         :ignore_user_agent, :notifier_name, :notifier_url, :notifier_version,
@@ -14,12 +14,6 @@ module Airbrake
     # The API key for your project, found on the project edit form.
     attr_accessor :api_key
 
-    # If you're using the Javascript notifier and would want to separate
-    # Javascript notifications into another Airbrake project, specify
-    # its APi key here.
-    # Defaults to #api_key (of the base project)
-    attr_writer :js_api_key
-
     # The host to connect to (defaults to airbrake.io).
     attr_accessor :host
 
@@ -158,7 +152,6 @@ module Airbrake
     alias_method :use_system_ssl_cert_chain?, :use_system_ssl_cert_chain
 
     def initialize
-      @js_api_key               = nil
       @secure                   = false
       @use_system_ssl_cert_chain= false
       @host                     = 'api.airbrake.io'
@@ -311,14 +304,6 @@ module Airbrake
       @rescue_rake_exceptions = val
     end
 
-    def js_api_key
-      @js_api_key || self.api_key
-    end
-
-    def js_notifier=(*args)
-      warn '[AIRBRAKE] config.js_notifier has been deprecated and has no effect.  You should use <%= airbrake_javascript_notifier %> directly at the top of your layouts.  Be sure to place it before all other javascript.'
-    end
-
     def ca_bundle_path
       if use_system_ssl_cert_chain? && File.exist?(OpenSSL::X509::DEFAULT_CERT_FILE)
         OpenSSL::X509::DEFAULT_CERT_FILE

data/lib/airbrake/rails.rb

@@ -2,7 +2,6 @@ require 'airbrake'
 require 'airbrake/rails/controller_methods'
 require 'airbrake/rails/action_controller_catcher'
 require 'airbrake/rails/error_lookup'
-require 'airbrake/rails/javascript_notifier'
 
 module Airbrake
   module Rails
@@ -11,7 +10,6 @@ module Airbrake
         ActionController::Base.send(:include, Airbrake::Rails::ActionControllerCatcher)
         ActionController::Base.send(:include, Airbrake::Rails::ErrorLookup)
         ActionController::Base.send(:include, Airbrake::Rails::ControllerMethods)
-        ActionController::Base.send(:include, Airbrake::Rails::JavascriptNotifier)
       end
 
       rails_logger = if defined?(::Rails.logger)

data/lib/airbrake/railtie.rb

@@ -41,12 +41,6 @@ module Airbrake
 
         include Airbrake::Rails::ControllerMethods
       end
-
-      if defined?(::ActionController::Base)
-        require 'airbrake/rails/javascript_notifier'
-
-        ::ActionController::Base.send(:include, Airbrake::Rails::JavascriptNotifier)
-      end
     end
   end
 end

data/lib/airbrake/version.rb

@@ -1,3 +1,3 @@
 module Airbrake
-  VERSION = "3.2.1".freeze
+  VERSION = "4.0.0".freeze
 end

data/test/configuration_test.rb

@@ -127,14 +127,6 @@ class ConfigurationTest < Test::Unit::TestCase
     assert_appends_value :rake_environment_filters
   end
 
-  should "warn when attempting to write js_notifier" do
-    config = Airbrake::Configuration.new
-    config.
-      expects(:warn).
-      with(regexp_matches(/deprecated/i))
-    config.js_notifier = true
-  end
-
   should "allow ignored user agents to be appended" do
     assert_appends_value :ignore_user_agent
   end

data/test/integration.rb

@@ -11,5 +11,4 @@ silence_warnings do
   require "action_view"
 end
 
-require File.expand_path "../integration/javascript_notifier_test", __FILE__
 require File.expand_path "../integration/catcher_test", __FILE__

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: airbrake
 version: !ruby/object:Gem::Version
-  version: 3.2.1
+  version: 4.0.0
 platform: ruby
 authors:
 - Airbrake
@@ -311,7 +311,6 @@ files:
 - features/metal.feature
 - features/rack.feature
 - features/rails.feature
-- features/rails_with_js_notifier.feature
 - features/rake.feature
 - features/sinatra.feature
 - features/step_definitions/file_steps.rb
@@ -351,7 +350,6 @@ files:
 - lib/airbrake/rails/action_controller_catcher.rb
 - lib/airbrake/rails/controller_methods.rb
 - lib/airbrake/rails/error_lookup.rb
-- lib/airbrake/rails/javascript_notifier.rb
 - lib/airbrake/rails/middleware.rb
 - lib/airbrake/rails3_tasks.rb
 - lib/airbrake/railtie.rb
@@ -368,8 +366,6 @@ files:
 - lib/airbrake/version.rb
 - lib/airbrake_tasks.rb
 - lib/rails/generators/airbrake/airbrake_generator.rb
-- lib/templates/javascript_notifier_configuration
-- lib/templates/javascript_notifier_loader
 - lib/templates/rescue.erb
 - rails/init.rb
 - resources/README.md
@@ -385,7 +381,6 @@ files:
 - test/helper.rb
 - test/integration.rb
 - test/integration/catcher_test.rb
-- test/integration/javascript_notifier_test.rb
 - test/logger_test.rb
 - test/notice_test.rb
 - test/notifier_test.rb
@@ -428,7 +423,6 @@ test_files:
 - test/controller_methods_test.rb
 - test/helper.rb
 - test/integration/catcher_test.rb
-- test/integration/javascript_notifier_test.rb
 - test/integration.rb
 - test/logger_test.rb
 - test/notice_test.rb
@@ -444,7 +438,6 @@ test_files:
 - features/metal.feature
 - features/rack.feature
 - features/rails.feature
-- features/rails_with_js_notifier.feature
 - features/rake.feature
 - features/sinatra.feature
 - features/step_definitions/file_steps.rb

data/features/rails_with_js_notifier.feature

@@ -1,104 +0,0 @@
-Feature: Install the Gem in a Rails application and enable the JavaScript notifier
-
-  Background:
-    Given I successfully run `rails new rails_root -O --skip-gemfile`
-    And I cd to "rails_root"
-    And I configure the Airbrake shim
-
-  Scenario: Include the Javascript notifier when enabled
-    When I configure the notifier to use the following configuration lines:
-      """
-      config.api_key     = "myapikey"
-      """
-    And I define a response for "TestController#index":
-      """
-        render :inline => '<html><head profile="http://example.com"><%= airbrake_javascript_notifier %></head><body></body></html>'
-      """
-    And I route "/test/index" to "test#index"
-    And I perform a request to "http://example.com:123/test/index" in the "production" environment
-    Then I should see the notifier JavaScript for the following:
-      | api_key  | environment | host           |
-      | myapikey | production  | api.airbrake.io |
-    And the notifier JavaScript should provide the following errorDefaults:
-      | url                           | component | action |
-      | http://example.com:123/test/index | test      | index  |
-
-  Scenario: Include the Javascript notifier when enabled using custom configuration settings
-    When I configure the notifier to use the following configuration lines:
-      """
-      config.development_environments = []
-      config.api_key     = "myapikey!"
-      config.host        = "myairbrake.com"
-      config.port        = 3001
-      """
-    And I define a response for "TestController#index":
-      """
-        render :inline => '<html><head><%= airbrake_javascript_notifier %></head><body></body></html>'
-      """
-    And I route "/test/index" to "test#index"
-    And I perform a request to "http://example.com:123/test/index"
-    Then I should see the notifier JavaScript for the following:
-      | api_key   | environment | host               |
-      | myapikey! | test  | myairbrake.com:3001 |
-
-  Scenario: Don't include the Javascript notifier by default
-    When I configure the notifier to use the following configuration lines:
-      """
-      config.api_key = "myapikey!"
-      """
-    And I define a response for "TestController#index":
-      """
-        render :inline => "<html><head></head><body></body></html>"
-      """
-    And I route "/test/index" to "test#index"
-    And I perform a request to "http://example.com:123/test/index"
-    Then I should not see notifier JavaScript
-
-  Scenario: Don't include the Javascript notifier when enabled in non-public environments
-    When I configure the notifier to use the following configuration lines:
-      """
-      config.api_key          = "myapikey!"
-      config.environment_name = 'test'
-      """
-    And I define a response for "TestController#index":
-      """
-        render :inline => '<html><head><%= airbrake_javascript_notifier %></head><body></body></html>'
-      """
-    And I route "/test/index" to "test#index"
-    And I perform a request to "http://example.com:123/test/index" in the "test" environment
-    Then I should not see notifier JavaScript
-
-  Scenario: Use the js_api_key if present
-    When I configure the notifier to use the following configuration lines:
-      """
-      config.api_key     = "myapikey!"
-      config.js_api_key     = "myjsapikey!"
-      """
-    And I define a response for "TestController#index":
-      """
-        render :inline => '<html><head><%= airbrake_javascript_notifier %></head><body></body></html>'
-      """
-    And I route "/test/index" to "test#index"
-    And I perform a request to "http://example.com:123/test/index" in the "production" environment
-    Then I should see the notifier JavaScript for the following:
-      | api_key     | environment | host        |
-      | myjsapikey! | production  | api.airbrake.io |
-
-  Scenario: Being careful with user's instance variables
-    When I configure the notifier to use the following configuration lines:
-      """
-      config.api_key     = "myapikey"
-      """
-    And I define a response for "TestController#index":
-      """
-        @template = "this is some random instance variable"
-        render :inline => '<html><head><%= airbrake_javascript_notifier %></head><body></body></html>'
-      """
-    And I route "/test/index" to "test#index"
-    And I perform a request to "http://example.com:123/test/index" in the "production" environment
-    Then I should see the notifier JavaScript for the following:
-      | api_key  | environment | host           |
-      | myapikey | production  | api.airbrake.io |
-    And the notifier JavaScript should provide the following errorDefaults:
-      | url                           | component | action |
-      | http://example.com:123/test/index | test      | index  |

data/lib/airbrake/rails/javascript_notifier.rb

@@ -1,85 +0,0 @@
-module Airbrake
-  module Rails
-    module JavascriptNotifier
-      def self.included(base) #:nodoc:
-        base.send :helper_method, :airbrake_javascript_notifier
-        base.send :helper_method, :airbrake_javascript_loader
-        base.send :helper_method, :airbrake_javascript_configuration
-      end
-
-      private
-
-        def airbrake_javascript_notifier
-          warn '[DEPRECATION] `airbrake_javascript_notifier` is deprecated and will no longer be supported in v4.0.0. /
-            Please use the official Airbrake JavaScript Notifier - https://github.com/airbrake/airbrake-js'
-          if Airbrake.configuration.public?
-            airbrake_javascript_loader + airbrake_javascript_configuration
-          end
-        end
-
-        def airbrake_javascript_loader
-          if Airbrake.configuration.public?
-            path = File.join File.dirname(__FILE__), '..', '..', 'templates', 'javascript_notifier_loader'
-
-            _airbrake_render_part path
-          end
-        end
-
-        def airbrake_javascript_configuration
-          if Airbrake.configuration.public?
-            path = File.join File.dirname(__FILE__), '..', '..', 'templates', 'javascript_notifier_configuration'
-
-            options              = {
-              :api_key         => Airbrake.configuration.js_api_key,
-              :environment     => Airbrake.configuration.environment_name,
-              :action_name     => action_name,
-              :controller_name => controller_name,
-              :url             => request.url
-            }
-
-            _airbrake_render_part path, options
-          end
-        end
-
-      protected
-        attr_reader :template
-
-        def _airbrake_render_part(path, locals={})
-          locals[:host] = _airbrake_host
-
-          options              = {
-            :file              => path,
-            :layout            => false,
-            :use_full_path     => false,
-            :handlers          => [:erb],
-            :locals            => locals
-          }
-
-          result = _airbrake_render_template options
-
-          if result.respond_to?(:html_safe)
-            result.html_safe
-          else
-            result
-          end
-        end
-
-        def _airbrake_render_template(options)
-          case template
-          when ActionView::Template
-            template.render options
-          else
-            render_to_string options
-          end
-        end
-
-        def _airbrake_host
-          host = Airbrake.configuration.host.dup
-          port = Airbrake.configuration.port
-          host << ":#{port}" unless [80, 443].include?(port)
-
-          host
-        end
-    end
-  end
-end

data/lib/templates/javascript_notifier_configuration

@@ -1,12 +0,0 @@
-<%= javascript_tag %Q{
-    try {
-      window.Airbrake = (typeof(Airbrake) == 'undefined' && typeof(Hoptoad) != 'undefined') ? Hoptoad : Airbrake
-      Airbrake.setKey('#{api_key}');
-      Airbrake.setHost('#{host}');
-      Airbrake.setEnvironment('#{environment}');
-      Airbrake.setErrorDefaults({ url: "#{escape_javascript url}", component: "#{controller_name}", action: "#{action_name}" });
-    } catch (e) {
-      window.onerror = null;
-    }
-  }
-%>

data/lib/templates/javascript_notifier_loader

@@ -1,6 +0,0 @@
-<%= javascript_tag %Q{
-  (function(){
-    var notifierJsScheme = (("https:" == document.location.protocol) ? "https://" : "http://");
-    document.write(unescape("%3Cscript src='" + notifierJsScheme + "#{host}/javascripts/notifier.js' type='text/javascript'%3E%3C/script%3E"));
-  })();
-}%>

data/test/integration/javascript_notifier_test.rb

@@ -1,56 +0,0 @@
-require 'airbrake/rails/javascript_notifier'
-require 'ostruct'
-
-class JavascriptNotifierTest < Test::Unit::TestCase
-  module FakeRenderer
-    def javascript_tag(text)
-      "<script>#{text}</script>"
-    end
-    def escape_javascript(text)
-      "ESC#{text}ESC"
-    end
-  end
-
-  class FakeController
-    def self.helper_method(*args)
-    end
-
-    include Airbrake::Rails::JavascriptNotifier
-
-    def action_name
-      "action"
-    end
-
-    def controller_name
-      "controller"
-    end
-
-    def request
-      @request ||= OpenStruct.new
-    end
-
-    def render_to_string(options)
-      context = OpenStruct.new(options[:locals])
-      context.extend(FakeRenderer)
-      context.instance_eval do
-        erb = ERB.new(IO.read(options[:file]))
-        erb.result(binding)
-      end
-    end
-  end
-
-  should "make sure escape_javacript is called on the request.url" do
-    Airbrake.configure do
-    end
-    controller = FakeController.new
-    controller.request.url = "bad_javascript"
-    assert controller.send(:airbrake_javascript_notifier)['"ESCbad_javascriptESC"']
-    assert ! controller.send(:airbrake_javascript_notifier)['"bad_javascript"']
-  end
-
-  should "not raise exceptions for the non-public requests" do
-    Airbrake::Configuration.any_instance.stubs(:public? => false)
-    controller = FakeController.new
-    assert_nothing_raised { controller.send(:airbrake_javascript_notifier) }
-  end
-end