klaviyo 0.9.3 → 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4761ff7c9edac6dd8dec7efd826f0b9a903022ced70b8938d9db3adfdc9f16ac
+  data.tar.gz: f9bca9ccb221bf7a30387a60e4fde3f6adba9e814702266fc0b869c5c470046b
+SHA512:
+  metadata.gz: 0da39baf09b301c7df78833d2a9d62bc8f72b2512c06b4c67ca247a863f72d4563512915037ad80aff05168cb41d3830dbec56b3e2bda3605d7a8f1b7826baf4
+  data.tar.gz: d555098395599b4e1b9c725f815229949e0c208c00d0b387fcc00ac3071763d5aef830e3cf5316f71e7f84900e950bad27757370ab5a0b810f07a05e519541e0

data/klaviyo.gemspec

@@ -2,17 +2,17 @@ files = ['klaviyo.gemspec', '{lib}/**/*'].map {|f| Dir[f]}.flatten
 
 Gem::Specification.new do |s|
   s.name        = 'klaviyo'
-  s.version     = '0.9.3'
-  s.date        = '2012-09-03'
+  s.version     = '1.2.0'
+  s.date        = '2020-09-28'
   s.summary     = 'You heard us, a Ruby wrapper for the Klaviyo API'
   s.description = 'Ruby wrapper for the Klaviyo API'
-  s.authors     = ['Andrew Bialecki']
-  s.email       = 'andrew@klaviyo.com'
+  s.authors     = ['Klaviyo Team']
+  s.email       = 'hello@klaviyo.com'
   s.files       = files
-  s.homepage = 'http://www.klaviyo.com/'
+  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
+end

data/lib/klaviyo/client.rb

@@ -1,53 +1,57 @@
 require 'open-uri'
 require 'base64'
 require 'json'
-require 'klaviyo/client/middleware'
 
 module Klaviyo
   class KlaviyoError < StandardError; end
-  
+
   class Client
-    def initialize(api_key, url = 'http://a.klaviyo.com/')
+    VERSION = '1.2.0'
+    KL_USER_AGENT = "Ruby_Klaviyo/#{VERSION}"
+
+    def initialize(api_key, url = 'https://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 = build_params({
+
+      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]
-      request('crm/api/track', params)
+
+      params = build_params(params)
+      request('api/track', params)
     end
-    
-    def track_once(event, customer_properties = {}, properties = {})
-      properties.update('__track_once__' => true)
-      track(event, email, id, properties, customer_properties)
+
+    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?
@@ -56,18 +60,18 @@ module Klaviyo
         :token => @api_key,
         :properties => properties
       })
-      request('crm/api/identify', params)
+      request('api/identify', params)
     end
 
     private
-    
+
     def build_params(params)
-      'data=' + Base64.encode64(JSON.generate(params)).gsub(/\n/,'')
+      "data=#{CGI.escape Base64.encode64(JSON.generate(params)).gsub(/\n/,'')}"
     end
-    
+
     def request(path, params)
-        url = @url + path + '?' + params
-        open(url).read == '1' ? true : false
+      url = "#{@url}#{path}?#{params}"
+      open(url, 'User-Agent' => KL_USER_AGENT).read == '1'
     end
   end
 end

data/lib/klaviyo.rb

@@ -1 +1 @@
-require 'klaviyo/client'
+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

@@ -1,96 +1,87 @@
 --- !ruby/object:Gem::Specification
 name: klaviyo
 version: !ruby/object:Gem::Version
-  version: 0.9.3
-  prerelease: 
+  version: 1.2.0
 platform: ruby
 authors:
-- Andrew Bialecki
+- Klaviyo Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-03 00:00:00.000000000 Z
+date: 2020-09-28 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: Ruby wrapper for the Klaviyo API
-email: andrew@klaviyo.com
+email: hello@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/
+- 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
-  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
+rubygems_version: 3.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: You heard us, a Ruby wrapper for the Klaviyo API
 test_files: []

data/lib/klaviyo/client/middleware.rb

@@ -1,72 +0,0 @@
-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