klaviyo-api-sdk 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2dd5f64c61d5745e183600a55d4bbf966e4e7068dab4adeae9461c3bfce0d31c
-  data.tar.gz: 01c259f431c20acd89549245684246751a7ffa3ea198eb4739d4b2daf59f475a
+  metadata.gz: e6d69c30e7ef51bcaf0cf14baa93eeb17151088e851e90534f1a987deda6078f
+  data.tar.gz: 31f9ffc768a778fba13c9b0619dc1257311f287dcdff61af47444d32dcebc41e
 SHA512:
-  metadata.gz: 42c5da9a5ba2da4e597bd8f4e443c8fc385029cc72eef8d60d1deb0a6ab23916ee0515a5be0d9da18fa4ac88a0e4a63831a749f78612cefd3e012dff1cbf0bce
-  data.tar.gz: 92986117415d56fdafeee9aa5a3eb09ce4f1b10b52779e04e5de4590ab27562399bf78e8fae9a4265999e4c1643504889c59875fcfc89849b1c8c4daf6e24246
+  metadata.gz: 0f1f8ce2bbe0b436b7f97cd7bcea5f0e79ce959c6172ae87c47f83ef360817e386efaa9559462c26c5b7ff183d1362744a41a054767fa8c8d6c4374ca099c2e6
+  data.tar.gz: 5edad8110899a5f21ac4f2da43698a549693feb8ea33a92a204cf30d59529c2c5f6e338c11e5eeb3f825ba0c569eb2262e8593682c7396fe11e1031be8ee3e45

data/CHANGELOG.md

@@ -4,6 +4,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.0.1] - 2022-12-06
+### Changes
+- Support for cursor pagination
+    - Passing the `next` value from a paginated result to the following call via the `page_cursor` query string argument will now result in the cursor being parsed and set appropriately by the `ApiClient`.
+
 ## [1.0.0] - 2022-10-19
 ### Added
 - Initial release

data/README.md

@@ -1,6 +1,6 @@
 # Klaviyo Ruby SDK
 
-- SDK version: 1.0.0
+- SDK version: 1.0.1
 - API revision: 2022-10-17
 
 ## Helpful Resources
@@ -70,13 +70,13 @@ gem build klaviyo-api-sdk.gemspec
 Then install the gem locally:
 
 ```shell
-gem install ./klaviyo-api-sdk-1.0.0.gem
+gem install ./klaviyo-api-sdk-1.0.1.gem
 ```
 
 
 Finally add this to the Gemfile:
 
-    gem 'klaviyo-api-sdk', '~> 1.0.0'
+    gem 'klaviyo-api-sdk', '~> 1.0.1'
 
 To install directly from rubygems:
 

data/klaviyo-api-sdk.gemspec

@@ -17,7 +17,7 @@ require "klaviyo-api-sdk/version"
 
 Gem::Specification.new do |s|
   s.name        = "klaviyo-api-sdk"
-  s.version     = "1.0.0"
+  s.version     = "1.0.1"
   s.authors     = ['Klaviyo Team']
   s.email       = ['libraries@klaviyo.com']
   s.summary     = 'You heard us, a Ruby wrapper for the Klaviyo API'

data/lib/klaviyo-api-sdk/api_client.rb

@@ -15,6 +15,7 @@ require 'json'
 require 'logger'
 require 'tempfile'
 require 'time'
+require 'uri'
 require 'typhoeus'
 
 module KlaviyoAPI
@@ -31,7 +32,7 @@ module KlaviyoAPI
     # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
     def initialize(config = Configuration.default)
       @config = config
-      @user_agent = "klaviyo-api-ruby/1.0.0"
+      @user_agent = "klaviyo-api-ruby/1.0.1"
       @default_headers = {
         'Content-Type' => 'application/json',
         'User-Agent' => @user_agent
@@ -96,6 +97,7 @@ module KlaviyoAPI
       follow_location = opts[:follow_location] || true
 
       update_params_for_auth! header_params, query_params, opts[:auth_names]
+      update_page_cursor! header_params, query_params
 
       # set ssl_verifyhosts option based on @config.verify_ssl_host (true/false)
       _verify_ssl_host = @config.verify_ssl_host ? 2 : 0
@@ -313,6 +315,25 @@ module KlaviyoAPI
       end
     end
 
+    # Sets page[cursor] in query_params from parsed URI
+    #
+    # @param [Hash] header_params Header parameters
+    # @param [Hash] query_params Query parameters
+    def update_page_cursor!(header_params, query_params)
+      page_cursor_key = "page[cursor]"
+      page_cursor = query_params[page_cursor_key.to_sym]
+
+      return if page_cursor.nil? || page_cursor.empty?
+
+      if page_cursor.is_a?(String) && page_cursor.include?('https://')
+        query = CGI::parse(URI(page_cursor).query)
+
+        return if !query.keys.include?(page_cursor_key)
+
+        query_params[page_cursor_key.to_sym] = query[page_cursor_key].first
+      end
+    end
+
     # Sets user agent in HTTP header
     #
     # @param [String] user_agent User agent (e.g. openapi-generator/ruby/1.0.0)

data/test.rb

@@ -0,0 +1,50 @@
+# Load the gem
+require 'klaviyo-api-sdk'
+require 'uri'
+
+# Setup authorization
+KlaviyoAPI.configure do |config|
+  config.api_key['Klaviyo-API-Key'] = 'Klaviyo-API-Key pk_51c0b2da23ca58ae5eac3d6fcfa55d6e20'
+  #config.max_retries = 5 # optional
+  #config.max_delay = 60 # optional
+end
+
+opts = {
+    "page%5Bcursor%5D": "bmV4dDo6aWQ6OjAxRzRKVjFIMk1NTk02NkE2MVFHWDdXVlFZ",
+    "another": "value"
+}
+
+begin
+    KlaviyoAPI::Profiles.get_profiles()
+end
+
+opts = {
+    "page%5Bcursor%5D": "https://a.klaviyo.com/api/profiles/?page%5Bcursor%5D=bmV4dDo6aWQ6Ok43dW1iVw&another=value"
+}
+
+begin
+    KlaviyoAPI::Profiles.get_profiles(opts)
+end
+
+opts = {
+    "page_cursor": "bmV4dDo6aWQ6OjAxRzRKVjFIMk1NTk02NkE2MVFHWDdXVlFZ",
+    "another": "value"
+}
+
+begin
+    KlaviyoAPI::Profiles.get_profiles(opts)
+end
+
+opts = {
+    "page_cursor": "https://a.klaviyo.com/api/profiles/?page%5Bcursor%5D=bmV4dDo6aWQ6Ok43dW1iVw&another=value"
+}
+
+begin
+    KlaviyoAPI::Profiles.get_profiles(opts)
+end
+
+# uri = "https://a.klaviyo.com/api/profiles/?page%5Bcursor%5D=bmV4dDo6aWQ6OjAxRzRKVjFIMk1NTk02NkE2MVFHWDdXVlFZ&another=value"
+# query = URI(uri).query.split('&').map{|x| x.to_s.split('=')}
+# # p query
+# p "\n"
+# print CGI::parse(URI(uri).query)["page[cursor]"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: klaviyo-api-sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Klaviyo Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-19 00:00:00.000000000 Z
+date: 2022-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: retriable
@@ -555,6 +555,7 @@ files:
 - spec/models/v2_template_render_query_as_sub_resource_spec.rb
 - spec/models/v2_template_render_query_spec.rb
 - spec/spec_helper.rb
+- test.rb
 homepage: https://www.klaviyo.com/
 licenses:
 - MIT