trueandco_analytics 0.3.0

data/lib/trueandco_analytics/cli/common.rb

@@ -0,0 +1,49 @@
+module TrueandcoAnalytics
+  module Cli
+    class Common
+      include TrueandcoAnalytics::Modules::Info
+
+      def initialize(args)
+        @args = args
+      end
+
+      def execute
+        if args.empty?
+          info(trans('help.need_help'))
+          exit
+        end
+        unless args[0] =~ /^-/
+          TrueandcoAnalytics::Cli::Report.new(args).execute
+          exit
+        end
+        OptionParser.new do |opts|
+          opts.banner = trans('help.need_help')
+
+          opts.on_tail('-h', '--help', 'Help') do
+            info(opts)
+            info(trans('help.description').gsub('\n', "\n"))
+          end
+          opts.on_tail('-v', '--version', 'Version of gem') do
+            info(trans('help.gem_version'))
+            info(TrueandcoAnalytics::VERSION)
+          end
+          opts.on_tail('-r', '--reports', 'List names of reports') do
+            info(TrueandcoAnalytics::Reports.available_reports)
+          end
+          opts.on_tail('-f', '--formats', 'List available formats of reports') do
+            info(TrueandcoAnalytics::Reports.available_formats)
+          end
+          opts.parse!
+        end
+      end
+
+      private
+
+      attr_reader :args
+
+      def trans(value)
+        I18n.t "trueandco_analytics.#{value}"
+      end
+    end
+  end
+end

data/lib/trueandco_analytics/cli/report.rb

@@ -0,0 +1,51 @@
+module TrueandcoAnalytics
+  module Cli
+    class Report
+      include TrueandcoAnalytics::Modules::Info
+
+      def initialize(args)
+        @args = args
+        @report_args = (Struct.new(:name, :format, :datetime_start, :datetime_end, :path)).new
+        @report_args.name = args[0]
+      end
+
+      def execute
+        need_generate_report = true
+        OptionParser.new do |opts|
+          opts.banner = trans('help.need_help')
+          # Info
+          opts.on_tail("-h", "--help", trans('help.about_help')) do
+            need_generate_report = false
+            info(opts)
+            info(trans('help.description').gsub('\n', "\n"))
+          end
+          # Args
+          opts.on("-fValue", "--format=Value", 'format') do |value|
+            @report_args.format = value
+          end
+          opts.on("-sValue", "--datetime_start=Value", 'datetime_strat') do |value|
+            @report_args.datetime_strat = value
+          end
+          opts.on("-eValue", "--datetime_end=Value", 'datetime_end') do |value|
+            @report_args.datetime_end = value
+          end
+          opts.on("-pValue", "--path=Value", 'path') do |value|
+            @report_args.path = value
+          end
+          opts.parse!
+        end
+        if need_generate_report
+          TrueandcoAnalytics::ReportC::Generate.new(report_args.to_h).execute
+        end
+      end
+
+      private
+
+      attr_reader :report_args, :args
+
+      def trans(value)
+        I18n.t "trueandco_analytics.#{value}"
+      end
+    end
+  end
+end

data/lib/trueandco_analytics/config/params.rb

@@ -0,0 +1,81 @@
+module TrueandcoAnalytics
+  module Config
+    module Params
+
+      @time_survey                       = 15
+      @time_survey_check                 = false
+      if Object.const_defined?('Rails')
+        @time_dead_session               = Rails.env.development? ? 30 : 600
+      end
+      @user_method_check                 = false
+      @buy_selector_class                = 'buy'
+      @buy_selector_class_check          = false
+      @connect_redis                     = { redis_db: 1, }
+      @connect_redis_check               = false
+      @sidekiq_configure_client_url      = 'redis://localhost:6379/1'
+      @sidekiq_configure_client_check    = false
+      @sidekiq_configure_server_url      = 'redis://localhost:6379/1'
+      @sidekiq_configure_server_check    = false
+      @sidekiq_configure_namespace       = 'metric'
+      @sidekiq_configure_namespace_check = false
+      @log                               = nil
+      @log_check                         = false
+      @connect_db                        = nil
+      @connect_db_check                  = false
+
+      class << self
+
+        def set_params
+          yield self  if block_given?
+        end
+
+        def self.attr_writer_only_once(*args)
+          args.each do |arg|
+            self.send(:define_method, "#{arg}=".intern) do |value|
+              return if value.nil?
+              return if instance_variable_get("@#{arg}_check")
+              return unless value.present?
+              instance_variable_set("@#{arg}", value)
+              instance_variable_set("@#{arg}_check", true)
+            end
+          end
+        end
+
+        attr_reader :time_survey, :time_dead_session, :buy_selector_class,
+          :sidekiq_configure_client_url, :sidekiq_configure_server_url, :sidekiq_configure_namespace,
+          :connect_db, :connect_redis
+        
+        attr_writer_only_once :time_survey, :user_method,
+          :sidekiq_configure_client_url, :sidekiq_configure_server_url, :sidekiq_configure_namespace,
+          :connect_db,:connect_redis
+
+        def buy_selector_class=(value)
+          return if value.nil?
+          @buy_selector_class = value.delete('.') unless @buy_selector_class_check
+          @buy_selector_class_check = true
+        end
+
+        def user_method
+          return OpenStruct.new(id: nil, name: '', email: '') unless @user_method_check
+          ::ApplicationController.new.public_send(@user_method)
+        end
+
+        def log
+          return unless @log_check
+          @log
+        end
+
+        def log=(value)
+          return if value.nil?
+          @log = value.chomp('.log') unless @log_check
+          @log_check = true
+        end
+
+        def log_obj
+          return unless @log_check
+          TrueandcoAnalytics::Logger.instance
+        end
+      end
+    end
+  end
+end

data/lib/trueandco_analytics/engine.rb

@@ -0,0 +1,31 @@
+require "trueandco_analytics/helpers/trueandco_analytics_helper"
+
+module TrueandcoAnalytics
+
+  class Engine < ::Rails::Engine
+    isolate_namespace TrueandcoAnalytics
+
+    initializer :append_migrations do |app|
+      unless app.root.to_s.match root.to_s
+        config.paths["db/migrate"].expanded.each do |expanded_path|
+          app.config.paths["db/migrate"] << expanded_path
+        end
+      end
+    end
+
+    initializer :action_controller do
+      ::TrueandcoAnalytics::Workers.init
+      ActiveSupport.on_load(:action_controller) do
+        self.try(:helper, ::TrueandcoAnalytics::TrueandcoAnalyticsHelper) ||
+            self.try(:include, ::TrueandcoAnalytics::TrueandcoAnalyticsHelper)
+      end
+    end
+
+    config.generators do |g|
+      g.test_framework :rspec, :fixture => false
+      g.fixture_replacement :factory_girl, :dir => 'spec/factories'
+      g.assets false
+      g.helper false
+    end
+  end
+end

data/lib/trueandco_analytics/helpers/trueandco_analytics_helper.rb

@@ -0,0 +1,35 @@
+module TrueandcoAnalytics
+  module TrueandcoAnalyticsHelper
+
+    def track_user_behavior
+      pull_user_statistic_path = Engine.routes.url_helpers.receiver_pull_user_statistic_path
+      return unless @user_behavior.nil?
+      @user_behavior = 1
+      js_string = <<-USER_BEHAVIOR_TRACK
+        var statistics_url = "#{root_url.chomp('/')}#{pull_user_statistic_path}",
+            app_token = "#{form_authenticity_token}";
+
+        userLog.init(statistics_url, app_token, {
+
+            clickCount: true,
+                clickDetails: true,
+                actionItem: {
+                    processOnAction: true,
+                    selector: '.buy',
+                    event: 'click'
+            },
+            processTime: #{Config::Params.time_survey},
+                processData: function(results, statistics_url, app_token) {
+                var xhr = new XMLHttpRequest();
+                xhr.open('POST', statistics_url, true);
+                xhr.setRequestHeader('X-CSRF-Token', app_token);
+                xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
+                var data = "user_metric=" + JSON.stringify(results);
+                xhr.send(data);
+            },
+        });
+      USER_BEHAVIOR_TRACK
+      javascript_tag js_string, defer: 'defer'
+    end
+  end
+end

data/lib/trueandco_analytics/locales/en.yml

@@ -0,0 +1,16 @@
+en:
+  trueandco_analytics:
+    help:
+        need_help:   '(-h or --help shows available options for use)'
+        description: 'For generate reports use:\nbundle exec trueandco_analytics report_name --datetime_start=datetime --datetime_end=datetime --format=format --path=path_destination'
+        gem_version: 'Gem version is:'
+
+    error:
+         argument:
+                 unknown_format: Unknown format of reports
+                 unknown_report: Report with the specified name was not found
+         log: 'An error occurred in the analytics'
+
+    result:
+         done: 'The report is created and located: %{path}'
+         data: 'Its Done'

data/lib/trueandco_analytics/modules/info.rb

@@ -0,0 +1,21 @@
+module TrueandcoAnalytics::Modules
+
+  module Info
+
+    def error_message(message)
+      $stderr.puts message.colorize(:red)
+      logger = Config::Params.log_obj
+      return if logger.nil?
+      logger.fatal { I18n.t('trueandco_analytics.error.log') + "\n" + message }
+    end
+
+    def info(message)
+      puts message.to_s.colorize(:blue)
+    end
+
+    def result(message)
+      puts I18n.t('trueandco_analytics.result.data').colorize(:green)
+      puts message.colorize(:green)
+    end
+  end
+end

data/lib/trueandco_analytics/reports/application_report.rb

@@ -0,0 +1,61 @@
+module TrueandcoAnalytics
+  class ApplicationReport
+
+    AVAILABLE_FORMATS = %w(csv arr).freeze
+    DEFAULT_FORMAT = AVAILABLE_FORMATS[0]
+
+    def initialize(format = nil, date_start = nil, date_end = nil)
+      format ||= DEFAULT_FORMAT
+      @format = format
+      unless format_available?
+        raise ArgumentError, I18n.t("trueandco_analytics.error.argument.unknown_format")
+      end
+      date_start = date_start.kind_of?(DateTime) ? date_start : DateTime.new(1970,1,1,0,0,0)
+      date_end   = date_end.kind_of?(DateTime) ? date_end : DateTime.now
+      date_end   += 1.days
+      arr = source_data(date_start, date_end)
+
+      @data = send("to_#{format}", arr)
+    end
+
+    def self.formats
+      AVAILABLE_FORMATS
+    end
+
+    def self.reports
+      self.subclasses.map{ |name| name.to_s.sub(/TrueandcoAnalytics::/,'').underscore }
+    end
+
+    def self.subclasses
+      self.descendants
+    end
+
+    def self.descendants
+      ObjectSpace.each_object(Class).select { |klass| klass < self }
+    end
+
+    private
+
+    attr_reader :format, :data, :report_name
+
+    def format_available?
+      AVAILABLE_FORMATS.include?(format)
+    end
+
+    def to_csv(arr)
+      return unless arr.kind_of?(Array)
+      return if arr.empty?
+      ::CSV.generate do |csv|
+        csv << arr.first.keys
+        arr.each do |hash|
+          csv << hash.values
+        end
+      end
+    end
+
+    def to_arr(arr)
+      return unless arr.kind_of?(Array)
+      arr
+    end
+  end
+end

data/lib/trueandco_analytics/reports/details_report.rb

@@ -0,0 +1,24 @@
+module TrueandcoAnalytics
+  class DetailsReport < ApplicationReport
+
+    attr_reader :data
+
+    def report_name
+      "details-report-#{DateTime.now.strftime("%Y.%m.%d %H:%M")}.#{@format}"
+    end
+
+    private
+
+    def source_data(date_start, date_end)
+      sql = <<-SQL_TEXT
+          SELECT DATE(metric_user_sessions.session_start) as 'date', metric_users.*, metric_user_sessions.*, metric_user_visits.*
+          FROM metric_user_visits 
+          LEFT JOIN metric_users ON metric_user_visits.metric_user_id = metric_users.id
+          LEFT JOIN metric_user_sessions ON metric_user_visits.metric_user_session_id = metric_user_sessions.id
+          WHERE DATE(metric_user_sessions.session_start) BETWEEN CAST('#{date_start}' AS DATE) AND CAST('#{date_end}' AS DATE)
+          ORDER BY DATE(metric_user_sessions.session_start) DESC, metric_users.id, metric_user_sessions.session_start ASC
+      SQL_TEXT
+      ActiveRecord::Base.connection.exec_query(sql).to_a
+    end
+  end
+end

data/lib/trueandco_analytics/reports/page_buy_in_date_range_report.rb

@@ -0,0 +1,29 @@
+module TrueandcoAnalytics
+  class PageBuyInDateRangeReport < ApplicationReport
+
+    attr_reader :data
+
+    def report_name
+      "page-buy-report-#{DateTime.now.strftime("%Y.%m.%d %H:%M")}.#{@format}"
+    end
+
+    private
+
+    def source_data(date_start, date_end)
+      sql = <<-SQL_TEXT
+          SELECT metric_user_visits.page_path, DATE(metric_user_sessions.session_start) as session_start, COUNT(metric_user_visits.metric_user_id) as buy_visit, all_visit.all_visit, group_concat(metric_user_visits.metric_user_id) as user_ids
+          FROM metric_user_visits 
+          LEFT JOIN metric_user_sessions ON metric_user_visits.metric_user_session_id = metric_user_sessions.id
+          LEFT JOIN (SELECT metric_user_visits.page_path, DATE(metric_user_sessions.session_start) as session_start, COUNT(metric_user_visits.metric_user_id) as all_visit
+                     FROM  metric_user_visits
+                     LEFT JOIN metric_user_sessions ON metric_user_visits.metric_user_session_id = metric_user_sessions.id
+                     GROUP BY page_path, DATE(metric_user_sessions.session_start)
+                    ) AS all_visit ON metric_user_visits.page_path = all_visit.page_path AND DATE(metric_user_sessions.session_start) = all_visit.session_start
+          WHERE metric_user_visits.is_buy = true AND
+          DATE(metric_user_sessions.session_start) BETWEEN CAST('#{date_start}' AS DATE) AND CAST('#{date_end}' AS DATE)
+          GROUP BY page_path, DATE(metric_user_sessions.session_start)
+      SQL_TEXT
+      ActiveRecord::Base.connection.exec_query(sql).to_a
+    end
+  end
+end

data/lib/trueandco_analytics/services/logger.rb

@@ -0,0 +1,24 @@
+module TrueandcoAnalytics
+
+  class Logger < Logger
+    include Singleton
+
+    def initialize
+      super(Rails.root.join("log/#{Config::Params.log}.log"))
+      self.formatter = formatter
+      self
+    end
+
+    def formatter
+      Proc.new { |severity, time, progname, msg|
+        formatted_severity = sprintf("%-5s", severity.to_s)
+        formatted_time = time.strftime("%Y-%m-%d %H:%M:%S")
+        "[#{formatted_severity} #{formatted_time} #{$$}] #{msg.to_s.strip}\n"
+      }
+    end
+
+    class << self
+      delegate :error, :debug, :fatal, :info, :warn, :add, :log, to: :instance
+    end
+  end
+end

data/lib/trueandco_analytics/services/redis_connect.rb

@@ -0,0 +1,12 @@
+module TrueandcoAnalytics
+  module RedisConnect
+    redis_conect = Config::Params.connect_redis
+    
+    @redis = Redis.new(redis_conect.merge({ driver: :hiredis }))
+    class << self
+      def get
+        @redis
+      end
+    end
+  end
+end