klaviyo 2.0.6 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c50780aa07007d13ffcbfd5e88692dc46122641627511be21f4988012d48d20e
-  data.tar.gz: 453757a911094db7394000a2aa59d4a0f31a3cb6aa9196e50a749dac3e51b336
+  metadata.gz: 637b6125081b06c6f8121a331e4bfaef0976a5293496a3f9fe5aaed3b8b96afc
+  data.tar.gz: 420103a5fec88c53524eeeeaf32826424feb3fe5bd4146b4127fc71059319512
 SHA512:
-  metadata.gz: 62278b5560afe418dc8658e71646f36905cdb10c2b607b923377ea08c8ea247630fc782c6dbceda1d4fe2a88f5f332995abce6dcf90484cfbc1791516d4b6cd3
-  data.tar.gz: 1358f2f45b1e92144f8a43f0f52a291f3ee859af3e416924e003a1b7c7a02553965d6240fecf8289eb41167c422565c8909b57344b8baed9091c6f022801183b
+  metadata.gz: 15ca790911f3306253271f36fe7e15da7c2e042a3a25614217aab530d52c4bfcfdf4cd675cd1bf4f761d7e4b9b126c07b87681def392daf9514d5ab072f016e2
+  data.tar.gz: 4eca152856c1ce76571c0745a6d437ed8ccea93e6fbf057f35d81771c80c11219f20198fb52cf561447554a939e8eea65fa0c2db041c54f426c7b70270d73a10

data/klaviyo.gemspec

@@ -2,8 +2,8 @@ files = ['klaviyo.gemspec', '{lib}/**/**/*'].map {|f| Dir[f]}.flatten
 
 Gem::Specification.new do |s|
   s.name        = 'klaviyo'
-  s.version     = '2.0.6'
-  s.date        = '2021-04-08'
+  s.version     = '2.1.0'
+  s.date        = '2021-10-01'
   s.summary     = 'You heard us, a Ruby wrapper for the Klaviyo API'
   s.description = 'Ruby wrapper for the Klaviyo API'
   s.authors     = ['Klaviyo Team']

data/lib/klaviyo/apis/data_privacy.rb

@@ -2,7 +2,7 @@ module Klaviyo
   class DataPrivacy < Client
     DATA_PRIVACY = 'data-privacy'
     DELETION_REQUEST = 'deletion-request'
-    
+
     # Submits a data privacy-related deletion request
     # @param id_type [String] 'email' or 'phone_number' or 'person_id
     # @param identifier [String] value for the identifier specified
@@ -11,9 +11,9 @@ module Klaviyo
       unless ['email', 'phone_number', 'person_id'].include? id_type
         raise Klaviyo::KlaviyoError.new(INVALID_ID_TYPE_ERROR)
       end
-      identifier = { id_type => identifier }      
+      data = Hash[id_type.to_sym, identifier]
       path = "#{DATA_PRIVACY}/#{DELETION_REQUEST}"
-      v2_request(HTTP_POST, path, identifier)
+      v2_request(HTTP_POST, path, **data)
     end
   end
 end

data/lib/klaviyo/apis/email_templates.rb

@@ -37,7 +37,7 @@ module Klaviyo
         name: name,
         html: html
       }
-      v1_request(HTTP_PUT, path, params)
+      v1_request(HTTP_PUT, path, **params)
     end
 
     # Deletes a given template.

data/lib/klaviyo/apis/lists.rb

@@ -14,7 +14,7 @@ module Klaviyo
       body = {
         :list_name => list_name
       }
-      v2_request(HTTP_POST, LISTS, body)
+      v2_request(HTTP_POST, LISTS, **body)
     end
 
     # Retrieves all the lists in the Klaviyo account
@@ -40,7 +40,7 @@ module Klaviyo
       body = {
         :list_name => list_name
       }
-      v2_request(HTTP_PUT, path, body)
+      v2_request(HTTP_PUT, path, **body)
     end
 
     # Deletes a list
@@ -65,7 +65,7 @@ module Klaviyo
         :phone_numbers => phone_numbers,
         :push_tokens => push_tokens
       }
-      v2_request(HTTP_GET, path, params)
+      v2_request(HTTP_GET, path, **params)
     end
 
     # Subscribe profiles to a list.
@@ -80,7 +80,7 @@ module Klaviyo
       params = {
         :profiles => profiles
       }
-      v2_request(HTTP_POST, path, params)
+      v2_request(HTTP_POST, path, **params)
     end
 
     # Unsubscribe and remove profiles from a list
@@ -92,7 +92,7 @@ module Klaviyo
       params = {
         :emails => emails
       }
-      v2_request(HTTP_DELETE, path, params)
+      v2_request(HTTP_DELETE, path, **params)
     end
 
     # Add profiles to a list
@@ -106,7 +106,7 @@ module Klaviyo
       params = {
         :profiles => profiles
       }
-      v2_request(HTTP_POST, path, params)
+      v2_request(HTTP_POST, path, **params)
     end
 
     # Check if profiles are on a list
@@ -123,7 +123,7 @@ module Klaviyo
         :phone_numbers => phone_numbers,
         :push_tokens => push_tokens
       }
-      v2_request(HTTP_GET, path, params)
+      v2_request(HTTP_GET, path, **params)
     end
 
     # Remove profiles from a list
@@ -139,7 +139,7 @@ module Klaviyo
         :phone_numbers => phone_numbers,
         :push_tokens => push_tokens
       }
-      v2_request(HTTP_DELETE, path, params)
+      v2_request(HTTP_DELETE, path, **params)
     end
 
     # Get all emails, phone numbers, along with reasons for list exclusion
@@ -151,7 +151,7 @@ module Klaviyo
       params = {
         :marker => marker
       }
-      v2_request(HTTP_GET, path, params)
+      v2_request(HTTP_GET, path, **params)
     end
 
     # Get all of the emails, phone numbers, and push tokens for profiles in a given list or segment

data/lib/klaviyo/apis/metrics.rb

@@ -11,7 +11,7 @@ module Klaviyo
         :page => page,
         :count => count
       }
-      v1_request(HTTP_GET, METRICS, params)
+      v1_request(HTTP_GET, METRICS, **params)
     end
 
     # Returns a batched timeline of all events in your Klaviyo account.
@@ -26,7 +26,7 @@ module Klaviyo
         :count => count,
         :sort => sort
       }
-      v1_request(HTTP_GET, path, params)
+      v1_request(HTTP_GET, path, **params)
     end
 
     # Returns a batched timeline for one specific type of metric.
@@ -42,7 +42,7 @@ module Klaviyo
         :count => count,
         :sort => sort
       }
-      v1_request(HTTP_GET, path, params)
+      v1_request(HTTP_GET, path, **params)
     end
 
     # Export event data, optionally filtering and segmented on available event properties
@@ -74,7 +74,7 @@ module Klaviyo
         :by => by,
         :count => count
       }
-      v1_request(HTTP_GET, path, params)
+      v1_request(HTTP_GET, path, **params)
     end
   end
 end

data/lib/klaviyo/apis/profiles.rb

@@ -12,7 +12,7 @@ module Klaviyo
       params = {
         :email => email
       }
-      v2_request(HTTP_GET, path, params)
+      v2_request(HTTP_GET, path, **params)
     end
 
     # Retrieve all the data attributes for a Klaviyo Person ID.
@@ -29,7 +29,7 @@ module Klaviyo
     # @return returns the updated person object
     def self.update_person_attributes(person_id, kwargs = {})
       path = "#{PERSON}/#{person_id}"
-      v1_request(HTTP_PUT, path, kwargs)
+      v1_request(HTTP_PUT, path, **kwargs)
     end
 
     # Listing a person's event timeline
@@ -45,7 +45,7 @@ module Klaviyo
         :count => count,
         :sort => sort
       }
-      v1_request(HTTP_GET, path, params)
+      v1_request(HTTP_GET, path, **params)
     end
 
     # Listing a person's event timeline for a particular metric
@@ -62,7 +62,7 @@ module Klaviyo
         :count => count,
         :sort => sort
       }
-      v1_request(HTTP_GET, path, params)
+      v1_request(HTTP_GET, path, **params)
     end
   end
 end

data/lib/klaviyo/apis/public.rb

@@ -4,12 +4,15 @@ module Klaviyo
     #
     # @kwarg :id [String] the customer or profile id
     # @kwarg :email [String] the customer or profile email
+    # @kwarg :phone_number [String] the customer or profile phone number
     # @kwarg :properties [Hash] properties of the profile to add or update
+    # @kwargs :method [String] the HTTP method to use for the request. Accepts 'get' or 'post'.  Defaults to 'get'.
     def self.identify(kwargs = {})
       defaults = {:id => nil,
                   :email => nil,
                   :phone_number => nil,
-                  :properties => {}
+                  :properties => {},
+                  :method => HTTP_GET
                  }
       kwargs = defaults.merge(kwargs)
 
@@ -27,7 +30,7 @@ module Klaviyo
         :properties => properties
       }
 
-      public_request(HTTP_GET, 'identify', params)
+      public_request(kwargs[:method], 'identify', **params)
     end
 
     # Used for tracking events and customer behaviors
@@ -39,6 +42,7 @@ module Klaviyo
     # @kwarg :properties [Hash] properties of the event
     # @kwargs :customer_properties [Hash] properties of the customer or profile
     # @kwargs :time [Integer] timestamp of the event
+    # @kwargs :method [String] the HTTP method to use for the request. Accepts 'get' or 'post'.  Defaults to 'get'.
     def self.track(event, kwargs = {})
       defaults = {
         :id => nil,
@@ -46,7 +50,8 @@ module Klaviyo
         :phone_number => nil,
         :properties => {},
         :customer_properties => {},
-        :time => nil
+        :time => nil,
+        :method => HTTP_GET
       }
 
       kwargs = defaults.merge(kwargs)
@@ -68,7 +73,7 @@ module Klaviyo
       }
       params[:time] = kwargs[:time] if kwargs[:time]
 
-      public_request(HTTP_GET, 'track', **params)
+      public_request(kwargs[:method], 'track', **params)
     end
 
     def self.track_once(event, kwargs = {})

data/lib/klaviyo/client.rb

@@ -4,6 +4,9 @@ module Klaviyo
     V1_API = 'v1'
     V2_API = 'v2'
 
+    KL_VERSION = '2.1.0'
+    KL_USER_AGENT = "Ruby_Klaviyo/#{KL_VERSION}"
+
     HTTP_DELETE = 'delete'
     HTTP_GET = 'get'
     HTTP_POST = 'post'
@@ -29,7 +32,8 @@ module Klaviyo
       connection = Faraday.new(
         url: url,
         headers: {
-          'Content-Type' => content_type
+          'Content-Type' => content_type,
+          'User-Agent' => KL_USER_AGENT
       })
       if content_type == CONTENT_JSON
         kwargs[:body] = kwargs[:body].to_json
@@ -40,10 +44,22 @@ module Klaviyo
     end
 
     def self.public_request(method, path, **kwargs)
-      check_public_api_key_exists()
-      params = build_params(kwargs)
-      url = "#{BASE_API_URL}/#{path}?#{params}"
-      res = Faraday.get(url).body
+      check_public_api_key_is_valid()
+      if method == HTTP_GET
+        params = build_params(kwargs)
+        url = "#{BASE_API_URL}/#{path}?#{params}"
+        res = Faraday.get(url, {}, { 'User-Agent' => KL_USER_AGENT }).body
+      elsif method == HTTP_POST
+        url = URI("#{BASE_API_URL}/#{path}")
+        response = Faraday.post(url) do |req|
+          req.headers['Content-Type'] = CONTENT_URL_FORM
+          req.headers['Accept'] = 'text/html'
+          req.headers['User-Agent'] = KL_USER_AGENT
+          req.body = {data: "#{kwargs.to_json}"}
+        end
+      else
+        raise KlaviyoError.new(INVALID_HTTP_METHOD)
+      end
     end
 
     def self.v1_request(method, path, content_type: CONTENT_JSON, **kwargs)
@@ -55,7 +71,7 @@ module Klaviyo
         }
         data[:body] = data[:body].merge(kwargs[:params])
         full_url = "#{V1_API}/#{path}"
-        request(method, full_url, content_type, data)
+        request(method, full_url, content_type, **data)
       else
         defaults = {:page => nil,
                     :count => nil,
@@ -75,7 +91,7 @@ module Klaviyo
       }
       data = {}
       data[:body] = key.merge(kwargs)
-      request(method, path, CONTENT_JSON, data)
+      request(method, path, CONTENT_JSON, **data)
     end
 
     def self.build_params(params)
@@ -96,10 +112,15 @@ module Klaviyo
       end
     end
 
-    def self.check_public_api_key_exists()
+    def self.check_public_api_key_is_valid()
       if !Klaviyo.public_api_key
         raise KlaviyoError.new(NO_PUBLIC_API_KEY_ERROR)
       end
+      if ( Klaviyo.public_api_key =~ /pk_\w{34}$/ ) == 0
+        warn(PRIVATE_KEY_AS_PUBLIC)
+      elsif ( Klaviyo.public_api_key =~ /\w{6}$/ ) != 0
+        raise KlaviyoError.new(INCORRECT_PUBLIC_API_KEY_LENGTH)
+      end
     end
 
     def self.encode_params(kwargs)

data/lib/klaviyo/klaviyo_module.rb

@@ -24,4 +24,7 @@ module Klaviyo
   NO_PUBLIC_API_KEY_ERROR = 'Please provide your Public API key for this request'
   REQUIRED_ARG_ERROR = 'You must identify a user by email, ID or phone_number'
   INVALID_ID_TYPE_ERROR = 'Invalid id_type provided, must be one of: email, phone_number, person_id'
+  PRIVATE_KEY_AS_PUBLIC = 'Private API key added in place of Public API key'
+  INCORRECT_PUBLIC_API_KEY_LENGTH = 'Public API Key must be 6 characters'
+  INVALID_HTTP_METHOD = 'Invalid HTTP method present, please use "get" or "post"'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: klaviyo
 version: !ruby/object:Gem::Version
-  version: 2.0.6
+  version: 2.1.0
 platform: ruby
 authors:
 - Klaviyo Team
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-08 00:00:00.000000000 Z
+date: 2021-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -87,7 +87,7 @@ files:
 homepage: https://www.klaviyo.com/
 licenses: []
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -102,8 +102,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
-signing_key:
+rubygems_version: 3.0.3
+signing_key: 
 specification_version: 4
 summary: You heard us, a Ruby wrapper for the Klaviyo API
 test_files: []