klaviyo_api 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa973ac50c2f9d84ffea184bbe4ca030c7ff1ffc99fd1a76f0ab51f845140487
-  data.tar.gz: ac7b1cf169a606910eb51aa5736d92e926c60e5862b710027bdd3fa468af4bed
+  metadata.gz: 7f85a155aaaffcfefa023339aabee06627eedd5aafe4aa3bd5585ae5a42ca85e
+  data.tar.gz: a83d88200ca420c62c24c53a1b57b4857f7b519bb2954cae6a24022680806e3b
 SHA512:
-  metadata.gz: 2776400dcc29ef86aac04acb8c49a64d383e302ade62602666c6bb02d69573bde894ea785e61c045329c234c64d242f60182a043d3cc74729bf84ea35e67863c
-  data.tar.gz: 6b9b855da870f2de53a3090dcae65269986cb9bc87c5373873fff684fb57e4bb46f585a6ea3955f66d3b38b0b4b5d373a0dea650d8eb510fab36b40729e904a3
+  metadata.gz: 9754d0c6d89a3fe4bb128295e45226223b7062afc5eeb2e1a0f4ac2ad51aba410b45d1a2d8b8645c18e1064b67331e425178b60e8105efa530ebfa9adaa5364f
+  data.tar.gz: f3dca57bea500ad7289bccef655e2a36272ee64a0865548311aff3cb1b50d791730ab7e982cbd36775cdd08957a9487ae169a0ced35b9c948f5bddf4275e1b42

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # CHANGELOG
 
+## [1.5.0]
+
+### Added
+
+ - Support `/v2/list<id>/exclusions/all`
+ - MarkerCollections can now return the next page of results
+
+### Changed
+
+ - `List#members` has been replaced with `ListMember#all_members` and now returns a regular collection instead of an Enumerator
+
 ## [1.4.0]
 
 ### Added

data/lib/klaviyo_api.rb

@@ -4,7 +4,6 @@ $LOAD_PATH.unshift File.dirname(__FILE__)
 
 # gem requires
 require 'activeresource'
-require 'caching_enumerator'
 
 # gem extensions
 require 'active_resource/connection_ext'

data/lib/klaviyo_api/collections.rb

@@ -1,3 +1,6 @@
 # frozen_string_literal: true
 
+require 'klaviyo_api/collections/paginated_collection'
+require 'klaviyo_api/collections/marker_collection'
+
 Dir.glob("#{File.dirname(__FILE__)}/collections/*").each { |file| require file if file.end_with? '.rb' }

data/lib/klaviyo_api/collections/event_collection.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module KlaviyoAPI::Collections
+  class EventCollection < MarkerCollection
+    def next_page_marker_name
+      'since'
+    end
+  end
+end

data/lib/klaviyo_api/collections/list_exclusion_collection.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module KlaviyoAPI::Collections
+  class ListExclusionCollection < MarkerCollection
+    def next_page_marker_name
+      'marker'
+    end
+  end
+end

data/lib/klaviyo_api/collections/list_membership_collection.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module KlaviyoAPI::Collections
+  # ListMembershipCollection, as opposed to ListMemberCollection.
+  # This is a collection of ListMembers, but _specifically_ in the
+  # context of the Group Memberships endpoint of a List.
+  # (https://www.klaviyo.com/docs/api/v2/lists#get-members-all)
+  class ListMembershipCollection < MarkerCollection
+    def next_page
+      # Return empty collection if no other pages
+      return self.class.new unless more_pages?
+
+      KlaviyoAPI::ListMember.all_members params: { **first.prefix_options, **original_params, "#{next_page_marker_name}": marker }
+    end
+  end
+end

data/lib/klaviyo_api/collections/marker_collection.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module KlaviyoAPI::Collections
+  # This collection is used for item types that rely on
+  # markers to provide pagination.
+  class MarkerCollection < ActiveResource::Collection
+    attr_accessor :count, :marker, :next
+
+    def initialize(response = {})
+      # May not exist
+      @count = response.delete 'count'
+
+      @next = response['next'] || response['marker']
+      @marker = @next
+
+      @elements = response['data'] || response['records'] || []
+    end
+
+    def next_page_marker_name
+      'marker'
+    end
+
+    def more_pages?
+      !@next.nil?
+    end
+
+    def next_page
+      # Return empty collection if no other pages
+      return self.class.new unless more_pages?
+
+      first.class.all params: { **first.prefix_options, **original_params, "#{next_page_marker_name}": marker }
+    end
+  end
+end

data/lib/klaviyo_api/collections/paginated_collection.rb

@@ -5,14 +5,14 @@ module KlaviyoAPI::Collections
   # provide `page`, `page_size`, etc.
   class PaginatedCollection < ActiveResource::Collection
     attr_accessor :total, :page, :page_size, :start, :end
-    
+
     def initialize(response = {})
-      @total  = response.delete 'total'
+      @total = response.delete 'total'
       @page = response.delete 'page'
       @page_size = response.delete 'page_size'
       @start = response.delete 'start'
       @end = response.delete 'end'
-      
+
       @elements = response['data'] || []
     end
   end

data/lib/klaviyo_api/resources/event.rb

@@ -9,7 +9,7 @@ module KlaviyoAPI
 
     self.element_name = 'timeline'
     self.collection_name = 'timeline'
-    self.collection_parser = KlaviyoAPI::Collections::NextMarkerCollection
+    self.collection_parser = KlaviyoAPI::Collections::EventCollection
 
     class << self
       def find_single(scope, options)

data/lib/klaviyo_api/resources/list.rb

@@ -5,9 +5,11 @@ module KlaviyoAPI
     self.prefix += 'v2/'
     self.primary_key = :list_id
 
+    has_many :exclusions, class_name: 'KlaviyoAPI::ListExclusion'
+
     class << self
       # Override this from ActiveResource#base in order to inject the id into the response
-      # because its not returned
+      # because it's not returned
       def find_single(scope, options)
         super.tap { |record| record.id = scope }
       end
@@ -20,24 +22,7 @@ module KlaviyoAPI
     #
     # https://www.klaviyo.com/docs/api/v2/lists#get-members-all
     def members(options = {})
-      CachingEnumerator.new do |yielder|
-        marker = nil
-
-        loop do
-          path = "#{self.class.prefix}group/#{id}/members/all"
-          path += "?marker=#{marker}" if marker
-
-          response = JSON.parse(connection.get(path, self.class.headers).body)
-          marker = response['marker']
-          list_members = response['records']
-
-          list_members.each do |list_member|
-            yielder.yield KlaviyoAPI::ListMember.new list_member
-          end
-
-          break if marker.nil?
-        end
-      end
+      KlaviyoAPI::ListMember.all_members params: { list_id: id, **options }
     end
   end
 end

data/lib/klaviyo_api/resources/list_exclusion.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module KlaviyoAPI
+  class ListExclusion < Base
+    self.prefix += 'v2/list/:list_id/'
+    self.element_name = 'exclusions/all'
+    self.collection_name = 'exclusions/all'
+
+    self.collection_parser = KlaviyoAPI::Collections::ListExclusionCollection
+
+    class << self
+      def find_single(_scope, _options)
+        raise KlaviyoAPI::InvalidOperation, 'Cannot get single Exclusion via API. Please use KlaviyoAPI::ListExclusion#all.'
+      end
+    end
+
+    def destroy
+      raise KlaviyoAPI::InvalidOperation, 'Cannot delete ListExclusions via API.'
+    end
+
+    def create
+      raise KlaviyoAPI::InvalidOperation, 'Cannot create ListExclusions via API.'
+    end
+
+    def update
+      raise KlaviyoAPI::InvalidOperation, 'Cannot update ListExclusions via API.'
+    end
+  end
+end

data/lib/klaviyo_api/resources/list_member.rb

@@ -2,7 +2,9 @@
 
 module KlaviyoAPI
   class ListMember < Base
-    self.prefix += 'v2/list/:list_id/'
+    ORIGINAL_PREFIX = '/api/v2/list/:list_id/'
+    self.prefix = ORIGINAL_PREFIX
+
     self.primary_key = :id
 
     # This is always plural
@@ -16,7 +18,7 @@ module KlaviyoAPI
       #
       # https://www.klaviyo.com/docs/api/v2/lists#delete-members
       def delete(email, options = {})
-        options = options.merge({emails: email})
+        options = options.merge emails: email
         connection.delete(element_path('', options), headers)
       end
 
@@ -36,6 +38,31 @@ module KlaviyoAPI
         end
         saved_list_members
       end
+
+      # As opposed to #all, which hits and requires a list of emails to check for membership,
+      # this method hits https://www.klaviyo.com/docs/api/v2/lists#get-members-all and gets all
+      # ListMembers for a List.
+      def all_members(options)
+        # The rest becomes much easier if we temporarily modify the prefix.
+        # We set it back later, have no fear.
+        self.prefix = '/api/v2/group/:list_id/members/all'
+
+        prefix_options, query_options = split_options(options[:params])
+        path = "#{prefix(prefix_options)}#{format_extension}#{query_string(query_options)}"
+
+        # Very heavily inspired by `find_every`
+        response = format.decode(connection.get(path, headers).body) || []
+        collection = KlaviyoAPI::Collections::ListMembershipCollection.new(response).tap do |parser|
+          parser.resource_class  = self
+          parser.original_params = query_options
+        end
+
+        collection.collect! { |record| instantiate_record(record, prefix_options) }
+
+        self.prefix = ORIGINAL_PREFIX
+
+        collection
+      end
     end
 
     # Adding a single Member to a List does not exist - they must be added as an
@@ -60,12 +87,12 @@ module KlaviyoAPI
     # https://www.klaviyo.com/docs/api/v2/lists#delete-members
     def destroy
       run_callbacks :destroy do
-        KlaviyoAPI::ListMember.delete self.email, prefix_options
+        KlaviyoAPI::ListMember.delete email, prefix_options
       end
     end
 
     def update
-      raise KlaviyoAPI::InvalidOperation.new 'Cannot update list members. You might be looking for delete and/or create.'
+      raise KlaviyoAPI::InvalidOperation, 'Cannot update list members. You might be looking for delete and/or create.'
     end
   end
 end

data/lib/klaviyo_api/resources/metric.rb

@@ -11,12 +11,12 @@ module KlaviyoAPI
     has_many :events, class_name: 'KlaviyoAPI::Event'
 
     class << self
-      def find_single(scope, options)
+      def find_single(_scope, _options)
         raise KlaviyoAPI::InvalidOperation, 'Cannot get single Metric via API. Please use KlaviyoAPI::Metric#all.'
       end
 
       def collection_path(prefix_options = {}, query_options = {})
-        super prefix_options, query_options.deep_merge({ api_key: headers['api-key'] })
+        super prefix_options, query_options.deep_merge(api_key: headers['api-key'])
       end
 
       # Get all Events for all Metrics

data/lib/klaviyo_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module KlaviyoAPI
-  VERSION = '1.4.0'
+  VERSION = '1.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: klaviyo_api
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - rewind.io
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-24 00:00:00.000000000 Z
+date: 2019-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activeresource
@@ -24,20 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 5.1.0
-- !ruby/object:Gem::Dependency
-  name: caching_enumerator
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.0.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.0.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -205,7 +191,10 @@ files:
 - lib/active_resource/connection_ext.rb
 - lib/klaviyo_api.rb
 - lib/klaviyo_api/collections.rb
-- lib/klaviyo_api/collections/next_marker_collection.rb
+- lib/klaviyo_api/collections/event_collection.rb
+- lib/klaviyo_api/collections/list_exclusion_collection.rb
+- lib/klaviyo_api/collections/list_membership_collection.rb
+- lib/klaviyo_api/collections/marker_collection.rb
 - lib/klaviyo_api/collections/paginated_collection.rb
 - lib/klaviyo_api/configuration.rb
 - lib/klaviyo_api/connection.rb
@@ -216,6 +205,7 @@ files:
 - lib/klaviyo_api/resources/base.rb
 - lib/klaviyo_api/resources/event.rb
 - lib/klaviyo_api/resources/list.rb
+- lib/klaviyo_api/resources/list_exclusion.rb
 - lib/klaviyo_api/resources/list_member.rb
 - lib/klaviyo_api/resources/metric.rb
 - lib/klaviyo_api/resources/profile.rb

data/lib/klaviyo_api/collections/next_marker_collection.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-module KlaviyoAPI::Collections
-  # This collection is used for item types that rely on
-  # 'next' markers to provide pagination.
-  class NextMarkerCollection < ActiveResource::Collection
-    attr_accessor :next, :count
-
-    def initialize(response = {})
-      @count  = response.delete 'count'
-      @next = response.delete 'next'
-
-      @elements = response['data'] || []
-    end
-  end
-end