Validate required hoptoad notifier fields

Jared Pace
1 parent 7bbbeef2
Showing 8 changed files with 83 additions and 3 deletions Show diff stats
Gemfile
Gemfile.lock
app/models/error.rb
app/models/notice.rb
lib/hoptoad.rb
spec/factories/error_factories.rb
spec/models/error_spec.rb
spec/models/notice_spec.rb
@@ -13,4 +13,5 @@ end
 group :test do
   gem 'rspec', '>= 2.0.0.beta.19'
   gem 'database_cleaner', '0.5.2'
+  gem 'factory_girl_rails'
 end
@@ -37,6 +37,10 @@ GEM
     diff-lcs (1.1.2)
     erubis (2.6.6)
       abstract (>= 1.0.0)
+    factory_girl (1.3.2)
+    factory_girl_rails (1.0)
+      factory_girl (~> 1.3)
+      rails (>= 3.0.0.beta4)
     haml (3.0.15)
     i18n (0.4.1)
     libxml-ruby (1.1.4)
@@ -101,6 +105,7 @@ PLATFORMS
 DEPENDENCIES
   bson_ext
   database_cleaner (= 0.5.2)
+  factory_girl_rails
   haml
   libxml-ruby
   mongoid (= 2.0.0.beta.15)
@@ -2,8 +2,16 @@ class Error
   include Mongoid::Document
   include Mongoid::Timestamps
  
+  field :klass
+  field :message
+  field :component
+  field :action
+  field :environment
+  
   embeds_many :notices
  
+  validates_presence_of :klass, :environment
+  
   def self.for(attrs)
     self.where(attrs).first || create(attrs)
   end
@@ -11,11 +11,13 @@ class Notice
  
   embedded_in :error, :inverse_of => :notices
  
+  validates_presence_of :backtrace, :server_environment, :notifier
+  
   def self.from_xml(hoptoad_xml)
     hoptoad_notice = Hoptoad::V2.parse_xml(hoptoad_xml)
  
     error = Error.for({
-      :class_name => hoptoad_notice['error']['class'],
+      :klass      => hoptoad_notice['error']['class'],
       :message    => hoptoad_notice['error']['message'],
       :component  => hoptoad_notice['request']['component'],
       :action     => hoptoad_notice['request']['action'],
 module Hoptoad
   module V2
+    class ApiVersionError < StandardError
+      def initialize
+        super "Wrong API Version: Expecting v2.0"
+      end
+    end
  
     def self.parse_xml(xml)
       parsed  = ActiveSupport::XmlMini.backend.parse(xml)['notice']
+      raise ApiVersionError unless parsed && parsed['version'] == '2.0'
       rekey(parsed)
     end
  
@@ -0,0 +1,24 @@
+Factory.define :error do |e|
+  e.klass         'FooError'
+  e.message       'FooError: Too Much Bar'
+  e.component     'foo'
+  e.action        'bar'
+  e.environment   'production'
+end
+
+Factory.define :notice do |n|
+  n.error               {|e| e.association :error}
+  n.backtrace           { random_backtrace }
+  n.server_environment  'server-environment' => 'production'
+  n.notifier            'name' => 'Notifier', 'version' => '1', 'url' => 'http://toad.com'
+end
+
+def random_backtrace
+  backtrace = []
+  99.times {|t| backtrace << {
+    'number'  => rand(999),
+    'file'    => "/path/to/file/#{ActiveSupport::SecureRandom.hex(4)}.rb",
+    'method'  => ActiveSupport.methods.shuffle.first
+  }}
+  backtrace
+end
 \ No newline at end of file
@@ -2,10 +2,24 @@ require &#39;spec_helper&#39;
  
 describe Error do
  
+  context 'validations' do
+    it 'requires a klass' do
+      error = Factory.build(:error, :klass => nil)
+      error.should_not be_valid
+      error.errors[:klass].should include("can't be blank")
+    end
+    
+    it 'requires an environment' do
+      error = Factory.build(:error, :environment => nil)
+      error.should_not be_valid
+      error.errors[:environment].should include("can't be blank")
+    end
+  end
+  
   context '#for' do
     before do
       @conditions = {
-        :class_name   => 'Whoops',
+        :klass        => 'Whoops',
         :message      => 'Whoops: Oopsy Daisy',
         :component    => 'Foo',
         :action       => 'bar',
@@ -2,6 +2,26 @@ require &#39;spec_helper&#39;
  
 describe Notice do
  
+  context 'validations' do
+    it 'requires a backtrace' do
+      notice = Factory.build(:notice, :backtrace => nil)
+      notice.should_not be_valid
+      notice.errors[:backtrace].should include("can't be blank")
+    end
+    
+    it 'requires the server_environment' do
+      notice = Factory.build(:notice, :server_environment => nil)
+      notice.should_not be_valid
+      notice.errors[:server_environment].should include("can't be blank")
+    end
+    
+    it 'requires the notifier' do
+      notice = Factory.build(:notice, :notifier => nil)
+      notice.should_not be_valid
+      notice.errors[:notifier].should include("can't be blank")
+    end
+  end
+  
   context '#from_xml' do
     before do
       @xml = Rails.root.join('spec','fixtures','hoptoad_test_notice.xml').read
@@ -9,7 +29,7 @@ describe Notice do
  
     it 'finds the correct error for the notice' do
       Error.should_receive(:for).with({
-        :class_name   => 'HoptoadTestingException',
+        :klass        => 'HoptoadTestingException',
         :message      => 'HoptoadTestingException: Testing hoptoad via "rake hoptoad:test". If you can see this, it works.',
         :component    => 'application',
         :action       => 'verify',
...	...	@@ -13,4 +13,5 @@ end
13	13	group :test do
14	14	gem 'rspec', '>= 2.0.0.beta.19'
15	15	gem 'database_cleaner', '0.5.2'
	16	+ gem 'factory_girl_rails'
16	17	end
...	...
...	...	@@ -37,6 +37,10 @@ GEM
37	37	diff-lcs (1.1.2)
38	38	erubis (2.6.6)
39	39	abstract (>= 1.0.0)
	40	+ factory_girl (1.3.2)
	41	+ factory_girl_rails (1.0)
	42	+ factory_girl (~> 1.3)
	43	+ rails (>= 3.0.0.beta4)
40	44	haml (3.0.15)
41	45	i18n (0.4.1)
42	46	libxml-ruby (1.1.4)
...	...	@@ -101,6 +105,7 @@ PLATFORMS
101	105	DEPENDENCIES
102	106	bson_ext
103	107	database_cleaner (= 0.5.2)
	108	+ factory_girl_rails
104	109	haml
105	110	libxml-ruby
106	111	mongoid (= 2.0.0.beta.15)
...	...
...	...	@@ -2,8 +2,16 @@ class Error
2	2	include Mongoid::Document
3	3	include Mongoid::Timestamps
4	4
	5	+ field :klass
	6	+ field :message
	7	+ field :component
	8	+ field :action
	9	+ field :environment
	10	+
5	11	embeds_many :notices
6	12
	13	+ validates_presence_of :klass, :environment
	14	+
7	15	def self.for(attrs)
8	16	self.where(attrs).first \|\| create(attrs)
9	17	end
...	...
...	...	@@ -11,11 +11,13 @@ class Notice
11	11
12	12	embedded_in :error, :inverse_of => :notices
13	13
	14	+ validates_presence_of :backtrace, :server_environment, :notifier
	15	+
14	16	def self.from_xml(hoptoad_xml)
15	17	hoptoad_notice = Hoptoad::V2.parse_xml(hoptoad_xml)
16	18
17	19	error = Error.for({
18		- :class_name => hoptoad_notice['error']['class'],
	20	+ :klass => hoptoad_notice['error']['class'],
19	21	:message => hoptoad_notice['error']['message'],
20	22	:component => hoptoad_notice['request']['component'],
21	23	:action => hoptoad_notice['request']['action'],
...	...
1	1	module Hoptoad
2	2	module V2
	3	+ class ApiVersionError < StandardError
	4	+ def initialize
	5	+ super "Wrong API Version: Expecting v2.0"
	6	+ end
	7	+ end
3	8
4	9	def self.parse_xml(xml)
5	10	parsed = ActiveSupport::XmlMini.backend.parse(xml)['notice']
	11	+ raise ApiVersionError unless parsed && parsed['version'] == '2.0'
6	12	rekey(parsed)
7	13	end
8	14
...	...
...	...	@@ -0,0 +1,24 @@
	1	+Factory.define :error do \|e\|
	2	+ e.klass 'FooError'
	3	+ e.message 'FooError: Too Much Bar'
	4	+ e.component 'foo'
	5	+ e.action 'bar'
	6	+ e.environment 'production'
	7	+end
	8	+
	9	+Factory.define :notice do \|n\|
	10	+ n.error {\|e\| e.association :error}
	11	+ n.backtrace { random_backtrace }
	12	+ n.server_environment 'server-environment' => 'production'
	13	+ n.notifier 'name' => 'Notifier', 'version' => '1', 'url' => 'http://toad.com'
	14	+end
	15	+
	16	+def random_backtrace
	17	+ backtrace = []
	18	+ 99.times {\|t\| backtrace << {
	19	+ 'number' => rand(999),
	20	+ 'file' => "/path/to/file/#{ActiveSupport::SecureRandom.hex(4)}.rb",
	21	+ 'method' => ActiveSupport.methods.shuffle.first
	22	+ }}
	23	+ backtrace
	24	+end
0	25	\ No newline at end of file
...	...
...	...	@@ -2,10 +2,24 @@ require 'spec_helper'
2	2
3	3	describe Error do
4	4
	5	+ context 'validations' do
	6	+ it 'requires a klass' do
	7	+ error = Factory.build(:error, :klass => nil)
	8	+ error.should_not be_valid
	9	+ error.errors[:klass].should include("can't be blank")
	10	+ end
	11	+
	12	+ it 'requires an environment' do
	13	+ error = Factory.build(:error, :environment => nil)
	14	+ error.should_not be_valid
	15	+ error.errors[:environment].should include("can't be blank")
	16	+ end
	17	+ end
	18	+
5	19	context '#for' do
6	20	before do
7	21	@conditions = {
8		- :class_name => 'Whoops',
	22	+ :klass => 'Whoops',
9	23	:message => 'Whoops: Oopsy Daisy',
10	24	:component => 'Foo',
11	25	:action => 'bar',
...	...
...	...	@@ -2,6 +2,26 @@ require 'spec_helper'
2	2
3	3	describe Notice do
4	4
	5	+ context 'validations' do
	6	+ it 'requires a backtrace' do
	7	+ notice = Factory.build(:notice, :backtrace => nil)
	8	+ notice.should_not be_valid
	9	+ notice.errors[:backtrace].should include("can't be blank")
	10	+ end
	11	+
	12	+ it 'requires the server_environment' do
	13	+ notice = Factory.build(:notice, :server_environment => nil)
	14	+ notice.should_not be_valid
	15	+ notice.errors[:server_environment].should include("can't be blank")
	16	+ end
	17	+
	18	+ it 'requires the notifier' do
	19	+ notice = Factory.build(:notice, :notifier => nil)
	20	+ notice.should_not be_valid
	21	+ notice.errors[:notifier].should include("can't be blank")
	22	+ end
	23	+ end
	24	+
5	25	context '#from_xml' do
6	26	before do
7	27	@xml = Rails.root.join('spec','fixtures','hoptoad_test_notice.xml').read
...	...	@@ -9,7 +29,7 @@ describe Notice do
9	29
10	30	it 'finds the correct error for the notice' do
11	31	Error.should_receive(:for).with({
12		- :class_name => 'HoptoadTestingException',
	32	+ :klass => 'HoptoadTestingException',
13	33	:message => 'HoptoadTestingException: Testing hoptoad via "rake hoptoad:test". If you can see this, it works.',
14	34	:component => 'application',
15	35	:action => 'verify',
...	...