minuteman 0.0.1 → 0.0.2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    minuteman (0.0.1)
+    minuteman (0.0.2)
       redis (~> 3.0.2)
 
 GEM

data/README.md

@@ -17,7 +17,7 @@ Freenode - #cuba.rb - 2012/10/30 15:20 UYT
 
 **conanbatt:** i use google analytics for the page itself, and its good, but for the webapp its really not useful
 
-**tizoc: conanbatt:** [http://amix.dk/blog/post/19714]() you can port this (if an equivalent doesn't exist already)
+**tizoc: conanbatt:** http://amix.dk/blog/post/19714 you can port this (if an equivalent doesn't exist already)
 
 **conanbatt:** the metrics link is excellent but its python and released 5 days ago lol
 
@@ -28,9 +28,9 @@ Freenode - #cuba.rb - 2012/10/30 15:20 UYT
 
 ## Inspiration
 
-* [http://blog.getspool.com/2011/11/29/fast-easy-realtime-metrics-using-redis-bitmaps/]()
-* [http://amix.dk/blog/post/19714]()
-* [http://en.wikipedia.org/wiki/Bit_array]()
+* http://blog.getspool.com/2011/11/29/fast-easy-realtime-metrics-using-redis-bitmaps/
+* http://amix.dk/blog/post/19714
+* http://en.wikipedia.org/wiki/Bit_array
 
 ## Installation
 
@@ -80,7 +80,11 @@ analytics.day("login:successful", Time.now.utc)
 analytics.hour("login:successful", Time.now.utc)
 analytics.minute("login:successful", Time.now.utc)
 
-# Check event length
+# Lists all the tracked events
+analytics.events
+#=> ["login:successful", "programming:login:ruby"]
+
+# Check event length on a given time
 today_events.length
 #=> 2
 
@@ -94,3 +98,18 @@ today_events.include?(admin.id)
 today_events.include?(User.all.map(&:id))
 #=> [true, true, false, false]
 ```
+
+## Bitwise operations
+
+You can intersect sets using AND(`&`), OR(`|`), NOT(`-`) and XOR(`^`).
+
+```ruby
+invited = analytics.month("email:invitation", Time.now.utc)
+successful_buys = analytics.month("buy:complete", Time.now.utc)
+
+successful_buys_after_invitation = invited & successful_buys
+successful_buys_after_invitation.include?(user.id)
+
+# Clean up all the operations cache
+analytics.reset_operations_cache
+```

data/lib/minuteman.rb

@@ -64,14 +64,23 @@ class Minuteman
     end
   end
 
+  # Public: List all the events given the minuteman namespace
+  #
+  def events
+    keys = @redis.keys([PREFIX, "*", "????"].join("_"))
+    keys.map { |key| key.split("_")[1] }
+  end
+
+  # Public: List all the operations executed in a given the minuteman namespace
+  #
+  def operations
+    @redis.keys([operations_cache_key_prefix, "*"].join("_"))
+  end
+
   # Public: Resets the bit operation cache keys
   #
   def reset_operations_cache
-    prefix = [
-      PREFIX, Minuteman::BitOperations::BIT_OPERATION_PREFIX
-    ].join("_")
-
-    keys = @redis.keys([prefix, "*"].join("_"))
+    keys = @redis.keys([operations_cache_key_prefix, "*"].join("_"))
     @redis.del(keys) if keys.any?
   end
 
@@ -81,4 +90,14 @@ class Minuteman
     keys = @redis.keys([PREFIX, "*"].join("_"))
     @redis.del(keys) if keys.any?
   end
+
+  private
+
+  # Private: The prefix key of all the operations
+  #
+  def operations_cache_key_prefix
+    [
+      PREFIX, Minuteman::BitOperations::BIT_OPERATION_PREFIX
+    ].join("_")
+  end
 end

data/lib/minuteman/time_events.rb

@@ -2,7 +2,7 @@ require "minuteman/time_spans"
 
 class Minuteman
   module TimeEvents
-    # Public: Helper to get all the time trakers ready
+    # Public: Helper to get all the time trackers ready
     #
     #   redis      - The Redis connection
     #   event_name - The event to be tracked

data/minuteman.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name              = "minuteman"
-  s.version           = "0.0.1"
+  s.version           = "0.0.2"
   s.summary           = "Bit Analytics"
   s.description       = "Fast and furious tracking system using Redis bitwise operations"
   s.authors           = ["elcuervo"]

data/test/unit/minuteman_test.rb

@@ -7,7 +7,7 @@ describe Minuteman do
     today = Time.now.utc
     last_month = today - (3600 * 24 * 30)
     last_week =  today - (3600 * 24 * 7)
-    last_minute = today - 61
+    last_minute = today - 120
 
     @analytics.mark("login", 12)
     @analytics.mark("login", [2, 42])
@@ -51,6 +51,27 @@ describe Minuteman do
     assert @last_month_events.include?(567)
   end
 
+  it "should list all the events" do
+    assert_equal ["login:successful", "login"], @analytics.events
+  end
+
+  it "should reset all the keys" do
+    assert_equal 2, @analytics.events.size
+
+    @analytics.reset_all
+
+    assert_equal 0, @analytics.events.size
+  end
+
+  it "should reset all bit operation keys" do
+    @week_events & @last_week_events
+    assert_equal 1, @analytics.operations.size
+
+    @analytics.reset_operations_cache
+
+    assert_equal 0, @analytics.operations.size
+  end
+
   it "should accept the AND bitwise operations" do
     and_operation = @week_events & @last_week_events
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: minuteman
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-31 00:00:00.000000000 Z
+date: 2012-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis