analytics.rb

require 'redis'
require 'redis/bitops'

# #track needs user_id.

Connection.new

# Connection to a MongoDB database storing Motivoo data.
#
class Connection
  include Singleton

  # Creates a new connection.
  #
  def initialize
    # config = Motivoo.configuration
    # db = Mongo::Connection.new(config.mongo_host, config.mongo_port)[config.mongo_db]
    @db = Redis.new
  end

  # Event tracking

  # Tracks an event.
  #
  def track(category, event, cohort_category, cohort, date_override = nil)

    # ap(track: {category: category, event: event, cohort_category: cohort_category, cohort: cohort})
    # When changing the query, revise Connection#create_indices.
    day = (date_override || Date.today).strftime("%Y-%m-%d")
    totals = @db.sparse_bitmap("#{category}:#{event}:#{cohort_category}:#{cohort}")
    totals[user_id] = true

    @tracking.update({category: category, event: event, cohort_category: cohort_category, cohort: cohort}, {"$inc" => {count: 1, "daily.#{day}" => 1}}, upsert: true)
  end

  # Finds an event.
  #
  def find(category, event, cohort_category, options = {})
    # ap(find: {category: category, event: event, cohort_category: cohort_category})
    # When changing the query, revise Connection#create_indices. It's less important than Connection#track because only Report uses it.

    source = options[:source] || "count"
    @tracking.find(category: category, event: event, cohort_category: cohort_category).to_a.inject({}) { |a, r| a.merge!(r["cohort"] => r[source.to_s]) }
  end
  #
  # # Lists events for a category.
  # #
  # def events_for(category)
  #   @tracking.distinct(:event, category: category).map(&:to_sym)
  # end
  #
  # # Lists cohorts in a cohort category.
  # #
  # def cohorts_in(cohort_category)
  #   @tracking.distinct(:cohort, cohort_category: cohort_category)
  # end
  #
  # # Lists all cohort categories.
  # #
  # def cohort_categories
  #   @tracking.distinct(:cohort_category).map(&:to_sym)
  # end
  #
  # # User data
  #
  # # Finds user data given an internal user id and if it's not there, creates it.
  # # Returns a hash containing user data without the primary key itself (user id).
  # #
  # def find_or_create_user_data(user_id)
  #   # ap(find_or_create_user_data: {user_id: user_id})
  #   # NOTE: The code below is designed to avoid a race condition.
  #   q = {"_id" => BSON::ObjectId(user_id)}
  #   user_data = @user_data.find_one(q)
  #   if user_data
  #     reject_record_id(user_data)
  #   else
  #     begin
  #       # Regardless whether we or some other process did the actual insert, we return an empty hash, as the record is fresh.
  #       @user_data.insert(q)
  #       {}
  #     rescue Mongo::OperationFailure => e
  #       raise unless e.error_code == 11000 # duplicate key error index
  #       # Another process/thread has just inserted the record.
  #       {}
  #     end
  #   end
  # end
  #
  # # Finds user data by an external user id.
  # # Returns ar array consisting of a primary key (user id) and a hash containing user data or nil if record not found.
  # # TODO: Change it to find_user_data(query_hash), in this specific case find_user_data("ext_user_id" => ext_user_id) so UserData completely encapsulates the concept.
  # #
  # def find_user_data_by_ext_user_id(ext_user_id)
  #   # ap(find_user_data_by_ext_user_id: {ext_user_id: ext_user_id})
  #   if existing_record = @user_data.find_one("ext_user_id" => ext_user_id)
  #     [existing_record["_id"].to_s, reject_record_id(existing_record)]
  #   end
  # end
  #
  # # Generates a new unique user id.
  # # It inserts a new record to make it possible to update it using assign_cohort, set_user_data without worrying about the record's existence but technically this isn't necessary.
  # #
  # def generate_user_id
  #   # ap(generate_user_id: {})
  #   @user_data.insert({}).to_s
  # end
  #
  # # Inserts a user data object, making sure first_visit_at is set to the provided time.
  # #
  # def create_user_data_with_first_visit_at(first_visit_at)
  #   # ap(create_user_data_with_first_visit_at: {first_visit_at: first_visit_at})
  #   user_id = BSON::ObjectId.from_time(first_visit_at).to_s
  #   find_or_create_user_data(user_id)
  #   user_id
  # end
  #
  # # Assigns a user to a cohort.
  # #
  # def assign_cohort(user_id, cohort_category, cohort)
  #   # ap(assign_cohort: {user_id: user_id, cohort_category: cohort_category, cohort: cohort})
  #   @user_data.update({"_id" => BSON::ObjectId(user_id)}, "$set" => {"cohorts.#{cohort_category}" => cohort})
  # end
  #
  # # Sets a user-defined user data field.
  # #
  # def set_user_data(user_id, hash)
  #   # ap(set_user_data: {user_id: user_id, hash: hash})
  #   @user_data.update({"_id" => BSON::ObjectId(user_id)}, "$set" => hash)
  # end
  #
  # # Returns a user-defined user data field or nil if record not found.
  # #
  # def get_user_data(user_id, key)
  #   # ap(get_user_data: {user_id: user_id, key: key})
  #   record = @user_data.find_one({"_id" => BSON::ObjectId(user_id)}, fields: {key => 1})
  #   if record
  #     record[key]
  #   else
  #     nil
  #   end
  # end
  #
  # # Sets user data fields if the key field is nil.
  # #
  # def set_user_data_unless_exists(user_id, key, hash)
  #   doc = @user_data.find_and_modify(query: {"_id" => BSON::ObjectId(user_id), key => nil}, update: {"$set" => hash})
  #   # ap(doc: doc, user_id: user_id, key: key)
  #   # binding.pry
  #   !doc.nil?
  # end
  #
  # # Removes user data from the database.
  # #
  # def destroy_user_data(user_id)
  #   # ap(destroy_user_data: {user_id: user_id})
  #   @user_data.remove("_id" => BSON::ObjectId(user_id))
  # end
  #
  # # Time of the user record creation time.
  # #
  # def user_data_created_at(user_id)
  #   BSON::ObjectId(user_id).generation_time
  # end
  #
  #
  # # Testing
  #
  # # Removes all tables and indices.
  # #
  # def clear!
  #   @tracking.drop
  #   @user_data.drop
  #   create_indices
  # end
end