express_analytics 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 84d543b4d000f2d078e1de04c7037a363002055b
+  data.tar.gz: a72da1ba9efaae938db14708005edef4309309fb
+SHA512:
+  metadata.gz: 05d9b3d4d4fb6c90df2413c6936e16ec4990279468ebf6435d234e1ca307d575e81a404a7a2836b4766565965bec85f16f5fd61ae470fc5e6e9c0b0a684268fc
+  data.tar.gz: 25cec6f1cc4dab45c1734bf2cd85cdb94d524b9e80b2205e133f722204d593ae1819cd5c52dfc1aad1bdeb35002618a76b1061ae1e97c78213a79b598c9a304c

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Steven Talcott Smith
+
+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/Rakefile

@@ -0,0 +1,37 @@
+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    = 'ExpressAnalytics'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  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'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/assets/javascripts/express_analytics/admin.js

@@ -0,0 +1 @@
+//= require_tree .

data/app/assets/javascripts/express_analytics/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/express_analytics/admin.css

@@ -0,0 +1,5 @@
+/*
+*= require express_admin
+*= require_tree .
+*= require_self
+*/

data/app/assets/stylesheets/express_analytics/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/express_analytics/application_controller.rb

@@ -0,0 +1,4 @@
+module ExpressAnalytics
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/express_analytics/daily_statistics_controller.rb

@@ -0,0 +1,5 @@
+module ExpressAnalytics
+  class DailyStatisticsController < ExpressAdmin::StandardController
+
+  end
+end

data/app/controllers/express_analytics/log_entries_controller.rb

@@ -0,0 +1,12 @@
+module ExpressAnalytics
+  class LogEntriesController < ExpressAdmin::StandardController
+
+    skip_logging!
+
+    def ordered_scope(scope)
+      scope.order(:created_at => :desc)
+    end
+
+
+  end
+end

data/app/helpers/express_analytics/application_helper.rb

@@ -0,0 +1,4 @@
+module ExpressAnalytics
+  module ApplicationHelper
+  end
+end

data/app/models/express_analytics/daily_statistic.rb

@@ -0,0 +1,54 @@
+module ExpressAnalytics
+  class DailyStatistic < ActiveRecord::Base
+
+    def self.all_statistics
+      Dir.glob(File.join(Rails.root, 'app', 'statistics', '*.rb')).map do |statistic|
+        file_name = File.basename(statistic).gsub('.rb', '')
+        class_name = file_name.classify
+        class_name = class_name.pluralize if file_name.match(/s$/)
+        class_name.constantize
+      end
+    end
+
+    def self.calculate_all!(date=nil)
+      all_statistics.each { |stat| stat.calculate!(date) }
+    end
+
+    def self.calculate(&block)
+      define_method(calculate_method_name, &block)
+    end
+
+    def self.calculate!(date_or_date_range = nil)
+      _arrayify(date_or_date_range||Date.today).each do |date|
+        _calculate_for_date!(date)
+      end
+    end
+
+    def calculate!
+      self.value = send(self.class.calculate_method_name, calculated_for)
+    end
+
+    private
+
+      def self._arrayify(date_or_date_range)
+        if date_or_date_range.present? &&
+           date_or_date_range.kind_of?(Range)
+          date_or_date_range.to_a
+        else
+          [date_or_date_range].flatten.compact
+        end
+      end
+
+      def self._calculate_for_date!(date)
+        stat = find_by_calculated_for(date.to_date) || new(calculated_for: date.to_date)
+        stat.calculate!
+        stat.save
+        stat
+      end
+
+      def self.calculate_method_name
+        "calculate_#{self.class.to_s.underscore}!".to_sym
+      end
+
+  end
+end

data/app/models/express_analytics/log_entry.rb

@@ -0,0 +1,5 @@
+module ExpressAnalytics
+  class LogEntry < ActiveRecord::Base
+    # default_scope { order(:created_at => :desc) }
+  end
+end

data/app/views/express_analytics/daily_statistics/index.html.et

@@ -0,0 +1,8 @@
+main_region {
+  smart_table(:daily_statistics)
+}
+sidebar_region {
+  widget_box(:daily_statistic) {
+    smart_form(:daily_statistic)
+  }
+}

data/app/views/express_analytics/log_entries/index.html.et

@@ -0,0 +1,20 @@
+v_box {
+  div {
+    collection_filter :log_entries
+
+    h2(class: 'content-title') {"Log Entries"}
+  }
+
+  div {
+    smart_table(:log_entries,
+      columns: {
+        "Date" => -> (log_entry) { log_entry.created_at.to_date },
+        'Time EST' => -> (log_entry) { log_entry.created_at.strftime('%T') },
+        'User' => -> (log_entry) { helpers.link_to(helpers.truncate(log_entry.username, length: 25), log_entries_path(filter: {username: log_entry.username})) },
+        'Action' => -> (log_entry) { helpers.link_to(log_entry.action, log_entries_path(filter: {action: log_entry.action}))},
+        'When' => :created_at_in_words,
+        'Notes' => :notes
+      },
+      show_search: false)
+  }
+}

data/app/views/layouts/express_analytics/admin.html.et

@@ -0,0 +1 @@
+render(template: 'layouts/express_admin/admin')

data/app/views/layouts/express_analytics/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>ExpressAnalytics</title>
+  <%= stylesheet_link_tag    "express_analytics/application", media: "all" %>
+  <%= javascript_include_tag "express_analytics/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/initializers/default_logger.rb

@@ -0,0 +1,78 @@
+# opening ApplicationController here to add default functionality
+# to override anything just override the appropriate method here.
+class ApplicationController < ActionController::Base
+  before_action do
+    create_log_entry!
+  end
+
+  def self.skip_logging!
+    define_method(:create_log_entry!) do
+      #nothing
+    end
+  end
+
+  def create_log_entry!
+
+    geo_data = begin
+       ExpressGeoip.lookup(request.remote_ip)
+     rescue => e
+       {}
+     end
+
+    entity = entity_for_log
+
+    entry_data = {
+      action:      action_for_log,
+      username:    current_user.try(:email),
+      ip_address:  request.ip,
+      user_agent:  request.user_agent,
+      entity_type: entity.try(:class).try(:to_s),
+      entity_id:   entity.try(:id),
+      notes:       notes_for_log
+    }
+
+    ExpressAnalytics::LogEntry.create(entry_data.merge(geo_data))
+
+  end
+
+  def action_for_log
+    # ExpressAnalytics::LogEntriesController#show becomes
+    # express_analytics/log_entries_controller#show
+    # show log entry
+    is_plural = %w(list index).include?(request.params[:action])
+    object_name = self.class.to_s.demodulize.underscore.titleize
+    object_name.gsub!(/ Controller/, '')
+    object_name = is_plural ? object_name : object_name.singularize
+
+    verb = is_plural ? 'view' : request.params[:action]
+    "#{verb} #{object_name}"
+  end
+
+  def entity_for_log
+    self.respond_to?(:resource) ? resource : nil
+  end
+
+  def notes_for_log
+    request.path # override to add notes
+  end
+
+
+end
+
+
+# TODO: Move this to ExpressGeoip
+module ExpressGeoip
+  def lookup(remote_ip)
+    geo_data = {}
+    if result = ExpressGeoip::GeoipLookup.lookup(request.remote_ip)
+      if result.present?
+        geo_data.merge!(geo_country_code: result.country.name,
+                        geo_administrative_area: nil,
+                        geo_locality: result.city.name,
+                        geo_latitude: (result.location.present? ? result.location.latitude : nil),
+                        geo_longitude: (result.location.present? ? result.location.latitude : nil) )
+      end
+    end
+    geo_data
+  end
+end

data/config/initializers/mount_engine.rb

@@ -0,0 +1,3 @@
+ExpressAdmin::Routes.register do |routes|
+  routes.mount ExpressAnalytics::Engine, at: ExpressAnalytics::Engine.config.express_analytics_mount_point
+end

data/config/menu.yml

@@ -0,0 +1,11 @@
+title: 'Express Analytics'
+path: '#'
+items:
+  -
+    title: 'Log Entries'
+    path: 'express_analytics.log_entries_path'
+
+  -
+    title: 'Daily Statistics'
+    path: 'express_analytics.daily_statistics_path'
+

data/config/routes.rb

@@ -0,0 +1,4 @@
+ExpressAnalytics::Engine.routes.draw do
+  resources :log_entries, only: [:index, :show]
+  resources :daily_statistics, only: [:index, :show]
+end

data/db/migrate/20160215051456_create_express_analytics_daily_statistics.rb

@@ -0,0 +1,11 @@
+class CreateExpressAnalyticsDailyStatistics < ActiveRecord::Migration
+  def change
+    create_table :express_analytics_daily_statistics do |t|
+      t.date :calculated_for
+      t.string :type
+      t.integer :value
+
+      t.timestamps null: false
+    end
+  end
+end

data/db/migrate/20160215053321_create_express_analytics_log_entries.rb

@@ -0,0 +1,20 @@
+class CreateExpressAnalyticsLogEntries < ActiveRecord::Migration
+  def change
+    create_table :express_analytics_log_entries do |t|
+      t.string :action, limit: 64
+      t.string :username, limit: 64
+      t.string :ip_address, limit: 16
+      t.string :geo_country_code, limit: 3
+      t.string :geo_administrative_area, limit: 64
+      t.string :geo_locality, limit: 64
+      t.float :geo_latitude
+      t.float :geo_longitude
+      t.string :user_agent
+      t.string :entity_type
+      t.integer :entity_id
+      t.string :notes
+
+      t.datetime :created_at, null: false
+    end
+  end
+end

data/lib/express_analytics/engine.rb

@@ -0,0 +1,16 @@
+require 'express_admin'
+module ExpressAnalytics
+  class Engine < ::Rails::Engine
+    initializer :assets do |config|
+      engine_assets_path = File.join(File.dirname(__FILE__), '..', '..', 'app', 'assets')
+      all_assets = Dir.glob File.join(engine_assets_path, 'stylesheets', '**', '*.css*')
+      all_assets += Dir.glob File.join(engine_assets_path, 'javascripts', '**', '*.js*')
+      all_assets.each {|path| path.gsub!("#{engine_assets_path}/stylesheets/", '')}
+      all_assets.each {|path| path.gsub!("#{engine_assets_path}/javascripts/", '')}
+      Rails.application.config.assets.precompile += all_assets
+    end
+    include ::ExpressAdmin::Menu::Loader
+    ExpressAnalytics::Engine.config.express_analytics_mount_point = '/admin/analytics'
+    isolate_namespace ExpressAnalytics
+  end
+end

data/lib/express_analytics/version.rb

@@ -0,0 +1,3 @@
+module ExpressAnalytics
+  VERSION = "0.0.1"
+end

data/lib/express_analytics.rb

@@ -0,0 +1,4 @@
+require "express_analytics/engine"
+
+module ExpressAnalytics
+end

data/lib/generators/express_analytics/install/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    rails generate install Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/express_analytics/install/install_generator.rb

@@ -0,0 +1,10 @@
+class ExpressAnalytics::InstallGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+  desc "mount express_analytics engine"
+  def install
+    route "mount ExpressAnalytics::Engine, at: ExpressAnalytics::Engine.config.express_analytics_mount_point"
+    rake "express_analytics:install:migrations"
+  end
+
+end

data/lib/tasks/express_analytics_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :express_analytics do
+#   # Task goes here
+# end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application', __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/bin/setup

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../',  __FILE__)
+
+Dir.chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file:
+
+  puts "== Installing dependencies =="
+  system "gem install bundler --conservative"
+  system "bundle check || bundle install"
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?("config/database.yml")
+  #   system "cp config/database.yml.sample config/database.yml"
+  # end
+
+  puts "\n== Preparing database =="
+  system "bin/rake db:setup"
+
+  puts "\n== Removing old logs and tempfiles =="
+  system "rm -f log/*"
+  system "rm -rf tmp/cache"
+
+  puts "\n== Restarting application server =="
+  system "touch tmp/restart.txt"
+end

data/test/dummy/config/application.rb

@@ -0,0 +1,26 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "express_analytics"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Do not swallow errors in after_commit/after_rollback callbacks.
+    config.active_record.raise_in_transactional_callbacks = true
+  end
+end
+

data/test/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+#
+default: &default
+  adapter: sqlite3
+  pool: 5
+  timeout: 5000
+
+development:
+  <<: *default
+  database: db/development.sqlite3
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: *default
+  database: db/test.sqlite3
+
+production:
+  <<: *default
+  database: db/production.sqlite3

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Rails.application.initialize!