event_capture 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9dea72d63dba4d78a8c82cb2e7ebf88a0a69c1d3
+  data.tar.gz: ff1bd8a0ca07ac4ba84eb889e54f6ebaf8fc8cc2
+SHA512:
+  metadata.gz: 6cfed7b71bda8e30617531553cce44c4d9a093188c89be66ae03abdf2b444fe1fdaedf7eaddb006437fd652ae07676623cc4ef7c62545ecd2ac7f486e98f47a0
+  data.tar.gz: a5dfca3d871efda0e01ca25ac19e6c9e42b0dfe0409a111d05829f85c218daa72f203721a8be91cd4f7e32a5066bb8fb89dff1bd94a6c63c5e923d3fc9efd48e

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+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

@@ -0,0 +1,104 @@
+# Event Capture
+
+[![Build Status](https://travis-ci.org/cbitstech/event_capture.svg?branch=master)](https://travis-ci.org/cbitstech/event_capture) [![security](https://hakiri.io/github/cbitstech/event_capture/master.svg)](https://hakiri.io/github/cbitstech/event_capture/master)
+
+Server and client components for capturing events.
+
+## Dependencies/assumptions
+
+The JS client bundled with this engine assumes that jQuery is present.
+Due to the use of some methods, such as `Date.prototype.toISOString`, the JS
+client is not compatible with older browsers such as IE8.
+
+## Installation
+
+Add to your `Gemfile`
+
+```ruby
+gem 'event_capture', git: 'git@github.com:cbitstech/event_capture.git'
+```
+
+Then
+
+    bundle install
+
+Add the migrations
+
+    rake event_capture:install:migrations
+
+And run them
+
+    rake db:migrate
+
+## Usage
+
+Mount the engine in `config/routes.rb`
+
+```ruby
+mount EventCapture::Engine, at: "event_capture"
+```
+
+If you want to add controller filters, such as for authentication, you can do
+so in an initializer. E.g. in `config/initializers/event_capture.rb`
+
+```ruby
+require "event_capture/events_controller"
+
+class EventCapture::EventsController
+  before_action :authenticate_participant!
+end
+```
+
+Additionally, you can add additional parameters to an event in the controller.
+
+```ruby
+class EventCapture::EventsController
+
+  # ...
+
+  def event_params
+    {
+      payload: params[:payload],
+      emitted_at: params[:emittedAt],
+      participant_id: current_participant.id
+    }
+  end
+end
+```
+
+### JS client
+
+Load the JavaScript in your manifest
+
+    //= require event_capture
+
+Use the client to emit data and handle server responses
+
+```javascript
+var client = new EventCaptureClient('https://my.server.api');
+var response = client.log({ kind: 'myEvent', payload: { foo: 'bar' } });
+response.done(function(event) {
+  // ...
+});
+response.fail(function(xhr, status, error) {
+  // ...
+});
+```
+
+## Run Ruby specs
+
+Create the database
+
+    rake app:db:create app:db:migrate
+
+Run the specs
+
+    rake spec
+
+## Run rubocop linter
+
+    rake rubocop
+
+## Run jsHint linter
+
+    rake jshint

data/Rakefile

@@ -0,0 +1,31 @@
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load "rails/tasks/engine.rake"
+
+Bundler::GemHelper.install_tasks
+
+require "rspec/core"
+require "rspec/core/rake_task"
+
+desc "Run all specs in spec directory (excluding plugin specs)"
+RSpec::Core::RakeTask.new(spec: "app:db:test:prepare")
+
+require "jshintrb/jshinttask"
+Jshintrb::JshintTask.new :jshint do |t|
+  t.pattern = "app/assets/javascripts/**/*.js"
+  t.options = :defaults
+  t.globals = ["$"]
+end
+
+require "rubocop/rake_task"
+RuboCop::RakeTask.new
+
+task :default do
+  Rake::Task["rubocop"].invoke
+  Rake::Task["spec"].invoke
+end

data/app/assets/javascripts/event_capture/client.js

@@ -0,0 +1,23 @@
+;(function() {
+  'use strict';
+
+  function EventCaptureClient(serverUrl) {
+    this.serverUrl = serverUrl;
+  }
+
+  EventCaptureClient.prototype.log = function(options) {
+    var data = {
+      kind: options.kind,
+      payload: options.payload,
+      emittedAt: (new Date()).toISOString()
+    };
+
+    return $.ajax({
+      type: 'POST',
+      url: this.serverUrl,
+      data: data
+    });
+  };
+
+  window.EventCaptureClient = EventCaptureClient;
+})();

data/app/assets/javascripts/event_capture.js

@@ -0,0 +1 @@
+//= require event_capture/client

data/app/controllers/event_capture/application_controller.rb

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

data/app/controllers/event_capture/events_controller.rb

@@ -0,0 +1,37 @@
+module EventCapture
+  # Provide event creation.
+  class EventsController < ApplicationController
+    def create
+      @event = Event.create!(event_params)
+
+      render json: {
+        id: @event.id,
+        emittedAt: @event.emitted_at,
+        recordedAt: @event.recorded_at,
+        payload: @event.payload,
+        userId: @event.user_id,
+        userAgent: @event.user_agent,
+        source: @event.source,
+        kind: @event.kind
+      }, status: :created
+
+    rescue ActiveRecord::ActiveRecordError => invalid
+      render json: { error: model_errors(invalid.record) },
+             status: :bad_request
+    end
+
+    private
+
+    def event_params
+      {
+        kind: params[:kind],
+        payload: params[:payload],
+        emitted_at: params[:emittedAt]
+      }
+    end
+
+    def model_errors(event)
+      event.errors.full_messages.join(", ")
+    end
+  end
+end

data/app/models/event_capture/event.rb

@@ -0,0 +1,14 @@
+module EventCapture
+  # An event logged from a client.
+  class Event < ActiveRecord::Base
+    before_create :set_timestamp
+
+    serialize :payload
+
+    private
+
+    def set_timestamp
+      self.recorded_at = DateTime.now
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,4 @@
+EventCapture::Engine.routes.draw do
+  # server api
+  resources :events, only: :create
+end

data/db/migrate/20140829235335_create_event_capture_events.rb

@@ -0,0 +1,13 @@
+class CreateEventCaptureEvents < ActiveRecord::Migration
+  def change
+    create_table :event_capture_events do |t|
+      t.datetime :emitted_at
+      t.datetime :recorded_at
+      t.text :payload
+      t.string :user_id
+      t.string :user_agent
+      t.string :source
+      t.string :kind
+    end
+  end
+end

data/db/migrate/20150727145934_change_events_recorded_at_to_null.rb

@@ -0,0 +1,5 @@
+class ChangeEventsRecordedAtToNull < ActiveRecord::Migration
+  def change
+    change_column_null :event_capture_events, :recorded_at, false
+  end
+end

data/db/migrate/20150727151245_change_events_emitted_at_to_null.rb

@@ -0,0 +1,5 @@
+class ChangeEventsEmittedAtToNull < ActiveRecord::Migration
+  def change
+    change_column_null :event_capture_events, :emitted_at, false
+  end
+end

data/lib/event_capture/engine.rb

@@ -0,0 +1,12 @@
+module EventCapture
+  # Mountable engine with isolated namespace.
+  class Engine < ::Rails::Engine
+    isolate_namespace EventCapture
+
+    config.generators do |g|
+      g.test_framework :rspec
+      g.assets false
+      g.helper false
+    end
+  end
+end

data/lib/event_capture/version.rb

@@ -0,0 +1,4 @@
+# nodoc
+module EventCapture
+  VERSION = "0.1.1"
+end

data/lib/event_capture.rb

@@ -0,0 +1,5 @@
+require "event_capture/engine"
+
+# nodoc
+module EventCapture
+end

data/lib/tasks/event_capture_tasks.rake

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

data/spec/controllers/event_capture/events_controller_spec.rb

@@ -0,0 +1,60 @@
+require "spec_helper"
+
+module EventCapture
+  class FakeARError < ActiveRecord::ActiveRecordError
+    attr_reader :record
+    def initialize(record)
+      @record = record
+    end
+  end
+
+  describe EventsController, type: :controller do
+    describe "POST create" do
+      let(:event) do
+        double("event",
+               id: 1234,
+               emitted_at: DateTime.new,
+               recorded_at: DateTime.new,
+               payload: {}.to_json,
+               user_id: "abcd",
+               user_agent: "efgh",
+               source: "foobar",
+               kind: "barfoo")
+      end
+
+      before(:each) do
+        @routes = Engine.routes
+      end
+
+      context "when the event validates" do
+        before do
+          expect(Event).to receive(:create!) { event }
+        end
+
+        it "should return an error message" do
+          post :create, format: :json
+
+          assert_response 201
+          expect(json["id"]).to eq(1234)
+        end
+      end
+
+      context "when the event doesn't validate" do
+        let(:errors) { double("errors", full_messages: ["baz"]) }
+
+        before do
+          expect(Event).to receive(:create!)
+            .and_raise(FakeARError.new(event))
+          allow(event).to receive(:errors) { errors }
+        end
+
+        it "should return an error message" do
+          post :create, format: :json
+
+          assert_response 400
+          expect(json["error"]).to eq("baz")
+        end
+      end
+    end
+  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,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 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 .

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,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/spec/dummy/app/helpers/application_helper.rb

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

data/spec/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/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/application.rb

@@ -0,0 +1,29 @@
+require File.expand_path('../boot', __FILE__)
+
+# Pick the frameworks you want:
+require "active_record/railtie"
+require "action_controller/railtie"
+# require "action_mailer/railtie"
+require "action_view/railtie"
+require "sprockets/railtie"
+# require "rails/test_unit/railtie"
+
+Bundler.require(*Rails.groups)
+require "event_capture"
+
+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,85 @@
+# PostgreSQL. Versions 8.2 and up are supported.
+#
+# Install the pg driver:
+#   gem install pg
+# On OS X with Homebrew:
+#   gem install pg -- --with-pg-config=/usr/local/bin/pg_config
+# On OS X with MacPorts:
+#   gem install pg -- --with-pg-config=/opt/local/lib/postgresql84/bin/pg_config
+# On Windows:
+#   gem install pg
+#       Choose the win32 build.
+#       Install PostgreSQL and put its /bin directory on your path.
+#
+# Configure Using Gemfile
+# gem 'pg'
+#
+default: &default
+  adapter: postgresql
+  encoding: unicode
+  # For details on connection pooling, see rails configuration guide
+  # http://guides.rubyonrails.org/configuring.html#database-pooling
+  pool: 5
+
+development:
+  <<: *default
+  database: dummy_development
+
+  # The specified database role being used to connect to postgres.
+  # To create additional roles in postgres see `$ createuser --help`.
+  # When left blank, postgres will use the default role. This is
+  # the same name as the operating system user that initialized the database.
+  #username: dummy
+
+  # The password associated with the postgres role (username).
+  #password:
+
+  # Connect on a TCP socket. Omitted by default since the client uses a
+  # domain socket that doesn't need configuration. Windows does not have
+  # domain sockets, so uncomment these lines.
+  #host: localhost
+
+  # The TCP port the server listens on. Defaults to 5432.
+  # If your server runs on a different port number, change accordingly.
+  #port: 5432
+
+  # Schema search path. The server defaults to $user,public
+  #schema_search_path: myapp,sharedapp,public
+
+  # Minimum log levels, in increasing order:
+  #   debug5, debug4, debug3, debug2, debug1,
+  #   log, notice, warning, error, fatal, and panic
+  # Defaults to warning.
+  #min_messages: notice
+
+# 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: dummy_test
+
+# As with config/secrets.yml, you never want to store sensitive information,
+# like your database password, in your source code. If your source code is
+# ever seen by anyone, they now have access to your database.
+#
+# Instead, provide the password as a unix environment variable when you boot
+# the app. Read http://guides.rubyonrails.org/configuring.html#configuring-a-database
+# for a full rundown on how to provide these environment variables in a
+# production deployment.
+#
+# On Heroku and other platform providers, you may have a full connection URL
+# available as an environment variable. For example:
+#
+#   DATABASE_URL="postgres://myuser:mypass@localhost/somedatabase"
+#
+# You can use this database configuration with:
+#
+#   production:
+#     url: <%= ENV['DATABASE_URL'] %>
+#
+production:
+  <<: *default
+  database: dummy_production
+  username: dummy
+  password: <%= ENV['DUMMY_DATABASE_PASSWORD'] %>

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