whoops 0.0.4 → 0.0.5

data/README.asciidoc

@@ -0,0 +1,100 @@
+Whoops
+======
+Daniel Higginbotham <daniel@flyingmachinestudios.com>
+2011-07-09
+
+== Overview
+
+=== Purpose
+
+whoops was originally conceived as an alternative to Hoptoad. Its allows you to:
+
+* *Log arbitrary events.* Whoops events use an event_type field which can be any string - exception, notification, warning, etc.
+* *Log arbitrary details.* Events are stored in http://www.mongodb.org[mongodb], giving you the flexibility of a document database.
+* *Search event details.* The search parser maps text to mongoid conditions, allowing you to do queries like +details.current_user_id#in [123, 423]+
+* *Extend the app.* Since it's a rails engine, you can make changes to your base rails app without worrying about merge difficulties when you upgrade whoops.
+
+If you find yourself bumping up against limitations in Hoptoad, whoops might be right for you.
+
+=== Design
+
+whoops consists of two main components: the rails 3 engine and the notifier. Hosting is up to you. The engine provides the following:
+
+* Controllers and views for viewing, filtering, and searching events.
+* An end point for receiving event notifications
+* A mailer for sending email notifications
+* http://www.mongoid.org[Mongoid] models
+
+The notifier is documented separately. Briefly, it allows you to create strategies for building an event notification. It also allows you to modify existing strategies.
+
+For example, you could use the https://github.com/flyingmachine/whoops_rails_notifier[rails 3 notifier] , but modify it to include the ID of the currently logged in user. If your app ran background processes, you could create a notification strategy specific to your processes. Both strategies can coexist in the same app.
+
+=== Terms / Models
+
+* _Event_ A specific occurrence of an event. The Event model stores details specific to an event.
+* _Event Group_ All Events are associated with an Event Group. Event Groups store details common to all events in the group.
+* _Notification_ The whoops notifier sends Notifications to whoops. A notification contains both Event and Event Group information; whoops sorts it out when it receives a Notification.
+
+== Usage
+
+=== Installation
+
+. create a new rails app
+. add +gem "whoops"+ to your Gemfile
+. run +bundle+
+. run +bundle exec rails g whoops:assets+ - this copies assets to your public directory (whoops isn't 3.1 compatible yet)
+. _optional_ add `root :to => "event_groups#index"` to your routes file to make the event group listing your home page
+. add https://github.com/flyingmachine/whoops_notifier[notifiers] to the code you want to monitor
+
+=== Filtering
+
+.Filters
+image::https://github.com/flyingmachine/whoops/raw/master/doc/images/dash-filters.png[Filters]
+
+When viewing the Event Group list, you can filter by service, environment, and event type.
+
+When you set a filter, its value is stored in a session and won't be changed until you click "reset". This is so that you won't lose your filter after, for example, viewing a specific event.
+
+=== Searching
+
+.Search
+image::https://github.com/flyingmachine/whoops/raw/master/doc/images/details-search.png[Search]
+
+For now, you need to enter your queries into the textarea shown above. Currently, searches only apply to the events within the current event group.
+
+.Search Syntax
+----
+key[#method] query
+----
+
+* *key* the Event field to search.
+* *method* _(optional)_ a http://mongoid.org/docs/querying/criteria.html#where[Mongoid] where criteria method
+* *query* a YAML string
+
+.Examples
+
+Below is the text you would write, and below that is essentially the ruby code that ends up getting run by the server
+
+----
+details.current_user_id#in [3, 54, 532]      <1>
+details.num_failures#gt 3                    <2>
+details.current_user.first_name Voldemort    <3>
+message#in !r/(yesterday|today)/             <4>
+----
+
+<1> `Event.where( {:"details.current_user_id".in => [3, 54, 532]} )`
+<2> `Event.where( {:"details.num_failure".gt => 3} )`
+<3> `Event.where( {:"details.current_user.first_name" => "Voldemort"} )`
+<4> `Event.where( {:message.in /(yesterday|today/)} )` Note that regular expressions must start with !r.
+
+This syntax is kind of goofy, but it lets you enter constant numbers, strings, arrays, hashes, and regular expressions, just like you could if you were typing in the code directly.
+
+== TODO
+
+* finish notifications
+* site-wide search
+* graphing
+
+== License
+
+This project uses MIT-LICENSE.

data/app/models/whoops/event.rb

@@ -18,7 +18,12 @@ class Whoops::Event
     event_group_params[:last_recorded_at] = params[:event_time]
     
     event_group = Whoops::EventGroup.first(:conditions => event_group_params.slice(*Whoops::EventGroup.identifying_fields))
-    event_group ||= Whoops::EventGroup.create(event_group_params)
+    if event_group
+      event_group.attributes = event_group_params
+      event_group.save
+    else
+      event_group = Whoops::EventGroup.create(event_group_params)
+    end
         
     event_params = params.slice(*Whoops::Event.field_names)
     event_group.events.create(event_params)

data/app/models/whoops/event_group.rb

@@ -7,6 +7,7 @@ class Whoops::EventGroup
     field string_field, :type => String
   end
   field :last_recorded_at, :type => DateTime
+  field :notify_on_next_occurrence, :type => Boolean, :default => true
   
   has_many :events, :class_name => "Whoops::Event"
   
@@ -29,4 +30,6 @@ class Whoops::EventGroup
     end
     services
   end
+  
+  
 end

data/app/models/whoops/notification_rule.rb

@@ -0,0 +1,45 @@
+class Whoops::NotificationRule
+  include Mongoid::Document
+  
+  field :email, :type => String
+  field :matchers, :type => Array
+
+  # This might come in handy in the future?
+  # class << self.fields["matchers"]
+  #   def set(object)
+  #     object = object.split("\n").collect{ |m| m.strip } if object.is_a?(String)
+  #     object
+  #   end
+  # end
+  
+  before_save :downcase_email
+  
+  def downcase_email
+    self.email.downcase!
+  end
+  
+  def matchers=(matchers)
+    write_attribute(:matchers, matchers.split("\n").collect{ |m| m.strip })
+  end
+  
+  def self.matches(event)
+    
+  end
+  
+  class Matcher
+    attr_accessor :event_group
+    
+    # @param [ Whoops::EventGroup ]
+    def initialize(event_group)
+      self.event_group = event_group
+    end
+    
+    def matching_emails
+      matches.collect{|m| m.email}.uniq
+    end
+    
+    def matches
+      Whoops::NotificationRule.where(:matchers => /^#{event_group.service}/)
+    end
+  end
+end

data/app/models/whoops/search_parser.rb

@@ -34,7 +34,7 @@ class Whoops::SearchParser
   def parse_value(value)
     value = value.strip
     # value = "!ruby/regexp \"#{value}\"" if value =~ /^\/.*\/$/
-    value.gsub!(/\/.*?\//, %Q{!ruby/regexp "\\0"})
+    value.gsub!(/!r(\/.*?\/)/, %Q{!ruby/regexp "\\1"})
     return YAML.load(value)
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: whoops
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: false
   segments: 
   - 0
   - 0
-  - 4
-  version: 0.0.4
+  - 5
+  version: 0.0.5
 platform: ruby
 authors: 
 - Daniel Higginbotham
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-03 00:00:00 -04:00
+date: 2011-07-09 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -251,9 +251,11 @@ files:
 - app/helpers/events_helper.rb
 - app/helpers/notifications_helper.rb
 - app/lib/field_names.rb
+- app/mailers/whoops/notification_mailer.rb
 - app/models/whoops/event.rb
 - app/models/whoops/event_group.rb
 - app/models/whoops/filter.rb
+- app/models/whoops/notification_rule.rb
 - app/models/whoops/search_parser.rb
 - app/views/event_groups/_list.html.haml
 - app/views/event_groups/index.html.haml
@@ -318,7 +320,7 @@ files:
 - MIT-LICENSE
 - Rakefile
 - Gemfile
-- README.rdoc
+- README.asciidoc
 has_rdoc: true
 homepage: 
 licenses: []

data/README.rdoc

@@ -1,3 +0,0 @@
-= Whoops
-
-This project rocks and uses MIT-LICENSE.