bit_analytics 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 !binary "U0hBMQ==":
-  metadata.gz: 8978bfb9dd2bf699d69081776c673859b7893687
-  data.tar.gz: 22dce94749ec582804d3fba2de027effa55de4b9
+  metadata.gz: 5fce88feba09c13d6a91ed272942b54b2e800eed
+  data.tar.gz: cddf8c287cce5180edd39e353da711fdde010cf9
 !binary "U0hBNTEy":
-  metadata.gz: a24a71ba813bdb1b5daf2177450a91bd7fb544d322cbb7e10dd58e82006751678cf6a74a79781606b034b61703f5672b16584c7cbd39aae612076bdbe1a4f039
-  data.tar.gz: c5fdc49e40652c6eb5529f1cb23106ce3bf1f3cf5f0557d0112157da15aaf7f1cc4da956ab09c829ed63d08692c03ff6e534686db5add1e01e25a738fdbef3df
+  metadata.gz: ba179695e5699412b98a4c9261a8d2d910accbc7c3466e980f1a0927d5dd5ae4318952670c9d3aa640bd62a1131a110bf908e58c71159f68ce7b6816342cee93
+  data.tar.gz: f79c8be49beb2ebf38df68a2d76a6dfe246fc8548d2208ae69321b0b6ed4437a804625d5a6b5f16ff58dc7116c4ef877771a0de16ab813c3b6b81f8509a0e103

data/lib/bit_analytics.rb

@@ -12,17 +12,18 @@ class BitAnalytics
     end
   end
 
-  #--- Events marking and deleting ---
   # Marks an event for hours, days, weeks and months.
-  # :param :event_name The name of the event, could be "active" or "new_signups"
-  # :param :uuid An unique id, typically user id. The id should not be huge, read Redis documentation why (bitmaps)
-  # :param :now Which date should be used as a reference point, default is `datetime.utcnow`
-  # :param :track_hourly Should hourly stats be tracked, defaults to bitanalytics.TRACK_HOURLY, but an be changed
-  # Examples:
+  #
+  # * +event_name+ - The name of the event, could be "active" or "new_signups"
+  # * +uuid+ - An unique id, typically user id. The id should not be huge, read Redis documentation why (bitmaps)
+  # * +now+ - Which date should be used as a reference point, default is `Time.now.getutc`
+  # * +track_hourly+ - Should hourly stats be tracked
+  #
+  # ==== Example
   # Mark id 1 as active
-  # mark_event('active', 1)
+  # @bit_analytics.mark_event('active', 1)
   # Mark task completed for id 252
-  # mark_event('tasks:completed', 252)
+  # @bit_analytics.mark_event('tasks:completed', 252)
   def mark_event(event_name, uuid, now: nil, track_hourly: nil)
     # Has memory applications
     track_hourly ||= false
@@ -116,11 +117,11 @@ class BitAnalytics
 
   #--- Events ---
 
-  # Extends with an obj.has_events_marked()
-  # that returns `True` if there are any events marked,
-  # otherwise `False` is returned.
+  # Extends with an obj.has_events_marked
+  # that returns truw if there are any events marked,
+  # otherwise false is returned.
 
-  # Extens also with a obj.delete()
+  # Extends also with a obj.delete
   # (useful for deleting temporary calculations).
 
   module MixinEventsMisc
@@ -132,8 +133,8 @@ class BitAnalytics
     end
   end
 
-  # Extends with an obj.get_count() that uses BITCOUNT to
-  # count all the events. Supports also __len__
+  # Extends with an obj.get_count that uses BITCOUNT to
+  # count all the events. Supports also length.
 
   module MixinCounts
     def get_count
@@ -146,8 +147,8 @@ class BitAnalytics
   end
 
   # Makes it possible to see if an uuid has been marked.
-  # Example: 
-  # user_active_today = 123 in DayEvents('active', 2012, 10, 23)
+  # ==== Example
+  # user_active_today = @bit_analytics.day_events('active', 2012, 10, 23).includes?(123)
   module MixinContains
     def includes?(uuid)
       if @redis.getbit(self.redis_key, uuid) == 1
@@ -166,8 +167,8 @@ end
 
 
 # Events for a month.
-# Example:
-# MonthEvents('active', 2012, 10)
+# ==== Example
+# @bit_analytics.month_events('active', 2012, 10)
 class MonthEvents < BitAnalytics
   include RedisConnection
   include MixinCounts
@@ -182,8 +183,8 @@ class MonthEvents < BitAnalytics
 end
 
 # Events for a week.
-# Example:
-# WeekEvents('active', 2012, 48)
+# ==== Example
+# @bit_analytics.week_events('active', 2012, 48)
 class WeekEvents < BitAnalytics
   include RedisConnection
   include MixinCounts
@@ -196,8 +197,8 @@ class WeekEvents < BitAnalytics
 end
 
 # Events for a day.
-# Example:
-# DayEvents('active', 2012, 10, 23)
+# ==== Example
+# @bit_analytics.day_events('active', 2012, 10, 23)
 class DayEvents < BitAnalytics
   include RedisConnection
   include MixinCounts
@@ -210,8 +211,8 @@ class DayEvents < BitAnalytics
 end
 
 # Events for a hour.
-# Example:
-# HourEvents('active', 2012, 10, 23, 13)
+# ==== Example
+# @bit_analytics.hour_events('active', 2012, 10, 23, 13)
 class HourEvents < BitAnalytics
   include RedisConnection
   include MixinCounts
@@ -224,22 +225,22 @@ class HourEvents < BitAnalytics
 end
 
 #--- Bit operations ---
+
 # Base class for bit operations (AND, OR, XOR).
 # Please note that each bit operation creates a new key prefixed with `bitanalytics_bitop_`.
 # These temporary keys can be deleted with `delete_temporary_bitop_keys`.
-
 # You can even nest bit operations.
-# Example:
-#     active_2_months = BitOpAnd(
-#         MonthEvents('active', last_month.year, last_month.month),
-#         MonthEvents('active', now.year, now.month)
+# ==== Example
+#     active_2_months = @bit_analytics.bit_op_and(
+#         @bit_analytics.month_events('active', last_month.year, last_month.month),
+#         @bit_analytics.month_events('active', now.year, now.month)
 #     )
-#     active_2_months = BitOpAnd(
-#         BitOpAnd(
-#             MonthEvents('active', last_month.year, last_month.month),
-#             MonthEvents('active', now.year, now.month)
+#     active_2_months = @bit_analytics.bit_op_and(
+#         @bit_analytics.bit_op_and(
+#             @bit_analytics.month_events('active', last_month.year, last_month.month),
+#             @bit_analytics.month_events('active', now.year, now.month)
 #         ),
-#         MonthEvents('active', now.year, now.month)
+#         @bit_analytics.month_events('active', now.year, now.month)
 #     )
 class BitOperation < BitAnalytics
   include MixinContains

data/lib/bit_analytics/version.rb

@@ -1,3 +1,3 @@
 class BitAnalytics
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bit_analytics
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Jure Triglav