lanalytics-rails 0.2.9

data/app/controllers/lanalytics/tracking_controller.rb

@@ -0,0 +1,28 @@
+require 'msgr'
+
+class Lanalytics::TrackingController < ApplicationController
+  respond_to :json
+  skip_before_action :add_lanalytics_filter
+  skip_before_action :verify_authenticity_token
+
+  WEB_EVENT_ROUTE_KEY = 'xikolo.web.exp_event.create'
+
+  def track
+    if params.key? :in_context
+      params[:in_context][:user_ip] = request.remote_ip
+    end
+
+    exp_api_stmt = Lanalytics::Model::ExpApiStatement.new_from_json(params.to_h)
+    Rails.logger.debug("On route '#{WEB_EVENT_ROUTE_KEY}'' pushing: #{exp_api_stmt.as_json}")
+    Msgr.publish(exp_api_stmt.as_json, to: WEB_EVENT_ROUTE_KEY)
+    render json: { status: "ok" }
+  end
+
+  def bulk_track
+  end
+
+  private
+  def log_params
+    params.permit("actor", "verb", "object")
+  end
+end

data/config/routes.rb

@@ -0,0 +1,17 @@
+Rails.application.routes.draw do
+  
+  mount JasmineRails::Engine => '/specs' if defined?(JasmineRails)
+  namespace :lanalytics do
+
+    #  Managing domain model
+    get 'snapshot', to: 'snapshot#snapshot'
+
+    # Tracking user event
+    post 'log', to: 'tracking#track'
+    post 'track', to: 'tracking#track'
+    # post 'bulk_track', to: 'tracking#bulk_track'
+  
+
+  end
+
+end

data/lib/lanalytics-rails.rb

@@ -0,0 +1,10 @@
+require "lanalytics/engine"
+require 'lanalytics/lanalytics_controller_filter'
+
+# Including important class from the other gem
+require 'lanalytics-model'
+
+module Lanalytics
+
+
+end

data/lib/lanalytics/engine.rb

@@ -0,0 +1,11 @@
+module Lanalytics
+  class Engine < ::Rails::Engine
+
+    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/lanalytics/lanalytics_controller_filter.rb

@@ -0,0 +1,24 @@
+require 'action_controller'
+require 'gon'
+
+module Lanalytics
+  module LanalyticsControllerFilter
+
+    # before_filter :add_lanalytics_filter
+
+    def add_lanalytics_filter
+      if current_user
+        
+        if gon.nil?
+          raise "The gem 'gon' is not included. Plz include this gem"
+        end
+
+        # Setting a meta lanaytics variable via gon, e.g. the current user so that it can be retrieved by tracking js code on the page
+        gon.lanalytics = {
+          :current_user => { id: current_user.id }
+        }
+      end
+    end
+
+  end
+end

data/lib/lanalytics/version.rb

@@ -0,0 +1,3 @@
+module Lanalytics
+  VERSION = "0.2.9"
+end

data/lib/tasks/lanalytics_tasks.rake

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

data/spec/controllers/tracking_controller_spec.rb

@@ -0,0 +1,45 @@
+require 'rails_helper'
+
+RSpec.describe Lanalytics::TrackingController, :type => :controller do
+
+  # before( =>each) do
+    # expect(Msgr).to receive(:publish).with
+    # Msgr.publish(tracking_event, to: "lanalytics.event.stream")
+  # end
+
+    
+  it "returns http success" do
+    post('track', request_data)
+    expect(response).to be_success
+  end
+
+  it "should push a message into the RabbitMQ Queue" do
+    
+    expect(Msgr).to receive(:publish) do | exp_stmt_as_hash, msgr_params |
+
+      expect(exp_stmt_as_hash).to be_a(Hash)
+      exp_stmt = Lanalytics::Model::ExpApiStatement.new_from_json(exp_stmt_as_hash)
+      expect(exp_stmt).to be_an_instance_of(Lanalytics::Model::ExpApiStatement)
+      expect(exp_stmt.user.uuid).to eq('00000001-3100-4444-9999-000000000001')
+      expect(exp_stmt.verb.type).to eq(:VIDEO_PLAY)
+      expect(exp_stmt.resource.type).to eq(:ITEM)
+      expect(exp_stmt.resource.uuid).to eq('00000003-3100-4444-9999-000000000003')
+
+      expect(msgr_params).to include(:to => 'xikolo.web.event.create')
+    end
+
+    post('track', request_data)
+    expect(response).to be_success
+  end
+
+  def request_data
+
+    return {
+      'user' => { 'uuid' => "00000001-3100-4444-9999-000000000001" },
+      'verb' => { "type" => "video_play", "verb_id" => "http://lanalytics.open.hpi.de/expapi/verbs/video-play" },
+      'resource' => { "type" => "Item", "uuid" => "00000003-3100-4444-9999-000000000003" }
+    }
+  end
+
+
+end

data/spec/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/spec/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/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,14 @@
+// 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 vendor/assets/javascripts of plugins, if any, 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/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .
+//= require lanalytics

data/spec/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 vendor/assets/stylesheets of plugins, if any, 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/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,9 @@
+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
+
+
+  include Lanalytics::LanalyticsControllerFilter
+  before_action :add_lanalytics_filter
+end

data/spec/dummy/app/controllers/welcome_controller.rb

@@ -0,0 +1,10 @@
+class WelcomeController < ApplicationController
+  def current_user
+    return {
+      id: "1234567890"
+    }
+  end
+
+  def index
+  end
+end

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

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

data/spec/dummy/app/helpers/welcome_helper.rb

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

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

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= include_gon %>
+  <%= 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/spec/dummy/app/views/welcome/index.html.erb

@@ -0,0 +1,5 @@
+
+<div data-lanalytics-resource='{"type": "SomeThing", "uuid": "1231231231231231231232"}'>
+  <p>Press to create an event</p>
+  <button data-lanalytics-event='{"verb": "DoSomething"}'>Press here to create an event</button>
+</div>

data/spec/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/spec/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/spec/dummy/bin/rake

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

data/spec/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Rails.application

data/spec/dummy/config/application.rb

@@ -0,0 +1,24 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+
+require "lanalytics-rails"
+
+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
+  end
+end
+

data/spec/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/spec/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/spec/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!

data/spec/dummy/config/environments/development.rb

@@ -0,0 +1,37 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations.
+  config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+
+  # Adds additional error checking when serving assets at runtime.
+  # Checks for improperly declared sprockets dependencies.
+  # Raises helpful error messages.
+  config.assets.raise_runtime_errors = true
+
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
+end

data/spec/dummy/config/environments/production.rb

@@ -0,0 +1,82 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # Code is not reloaded between requests.
+  config.cache_classes = true
+
+  # Eager load code on boot. This eager loads most of Rails and
+  # your application in memory, allowing both threaded web servers
+  # and those relying on copy on write to perform better.
+  # Rake tasks automatically ignore this option for performance.
+  config.eager_load = true
+
+  # Full error reports are disabled and caching is turned on.
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Enable Rack::Cache to put a simple HTTP cache in front of your application
+  # Add `rack-cache` to your Gemfile before enabling this.
+  # For large-scale production use, consider using a caching reverse proxy like nginx, varnish or squid.
+  # config.action_dispatch.rack_cache = true
+
+  # Disable Rails's static asset server (Apache or nginx will already do this).
+  config.serve_static_assets = false
+
+  # Compress JavaScripts and CSS.
+  config.assets.js_compressor = :uglifier
+  # config.assets.css_compressor = :sass
+
+  # Do not fallback to assets pipeline if a precompiled asset is missed.
+  config.assets.compile = false
+
+  # Generate digests for assets URLs.
+  config.assets.digest = true
+
+  # `config.assets.precompile` has moved to config/initializers/assets.rb
+
+  # Specifies the header that your server uses for sending files.
+  # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # Set to :debug to see everything in the log.
+  config.log_level = :info
+
+  # Prepend all log lines with the following tags.
+  # config.log_tags = [ :subdomain, :uuid ]
+
+  # Use a different logger for distributed setups.
+  # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new)
+
+  # Use a different cache store in production.
+  # config.cache_store = :mem_cache_store
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server.
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Precompile additional assets.
+  # application.js, application.css, and all non-JS/CSS in app/assets folder are already added.
+  # config.assets.precompile += %w( search.js )
+
+  # Ignore bad email addresses and do not raise email delivery errors.
+  # Set this to true and configure the email server for immediate delivery to raise delivery errors.
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation cannot be found).
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners.
+  config.active_support.deprecation = :notify
+
+  # Disable automatic flushing of the log to improve performance.
+  # config.autoflush_log = false
+
+  # Use default logging formatter so that PID and timestamp are not suppressed.
+  config.log_formatter = ::Logger::Formatter.new
+
+  # Do not dump schema after migrations.
+  config.active_record.dump_schema_after_migration = false
+end