delayed_km 0.0.1

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/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Marc Beaupre
+
+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,34 @@
+Delayed KM
+==========
+
+# DelayedKm
+
+Alternative for the Kissmetrics provided gem but using delayed_job instead of cron. This will suit Heroku users.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'delayed_km'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install delayed_km
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+    gem 'httparty'
+    gem 'delayed_job'

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/delayed_km.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/delayed_km/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Vincent Brendel, Dirk Elmendorf"]
+  gem.email         = ["jack.quack@gmail.com"]
+  gem.description   = %q{Alternative for the Kissmetrics provided gem but using delayed_job instead of cron. This will suit Heroku users.}
+  gem.summary       = %q{Kissmetrics with delayed_job}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "delayed_km"
+  gem.require_paths = ["lib"]
+  gem.version       = DelayedKm::VERSION
+
+  gem.add_dependency('httparty')
+  gem.add_dependency('delayed_job')
+  gem.add_dependency('rake')
+  gem.add_development_dependency('rspec')
+end
+

data/lib/delayed_km/version.rb

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

data/lib/delayed_km.rb

@@ -0,0 +1,103 @@
+require "delayed_km/version"
+
+module DelayedKm
+  @id = nil
+  @key = nil
+
+  class << self
+    def identity
+      @id
+    end
+
+    def api_key
+      @key
+    end
+
+    def host
+      "trk.kissmetrics.com"
+    end
+
+    def init(key)
+      @key = key
+    end
+
+    def identify(id)
+      @id = id
+    end
+
+    def record(action, props = {})
+      raise ArgumentError, "You must set an API key" if !@key
+      raise ArgumentError, "You must identify a user first" if !@id
+      props = hash_keys_to_str(props)
+      props.update("_n" => action)
+      props.update("_p" => @id)
+      props.update("_k" => @key)
+
+      if props["_t"]
+        props['_d'] = "1"
+      else
+        props['_t'] = Time.now.to_i.to_s
+      end
+
+      delay_query("e", props)
+    end
+
+    def alias(name, alias_to)
+      raise ArgumentError, "You must set an API key" if !@key
+      raise ArgumentError, "You must identify a user first" if !@id
+      p = {
+          '_n' => alias_to,
+          '_p' => name,
+          '_k' => @key,
+      }
+
+      delay_query("a", p)
+    end
+
+    def set(props = {})
+      raise ArgumentError, "You must set an API key" if !@key
+      raise ArgumentError, "You must identify a user first" if !@id
+      props = hash_keys_to_str(props)
+
+      props.update("_p" => @id)
+      props.update("_k" => @key)
+
+      if props["_t"]
+        props['_d'] = "1"
+      else
+        props['_t'] = Time.now.to_i.to_s
+      end
+      delay_query("s", props)
+    end
+
+    def get(url)
+      begin
+        return HTTParty.get(url)
+      rescue Exception => e
+        raise e.exception(e.message)
+      end
+    end
+
+    protected
+    #This is from the offical km.rb
+    def hash_keys_to_str(hash)
+      Hash[*hash.map { |k, v| k.class == Symbol ? [k.to_s, v] : [k, v] }.flatten] # convert all keys to strings
+    end
+
+    def delay_query(type, props)
+      params = []
+      props.each do |k, v|
+        params << "#{CGI.escape(k.to_s)}=#{CGI.escape(v.to_s)}"
+      end
+      query = params.join("&")
+      url = "http://#{KM.host}/#{type}?#{query}"
+      job = KMJob.new(url)
+      Rails.logger.debug url
+      if Rails.application.config.delayed_km
+        Delayed::Job.enqueue job
+      elsif Rails.application.config.delayed_km_debug
+        job.perform
+      end
+    end
+  end
+end

data/lib/license.txt

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+  Copyright (c) 2011 Vincent Brendel, Dirk Elmendorf
+
+
+  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/lib/spec/dkm_spec.rb

@@ -0,0 +1,186 @@
+require 'spec_helper'
+describe DKM do
+  it "should know the host to talk to" do
+    DKM.host.should == "trk.kissmetrics.com"
+  end
+  it "should set and know the api_key" do
+    DKM.init("DKM_KEY")
+    DKM.api_key.should == "DKM_KEY"
+  end
+  it "should set and know the identiy know the id" do
+    DKM.identify("BOB")
+    DKM.identity.should == "BOB"
+
+  end
+  it "should be able to make an http request" do
+    HTTParty.should_receive(:get).with("http://www.truckingoffice.com")
+    DKM.get("http://www.truckingoffice.com")
+
+  end
+  it "should trigger exception notifier if it is installed"
+  it "should raise an error if no key is provided" do
+    DKM.init(nil)
+    expect { DKM.record("") }.should raise_error(ArgumentError, "You must set an API key")
+    expect { DKM.set("") }.should raise_error(ArgumentError, "You must set an API key")
+    expect { DKM.alias("", "") }.should raise_error(ArgumentError, "You must set an API key")
+  end
+
+  it "should raise an error if no identity is set" do
+    DKM.init("DKM_KEY")
+    DKM.identify(nil)
+    expect { DKM.record("") }.should raise_error(ArgumentError, "You must identify a user first")
+    expect { DKM.set("") }.should raise_error(ArgumentError, "You must identify a user first")
+    expect { DKM.alias("", "") }.should raise_error(ArgumentError, "You must identify a user first")
+  end
+  context "record" do
+    before(:each) do
+      @now = Time.now
+      Time.stub!(:now).and_return(@now)
+      DKM.init("DKM_KEY")
+      DKM.identify("bob@aol.com")
+      @delay = mock
+      DKM.stub!(:delay).and_return(@delay)
+    end
+
+    def set_record_mock(action, args = {}, date = nil)
+      @delay.should_receive(:get) do |url|
+
+        expect { URI.parse(url) }.should_not raise_error
+        uri = URI.parse(url)
+        q = CGI.parse(uri.query)
+        uri.host.should == DKM.host
+        uri.path.should == "/e"
+        q["_k"].first.should == "DKM_KEY"
+        q["_p"].first.should == "bob@aol.com"
+        q["_n"].first.should == action
+        if date
+          q["_d"].first.should == "1"
+          q["_t"].first.should == date.to_i.to_s
+        else
+          q["_t"].first.should == @now.to_i.to_s
+        end
+        args.keys.each do |key|
+          q[key.to_s].first.should == args[key].to_s
+        end
+      end
+    end
+
+    it "should allow you to record an event" do
+      set_record_mock("Paid Us")
+      DKM.record("Paid Us")
+    end
+    it "should allow you to record an event for a time in the past" do
+      set_record_mock("Paid Us", {}, @now - 1.day)
+      DKM.record("Paid Us", {"_t" => (@now - 1.day).to_i.to_s})
+    end
+    it "should allow you to record an event with additional properties" do
+      set_record_mock("Paid Us", {"plan" => "Standard", "amount" => "25.00"})
+      DKM.record("Paid Us", {"plan" => "Standard", "amount" => "25.00"})
+    end
+    it "should allow you to record an event with additional properties that have special characters in the keys" do
+      set_record_mock("Paid Us", {"plan" => "Standard", "amount of $" => "25.00"})
+      DKM.record("Paid Us", {"plan" => "Standard", "amount of $" => "25.00"})
+    end
+    it "should allow you to record an event with additional properties for a time in the past" do
+      set_record_mock("Paid Us", {"plan" => "Standard", "amount" => "25.00"}, @now - 1.day)
+      DKM.record("Paid Us", {"plan" => "Standard", "amount" => "25.00", "_t" => (@now - 1.day).to_i.to_s})
+    end
+    it "should allow you to use symbols for keys on the additional properties" do
+      set_record_mock("Paid Us", {"plan" => "Standard", "amount" => "25.00"}, @now - 1.day)
+      DKM.record("Paid Us", {:plan => "Standard", :amount => "25.00", :_t => (@now - 1.day).to_i.to_s})
+    end
+  end
+  context "set" do
+    before(:each) do
+      @now = Time.now
+      Time.stub!(:now).and_return(@now)
+      DKM.init("DKM_KEY")
+      DKM.identify("bob@aol.com")
+      @delay = mock
+      DKM.stub!(:delay).and_return(@delay)
+    end
+
+    def set_set_mock(args = {}, date = nil)
+      @delay.should_receive(:get) do |url|
+        expect { URI.parse(url) }.should_not raise_error
+        uri = URI.parse(url)
+        q = CGI.parse(uri.query)
+        uri.host.should == DKM.host
+        uri.path.should == "/s"
+        q["_k"].first.should == "DKM_KEY"
+        q["_p"].first.should == "bob@aol.com"
+
+        if date
+          q["_d"].first.should == "1"
+          q["_t"].first.should == date.to_i.to_s
+        else
+          q["_t"].first.should == @now.to_i.to_s
+        end
+        args.keys.each do |key|
+          q[key.to_s].first.should == args[key].to_s
+        end
+      end
+    end
+
+    it "should allow you to set a property on a profile" do
+      set_set_mock({"plan" => "Standard"})
+      DKM.set({"plan" => "Standard"})
+    end
+    it "should allow you to set multiple properties on a profile" do
+      set_set_mock({"plan" => "Standard", "amount" => "25.00"})
+      DKM.set({"plan" => "Standard", "amount" => "25.00"})
+    end
+    it "should allow you to set  properties on a profile with special characters" do
+      set_set_mock({"plan" => "Standard", "amount of $" => "25.00"})
+      DKM.set({"plan" => "Standard", "amount of $" => "25.00"})
+    end
+    it "should allow you to set a property on a profile for a time in the past" do
+
+      set_set_mock({"plan" => "Standard"}, @now - 1.day)
+      DKM.set({"plan" => "Standard", "_t" => (@now - 1.day).to_i.to_s})
+    end
+    it "should allow you to set multiple properties on a profile for a time in the past" do
+      set_set_mock({"plan" => "Standard", "amount" => "25.00"}, @now - 1.day)
+      DKM.set({"plan" => "Standard", "amount" => "25.00", "_t" => (@now - 1.day).to_i.to_s})
+    end
+    it "should allow you to use symbols for keys on  properties" do
+      set_set_mock({"plan" => "Standard", "amount" => "25.00"}, @now - 1.day)
+      DKM.set({:plan => "Standard", :amount => "25.00", :_t => (@now - 1.day).to_i.to_s})
+    end
+  end
+
+  it "should allow you to alias on identity to another" do
+
+  end
+  context "identify" do
+    before(:each) do
+      @now = Time.now
+      Time.stub!(:now).and_return(@now)
+      DKM.init("DKM_KEY")
+      DKM.identify("bob@aol.com")
+      @delay = mock
+      DKM.stub!(:delay).and_return(@delay)
+    end
+
+    def set_identify_mock(old_name, new_name)
+
+      @delay.should_receive(:get) do |url|
+        expect { URI.parse(url) }.should_not raise_error
+        uri = URI.parse(url)
+
+        q = CGI.parse(uri.query)
+        uri.host.should == DKM.host
+        uri.path.should == "/a"
+        q["_k"].first.should == "DKM_KEY"
+        q["_p"].first.should == old_name
+        q["_n"].first.should == new_name
+      end
+    end
+
+    it "should allow you to alias a user" do
+      set_identify_mock("sam@aol.com", "will@aol.com")
+      DKM.alias("sam@aol.com", "will@aol.com")
+    end
+  end
+
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: delayed_km
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Vincent Brendel, Dirk Elmendorf
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: &70349193944300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70349193944300
+- !ruby/object:Gem::Dependency
+  name: delayed_job
+  requirement: &70349193943880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70349193943880
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70349193943460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70349193943460
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70349193965640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70349193965640
+description: Alternative for the Kissmetrics provided gem but using delayed_job instead
+  of cron. This will suit Heroku users.
+email:
+- jack.quack@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- delayed_km.gemspec
+- lib/delayed_km.rb
+- lib/delayed_km/version.rb
+- lib/license.txt
+- lib/spec/dkm_spec.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -49468628806324911
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -49468628806324911
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: Kissmetrics with delayed_job
+test_files: []