big_marker_client 0.1.2 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9158ca174ac5afbc0b1b0057b3e50070f65ec0573a5244b5b5214b9de19d9bbb
-  data.tar.gz: 89a8f747bec556b71ecf3ee4ed0d7bf83d9310ea0d9682c6319402527f793c15
+  metadata.gz: 761022b647bdfeecdd833b29b236ff768cf2713d2d5c82a3986638d5cc67b0d5
+  data.tar.gz: 16707b0d879dd593066b400677c343bdfa47eed6d97e5132a5f99599b94e64e6
 SHA512:
-  metadata.gz: cbc3d4cb06b5ee68b65bafa1390ced3f73dc9a00f2c60aa111f7d32f369b4dcabfc24f3fb96b3ecc9a9d0a6521ff37d60ad74dc628ecfc25556c2b272943a484
-  data.tar.gz: bc6517c9c88a1f347cc27bf859a76e0b2a6b03078df0967f057e80805092c314d8ab1d0e61a3b3bc1037220b2cdf420d76e3df7d910327cdc7f7ddd23f3a50f0
+  metadata.gz: c18cf2836336c335143e01690ccbc3acdfaf96f39bc86d415270fc9e8bf8b97c5069f35d508e664a65dab94bd97cba7d191acada60fd242a710b56828229e948
+  data.tar.gz: 12d4ca8e8394a012f395dbd910c3a9835c9a072b20e88a39167f25adecf1b77d1483cbb42a303f05774b39405fc06bcda4fc806a8056b932003c9533935b36b7

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 3.0
+  TargetRubyVersion: 2.6
   NewCops: enable
   Exclude:
     - "vendor/**/*"
@@ -18,10 +18,6 @@ Metrics/BlockLength:
     - "spec/**/*"
     - "big_marker_client.gemspec"
 
-Performance/StringIdentifierArgument:
-  Exclude:
-    - "lib/big_marker_client/base.rb"
-
 Style/Documentation:
   Enabled: false
 

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+## [0.1.6] - 2022-01-19
+
+- fix recurring method to return "child_conferences"
+
+## [0.1.5] - 2022-01-19 (broken, don't use!)
+
+- refactor HTTP client into a separate class
+- fix looping if no meta-data is returned
+
+## [0.1.4] - 2022-01-18
+
+- add new properties to attendees and add handout model and factory
+
+## [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
@@ -93,11 +116,19 @@ module BigMarkerClient
           def recurring(conference_id, params = {})
             result = get(replace_path_params(path: RECURRING_CONFERENCES,
                                              replacements: { "{id}": conference_id }), params)
-            return map_to_model_array(result["conferences"]) if result["conferences"]
+            return map_to_model_array(result["child_conferences"]) if result["child_conferences"]
 
             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, "child_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

@@ -3,6 +3,8 @@ require "typhoeus/adapters/faraday"
 
 module BigMarkerClient
   class Base
+    DEFAULT_PER_PAGE_SIZE = 25
+
     class << self
       def post(path, body = {})
         request(verb: :post, path: path, params: body)
@@ -32,59 +34,94 @@ 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 break?(results: results, result: result, page: page, page_size: page_size(params))
+
+          page += 1
+        end
+        results
+      end
+
       private
 
       def request(path:, verb: :get, params: {})
         check_preconditions(verb, path)
+        params = stringify_keys(params)
 
         params = params.to_json unless %w[get delete].include?(verb.to_s)
-        response = http_client.send(verb.to_s, base_url(path), params)
+        @http_client ||= HttpClient.new
+        response = @http_client.connection.send(verb.to_s, base_url(path), params)
         parse_body(response.body)
       end
 
       def check_preconditions(verb, path)
-        if verb.nil? || path.nil? || BigMarkerClient::Config.api_key.nil?
-          raise ArgumentError, "http_method, path or api key is missing"
-        end
+        raise ArgumentError, "http_method, path or api key is missing" if verb.nil? || path.nil? || Config.api_key.nil?
         raise ArgumentError, "unsupported http_method: #{verb}" unless %w[post put patch delete get].include?(verb.to_s)
       end
 
-      def http_client
-        conn ||= Faraday.new(url: BigMarkerClient::Config.base_url) do |faraday|
-          faraday = headers(faraday)
-          configure_logging(faraday) if BigMarkerClient::Config.log
+      def stringify_keys(hash)
+        hash_symbol_keys = hash.keys.select { |key| key.is_a?(Symbol) }
+        hash_symbol_keys.each do |key|
+          hash[key.to_s] = hash[key]
+          hash.delete(key)
         end
-        conn.adapter :typhoeus
-        conn
-      end
-
-      def headers(adapter)
-        adapter.headers["Content-Type"] = "application/json"
-        adapter.headers["API-KEY"] = BigMarkerClient::Config.api_key unless BigMarkerClient::Config.api_key.nil?
-        adapter
-      end
-
-      def configure_logging(adapter)
-        adapter.response :logger do |logger|
-          logger.instance_variable_get("@options")[:log_level] = :debug if BigMarkerClient::Config.debug
-          logger.filter(/password=([^&]+)/, "password=[FILTERED]")
-          logger.filter(/API-KEY: "(\w*)"/, "API-KEY: [FILTERED]")
-        end
-        adapter
+        hash
       end
 
       def base_url(path)
-        BigMarkerClient::Config.base_url + (path.start_with?("/") ? path : "/#{path}")
+        Config.base_url + (path.start_with?("/") ? path : "/#{path}")
       end
 
       def parse_body(body)
         return nil if body.strip == ""
 
         json = JSON.parse(body)
-        BigMarkerClient::Config.logger.debug(json) if BigMarkerClient::Config.debug
+        Config.logger.debug(json) if Config.debug
         json
       rescue JSON::ParserError
-        raise BigMarkerClient::ResponseError, "invalid response"
+        raise ResponseError, "invalid response"
+      end
+
+      def page_size(params)
+        params["page_count"] || params.fetch("per_page", DEFAULT_PER_PAGE_SIZE)
+      end
+
+      ##
+      # BigMarker API is a total mess that won't return total_pages or total_entries on all request types so we have to
+      # get creative
+      def break?(results:, result:, page:, page_size:)
+        return true if break_on_full_metadata?(results: results, result: result, page: page) ||
+                       break_on_partial_metadata?(results: results, result: result, page: page)
+
+        results.length.zero? || (results.length % page_size) != 0 || (results.length.to_f / page_size) < page
+      end
+
+      def break_on_full_metadata?(results:, result:, page:)
+        if !result["total_pages"].nil? && !total_count(result).nil?
+          return ((page >= result["total_pages"].to_i) || (results.length >= total_count(result).to_i))
+        end
+
+        false
+      end
+
+      def break_on_partial_metadata?(results:, result:, page:)
+        return page >= result["total_pages"].to_i unless result["total_pages"].nil?
+        return results.length >= total_count(result).to_i unless total_count(result).nil?
+
+        false
+      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

data/lib/big_marker_client/http_client.rb

@@ -0,0 +1,30 @@
+module BigMarkerClient
+  class HttpClient
+    attr_reader :connection
+
+    def initialize
+      @connection = Faraday.new(url: Config.base_url) do |faraday|
+        faraday = headers(faraday)
+        configure_logging(faraday) if Config.log
+      end
+      @connection.adapter :typhoeus
+    end
+
+    private
+
+    def headers(adapter)
+      adapter.headers["Content-Type"] = "application/json"
+      adapter.headers["API-KEY"] = Config.api_key unless Config.api_key.nil?
+      adapter
+    end
+
+    def configure_logging(adapter)
+      adapter.response :logger do |logger|
+        logger.instance_variable_get(:@options)[:log_level] = :debug if Config.debug
+        logger.filter(/password=([^&]+)/, "password=[FILTERED]")
+        logger.filter(/API-KEY: "(\w*)"/, "API-KEY: [FILTERED]")
+      end
+      adapter
+    end
+  end
+end

data/lib/big_marker_client/models/attendee.rb

@@ -1,9 +1,28 @@
 module BigMarkerClient
   module Models
     class Attendee < Base
-      attr_accessor :email, :first_name, :last_name, :entered_at, :leaved_at, :total_duration, :engaged_duration,
+      attr_accessor :id, :bmid, :conference_id, :email, :first_name, :last_name, :edited_in_room_display_name,
+                    :custom_fields, :entered_at, :leaved_at, :total_duration, :engaged_duration, :attendance_monitor,
+                    :survey_results, :time_zone, :country,
                     :chats_count, :qas_count, :polls_count, :polls, :questions, :handouts, :browser_name,
                     :browser_version, :device_name
+      attr_reader :view_handout, :download_handout
+
+      def download_handout=(handout_array)
+        @download_handout = if handout_array.nil? || !handout_array.is_a?(Array) || handout_array.empty?
+                              []
+                            else
+                              handout_array.map { |handout_hash| Handout.new(handout_hash) }
+                            end
+      end
+
+      def view_handout=(handout_array)
+        @view_handout = if handout_array.nil? || !handout_array.is_a?(Array) || handout_array.empty?
+                          []
+                        else
+                          handout_array.map { |handout_hash| Handout.new(handout_hash) }
+                        end
+      end
     end
   end
 end

data/lib/big_marker_client/models/handout.rb

@@ -0,0 +1,12 @@
+module BigMarkerClient
+  module Models
+    class Handout < Base
+      attr_accessor :type, :email, :content, :source_from
+      attr_reader :timestamp
+
+      def timestamp=(timestamp)
+        @timestamp = DateTime.strptime(timestamp, "%m/%d/%Y %H:%M:%S %z") unless timestamp.nil? || timestamp == ""
+      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.6".freeze
 end

data/lib/big_marker_client.rb

@@ -10,6 +10,7 @@ module BigMarkerClient
 
   autoload :Base, "big_marker_client/base"
   autoload :Config, "big_marker_client/config"
+  autoload :HttpClient, "big_marker_client/http_client"
   autoload :Version, "big_marker_client/version"
 
   module Api
@@ -27,6 +28,7 @@ module BigMarkerClient
     autoload :Base, "big_marker_client/models/base"
     autoload :Conference, "big_marker_client/models/conference"
     autoload :DialInInformation, "big_marker_client/models/dial_in_information"
+    autoload :Handout, "big_marker_client/models/handout"
     autoload :PreloadFile, "big_marker_client/models/preload_file"
     autoload :Presenter, "big_marker_client/models/presenter"
     autoload :Registrant, "big_marker_client/models/registrant"

data/spec/factories/big_marker/attendee.rb

@@ -1,12 +1,21 @@
 FactoryBot.define do
   factory :big_marker_attendee, class: "BigMarkerClient::Models::Attendee" do
+    sequence(:id)
+    sequence(:bmid) { SecureRandom.hex(6) }
+    sequence(:conference_id) { SecureRandom.hex(6) }
     sequence(:email) { |n| "attendee#{n}@example.com" }
     first_name { "Attendee first name" }
     last_name { "Attendee last name" }
+    edited_in_room_display_name { nil }
+    custom_fields { [] }
     entered_at { (Time.now - (60 * BigMarkerClient::TestSupport::MINUTES)).strftime("%FT%T%:z") }
     leaved_at { Time.now.strftime("%FT%T%:z") }
     total_duration { "3600" }
     engaged_duration { "240" }
+    attendance_monitor { { "show_popup" => 0, "click_popup" => 0 } }
+    survey_results { [] }
+    time_zone { "Europe/Berlin" }
+    country { "Germany" }
     chats_count { 1 }
     qas_count { 0 }
     polls_count { 2 }
@@ -16,12 +25,26 @@ FactoryBot.define do
     browser_name { "Google Chrome" }
     browser_version { 96 }
     device_name { "desktop" }
+    download_handout { [] }
+    view_handout { [] }
 
     initialize_with do
-      new(email: email, first_name: first_name, last_name: last_name, entered_at: entered_at, leaved_at: leaved_at,
-          total_duration: total_duration, engaged_duration: engaged_duration, chats_count: chats_count,
-          qas_count: qas_count, polls_count: polls_count, polls: polls, questions: questions, handouts: handouts,
-          browser_name: browser_name, browser_version: browser_version, device_name: device_name)
+      new(id: id, bmid: bmid, conference_id: conference_id, email: email, first_name: first_name, last_name: last_name,
+          edited_in_room_display_name: edited_in_room_display_name, custom_fields: custom_fields,
+          entered_at: entered_at, leaved_at: leaved_at, total_duration: total_duration,
+          engaged_duration: engaged_duration, attendance_monitor: attendance_monitor, survey_results: survey_results,
+          time_zone: time_zone, country: country, chats_count: chats_count, qas_count: qas_count,
+          polls_count: polls_count, polls: polls, questions: questions, handouts: handouts, browser_name: browser_name,
+          browser_version: browser_version, device_name: device_name, download_handout: download_handout,
+          view_handout: view_handout)
+    end
+
+    trait :with_view_handouts do
+      view_handout { build_list(:big_marker_handout, 1, :view_handout) }
+    end
+
+    trait :with_download_handouts do
+      download_handout { build_list(:big_marker_handout, 1, :download_handout) }
     end
   end
 end

data/spec/factories/big_marker/handout.rb

@@ -0,0 +1,21 @@
+FactoryBot.define do
+  factory :big_marker_handout, class: "BigMarkerClient::Models::Handout" do
+    type { "handout" }
+    sequence(:email) { |n| "attendee-email#{n}@example.com" }
+    sequence(:content) { |n| "some_file_name#{n}.pdf" }
+    timestamp { Time.now.strftime("%m/%d/%Y %H:%M:%S %z") }
+    source_from { "Live Webinar" }
+
+    trait :view_handout do
+      type { "view_handout" }
+    end
+
+    trait :download_handout do
+      type { "download_handout" }
+    end
+
+    initialize_with do
+      new(type: type, email: email, content: content, timestamp: timestamp, source_from: source_from)
+    end
+  end
+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.6
 platform: ruby
 authors:
 - Burkhard Vogel-Kreykenbohm
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-07 00:00:00.000000000 Z
+date: 2022-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -92,10 +92,12 @@ files:
 - lib/big_marker_client/api/v1/presenter.rb
 - lib/big_marker_client/base.rb
 - lib/big_marker_client/config.rb
+- lib/big_marker_client/http_client.rb
 - lib/big_marker_client/models/attendee.rb
 - lib/big_marker_client/models/base.rb
 - lib/big_marker_client/models/conference.rb
 - lib/big_marker_client/models/dial_in_information.rb
+- lib/big_marker_client/models/handout.rb
 - lib/big_marker_client/models/preload_file.rb
 - lib/big_marker_client/models/presenter.rb
 - lib/big_marker_client/models/registrant.rb
@@ -105,6 +107,7 @@ files:
 - spec/factories/big_marker/attendee.rb
 - spec/factories/big_marker/conference.rb
 - spec/factories/big_marker/dial_in_infromation.rb
+- spec/factories/big_marker/handout.rb
 - spec/factories/big_marker/preload_file.rb
 - spec/factories/big_marker/presenter.rb
 - spec/factories/big_marker/registrant.rb
@@ -122,7 +125,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="