delayable_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/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+## v0.0.1: 2012/01/24
+
+* Wrote initial methods and documentation for instantiating a
+  KISSmetrics API client and recording events, aliasing identifiers, and
+  setting properties

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Nicholas Firth-McCoy
+
+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,48 @@
+# delayable_km
+
+`delayable_km` is a minimal implementation of the [KISSmetrics](http://www.kissmetrics.com/) API that can be used with `delayed_job`.
+
+The [official KISSmetrics gem](https://github.com/kissmetrics/km) is written is incompatible with `delayed_job`. They instead use a [cron based](http://support.kissmetrics.com/apis/cron) method to asynchronously send data to KISSmetrics.
+
+I'd prefer to use `delayed_job`, hence the gem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'delayable_km'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install delayable_km
+
+## Usage
+
+This gem is used in a similar way to the [official gem](https://github.com/kissmetrics/km), but it requires that you instantiate an API client:
+
+    # Official km gem approach:
+    KM.initialize(your_api_key)
+    KM.identify(current_user.email)
+    KM.record('some event')
+
+    # delayable_km approach:
+    @km ||= KM.initialize(your_api_key)
+    @km.identify(current_user.email)
+    @km.record(event, optional_properties)
+
+As a result, it can be used with `delayed_job`:
+
+    # Will be added to your queue of jobs for delayed_job to run
+    @km.delay.record(event, optional_properties)
+
+## 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

data/Rakefile

@@ -0,0 +1,26 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+
+# Define a task to make sure the gem's files are world readable.
+task :set_permissions do
+  system("find . -type f -exec chmod 644 {} \\;")
+  system("find . -type d -exec chmod 755 {} \\;")
+end
+
+# Add :set_permissions as a dependency for the :build, :install, and :release
+# tasks that bundler provides, so that the correct permissions are always set.
+task :build => :set_permissions
+task :install => :set_permissions
+task :release => :set_permissions
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new('spec')
+
+  require 'yard'
+  YARD::Rake::YardocTask.new(:yard)
+rescue LoadError
+  abort "You need to install the gem's development dependencies. Run `bundle install`."
+end
+
+task :default => :spec

data/delayable_km.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/delayable_km/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Nicholas Firth-McCoy"]
+  gem.email         = ["nicholas@2suggestions.com.au"]
+  gem.summary       = %q{A minimal wrapper for the KISSmetrics API that can be used with delayed_job}
+  gem.homepage      = "https://github.com/nfm/delayable_km"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "delayable_km"
+  gem.require_paths = ["lib"]
+  gem.version       = DelayableKm::VERSION
+
+  gem.required_rubygems_version = '>= 1.3.6'
+  gem.add_runtime_dependency 'httparty'
+
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'webmock'
+  gem.add_development_dependency 'simplecov'
+  gem.add_development_dependency 'yard'
+end

data/lib/delayable_km.rb

@@ -0,0 +1,12 @@
+require "delayable_km/version"
+
+# delayable_km: A minimal wrapper for the KISSmetrics API that can be used with delayed_job
+#
+# @see https://github.com/kissmetrics/km The official KISSmetrics Ruby gem: km
+# @see http://support.kissmetrics.com/apis/specifications The official KISSmetrics API specification
+# @see http://support.kissmetrics.com/apis/api-tips Tips for using the KISSmetrics API
+# @see http://support.kissmetrics.com/apis/common-methods Commonly used API calls
+# @see http://support.kissmetrics.com/apis/ruby-specific#basic-rails-integration Tips for integrating the KISSmetrics Ruby and Javascript APIs with Rails
+module DelayableKm
+  require 'delayable_km/km'
+end

data/lib/delayable_km/km.rb

@@ -0,0 +1,61 @@
+# The main delayable_km class, containing methods for initializing a KISSmetrics API client and making API calls
+class KM
+  # The default KISSmetrics API endpoint that all requests are sent to
+  DEFAULT_API_ENDPOINT = 'http://trk.kissmetrics.com'
+
+  # Create a KISSmetrics API client.
+  #
+  # @param [String] :api_key Your site's KISSmetrics API key
+  def initialize(api_key, options = {})
+    @api_key = api_key
+    @api_endpoint = DEFAULT_API_ENDPOINT
+  end
+
+  # Set the identity of a person using your site
+  # @see http://support.kissmetrics.com/apis/common-methods#identify
+  #
+  # @param [String] :id A unique identifier for a person (email address, user id, or login are common choices)
+  def identify(id)
+    @id = id
+  end
+
+  # Record a KISSmetrics event
+  # @see http://support.kissmetrics.com/apis/common-methods#record
+  #
+  # @param [String] event
+  # @param [Hash] params
+  # @option options [String] :_p (@id) The identity of the person you are setting properties on. You can also set this by calling #identify.
+  def record(event, params = {})
+    defaults = { :_n => event, :_p => @id }
+    params = defaults.merge(params)
+    request('e', params)
+  end
+
+  # Associate one KISSmetrics identity with another
+  # @see http://support.kissmetrics.com/apis/common-methods#alias
+  # @note The order of arguments to this method doesn't actually matter. You can call it with the existing identifier first or second.
+  #
+  # @param [String] name An existing identifier for a user
+  # @param [String] alias_to A new identifier to associate with the user
+  def alias(name, alias_to)
+    params = { :_n => alias_to, :_p => name }
+    request('a', params)
+  end
+
+  # Set properties on a person without recording a named event
+  # @see http://support.kissmetrics.com/apis/common-methods#set
+  #
+  # @param [Hash] params An arbitrary hash of properties to associate with a person
+  # @option options [String] :_p (@id) The identity of the person you are setting properties on. You can also set this by calling #identify.
+  def set(params)
+    defaults = { :_p => @id }
+    params = defaults.merge(params)
+    request('s', params)
+  end
+
+private
+  def request(path, params)
+    params = { :_t => Time.now.utc.to_i.to_s, :_d => 1, :_k => @api_key }.merge(params)
+    HTTParty.get("#{@api_endpoint}/#{path}", :query => params)
+  end
+end

data/lib/delayable_km/version.rb

@@ -0,0 +1,5 @@
+module DelayableKm
+  # The version of delayable_km that you're using. delayable_km is versioned using semantic versioning.
+  # @see http://semver.org/
+  VERSION = "0.0.1"
+end

data/spec/delayable_km/km_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe KM do
+  describe '.record' do
+    pending
+  end
+
+  describe '.alias' do
+    pending
+  end
+
+  describe '.set' do
+    pending
+  end
+end

data/spec/delayable_km_spec.rb

@@ -0,0 +1 @@
+require 'spec_helper'

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'simplecov'
+SimpleCov.start
+
+require 'rspec'
+require 'webmock/rspec'
+
+require 'delayable_km'

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: delayable_km
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Nicholas Firth-McCoy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: &23060740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *23060740
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &23060240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *23060240
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: &23059700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *23059700
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &23059160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *23059160
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &23058500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *23058500
+description: 
+email:
+- nicholas@2suggestions.com.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- delayable_km.gemspec
+- lib/delayable_km.rb
+- lib/delayable_km/km.rb
+- lib/delayable_km/version.rb
+- spec/delayable_km/km_spec.rb
+- spec/delayable_km_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/nfm/delayable_km
+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: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: A minimal wrapper for the KISSmetrics API that can be used with delayed_job
+test_files: []
+has_rdoc: