ahoy_events 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4aafe11f432c41f6ba5b0421cff4781e98930519
+  data.tar.gz: af3c865cc2af3ed452c509bbd6d4c6151271f40c
+SHA512:
+  metadata.gz: 086ea22e72dfc2f13979ae606402d711726f7228667a86b85328c8eed4bf170d693dd0e2c44ef3953e3c614c272558d88edfc406c025dfc0b741acc8a18d1f81
+  data.tar.gz: 91238c667ebbeed5eeda837251027d82ab5d258d06f20500c6ad3a58f65689df787541b51cec7145eebb66ce8e1e5adab5a597a920f3b4509fc276a0dbe70e2c

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ahoy_events.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Andrew Kane
+
+MIT License
+
+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,102 @@
+# Ahoy Events
+
+:seedling: Simple, powerful event tracking for Rails
+
+## Installation
+
+First, [add Ahoy](https://github.com/ankane/ahoy#installation).
+
+Next, add this line to your application’s Gemfile:
+
+```ruby
+gem 'ahoy_events'
+```
+
+Lastly, include the javascript file in `app/assets/javascripts/application.js` after Ahoy.
+
+```javascript
+//= require ahoy
+//= require ahoy_events
+```
+
+## How It Works
+
+Each event has a `name` and `properties`.
+
+There are three ways to track events.
+
+#### JavaScript
+
+```javascript
+ahoy.track("Viewed book", {title: "The World is Flat"});
+```
+
+#### Ruby
+
+```ruby
+ahoy.track "Viewed book", title: "Hot, Flat, and Crowded"
+```
+
+#### Native Apps
+
+Send a `POST` request to `/ahoy/events` with:
+
+- name
+- properties
+- user token (depends on your authentication framework)
+- `Ahoy-Visit` header
+
+Requests should have `Content-Type: application/json`.
+
+## Storing Events
+
+You choose how to store events.
+
+### ActiveRecord
+
+Create an `Ahoy::Event` model to store events.
+
+```sh
+rails generate ahoy_events:active_record
+```
+
+### Custom
+
+Create your own subscribers in `config/initializers/ahoy.rb`.
+
+```ruby
+class LogSubscriber
+
+  def track(name, properties, options = {})
+    data = {
+      name: name,
+      properties: properties,
+      time: options[:time].to_i,
+      visit_id: options[:visit].try(:id),
+      user_id: options[:user].try(:id),
+      ip: options[:controller].try(:request).try(:remote_ip)
+    }
+    Rails.logger.info data.to_json
+  end
+
+end
+
+# and add it
+Ahoy.subscribers << LogSubscriber.new
+```
+
+Add as many subscribers as you’d like.
+
+## TODO
+
+- Ability to track JavaScript events automatically (button clicks, etc)
+- Ability to track Rails events automatically (actions, etc)
+
+## Contributing
+
+Everyone is encouraged to help improve this project. Here are a few ways you can help:
+
+- [Report bugs](https://github.com/ankane/ahoy_events/issues)
+- Fix bugs and [submit pull requests](https://github.com/ankane/ahoy_events/pulls)
+- Write, clarify, or fix documentation
+- Suggest or add new features

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/ahoy_events.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ahoy_events/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ahoy_events"
+  spec.version       = AhoyEvents::VERSION
+  spec.authors       = ["Andrew Kane"]
+  spec.email         = ["andrew@chartkick.com"]
+  spec.summary       = %q{Simple, powerful event tracking for Rails}
+  spec.description   = %q{Simple, powerful event tracking for Rails}
+  spec.homepage      = "https://github.com/ankane/ahoy_events"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "ahoy_matey", ">= 0.1.4"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

data/app/controllers/ahoy/events_controller.rb

@@ -0,0 +1,10 @@
+module Ahoy
+  class EventsController < Ahoy::BaseController
+
+    def create
+      ahoy.track params[:name], params[:properties]
+      render json: {}
+    end
+
+  end
+end

data/app/models/ahoy/event.rb

@@ -0,0 +1,10 @@
+module Ahoy
+  class Event < ActiveRecord::Base
+    self.table_name = "ahoy_events"
+
+    belongs_to :visit
+    belongs_to :user, polymorphic: true
+
+    serialize :properties, JSON
+  end
+end

data/config/routes.rb

@@ -0,0 +1,5 @@
+Ahoy::Engine.routes.draw do
+  scope module: "ahoy" do
+    resources :events, only: [:create]
+  end
+end

data/lib/ahoy/subscribers/active_record.rb

@@ -0,0 +1,17 @@
+module Ahoy
+  module Subscribers
+    class ActiveRecord
+
+      def track(name, properties, options = {})
+        Ahoy::Event.create! do |e|
+          e.visit = options[:visit]
+          e.user = options[:user]
+          e.name = name
+          e.properties = properties
+          e.time = options[:time]
+        end
+      end
+
+    end
+  end
+end

data/lib/ahoy/tracker.rb

@@ -0,0 +1,32 @@
+module Ahoy
+  class Tracker
+
+    def initialize(options = {})
+      @controller = options[:controller]
+    end
+
+    def track(name, properties, options = {})
+      # publish to each subscriber
+      if @controller
+        options[:controller] ||= @controller
+      end
+      if @controller.respond_to?(:current_user)
+        options[:user] ||= @controller.current_user
+      end
+      if @controller.respond_to?(:current_visit)
+        options[:visit] ||= @controller.current_visit
+      end
+      options[:time] ||= Time.zone.now
+
+      subscribers = Ahoy.subscribers
+      if subscribers.any?
+        subscribers.each do |subscriber|
+          subscriber.track(name, properties, options)
+        end
+      else
+        $stderr.puts "No subscribers"
+      end
+    end
+
+  end
+end

data/lib/ahoy_events/version.rb

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

data/lib/ahoy_events.rb

@@ -0,0 +1,26 @@
+require "ahoy_events/version"
+require "ahoy_matey"
+require "ahoy/tracker"
+require "ahoy/subscribers/active_record"
+
+module AhoyEvents
+  class Engine < ::Rails::Engine
+  end
+end
+
+module Ahoy
+  mattr_accessor :subscribers
+  self.subscribers = []
+end
+
+module Ahoy
+  module Controller
+
+    protected
+
+    def ahoy
+      @ahoy ||= Ahoy::Tracker.new(controller: self)
+    end
+
+  end
+end

data/lib/generators/ahoy_events/active_record_generator.rb

@@ -0,0 +1,34 @@
+# taken from https://github.com/collectiveidea/audited/blob/master/lib/generators/audited/install_generator.rb
+require "rails/generators"
+require "rails/generators/migration"
+require "active_record"
+require "rails/generators/active_record"
+
+module AhoyEvents
+  module Generators
+    class ActiveRecordGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      # Implement the required interface for Rails::Generators::Migration.
+      def self.next_migration_number(dirname) #:nodoc:
+        next_migration_number = current_migration_number(dirname) + 1
+        if ActiveRecord::Base.timestamped_migrations
+          [Time.now.utc.strftime("%Y%m%d%H%M%S"), "%.14d" % next_migration_number].max
+        else
+          "%.3d" % next_migration_number
+        end
+      end
+
+      def copy_migration
+        migration_template "create_events.rb", "db/migrate/create_ahoy_events.rb"
+      end
+
+      def create_initializer
+        template "initializer.rb", "config/initializers/ahoy.rb"
+      end
+
+    end
+  end
+end

data/lib/generators/ahoy_events/templates/create_events.rb

@@ -0,0 +1,20 @@
+class <%= migration_class_name %> < ActiveRecord::Migration
+  def change
+    create_table :ahoy_events do |t|
+      # visit
+      t.references :visit
+
+      # user
+      t.integer :user_id
+      t.string :user_type
+
+      t.string :name
+      t.text :properties
+      t.timestamp :time
+    end
+
+    add_index :ahoy_events, [:visit_id]
+    add_index :ahoy_events, [:user_id, :user_type]
+    add_index :ahoy_events, [:time]
+  end
+end

data/lib/generators/ahoy_events/templates/initializer.rb

@@ -0,0 +1 @@
+Ahoy.subscribers << Ahoy::Subscribers::ActiveRecord.new

data/vendor/assets/javascripts/ahoy_events.js

@@ -0,0 +1,25 @@
+/*jslint browser: true, indent: 2, plusplus: true, vars: true */
+
+(function (window) {
+  "use strict";
+
+  var ahoy = window.ahoy;
+
+  ahoy.track = function (name, properties) {
+    ahoy.ready( function () {
+      var data = {name: name, properties: properties};
+      ahoy.log(data);
+
+      // ensure JSON is defined
+      if (typeof(JSON) !== "undefined") {
+        $.ajax({
+          type: "POST",
+          url: "/ahoy/events",
+          data: JSON.stringify(data),
+          contentType: "application/json; charset=utf-8",
+          dataType: "json"
+        });
+      }
+    });
+  };
+}(window));

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: ahoy_events
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrew Kane
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ahoy_matey
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.4
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple, powerful event tracking for Rails
+email:
+- andrew@chartkick.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ahoy_events.gemspec
+- app/controllers/ahoy/events_controller.rb
+- app/models/ahoy/event.rb
+- config/routes.rb
+- lib/ahoy/subscribers/active_record.rb
+- lib/ahoy/tracker.rb
+- lib/ahoy_events.rb
+- lib/ahoy_events/version.rb
+- lib/generators/ahoy_events/active_record_generator.rb
+- lib/generators/ahoy_events/templates/create_events.rb
+- lib/generators/ahoy_events/templates/initializer.rb
+- vendor/assets/javascripts/ahoy_events.js
+homepage: https://github.com/ankane/ahoy_events
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Simple, powerful event tracking for Rails
+test_files: []