km_resque 1.0.0

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.9.2
+script: bundle exec rspec spec

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Luke Melia
+
+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,51 @@
+# KmResque
+
+An interface for interacting with the KISSmetrics API via Resque. Keeps all direct interactions with the KISSMetrics API out of your requests.
+
+[![Build Status](https://secure.travis-ci.org/lukemelia/km_resque.png)](http://travis-ci.org/lukemelia/km_resque)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'km_resque'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install km_resque
+
+Configure your API key:
+
+    KmResque.configure do |config|
+      config.key = '<YOUR-KISSMETRICS-API-KEY>'
+    end
+
+## Usage
+
+    KmResque.alias(anonymous_id, user.id)
+    KmResque.record(user.id, 'signed_up', { :source => 'contest' })
+    KmResque.set(user.id, { :gender => 'F' })
+
+## Running specs
+
+    $ bundle exec rspec spec/
+
+## 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'`); don't forget the specs!
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Credits
+
+Written by Luke Melia. Thanks to Yapp for open sourcing KMResque. Inspiration from delayed_kiss and km-delay.
+
+## License
+
+km_resque is available under the terms of the MIT License http://www.opensource.org/licenses/mit-license.php

data/Rakefile

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

data/km-resque.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/km_resque/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Luke Melia"]
+  gem.email         = ["luke@lukemelia.com"]
+  gem.description   = %q{Interact with the KISSMetrics API via Resque}
+  gem.summary       = %q{Interact with the KISSMetrics API via Resque}
+  gem.homepage      = "https://github.com/lukemelia/km_resque"
+
+  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          = "km_resque"
+  gem.require_paths = ["lib"]
+  gem.version       = KmResque::VERSION
+
+  gem.add_dependency 'resque', '>= 1.1.0'
+  gem.add_development_dependency 'resque_spec'
+  gem.add_development_dependency 'webmock'
+end

data/lib/km_resque/alias_job.rb

@@ -0,0 +1,11 @@
+require 'km_resque/api_client'
+
+class KmResque
+  class AliasJob
+    @queue = :km
+
+    def self.perform(identifier1, identifier2, timestamp)
+      ApiClient.new.alias(identifier1, identifier2, timestamp)
+    end
+  end
+end

data/lib/km_resque/api_client.rb

@@ -0,0 +1,66 @@
+require 'km_resque'
+
+class KmResque
+  class ApiClient
+    def alias(identifier1, identifier2, timestamp)
+      hit('a', { '_n' => identifier2,
+                 '_p' => identifier1,
+                 '_t' => timestamp
+               })
+    end
+
+    def record(identifier, event_name, properties, timestamp)
+      hit('e', { '_p' => identifier,
+                 '_n' => event_name,
+                 '_t' => timestamp
+               }.merge(properties || {}))
+    end
+
+    def set(identifier, properties, timestamp)
+      hit('s', { '_p' => identifier,
+                 '_t' => timestamp
+               }.merge(properties))
+    end
+
+    def api_key
+      @api_key ||= KmResque.configuration.key
+    end
+
+    def host
+      @host ||= KmResque.configuration.host
+    end
+
+    def port
+      @port ||= KmResque.configuration.port
+    end
+
+  private
+
+    def hit(type, data)
+      unless data['_p']
+        raise Error.new("Can't hit the API without an identity")
+      end
+
+      data['_k'] = api_key
+      unless data['_k']
+        raise Error.new("Can't hit the API without an API Key")
+      end
+
+      data['_d'] = 1 if data['_t']
+      data['_t'] ||= Time.now.to_i
+
+      unsafe = Regexp.new("[^#{URI::REGEXP::PATTERN::UNRESERVED}]", false, 'N')
+
+      query_parts = []
+      query = ''
+      data.inject(query) do |query, key_val|
+        query_parts <<  key_val.collect { |i| URI.escape(i.to_s, unsafe) }.join('=')
+      end
+      query = '/' + type + '?' + query_parts.join('&')
+      proxy = URI.parse(ENV['http_proxy'] || ENV['HTTP_PROXY'] || '')
+      res = Net::HTTP::Proxy(proxy.host, proxy.port, proxy.user, proxy.password).start(host, port) do |http|
+        http.get(query)
+      end
+    end
+  end
+end

data/lib/km_resque/configuration.rb

@@ -0,0 +1,15 @@
+class KmResque
+  class Configuration
+    attr_accessor :key
+
+    attr_writer :host
+    def host
+      @host ||= 'trk.kissmetrics.com'
+    end
+
+    attr_writer :port
+    def port
+      @port ||= 80
+    end
+  end
+end

data/lib/km_resque/record_job.rb

@@ -0,0 +1,11 @@
+require 'km_resque/api_client'
+
+class KmResque
+  class RecordJob
+    @queue = :km
+
+    def self.perform(identifier, event_name, properties, timestamp)
+      ApiClient.new.record(identifier, event_name, properties, timestamp)
+    end
+  end
+end

data/lib/km_resque/set_job.rb

@@ -0,0 +1,11 @@
+require 'km_resque/api_client'
+
+class KmResque
+  class SetJob
+    @queue = :km
+
+    def self.perform(identifier, properties, timestamp)
+      ApiClient.new.set(identifier, properties, timestamp)
+    end
+  end
+end

data/lib/km_resque/version.rb

@@ -0,0 +1,3 @@
+class KmResque
+  VERSION = "1.0.0"
+end

data/lib/km_resque.rb

@@ -0,0 +1,24 @@
+require "km_resque/version"
+require "km_resque/configuration"
+require "km_resque/alias_job"
+require "km_resque/set_job"
+require "km_resque/record_job"
+
+class KmResque
+  class Error < RuntimeError; end
+  def self.configure(&block)
+    yield configuration
+  end
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+  def self.alias(identifier1, identifier2)
+    ::Resque.enqueue(AliasJob, identifier1, identifier2, Time.now.to_i)
+  end
+  def self.set(identifier, properties)
+    ::Resque.enqueue(SetJob, identifier, properties, Time.now.to_i)
+  end
+  def self.record(identifier, eventName, properties)
+    ::Resque.enqueue(RecordJob, identifier, eventName, properties, Time.now.to_i)
+  end
+end

data/spec/lib/km_resque/alias_job_spec.rb

@@ -0,0 +1,20 @@
+$:.push File.expand_path('../../lib', __FILE__)
+require 'webmock/rspec'
+require 'km_resque/alias_job'
+
+describe "KmResque::AliasJob" do
+  before(:each) do
+    stub_request(:any, %r{http://trk.kissmetrics.com.*})
+    KmResque.configure do |config|
+      config.key = "abc123"
+    end
+  end
+  describe "perform" do
+    it "should hit the KM API" do
+      timestamp = Time.now.to_i
+      KmResque::AliasJob.perform("identifier1", "identifier2", timestamp)
+      expected_api_hit = "http://trk.kissmetrics.com/a?_d=1&_k=abc123&_n=identifier2&_p=identifier1&_t=#{timestamp}"
+      WebMock.should have_requested(:get, expected_api_hit)
+    end
+  end
+end

data/spec/lib/km_resque/record_job_spec.rb

@@ -0,0 +1,32 @@
+$:.push File.expand_path('../../lib', __FILE__)
+require 'webmock/rspec'
+require 'km_resque/record_job'
+
+describe "KmResque::RecordJob" do
+  before(:each) do
+    stub_request(:any, %r{http://trk.kissmetrics.com.*})
+    KmResque.configure do |config|
+      config.key = "abc123"
+    end
+  end
+  describe "perform" do
+    it "should hit the KM API" do
+      timestamp = Time.now.to_i
+      KmResque::RecordJob.perform("identifier", "eventName", { :foo => 'bar', :baz => 'bay'}, timestamp)
+      expected_api_hit = "http://trk.kissmetrics.com/e?_d=1&_k=abc123&_n=eventName&_p=identifier&_t=#{timestamp}&baz=bay&foo=bar"
+      WebMock.should have_requested(:get, expected_api_hit)
+    end
+    it "should succceed with no properties" do
+      timestamp = Time.now.to_i
+      KmResque::RecordJob.perform("identifier", "eventName", nil, timestamp)
+      expected_api_hit = "http://trk.kissmetrics.com/e?_d=1&_k=abc123&_n=eventName&_p=identifier&_t=#{timestamp}"
+      WebMock.should have_requested(:get, expected_api_hit)
+    end
+    it "should raise an error when no identity is provided" do
+      timestamp = Time.now.to_i
+      lambda {
+        KmResque::RecordJob.perform(nil, "eventName", { :foo => 'bar', :baz => 'bay'}, timestamp)
+        }.should raise_error(KmResque::Error)
+    end
+  end
+end

data/spec/lib/km_resque/resque_spec.rb

@@ -0,0 +1,47 @@
+$:.push File.expand_path('../lib', __FILE__)
+require 'km_resque'
+require 'resque_spec'
+
+describe "KmResque" do
+  before(:each) do
+    ResqueSpec.reset!
+    Time.stub!(:now => Time.now)
+    @timestamp = Time.now.to_i
+  end
+  describe "configuring" do
+    it "should capture the API key" do
+      KmResque.configure do |config|
+        config.key = "foo"
+      end
+      KmResque.configuration.key.should == "foo"
+    end
+  end
+  describe "alias" do
+    it "should queue an AliasJob" do
+      KmResque.alias("identifier1", "identifier2")
+      KmResque::AliasJob.should have_queued("identifier1",
+                                              "identifier2",
+                                              @timestamp
+                                              ).in(:km)
+    end
+  end
+  describe "set" do
+    it "should queue an SetJob" do
+      KmResque.set("identifier", {:some_prop => 'some_val'})
+      KmResque::SetJob.should have_queued("identifier",
+                                            {:some_prop => 'some_val'},
+                                            @timestamp
+                                            ).in(:km)
+    end
+  end
+  describe "record" do
+    it "should queue an RecordJob" do
+      KmResque.record("identifier", "myEventName", {:some_prop => 'some_val'})
+      KmResque::RecordJob.should have_queued("identifier",
+                                               "myEventName",
+                                               {:some_prop => 'some_val'},
+                                               @timestamp
+                                               ).in(:km)
+    end
+  end
+end

data/spec/lib/km_resque/set_job_spec.rb

@@ -0,0 +1,20 @@
+$:.push File.expand_path('../../lib', __FILE__)
+require 'webmock/rspec'
+require 'km_resque/set_job'
+
+describe "KmResque::SetJob" do
+  before(:each) do
+    stub_request(:any, %r{http://trk.kissmetrics.com.*})
+    KmResque.configure do |config|
+      config.key = "abc123"
+    end
+  end
+  describe "perform" do
+    it "should hit the KM API" do
+      timestamp = Time.now.to_i
+      KmResque::SetJob.perform("identifier", { :foo => 'bar', :baz => 'bay'}, timestamp)
+      expected_api_hit = "http://trk.kissmetrics.com/s?_d=1&_k=abc123&_p=identifier&_t=#{timestamp}&baz=bay&foo=bar"
+      WebMock.should have_requested(:get, expected_api_hit)
+    end
+  end
+end

data/spec/lib/km_resque_spec.rb

@@ -0,0 +1,47 @@
+$:.push File.expand_path('../lib', __FILE__)
+require 'km_resque'
+require 'resque_spec'
+
+describe "KmResque" do
+  before(:each) do
+    ResqueSpec.reset!
+    Time.stub!(:now => Time.now)
+    @timestamp = Time.now.to_i
+  end
+  describe "configuring" do
+    it "should capture the API key" do
+      KmResque.configure do |config|
+        config.key = "foo"
+      end
+      KmResque.configuration.key.should == "foo"
+    end
+  end
+  describe "alias" do
+    it "should queue an AliasJob" do
+      KmResque.alias("identifier1", "identifier2")
+      KmResque::AliasJob.should have_queued("identifier1",
+                                              "identifier2",
+                                              @timestamp
+                                              ).in(:km)
+    end
+  end
+  describe "set" do
+    it "should queue an SetJob" do
+      KmResque.set("identifier", {:some_prop => 'some_val'})
+      KmResque::SetJob.should have_queued("identifier",
+                                            {:some_prop => 'some_val'},
+                                            @timestamp
+                                            ).in(:km)
+    end
+  end
+  describe "record" do
+    it "should queue an RecordJob" do
+      KmResque.record("identifier", "myEventName", {:some_prop => 'some_val'})
+      KmResque::RecordJob.should have_queued("identifier",
+                                               "myEventName",
+                                               {:some_prop => 'some_val'},
+                                               @timestamp
+                                               ).in(:km)
+    end
+  end
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification 
+name: km_resque
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Luke Melia
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-09-20 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: resque
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: resque_spec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: webmock
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: Interact with the KISSMetrics API via Resque
+email: 
+- luke@lukemelia.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- km-resque.gemspec
+- lib/km_resque.rb
+- lib/km_resque/alias_job.rb
+- lib/km_resque/api_client.rb
+- lib/km_resque/configuration.rb
+- lib/km_resque/record_job.rb
+- lib/km_resque/set_job.rb
+- lib/km_resque/version.rb
+- spec/lib/km_resque/alias_job_spec.rb
+- spec/lib/km_resque/record_job_spec.rb
+- spec/lib/km_resque/resque_spec.rb
+- spec/lib/km_resque/set_job_spec.rb
+- spec/lib/km_resque_spec.rb
+homepage: https://github.com/lukemelia/km_resque
+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: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Interact with the KISSMetrics API via Resque
+test_files: 
+- spec/lib/km_resque/alias_job_spec.rb
+- spec/lib/km_resque/record_job_spec.rb
+- spec/lib/km_resque/resque_spec.rb
+- spec/lib/km_resque/set_job_spec.rb
+- spec/lib/km_resque_spec.rb