trackme 0.0.4

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MzNmYzIzOTQ1NzU1NzRhN2UwOTU3MmU5ZDA0NWQ1ZWUwNmMzNmU3ZQ==
+  data.tar.gz: !binary |-
+    NTNjNTE4MjhiYzZjNmE4ZmY3NDBiZTY4ZmY1YzZjY2Q5ZGJhYTkyNA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ZWI4OWE0ZWNmZjQ4NDRmN2U3MWU3YThiY2I0OWIzNDBkOGEzZjA2NThmNGI1
+    NTYyOTczZjlkYjdkMDNkYjJiMjU1ZTkyMDg5MWU0ZjZlZDhjYTc0OTA1MTdl
+    ZDVlOGYwZWQ0NDBiYzE2NDY4NTRiZmRkMDJkYmEyMGI3MmNmODQ=
+  data.tar.gz: !binary |-
+    NjA5NjA1OTVmZTcxZGUyZTYzZjQ4ODY5ZDI0N2JlMDIyYWE0ZjQzYmIzMWQ2
+    MDUxNTc0YWEzY2E5YjkyZjBiMTQ5Zjc5NDJkYmRhMTNmOWZkYTMwNmEzNzQ1
+    ODI5NWUyMTQ2MjUwZmU5ZjIyMDFjOGI5OWQ3MWQ0MWRiYmE4ZjA=

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Michael Dijkstra
+
+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,101 @@
+# TrackMe
+
+Simple user activity tracking for Ruby and Rails developers
+
+## Usage
+
+TrackMe is based on the idea that an actor performs an event.
+
+To setup your event class add the following:
+  `include TrackMe::Event`
+
+To setup your actor class add the following:
+  `include TrackMe::Actor`
+
+By default, TrackMe looks for an event class called 'Event'. If you would like
+to change this then set the following:
+  `self.event_klass = CLASS`
+
+Once setup, you can track a users activity in the following way:
+  `current_user.track_me(category: 'View')`
+
+## Details
+
+TrackMe events have the following options:
++ `:actor` (required) - The object that did the event
++ `:category` (required)- The event category, such as 'Message'
++ `:label` (optional)- The label of the event category, such as 'New'
++ `:value` (optional)- The value of the event category label, such as 'Hello Bob!'
++ `:created_at` (optional)- The date the event occurred, such as '2013-09-29
+  12:00:00'
+
+TrackMe needs the following fields to save events:
++ `actor_id` - Integer
++ `category` - String
++ `label` - String
++ `value` - String
++ `created_at` - Date/Time
+
+## Rails Example
+
+First, add the TrackMe gem to your Gemfile:
+
+  `gem 'trackme'`
+
+Next, you need to setup a model to be the actor, this is most likely going to
+be your `User` model.
+
+```ruby
+class User
+  include TrackMe::Actor
+
+  # … existing model code
+end
+```
+
+Then you need to setup a model to save the events, in most cases you will need
+to create a new model with the fields `actor`, `category`, `label`, `value`.
+
+In a Rails app backed by Postgress you would set this up with by running the
+following on the command line:
+
+  `rails g model event actor_id:integer category:text label:text value:text -t nil`
+
+  `rake db:migrate`
+
+And add the following to your `Event` model:
+
+```ruby
+class Event
+  include TrackMe::Event
+
+  # … existing model code
+end
+```
+
+Let's say you have a `Messages` controller and you want to track when a user
+sends a message, you would add the following code to your `create` action:
+
+```ruby
+class MessagesController
+  # … existing controller code
+
+  def create
+    # … existing code
+    @sender = User.find(params[:sender_id])
+    @sender.track_me(category: 'Message', label: 'New', value: @message.body)
+  end
+
+  # … more controller code
+end
+```
+
+That's it! Now you are able to track users activity.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/lib/trackme.rb

@@ -0,0 +1,4 @@
+require 'trackme/version'
+require 'trackme/actor.rb'
+require 'trackme/errors.rb'
+require 'trackme/event.rb'

data/lib/trackme/actor.rb

@@ -0,0 +1,23 @@
+module TrackMe
+
+  module Actor
+
+    attr_accessor :event_klass
+
+    def track_me(options={})
+      validate_track_me(options) or raise StandardError
+      event_class.publish(self, options)
+    end
+
+    def validate_track_me(options)
+      options[:category].empty? == false && options[:label].empty? == false
+    rescue
+      raise Errors::InvalidData
+    end
+
+    def event_class
+       @event_klass ||= event_klass ? event_klass.classify.constantize : ::Event
+    end
+  end
+
+end

data/lib/trackme/errors.rb

@@ -0,0 +1,17 @@
+module TrackMe
+
+  module Errors
+
+    class InvalidData < StandardError
+
+      attr_reader :message
+
+      def initialize(message)
+        @message = "Invalid Data: #{message}"
+      end
+
+    end
+
+  end
+
+end

data/lib/trackme/event.rb

@@ -0,0 +1,19 @@
+module TrackMe
+  module Event
+    attr_reader :actor, :category, :label, :value, :created_at
+    attr_writer :actor, :category, :label, :value, :created_at
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def publish(actor, data={})
+        (actor && data[:category]) or raise Errors::InvalidData
+        event = new({ actor_id: actor.id }.merge(data))
+        event.save
+        event
+      end
+    end
+  end
+end

data/lib/trackme/version.rb

@@ -0,0 +1,3 @@
+module TrackMe
+  VERSION = "0.0.4"
+end

data/spec/app/models/event.rb

@@ -0,0 +1,14 @@
+class Event
+  include TrackMe::Event
+
+  def initialize(data={})
+    @actor = data[:actor]
+    @category = data[:category]
+    @label = data[:label]
+    @value = data[:value]
+    @created_at = data[:created_at]
+  end
+
+  def save
+  end
+end

data/spec/app/models/user.rb

@@ -0,0 +1,11 @@
+class User
+  include TrackMe::Actor
+
+  def self.existing_instance_method
+    true
+  end
+
+  def id
+    '1'
+  end
+end

data/spec/lib/actor_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+describe TrackMe do
+  describe "Actor" do
+    describe ".track_me" do
+      it "must have a category" do
+        expect{ user.track_me(category: '', label: 'Homepage') }.to raise_error
+      end
+
+      it "must have a label" do
+        expect{ user.track_me(category: 'View', label: '') }.to raise_error
+      end
+
+      it "is valid with category and label" do
+        expect{ user.track_me(data) }.not_to raise_error
+      end
+
+      it "still uses existing methods" do
+        User.existing_instance_method.should eq(true)
+      end
+    end
+  end
+end

data/spec/lib/event_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+describe TrackMe do
+  describe "Event" do
+    describe ".publish" do
+      it "must have an actor" do
+        expect{ Event.publish(nil, data) }.to raise_error
+      end
+
+      it "must have a category" do
+        expect{ Event.publish(user, { category: nil }) }.to raise_error
+      end
+
+      it "returns an event" do
+        event = Event.publish(user, data)
+        event.class.should eq(Event)
+      end
+
+      it "can override the create date" do
+        event = Event.publish(user, { created_at: Time.new(2013) }.merge(data))
+        event.created_at.should eq(Time.new(2013))
+      end
+    end
+
+    describe ".create" do
+      it "has an actor" do
+        event.actor.should eq(user)
+      end
+
+      it "has a category" do
+        event.category.should eq('View')
+      end
+
+      it "has a label" do
+        event.label.should eq('Homepage')
+      end
+
+      it "has a value" do
+        event.value.should eq('1')
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+#
+
+require 'trackme'
+
+require 'app/models/user.rb'
+require 'app/models/event.rb'
+require 'support/trackme_helper.rb'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+
+  config.include TrackMeHelper
+end

data/spec/support/trackme_helper.rb

@@ -0,0 +1,13 @@
+module TrackMeHelper
+  def user
+    @user ||= User.new
+  end
+
+  def event
+    @event ||= Event.new({ actor: user }.merge(data))
+  end
+
+  def data
+    { category: 'View', label: 'Homepage', value: '1' }
+  end
+end

data/trackme.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'trackme/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "trackme"
+  spec.version       = TrackMe::VERSION
+  spec.authors       = ["Michael Dijkstra"]
+  spec.email         = ["micdijkstra@gmail.com"]
+  spec.description   = %q{Simple user activity tracking}
+  spec.summary       = %q{Provides an easy way for Ruby and Rails developers to track user activity.}
+  spec.homepage      = "https://github.com/micdijkstra/trackme"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: trackme
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Michael Dijkstra
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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 user activity tracking
+email:
+- micdijkstra@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/trackme.rb
+- lib/trackme/actor.rb
+- lib/trackme/errors.rb
+- lib/trackme/event.rb
+- lib/trackme/version.rb
+- spec/app/models/event.rb
+- spec/app/models/user.rb
+- spec/lib/actor_spec.rb
+- spec/lib/event_spec.rb
+- spec/spec_helper.rb
+- spec/support/trackme_helper.rb
+- trackme.gemspec
+homepage: https://github.com/micdijkstra/trackme
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Provides an easy way for Ruby and Rails developers to track user activity.
+test_files:
+- spec/app/models/event.rb
+- spec/app/models/user.rb
+- spec/lib/actor_spec.rb
+- spec/lib/event_spec.rb
+- spec/spec_helper.rb
+- spec/support/trackme_helper.rb