eventy 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fbecb855729ed71d610ed6008917ff66e48f149d
-  data.tar.gz: fbe7ff286d9dd15cae0dfaf74bac476fadbd01c9
+  metadata.gz: 24bee34870e8b88e3d749d1f01f542fb46fe6332
+  data.tar.gz: 0ac34b2a49c5a5f994f873d077ff059a942965d7
 SHA512:
-  metadata.gz: f78694465489b75c85357632f5114020d1ea2e2a610fe300c0e796839062694f9d89c5c340084d9dbbcc8bbeb0522160c3b8a29d0e29da1bab74865ad4ddcb08
-  data.tar.gz: 519fd8a37f1ff8fe8754cf8f6f6a47d7c2a30f420ec7fffa9b6bd63fea0f6865e41186ee12a89ed8eaf649dc60e7cf83d2a51af57833955ef8e6392433d9351c
+  metadata.gz: 8a7024380bec5f673db8f8113b0818c0010339dfc3c3c65a8fc026fce0da694a352a6b473fb25b2a2eb9006104d0ee4f527911c2c646d642338eef6a0bca71ca
+  data.tar.gz: 7ca796841268780e8832ae0656ced444b655817780c13a3c6f36c6be8e2553f43acd9a0e455e7f06dbc0a06a63059cf03b4abc0ff944f150f90b53240c5897c5

data/README.md

@@ -1,6 +1,8 @@
 # Eventy
 
-TODO: Write a gem description
+Super simple event tracking in Rails. Record arbitrary events, associate them with a user or account, and record any associated properties.
+
+Currently, Eventy ships with two backends: `active_record`, and `active_record_hstore`.
 
 ## Installation
 
@@ -12,13 +14,28 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
+Next, run the Rails generator to create a migration for your desired backend (either `active_record` or `active_record_hstore`):
+
+    $ bundle exec rails generate eventy:active_record
+
+You may need to modify this migration. Then run the migration:
+
+    $ bundle exec rake db:migrate
 
-    $ gem install eventy
+Finally, configure eventy to use your preferred backend:
+
+    # config/initializers/eventy.rb
+    Eventy.configure(backend: :active_record)
 
 ## Usage
 
-TODO: Write usage instructions here
+Record events by calling `Eventy.record(event_name, unique_identifier, attributes)`:
+
+    Eventy.record('account:signup', session[:unique_id], { referrer: 'Facebook' })
+    Eventy.record('response:create', current_account.unique_id)
+    Eventy.record('response:create', current_account.unique_id)
+
+You can name your events however you like, associate them with whatever unique identifier you like, and assign them arbitrary properties. Simple.
 
 ## Contributing
 

data/lib/eventy.rb

@@ -6,6 +6,8 @@ module Eventy
     case options[:backend].to_sym
     when :active_record
       require "eventy/backends/active_record"
+    when :active_record_hstore
+      require "eventy/backends/active_record_hstore"
     end
   end
 

data/lib/eventy/backends/active_record_hstore.rb

@@ -0,0 +1,11 @@
+module Eventy
+  class Event < ::ActiveRecord::Base
+    include AbstractEvent
+
+    store_accessor :properties
+
+    def self.record(event_name, identity, properties = {})
+      create(name: event_name, identity: identity, properties: properties)
+    end
+  end
+end

data/lib/eventy/version.rb

@@ -1,3 +1,3 @@
 module Eventy
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/generators/eventy/active_record_hstore_generator.rb

@@ -0,0 +1,15 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class Eventy::ActiveRecordHstoreGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+  source_root File.expand_path('../templates', __FILE__)
+
+  def self.next_migration_number(path)
+    Time.now.utc.strftime("%Y%m%d%H%M%S")
+  end
+
+  def copy_migrations
+    migration_template 'setup_eventy_hstore.rb', "db/migrate/setup_eventy.rb"
+  end
+end

data/lib/generators/eventy/templates/setup_eventy_hstore.rb

@@ -0,0 +1,23 @@
+# Creates the database table plus indexes you'll need to use Eventy
+class SetupEventy < ActiveRecord::Migration
+  def self.up
+    execute "CREATE EXTENSION hstore"
+
+    create_table :events, force: true do |t|
+      t.string :name
+      t.string :identity
+      t.hstore :properties
+      t.timestamps
+    end
+
+    add_index :events, :name
+    add_index :events, [:identity, :name]
+    add_index :events, :properties, using: :gin
+  end
+
+  def self.down
+    drop_table :events
+
+    execute "DROP EXTENSION hstore"
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eventy
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Nicholas Firth-McCoy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-28 00:00:00.000000000 Z
+date: 2013-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -55,9 +55,12 @@ files:
 - lib/eventy.rb
 - lib/eventy/abstract_event.rb
 - lib/eventy/backends/active_record.rb
+- lib/eventy/backends/active_record_hstore.rb
 - lib/eventy/version.rb
 - lib/generators/eventy/active_record_generator.rb
+- lib/generators/eventy/active_record_hstore_generator.rb
 - lib/generators/eventy/templates/setup_eventy.rb
+- lib/generators/eventy/templates/setup_eventy_hstore.rb
 homepage: https://github.com/nfm/eventy
 licenses:
 - MIT