toadhopper 2.0 → 2.1

data/test/helper.rb

@@ -2,13 +2,50 @@ require 'bundler/setup'
 require 'test/unit'
 require 'fakeweb'
 require 'toadhopper'
+require 'nokogiri'
 
-FakeWeb.allow_net_connect = true
+def reset_test_env
+  FakeWeb.clean_registry
+  FakeWeb.allow_net_connect = false
+end
 
 def toadhopper
-  @toadhopper ||= Toadhopper.new(ENV['AIRBRAKE_API_KEY'] || ENV['HOPTOAD_API_KEY'] || "test api key")
+  api_key = toadhopper_api_key || 'test api key'
+  Toadhopper.new api_key, toadhopper_args
+end
+
+def toadhopper_api_key
+  ENV['AIRBRAKE_API_KEY'] || ENV['HOPTOAD_API_KEY']
+end
+
+def toadhopper_args
+  ENV['AIRBRAKE_FULL_TEST'] ? {:notify_host => "https://#{Toadhopper::DEFAULT_DOMAIN}"} : {}
+end
+
+def assert_valid_airbrake_xml(body)
+  # prepare schema for validation
+  xsd_path = File.expand_path File.join('resources', 'airbrake_2_2.xsd'),
+    File.dirname(__FILE__)
+  xsd = Nokogiri::XML::Schema File.read xsd_path
+  # validate xml document
+  #doc = Nokogiri::XML body
+  doc = Nokogiri::XML body
+  assert xsd.valid?(doc), "The document is not valid:\n#{body}"
+end
+
+def posting_response_good
+"<notice>
+<id>d87i3bc8-1854-f937-184b-e2d93711cad3</id>
+<url>#{Toadhopper::DEFAULT_NOTIFY_HOST}/locate/d87i3bc8-1854-f937-184b-e2d93711cad3</url>
+</notice>"
+end
+
+def posting_response_bad_apikey
+  'We could not find a project with API key of foo.  Please double check your airbrake configuration.'
 end
 
 def error
   begin; raise "Kaboom!"; rescue => e; e end
 end
+
+reset_test_env

data/test/resources/airbrake_2_2.xsd

@@ -0,0 +1,78 @@
+<?xml version="1.0"?>
+<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
+
+  <xs:element name="notice">
+    <xs:complexType>
+      <xs:all>
+        <xs:element name="api-key" type="xs:string"/>
+        <xs:element name="notifier" type="notifier"/>
+        <xs:element name="error" type="error"/>
+        <xs:element name="request" type="request" minOccurs="0"/>
+        <xs:element name="server-environment" type="serverEnvironment"/>
+      </xs:all>
+      <xs:attribute name="version" type="xs:string" use="required"/>
+    </xs:complexType>
+  </xs:element>
+
+  <xs:complexType name="notifier">
+    <xs:all>
+      <xs:element name="name" type="xs:string"/>
+      <xs:element name="version" type="xs:string"/>
+      <xs:element name="url" type="xs:string"/>
+    </xs:all>
+  </xs:complexType>
+
+  <xs:complexType name="error">
+    <xs:all>
+      <xs:element name="class" type="xs:string"/>
+      <xs:element name="message" type="xs:string" minOccurs="0"/>
+      <xs:element name="backtrace" type="backtrace"/>
+    </xs:all>
+  </xs:complexType>
+
+  <xs:complexType name="backtrace">
+    <xs:sequence>
+      <xs:element name="line" maxOccurs="unbounded">
+        <xs:complexType>
+          <xs:attribute name="file" type="xs:string" use="required"/>
+          <xs:attribute name="number" type="xs:string" use="required"/>
+          <xs:attribute name="method" type="xs:string" use="optional"/>
+        </xs:complexType>
+      </xs:element>
+    </xs:sequence>
+  </xs:complexType>
+
+  <xs:complexType name="request">
+    <xs:all>
+      <xs:element name="url" type="xs:string"/>
+      <xs:element name="component" type="xs:string"/>
+      <xs:element name="action" type="xs:string" minOccurs="0"/>
+      <xs:element name="params" type="varList" minOccurs="0"/>
+      <xs:element name="session" type="varList" minOccurs="0"/>
+      <xs:element name="cgi-data" type="varList" minOccurs="0"/>
+    </xs:all>
+  </xs:complexType>
+
+  <xs:complexType name="varList">
+    <xs:sequence>
+      <xs:element name="var" type="var" maxOccurs="unbounded"/>
+    </xs:sequence>
+  </xs:complexType>
+
+  <xs:complexType name="var" mixed="true">
+    <xs:sequence>
+      <xs:element name="var" type="var" minOccurs="0" maxOccurs="unbounded"/>
+    </xs:sequence>
+    <xs:attribute name="key" type="xs:string" use="required"/>
+  </xs:complexType>
+
+  <xs:complexType name="serverEnvironment">
+    <xs:sequence>
+      <xs:element name="project-root" type="xs:string" minOccurs="0"/>
+      <xs:element name="environment-name" type="xs:string"/>
+      <xs:element name="app-version" type="xs:string" minOccurs="0"/>
+      <xs:element name="hostname" type="xs:string" minOccurs="0"/>
+    </xs:sequence>
+  </xs:complexType>
+
+</xs:schema>

data/test/test_deploy_tracking.rb

@@ -3,13 +3,69 @@ require 'cgi'
 require 'fakeweb'
 
 class Toadhopper::TestDeployTracking < Test::Unit::TestCase
+  BOGUS_KEY = 'bogus_key'
+
   def test_deploy
-    FakeWeb.register_uri(:post, 'http://airbrakeapp.com/deploys.txt', :status => ['200', 'Ok'])
-    options = {:framework_env => 'test', :scm_revision => 3, :scm_repository => 'some/where', :username => 'phil'}
-    response = Toadhopper('bogus key').deploy!(options)
-    request = FakeWeb.last_request
-    expected_parameters = {'api_key' => 'bogus key', 'deploy[rails_env]' => 'test', 'deploy[scm_revision]' => '3', 'deploy[scm_repository]' => 'some/where', 'deploy[local_username]' => 'phil'}
+    response_body = 'Recorded deploy of My Awesome App to test.'
+    FakeWeb.register_uri(:post, "http://#{Toadhopper::DEFAULT_DOMAIN}/deploys.txt", :body => response_body, :status => ['200', 'Ok'])
+    response = Toadhopper(BOGUS_KEY).deploy!(options)
+    # Check our request
+    assert_equal expected_parameters, query_to_hash(FakeWeb.last_request.body)
+    # Check how we capture the mock response
+    assert_equal 200, response.status, response
+    assert_equal response_body, response.body, response
+    assert_equal [], response.errors, response
+  end
+
+  def test_fake_secure_deploy
+    response_body = 'Recorded deploy of Foo to test.'
+    FakeWeb.register_uri(:post, "https://#{Toadhopper::DEFAULT_DOMAIN}/deploys.txt", :body => response_body, :status => ['200', 'OK'])
+    response = Toadhopper.new(BOGUS_KEY, :notify_host => "https://#{Toadhopper::DEFAULT_DOMAIN}").deploy!(options)
+    # Check our request
+    assert_equal expected_parameters, query_to_hash(FakeWeb.last_request.body)
+    # Check how we capture the mock response
     assert_equal 200, response.status
-    assert_equal expected_parameters, Hash[CGI.unescape(FakeWeb.last_request.body).split('&').map { |x| x.split('=') }]
+    assert_equal response_body, response.body, response
+    assert_equal [], response.errors, response
+  end
+
+  def test_deploy_integration_bad_key
+    FakeWeb.allow_net_connect = true
+    response = Toadhopper('bogus key').deploy!(options)
+    # Check how we capture the live response
+    assert_equal 403, response.status, response
+    expected_error = 'could not find a project with API key'
+    assert_match expected_error, response.body, response
+    assert_equal 1, response.errors.size, response
+    assert_match expected_error, response.errors.first, response
+  end
+
+  if toadhopper_api_key and ENV['AIRBRAKE_FULL_TEST']
+    def test_deploy_integration_good_key
+      FakeWeb.allow_net_connect = true
+      opts = {:scm_repository => 'git://github.com/toolmantim/toadhopper.git', :scm_revision => '5e15028652023c98c70ac275b5f04bb368e04773'}
+      response = toadhopper.deploy!(opts)
+      # Check how we capture the live response
+      assert_equal 200, response.status, response
+      assert_match 'Recorded deploy', response.body, response
+      assert_equal [], response.errors, response
+    end
+  end
+
+  def options
+    {:framework_env => 'test', :scm_revision => 3, :scm_repository => 'some/where', :username => 'phil'}
+  end
+
+  def expected_parameters
+    {'api_key' => BOGUS_KEY, 'deploy[rails_env]' => 'test', 'deploy[scm_revision]' => '3', 'deploy[scm_repository]' => 'some/where', 'deploy[local_username]' => 'phil'}
+  end
+
+  def query_to_hash(query)
+    Hash[CGI.unescape(query).split('&').map { |x| x.split('=') }]
+  end
+
+  # This method is called automatically after every test
+  def teardown
+    reset_test_env
   end
 end

data/test/test_filtering.rb

@@ -23,8 +23,9 @@ class Toadhopper::TestFiltering < Test::Unit::TestCase
   end
 
   def filtered_document(key, value, filter)
-    toadhopper.filters = filter
+    toad = toadhopper
+    toad.filters = filter
     hash = {"nested" => {key => value}, key => value}
-    toadhopper.__send__(:document_for, error, {:params => hash, :session => hash, :environment => hash})
+    toad.__send__(:document_for, error, {:params => hash, :session => hash, :environment => hash})
   end
 end

data/test/test_initialization.rb

@@ -0,0 +1,83 @@
+require 'helper'
+
+class Toadhopper::TestInitialization < Test::Unit::TestCase
+  MY_KEY = 'my key'
+
+  def test_defaults
+    assert_equal 'airbrake.io', Toadhopper::DEFAULT_DOMAIN
+    assert_equal 'http://airbrake.io', Toadhopper::DEFAULT_NOTIFY_HOST
+  end
+
+  def test_no_params
+    toad = Toadhopper.new MY_KEY
+    assert_toad_behavior toad
+    assert_match Toadhopper::DEFAULT_NOTIFY_HOST, toad.error_url.to_s
+    assert ! toad.secure?
+  end
+
+  def test_http_host
+    toad = Toadhopper.new MY_KEY, :notify_host => 'http://foo.com'
+    assert_toad_behavior toad
+    assert_match 'http://foo.com', toad.deploy_url.to_s
+    assert ! toad.secure?
+  end
+
+  def test_https_host
+    secure_host = 'https://example.com'
+    toad = Toadhopper.new MY_KEY, :notify_host => secure_host
+    assert_toad_behavior toad
+    assert_match secure_host, toad.error_url.to_s
+    assert toad.secure?
+  end
+
+  def test_vague_host_not_allowed
+    assert_raise(ToadhopperException) do
+      Toadhopper.new MY_KEY, :notify_host => 'toadhopper.net'
+    end
+  end
+
+  def test_http_transport
+    transport = Net::HTTP.new 'airbrake.io'
+    toad = Toadhopper.new MY_KEY, :transport => transport
+    assert ! toad.secure?
+    assert_same transport, toad.connection(toad.error_url)
+  end
+
+  def test_https_transport
+    transport = Net::HTTP.new 'foo.com', 443
+    transport.use_ssl = true
+    toad = Toadhopper.new MY_KEY, :transport => transport
+    assert toad.secure?
+    assert_same transport, toad.connection(toad.error_url)
+  end
+
+  def test_transport_and_url_conflict
+    transport = Net::HTTP.new 'domain1.com'
+    assert_raise(ToadhopperException) do
+      Toadhopper.new MY_KEY, :notify_host => 'http://domain2.com', :transport => transport
+    end
+  end
+
+  def test_ca_file
+    assert File.exists? Toadhopper::CA_FILE
+  end
+
+  def test_ca_file_validates_notify_host
+    require 'openssl'
+    require 'socket'
+    context             = OpenSSL::SSL::SSLContext.new
+    context.ca_file     = Toadhopper::CA_FILE
+    context.verify_mode = OpenSSL::SSL::VERIFY_PEER
+    client_socket = TCPSocket.new Toadhopper::DEFAULT_DOMAIN, 443
+    ssl_client = OpenSSL::SSL::SSLSocket.new client_socket, context
+    ssl_client.connect
+    ssl_client.puts 'hello server!'
+    body = ssl_client.read
+    assert_match /html/, body, "bad response body: #{body.inspect}"
+  end
+
+  def assert_toad_behavior(toad)
+    assert_kind_of Toadhopper, toad
+    assert_equal MY_KEY, toad.api_key
+  end
+end

data/test/test_posting.rb

@@ -1,18 +1,87 @@
 require 'helper'
 
 class Toadhopper::TestPosting < Test::Unit::TestCase
+  MY_ERROR_URL = "#{Toadhopper::DEFAULT_NOTIFY_HOST}/notifier_api/v2/notices"
+
+  def test_mock_successful_posting
+    key = 'lolc@tz'
+    response_body = posting_response_good
+    FakeWeb.register_uri(:post, MY_ERROR_URL, :body => response_body, :status => ['200', 'OK'])
+    response = Toadhopper(key).post!(error)
+    # Check our request
+    assert_match key, FakeWeb.last_request.body, FakeWeb.last_request.body
+    assert_valid_airbrake_xml FakeWeb.last_request.body
+    # Check how we capture the mock response
+    assert_equal response_body, response.body, response
+    assert_successful_response response
+  end
+
+  def test_mock_unsuccessful_posting
+    key = 'roflcopt3r'
+    response_body = posting_response_bad_apikey
+    FakeWeb.register_uri(:post, MY_ERROR_URL, :body => response_body, :status => ['422', '422 status code 422'])
+    response = Toadhopper(key).post! error
+    # Check how we capture the mock response
+    assert_equal response_body, response.body, response
+    assert_failed_response response
+  end
+
   def test_posting
+    FakeWeb.allow_net_connect = true
     response = Toadhopper('bogus key').post!(error)
-    assert_equal 422, response.status
-    assert_equal ['No project exists with the given API key.'], response.errors
+    # Check how we capture the live response
+    assert_failed_response response
   end
 
-  if ENV['AIRBRAKE_API_KEY']
+  def test_posting_transport
+    FakeWeb.allow_net_connect = true
+    response = Toadhopper.new('bogus key', :transport => transport).post!(error)
+    assert_equal 1, response.errors.length, response
+  end
+
+  if toadhopper_api_key
     def test_posting_integration
-      toadhopper.filters = "AIRBRAKE_API_KEY", "ROOT_PASSWORD"
-      response = toadhopper.post!(error)
-      assert_equal 200, response.status
-      assert_equal [], response.errors
+      FakeWeb.allow_net_connect = true
+      toad = toadhopper
+      toad.filters = "AIRBRAKE_API_KEY", "ROOT_PASSWORD"
+      assert_successful_response toad.post! error
+    end
+
+    def test_posting_transport_integration
+      FakeWeb.allow_net_connect = true
+      toad = Toadhopper.new toadhopper_api_key, :transport => transport
+      assert_successful_response toad.post! error
     end
   end
+
+  def assert_successful_response(response)
+    assert_equal 200, response.status, response
+    assert_match '</id>', response.body, response
+    assert_equal [], response.errors, response
+  end
+
+  def assert_failed_response(response, code = 422)
+    assert_equal code, response.status, response
+    assert_respond_to response.errors, :each_with_index, response
+    assert_equal 1, response.errors.length, response
+  end
+
+  def transport
+    port = nil
+    port = Net::HTTP.https_default_port if ENV['AIRBRAKE_FULL_TEST']
+    transport = Net::HTTP.new Toadhopper::DEFAULT_DOMAIN, port
+    transport.read_timeout = 7 # seconds
+    transport.open_timeout = 7 # seconds
+    if ENV['AIRBRAKE_FULL_TEST']
+      transport.use_ssl     = true
+      transport.ca_file     = Toadhopper::CA_FILE
+      transport.verify_mode = OpenSSL::SSL::VERIFY_PEER
+    end
+    transport
+  end
+
+  # This method is called automatically after every test
+  def teardown
+    reset_test_env
+  end
 end

data/toadhopper.gemspec

@@ -20,9 +20,11 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ['lib']
-  s.extra_rdoc_files  = ['README.md', 'LICENSE']
+  s.extra_rdoc_files  = ['README.md', 'LICENSE', 'CHANGELOG.md']
   
   s.add_development_dependency 'rake'
   s.add_development_dependency 'test-unit'
   s.add_development_dependency 'fakeweb'
+  s.add_development_dependency 'travis-lint'
+  s.add_development_dependency 'nokogiri'
 end

metadata

@@ -1,10 +1,10 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: toadhopper
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: '2.1'
   prerelease: 
-  version: "2.0"
 platform: ruby
-authors: 
+authors:
 - Tim Lucas
 - Samuel Tesla
 - Corey Donohoe
@@ -13,55 +13,102 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-07-26 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-07-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rake
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: test-unit
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: travis-lint
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *id003
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A base library for Airbrake error reporting
-email: 
+email:
 - t.lucas@toolmantim.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.md
 - LICENSE
-files: 
+- CHANGELOG.md
+files:
 - .gitignore
+- .travis.yml
 - .yardopts
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -69,48 +116,47 @@ files:
 - lib/notice.erb
 - lib/toadhopper.rb
 - lib/toadhopper/capistrano.rb
+- lib/toadhopper_exception.rb
+- resources/README.md
+- resources/ca-bundle.crt
 - test/helper.rb
+- test/resources/airbrake_2_2.xsd
 - test/test_convenience_constructor.rb
 - test/test_deploy_tracking.rb
 - test/test_filtering.rb
+- test/test_initialization.rb
 - test/test_posting.rb
 - toadhopper.gemspec
 homepage: http://github.com/toolmantim/toadhopper
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 384563062547314553
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 384563062547314553
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: toadhopper
-rubygems_version: 1.8.5
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Post error notifications to Airbrake
-test_files: 
+test_files:
 - test/helper.rb
+- test/resources/airbrake_2_2.xsd
 - test/test_convenience_constructor.rb
 - test/test_deploy_tracking.rb
 - test/test_filtering.rb
+- test/test_initialization.rb
 - test/test_posting.rb
+has_rdoc: