big_marker_client 0.1.4 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6fb91b5a5354ae4629ec265e53476357d78dbd65da6996cf24de3c7866a3402
-  data.tar.gz: cadac9e803e07b4836b3a6008a825f976884877196852b9573fbc33c59f35386
+  metadata.gz: bceccab3ab7c9810771319f2432752db52a2c31fef2d7fb4278784738f99a4a0
+  data.tar.gz: 0eb375f2a3bf1fa03d2c03537ef8ae5fb55e64758ad4ed707f0f787aa031763a
 SHA512:
-  metadata.gz: 62a7c90fe1839b181dfe1f3103933de22053e7330a9e17044d17c5323a67929bd23bf9c1f81d8741807d56018c1c40c4b9a8765ecc6ed9137bd9ff4496cf5628
-  data.tar.gz: c08e7e125dc6fd43a8174f40d0c52d300431704030436b36f6afe942c379b081b9a1106b9aaf3a9254bd801ad6810a86dce4e12edc2ba5d78dd62ba76021911a
+  metadata.gz: 98cb9e67d4c3fec8ae756f1632a99100d7b9b624fe94b38231213809ed4efe824a59b652893be4d8807d29ed9f14b2b7ef26b81c245f458b404925929eef0dc4
+  data.tar.gz: d301b85ab74162be2fe8ef587e702bf9f108f170b323fb51fa9a1049b71bdd21c42dea5c2a633a31dcd9ab20864c089d40a5a6eef137ae27591747802a6c338e

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,29 @@
+# Changelog
+
+## [0.1.8] - unreleased
+
+- 
+
+## [0.1.7] - 2022-05-20
+
+- fix return types for update and create are different from show
+- fix attendee duration format (not integer minutes but time string)
+- add attendee field `certificate_of_completion`
+- add participant fields `enter_as_attendee`, `remove_bigmarker_contact_option`, `show_on_networking_center`,
+  `show_chat_icon_in_booth_or_session_room`
+- better error handling of date fields
+- better handling of attendees `SurveyResult`
+- bundle update
+
+## [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

data/Gemfile

@@ -15,7 +15,7 @@ group :development do
 end
 
 group :test do
-  gem "activesupport", "~> 6.0"
+  gem "activesupport", ">= 5.2"
   gem "factory_bot"
   gem "rspec", "~> 3.0"
   gem "webmock"

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

@@ -116,7 +116,7 @@ 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
@@ -126,7 +126,7 @@ module BigMarkerClient
           # @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)
+            loop_over(path, "child_conferences", ::BigMarkerClient::Models::Conference, params)
           end
 
           ##
@@ -137,7 +137,7 @@ module BigMarkerClient
           def update(conference_id, body = {})
             body = body.to_h if body.is_a?(::BigMarkerClient::Models::Conference)
             result = put(replace_path_params(path: UPDATE_CONFERENCE, replacements: { "{id}": conference_id }), body)
-            return ::BigMarkerClient::Models::Conference.new(result["conference"]) if result["conference"]
+            return ::BigMarkerClient::Models::Conference.new(result) if result["id"]
 
             result
           end
@@ -149,7 +149,7 @@ module BigMarkerClient
           def create(body = {})
             body = body.to_h if body.is_a?(::BigMarkerClient::Models::Base)
             result = post(CREATE_CONFERENCE, body)
-            return ::BigMarkerClient::Models::Conference.new(result["conference"]) if result["conference"]
+            return ::BigMarkerClient::Models::Conference.new(result) if result["id"]
 
             result
           end

data/lib/big_marker_client/base.rb

@@ -1,8 +1,9 @@
-require "typhoeus"
-require "typhoeus/adapters/faraday"
+require "faraday"
 
 module BigMarkerClient
   class Base
+    DEFAULT_PER_PAGE_SIZE = 25
+
     class << self
       def post(path, body = {})
         request(verb: :post, path: path, params: body)
@@ -36,10 +37,10 @@ module BigMarkerClient
         page = 1
         results = []
         loop do
-          params[:page] = page
+          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
+          break if break?(results: results, result: result, page: page, page_size: page_size(params))
 
           page += 1
         end
@@ -50,55 +51,71 @@ module BigMarkerClient
 
       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)
-        parse_body(response.body)
+        @http_client ||= HttpClient.new
+        response = @http_client.connection.send(verb.to_s, base_url(path), params)
+        return parse_body(response.body) if response.success?
+
+        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
 
       ##

data/lib/big_marker_client/config.rb

@@ -9,7 +9,7 @@ module BigMarkerClient
       end
 
       def api_key
-        @api_key ||= ENV["BIGMARKER_API_KEY"]
+        @api_key ||= ENV.fetch("BIGMARKER_API_KEY", nil)
       end
 
       def log

data/lib/big_marker_client/http_client.rb

@@ -0,0 +1,29 @@
+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
+    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

@@ -3,10 +3,9 @@ module BigMarkerClient
     class Attendee < Base
       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
+                    :time_zone, :country, :certificate_of_completion, :chats_count, :qas_count, :polls_count, :polls,
+                    :questions, :handouts, :browser_name, :browser_version, :device_name
+      attr_reader :view_handout, :download_handout, :survey_results
 
       def download_handout=(handout_array)
         @download_handout = if handout_array.nil? || !handout_array.is_a?(Array) || handout_array.empty?
@@ -16,6 +15,16 @@ module BigMarkerClient
                             end
       end
 
+      # TODO: handout has same structure as view_handout?
+
+      def survey_results=(results_array)
+        @survey_results = if results_array.nil? || !results_array.is_a?(Array) || results_array.empty?
+                            []
+                          else
+                            results_array.map { |result_hash| SurveyResult.new(result_hash) }
+                          end
+      end
+
       def view_handout=(handout_array)
         @view_handout = if handout_array.nil? || !handout_array.is_a?(Array) || handout_array.empty?
                           []

data/lib/big_marker_client/models/handout.rb

@@ -6,6 +6,8 @@ module BigMarkerClient
 
       def timestamp=(timestamp)
         @timestamp = DateTime.strptime(timestamp, "%m/%d/%Y %H:%M:%S %z") unless timestamp.nil? || timestamp == ""
+      rescue Date::Error
+        @timestamp = nil
       end
     end
   end

data/lib/big_marker_client/models/presenter.rb

@@ -6,7 +6,9 @@ module BigMarkerClient
                     :presenter_dial_in_id, :presenter_dial_in_passcode, :title, :bio, :can_manage, :is_moderator,
                     :facebook, :twitter, :linkedin, :website,
                     # for presenter creation
-                    :presenter_temporary_password, :send_email_invite, :add_to_channel_subscriber_list
+                    :presenter_temporary_password, :send_email_invite, :add_to_channel_subscriber_list,
+                    :enter_as_attendee, :remove_bigmarker_contact_option, :show_on_networking_center,
+                    :show_chat_icon_in_booth_or_session_room
 
       # differences between creation and retrieval, use creation as leading (oh well)
       alias display_name name

data/lib/big_marker_client/models/survey_result.rb

@@ -0,0 +1,18 @@
+module BigMarkerClient
+  module Models
+    class SurveyResult < Base
+      attr_accessor :question, :email, :response
+      attr_reader :date
+
+      def date=(date_str)
+        @date = Date.strptime(date_str, "%a, %b %d, %Y") unless date_str.nil? || date_str == ""
+      rescue Date::Error
+        @date = nil
+      end
+
+      def answered?
+        !response.nil? && response != ""
+      end
+    end
+  end
+end

data/lib/big_marker_client/version.rb

@@ -1,3 +1,3 @@
 module BigMarkerClient
-  VERSION = "0.1.4".freeze
+  VERSION = "0.1.8".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
@@ -31,6 +32,7 @@ module BigMarkerClient
     autoload :PreloadFile, "big_marker_client/models/preload_file"
     autoload :Presenter, "big_marker_client/models/presenter"
     autoload :Registrant, "big_marker_client/models/registrant"
+    autoload :SurveyResult, "big_marker_client/models/survey_result"
     autoload :WebinarStats, "big_marker_client/models/webinar_stats"
   end
 end

data/spec/factories/big_marker/attendee.rb

@@ -10,8 +10,8 @@ FactoryBot.define do
     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" }
+    total_duration { Time.at(rand * 120 * 60).utc.strftime("%T") }
+    engaged_duration { Time.at(rand * 120 * 60).utc.strftime("%T") }
     attendance_monitor { { "show_popup" => 0, "click_popup" => 0 } }
     survey_results { [] }
     time_zone { "Europe/Berlin" }
@@ -27,6 +27,7 @@ FactoryBot.define do
     device_name { "desktop" }
     download_handout { [] }
     view_handout { [] }
+    certificate_of_completion { "" }
 
     initialize_with do
       new(id: id, bmid: bmid, conference_id: conference_id, email: email, first_name: first_name, last_name: last_name,
@@ -36,7 +37,7 @@ FactoryBot.define do
           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)
+          view_handout: view_handout, certificate_of_completion: certificate_of_completion)
     end
 
     trait :with_view_handouts do

data/spec/factories/big_marker/presenter.rb

@@ -24,6 +24,10 @@ FactoryBot.define do
     presenter_temporary_password { "secret" }
     send_email_invite { true }
     add_to_channel_subscriber_list { false }
+    enter_as_attendee { false }
+    remove_bigmarker_contact_option { true }
+    show_on_networking_center { true }
+    show_chat_icon_in_booth_or_session_room { true }
 
     initialize_with do
       new(presenter_id: presenter_id, member_id: member_id, conference_id: conference_id, name: name,
@@ -34,7 +38,10 @@ FactoryBot.define do
           title: title, bio: bio, can_manage: can_manage, is_moderator: is_moderator, facebook: facebook,
           twitter: twitter, linkedin: linkedin, website: website,
           presenter_temporary_password: presenter_temporary_password, send_email_invite: send_email_invite,
-          add_to_channel_subscriber_list: add_to_channel_subscriber_list)
+          add_to_channel_subscriber_list: add_to_channel_subscriber_list, enter_as_attendee: enter_as_attendee,
+          remove_bigmarker_contact_option: remove_bigmarker_contact_option,
+          show_on_networking_center: show_on_networking_center,
+          show_chat_icon_in_booth_or_session_room: show_chat_icon_in_booth_or_session_room)
     end
   end
 end

data/spec/factories/big_marker/survey_result.rb

@@ -0,0 +1,12 @@
+FactoryBot.define do
+  factory :big_marker_survey_result, class: "BigMarkerClient::Models::SurveyResult" do
+    sequence(:question) { |n| "question #{n}" }
+    sequence(:email) { |n| "attendee-email#{n}@example.com" }
+    date { Date.today.strftime("%a, %b %d, %Y") }
+    response { "response" }
+
+    initialize_with do
+      new(question: question, email: email, date: date, response: response)
+    end
+  end
+end

metadata

@@ -1,43 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: big_marker_client
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.8
 platform: ruby
 authors:
 - Burkhard Vogel-Kreykenbohm
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-18 00:00:00.000000000 Z
+date: 2022-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: faraday-httpclient
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -52,20 +38,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: typhoeus
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
 description: Encapsulates calls to the BigMarker API to create ond retrieve conferences,
   participants, analytics and more
 email:
@@ -92,6 +64,7 @@ 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
@@ -100,6 +73,7 @@ files:
 - lib/big_marker_client/models/preload_file.rb
 - lib/big_marker_client/models/presenter.rb
 - lib/big_marker_client/models/registrant.rb
+- lib/big_marker_client/models/survey_result.rb
 - lib/big_marker_client/models/webinar_stats.rb
 - lib/big_marker_client/test_support.rb
 - lib/big_marker_client/version.rb
@@ -110,6 +84,7 @@ files:
 - spec/factories/big_marker/preload_file.rb
 - spec/factories/big_marker/presenter.rb
 - spec/factories/big_marker/registrant.rb
+- spec/factories/big_marker/survey_result.rb
 - spec/factories/big_marker/webinar_stats.rb
 homepage: https://gitlab.com/capinside-oss/big_marker_client
 licenses:
@@ -124,14 +99,14 @@ 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:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: simple client library to access the BigMarker API