delayed_kiss 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in delayed_kiss.gemspec
+gemspec
+gem 'rspec', '2.7.0'
+gem 'mocha', '0.10.0'

data/README.textile

@@ -0,0 +1,44 @@
+h1. Delayed Kiss
+
+A simple interface for the KISSmetrics API that plays nicely with Delayed Job and Heroku.
+
+h2. Installation
+
+Include the gem in your gemfile:
+
+<pre>
+  gem 'delayed_kiss'
+</pre>
+
+Configure your API key:
+<pre>
+  #in config/kiss_metrics.yml
+  development:
+    key: <yourkey>
+  test:
+    key: <yourkey>
+  production:
+    key: <yourkey>
+</pre>
+Initialize the API key
+<pre>
+  #in config/initializers
+  KM_CONFIG = YAML::load(ERB.new(IO.read(File.join(Rails.root, "config/kissmetrics.yml"))).result)[Rails.env]
+  if !KM_CONFIG.blank?
+    DelayedKiss.configure do |config|
+      config.key = KM_CONFIG['key']
+    end
+  end
+</pre>
+
+h2. Usage
+
+Start recording events anywhere in your application:
+<pre>
+  DelayedKiss.alias(anonymous_user, user.km_id)
+  DelayedKiss.record(user.km_id, 'signed up')
+</pre>
+
+h2. Thanks
+
+DelayedKiss is derived and gemified from https://github.com/vbrendel/delayed_km

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new('spec')
+
+# If you want to make this the default task
+task :default => :spec

data/delayed_kiss.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "delayed_kiss/version"
+
+Gem::Specification.new do |s|
+  s.name        = "delayed_kiss"
+  s.version     = DelayedKiss::VERSION
+  s.authors     = ["Dustin DeYoung"]
+  s.email       = ["ddeyoung@authorsolutions.com"]
+  s.homepage    = ""
+  s.summary     = %q{KissMetrics API with Delayed Job}
+  s.description = %q{A simple wrapper for the KissMetrics API using Delayed Job}
+
+  s.rubyforge_project = "delayed_kiss"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency("activesupport")
+  s.add_dependency("i18n")
+  s.add_dependency("httparty", ">= 0.8.1")
+  s.add_dependency("delayed_job", ">= 2.1.4")
+end

data/lib/delayed_kiss/version.rb

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

data/lib/delayed_kiss.rb

@@ -0,0 +1,52 @@
+require "delayed_kiss/version"
+
+module DelayedKiss
+  mattr_accessor :key
+  @@key = nil
+  
+  def self.configure
+    yield self
+  end
+
+  def self.record(id, event, query_params={})
+    raise DelayedKiss::ConfigurationError if @@key.blank?
+    raise ArgumentError.new("id can't be blank") if id.blank?
+    raise ArgumentError.new("event can't be blank") if event.blank?
+    
+    query_params.merge!({
+      '_n' => event,
+      '_p' => id,
+      '_t' => Time.now.to_i.to_s,
+      '_k' => @@key
+    })
+    HTTParty.delay.get('https://trk.kissmetrics.com/e?' + query_params.to_param)
+  end
+
+  def self.alias(alias_from, alias_to)
+    raise DelayedKiss::ConfigurationError if @@key.blank?
+    raise ArgumentError.new("you must specify both a from a to value") if alias_from.blank? || alias_to.blank?
+    
+    query_params = {
+      '_n' => alias_to,
+      '_p' => alias_from,
+      '_t' => Time.now.to_i.to_s,
+      '_k' => @@key
+    }
+    HTTParty.delay.get('https://trk.kissmetrics.com/a?' + query_params.to_param)
+  end
+
+  def self.set(id, query_params)
+    raise DelayedKiss::ConfigurationError if @@key.blank?
+    raise ArgumentError.new("id can't be blank") if !id || id.blank?
+    return if query_params.blank? # don't do anything if we're not setting any values on the identity
+    
+    query_params.merge!({
+      '_p' => id,
+      '_t' => Time.now.to_i.to_s,
+      '_k' => @@key
+    })
+    HTTParty.delay.get('https://trk.kissmetrics.com/s?' + query_params.to_param)
+  end
+  
+  class ConfigurationError < StandardError; end
+end

data/spec/delayed_kiss_spec.rb

@@ -0,0 +1,110 @@
+require 'spec_helper'
+
+describe DelayedKiss do
+  describe :configure do
+    before(:each) do
+      DelayedKiss.cache_config
+    end
+    
+    after(:each) do
+      DelayedKiss.reset_config
+    end
+    
+    it "should configure the key" do
+      test_key = "youraikeyvalue"
+      DelayedKiss.configure do |config|
+        config.key = test_key
+      end
+      
+      DelayedKiss.key.should == test_key
+    end
+  end
+  
+  describe :record do
+    it "should send a request to the KISSmetrics API when valid parameters are supplied" do
+     HTTParty.expects(:get).once.returns(true)
+     DelayedKiss.record("identity", "event")
+    end
+    
+    it "should raise an error without an identity" do
+      HTTParty.expects(:get).never
+      expect { DelayedKiss.record(nil, "event") }.to raise_error(ArgumentError)
+    end
+    
+    it "should rais an error without an event" do
+      expect { DelayedKiss.record("identity", nil) }.to raise_error(ArgumentError)
+    end
+    
+    it "should send a request to the KISSmetrics API with custom properties in the URL's query string" do
+      HTTParty.expects(:get).with(regexp_matches(/type=crazy/)).returns(true)
+      DelayedKiss.record("identity", "event", {:type => "crazy"})
+    end
+    
+    it "should raise an error if the key is not configured" do
+      DelayedKiss.cache_config
+      DelayedKiss.key = nil
+      expect { DelayedKiss.record("identity", "event") }.to raise_error(DelayedKiss::ConfigurationError)
+      DelayedKiss.reset_config
+    end
+  end
+  
+  describe :alias do
+    it "should send a request to the KISSmetrics API when valid parameters are supplied" do
+      HTTParty.expects(:get).once.returns(true)
+      DelayedKiss.alias("oldname", "newname")
+    end
+    
+    it "should include the from alias in the query string" do
+      HTTParty.expects(:get).with(regexp_matches(/_p=oldname/)).returns(true)
+      DelayedKiss.alias("oldname", "newname")
+    end
+    
+    it "should include the to alias in the query string" do
+      HTTParty.expects(:get).with(regexp_matches(/_n=newname/)).returns(true)
+      DelayedKiss.alias("oldname", "newname")
+    end
+    
+    it "should raise an error without a from alias" do
+      expect { DelayedKiss.alias(nil, "newname") }.to raise_error(ArgumentError)
+    end
+    
+    it "should raise an error without a to alias" do
+      expect { DelayedKiss.alias("oldname", nil) }.to raise_error(ArgumentError)
+    end
+    
+    it "should raise an error if the key is not configured" do
+      DelayedKiss.cache_config
+      DelayedKiss.key = nil
+      expect { DelayedKiss.record("identity", "event") }.to raise_error(DelayedKiss::ConfigurationError)
+      DelayedKiss.reset_config
+    end
+  end
+  
+  describe :set do
+    it "should send a request to the KISSmetrics API when valid parameters are supplied" do
+      HTTParty.expects(:get).once.returns(true)
+      DelayedKiss.set("identity", {:gender => :male})
+    end
+    
+    it "should include the set properties in the query string" do
+      HTTParty.expects(:get).with(regexp_matches(/age=27/)).returns(true)
+      DelayedKiss.set("identity", {:age => 27})
+    end
+    
+    it "should not send a reuqest to the KISSmetrics API when the set paramters are blank" do
+      HTTParty.expects(:get).never
+      DelayedKiss.set("identity", {})
+    end
+    
+    it "raises an error without an identity" do
+      expect { DelayedKiss.set(nil, {:gener => :female}) }.to raise_error(ArgumentError)
+    end
+    
+    it "should raise an error if the key is not configured" do
+      DelayedKiss.cache_config
+      DelayedKiss.key = nil
+      expect { DelayedKiss.record("identity", "event") }.to raise_error(DelayedKiss::ConfigurationError)
+      DelayedKiss.reset_config
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,37 @@
+require 'rubygems'
+require 'bundler/setup'
+
+
+require 'active_support'
+require 'active_support/core_ext'
+require 'httparty'
+require 'delayed_job'
+require 'delayed_kiss'
+
+RSpec.configure do |config|
+  config.mock_with :mocha
+end
+
+DelayedKiss.configure do |config|
+  config.key = "dlf23jkd9sl32nfj99kl2s8635h3jk33f"
+end
+
+# provide methods for clearing and restoring the configurations 
+module DelayedKiss
+  @@cached_key = nil
+
+  def self.cache_config
+    @@cached_key = @@key
+  end
+
+  def self.reset_config
+    @@key = @@cached_key if @@cached_key
+  end
+end
+
+# ignore delaying jobs
+module Delayed::MessageSending
+  def delay
+    return self
+  end
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: delayed_kiss
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Dustin DeYoung
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-07 00:00:00.000000000 -05:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &2152316100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2152316100
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: &2152315680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2152315680
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: &2152315180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *2152315180
+- !ruby/object:Gem::Dependency
+  name: delayed_job
+  requirement: &2152314680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: *2152314680
+description: A simple wrapper for the KissMetrics API using Delayed Job
+email:
+- ddeyoung@authorsolutions.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- README.textile
+- Rakefile
+- delayed_kiss.gemspec
+- lib/delayed_kiss.rb
+- lib/delayed_kiss/version.rb
+- spec/delayed_kiss_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: delayed_kiss
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: KissMetrics API with Delayed Job
+test_files:
+- spec/delayed_kiss_spec.rb
+- spec/spec_helper.rb