km_sidekiq 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cc62e3585e795197209d19213990ca1c1031d34b
+  data.tar.gz: 13d5680558d8cff48297496c9a429951e861d506
+SHA512:
+  metadata.gz: ab37eb36a61bf1be20a9155871aae9f011c56a51da39f2109ddb44cbfd3f6442e13a9eaae8230a6ba2c7900e7ead65cd4dba8ef6f2b7c11db7f2dc06ce183294
+  data.tar.gz: 1c9eaa7d92b3d1e20f53f51abcf8d292aff01491ac90f53f7796bd6827c1acbaa47160074634e0acc16b5ba0c6dabffae52680b38c430e63935ffafe74023373

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_sidekiq.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 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 @@
+# KmSidekiq
+
+An interface for interacting with the KISSmetrics API via Sidekiq. Keeps all direct interactions with the KISSMetrics API out of your requests.
+
+[![Build Status](https://secure.travis-ci.org/yapplabs/km_sidekiq.png)](http://travis-ci.org/yapplabs/km_sidekiq)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'km_sidekiq'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install km_sidekiq
+
+Configure your API key:
+
+    KmSidekiq.configure do |config|
+      config.key = '<YOUR-KISSMETRICS-API-KEY>'
+    end
+
+## Usage
+
+    KmSidekiq.alias(anonymous_id, user.id)
+    KmSidekiq.record(user.id, 'signed_up', { :source => 'contest' })
+    KmSidekiq.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
+
+KmResque originally written by Luke Melia. Adapted by Ray Cohen and Stefan Penner for Sidekiq. Inspiration from delayed_kiss and km-delay.
+
+## License
+
+km_sidekiq 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-sidekiq.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/km_sidekiq/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 Sidekiq}
+  gem.summary       = %q{Interact with the KISSMetrics API via Sidekiq}
+  gem.homepage      = "https://github.com/yapplabs/km_sidekiq"
+
+  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_sidekiq"
+  gem.require_paths = ["lib"]
+  gem.version       = KmSidekiq::VERSION
+
+  gem.add_dependency 'sidekiq', '>= 2.0.0'
+  gem.add_development_dependency 'rspec-sidekiq'
+  gem.add_development_dependency 'webmock'
+end

data/lib/km_sidekiq.rb

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

data/lib/km_sidekiq/alias_job.rb

@@ -0,0 +1,13 @@
+require 'km_sidekiq/api_client'
+require 'sidekiq'
+
+class KmSidekiq
+  class AliasJob
+    include Sidekiq::Worker
+    sidekiq_options :queue => :km
+
+    def perform(identifier1, identifier2, timestamp)
+      ApiClient.new.alias(identifier1, identifier2, timestamp.to_i)
+    end
+  end
+end

data/lib/km_sidekiq/api_client.rb

@@ -0,0 +1,79 @@
+require 'km_sidekiq'
+
+class KmSidekiq
+  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 ||= KmSidekiq.configuration.key
+    end
+
+    def host
+      @host ||= KmSidekiq.configuration.host
+    end
+
+    def port
+      @port ||= KmSidekiq.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
+
+      if data['_t']
+        data['_d'] = 1
+        unless validate_timestamp(data['_t'])
+          raise Error.new("Timestamp #{data['_t']} is invalid")
+        end
+      else
+        data['_t'] = Time.now.to_i
+      end
+
+      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
+
+    SECONDS_IN_ONE_HUNDRED_YEARS = 60 * 60 * 24 * 365 * 100
+
+    def validate_timestamp(timestamp)
+      timestamp = timestamp.to_i
+      (timestamp > 0) && (timestamp < (Time.now.to_i + SECONDS_IN_ONE_HUNDRED_YEARS))
+    end
+  end
+end

data/lib/km_sidekiq/configuration.rb

@@ -0,0 +1,15 @@
+class KmSidekiq
+  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_sidekiq/record_job.rb

@@ -0,0 +1,13 @@
+require 'km_sidekiq/api_client'
+require 'sidekiq'
+
+class KmSidekiq
+  class RecordJob
+    include Sidekiq::Worker
+    sidekiq_options :queue => :km
+
+    def perform(identifier, event_name, properties, timestamp)
+      ApiClient.new.record(identifier, event_name, properties, timestamp.to_i)
+    end
+  end
+end

data/lib/km_sidekiq/set_job.rb

@@ -0,0 +1,13 @@
+require 'km_sidekiq/api_client'
+require 'sidekiq'
+
+class KmSidekiq
+  class SetJob
+    include Sidekiq::Worker
+    sidekiq_options :queue => :km
+
+    def perform(identifier, properties, timestamp)
+      ApiClient.new.set(identifier, properties, timestamp.to_i)
+    end
+  end
+end

data/lib/km_sidekiq/version.rb

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

data/spec/lib/km_sidekiq/alias_job_spec.rb

@@ -0,0 +1,31 @@
+$:.push File.expand_path('../../lib', __FILE__)
+require 'webmock/rspec'
+require 'km_sidekiq/alias_job'
+
+describe "KmSidekiq::AliasJob" do
+  before do
+    stub_request(:any, %r{http://trk.kissmetrics.com.*})
+    KmSidekiq.configure do |config|
+      config.key = "abc123"
+    end
+  end
+  describe "perform" do
+    subject do
+      KmSidekiq::AliasJob.new
+    end
+    it "should hit the KM API" do
+      timestamp = Time.now.to_i
+      subject.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
+    it "should round off any decimal in timestamp" do
+      now = Time.now
+      timestamp_float = now.to_f
+      timeStamp_int = now.to_i
+      subject.perform("identifier1", "identifier2", timestamp_float)
+      expected_api_hit = "http://trk.kissmetrics.com/a?_d=1&_k=abc123&_n=identifier2&_p=identifier1&_t=#{timeStamp_int}"
+      WebMock.should have_requested(:get, expected_api_hit)
+    end
+  end
+end

data/spec/lib/km_sidekiq/record_job_spec.rb

@@ -0,0 +1,49 @@
+$:.push File.expand_path('../../lib', __FILE__)
+require 'webmock/rspec'
+require 'km_sidekiq/record_job'
+
+describe "KmSidekiq::RecordJob" do
+  before do
+    stub_request(:any, %r{http://trk.kissmetrics.com.*})
+    KmSidekiq.configure do |config|
+      config.key = "abc123"
+    end
+  end
+  describe "perform" do
+    subject do
+      KmSidekiq::RecordJob.new
+    end
+    it "should hit the KM API" do
+      timestamp = Time.now.to_i
+      subject.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
+      subject.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 {
+        subject.perform(nil, "eventName", { :foo => 'bar', :baz => 'bay'}, timestamp)
+      }.should raise_error(KmSidekiq::Error)
+    end
+    it "should raise an error when an invalid timestamp is provided" do
+      timestamp = Time.now.to_i * 1000 # common mistake is providing milliseconds instead of seconds
+      lambda {
+        subject.perform("identifier", "eventName", { :foo => 'bar', :baz => 'bay'}, timestamp)
+      }.should raise_error(KmSidekiq::Error)
+    end
+    it "should round off any decimal in timestamp" do
+      now = Time.now
+      timestamp_float = now.to_f
+      timeStamp_int = now.to_i
+      subject.perform("identifier", "eventName", { :foo => 'bar', :baz => 'bay'}, timestamp_float)
+      expected_api_hit = "http://trk.kissmetrics.com/e?_d=1&_k=abc123&_n=eventName&_p=identifier&_t=#{timeStamp_int}&baz=bay&foo=bar"
+      WebMock.should have_requested(:get, expected_api_hit)
+    end
+  end
+end

data/spec/lib/km_sidekiq/set_job_spec.rb

@@ -0,0 +1,31 @@
+$:.push File.expand_path('../../lib', __FILE__)
+require 'webmock/rspec'
+require 'km_sidekiq/set_job'
+
+describe "KmSidekiq::SetJob" do
+  before do
+    stub_request(:any, %r{http://trk.kissmetrics.com.*})
+    KmSidekiq.configure do |config|
+      config.key = "abc123"
+    end
+  end
+  describe "perform" do
+    subject do
+      KmSidekiq::SetJob.new
+    end
+    it "should hit the KM API" do
+      timestamp = Time.now.to_i
+      subject.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
+    it "should round off any decimal in timestamp" do
+      now = Time.now
+      timestamp_float = now.to_f
+      timeStamp_int = now.to_i
+      subject.perform("identifier", { :foo => 'bar', :baz => 'bay'}, timestamp_float)
+      expected_api_hit = "http://trk.kissmetrics.com/s?_d=1&_k=abc123&_p=identifier&_t=#{timeStamp_int}&baz=bay&foo=bar"
+      WebMock.should have_requested(:get, expected_api_hit)
+    end
+  end
+end

data/spec/lib/km_sidekiq/sidekiq_spec.rb

@@ -0,0 +1,75 @@
+$:.push File.expand_path('../lib', __FILE__)
+require 'km_sidekiq'
+require 'rspec-sidekiq'
+
+describe "KmSidekiq" do
+  before do
+    Time.stub(:now => Time.now)
+    @prior_timestamp = Time.now.to_i-(60 * 60 * 24)
+    @timestamp = Time.now.to_i
+  end
+  describe "configuring" do
+    it "should capture the API key" do
+      KmSidekiq.configure do |config|
+        config.key = "foo"
+      end
+      KmSidekiq.configuration.key.should == "foo"
+    end
+  end
+  describe "alias" do
+    it "should queue an AliasJob with current time" do
+      KmSidekiq.alias("identifier1", "identifier2")
+      KmSidekiq::AliasJob.should have_enqueued_job("identifier1",
+                                              "identifier2",
+                                              @timestamp
+                                              )
+    end
+  end
+  describe "set" do
+    it "should queue a SetJob with current time" do
+      KmSidekiq.set("identifier", {:some_prop => 'some_val'})
+      KmSidekiq::SetJob.should have_enqueued_job("identifier",
+                                            {'some_prop' => 'some_val'},
+                                            @timestamp
+                                            )
+    end
+  end
+  describe "record" do
+    it "should queue a RecordJob with current time" do
+      KmSidekiq.record("identifier", "myEventName", {:some_prop => 'some_val'})
+      KmSidekiq::RecordJob.should have_enqueued_job("identifier",
+                                               "myEventName",
+                                               {'some_prop' => 'some_val'},
+                                               @timestamp
+                                               )
+    end
+  end
+  describe "alias" do
+    it "should queue an AliasJob with arbitrary timestamp" do
+      KmSidekiq.alias("identifier1", "identifier2", @prior_timestamp)
+      KmSidekiq::AliasJob.should have_enqueued_job("identifier1",
+                                              "identifier2",
+                                              @prior_timestamp
+                                              )
+    end
+  end
+  describe "set" do
+    it "should queue a SetJob with arbitrary timestamp" do
+      KmSidekiq.set("identifier", {:some_prop => 'some_val'}, @prior_timestamp)
+      KmSidekiq::SetJob.should have_enqueued_job("identifier",
+                                            {'some_prop' => 'some_val'},
+                                            @prior_timestamp
+                                            )
+    end
+  end
+  describe "record" do
+    it "should queue a RecordJob with arbitrary timestamp" do
+      KmSidekiq.record("identifier", "myEventName", {:some_prop => 'some_val'}, @prior_timestamp)
+      KmSidekiq::RecordJob.should have_enqueued_job("identifier",
+                                               "myEventName",
+                                               {'some_prop' => 'some_val'},
+                                               @prior_timestamp
+                                               )
+    end
+  end
+end

data/spec/lib/km_sidekiq_spec.rb

@@ -0,0 +1,48 @@
+$:.push File.expand_path('../lib', __FILE__)
+require 'km_sidekiq'
+require 'rspec-sidekiq'
+
+Sidekiq::Testing.fake!
+
+describe "KmSidekiq" do
+  before do
+    Time.stub(:now => Time.now)
+    @timestamp = Time.now.to_i
+  end
+  describe "configuring" do
+    it "should capture the API key" do
+      KmSidekiq.configure do |config|
+        config.key = "foo"
+      end
+      KmSidekiq.configuration.key.should == "foo"
+    end
+  end
+  describe "alias" do
+    it "should queue an AliasJob" do
+      KmSidekiq.alias("identifier1", "identifier2")
+      KmSidekiq::AliasJob.should have_enqueued_job("identifier1",
+                                              "identifier2",
+                                              @timestamp
+                                              )
+    end
+  end
+  describe "set" do
+    it "should queue an SetJob" do
+      KmSidekiq.set("identifier", {:some_prop => 'some_val'})
+      KmSidekiq::SetJob.should have_enqueued_job("identifier",
+                                            {'some_prop' => 'some_val'},
+                                            @timestamp
+                                            )
+    end
+  end
+  describe "record" do
+    it "should queue an RecordJob" do
+      KmSidekiq.record("identifier", "myEventName", {:some_prop => 'some_val'})
+      KmSidekiq::RecordJob.should have_enqueued_job("identifier",
+                                               "myEventName",
+                                               {'some_prop' => 'some_val'},
+                                               @timestamp
+                                               )
+    end
+  end
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: km_sidekiq
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Luke Melia
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec-sidekiq
+  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: webmock
+  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: Interact with the KISSMetrics API via Sidekiq
+email:
+- luke@lukemelia.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- km-sidekiq.gemspec
+- lib/km_sidekiq.rb
+- lib/km_sidekiq/alias_job.rb
+- lib/km_sidekiq/api_client.rb
+- lib/km_sidekiq/configuration.rb
+- lib/km_sidekiq/record_job.rb
+- lib/km_sidekiq/set_job.rb
+- lib/km_sidekiq/version.rb
+- spec/lib/km_sidekiq/alias_job_spec.rb
+- spec/lib/km_sidekiq/record_job_spec.rb
+- spec/lib/km_sidekiq/set_job_spec.rb
+- spec/lib/km_sidekiq/sidekiq_spec.rb
+- spec/lib/km_sidekiq_spec.rb
+homepage: https://github.com/yapplabs/km_sidekiq
+licenses: []
+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.1.10
+signing_key: 
+specification_version: 4
+summary: Interact with the KISSMetrics API via Sidekiq
+test_files:
+- spec/lib/km_sidekiq/alias_job_spec.rb
+- spec/lib/km_sidekiq/record_job_spec.rb
+- spec/lib/km_sidekiq/set_job_spec.rb
+- spec/lib/km_sidekiq/sidekiq_spec.rb
+- spec/lib/km_sidekiq_spec.rb