abaci 0.1.0

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## Abaci 0.1.0
+
+* Initial build

data/README.md

@@ -0,0 +1,75 @@
+# Abaci
+
+[![Build Status](https://secure.travis-ci.org/jdtornow/abaci.png)](http://travis-ci.org/jdtornow/abaci) [![Dependency Status](https://gemnasium.com/jdtornow/abaci.png?travis)](https://gemnasium.com/jdtornow/abaci)
+
+Abaci (pronounced abba-sigh) is a simple structure for the collection and reporting on numerical counters. Counters can be used to track time-based statistics for a wide array of functions within your application. Abaci uses a Redis backend to store all counters for lightning quick read and write access.
+
+What does *abaci* mean? Its the plural form of [Abacus](http://en.wikipedia.org/wiki/Abacus), a common arithmetic assistance device from before we had computers. Imagine that.
+
+## Requirements
+
+* Ruby 1.9.2+
+* Redis
+
+## Configuration
+
+Abaci will use the default Redis instance by default, assumed to be available via `Redis.current`. To use with a specific Redis instance, pass a `Redis` object to `Abaci.options[:redis]`. You can use it this way with [Redis Namespace](https://github.com/defunkt/redis-namespace) if necessary.
+
+By default, the prefix `ab` is used before all stats stored in Redis. If you are using running multiple apps using the same Redis instance (likely in development mode), you can change the prefix by setting `Abaci.options[:prefix]`.
+
+Here's a sample configuration that we use often:
+
+```ruby
+connection = Redis.new
+REDIS = Redis::Namespace.new(:ns, :redis => connection)
+
+Abaci.options[:redis] = REDIS
+Abaci.options[:prefix] = 'stats'
+```
+
+If you are using Rails, put that in an initializer and you're good to go.
+
+## Basic Usage
+
+```ruby
+# Log page views
+Abaci['views'].increment # => 1
+Abaci['views'].increment # => 2
+
+# Increment (and decrement) all take a parameter or default to incrementing by 1
+Abaci['views'].increment(3) # => 5
+
+# Decrementing is available if needed
+Abaci['views'].decrement # => 4
+
+# Get total number of views
+Abaci['views'].get # => 4
+
+# Get total number of views in year 2012
+Abaci['views'].get(2012) # => 4
+
+# Get total number of views in October of 2012
+Abaci['views'].get(2012, 10) # => 4
+
+# Get total number of views on October 20, 2012
+Abaci['views'].get(2012, 10, 20) # => 4
+
+# Get total views in the last 30 days
+Abaci['views'].get_last_days(30) # => 4
+
+# View all counter stat keys stored
+Abaci['views'].keys
+
+# Clear counters for views
+Abaci['views'].del
+```
+
+## Issues
+
+If you have any issues or find bugs running Abaci, please [report them on Github](https://github.com/jdtornow/abaci/issues). While most functions should be stable, Abaci is still in its infancy and certain issues may be present.
+
+## License
+
+Abaci is released under the [MIT license](http://www.opensource.org/licenses/MIT)
+
+Contributions and pull-requests are more than welcome.

data/lib/abaci.rb

@@ -0,0 +1,28 @@
+require 'abaci/version'
+
+module Abaci
+  autoload :Counter,      'abaci/counter'
+  autoload :Store,        'abaci/store'
+
+  # Configuration options
+  class << self
+    def [](key)
+      Counter[key]
+    end
+
+    def options
+      @options ||= {
+        :redis => nil,
+        :prefix => 'ab'
+      }
+    end
+
+    def prefix
+      options[:prefix]
+    end
+
+    def store
+      @store ||= Store.new(options)
+    end
+  end
+end

data/lib/abaci/counter.rb

@@ -0,0 +1,100 @@
+module Abaci
+  class Counter
+    attr_reader :key
+
+    def initialize(key = nil)
+      @key = key
+    end
+
+    def decr(by = 1)
+    decrement_at(nil, by)
+    end
+    alias_method :decrement, :decr
+
+    def decrement_at(date = nil, by = 1)
+      date = Time.now unless date.respond_to?(:strftime)
+      run(:decrby, by, date)
+    end
+
+    def del
+      keys.each { |k| Abaci.store.del(k) }
+      true
+    end
+
+    def get(year = nil, month = nil, day = nil, hour = nil, min = nil)
+      get_key = [ key, year, month, day, hour, min ].compact.join(':')
+      Abaci.store.get(get_key).to_i
+    end
+
+    def get_last_days(number_of_days = 30)
+      seconds = number_of_days.to_i * 86400
+      start = (Date.today - Rational(seconds, 86400)).to_date
+      dates = (start..Date.today).map { |d| d.strftime('%Y:%-m:%-d') }
+      dates.map { |date| Abaci.store.get("#{key}:#{date}" ).to_i }.reduce(:+)
+    end
+
+    def incr(by = 1)
+      increment_at(nil, by)
+    end
+    alias_method :increment, :incr
+
+    def increment_at(date = nil, by = 1)
+      date = Time.now unless date.respond_to?(:strftime)
+      run(:incrby, by, date)
+    end
+
+    def keys
+      Abaci.store.keys("#{key}*")
+    end
+
+    ## Class methods ##
+    ############################################################################
+
+    # Returns a hash of all current values
+    def self.all
+      keys.inject({}) { |hash, key| hash[key] = Abaci.store.get(key).to_i; hash }
+    end
+
+    # Gets all currently logged stat keys
+    def self.keys(search = "*")
+      Abaci.store.keys(search).sort
+    end
+
+    # Alias for Counter#new(key)
+    def self.[](key)
+      Counter.new(key)
+    end
+
+    def self.method_missing(method, *args)
+      ms = method.to_s.downcase.strip
+
+      if ms =~ /(incr|decr)(ement|ease)?_([a-z_]*)$/
+        return self[$3].send($1, *args)
+      elsif ms =~ /^(clear|reset|del)_([a-z_]*)!$/
+        return self[$2].del
+      elsif ms =~ /^last_(\d*)_days_of_([a-z_]*)$/
+        return self[$2].get_last_days($1)
+      elsif ms =~ /[a-z_]*/
+        return self[ms].get(*args)
+      end
+
+      super
+    end
+
+    ## Protected methods ##
+    ############################################################################
+
+    protected
+      def run(method, by, date)
+        now = date.strftime('%Y/%m/%d/%k/%M').split('/')
+
+        now.inject(key) do |memo, t|
+          memo = "#{memo}:#{t.to_i}"
+          Abaci.store.send(method, memo, by)
+          memo
+        end
+
+        Abaci.store.send(method, key, by)
+      end
+  end
+end

data/lib/abaci/store.rb

@@ -0,0 +1,48 @@
+module Abaci
+  require 'redis'
+
+  # Common interface for Redis. In the future this could be
+  # swapped out for an alternate datastore.
+  class Store
+    def initialize(options)
+      @redis = options[:redis] || Redis.current
+      @prefix = options[:prefix] || 'ab'
+    end
+
+    def decrby(key, by = 1)
+      exec(:decrby, key, by)
+    end
+
+    def del(key)
+      exec(:del, key)
+    end
+
+    def get(key)
+      exec(:get, key)
+    end
+
+    def incrby(key, by = 1)
+      exec(:incrby, key, by)
+    end
+
+    def keys(pattern)
+      sub = Regexp.new("^#{Abaci.prefix}:")
+      exec(:keys, pattern).map { |k| k.gsub(sub, '') }
+    end
+
+    def set(key, value)
+      exec(:set, key, value)
+    end
+
+    protected
+      def exec(command, key, *args)
+        if @redis and @redis.respond_to?(command)
+          @redis.send(command, prefixed_key(key), *args)
+        end
+      end
+
+      def prefixed_key(key)
+        [ @prefix, key ].compact.join(':')
+      end
+  end
+end

data/lib/abaci/version.rb

@@ -0,0 +1,3 @@
+module Abaci
+  VERSION = "0.1.0" unless defined?(::Abaci::VERSION)
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: abaci
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- John Tornow
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Collect stats on events, activities and behaviors across time in Ruby
+  with a Redis backend.
+email:
+- john@johntornow.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/abaci/counter.rb
+- lib/abaci/store.rb
+- lib/abaci/version.rb
+- lib/abaci.rb
+- README.md
+- CHANGELOG.md
+homepage: http://github.com/jdtornow/abaci
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A basic stats reporting and collection tool for Ruby.
+test_files: []
+has_rdoc: