big_marker_client 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9158ca174ac5afbc0b1b0057b3e50070f65ec0573a5244b5b5214b9de19d9bbb
-  data.tar.gz: 89a8f747bec556b71ecf3ee4ed0d7bf83d9310ea0d9682c6319402527f793c15
+  metadata.gz: 4ae319a03754f05c2928906fefa27dbfdf3e19fad1a0bc6f12d1711760451a8b
+  data.tar.gz: b6682c4b5c54470b6aadfeaf0ae88fcca0c37a98ce001b2eb4c88fd8c1c70bea
 SHA512:
-  metadata.gz: cbc3d4cb06b5ee68b65bafa1390ced3f73dc9a00f2c60aa111f7d32f369b4dcabfc24f3fb96b3ecc9a9d0a6521ff37d60ad74dc628ecfc25556c2b272943a484
-  data.tar.gz: bc6517c9c88a1f347cc27bf859a76e0b2a6b03078df0967f057e80805092c314d8ab1d0e61a3b3bc1037220b2cdf420d76e3df7d910327cdc7f7ddd23f3a50f0
+  metadata.gz: d19877b53cad7224ef8a1c9af5689510e7d42f9bcb5abaf536ffd1a511d3ba04e562e0568a874bfe3e36295ec84df26094f378b6aac3b16f91daa486cccad196
+  data.tar.gz: 9154f4eec680cb10f429c85fd3cd85fd1bd57aed2407350b49601488e24e3899b4d69b40930ec90b98cedf58f6d3f2c85ad17b0f3e1f12b6e04a65046d9842dc

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## [0.1.3] - 2022-01-11
+
+- add helper methods to iterate over all pages for paginated requests
+
 ## [0.1.2] - 2022-01-07
 
 - actually package the factories into the gem

data/lib/big_marker_client/api/v1/conference/registration.rb

@@ -24,6 +24,14 @@ module BigMarkerClient
               result
             end
 
+            ##
+            # helper method to retrieve all pages for the #list method
+            # @see #list
+            def list_all(conference_id, params = {})
+              path = replace_path_params(path: LIST_REGISTRANTS, replacements: { "{id}": conference_id })
+              loop_over(path, "registrations", ::BigMarkerClient::Models::Registrant, params)
+            end
+
             ##
             # list all registrants to a conference with custom fields.
             # @param conference_id [String] conference identifier
@@ -39,6 +47,14 @@ module BigMarkerClient
               result
             end
 
+            ##
+            # helper method to retrieve all pages for the #list_with_fields method
+            # @see #list_with_fields
+            def list_all_with_fields(conference_id, params = {})
+              path = replace_path_params(path: LIST_REGISTRANTS_WITH_FIELDS, replacements: { "{id}": conference_id })
+              loop_over(path, "registrations", ::BigMarkerClient::Models::Registrant, params)
+            end
+
             ##
             # registers a participant to a conference.
             # @param conference_id [String] conference identifier
@@ -86,8 +102,8 @@ module BigMarkerClient
 
             private
 
-            def map_to_model_array(hash_array)
-              hash_array.map { |hash| ::BigMarkerClient::Models::Registrant.new(hash) }
+            def map_to_model_array(hash_array, model_class = ::BigMarkerClient::Models::Registrant)
+              hash_array.map { |hash| model_class.new(hash) }
             end
           end
         end

data/lib/big_marker_client/api/v1/conference.rb

@@ -34,6 +34,14 @@ module BigMarkerClient
             result
           end
 
+          ##
+          # helper method to retrieve all pages for the #list method
+          # @see #list
+          def list_all(params = {})
+            params["page_count"] ||= params["per_page"] if params["per_page"]
+            loop_over(LIST_CONFERENCES, "conferences", ::BigMarkerClient::Models::Conference, params)
+          end
+
           ##
           # search for conferences with specific matching criteria.
           # @param params [Hash] recognized are:
@@ -55,6 +63,13 @@ module BigMarkerClient
             result
           end
 
+          ##
+          # helper method to retrieve all pages for the #search method
+          # @see #search
+          def search_all(params = {})
+            loop_over(SEARCH_CONFERENCES, "conferences", ::BigMarkerClient::Models::Conference, params, :post)
+          end
+
           ##
           # get one conference based on it's ID
           # @param conference_id [String] conference identifier
@@ -81,6 +96,14 @@ module BigMarkerClient
             result
           end
 
+          ##
+          # helper method to retrieve all pages for the #associated_series method
+          # @see #associated_series
+          def associated_series_all(conference_id, params = {})
+            path = replace_path_params(path: ASSOCIATED_SERIES_CONFERENCES, replacements: { "{id}": conference_id })
+            loop_over(path, "conferences", ::BigMarkerClient::Models::Conference, params)
+          end
+
           ##
           # get child conferences of a parent recurring conference.
           # @param conference_id [String] conference identifier
@@ -98,6 +121,14 @@ module BigMarkerClient
             result
           end
 
+          ##
+          # helper method to retrieve all pages for the #recurring method
+          # @see #recurring
+          def recurring_all(conference_id, params = {})
+            path = replace_path_params(path: RECURRING_CONFERENCES, replacements: { "{id}": conference_id })
+            loop_over(path, "conferences", ::BigMarkerClient::Models::Conference, params)
+          end
+
           ##
           # update a conference either with a Models::Conference object or single properties as hash
           # @param conference_id [String] conference identifier
@@ -176,6 +207,14 @@ module BigMarkerClient
             result
           end
 
+          ##
+          # helper method to retrieve all pages for the #attendees method
+          # @see #attendees
+          def attendees_all(conference_id, params = {})
+            path = replace_path_params(path: GET_CONFERENCE_ATTENDEES, replacements: { "{id}": conference_id })
+            loop_over(path, "attendees", ::BigMarkerClient::Models::Attendee, params)
+          end
+
           private
 
           def map_to_model_array(hash_array, model_class = ::BigMarkerClient::Models::Conference)

data/lib/big_marker_client/base.rb

@@ -32,6 +32,20 @@ module BigMarkerClient
         new_path
       end
 
+      def loop_over(path, field, model_class, params = {}, method = :get)
+        page = 1
+        results = []
+        loop do
+          params[:page] = page
+          result = send(method, path, params)
+          results += map_to_model_array(result[field], model_class) if result[field]
+          break if page >= result["total_pages"].to_i || results.length >= total_count(result).to_i
+
+          page += 1
+        end
+        results
+      end
+
       private
 
       def request(path:, verb: :get, params: {})
@@ -86,6 +100,13 @@ module BigMarkerClient
       rescue JSON::ParserError
         raise BigMarkerClient::ResponseError, "invalid response"
       end
+
+      ##
+      # conferences#list is a total mess as requests require `page_count` instead of `per_page` as everywhere else and
+      # ti will return `total_count` instead of `total_entries` compared to the rest
+      def total_count(response)
+        response["total_entries"] || response["total_count"]
+      end
     end
   end
 end

data/lib/big_marker_client/version.rb

@@ -1,3 +1,3 @@
 module BigMarkerClient
-  VERSION = "0.1.2".freeze
+  VERSION = "0.1.3".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: big_marker_client
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Burkhard Vogel-Kreykenbohm
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-07 00:00:00.000000000 Z
+date: 2022-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday