mancora 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - "1.9.3"

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mancora.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Caleb
+
+MIT License
+
+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,130 @@
+# Mancora [![Build Status](https://secure.travis-ci.org/cbron/mancora.png)](http://travis-ci.org/cbron/mancora)
+
+Easily save counts of models or specific model queries on regular intervals into a single table to use for statistics.
+
+For example, you can set up a count on the number of subscribers you get per hour, day, week, etc. That number will be saved in a table in the database with which you can do whatever you want (I'll show you how to graph it below). The other main option is a total count, basically a `User.count` for each of those time periods. Finally you can specify a custom class method to call, completely seperate from Mancora.
+
+
+## Installation
+
+Add this line to your application's Gemfile
+
+    gem 'mancora'
+
+And then execute
+
+    bundle
+
+To add it to your application
+
+    rails g mancora:install
+    rake db:migrate # Creates a mancora_stats table, use `Mancora::Stat` to access it
+
+## Usage
+
+Then setup your lib/mancora.rb file. Only class_name and intervals are required
+
+    Mancora.widgets do
+
+      widget :errors_per_hour do
+        class_name Requests
+        intervals :hourly
+        conditions :name => "error"
+      end
+      #this generates: Request.where(:name => "error", :created_at => 1.hour.ago.beginning_of_hour..1.hour.ago.end_of_hour).count
+
+      widget :subscribers_count do
+        class_name Subscriber
+        intervals [:hourly, :daily, :monthly, :yearly]
+        field :registered_at
+        time 1.day.ago #lag by one day
+      end
+
+      widget :total_subscribers_count do
+        class_name Subscriber
+        intervals [:daily, :weekly, :monthly, :yearly]
+        count_type :total
+      end
+
+      widget :custm_promo_codes
+        class_name Subscriber
+        class_method generate_promo_code_hash
+        intervals :monthly
+      end
+
+    end
+
+Options
+
+key | function
+--- | ---
+class_name | The class name you will be querying on
+intervals | The interval you want to collect stats on
+count_type | The type of count for this interval. `:timed` will query only this time period and is the default. `:total` will just do a total count on that modal, it cannot be backfilled. 
+conditions | Additional conditions for query as a hash
+field | Field other than created_at to query on. Not included if count_type is :total.
+time | Amount of time to lag by: 1.day, 1.hour.
+class_method | Custom class method to call, will not insert row in database. All this does is call the method at run time
+
+
+Now to run it
+
+    #in the console
+    Mancora.run
+
+    #backfill the last 36 hours
+    Mancora.run(36)
+
+    #via rake
+    rake mancora
+
+Finally setup a cron to run **every hour**. You could use the whenever gem but personally I still like: 
+
+    # Every hour at 5 minutes in
+    5 */1 * * * cd /rails_path && /usr/local/bin/rake RAILS_ENV=production mancora >> /rails_path/log/mancora.log 2>&1
+
+    
+
+Result in db (notice subscribers_count has a day lag, and daily includes the time zone)
+
+id | name | intervals | count | start | end
+--- | --- | --- | --- | --- | ---
+1 | errors | hourly | 4 | 2013-03-01 21:00:00 | 2013-03-01 21:59:59
+2 | subscribers_count | hourly | 2 | 2013-02-28 21:00:00 | 2013-02-28 21:59:59
+3 | total_subscribers_count | daily | 972 | 2013-02-27 07:00:00 | 2013-02-28 06:59:59
+
+
+## Graphing the results
+
+I ended up using Morris: http://www.oesmith.co.uk/morris.js/
+
+After installing Raphael/Morris its as easy as: 
+
+Controller
+
+    @subscribers_today = Mancora::Stat.where(:name => "subscribers_count", :intervals => :hourly).limit(24).order("start desc")
+
+View
+
+    %h1 Subscribers today
+    =content_tag :div, "", id: "subscribers_chart", data: {subscriberstoday: @subscribers_today} 
+
+Coffeescript
+
+    Morris.Line
+      element: "subscribers_chart"
+      data: $("#subscribers_chart").data('subscribers')
+      xkey: "start"
+      ykeys: ["count"]
+      labels: ["Count"]
+      hideHover: false
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+
+task :test do
+  puts "done"
+end
+
+task :default => [:test]

data/lib/generators/mancora/install/install_generator.rb

@@ -0,0 +1,25 @@
+require 'rails/generators/migration'
+
+module Mancora
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      include Rails::Generators::Migration
+      source_root File.expand_path('../templates', __FILE__)
+      desc "add the migrations"
+
+      def self.next_migration_number(path)
+        unless @prev_migration_nr
+          @prev_migration_nr = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
+        else
+          @prev_migration_nr += 1
+        end
+        @prev_migration_nr.to_s
+      end
+
+      def copy_migrations
+        migration_template "create_mancora_stats.rb", "db/migrate/create_mancora_stats.rb"
+        copy_file "mancora.rb", "lib/mancora.rb"        
+      end
+    end
+  end
+end

data/lib/generators/mancora/install/templates/create_mancora_stats.rb

@@ -0,0 +1,13 @@
+class CreateMancoraStats < ActiveRecord::Migration
+  def change
+    create_table :mancora_stats do |t|
+      t.string :name
+      t.string :intervals
+      t.integer :count
+      t.datetime :start
+      t.datetime :end
+
+      t.timestamps
+    end
+  end
+end

data/lib/generators/mancora/install/templates/mancora.rb

@@ -0,0 +1,28 @@
+Mancora.widgets do 
+
+  # widget :errors do
+  #   class_name ManualStat
+  #   intervals [:hourly, :daily, :weekly, :monthly, :yearly]
+  #   conditions :name => "error"
+  # end
+
+  # widget :subscribers_count do
+  #   class_name Subscriber
+  #   intervals :hourly
+  #   field :registered_at
+  #   time 1.day.ago #lag by one day
+  # end
+
+  # widget :total_subscribers_count do
+  #   class_name Subscriber
+  #   intervals [:daily, :weekly, :monthly, :yearly]
+  #   count_type :total
+  # end
+
+  # widget :custm_promo_codes
+  #   class_name Subscriber
+  #   class_method generate_promo_code_hash
+  #   intervals :monthly
+  # end
+
+end

data/lib/mancora/railtie.rb

@@ -0,0 +1,11 @@
+require 'mancora'
+require 'rails'
+module Mancora
+  class Railtie < Rails::Railtie
+    railtie_name :mancora
+
+    rake_tasks do
+      load "tasks/tasks.rake"
+    end
+  end
+end

data/lib/mancora/stat.rb

@@ -0,0 +1,5 @@
+module Mancora
+  class Stat < ActiveRecord::Base
+    attr_accessible :count, :end, :intervals, :name, :start
+  end
+end

data/lib/mancora/version.rb

@@ -0,0 +1,3 @@
+module Mancora
+  VERSION = "0.0.1"
+end

data/lib/mancora/widget.rb

@@ -0,0 +1,136 @@
+class Widget
+  attr_accessor :name, :class_name, :intervals, :count_type, :conditions,
+                :start, :end, :time, :field, :query, :class_method
+  
+  def initialize(name, backfill = 0, &block)
+    @name = name
+    @conditions = {}
+    instance_eval &block
+
+    lazy_names
+
+    #run all backfills plus the original @time
+    backfill.downto(0) do |b|
+      b != 0 ? @backfilling = true : @backfilling = false
+      @run_time = @time - b.hours
+
+      @intervals.each do |i|
+        time_interval = @query.blank? ? get_interval(i) : {}
+        all_conditions = @conditions.merge(time_interval)
+        run(i, all_conditions) if should_i_run?(i)
+      end
+    end
+  end
+
+  def class_name(str)
+    @class_name = str
+  end
+
+  def intervals(opts)
+    @intervals =  opts.instance_of?(Array)? opts : [opts]
+  end
+
+  def count_type(str)
+    @count_type = str
+  end
+
+  def conditions(str)
+    @conditions =  str
+  end
+
+  def time(str)
+    @time = str
+  end
+
+  def field(str)
+    @field = str
+  end
+
+  def query(str)
+    @query = str
+  end
+
+  def class_method(str)
+    @class_method = str
+  end
+
+  def lazy_names
+    @time ||= Time.now
+    @field ||= :created_at
+    @count_type ||= :timed
+  end
+
+  def run(interval, all_conditions)
+    puts "Running " + interval.to_s + " " + self.name.to_s
+
+    if @class_method
+      @class_name.send(@class_method)
+    else
+      if @count_type == :timed
+        result = @class_name.where(all_conditions)
+      elsif @count_type == :total
+        count = (@backfilling ? nil : @class_name.where(@conditions).count)
+      elsif !@query.blank?
+        result = eval(@query)
+      end
+
+      #create or update record, this way we can backfill without overwriting
+      obj = Mancora::Stat.find_or_initialize_by_name_and_start(name, @start)
+
+      obj.update_attributes(
+         :name => @name,
+         :start => @start,
+         :end => @end,
+         :intervals => interval,
+         :count => (@count_type == :timed ? result.count : count)
+      )
+    end
+  end
+
+  #given an interval symbol, return a hash with the correct conditions
+  def get_interval(interval)
+    case interval
+      when :custom
+        return {}
+      when :hourly
+        @start = (@run_time - 1.hour).beginning_of_hour
+        @end = (@run_time - 1.hour).end_of_hour
+        return {@field => @start..@end}
+      when :daily
+        @start = @run_time.yesterday.beginning_of_day
+        @end = @run_time.yesterday.end_of_day
+        return {@field => @start..@end}
+      when :weekly
+        @start = @run_time.yesterday.beginning_of_week
+        @end = @run_time.yesterday.end_of_week
+        return {@field => @start..@end}
+      when :monthly
+        @start = @run_time.yesterday.beginning_of_month
+        @end = @run_time.yesterday.end_of_month
+        return {@field => @start..@end}
+      when :yearly
+        @start = @run_time.yesterday.beginning_of_year
+        @end = @run_time.yesterday.end_of_year
+        return {@field => @start..@end}
+    end
+  end
+
+  #given an interval symbol, determine whether or not a query (and relative db insert) should take place
+  def should_i_run?(interval)
+    if interval == :hourly
+      true
+    elsif interval == :daily && @run_time.hour == 0
+      true
+    elsif interval == :weekly && @run_time.beginning_of_week == @run_time.beginning_of_day
+      true
+    elsif interval == :monthly && @run_time.day == 1
+      true
+    elsif interval == :yearly && @run_time.beginning_of_year == @run_time.beginning_of_day
+      true
+    else
+      false
+    end
+  end
+
+
+end

data/lib/mancora.rb

@@ -0,0 +1,26 @@
+require "mancora/version"
+require 'mancora/widget'
+require 'mancora/stat'
+require 'mancora/railtie' if defined?(Rails)
+
+module Mancora
+  extend self
+  
+  def self.table_name_prefix
+    'mancora_'
+  end
+
+  def self.run(backfill = 0)
+    @backfill = backfill
+    puts "Backfilling " + (@backfill || 0).to_s  + " hours." if @backfill > 0
+    load Rails.root.join('lib', 'mancora.rb')
+  end
+
+  def widgets(hash = {}, &block)  
+    instance_eval(&block) if block_given?
+  end
+
+  def widget(opt, options = {}, &block)
+    Widget.new(opt, @backfill, &block)
+  end
+end

data/lib/tasks/tasks.rake

@@ -0,0 +1,4 @@
+task :mancora => :environment do
+  puts "Mancora running..."
+  Mancora.run
+end

data/mancora.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mancora/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mancora"
+  spec.version       = Mancora::VERSION
+  spec.authors       = ["cbron"]
+  spec.email         = ["x@x.com"]
+  spec.description   = %q{Save for counts for statistics}
+  spec.summary       = %q{Easily save counts of models on regular intervals into a single table to use for statistics.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: mancora
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- cbron
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-07 00:00:00.000000000 Z
+dependencies:
+- !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: rake
+  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: Save for counts for statistics
+email:
+- x@x.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/mancora/install/install_generator.rb
+- lib/generators/mancora/install/templates/create_mancora_stats.rb
+- lib/generators/mancora/install/templates/mancora.rb
+- lib/mancora.rb
+- lib/mancora/railtie.rb
+- lib/mancora/stat.rb
+- lib/mancora/version.rb
+- lib/mancora/widget.rb
+- lib/tasks/tasks.rake
+- mancora.gemspec
+homepage: ''
+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: 92013857095353279
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 92013857095353279
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Easily save counts of models on regular intervals into a single table to
+  use for statistics.
+test_files: []