prisma 0.1.0

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Christof Dorner
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,19 @@
+# prisma [![Continuous Integration](https://secure.travis-ci.org/chdorner/prisma.png?branch=master)](https://secure.travis-ci.org/chdorner/prisma)
+
+Prisma is a simple request stats collector for Rails applications with configurable groups.
+
+## Contributing to prisma
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2012 Christof Dorner. See LICENSE.txt for
+further details.
+

data/bin/prisma-web

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
+begin
+  require 'vegas'
+rescue LoadError
+  require 'rubygems'
+  require 'vegas'
+end  
+require 'prisma/server'
+
+
+Vegas::Runner.new(Prisma::Server, 'prisma-web') do |runner, opts, app|
+  opts.on('-N NAMESPACE', "--namespace NAMESPACE", "set the Redis namespace") {|namespace|
+    runner.logger.info "Using Redis namespace '#{namespace}'"
+    Prisma.redis_namespace = namespace
+  }
+  opts.on('-r redis-connection', "--redis redis-connection", "set the Redis connection string") {|redis_connection|
+    runner.logger.info "Using Redis connection '#{redis_connection}'"
+    Prisma.redis = redis_connection
+  }
+end

data/lib/prisma.rb

@@ -0,0 +1,108 @@
+require 'rails/all'
+require 'redis-namespace'
+
+require 'prisma/group'
+require 'prisma/railtie'
+require 'prisma/filter'
+
+# Used for configuration, typically in a Rails initializer.
+module Prisma
+  mattr_reader :groups
+  # @!visibility private
+  @@groups = {}
+
+  # @!visibility public
+  # Set your own +Redis+ instance, it will be wrapped into a +Redis::Namespace+ object with the configured namespace.
+  # Useful for when Redis is not available on the standard IP and port.
+  # Allows:
+  # - hostname:port
+  # - hostname:port:db
+  # - redis://hostname:port/db
+  # - +Redis+ instance
+  mattr_accessor :redis
+  # @!visibility private
+  @@redis = ::Redis.new
+
+  # @!visibility public
+  # String for redis namespace, defaults to +prisma+
+  mattr_accessor :redis_namespace
+  # @!visibility private
+  @@redis_namespace = 'prisma' 
+
+  # @!visibility public
+  # Duration in seconds for expiring redis keys (easy to use with Rails duration helpers +1.day+)
+  mattr_accessor :redis_expiration_duration
+
+  # Configure prisma. Example usage:
+  #     Prisma.setup do |config|
+  #       config.group :active_api_clients { |controller| controller.current_client.id }
+  #       config.redis = Redis.new(:db => 1)
+  #       config.redis_namespace = 'stats'
+  #       config.redis_expiration_duration = 2.days
+  #     end
+  def self.setup
+    yield self
+    store_configuration
+  end
+
+  # Configures a group. The instance of the current {http://api.rubyonrails.org/classes/ActionController/Base.html ActionController} is being passed as an argument into the block.
+  # As an example, tracking daily active users could be as simple as:
+  #     Prisma.setup |config|
+  #       config.group :logged_in { |controller| controller.current_user.id }
+  #     end
+  #
+  # @param [Symbol/String] name for identifying the group, it is used as part of the redis key.
+  # @param [String] description for describing the gorup, it is used in the admin interface.
+  # @param [Block] block returning a String (or a meaningful +.to_s output+) which is used for identifying a counter inside a group, Prisma doesn't count a request if block returns +nil+ or +false+
+  def self.group(name, description=nil, &block)
+    @@groups[name] = Group.new(:name => name, :description => description, :block => block)
+  end
+
+  # Returns a default or configured +Redis+ instance wrapped in a +Redis::Namespace+
+  # @return [Redis::Namespace]
+  def self.redis
+    @@namespaced_redis ||= lambda do
+      case @@redis
+      when String
+        if @@redis =~ /redis\:\/\//
+          redis = Redis.connect(:url => @@redis, :thread_safe => true)
+        else
+          host, port, db = @@redis.split(':')
+          redis = Redis.new(:host => host, :port => port, :thread_safe => true, :db => db)
+        end
+        Redis::Namespace.new(redis_namespace, :redis => redis)
+      else
+        Redis::Namespace.new(redis_namespace, :redis => @@redis)
+      end
+    end.call
+  end
+
+  # @!visibility private
+  # Returns redis key for a group name and optional date
+  # @param [Symbol/String] group_name for which group the redis key is for
+  # @param [Date] date for which date the redis key is for, if not given it uses today's date
+  # @return [String] the redis key
+  def self.redis_key(group_name, date=nil)
+    date = Time.now.utc.to_date unless date
+    "#{group_name}:#{date.strftime('%Y:%m:%d')}"
+  end
+
+  # @!visibility private
+  # Returns duration of from beginning of day to now + given or configured duration
+  # @param [Numeric] duration in seconds (defaults to configured +redis_expiration_duration+)
+  # @return [Numeric] duration
+  def self.redis_expire(duration=nil)
+    duration = redis_expiration_duration unless duration
+    (Time.now.utc.beginning_of_day + duration).to_i - Time.now.utc.to_i
+  end
+
+  # @!visibility private
+  # Stores the configured groups inside of redis
+  def self.store_configuration
+    redis.del 'configuration'
+    groups.values.each do |group|
+      redis.hset 'configuration', group.name, group.description
+    end
+  end
+end
+

data/lib/prisma/filter.rb

@@ -0,0 +1,23 @@
+module Prisma
+  # Gets included into controllers and runs after_filter method
+  module Filter
+    extend ActiveSupport::Concern
+
+    included do
+      after_filter :prisma_disperse_request
+    end
+
+    protected
+
+    def prisma_disperse_request
+      Prisma.groups.each do |name, group|
+        redis_key = Prisma.redis_key(name)
+        value = group.block.call(self)
+        Prisma.redis.hincrby redis_key, value, 1 if value
+
+        Prisma.redis.expire redis_key, Prisma.redis_expire if Prisma.redis_expiration_duration
+      end
+    end
+  end
+end
+

data/lib/prisma/group.rb

@@ -0,0 +1,66 @@
+module Prisma
+  # Represents a configured group, has convenience methods for getting data.
+  class Group
+    # The name of the group, typically a +Symbol+
+    attr_accessor :name
+
+    # The description of the group, typcially a +String+
+    attr_accessor :description
+
+    # The block which evaluates to a +String+ or meaningful +Object.to_s+
+    attr_accessor :block
+
+    # Initialize +Group+ from a hash
+    def initialize(options={})
+      self.name = options[:name]
+      self.description = options[:description]
+      self.block = options[:block]
+    end
+
+    # Get a +Hash+ with the +Date+ as key and amount of items as the value. Grouped by day.
+    #     group.range(5.days.ago.to_date..Date.today)
+    #     group.daily(5.days.ago.to_date..Date.today)
+    # @param [Range] range of days
+    # @return [Hash]
+    def range(range)
+      range = range..range if range.is_a? Date
+      data = {}
+      range.each do |date|
+        data[date] = Prisma.redis.hlen Prisma.redis_key(name, date)
+      end
+      data
+    end
+    alias_method :daily, :range
+
+    # Get a +Hash+ with the +Date+ as key and amount of items as the value. Grouped by week, key represents a +Date+ object of the first day of the week.
+    #     group.weekly(1.week.ago.to_date..Date.today)
+    # @param [Range] range of days
+    # @return [Hash]
+    def weekly(range)
+      data = range(range)
+
+      data = data.group_by { |date, value| date.beginning_of_week }
+      sum_up_grouped_data(data)
+    end
+
+    # Get a +Hash+ with the +Date+ as key and amount of items as the value. Grouped by month, key represents a +Date+ object of the first day of the month.
+    #     group.monthly(1.month.ago.to_date..Date.today)
+    # @param [Range] range of days
+    # @return [Hash]
+    def monthly(range)
+      data = range(range)
+
+      data = data.group_by { |date, value| date.beginning_of_month }
+      sum_up_grouped_data(data)
+    end
+
+    private
+
+    def sum_up_grouped_data(data)
+      data.each do |date, values|
+        data[date] = values.map { |value| value.second }.inject{ |sum, count| sum + count }
+      end
+    end
+  end
+end
+

data/lib/prisma/railtie.rb

@@ -0,0 +1,10 @@
+module Prisma
+  class Railtie < Rails::Railtie
+    initializer 'prisma.insert_into_action_controller' do
+      ActiveSupport.on_load :action_controller do
+        ActionController::Base.send(:include, ::Prisma::Filter)
+      end
+    end
+  end
+end
+

data/lib/prisma/server.rb

@@ -0,0 +1,54 @@
+require 'sinatra/base'
+require 'erb'
+require 'prisma'
+require 'active_support/core_ext'
+
+module Prisma
+  # Sinatra application for viewing request stats
+  class Server < Sinatra::Base
+    dir = File.join(File.dirname(File.expand_path(__FILE__)), 'server')
+
+    set :views, File.join(dir, 'views')
+    set :public_folder, File.join(dir, 'public')
+
+    get '/' do
+      redirect to('/daily')
+    end
+
+    get '/daily' do
+      @date_format = '%m-%d'
+      @groups = groups.map do |group|
+        values = group.daily (Date.today-1.month)..Date.today
+        [group, values]
+      end
+      erb :index
+    end
+
+    get '/weekly' do
+      @date_format = '%W'
+      @groups = groups.map do |group|
+        values = group.weekly (Date.today-3.months)..Date.today
+        [group, values]
+      end
+      erb :index
+    end
+
+    get '/monthly' do
+      @date_format = '%Y-%m'
+      @groups = groups.map do |group|
+        values = group.monthly (Date.today-1.year)..Date.today
+        [group, values]
+      end
+      erb :index
+    end
+
+    private
+
+    def groups
+      Prisma.redis.hgetall('configuration').map do |name, description|
+        Prisma::Group.new(:name => name, :description => description)
+      end
+    end
+  end
+end
+

metadata

@@ -0,0 +1,331 @@
+--- !ruby/object:Gem::Specification
+name: prisma
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Christof Dorner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: redis-namespace
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: vegas
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  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: bundler
+  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: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+- !ruby/object:Gem::Dependency
+  name: guard
+  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: guard-rspec
+  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: guard-livereload
+  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: rb-fsevent
+  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: growl
+  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: simplecov
+  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: timecop
+  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: shotgun
+  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: 
+email: christof@chdorner.me
+executables:
+- prisma-web
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- bin/prisma-web
+- lib/prisma.rb
+- lib/prisma/filter.rb
+- lib/prisma/group.rb
+- lib/prisma/railtie.rb
+- lib/prisma/server.rb
+- LICENSE.txt
+- README.md
+homepage: https://github.com/chdorner/prisma
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2724509723049501504
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Simple request stats collector for Rails applications
+test_files: []