all_seeing_eye 0.0.20 → 0.1.0

data/README.markdown

@@ -28,20 +28,22 @@ we can't just start collecting it again. Combined with some code to store arbitr
 So, AllSeeingEye was born out of our need to track incoming requests accurately, quickly, and in a way that is easily 
 displayable to our business users.
 
+...but this early version still has a few pain points I'm working out. So some requests are slower than I'd like. But everything will be fast soon enough!
+
 ## Installation
 
 Get Redis via the amazing Homebrew: `brew install redis`
 
-Add AllSeeingEye to your project's Gemfile: `gem 'all\_seeing\_eye'`
+Add AllSeeingEye to your project's Gemfile: `gem 'all_seeing_eye'`
 
 Install it with Bundler: `bundle install`
 
 ## Setup
 
-  bundle exec ruby script/generate all\_seeing\_eye
+    bundle exec ruby script/generate all_seeing_eye
 
 This puts the AllSeeingEye config file at config/all\_seeing\_eye.yml. The file is annotated with all the information you 
-need to get started, but some quick explanation:
+need to get started, but some quick explanations:
 
 ### Timeout
 AllSeeingEye's data collection is wrapped by a timeout to ensure speediness. I keep this value at 30 milliseconds (0.03), but 
@@ -61,13 +63,13 @@ shared between them. I only use one right now (I call it 'request'), but if you
 
 Each model definition should be structured like this:
 
-  model\_name:
-    first\_field\_name:
-      object: object_name
-      method: .method_name
-    second\_field\_name:
-      object: hash
-      method: "['key']"
+    model_name:
+      first_field_name:
+        object: object_name
+        method: .method_name
+      second_field_name:
+        object: hash
+        method: "['key']"
 
 Model names and field names are completely arbitrary, and I try to humanize them as best as I can.
 
@@ -80,28 +82,42 @@ and/or bad method... so try not to do that.
 As a helpful hint, recording "request\_uri" isn't nearly as helpful as you might think. Try to save requests without any params 
 and without a leading slash by defining a method in ApplicationController instead:
 
-  protected
-  def clean_request
-    request.request_uri.split('?').first[1..-1]
-  end 
+    protected
+    def clean_request
+      request.request_uri.split('?').first[1..-1]
+    end 
 
 Then, in your all\_seeing\_eye.yml:
   
-  request:
-    uri:
-      object: controller
-      method: .clean_request
+    request:
+      uri:
+        object: controller
+        method: .clean_request
 
 ## Running
 
-When your Rails application starts, you should see each request contain "+++ Request watched by AllSeeingEye." That means 
+When your Rails application starts, you should see each request contain `+++ Request watched by AllSeeingEye`. That means 
 AllSeeingEye is running successfully. Good job!
 
 Starting the server is simple. Just type `all-seeing-eye` from the commandline and Sinatra should start automatically.
 
+Using the web interface is fairly straightforward; the only bit that might need some explanation is searching, which is 
+kinda nifty.
+
+### Searching
+
+You can use the text field in the upper-right to search. Right now, AllSeeingEye accepts queries in one of two formats:
+
+1. One time in the past followed by another time in the past, separated by "to". AllSeeingEye uses Chronic for natural 
+language parsing on times, so you can use "yesterday to now", "last friday to yesterday", "last christmas to last easter" 
+and whatever other query formats Chronic supports.
+2. A field and a value, separated by a colon. So "ip:127.0.0.1" will show all results for that IP address, 
+"account:josh@joshsymonds.com" to find an account by a specific email, and so on. This will automatically try to find 
+the correct model that you're searching for as well, which is helpful.
+
 ## Extras
 
-I included the Nginx config we use for AllSeeingEye as a small bonus. It's in examples/all\_seeing\_eye-nginx.conf.
+I included the nginx config we use for AllSeeingEye as a small bonus. It's in examples/all\_seeing\_eye-nginx.conf.
 
 ## Contributing to AllSeeingEye
  

data/VERSION

@@ -1 +1 @@
-0.0.20
+0.1.0

data/all_seeing_eye.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{all_seeing_eye}
-  s.version = "0.0.20"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Josh Symonds"]
@@ -30,8 +30,6 @@ Gem::Specification.new do |s|
     "examples/all_seeing_eye-nginx.conf",
     "init.rb",
     "lib/all_seeing_eye.rb",
-    "lib/all_seeing_eye/generators/all_seeing_eye.yml",
-    "lib/all_seeing_eye/generators/all_seeing_eye_generator.rb",
     "lib/all_seeing_eye/integrations/rails2.rb",
     "lib/all_seeing_eye/model.rb",
     "lib/all_seeing_eye/server.rb",
@@ -46,6 +44,8 @@ Gem::Specification.new do |s|
     "lib/all_seeing_eye/server/views/layout.erb",
     "lib/all_seeing_eye/server/views/left.erb",
     "lib/all_seeing_eye/server/views/total.erb",
+    "lib/generators/all_seeing_eye/all_seeing_eye_generator.rb",
+    "lib/generators/all_seeing_eye/templates/all_seeing_eye.yml",
     "test/base_test.rb",
     "test/fixtures/all_seeing_eye.yml",
     "test/fixtures/redis-test.conf",

data/lib/all_seeing_eye/server/views/field.erb

@@ -78,7 +78,7 @@
       
         $("#graph").bind("plotclick", function (event, pos, item) {
             if (item) {
-              window.location = '<%= u "fields/#{CGI::escape(@field)}/" %>' + encodeURIComponent(ids[item.dataIndex])
+              window.location = '<%= u "#{@model.model_name}/#{CGI::escape(@field)}/" %>' + encodeURIComponent(ids[item.dataIndex])
             }
         });
     </script>

data/lib/all_seeing_eye/server/views/layout.erb

@@ -19,7 +19,9 @@
       </div>
       <ul class='nav'>
         <%= tab 'Total' %>
-        <%= tab 'Fields' %>
+        <% AllSeeingEye.configuration[:models].each do |m| %>
+          <%= tab m.model_name %>
+        <% end %>
         <li class='right'>
           <form action='<%=u '/search' %>'>
             <label>Search</label>

data/lib/all_seeing_eye/server/views/left.erb

@@ -1,19 +1,20 @@
+<% tabs = @model.field_keys %>
 <% if @field %>
   <% if @id %>
     <div id='left'>
       <ul>
-        <li class=<%= current_page.split(CGI.escape(@id))[1] ? '' : 'current' %>><a href="<%= u "fields/#{@field}/#{CGI.escape(@id)} " %>">Total</a></li>
+        <li class=<%= current_page.split(CGI.escape(@id))[1] ? '' : 'current' %>><a href="<%= u "#{@model.model_name}/#{@field}/#{CGI.escape(@id)} " %>">Total</a></li>
         <% (tabs - [@field]).each do |t| %>
-          <%= tab t, "fields/#{@field}/#{CGI.escape(@id)}" %>
+          <%= tab t, "#{@model.model_name}/#{@field}/#{CGI.escape(@id)}" %>
         <% end %>
       </ul>
     </div>
   <% elsif @query%>
     <div id='left'>
       <ul>
-        <li class=<%= current_page.split(CGI.escape(@query))[1] ? '' : 'current' %>><a href="<%= u "search/#{CGI.escape(@query) }" %>"}>Total</a></li>
+        <li class=<%= current_page.split(CGI.escape(@query))[1] ? '' : 'current' %>><a href="<%= u "search/#{@model.model_name}/#{CGI.escape(@query) }" %>"}>Total</a></li>
         <% tabs.each do |t| %>
-          <%= tab t, "search/#{CGI.escape(@query)}" %>
+          <%= tab t, "search/#{@model.model_name}/#{CGI.escape(@query)}" %>
         <% end %>
       </ul>
     </div>
@@ -21,7 +22,7 @@
     <div id='left'>
       <ul>
         <% (tabs).each do |t| %>
-          <%= tab t, 'fields' %>
+          <%= tab t, @model.model_name %>
         <% end %>
       </ul>
     </div>

data/lib/all_seeing_eye/server.rb

@@ -80,64 +80,76 @@ class AllSeeingEye
     end
     
     get '/search' do
-      redirect url_path("/search/#{CGI::escape(params[:query])}")
+      AllSeeingEye.configuration[:models].each do |m|
+        results = m.search(params[:query])
+        if !results.nil? && !results.empty?
+          redirect url_path("/search/#{m.model_name}/#{CGI::escape(params[:query])}")
+          break
+        end
+      end
+      show :total
     end
     
-    get "/fields" do
-      redirect url_path("/fields/#{AllSeeingEye::Request.field_keys.first}")
-    end
-
-    AllSeeingEye::Request.field_keys.each do |field|
-      get "/fields/#{field}" do
-        @page = params[:page].blank? ? 1 : params[:page].to_i
-        @field = field
-        @count = AllSeeingEye::Request.count
-        @requests = AllSeeingEye::Request.list_by_field(@field, :page => @page)
-        show :field
-      end
-      
-      get %r{/search/(.*?)/#{field}$} do
-        @page = params[:page].blank? ? 1 : params[:page].to_i
-        @field = field
-        @query = params[:captures].first
-        @requests = AllSeeingEye::Request.search(@query)
-        counts = Hash.new(0)
-        @requests.each {|r| next if r.send(@field.to_sym).nil?; counts[r.send(@field.to_sym)] += 1}
-        @requests = counts.sort {|a, b| b.last <=> a.last}
-        show :field
+    AllSeeingEye.configuration[:models].each do |model|
+    
+      get "/#{model.model_name}" do
+        @model = model
+        redirect url_path("/#{model.model_name}/#{model.field_keys.first}")
       end
 
-      (AllSeeingEye::Request.field_keys - [field]).each do |f|
-        get %r{/fields/#{field}/(.*?)/#{f}$} do
+      AllSeeingEye::Request.field_keys.each do |field|
+        get "/#{model.model_name}/#{field}" do
+          @model = model
           @page = params[:page].blank? ? 1 : params[:page].to_i
           @field = field
-          @id = params[:captures].first
-          @view = f
-          @requests = AllSeeingEye::Request.find_by_field(@field, :value => @id)
+          @count = model.count
+          @requests = model.list_by_field(@field, :page => @page)
+          show :field
+        end
+      
+        get %r{/search/#{model.model_name}/(.*?)/#{field}$} do
+          @model = model
+          @page = params[:page].blank? ? 1 : params[:page].to_i
+          @field = field
+          @query = params[:captures].first
+          @requests = model.search(@query)
           counts = Hash.new(0)
-          @requests.each {|r| next if r.send(@view.to_sym).nil?; counts[r.send(@view.to_sym)] += 1}
+          @requests.each {|r| next if r.send(@field.to_sym).nil?; counts[r.send(@field.to_sym)] += 1}
           @requests = counts.sort {|a, b| b.last <=> a.last}
           show :field
         end
-      end
+
+        (AllSeeingEye::Request.field_keys - [field]).each do |f|
+          get %r{/#{model.model_name}/#{field}/(.*?)/#{f}$} do
+            @model = model
+            @page = params[:page].blank? ? 1 : params[:page].to_i
+            @field = field
+            @id = params[:captures].first
+            @view = f
+            @requests = model.find_by_field(@field, :value => @id)
+            counts = Hash.new(0)
+            @requests.each {|r| next if r.send(@view.to_sym).nil?; counts[r.send(@view.to_sym)] += 1}
+            @requests = counts.sort {|a, b| b.last <=> a.last}
+            show :field
+          end
+        end
       
-      get %r{/fields/#{field}/(.*)$} do
-        @field = field
-        @id = params[:captures].first
-        @counts = AllSeeingEye::Request.list_by_field(@field, :value => @id)
-        show :total
+        get %r{/#{model.model_name}/#{field}/(.*)$} do
+          @model = model
+          @field = field
+          @id = params[:captures].first
+          @counts = model.list_by_field(@field, :value => @id)
+          show :total
+        end
       end
-    end
     
-    get %r{/search/(.*?)$} do
-      @field = 'total'
-      @query = params[:captures].first
-      @counts = AllSeeingEye::Request.search(@query, :count => true)
-      show :total
-    end
-
-    def tabs
-      @tabs ||= AllSeeingEye::Request.field_keys
+      get %r{/search/#{model.model_name}/(.*?)$} do
+        @model = model
+        @field = 'total'
+        @query = params[:captures].first
+        @counts = model.search(@query, :count => true)
+        show :total
+      end
     end
   end
 end

data/lib/{all_seeing_eye/generators → generators/all_seeing_eye}/all_seeing_eye_generator.rb

@@ -1,7 +1,7 @@
 class AllSeeingEyeGenerator < Rails::Generator::Base
   def manifest
     record do |m|
-      m.template('all_seeing_eye.yml', "config/initializers/all_seeing_eye.yml")
+      m.template('all_seeing_eye.yml', "config/all_seeing_eye.yml")
     end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: all_seeing_eye
 version: !ruby/object:Gem::Version 
-  hash: 55
+  hash: 27
   prerelease: 
   segments: 
   - 0
+  - 1
   - 0
-  - 20
-  version: 0.0.20
+  version: 0.1.0
 platform: ruby
 authors: 
 - Josh Symonds
@@ -185,8 +185,6 @@ files:
 - examples/all_seeing_eye-nginx.conf
 - init.rb
 - lib/all_seeing_eye.rb
-- lib/all_seeing_eye/generators/all_seeing_eye.yml
-- lib/all_seeing_eye/generators/all_seeing_eye_generator.rb
 - lib/all_seeing_eye/integrations/rails2.rb
 - lib/all_seeing_eye/model.rb
 - lib/all_seeing_eye/server.rb
@@ -201,6 +199,8 @@ files:
 - lib/all_seeing_eye/server/views/layout.erb
 - lib/all_seeing_eye/server/views/left.erb
 - lib/all_seeing_eye/server/views/total.erb
+- lib/generators/all_seeing_eye/all_seeing_eye_generator.rb
+- lib/generators/all_seeing_eye/templates/all_seeing_eye.yml
 - test/base_test.rb
 - test/fixtures/all_seeing_eye.yml
 - test/fixtures/redis-test.conf