mailchimp-rest-api 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd8e4ac41f0ff072d449fab1c0466bed09d533def2a97db463a0dd76e47aaef2
-  data.tar.gz: 24fccb0d0eb4175d77055bdd5ce4e935789cbd5b6ed700d17f7d98ab86ada034
+  metadata.gz: 428009c6c680a7c4bc6ec3b80fe5e4c1485df70e358928655fefabbf0b76637c
+  data.tar.gz: bd8307d56a558d64a4d7a7551a21cacf9dfe1e44036882191421c359c1b2682a
 SHA512:
-  metadata.gz: 8cc1fa18308afd486cb4418317f8809d9e2758df9a1ea4087aaea57ba66db3570ae91fc99faccd8472a4663f22800151519b5c4c350f750f275a484c147544fe
-  data.tar.gz: 0df6d93f8742d35b73372a5b7ce139723102261f046243e77bcb30f90937fa519a93e0c1fd4e267bc67bb5a38c9932907d5a2373a0f27ac49f81d763bd4465f5
+  metadata.gz: c3f2cc4b7561902a8ba1991b8acb68be65714a506854adea22cd3d0f1a7fa449aae6cea82267cb55d4b45a9ea7f11f6c4ba41b5e602d8a75ecb6f6f4df8a3102
+  data.tar.gz: f4bb0e6175805b8363ed59df417c4f103ee6b70c5bc40dd6003e7f8ac7eaef3ac5ac992a251b055d224981ab6142f9c460e2a0924ce7691bfbf0cc560e922f7f

data/README.md

@@ -149,25 +149,19 @@ client = MailchimpAPI::Client.new(
 
 ## Pagination
 
-We have two specific methods:
-
-- `MailchimpAPI#each_page(response)` - iterates over current and each next page
-  response
-- `MailchimpAPI#each_page_item(response, items: :members)` - iterates over
-  each item (each member in this case)
-
-Example:
+All REST resources have `#each` method. Example:
 
 ```ruby
-first_page = MailchimpAPI.audience_members.list(list_id, query: { count: 100 }
+MailchimpAPI.audience_members.each(list_id) { |member| ... }
+MailchimpAPI.audience_member_tags.each(list_id, member_id) { |tag| ... }
+```
 
-MailchimpAPI.each_page(first_page) do |response|
-  puts response.body
-end
+`Each` method accepts `query`, `body` and `headers` as any other API.
+By default it requests 1000 items on each page, but it is configurable through
+`query` parameter. Example:
 
-MailchimpAPI.each_page_item(first_page, items: :members) do |item|
-  puts item[:email_address]
-end
+```ruby
+MailchimpAPI.audience_members.each(list_id, query: { count: 100 }) { |member| ... }
 ```
 
 ## Request

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/lib/mailchimp-api/client.rb

@@ -6,7 +6,6 @@ module MailchimpAPI
 
     include APIMethods
     include BatchMethods
-    include PaginationMethods
 
     attr_reader :api_key, :api_url, :api_version, :authorization_token, :config
 

data/lib/mailchimp-api/pagination/list_each_item_helper.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module MailchimpAPI
+  module Pagination
+    module ListEachItemHelper
+      private
+
+      def list_each_item(items_field, *args, query: nil, body: nil, headers: nil, &block)
+        return enum_for(:list_each_item, items_field, *args, query: query, body: body, headers: headers) unless block
+
+        query = PrepareQueryParams.call(query, items_field: items_field)
+
+        loop do
+          response = list(*args, query: query, body: body, headers: headers)
+          response.body.fetch(items_field).each(&block)
+
+          total_received_items_count = query.fetch(:offset) + query.fetch(:count)
+          break if total_received_items_count >= response.body.fetch(:total_items)
+
+          query[:offset] = total_received_items_count
+        end
+      end
+    end
+  end
+end

data/lib/mailchimp-api/pagination/prepare_query_params.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module MailchimpAPI
+  module Pagination
+    class PrepareQueryParams
+      class << self
+        def call(query, items_field:)
+          query ||= {}
+          query = query.transform_keys(&:to_sym)
+
+          prepare_offset(query)
+          prepare_count(query)
+
+          ensure_fields_included(query, items_field: items_field, total_field: "total_items")
+          ensure_fields_not_excluded(query, items_field: items_field, total_field: "total_items")
+          query
+        end
+
+        private
+
+        def prepare_offset(query)
+          query[:offset] = query[:offset].to_i
+        end
+
+        def prepare_count(query)
+          query[:count] = query[:count].to_i
+          query[:count] = 1000 if query[:count] == 0
+        end
+
+        def ensure_fields_included(query, items_field:, total_field:)
+          fields = query[:fields] || ""
+          query[:fields] = (fields.split(",") + [items_field.to_s, total_field]).uniq.join(",")
+        end
+
+        def ensure_fields_not_excluded(query, items_field:, total_field:)
+          excluded_fields = query[:excluded_fields]
+          return unless excluded_fields
+
+          excluded_fields = (excluded_fields.split(",") - [items_field.to_s, total_field]).join(",")
+          excluded_fields.empty? ? query.delete(:excluded_fields) : query[:excluded_fields] = excluded_fields
+        end
+      end
+    end
+  end
+end

data/lib/mailchimp-api/resources/audience/interest_categories.rb

@@ -4,6 +4,8 @@ module MailchimpAPI
   module Audience
     class InterestCategories < Resource
       module APIs
+        include Pagination::ListEachItemHelper
+
         def list(list_id, query: nil, body: nil, headers: nil)
           path = "/lists/#{list_id}/interest-categories"
           client.get(path, query: query, body: body, headers: headers)
@@ -28,6 +30,10 @@ module MailchimpAPI
           path = "/lists/#{list_id}/interest-categories/#{interest_category_id}"
           client.patch(path, query: query, body: body, headers: headers)
         end
+
+        def each(list_id, query: nil, body: nil, headers: nil, &block)
+          list_each_item(:categories, list_id, query: query, body: body, headers: headers, &block)
+        end
       end
 
       include APIs

data/lib/mailchimp-api/resources/audience/interests.rb

@@ -4,6 +4,8 @@ module MailchimpAPI
   module Audience
     class Interests < Resource
       module APIs
+        include Pagination::ListEachItemHelper
+
         def list(list_id, interest_category_id, query: nil, body: nil, headers: nil)
           path = "/lists/#{list_id}/interest-categories/#{interest_category_id}/interests"
           client.get(path, query: query, body: body, headers: headers)
@@ -28,6 +30,10 @@ module MailchimpAPI
           path = "/lists/#{list_id}/interest-categories/#{interest_category_id}/interests/#{interest_id}"
           client.patch(path, query: query, body: body, headers: headers)
         end
+
+        def each(list_id, interest_category_id, query: nil, body: nil, headers: nil, &block)
+          list_each_item(:interests, list_id, interest_category_id, query: query, body: body, headers: headers, &block)
+        end
       end
 
       include APIs

data/lib/mailchimp-api/resources/audience/member_tags.rb

@@ -4,6 +4,8 @@ module MailchimpAPI
   module Audience
     class MemberTags < Resource
       module APIs
+        include Pagination::ListEachItemHelper
+
         def list(list_id, email, query: nil, body: nil, headers: nil)
           path = "/lists/#{list_id}/members/#{subscriber_hash(email)}/tags"
           client.get(path, query: query, body: body, headers: headers)
@@ -13,6 +15,10 @@ module MailchimpAPI
           path = "/lists/#{list_id}/members/#{subscriber_hash(email)}/tags"
           client.post(path, query: query, body: body, headers: headers)
         end
+
+        def each(list_id, email, query: nil, body: nil, headers: nil, &block)
+          list_each_item(:tags, list_id, email, query: query, body: body, headers: headers, &block)
+        end
       end
 
       include MailchimpAPI::Audience::Utils

data/lib/mailchimp-api/resources/audience/members.rb

@@ -4,6 +4,8 @@ module MailchimpAPI
   module Audience
     class Members < Resource
       module APIs
+        include Pagination::ListEachItemHelper
+
         def list(list_id, query: nil, body: nil, headers: nil)
           path = "/lists/#{list_id}/members"
           client.get(path, query: query, body: body, headers: headers)
@@ -38,6 +40,10 @@ module MailchimpAPI
           path = "/lists/#{list_id}/members/#{subscriber_hash(email)}/actions/delete-permanent"
           client.post(path, query: query, body: body, headers: headers)
         end
+
+        def each(list_id, query: nil, body: nil, headers: nil, &block)
+          list_each_item(:members, list_id, query: query, body: body, headers: headers, &block)
+        end
       end
 
       include MailchimpAPI::Audience::Utils

data/lib/mailchimp-api/resources/audience/webhooks.rb

@@ -4,6 +4,8 @@ module MailchimpAPI
   module Audience
     class Webhooks < Resource
       module APIs
+        include Pagination::ListEachItemHelper
+
         def list(list_id, query: nil, body: nil, headers: nil)
           path = "/lists/#{list_id}/webhooks"
           client.get(path, query: query, body: body, headers: headers)
@@ -28,6 +30,10 @@ module MailchimpAPI
           path = "/lists/#{list_id}/webhooks/#{webhook_id}"
           client.patch(path, query: query, body: body, headers: headers)
         end
+
+        def each(list_id, query: nil, body: nil, headers: nil, &block)
+          list_each_item(:webhooks, list_id, query: query, body: body, headers: headers, &block)
+        end
       end
 
       include APIs

data/lib/mailchimp-api.rb

@@ -49,6 +49,8 @@ module MailchimpAPI
   end
 end
 
+require_relative "mailchimp-api/pagination/list_each_item_helper"
+require_relative "mailchimp-api/pagination/prepare_query_params"
 require_relative "mailchimp-api/resource"
 require_relative "mailchimp-api/resources/audience/utils/subscriber_hash"
 require_relative "mailchimp-api/resources/audience/interest_categories"
@@ -59,7 +61,6 @@ require_relative "mailchimp-api/resources/audience/webhooks"
 require_relative "mailchimp-api/batch_request"
 require_relative "mailchimp-api/client/api_methods"
 require_relative "mailchimp-api/client/batch_methods"
-require_relative "mailchimp-api/client/pagination_methods"
 require_relative "mailchimp-api/client"
 require_relative "mailchimp-api/config"
 require_relative "mailchimp-api/error"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: mailchimp-rest-api
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Andrey Glushkov
 bindir: bin
 cert_chain: []
-date: 2025-04-28 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
 description: Marketing Mailchimp REST API with no dependencies.
 email:
@@ -23,11 +23,12 @@ files:
 - lib/mailchimp-api/client.rb
 - lib/mailchimp-api/client/api_methods.rb
 - lib/mailchimp-api/client/batch_methods.rb
-- lib/mailchimp-api/client/pagination_methods.rb
 - lib/mailchimp-api/config.rb
 - lib/mailchimp-api/error.rb
 - lib/mailchimp-api/failed_request_error_builder.rb
 - lib/mailchimp-api/network_error_builder.rb
+- lib/mailchimp-api/pagination/list_each_item_helper.rb
+- lib/mailchimp-api/pagination/prepare_query_params.rb
 - lib/mailchimp-api/request.rb
 - lib/mailchimp-api/request_executor.rb
 - lib/mailchimp-api/resource.rb
@@ -62,7 +63,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.8
 specification_version: 4
 summary: Mailchimp REST API (Marketing)
 test_files: []

data/lib/mailchimp-api/client/pagination_methods.rb

@@ -1,51 +0,0 @@
-# frozen_string_literal: true
-
-module MailchimpAPI
-  class Client
-    module PaginationMethods
-      # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
-      def next_page(response)
-        unless response.body.key?(:total_items)
-          raise Error, "Please ensure `total_items` field is not excluded from response"
-        end
-
-        request = response.request
-        query = request.query
-
-        count = query.key?(:count) ? query[:count].to_i : 10
-        offset = query.key?(:offset) ? query[:offset].to_i : 0
-
-        body = response.body
-        total_items = body[:total_items].to_i
-        is_final_page = ((offset + count) >= total_items)
-        return if is_final_page
-
-        new_query = query.merge(offset: offset + count, count: count)
-
-        get(
-          request.path,
-          query: new_query,
-          body: request.body,
-          headers: request.headers
-        )
-      end
-      # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
-
-      def each_page(response, &block)
-        return enum_for(:each_page, response) unless block
-
-        page = response
-        yield(page)
-        yield(page) while (page = next_page(page))
-      end
-
-      def each_page_item(response, items:, &block)
-        return enum_for(:each_page_item, response, items: items) unless block
-
-        each_page(response) do |page|
-          page.body.fetch(items).each(&block)
-        end
-      end
-    end
-  end
-end