klaviyo 1.0.0 → 2.0.2

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: b500c9a9b23a831e8dbd4973b10e86420af64d70
4
- data.tar.gz: 75585569e42545281d0622a40c5f888f261d6622
2
+ SHA256:
3
+ metadata.gz: 2b799e59210fdba2f42e88c903a4194f826590309e50650cbf360016bb0fd14e
4
+ data.tar.gz: df417c927034075c4894d2c186bc4f5a50ca2e26ed3e825a659adbd73f6524e6
5
5
  SHA512:
6
- metadata.gz: eecb6c11c4b4a893271f914db129724362ae6d74d5950ef79b5aa90e83939ea6c937af40122768b2e1f409640cef72587e19bfc3af05b1fda9dc33c4b46c3c20
7
- data.tar.gz: 98d0566c1c134ea9ab32c0968927019d0231532aeeb72a86e432aeef60a4314f54dd12450269d9dc0762a373feef0b15dfdba8a68b2ef387fe8ce29c9576ff39
6
+ metadata.gz: 1ef1843515b936f2fd60b91dbd3d3cdaea780b56b49379134c04211c4609ad12ad1a296225fe576418bd93f0a437d88ec212c8b3f02fc6aa5289b5e39db7d5b1
7
+ data.tar.gz: e77f951331a55720f0f8f38a01d7ce51707f4cf316cd3eeeabc64739090ef1a41e5387e84b831bf703f3e19004bf35ec91d3b5e3e624bc94cec23fb4b1b6646f
@@ -1,18 +1,18 @@
1
- files = ['klaviyo.gemspec', '{lib}/**/*'].map {|f| Dir[f]}.flatten
1
+ files = ['klaviyo.gemspec', '{lib}/**/**/*'].map {|f| Dir[f]}.flatten
2
2
 
3
3
  Gem::Specification.new do |s|
4
4
  s.name = 'klaviyo'
5
- s.version = '1.0.0'
6
- s.date = '2014-09-06'
5
+ s.version = '2.0.2'
6
+ s.date = '2020-12-28'
7
7
  s.summary = 'You heard us, a Ruby wrapper for the Klaviyo API'
8
8
  s.description = 'Ruby wrapper for the Klaviyo API'
9
9
  s.authors = ['Klaviyo Team']
10
- s.email = 'hello@klaviyo.com'
10
+ s.email = 'libraries@klaviyo.com'
11
11
  s.files = files
12
12
  s.homepage = 'https://www.klaviyo.com/'
13
13
  s.require_path = 'lib'
14
- s.has_rdoc = false
15
14
  s.add_dependency 'json'
16
15
  s.add_dependency 'rack'
17
16
  s.add_dependency 'escape'
18
- end
17
+ s.add_dependency 'faraday'
18
+ end
@@ -1 +1 @@
1
- require 'klaviyo/client'
1
+ require 'klaviyo/klaviyo_module'
@@ -0,0 +1,166 @@
1
+ module Klaviyo
2
+ class Lists < Client
3
+ EXCLUSIONS = 'exclusions'
4
+ GROUP = 'group'
5
+ LIST = 'list'
6
+ LISTS = 'lists'
7
+ MEMBERS = 'members'
8
+ SUBSCRIBE = 'subscribe'
9
+
10
+ # Creates a new list
11
+ # @param list_name [String] the list name
12
+ # @return will return with HTTP OK on success
13
+ def self.create_list(list_name)
14
+ body = {
15
+ :list_name => list_name
16
+ }
17
+ v2_request(HTTP_POST, LISTS, body)
18
+ end
19
+
20
+ # Retrieves all the lists in the Klaviyo account
21
+ # @return [List] a list of JSON objects of the name and id for each list
22
+ def self.get_lists()
23
+ v2_request(HTTP_GET, LISTS)
24
+ end
25
+
26
+ # Retrieves the details of the list
27
+ # @param list_id [String] the id of the list
28
+ # @return [JSON] a JSON object containing information about the list
29
+ def self.get_list_details(list_id)
30
+ path = "#{LIST}/#{list_id}"
31
+ v2_request(HTTP_GET, path)
32
+ end
33
+
34
+ # Updates the properties of a list
35
+ # @param list_id [String] the id of the list
36
+ # @param list_name [String] the new name of the list
37
+ # @return will return with HTTP OK on success
38
+ def self.update_list_details(list_id, list_name)
39
+ path = "#{LIST}/#{list_id}"
40
+ body = {
41
+ :list_name => list_name
42
+ }
43
+ v2_request(HTTP_PUT, path, body)
44
+ end
45
+
46
+ # Deletes a list
47
+ # @param list_id [String] the id of the list
48
+ # @return will return with HTTP OK on success
49
+ def self.delete_list(list_id)
50
+ path = "#{LIST}/#{list_id}"
51
+ v2_request(HTTP_DELETE, path)
52
+ end
53
+
54
+ # Check if profiles are in a list and not supressed
55
+ # @param list_id [String] the id of the list
56
+ # @param :emails [List] the emails of the profiles to check
57
+ # @param :phone_numbers [List] the phone numbers of the profiles to check
58
+ # @param :push_tokens [List] push tokens of the profiles to check
59
+ # @return A list of JSON objects of the profiles. Profiles that are
60
+ # supressed or not found are not included.
61
+ def self.check_list_subscriptions(list_id, emails: [], phone_numbers: [], push_tokens: [])
62
+ path = "#{LIST}/#{list_id}/#{SUBSCRIBE}"
63
+ params = {
64
+ :emails => emails,
65
+ :phone_numbers => phone_numbers,
66
+ :push_tokens => push_tokens
67
+ }
68
+ v2_request(HTTP_GET, path, params)
69
+ end
70
+
71
+ # Subscribe profiles to a list.
72
+ # @param list_id [String] the id of the list
73
+ # @param profiles [List] a list of JSON objects. Each object requires either
74
+ # an email or phone number key.
75
+ # @return will retun HTTP OK on success. If the list is single opt-in then a
76
+ # list of records containing the email address, phone number, push token,
77
+ # and the corresponding profile ID will also be included.
78
+ def self.add_subscribers_to_list(list_id, profiles: [])
79
+ path = "#{LIST}/#{list_id}/#{SUBSCRIBE}"
80
+ params = {
81
+ :profiles => profiles
82
+ }
83
+ v2_request(HTTP_POST, path, params)
84
+ end
85
+
86
+ # Unsubscribe and remove profiles from a list
87
+ # @param list_id [String] the id of the list
88
+ # @param :emails [List] the emails of the profiles to check
89
+ # @return will return with HTTP OK on success
90
+ def self.unsubscribe_from_list(list_id, emails: [])
91
+ path = "#{LIST}/#{list_id}/#{SUBSCRIBE}"
92
+ params = {
93
+ :emails => emails
94
+ }
95
+ v2_request(HTTP_DELETE, path, params)
96
+ end
97
+
98
+ # Add profiles to a list
99
+ # @param list_id [String] the id of the list
100
+ # @param :profiles [List] A list of JSON objects. Each object is a profile
101
+ # that will be added to the list
102
+ # @return will return with HTTP OK on success and a list of records of the
103
+ # corresponding profile id
104
+ def self.add_to_list(list_id, profiles: [])
105
+ path = "#{LIST}/#{list_id}/#{MEMBERS}"
106
+ params = {
107
+ :profiles => profiles
108
+ }
109
+ v2_request(HTTP_POST, path, params)
110
+ end
111
+
112
+ # Check if profiles are on a list
113
+ # @param list_id [String] the id of the list
114
+ # @param :emails [List] the emails of the profiles to check
115
+ # @param :phone_numbers [List] the phone numbers of the profiles to check
116
+ # @param :push_tokens [List] push tokens of the profiles to check
117
+ # @return A list of JSON objects of the profiles. Profiles that are
118
+ # supressed or not found are not included.
119
+ def self.check_list_memberships(list_id, emails: [], phone_numbers: [], push_tokens: [])
120
+ path = "#{LIST}/#{list_id}/#{MEMBERS}"
121
+ params = {
122
+ :emails => emails,
123
+ :phone_numbers => phone_numbers,
124
+ :push_tokens => push_tokens
125
+ }
126
+ v2_request(HTTP_GET, path, params)
127
+ end
128
+
129
+ # Remove profiles from a list
130
+ # @param list_id [String] the id of the list
131
+ # @param :emails [List] the emails of the profiles to check
132
+ # @param :phone_numbers [List] the phone numbers of the profiles to check
133
+ # @param :push_tokens [List] push tokens of the profiles to check
134
+ # @return will return with HTTP OK on success
135
+ def self.remove_from_list(list_id, emails: [], phone_numbers: [], push_tokens: [])
136
+ path = "#{LIST}/#{list_id}/#{MEMBERS}"
137
+ params = {
138
+ :emails => emails,
139
+ :phone_numbers => phone_numbers,
140
+ :push_tokens => push_tokens
141
+ }
142
+ v2_request(HTTP_DELETE, path, params)
143
+ end
144
+
145
+ # Get all emails, phone numbers, along with reasons for list exclusion
146
+ # @param list_id [String] the id of the list
147
+ # @param marker [Integer] a marker from a previous call to get the next batch
148
+ # @return [List] A list of JSON object for each profile with the reason for exclusion
149
+ def self.get_list_exclusions(list_id, marker: nil)
150
+ path = "#{LIST}/#{list_id}/#{EXCLUSIONS}/#{ALL}"
151
+ params = {
152
+ :marker => marker
153
+ }
154
+ v2_request(HTTP_GET, path, params)
155
+ end
156
+
157
+ # Get all of the emails, phone numbers, and push tokens for profiles in a given list or segment
158
+ # @param list_id [String] the id of the list
159
+ # @param marker [Integer] a marker from a previous call to get the next batch
160
+ # @return [List] A list of JSON objects for each profile with the id, email, phone number, and push token
161
+ def self.get_group_members(list_id)
162
+ path = "#{GROUP}/#{list_id}/#{MEMBERS}/#{ALL}"
163
+ v2_request(HTTP_GET, path)
164
+ end
165
+ end
166
+ end
@@ -0,0 +1,82 @@
1
+ module Klaviyo
2
+ class Metrics < Client
3
+ EXPORT = 'export'
4
+ METRIC = 'metric'
5
+ METRICS = 'metrics'
6
+
7
+ # Returns a list of all metrics in Klaviyo
8
+ # @param page [Integer] which page to return, default 0
9
+ # @param count [Integer] number of results to return, default 100
10
+ # @return a dictionary with a data property that contains an array of all the metrics
11
+ def self.get_metrics(page: DEFAULT_PAGE, count: DEFAULT_COUNT)
12
+ params = {
13
+ :page => page,
14
+ :count => count
15
+ }
16
+ v1_request(HTTP_GET, METRICS, params)
17
+ end
18
+
19
+ # Returns a batched timeline of all events in your Klaviyo account.
20
+ # @param since [Integer or String] either a Unix timestamp or the UUID from a previous request. Default is the current time.
21
+ # @param count [Integer] number of results to return, default 100
22
+ # @param sort [String] 'asc' or 'desc', sort order to apply to the timeline. Default is 'desc'.
23
+ # @return a dictionary with a data property that contains an array of the metrics
24
+ def self.get_metrics_timeline(since: nil, count: DEFAULT_COUNT, sort: DEFAULT_SORT_DESC)
25
+ path = "#{METRICS}/#{TIMELINE}"
26
+ params = {
27
+ :since => since,
28
+ :count => count,
29
+ :sort => sort
30
+ }
31
+ v1_request(HTTP_GET, path, params)
32
+ end
33
+
34
+ # Returns a batched timeline for one specific type of metric.
35
+ # @param metric_id [String] the id of the metric
36
+ # @param since [Integer or String] either a Unix timestamp or the UUID from a previous request. Default is the current time.
37
+ # @param count [Integer] number of results to return, default 100
38
+ # @param sort [String] 'asc' or 'desc', sort order to apply to the timeline. Default is 'desc'.
39
+ # @return a dictionary with a data property that contains information about what metric the event tracks
40
+ def self.get_metric_timeline(metric_id, since: nil, count: DEFAULT_COUNT, sort: DEFAULT_SORT_DESC)
41
+ path = "#{METRIC}/#{metric_id}/#{TIMELINE}"
42
+ params = {
43
+ :since => since,
44
+ :count => count,
45
+ :sort => sort
46
+ }
47
+ v1_request(HTTP_GET, path, params)
48
+ end
49
+
50
+ # Export event data, optionally filtering and segmented on available event properties
51
+ # @param metric_id [String] the id of the metric
52
+ # @param start_date [String] Beginning of the timeframe to pull event data for. Default is 1 month ago
53
+ # @param end_date [String] End of the timeframe to pull event data for. Default is the current day
54
+ # @param unit [String] Granularity to bucket data points into - one of ‘day’, ‘week’, or ‘month’. Defaults to ‘day’.
55
+ # @param measurement [String or JSON-encoded list] Type of metric to fetch
56
+ # @param where [JSON-encoded list] Conditions to use to filter the set of events. A max of 1 condition can be given.
57
+ # @param by [String] The name of a property to segment the event data on. Where and by parameters cannot be specified at the same time.
58
+ # @param count [Integer] Maximum number of segments to return. The default value is 25.
59
+ # @return A dictionary relecting the input request parameters as well as a results property
60
+ def self.get_metric_export(metric_id,
61
+ start_date: nil,
62
+ end_date: nil,
63
+ unit: nil,
64
+ measurement: nil,
65
+ where: nil,
66
+ by: nil,
67
+ count: nil
68
+ )
69
+ path = "#{METRIC}/#{metric_id}/#{EXPORT}"
70
+ params = {
71
+ :start_date => start_date,
72
+ :end_date => end_date,
73
+ :unit => unit,
74
+ :measurement => measurement,
75
+ :where => where,
76
+ :by => by,
77
+ :count => count
78
+ }
79
+ v1_request(HTTP_GET, path, params)
80
+ end
81
+ end
82
+ end
@@ -0,0 +1,55 @@
1
+ module Klaviyo
2
+ class Profiles < Client
3
+ PERSON = 'person'
4
+
5
+ # Retrieve all the data attributes for a Klaviyo Person ID.
6
+ # @param person_id [String] the id of the profile
7
+ # @return returns a person object
8
+ def self.get_person_attributes(person_id)
9
+ path = "#{PERSON}/#{person_id}"
10
+ v1_request(HTTP_GET, path)
11
+ end
12
+
13
+ # Add or update one more more attributes for a Person
14
+ # @param person_id [String] the id of the profile
15
+ # @param kwargs [Key/value pairs] attributes to add/update in the profile
16
+ # @return returns the updated person object
17
+ def self.update_person_attributes(person_id, kwargs = {})
18
+ path = "#{PERSON}/#{person_id}"
19
+ v1_request(HTTP_PUT, path, kwargs)
20
+ end
21
+
22
+ # Listing a person's event timeline
23
+ # @param person_id [String] the id of the profile
24
+ # @param since [Integer or String] either a Unix timestamp or the UUID from a previous request. Default is the current time.
25
+ # @param count [Integer] number of results to return, default 100
26
+ # @param sort [String] 'asc' or 'desc', sort order to apply to the timeline. Default is 'desc'.
27
+ # @return returns a dictionary containing a list of metric event objects
28
+ def self.get_person_metrics_timeline(person_id, since: nil, count: DEFAULT_COUNT, sort: DEFAULT_SORT_DESC)
29
+ path = "#{PERSON}/#{person_id}/#{METRICS}/#{TIMELINE}"
30
+ params = {
31
+ :since => since,
32
+ :count => count,
33
+ :sort => sort
34
+ }
35
+ v1_request(HTTP_GET, path, params)
36
+ end
37
+
38
+ # Listing a person's event timeline for a particular metric
39
+ # @param person_id [String] the id of the profile
40
+ # @param metric_id [String] the id of the metric
41
+ # @param since [Integer or String] either a Unix timestamp or the UUID from a previous request. Default is the current time.
42
+ # @param count [Integer] number of results to return, default 100
43
+ # @param sort [String] 'asc' or 'desc', sort order to apply to the timeline. Default is 'desc'.
44
+ # @return returns a dictionary containing a list of metric event objects
45
+ def self.get_person_metric_timeline(person_id, metric_id, since: nil, count: DEFAULT_COUNT, sort: DEFAULT_SORT_DESC)
46
+ path = "#{PERSON}/#{person_id}/#{METRIC}/#{metric_id}/#{TIMELINE}"
47
+ params = {
48
+ :since => since,
49
+ :count => count,
50
+ :sort => sort
51
+ }
52
+ v1_request(HTTP_GET, path, params)
53
+ end
54
+ end
55
+ end
@@ -0,0 +1,79 @@
1
+ module Klaviyo
2
+ class Public < Client
3
+ # Used for identifying customers and managing profile properties
4
+ #
5
+ # @kwarg :id [String] the customer or profile id
6
+ # @kwarg :email [String] the customer or profile email
7
+ # @kwarg :properties [Hash] properties of the profile to add or update
8
+ def self.identify(kwargs = {})
9
+ defaults = {:id => nil,
10
+ :email => nil,
11
+ :phone_number => nil,
12
+ :properties => {}
13
+ }
14
+ kwargs = defaults.merge(kwargs)
15
+
16
+ unless check_required_args(kwargs)
17
+ return
18
+ end
19
+
20
+ properties = kwargs[:properties]
21
+ properties[:email] = kwargs[:email] unless kwargs[:email].to_s.empty?
22
+ properties[:$phone_number] = kwargs[:phone_number] unless kwargs[:phone_number].to_s.empty?
23
+ properties[:id] = kwargs[:id] unless kwargs[:id].to_s.empty?
24
+
25
+ params = {
26
+ :token => Klaviyo.public_api_key,
27
+ :properties => properties
28
+ }
29
+
30
+ public_request(HTTP_GET, 'identify', params)
31
+ end
32
+
33
+ # Used for tracking events and customer behaviors
34
+ #
35
+ # @param event [String] the event to track
36
+ # @kwarg :id [String] the customer or profile id
37
+ # @kwarg :email [String] the customer or profile email
38
+ # @kwarg :phone_number [String] the customer or profile phone number
39
+ # @kwarg :properties [Hash] properties of the event
40
+ # @kwargs :customer_properties [Hash] properties of the customer or profile
41
+ # @kwargs :time [Integer] timestamp of the event
42
+ def self.track(event, kwargs = {})
43
+ defaults = {
44
+ :id => nil,
45
+ :email => nil,
46
+ :phone_number => nil,
47
+ :properties => {},
48
+ :customer_properties => {},
49
+ :time => nil
50
+ }
51
+
52
+ kwargs = defaults.merge(kwargs)
53
+
54
+ unless check_required_args(kwargs)
55
+ return
56
+ end
57
+
58
+ customer_properties = kwargs[:customer_properties]
59
+ customer_properties[:email] = kwargs[:email] unless kwargs[:email].to_s.empty?
60
+ customer_properties[:$phone_number] = kwargs[:phone_number] unless kwargs[:phone_number].to_s.empty?
61
+ customer_properties[:id] = kwargs[:id] unless kwargs[:id].to_s.empty?
62
+
63
+ params = {
64
+ :token => Klaviyo.public_api_key,
65
+ :event => event,
66
+ :properties => kwargs[:properties],
67
+ :customer_properties => customer_properties
68
+ }
69
+ params[:time] = kwargs[:time].to_time.to_i if kwargs[:time]
70
+
71
+ public_request(HTTP_GET, 'track', params)
72
+ end
73
+
74
+ def self.track_once(event, kwargs = {})
75
+ kwargs.update('__track_once__' => true)
76
+ track(event, kwargs)
77
+ end
78
+ end
79
+ end
@@ -1,74 +1,95 @@
1
- require 'open-uri'
2
- require 'base64'
3
- require 'json'
4
-
5
1
  module Klaviyo
6
- class KlaviyoError < StandardError; end
7
-
8
2
  class Client
9
- def initialize(api_key, url = 'http://a.klaviyo.com/')
10
- @api_key = api_key
11
- @url = url
12
- end
13
-
14
- def track(event, kwargs = {})
15
- defaults = {:id => nil, :email => nil, :properties => {}, :customer_properties => {}, :time => nil}
16
- kwargs = defaults.merge(kwargs)
17
-
18
- if kwargs[:email].to_s.empty? and kwargs[:id].to_s.empty?
19
- raise KlaviyoError.new('You must identify a user by email or ID')
3
+ BASE_API_URL = 'https://a.klaviyo.com/api'
4
+ V1_API = 'v1'
5
+ V2_API = 'v2'
6
+
7
+ HTTP_DELETE = 'delete'
8
+ HTTP_GET = 'get'
9
+ HTTP_POST = 'post'
10
+ HTTP_PUT = 'put'
11
+
12
+ ALL = 'all'
13
+ TIMELINE = 'timeline'
14
+
15
+ DEFAULT_COUNT = 100
16
+ DEFAULT_PAGE = 0
17
+ DEFAULT_SORT_DESC = 'desc'
18
+
19
+ private
20
+
21
+ def self.request(method, path, kwargs = {})
22
+ check_private_api_key_exists()
23
+ url = "#{BASE_API_URL}/#{path}"
24
+ connection = Faraday.new(
25
+ url: url,
26
+ headers: {
27
+ 'Content-Type' => 'application/json'
28
+ })
29
+ response = connection.send(method) do |req|
30
+ req.body = kwargs[:body].to_json || nil
20
31
  end
21
-
22
- customer_properties = kwargs[:customer_properties]
23
- customer_properties[:email] = kwargs[:email] unless kwargs[:email].to_s.empty?
24
- customer_properties[:id] = kwargs[:id] unless kwargs[:id].to_s.empty?
32
+ end
33
+
34
+ def self.public_request(method, path, kwargs = {})
35
+ check_public_api_key_exists()
36
+ params = build_params(kwargs)
37
+ url = "#{BASE_API_URL}/#{path}?#{params}"
38
+ res = Faraday.get(url).body
39
+ end
25
40
 
26
- params = {
27
- :token => @api_key,
28
- :event => event,
29
- :properties => kwargs[:properties],
30
- :customer_properties => customer_properties,
31
- :ip => ''
41
+ def self.v1_request(method, path, kwargs = {})
42
+ defaults = {:page => nil,
43
+ :count => nil,
44
+ :since => nil,
45
+ :sort => nil}
46
+ params = defaults.merge(kwargs)
47
+ query_params = encode_params(params)
48
+ full_url = "#{V1_API}/#{path}?api_key=#{Klaviyo.private_api_key}#{query_params}"
49
+ request(method, full_url)
50
+ end
51
+
52
+ def self.v2_request(method, path, kwargs = {})
53
+ path = "#{V2_API}/#{path}"
54
+ key = {
55
+ "api_key": "#{Klaviyo.private_api_key}"
32
56
  }
33
- params[:time] = kwargs[:time].to_time.to_i if kwargs[:time]
34
-
35
- params = build_params(params)
36
- request('crm/api/track', params)
57
+ data = {}
58
+ data[:body] = key.merge(kwargs)
59
+ request(method, path, data)
37
60
  end
38
-
39
- def track_once(event, opts = {})
40
- opts.update('__track_once__' => true)
41
- track(event, opts)
61
+
62
+ def self.build_params(params)
63
+ "data=#{Base64.encode64(JSON.generate(params)).gsub(/\n/,'')}"
42
64
  end
43
-
44
- def identify(kwargs = {})
45
- defaults = {:id => nil, :email => nil, :properties => {}}
46
- kwargs = defaults.merge(kwargs)
47
-
48
- if kwargs[:email].to_s.empty? and kwargs[:id].to_s.empty?
49
- raise KlaviyoError.new('You must identify a user by email or ID')
65
+
66
+ def self.check_required_args(kwargs)
67
+ if kwargs[:email].to_s.empty? and kwargs[:phone_number].to_s.empty? and kwargs[:id].to_s.empty?
68
+ raise Klaviyo::KlaviyoError.new(REQUIRED_ARG_ERROR)
69
+ else
70
+ return true
50
71
  end
51
-
52
- properties = kwargs[:properties]
53
- properties[:email] = kwargs[:email] unless kwargs[:email].to_s.empty?
54
- properties[:id] = kwargs[:id] unless kwargs[:id].to_s.empty?
72
+ end
55
73
 
56
- params = build_params({
57
- :token => @api_key,
58
- :properties => properties
59
- })
60
- request('crm/api/identify', params)
74
+ def self.check_private_api_key_exists()
75
+ if !Klaviyo.private_api_key
76
+ raise KlaviyoError.new(NO_PRIVATE_API_KEY_ERROR)
77
+ end
61
78
  end
62
79
 
63
- private
64
-
65
- def build_params(params)
66
- 'data=' + Base64.encode64(JSON.generate(params)).gsub(/\n/,'')
80
+ def self.check_public_api_key_exists()
81
+ if !Klaviyo.public_api_key
82
+ raise KlaviyoError.new(NO_PUBLIC_API_KEY_ERROR)
83
+ end
67
84
  end
68
-
69
- def request(path, params)
70
- url = @url + path + '?' + params
71
- open(url).read == '1' ? true : false
85
+
86
+ def self.encode_params(kwargs)
87
+ kwargs.select!{|k, v| v}
88
+ params = URI.encode_www_form(kwargs)
89
+
90
+ if !params.empty?
91
+ return "&#{params}"
92
+ end
72
93
  end
73
94
  end
74
95
  end
@@ -0,0 +1,23 @@
1
+ require 'open-uri'
2
+ require 'base64'
3
+ require 'json'
4
+ require 'faraday'
5
+
6
+ require_relative './client'
7
+ require_relative 'apis/public'
8
+ require_relative 'apis/lists'
9
+ require_relative 'apis/metrics'
10
+ require_relative 'apis/profiles'
11
+
12
+ module Klaviyo
13
+ class << self
14
+ attr_accessor :public_api_key
15
+ attr_accessor :private_api_key
16
+ end
17
+
18
+ class KlaviyoError < StandardError; end
19
+
20
+ NO_PRIVATE_API_KEY_ERROR = 'Please provide your Private API key for this request'
21
+ NO_PUBLIC_API_KEY_ERROR = 'Please provide your Public API key for this request'
22
+ REQUIRED_ARG_ERROR = 'You must identify a user by email, ID or phone_number'
23
+ end
metadata CHANGED
@@ -1,88 +1,106 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: klaviyo
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.0
4
+ version: 2.0.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - Klaviyo Team
8
- autorequire:
8
+ autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2014-09-06 00:00:00.000000000 Z
11
+ date: 2020-12-28 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: json
15
15
  requirement: !ruby/object:Gem::Requirement
16
16
  requirements:
17
- - - '>='
17
+ - - ">="
18
18
  - !ruby/object:Gem::Version
19
19
  version: '0'
20
20
  type: :runtime
21
21
  prerelease: false
22
22
  version_requirements: !ruby/object:Gem::Requirement
23
23
  requirements:
24
- - - '>='
24
+ - - ">="
25
25
  - !ruby/object:Gem::Version
26
26
  version: '0'
27
27
  - !ruby/object:Gem::Dependency
28
28
  name: rack
29
29
  requirement: !ruby/object:Gem::Requirement
30
30
  requirements:
31
- - - '>='
31
+ - - ">="
32
32
  - !ruby/object:Gem::Version
33
33
  version: '0'
34
34
  type: :runtime
35
35
  prerelease: false
36
36
  version_requirements: !ruby/object:Gem::Requirement
37
37
  requirements:
38
- - - '>='
38
+ - - ">="
39
39
  - !ruby/object:Gem::Version
40
40
  version: '0'
41
41
  - !ruby/object:Gem::Dependency
42
42
  name: escape
43
43
  requirement: !ruby/object:Gem::Requirement
44
44
  requirements:
45
- - - '>='
45
+ - - ">="
46
46
  - !ruby/object:Gem::Version
47
47
  version: '0'
48
48
  type: :runtime
49
49
  prerelease: false
50
50
  version_requirements: !ruby/object:Gem::Requirement
51
51
  requirements:
52
- - - '>='
52
+ - - ">="
53
+ - !ruby/object:Gem::Version
54
+ version: '0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: faraday
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - ">="
60
+ - !ruby/object:Gem::Version
61
+ version: '0'
62
+ type: :runtime
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - ">="
53
67
  - !ruby/object:Gem::Version
54
68
  version: '0'
55
69
  description: Ruby wrapper for the Klaviyo API
56
- email: hello@klaviyo.com
70
+ email: libraries@klaviyo.com
57
71
  executables: []
58
72
  extensions: []
59
73
  extra_rdoc_files: []
60
74
  files:
61
75
  - klaviyo.gemspec
62
- - lib/klaviyo/client.rb
63
76
  - lib/klaviyo.rb
77
+ - lib/klaviyo/apis/lists.rb
78
+ - lib/klaviyo/apis/metrics.rb
79
+ - lib/klaviyo/apis/profiles.rb
80
+ - lib/klaviyo/apis/public.rb
81
+ - lib/klaviyo/client.rb
82
+ - lib/klaviyo/klaviyo_module.rb
64
83
  - lib/rack/klaviyo.rb
65
84
  homepage: https://www.klaviyo.com/
66
85
  licenses: []
67
86
  metadata: {}
68
- post_install_message:
87
+ post_install_message:
69
88
  rdoc_options: []
70
89
  require_paths:
71
90
  - lib
72
91
  required_ruby_version: !ruby/object:Gem::Requirement
73
92
  requirements:
74
- - - '>='
93
+ - - ">="
75
94
  - !ruby/object:Gem::Version
76
95
  version: '0'
77
96
  required_rubygems_version: !ruby/object:Gem::Requirement
78
97
  requirements:
79
- - - '>='
98
+ - - ">="
80
99
  - !ruby/object:Gem::Version
81
100
  version: '0'
82
101
  requirements: []
83
- rubyforge_project:
84
- rubygems_version: 2.0.14
85
- signing_key:
102
+ rubygems_version: 3.0.8
103
+ signing_key:
86
104
  specification_version: 4
87
105
  summary: You heard us, a Ruby wrapper for the Klaviyo API
88
106
  test_files: []