klaviyo 0.9.0

data/klaviyo.gemspec

@@ -0,0 +1,18 @@
+files = ['klaviyo.gemspec', '{lib}/**/*'].map {|f| Dir[f]}.flatten
+
+Gem::Specification.new do |s|
+  s.name        = 'klaviyo'
+  s.version     = '0.9.0'
+  s.date        = '2012-07-10'
+  s.summary     = 'Ruby wrapper for the Klaviyo API'
+  s.description = 'You heard us, a Ruby wrapper for the Klaviyo API'
+  s.authors     = ['Andrew Bialecki']
+  s.email       = 'andrew@klaviyo.com'
+  s.files       = files
+  s.homepage = 'http://www.klaviyo.com/'
+  s.require_path = 'lib'
+  s.has_rdoc    = false
+  s.add_dependency 'json'
+  s.add_dependency 'rack'
+  s.add_dependency 'escape'
+end

data/lib/klaviyo.rb

@@ -0,0 +1 @@
+require 'klaviyo/client'

data/lib/klaviyo/client.rb

@@ -0,0 +1,73 @@
+require 'open-uri'
+require 'base64'
+require 'json'
+require 'klaviyo/client/middleware'
+
+module Klaviyo
+  class KlaviyoError < StandardError; end
+  
+  class Client
+    def initialize(api_key, env, url = 'http://a.klaviyo.com/')
+      @api_key = api_key
+      @env = env
+      @url = url
+    end
+    
+    def track(event, kwargs = {})
+      defaults = {:id => nil, :email => nil, :properties => {}, :customer_properties => {}}
+      kwargs = defaults.merge(kwargs)
+      
+      if kwargs[:email].to_s.empty? and kwargs[:id].to_s.empty?
+        raise KlaviyoError.new('You must identify a user by email or ID')
+      end
+      
+      customer_properties = kwargs[:customer_properties]
+      customer_properties[:email] = kwargs[:email] unless kwargs[:email].to_s.empty?
+      customer_properties[:id] = kwargs[:id] unless kwargs[:id].to_s.empty?
+      
+      params = build_params({
+        :token => @api_key,
+        :event => event,
+        :properties => kwargs[:properties],
+        :customer_properties => customer_properties,
+        :ip => ''
+      })
+      request('crm/api/track', params)
+    end
+    
+    def track_once(event, customer_properties = {}, properties = {})
+      properties.update('__track_once__' => true)
+      track(event, email, id, properties, customer_properties)
+    end
+    
+    def identify(kwargs = {})
+      defaults = {:id => nil, :email => nil, :properties => {}}
+      kwargs = defaults.merge(kwargs)
+      
+      if kwargs[:email].to_s.empty? and kwargs[:id].to_s.empty?
+        raise KlaviyoError.new('You must identify a user by email or ID')
+      end
+      
+      properties = kwargs[:properties]
+      properties[:email] = kwargs[:email] unless kwargs[:email].to_s.empty?
+      properties[:id] = kwargs[:id] unless kwargs[:id].to_s.empty?
+
+      params = build_params({
+        :token => @api_key,
+        :properties => properties
+      })
+      request('crm/api/identify', params)
+    end
+
+    private
+    
+    def build_params(params)
+      'data=' + Base64.encode64(JSON.generate(params)).gsub(/\n/,'')
+    end
+    
+    def request(path, params)
+        url = @url + path + '?' + params
+        open(url).read == '1' ? true : false
+    end
+  end
+end

data/lib/klaviyo/client/middleware.rb

@@ -0,0 +1,72 @@
+require 'rack'
+
+module Klaviyo
+  class Client
+    class Middleware
+      def initialize(app, api_key, options={})
+        @app = app
+        @api_key = api_key
+        @options = {
+          :insert_js_last => true
+        }.merge(options)
+      end
+
+      def call(env)
+        @env = env
+
+        @status, @headers, @response = @app.call(env)
+
+        if is_trackable_response?
+          update_response!
+          update_content_length!
+        end
+
+        [@status, @headers, @response]
+      end
+
+      private
+
+      def update_response!
+        @response.each do |part|
+          insert_at = part.index(@options[:insert_js_last] ? '</body' : '</head')
+          unless insert_at.nil?
+            part.insert(insert_at, render_script)
+          end
+        end
+      end
+
+      def update_content_length!
+        new_size = 0
+        @response.each{|part| new_size += part.bytesize}
+        @headers.merge!('Content-Length' => new_size.to_s)
+      end
+
+      def is_ajax_request?
+        @env.has_key?('HTTP_X_REQUESTED_WITH') && @env['HTTP_X_REQUESTED_WITH'] == 'XMLHttpRequest'
+      end
+
+      def is_html_response?
+        @headers['Content-Type'].include?('text/html') if @headers.has_key?('Content-Type')
+      end
+
+      def is_trackable_response?
+        is_html_response? && !is_ajax_request?
+      end
+
+      def render_script
+          <<-EOT
+        <script text="text/javascript">
+          var _learnq = _learnq || [];
+          _learnq.push(['account', '#{@api_key}']);
+
+          (function () {
+            var b = document.createElement('script'); b.type = 'text/javascript'; b.async = true;
+            b.src = ('https:' == document.location.protocol ? 'https://' : 'http://') + 'a.klaviyo.com/media/js/learnmarklet.js';
+            var a = document.getElementsByTagName('script')[0]; a.parentNode.insertBefore(b, a);
+          })();
+        </script>
+          EOT
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: klaviyo
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+  prerelease: 
+platform: ruby
+authors:
+- Andrew Bialecki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: escape
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: You heard us, a Ruby wrapper for the Klaviyo API
+email: andrew@klaviyo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- klaviyo.gemspec
+- lib/klaviyo/client/middleware.rb
+- lib/klaviyo/client.rb
+- lib/klaviyo.rb
+homepage: http://www.klaviyo.com/
+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.24
+signing_key: 
+specification_version: 3
+summary: Ruby wrapper for the Klaviyo API
+test_files: []