RubyGems - trueandco_analytics - Versions diffs - 0.3.0 - Mend

trueandco_analytics 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (45) hide show

checksums.yaml +7 -0
data/MIT-LICENSE +20 -0
data/README.md +152 -0
data/Rakefile +36 -0
data/app/assets/javascripts/trueandco_analytics.js +170 -0
data/app/commands/trueandco_analytics/arr_jsons_to_arr_hash.rb +20 -0
data/app/commands/trueandco_analytics/metric_c/add_list.rb +65 -0
data/app/commands/trueandco_analytics/report_c/generate.rb +31 -0
data/app/commands/trueandco_analytics/session_c/create.rb +65 -0
data/app/commands/trueandco_analytics/session_c/put_data.rb +46 -0
data/app/commands/trueandco_analytics/user_c/create_or_update_user_if_exist.rb +41 -0
data/app/controllers/trueandco_analytics/application_controller.rb +5 -0
data/app/controllers/trueandco_analytics/reciver_controller.rb +19 -0
data/app/models/trueandco_analytics/application_record.rb +5 -0
data/app/models/trueandco_analytics/metric_user.rb +8 -0
data/app/models/trueandco_analytics/metric_user_session.rb +8 -0
data/app/models/trueandco_analytics/metric_user_visit.rb +8 -0
data/app/views/trueandco_analytics/receiver/pull_user_statistic.erb +0 -0
data/app/workers/trueandco_analytics/user_session_metric_worker.rb +21 -0
data/config/routes.rb +3 -0
data/config/secrets.yml +2 -0
data/db/migrate/20170802133950_create_metric_users.rb +19 -0
data/db/migrate/20170802134044_create_metric_user_visits.rb +20 -0
data/db/migrate/20170802134059_create_metric_user_sessions.rb +27 -0
data/exe/trueandco_analytics +28 -0
data/lib/extension_string.rb +20 -0
data/lib/generators/trueandco_analytics/install_generator.rb +14 -0
data/lib/generators/trueandco_analytics/templates/trueandco_analytics.rb +37 -0
data/lib/trueandco_analytics/cli/common.rb +49 -0
data/lib/trueandco_analytics/cli/report.rb +51 -0
data/lib/trueandco_analytics/config/params.rb +81 -0
data/lib/trueandco_analytics/engine.rb +31 -0
data/lib/trueandco_analytics/helpers/trueandco_analytics_helper.rb +35 -0
data/lib/trueandco_analytics/locales/en.yml +16 -0
data/lib/trueandco_analytics/modules/info.rb +21 -0
data/lib/trueandco_analytics/reports/application_report.rb +61 -0
data/lib/trueandco_analytics/reports/details_report.rb +24 -0
data/lib/trueandco_analytics/reports/page_buy_in_date_range_report.rb +29 -0
data/lib/trueandco_analytics/services/logger.rb +24 -0
data/lib/trueandco_analytics/services/redis_connect.rb +12 -0
data/lib/trueandco_analytics/services/reports.rb +30 -0
data/lib/trueandco_analytics/services/workers.rb +14 -0
data/lib/trueandco_analytics/version.rb +3 -0
data/lib/trueandco_analytics.rb +37 -0
metadata +242 -0

checksums.yaml ADDED Viewed

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2eddcffa3c6a13247a6f2ea46e5cde544fd73fbc
+  data.tar.gz: ef377598828ff1be656935568fab8d2c1d2a0311
+SHA512:
+  metadata.gz: 1654ffbb2a22a87e2e5930cd0978284971e9ebbaf8b6bf69f45c151fdf0a12bd2a8d94f46fa87adefad7c4587deefabb249482d2b920559d0ae99bfd94888c97
+  data.tar.gz: 3e0a6bb73989e4f76d6e9bf02ebbda08e1372b537d71a72df9ac6bced523e8d81ba3313fb54c1b7a38003dc5ca7c3784b8881beaf142c02ebfbd82503bfabb5c

data/MIT-LICENSE ADDED Viewed

@@ -0,0 +1,20 @@
+Copyright 2017
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md ADDED Viewed

@@ -0,0 +1,152 @@
+# Trueandco_analytics
+**Trueandco_analytics** Gems for authentication and authorization
+## About
+Many systems analysts do not provide data about the specific user. This gem allows administrators to obtain reports on a particular user and common page statistics
+## Installation
+1. You shall have (redis, sidekiq, mysql) on your server.
+2. You have to include gems in your Gemfile:
+  ```ruby
+  gem 'trueandco_analytics'
+  ```
+3. And then to start
+  ```ruby
+  bundle
+  ```
+4. To start the initialiser, for detailed configured gem
+   ```ruby
+   rails g trueandco_analytics:install
+   ```
+   After
+   ```ruby
+      rake db:migrate
+   ```
+   or
+   ```ruby
+     rails db:migrate
+   ```
+   That create 3 tables:
+   `metric_users`, `metric_user_sessions`, `metric_user_visits`
+   `metric_users`         Info about users
+   `metric_user_sessions` Info about user sesssions
+   `metric_user_visits`   Pages which were visited by the user within the session
+   Add assetcs
+   ```js
+     //= require trueandco_analytics
+   ```
+   Add helper ` track_user_behavior` to head for tracking
+   ```html
+       <!DOCTYPE html>
+       <html>
+       <head>
+         <title>Example</title>
+         <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+         <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+         <%= csrf_meta_tags %>
+         <%= track_user_behavior %>
+       </head>
+   ```
+   Add the mointing address
+   ```ruby
+     mount TrueandcoAnalytics::Engine, at: "/metric"
+   ```
+   And you need to listen queue `user_metric`
+   ```ruby
+     bundle exec sidekiq  --queue=user_metric
+   ```
+   Need set in app
+   ```ruby
+     config.eager_load = true
+   ```
+   The application must have a route `root`
+   For use of the console mode. it is necessary to specify the current database.
+   ```ruby
+     config.db_connect = {
+       database: 'development_db_name',
+       username: 'ivan',
+       password: '3443555',
+       host:     '127.0.0.1',
+       port: 3306
+     }
+   ```
+   It is possible to include the logging mode, having specified the name
+   ```ruby
+     config.log = 'name of log'
+   ```
+## Usage
+    Now we can take data in a convenient format.
+    It is necessary to specify the report and a format of data
+    So far only arr, csv is available
+    For this we use the service object `::TrueandcoAnalytics::Reports`
+    Available formats
+    ```ruby
+     ::TrueandcoAnalytics::Reports.available_formats
+    ```
+    List of reports
+    ```ruby
+     ::TrueandcoAnalytics::Reports.available_reports
+    ```
+    Get report obj with method report_name and data
+    ```ruby
+     ::TrueandcoAnalytics::Reports.get_report_obj('page_buy_in_date_range_report', 'csv')
+     ::TrueandcoAnalytics::Reports.get_report_obj('page_buy_in_date_range_report', 'csv', datetme_start, datetime_end)
+    ```
+    ### Usage console mod
+    bundle exec trueandco_analytics -h
+## Settings
+  * Time survey Analytics seconds
+  `config.time_survey = 15`
+  * Specify the method available in the ApplicationController to the receiving user object. Containing id, email.
+  `config.user_method = 'current_user'`
+  * Specify css the selector class for the button purchase
+  `config.buy_selector_class = 'buy'`
+  * Specify the database where redis will store the statistics for the session user
+  ```ruby
+    config.connect_redis = {
+        #url: "redis://your_host:6379",
+        #redis_password: '',
+        redis_db: 1
+    }
+  ```
+  * Specify Sidekiq config
+  `config.sidekiq_configure_client_url      = 'redis://localhost:6379/1'`
+  `config.sidekiq_configure_server_url      = 'redis://localhost:6379/1'`
+  `config.sidekiq_configure_namespace       = 'metric'`
+## Ruby version tested
+**2.2.4**
+## Contributing
+Bug reports and pull requests are welcome on GitHub at https://github.com/Rattt/trueandco_analytics. This project is intended to be a safe,
+welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/Rakefile ADDED Viewed

@@ -0,0 +1,36 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+require 'rdoc/task'
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'TrueandcoAnalytics'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+load 'rails/tasks/statistics.rake'
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+task default: :test

data/app/assets/javascripts/trueandco_analytics.js ADDED Viewed

@@ -0,0 +1,170 @@
+var userLog = (function(){
+    //
+    // Private variables
+    //
+    var defaults = {
+            // Available functionality
+            clickCount: true,
+            clickDetails: true,
+            // Action Item
+            actionItem: {
+                processOnAction: false,
+                selector: '',
+                event: ''
+            },
+            processTime: 15,
+            processData: function(results, statistics_url){
+                console.log(results);
+            },
+        },
+        // End results, what is shown to the user
+        results = {
+            userReferrer: '',
+            time: {
+                totalTime: 0,
+                timeOnPage: 0,
+                timestamp: 0
+            },
+            clicks: {
+                clickCount:0,
+                clickDetails: []
+            },
+        },
+        support = !!document.querySelector && !!document.addEventListener,
+        data_receiver = '',
+        app_token = '',
+        settings;
+    // Helper Functions
+    var helperActions = {
+        userReferrer: function (){
+            result = document.referrer;
+            results.userReferrer = 10;
+        },
+        /**
+         * Detect the X,Y coordinates of the mouse movement
+         * @private
+         */
+        mouseMovement: function(){
+            document.addEventListener('mousemove', function(){
+                results.mouseMovements.push({
+                    timestamp: Date.now(),
+                    x: event.pageX,
+                    y: event.pageY
+                });
+            });
+        },
+    }
+    /**
+     * Merge defaults with options
+     * @private
+     * @param {Object} default settings
+     * @param {Object} user options
+     * @returns {Object} merged object
+     */
+    function getSettings(defaults, options){
+        var option;
+        for(option in options){
+            if(options.hasOwnProperty(option)){
+                defaults[option] = options[option];
+            }
+        }
+        return defaults;
+    }
+    /**
+     * Initialize the event listeners
+     * @public
+     * @param {Object} user options
+     */
+    function init(statistics_url, token, options){
+        if(!support) return;
+        data_receiver = statistics_url;
+        app_token = token;
+        // Extend default options
+        if (options && typeof options === "object") {
+            settings = getSettings(defaults, options);
+        }
+        document.addEventListener('DOMContentLoaded', function() {
+            // Countdown Timer
+            window.setInterval(function(){
+                if(document['visibilityState'] === 'visible'){
+                    results.time.timeOnPage++;
+                }
+                results.time.totalTime++;
+                // Check if we need to process results
+                if(settings.processTime > 0 && results.time.totalTime % settings.processTime === 0){
+                    processResults();
+                }
+            },1000);
+            results.time.timestamp = (function() {
+                return Math.round((+new Date())/1000);
+            })();
+            // Click registration, increment click counter and save click time+position
+            if(settings.clickCount || settings.clickDetails){
+                document.addEventListener('mouseup', function(){
+                    if(settings.clickCount){
+                        results.clicks.clickCount++;
+                    }
+                    if(settings.clickDetails){
+                        results.clicks.clickDetails.push({
+                            timestamp: Date.now(),
+                            node: event.target.outerHTML,
+                            x: event.pageX,
+                            y: event.pageY
+                        });
+                    }
+                });
+            }
+            // Mouse movements
+            if(settings.mouseMovement){
+                helperActions.mouseMovement();
+            }
+            // referral
+            if(settings.userReferrer){
+                helperActions.userReferrer();
+            }
+            // Event Listener to porcess
+            if(settings.actionItem.processOnAction){
+                var node = document.querySelector(settings.actionItem.selector);
+                if(!!!node) throw new Error('Selector was not found.');
+                node.addEventListener(settings.actionItem.event, function(){
+                    return processResults();
+                })
+            }
+        });
+    }
+    /**
+     * Calls provided function with results as parameter
+     * @public
+     */
+    function processResults(){
+        if(settings.hasOwnProperty('processData')){
+            var result = settings.processData.call(undefined, results, data_receiver, app_token);
+            results.clicks.clickDetails = []
+            return result;
+        }
+        return false;
+    }
+    // Module pattern, only expose necessary methods
+    return {
+        init: init,
+        processResults: processResults,
+    };
+})();

data/app/commands/trueandco_analytics/arr_jsons_to_arr_hash.rb ADDED Viewed

@@ -0,0 +1,20 @@
+module TrueandcoAnalytics
+  class ArrJsonsToArrHash
+    def initialize(arr_json)
+      @arr_json = arr_json
+    end
+    def execute
+      result = []
+      @arr_json.each do |json|
+        result << JSON.parse(json)
+      end
+      result
+    end
+    private
+    attr_reader :arr_json
+  end
+end

data/app/commands/trueandco_analytics/metric_c/add_list.rb ADDED Viewed

@@ -0,0 +1,65 @@
+module TrueandcoAnalytics
+  module MetricC
+    class AddList
+      def initialize(metric_user, session, user_session_data)
+        if metric_user.nil? || session.nil? || user_session_data.nil?
+          raise ArgumentError.new("#{self.to_s} metric_user=#{metric_user}
+            session=#{session} user_session_data=#{user_session_data}")
+        end
+        @metric_user    = metric_user
+        @session        = session
+        @user_session_data = user_session_data
+      end
+      def execute
+        uniq_pages = info_uniq_page
+        return if uniq_pages.nil?
+        uniq_pages.each do |page|
+          data = {
+            metric_user: metric_user,
+            metric_user_session: session,
+            page_path:  page['page_path'],
+            user_action: page['clicks']['clickDetails'].to_json,
+            time_s: page['time']['timeOnPage'],
+            is_buy: page['clicks']['clickDetails'].length > 0
+          }
+          MetricUserVisit.create(data)
+        end
+      end
+      private
+      attr_reader :metric_user, :session, :user_session_data
+      def info_uniq_page
+        length = user_session_data.length
+        return user_session_data if length < 2
+        results = []
+        page = user_session_data[0]['page_path']
+        clickDetails = []
+        index = 0
+        while index < length - 1
+          unless user_session_data[index]['clicks']['clickDetails'].empty?
+            clickDetails = user_session_data[index]['clicks']['clickDetails']
+          end
+          index += 1
+          unless page  == user_session_data[index]['page_path']
+            data = user_session_data[index - 1]
+            data['clicks']['clickDetails'] = clickDetails
+            results << data
+            page = user_session_data[index]['page_path']
+            clickDetails = []
+          end
+        end
+        data = user_session_data[index]
+        unless data['clicks']['clickDetails'].empty?
+          clickDetails = data['clicks']['clickDetails']
+        end
+        data['clicks']['clickDetails'] = clickDetails
+        results << data
+        results
+      end
+    end
+  end
+end