counterman 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 54385171cb60d92865307932d22b25e205eb06a0
+  data.tar.gz: 8e67a8f47b43988d73bfcc79fa777a66ae1c7534
+SHA512:
+  metadata.gz: c83b01b5c2e9c581f8cdfbcd112af488bbb735cee79c53fa6785506eca3af975b86a0b30ce08d079886ca29103af583da87617c9f90029c3b333dc64d32e0dc4
+  data.tar.gz: 704364f2fcc14088612000bb4de09caba7ffcaac6cf86931b92be969a8c12aba940416b645f692c17fbbefc7804de28638b4d85066034298504d931ed4cbfe8e

data/.gitignore

@@ -0,0 +1 @@
+pkg

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - "1.9.3"
+  - "2.0.0"
+  - "jruby-19mode"
+services:
+  - "redis-server"

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+gemspec
+gem "rake"

data/Gemfile.lock

@@ -0,0 +1,30 @@
+PATH
+  remote: .
+  specs:
+    counterman (0.0.1)
+      redis (~> 3.0.3)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    given_core (3.0.0)
+      sorcerer (>= 0.3.7)
+    minitest (4.3.2)
+    minitest-given (3.0.0)
+      given_core (= 3.0.0)
+      minitest (> 4.3)
+    rake (0.9.2.2)
+    redis (3.0.3)
+    redis-namespace (1.2.1)
+      redis (~> 3.0.0)
+    sorcerer (1.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  counterman!
+  minitest (~> 4.3.0)
+  minitest-given (~> 3.0.0)
+  rake
+  redis-namespace (~> 1.2.1)

data/README.md

@@ -0,0 +1 @@
+

data/Rakefile

@@ -0,0 +1,14 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new("spec") do |t|
+  t.pattern = "test/**/*_test.rb"
+end
+
+Rake::TestTask.new("bench") do |t|
+  t.pattern = "test/bench/*_bench.rb"
+end
+
+task :default => [:test]
+task :all     => [:test, :bench]
+task :test    => [:spec]

data/counterman.gemspec

@@ -0,0 +1,18 @@
+Gem::Specification.new do |s|
+  s.name              = "counterman"
+  s.version           = "0.0.1"
+  s.summary           = "Counter Analytics"
+  s.description       = "Fast and furious tracking system using Redis hash operations"
+  s.authors           = ["maccman"]
+  s.licenses          = ["MIT"]
+  s.email             = ["info@eribium.org"]
+  s.homepage          = "http://github.com/maccman/counterman"
+  s.files             = `git ls-files`.split("\n")
+  s.test_files        = `git ls-files test`.split("\n")
+
+  s.add_dependency("redis", "~> 3.0.3")
+
+  s.add_development_dependency("minitest",        "~> 4.3.0")
+  s.add_development_dependency("minitest-given",  "~> 3.0.0")
+  s.add_development_dependency("redis-namespace", "~> 1.2.1")
+end

data/lib/counterman.rb

@@ -0,0 +1,130 @@
+require "redis"
+require "time"
+require "forwardable"
+require "counterman/time_events"
+
+# Public: Counterman core classs
+#
+class Counterman
+  extend Forwardable
+
+  class << self
+    attr_accessor :redis, :options
+
+    # Public: Prevents a fatal error if the options are set to silent
+    #
+    def safe(&block)
+      yield if block
+    rescue Redis::BaseError => e
+      raise e unless options[:silent]
+    end
+  end
+
+  PREFIX = "counterman"
+
+  def_delegators self, :redis, :redis=, :options, :options=, :safe
+
+  # Public: Initializes Counterman
+  #
+  #   options - An options hash to change how Counterman behaves
+  #
+  def initialize(options = {})
+
+    self.options = default_options.merge!(options)
+
+    spans = self.options.fetch(:time_spans, %w[year month week day hour minute])
+    @time_spans = generate_spans(spans)
+  end
+
+  # Public: Lazily Instantiate and memoize the Redis connection
+  #
+  def redis
+    @redis ||= case options[:redis]
+               when nil
+                 Redis.new
+               when Hash
+                 Redis.new options[:redis]
+               else
+                 options[:redis]
+               end
+  end
+
+
+  # Public: Marks an id to a given event on a given time
+  #
+  #   event_name - The event name to be searched for
+  #   ids        - The ids to be tracked
+  #
+  # Examples
+  #
+  #   analytics = Counterman.new
+  #   analytics.track("login", 1)
+  #   analytics.track("login", [2, 3, 4])
+  #
+  def track(event_name, ids, time = Time.now.utc)
+    event_time = time.kind_of?(Time) ? time : Time.parse(time.to_s)
+    time_events = TimeEvents.start(@time_spans, event_name, event_time)
+
+    track_events(time_events, Array(ids))
+  end
+
+  # Public: List all the events given the counterman namespace
+  #
+  def events
+    keys = safe { redis.keys([PREFIX, "*", "????"].join("_")) }
+    keys.map { |key| key.split("_")[1] }
+  end
+
+  # Public: Resets all the used keys
+  #
+  def reset_all
+    keys = safe { redis.keys([PREFIX, "*"].join("_")) }
+    safe { redis.del(keys) } if keys.any?
+  end
+
+  private
+
+  # Private: Generates the methods to fech data
+  #
+  #   spans: An array of timespans corresponding to a TimeSpan class
+  #
+  def generate_spans(spans)
+    spans.map do |method_name|
+      constructor = self.class.const_get(method_name.capitalize)
+
+      define_singleton_method(method_name) do |*args|
+        event_name, date = *args
+        date ||= Time.now.utc
+
+        constructor.new(event_name, date)
+      end
+
+      constructor
+    end
+  end
+
+  # Private: Default configuration options
+  #
+  def default_options
+    { cache:  true, silent: false }
+  end
+
+  # Private: Marks ids for a given time events
+  #
+  #  time_events: A set of TimeEvents
+  #  ids:         The ids to be tracked
+  #
+  def track_events(time_events, ids)
+    safe_multi do
+      time_events.each do |event|
+        ids.each { |id| safe { redis.hincrby(event.key, id, 1) } }
+      end
+    end
+  end
+
+  # Private: Executes a block within a safe connection using redis.multi
+  #
+  def safe_multi(&block)
+    safe { redis.multi(&block) }
+  end
+end

data/lib/counterman/hash_operations.rb

@@ -0,0 +1,11 @@
+class Counterman
+  module HashOperations
+    extend Forwardable
+
+    def_delegators :Counterman, :safe, :redis
+
+    def count(id)
+      safe { redis.hget(key, id).to_i }
+    end
+  end
+end

data/lib/counterman/time_events.rb

@@ -0,0 +1,18 @@
+require "counterman/time_spans"
+
+# Public: Counterman core classs
+#
+class Counterman
+  module TimeEvents
+    # Public: Helper to get all the time trackers ready
+    #
+    #   event_name - The event to be tracked
+    #   date       - A given Time object
+    #
+    def self.start(time_spans, event_name, time)
+      time_spans.map do |t|
+        t.new(event_name, time)
+      end
+    end
+  end
+end

data/lib/counterman/time_span.rb

@@ -0,0 +1,36 @@
+require "counterman/hash_operations"
+
+# Public: Counterman core classs
+#
+class Counterman
+  # Public: The timespan class. All the time span classes inherit from this one
+  #
+  class TimeSpan
+    include HashOperations
+
+    attr_reader :key
+
+    DATE_FORMAT = "%s-%02d-%02d"
+    TIME_FORMAT = "%02d:%02d"
+
+    # Public: Initializes the base TimeSpan class
+    #
+    #   event_name - The event to be tracked
+    #   date       - A given Time object
+    #
+    def initialize(event_name, date)
+      @key = build_key(event_name, time_format(date))
+    end
+
+    private
+
+    # Private: The redis key that's going to be used
+    #
+    #   event_name - The event to be tracked
+    #   date       - A given Time object
+    #
+    def build_key(event_name, date)
+      [Counterman::PREFIX, event_name, date.join("-")].join("_")
+    end
+  end
+end

data/lib/counterman/time_spans.rb

@@ -0,0 +1,7 @@
+require "counterman/time_span"
+require "counterman/time_spans/year"
+require "counterman/time_spans/month"
+require "counterman/time_spans/week"
+require "counterman/time_spans/day"
+require "counterman/time_spans/hour"
+require "counterman/time_spans/minute"

data/lib/counterman/time_spans/day.rb

@@ -0,0 +1,17 @@
+# Public: Counterman core classs
+#
+class Counterman
+  # Public: Day TimeSpan class
+  #
+  class Day < TimeSpan
+    private
+
+    # Private: The format that's going the be used for the date part of the key
+    #
+    #   date       - A given Time object
+    #
+    def time_format(date)
+      [DATE_FORMAT % [date.year, date.month, date.day]]
+    end
+  end
+end

data/lib/counterman/time_spans/hour.rb

@@ -0,0 +1,19 @@
+# Public: Counterman core classs
+#
+class Counterman
+  # Public: Hour TimeSpan class
+  #
+  class Hour < TimeSpan
+    private
+
+    # Private: The format that's going the be used for the date part of the key
+    #
+    #   date       - A given Time object
+    #
+    def time_format(date)
+      full_date = DATE_FORMAT % [date.year, date.month, date.day]
+      time = TIME_FORMAT % [date.hour, 0]
+      [full_date + " " + time]
+    end
+  end
+end

data/lib/counterman/time_spans/minute.rb

@@ -0,0 +1,19 @@
+# Public: Counterman core classs
+#
+class Counterman
+  # Public: Minute TimeSpan class
+  #
+  class Minute < TimeSpan
+    private
+
+    # Private: The format that's going the be used for the date part of the key
+    #
+    #   date       - A given Time object
+    #
+    def time_format(date)
+      full_date = DATE_FORMAT % [date.year, date.month, date.day]
+      time = TIME_FORMAT % [date.hour, date.min]
+      [full_date + " " + time]
+    end
+  end
+end

data/lib/counterman/time_spans/month.rb

@@ -0,0 +1,17 @@
+# Public: Counterman core classs
+#
+class Counterman
+  # Public: Month TimeSpan class
+  #
+  class Month < TimeSpan
+    private
+
+    # Private: The format that's going the be used for the date part of the key
+    #
+    #   date       - A given Time object
+    #
+    def time_format(date)
+      [date.year, "%02d" % date.month]
+    end
+  end
+end

data/lib/counterman/time_spans/week.rb

@@ -0,0 +1,18 @@
+# Public: Counterman core classs
+#
+class Counterman
+  # Public: Month TimeSpan class
+  #
+  class Week < TimeSpan
+    private
+
+    # Private: The format that's going the be used for the date part of the key
+    #
+    #   date       - A given Time object
+    #
+    def time_format(date)
+      week = date.strftime("%W")
+      [date.year, "W" + week]
+    end
+  end
+end

data/lib/counterman/time_spans/year.rb

@@ -0,0 +1,17 @@
+# Public: Counterman core classs
+#
+class Counterman
+  # Public: Year TimeSpan class
+  #
+  class Year < TimeSpan
+    private
+
+    # Private: The format that's going the be used for the date part of the key
+    #
+    #   date       - A given Time object
+    #
+    def time_format(date)
+      [date.year]
+    end
+  end
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: counterman
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- maccman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.3.0
+- !ruby/object:Gem::Dependency
+  name: minitest-given
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: redis-namespace
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+description: Fast and furious tracking system using Redis hash operations
+email:
+- info@eribium.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- counterman.gemspec
+- lib/counterman.rb
+- lib/counterman/hash_operations.rb
+- lib/counterman/time_events.rb
+- lib/counterman/time_span.rb
+- lib/counterman/time_spans.rb
+- lib/counterman/time_spans/day.rb
+- lib/counterman/time_spans/hour.rb
+- lib/counterman/time_spans/minute.rb
+- lib/counterman/time_spans/month.rb
+- lib/counterman/time_spans/week.rb
+- lib/counterman/time_spans/year.rb
+homepage: http://github.com/maccman/counterman
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Counter Analytics
+test_files: []