whoops_notifier 0.0.1 → 0.0.2

data/Gemfile

@@ -7,9 +7,9 @@ gem "json"
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 group :development do
-  gem "rspec", "~> 2.3.0"
+  gem "rspec", "~> 2.6.0"
   gem "bundler", "~> 1.0.0"
   gem "jeweler", "~> 1.5.2"
-  gem "mocha"
   gem "ruby-debug"
+  gem "fakeweb"
 end

data/Gemfile.lock

@@ -3,6 +3,7 @@ GEM
   specs:
     columnize (0.3.2)
     diff-lcs (1.1.2)
+    fakeweb (1.3.0)
     git (1.2.5)
     jeweler (1.5.2)
       bundler (~> 1.0.0)
@@ -10,16 +11,15 @@ GEM
       rake
     json (1.5.1)
     linecache (0.43)
-    mocha (0.9.12)
     rake (0.8.7)
-    rspec (2.3.0)
-      rspec-core (~> 2.3.0)
-      rspec-expectations (~> 2.3.0)
-      rspec-mocks (~> 2.3.0)
-    rspec-core (2.3.1)
-    rspec-expectations (2.3.0)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
       diff-lcs (~> 1.1.2)
-    rspec-mocks (2.3.0)
+    rspec-mocks (2.6.0)
     ruby-debug (0.10.4)
       columnize (>= 0.1)
       ruby-debug-base (~> 0.10.4.0)
@@ -31,8 +31,8 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.0.0)
+  fakeweb
   jeweler (~> 1.5.2)
   json
-  mocha
-  rspec (~> 2.3.0)
+  rspec (~> 2.6.0)
   ruby-debug

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/lib/whoops_notifier.rb

@@ -11,21 +11,32 @@ module WhoopsNotifier
   
   class << self
     attr_accessor :strategies, :config
+    
+    # @overload notify(evidence)
+    #   Notify using the default basic strategy
+    #   @param [Hash] evidence the evidence expected by the basic strategy
+    # @overload notify(strategy_name, evidence)
+    #   @param [Symbol, String] strategy_name
+    #   @param [Hash] evidence same as above
     def notify(strategy_name, evidence = {})
       if strategy_name.is_a? Hash
         notify("default::basic", strategy_name)
       else
         investigator = Investigator.new(strategies[strategy_name], evidence)
         investigator.investigate!
+        send_report(investigator.report) unless investigator.ignore_report?
       end
     end
+    
+    def send_report(report)
+      Sender.new(WhoopsNotifier.config.to_hash).send_report(report.to_hash)
+    end
   end
   
   def self.config
     @config ||= Configuration.new
   end
   
-  
   self.strategies = {}
 end
 

data/lib/whoops_notifier/configuration.rb

@@ -1,4 +1,6 @@
-# Copyright (c) 2007, Tammer Saleh, Thoughtbot, Inc.
+require 'yaml'
+
+# Borrows heavily from Hoptoad Notifier by Tammer Saleh
 module WhoopsNotifier  
   # Used to set up and modify settings for the notifier.
   class Configuration
@@ -90,6 +92,7 @@ module WhoopsNotifier
     
     def set_with_hash(config)
       OPTIONS.each do |option|
+        next unless self.respond_to?("#{option}=")
         if config.has_key?(option)
           self.send("#{option}=", config[option])
         elsif config.has_key?(option.to_s)

data/lib/whoops_notifier/investigator.rb

@@ -1,7 +1,8 @@
 module WhoopsNotifier
   class Investigator
-    # get data from evidence using a strategy to create a report, then send or ignore
+    # get data from evidence using a strategy to create a report and decide whether it should be ignored
     attr_accessor :strategy, :report, :evidence, :ignore_report
+    alias :ignore_report? :ignore_report
 
     def initialize(strategy, evidence)
       raise ArgumentError, "strategy can not be nil" if strategy.nil?
@@ -13,15 +14,10 @@ module WhoopsNotifier
     
     def investigate!
       create_report
-      send_report unless ignore_report
     end
     
     def create_report
       strategy.call(self)
     end
-    
-    def send_report
-      Sender.new(WhoopsNotifier.config.to_hash).send_report(self.report.to_hash)
-    end
   end
 end

data/lib/whoops_notifier/report.rb

@@ -1,6 +1,6 @@
 module WhoopsNotifier
   class Report
-    ATTRIBUTES = [:event_type, :service, :environment, :message, :identifier, :event_time, :details]
+    ATTRIBUTES = [:event_type, :service, :environment, :message, :event_group_identifier, :event_time, :details]
     ATTRIBUTES.each do |attribute|
       attr_accessor attribute
     end

data/lib/whoops_notifier/sender.rb

@@ -22,13 +22,13 @@ module WhoopsNotifier
       end
     end
 
-    # Sends the notice data off to Hoptoad for processing.
+    # Sends the notice data off to Whoops for processing.
     #
     # @param [Hash] data The notice to be sent off
     def send_report(data)
       # TODO: format
       # TODO: validation
-      data = {:event => data}.to_json
+      data = prepare_data(data)
       logger.debug { "Sending request to #{url.to_s}:\n#{data}" } if logger
 
       http =
@@ -58,6 +58,10 @@ module WhoopsNotifier
         error_id[1] if error_id
       end
     end
+    
+    def prepare_data(data)
+      {:event => data}.to_json
+    end
 
     private
 
@@ -70,13 +74,10 @@ module WhoopsNotifier
 
     def log(level, message, response = nil)
       logger.send level, LOG_PREFIX + message if logger
-      # HoptoadNotifier.report_environment_info
-      # HoptoadNotifier.report_response_body(response.body) if response && response.respond_to?(:body)
     end
 
     def logger
       WhoopsNotifier.config.logger
-    end
-    
+    end 
   end
 end

data/lib/whoops_notifier/strategy.rb

@@ -31,7 +31,7 @@ module WhoopsNotifier
     end
     
     # block takes one param, the investigator's report
-    def add_ignore_criterion(name, &block)
+    def add_ignore_case(name, &block)
       give_name(name, block)
       @ignore_criteria << block
     end

data/spec/configuration_spec.rb

@@ -1,6 +1,15 @@
 describe "WhoopsNotifier::Configuration" do
   describe "#set" do 
-    after(:each) { WhoopsNotifier.config.host = nil }
+    before(:each) {
+      @real_config = WhoopsNotifier.config.to_hash
+      WhoopsNotifier::Configuration::OPTIONS.each do |option|
+        WhoopsNotifier.config.send("#{option}=", nil) if WhoopsNotifier.config.respond_to?("#{option}=".to_sym)
+      end
+    }
+    after(:each) { 
+      WhoopsNotifier.config.set(@real_config)
+    }
+    
     let(:config_path) { File.join(File.dirname(__FILE__), "fixtures/whoops_notifier.yml") }
     it "should set the config from a yaml filename" do
       WhoopsNotifier.config.set(config_path)

data/spec/investigator_spec.rb

@@ -17,19 +17,13 @@ describe "WhoopsNotifier::Investigator" do
   
   describe "#investigate!" do
     it "should not send report if ignore_report is true" do
-      strategy = mock(:call)
+      strategy = lambda{}
       investigator = WhoopsNotifier::Investigator.new(strategy, {})
       investigator.ignore_report = true
       
-      investigator.expects(:send_report).never
+      investigator.should_not_receive(:send_report)
       
       investigator.investigate!
     end
-  end
-  
-  describe "#send_report" do
-    it "should send the report's hash" do
-      
-    end
-  end
+  end  
 end

data/spec/sender_spec.rb

@@ -0,0 +1,15 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe WhoopsNotifier::Sender do
+  describe "#send_report" do
+    it "should send a report to the configured URL when given a config object" do
+      FakeWeb.register_uri(:post, "http://whoops.com/events/", :body => "success")
+      
+      sender = WhoopsNotifier::Sender.new(WhoopsNotifier.config)
+      sender.send_report({:test => true})
+
+      request = FakeWeb.last_request
+      request.body.should =~ /"test"/
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,12 +1,13 @@
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
+rspec_dir = File.dirname(__FILE__)
+
+$LOAD_PATH.unshift(File.join(rspec_dir, '..', 'lib'))
+$LOAD_PATH.unshift(rspec_dir)
 require 'rspec'
 require 'whoops_notifier'
+require 'fakeweb'
 
 # Requires supporting files with custom matchers and macros, etc,
 # in ./support/ and its subdirectories.
-Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+Dir["#{rspec_dir}/support/**/*.rb"].each {|f| require f}
 
-RSpec.configure do |config|
-  config.mock_with :mocha
-end
+WhoopsNotifier.config.set(File.join(rspec_dir, "fixtures", "whoops_notifier.yml"))

data/spec/strategy_spec.rb

@@ -2,12 +2,12 @@ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe "WhoopsNotifier::Strategy" do
   describe "#initialize" do
-    it "should add strategy to WhoopsNotifier.strategies" do
+    it "adds a strategy to WhoopsNotifier.strategies" do
       s = WhoopsNotifier::Strategy.new(:test)
       WhoopsNotifier.strategies[:test].should == s
     end
     
-    it "should create empty arrays for ignore criteria and report_modifiers" do
+    it "creates empty arrays for ignore criteria and report_modifiers" do
       s = WhoopsNotifier::Strategy.new(:test)
       s.ignore_criteria.should == []
       s.report_modifiers.should == []
@@ -15,7 +15,7 @@ describe "WhoopsNotifier::Strategy" do
   end
   
   describe "#add_report_modifier" do
-    it "should add a named block" do
+    it "adds a named block" do
       s = WhoopsNotifier::Strategy.new(:test)
       s.add_report_modifier(:add_message) { |investigator| }
 
@@ -23,12 +23,21 @@ describe "WhoopsNotifier::Strategy" do
     end
   end
   
+  describe "#add_ignore_case" do
+    it "adds a named ignore criteria block" do
+      s = WhoopsNotifier::Strategy.new(:test)
+      s.add_ignore_case(:ignore_if_empty) { |investigator| }
+
+      s.ignore_criteria.first.name.should == :ignore_if_empty
+    end
+  end
+  
   describe "#call" do
     it "should change the investigator's 'ignore' attribute to true if any ignore criteria are true" do
       strategy = WhoopsNotifier::Strategy.new(:test)
       investigator = WhoopsNotifier::Investigator.new(strategy, nil)
       
-      strategy.add_ignore_criterion(:always_ignore) do |report|
+      strategy.add_ignore_case(:always_ignore) do |report|
         true
       end
       
@@ -57,8 +66,8 @@ describe "WhoopsNotifier::Strategy" do
       strategy.add_report_modifier(:report1){ }
       strategy.add_report_modifier(:report2){ }
       
-      strategy.add_ignore_criterion(:ignore1){ true }
-      strategy.add_ignore_criterion(:ignore2){ true }
+      strategy.add_ignore_case(:ignore1){ true }
+      strategy.add_ignore_case(:ignore2){ true }
       
       strategy.inspect.should == "awesome_strategy
 report modifiers: report1, report2

data/spec/whoops_notifier_spec.rb

@@ -1,12 +1,56 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe "WhoopsNotifier" do
+  before(:each) { FakeWeb.clean_registry }
+  
   describe ".strategies" do
+    it "is a hash with keys of strategy names and values of strategy objects" do
+      WhoopsNotifier.strategies.each do |key, value|
+        (key.instance_of?(Symbol) || key.instance_of?(String)).should be_true
+        value.should be_a WhoopsNotifier::Strategy
+      end
+    end
   end
   
   describe ".config" do
+    it "returns a WhoopsNotifier::Configuration object" do
+      WhoopsNotifier.config.should be_a(WhoopsNotifier::Configuration)
+    end
   end
   
   describe ".notify" do
+    let(:investigator){ double(:investigator, :investigate! => nil, :report => nil) }
+    
+    it "uses the basic strategy if no strategy name is provided" do
+      WhoopsNotifier.stub(:send_report)
+      investigator.stub(:ignore_report?).and_return(false)
+      WhoopsNotifier::Investigator.should_receive(:new).with(WhoopsNotifier.strategies["default::basic"], {}).and_return(investigator)
+      WhoopsNotifier.notify({})
+    end
+    
+    it "sends a report when the investigator is not ignoring the event" do
+      investigator.should_receive(:ignore_report?).and_return(false)
+      WhoopsNotifier::Investigator.stub(:new).and_return(investigator)
+      
+      WhoopsNotifier.should_receive(:send_report)
+      WhoopsNotifier.notify({})
+    end
+    
+    it "does not sned a request if the investigator is ignoring the event" do
+      investigator.should_receive(:ignore_report?).and_return(true)
+      WhoopsNotifier::Investigator.stub(:new).and_return(investigator)
+      
+      WhoopsNotifier.should_not_receive(:send_report)
+      WhoopsNotifier.notify({})
+    end
+  end
+  
+  describe ".send_report" do
+    it "should send a report to the configured URL" do
+      FakeWeb.register_uri(:post, "http://whoops.com/events/", :body => "success")
+      WhoopsNotifier.notify({})
+      request = FakeWeb.last_request
+      request.body.should =~ /"event"/
+    end
   end
 end

data/whoops_notifier.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{whoops_notifier}
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Daniel Higginbotham"]
-  s.date = %q{2011-06-03}
+  s.date = %q{2011-06-09}
   s.description = %q{Handles basic notification responsibilities and allows creation of report creation strategies}
   s.email = %q{daniel@flyingmachinestudios.com}
   s.extra_rdoc_files = [
@@ -35,6 +35,7 @@ Gem::Specification.new do |s|
     "spec/configuration_spec.rb",
     "spec/fixtures/whoops_notifier.yml",
     "spec/investigator_spec.rb",
+    "spec/sender_spec.rb",
     "spec/spec_helper.rb",
     "spec/strategy_spec.rb",
     "spec/whoops_notifier_spec.rb",
@@ -48,6 +49,7 @@ Gem::Specification.new do |s|
   s.test_files = [
     "spec/configuration_spec.rb",
     "spec/investigator_spec.rb",
+    "spec/sender_spec.rb",
     "spec/spec_helper.rb",
     "spec/strategy_spec.rb",
     "spec/whoops_notifier_spec.rb"
@@ -59,26 +61,26 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<json>, [">= 0"])
-      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.6.0"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
-      s.add_development_dependency(%q<mocha>, [">= 0"])
       s.add_development_dependency(%q<ruby-debug>, [">= 0"])
+      s.add_development_dependency(%q<fakeweb>, [">= 0"])
     else
       s.add_dependency(%q<json>, [">= 0"])
-      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_dependency(%q<rspec>, ["~> 2.6.0"])
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
-      s.add_dependency(%q<mocha>, [">= 0"])
       s.add_dependency(%q<ruby-debug>, [">= 0"])
+      s.add_dependency(%q<fakeweb>, [">= 0"])
     end
   else
     s.add_dependency(%q<json>, [">= 0"])
-    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    s.add_dependency(%q<rspec>, ["~> 2.6.0"])
     s.add_dependency(%q<bundler>, ["~> 1.0.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
-    s.add_dependency(%q<mocha>, [">= 0"])
     s.add_dependency(%q<ruby-debug>, [">= 0"])
+    s.add_dependency(%q<fakeweb>, [">= 0"])
   end
 end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: whoops_notifier
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Daniel Higginbotham
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-03 00:00:00 -04:00
+date: 2011-06-09 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -41,12 +41,12 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 23
         segments: 
         - 2
-        - 3
+        - 6
         - 0
-        version: 2.3.0
+        version: 2.6.0
   requirement: *id002
 - !ruby/object:Gem::Dependency 
   prerelease: false
@@ -83,7 +83,7 @@ dependencies:
 - !ruby/object:Gem::Dependency 
   prerelease: false
   type: :development
-  name: mocha
+  name: ruby-debug
   version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -97,7 +97,7 @@ dependencies:
 - !ruby/object:Gem::Dependency 
   prerelease: false
   type: :development
-  name: ruby-debug
+  name: fakeweb
   version_requirements: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -136,6 +136,7 @@ files:
 - spec/configuration_spec.rb
 - spec/fixtures/whoops_notifier.yml
 - spec/investigator_spec.rb
+- spec/sender_spec.rb
 - spec/spec_helper.rb
 - spec/strategy_spec.rb
 - spec/whoops_notifier_spec.rb
@@ -177,6 +178,7 @@ summary: Handles basic notification responsibilities and allows creation of repo
 test_files: 
 - spec/configuration_spec.rb
 - spec/investigator_spec.rb
+- spec/sender_spec.rb
 - spec/spec_helper.rb
 - spec/strategy_spec.rb
 - spec/whoops_notifier_spec.rb