klaviyo 2.0.8 → 2.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b02aaf0e72a06b6d2bf999e9279a8b6c20c0f4f7652275fea1981ea0ab0683c5
-  data.tar.gz: 4b2ac021105853944c5bdbf47efa268addda7b1006f2683be04cadefb4db7ecc
+  metadata.gz: f20097f9b9538503cc8f541dd7e6d71c6c70904e51fdd59f636670f56d0b53c5
+  data.tar.gz: 98032c0e8a4ac60b16501495b71d35ce09bd28bd62fce4c49392448929555ffa
 SHA512:
-  metadata.gz: 561d598fa79624b0a2e271efb64676d55f39f09ca4ee787097061006f865f08f14d12faa49da7eea2a28523c3c0d96ed727feff2b40924b3965b1b1b234fb727
-  data.tar.gz: 934fe573a195fa8e307fc1c4383f810965d0b2636e81d8a442ece9c5b613ddef4d3eb3a1d5a159a82328edbb12cd0c87ab071a27ce5d7d57f2e8d7060a29433b
+  metadata.gz: e4f99398385906828f37a4e1f25f05ca76493a905d526177da2cc189301fba84adc76551711213c85003337b0278d0cade9c8ba52e0c0726176465fd2c8132cd
+  data.tar.gz: e109724a853cbf44a3546298fdfc04037a9cfb748b72a3edd96fab1475e209a3ea67c697ce940ff54d6aac57120f37aa853076398c016995b1b4b11f70279694

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.8'
-  s.date        = '2021-04-28'
+  s.version     = '2.0.9'
+  s.date        = '2021-07-30'
   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/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

@@ -40,10 +40,21 @@ 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).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.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)
@@ -96,10 +107,16 @@ 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
+        raise KlaviyoError.new(PRIVATE_KEY_AS_PUBLIC)
+      end
+      if ( 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.8
+  version: 2.0.9
 platform: ruby
 authors:
 - Klaviyo Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-28 00:00:00.000000000 Z
+date: 2021-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json