klaviyo 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ed68e4edade34eeb6db1de9bfe4d644b5b22f30a7e81080eb57fd7609ea05222
+  data.tar.gz: d5152cfa55ca8e4068494037a108bc4a18b9053984ccc32dea09a0510f61a73c
+SHA512:
+  metadata.gz: 25e22b0c53b0a0d8b7ec4f5c7f2441d093628c098e100a8426b2c7edb48a4f1e4113dede538c8a1883cc49c0a73fc22bc4422c612d6d1ccb635a7ff266c7071b
+  data.tar.gz: 9be13c509823d4d8c503de3b90c80c516163d0fcbd61d606da5dcc6d2db4818f202a82d924482dcf9a95bc9039bce231a75b6830129f7e694f4ee2d1876a4e87

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     = '1.1.0'
+  s.date        = '2014-09-06'
+  s.summary     = 'You heard us, a Ruby wrapper for the Klaviyo API'
+  s.description = 'Ruby wrapper for the Klaviyo API'
+  s.authors     = ['Klaviyo Team']
+  s.email       = 'hello@klaviyo.com'
+  s.files       = files
+  s.homepage = 'https://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/client.rb

@@ -0,0 +1,74 @@
+require 'open-uri'
+require 'base64'
+require 'json'
+
+module Klaviyo
+  class KlaviyoError < StandardError; end
+
+  class Client
+    def initialize(api_key, url = 'http://a.klaviyo.com/')
+      @api_key = api_key
+      @url = url
+    end
+
+    def track(event, kwargs = {})
+      defaults = {:id => nil, :email => nil, :properties => {}, :customer_properties => {}, :time => nil}
+      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 = {
+        :token => @api_key,
+        :event => event,
+        :properties => kwargs[:properties],
+        :customer_properties => customer_properties,
+        :ip => ''
+      }
+      params[:time] = kwargs[:time].to_time.to_i if kwargs[:time]
+
+      params = build_params(params)
+      request('api/track', params)
+    end
+
+    def track_once(event, opts = {})
+      opts.update('__track_once__' => true)
+      track(event, opts)
+    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('api/identify', params)
+    end
+
+    private
+
+    def build_params(params)
+      "data=#{CGI.escape Base64.encode64(JSON.generate(params)).gsub(/\n/,'')}"
+    end
+
+    def request(path, params)
+      url = "#{@url}#{path}?#{params}"
+      open(url).read == '1'
+    end
+  end
+end

data/lib/klaviyo.rb

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

data/lib/rack/klaviyo.rb

@@ -0,0 +1,67 @@
+module Rack
+  class Klaviyo
+    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/analytics/analytics.js';
+          var a = document.getElementsByTagName('script')[0]; a.parentNode.insertBefore(b, a);
+        })();
+      </script>
+      EOT
+    end
+  end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: klaviyo
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+platform: ruby
+authors:
+- Klaviyo Team
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: escape
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby wrapper for the Klaviyo API
+email: hello@klaviyo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- klaviyo.gemspec
+- lib/klaviyo.rb
+- lib/klaviyo/client.rb
+- lib/rack/klaviyo.rb
+homepage: https://www.klaviyo.com/
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: You heard us, a Ruby wrapper for the Klaviyo API
+test_files: []