Merge branch 'release/v0.0.3'

Gemfile

@@ -1,12 +1,14 @@
 source 'http://rubygems.org/'
 
 gem 'activesupport', '>= 2.3.0'
-gem 'json', '>= 1.0.0'
-gem 'redis', '>= 2.0.0'
+gem 'json', '>= 1.4.6'
+gem 'redis', '>= 2.1.1'
+gem 'system_timer', '>= 1.0.0'
 gem 'time_ext', '>= 0.2.6'
 
 group :development do
-  gem 'rspec', '>= 2.0.1'
-  gem 'yard', '>= 0.6.1'
+  gem 'jeweler', '>= 1.5.1'
+  gem 'rspec', '>= 2.1.0'
+  gem 'yard', '>= 0.6.3'
   gem 'i18n'
 end

Gemfile.lock

@@ -3,8 +3,14 @@ GEM
   specs:
     activesupport (3.0.3)
     diff-lcs (1.1.2)
+    git (1.2.5)
     i18n (0.4.2)
+    jeweler (1.5.1)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
     json (1.4.6)
+    rake (0.8.7)
     redis (2.1.1)
     rspec (2.1.0)
       rspec-core (~> 2.1.0)
@@ -14,6 +20,7 @@ GEM
     rspec-expectations (2.1.0)
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.1.0)
+    system_timer (1.0)
     time_ext (0.2.6)
       activesupport (>= 2.3.0)
     yard (0.6.3)
@@ -24,8 +31,10 @@ PLATFORMS
 DEPENDENCIES
   activesupport (>= 2.3.0)
   i18n
-  json (>= 1.0.0)
-  redis (>= 2.0.0)
-  rspec (>= 2.0.1)
+  jeweler (>= 1.5.1)
+  json (>= 1.4.6)
+  redis (>= 2.1.1)
+  rspec (>= 2.1.0)
+  system_timer (>= 1.0.0)
   time_ext (>= 0.2.6)
-  yard (>= 0.6.1)
+  yard (>= 0.6.3)

README.md

@@ -2,11 +2,66 @@
 
 A Redis-backed statistics storage and querying library written in Ruby.
 
-## Early Beta
+Redistat was originally created to replace a small hacked together statistics collection solution which was MySQL-based. When I started I had a short list of requirements:
 
-Currently this is an early beta release. Readme and documentation is forthcoming.
+* Store and increment/decrement integer values (counters, etc)
+* Up to the second statistics available at all times
+* Screamingly fast
 
-For now, please check `spec/model_spec.rb` and `spec/model_helper.rb` to get started with how to use Redistat.
+Redis fits perfectly with all of these requirements. It has atomic operations like increment, and it's lightning fast, meaning if the data is structured well, the initial stats reporting call will store data in a format that's instantly retrievable just as fast.
+
+## Installation
+
+    gem install redistat
+
+## Usage
+
+The simplest way to use Redistat is through the model wrapper.
+
+    class VisitorStats
+      include Redistat::Model
+    end
+
+Before any of you Rails-purists start complaining about the model name being plural, I want to point out that it makes sense with Redistat, cause a model doesn't exactly return a specific row or object. But I'm getting ahead of myself.
+
+To store statistics we essentially tell Redistat that an event has occurred with a label of X, and statistics of Y. So let's say we want to store a page view event on the `/about` page on a site:
+
+    VisitorStats.store('/about', {:views => 1})
+
+In the above case "`/about`" is the label under which the stats are grouped, and the statistics associated with the event is simply a normal Ruby hash, except all values need to be integers, or Redis' increment calls won't work.
+
+To later retrieve statistics, we use the `fetch` method:
+
+    stats = VisitorStats.fetch('/about', 2.hour.ago, Time.now)
+    # stats => [{:views => 1}]
+    # stats.total => {:views => 1}
+
+The fetch method requires 3 arguments, a label, a start time, and an end time. Fetch returns a `Redistat::Collection` object, which is normal Ruby Array with a couple of added methods, like total shown above.
+
+For more detailed usage, please check spec files, and source code till I have time to write up a complete readme.
+
+
+## Some Technical Details
+
+To give a brief look into how Redistat works internally to store statistics, I'm going to use the examples above. The store method accepts a Ruby Hash with statistics to store. Redistat stores all statistics as hashes in Redis. It stores summaries of the stats for the specific time when it happened and all it's parent time groups (second, minute, hour, day, month, year). The default depth Redistat goes to is hour, unless the `depth` option is passed to `store` or `fetch`.
+
+In short, the above call to `store` creates the following keys in Redis:
+
+    VisitorStats//about:2010
+    VisitorStats//about:201011
+    VisitorStats//about:20101124
+    VisitorStats//about:2010112401
+
+Each of these keys in Redis are a hash, containing the sums of each statistic point reported for the time frame the key represents. In this case there's two slashes, cause the label we used was “`/about`”, and the scope (class name when used through the model wrapper) and the label are separated with a slash.
+
+When retrieving statistics for a given date range, Redistat figures out how to do the least number of calls to Redis to fetch all relevant data. For example, if you want the sum of stats from the 4th till the last of November, the full month of November would first be fetched, then the first 3 days of November would be fetched and removed from the full month stats.
+
+
+## Todo
+
+* Proper/complete readme.
+* Documentation.
+* Anything else that becomes apparent after real-world use.
 
 
 ## Note on Patches/Pull Requests

Rakefile

@@ -11,10 +11,12 @@ begin
     gem.homepage = 'http://github.com/jimeh/redistat'
     gem.authors = ['Jim Myhrberg']
     gem.add_dependency 'activesupport', '>= 2.3.0'
-    gem.add_dependency 'json', '>= 1.0.0'
-    gem.add_dependency 'redis', '>= 2.0.0'
+    gem.add_dependency 'json', '>= 1.4.6'
+    gem.add_dependency 'redis', '>= 2.1.1'
+    gem.add_dependency 'system_timer', '>= 1.0.0'
     gem.add_dependency 'time_ext', '>= 0.2.6'
-    gem.add_development_dependency 'rspec', '>= 2.0.1'
+    gem.add_development_dependency 'jeweler', '>= 1.5.1'
+    gem.add_development_dependency 'rspec', '>= 2.1.0'
     gem.add_development_dependency 'yard', '>= 0.6.1'
   end
   Jeweler::GemcutterTasks.new

VERSION

@@ -1 +1 @@
-0.0.2
+0.0.3

lib/redistat.rb

@@ -82,23 +82,3 @@ module Redistat
   module_function :connect, :connection, :flush, :redis, :redis=, :options, :threaded
 
 end
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

lib/redistat/model.rb

@@ -18,7 +18,7 @@ module Redistat
         :till  => till
       }.merge(options.merge(opts)))
     end
-    alias :find :fetch
+    alias :lookup :fetch
     
     def hashed_label(boolean = nil)
       if !boolean.nil?

spec/finder_spec.rb

@@ -101,12 +101,3 @@ describe Redistat::Finder do
   end
   
 end
-
-
-
-
-
-
-
-
-

spec/summary_spec.rb

@@ -47,26 +47,3 @@ describe Redistat::Summary do
   end
   
 end
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-