big_marker_client 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bceccab3ab7c9810771319f2432752db52a2c31fef2d7fb4278784738f99a4a0
-  data.tar.gz: 0eb375f2a3bf1fa03d2c03537ef8ae5fb55e64758ad4ed707f0f787aa031763a
+  metadata.gz: ef58a11c9bb23d90fdb4f35ebb17cc9aea7a0782d9acb09324db9a87dd3ffcb5
+  data.tar.gz: a594edc8149b000c227b9afa0734a64f02465720fa132ebedff782f0b8bca602
 SHA512:
-  metadata.gz: 98cb9e67d4c3fec8ae756f1632a99100d7b9b624fe94b38231213809ed4efe824a59b652893be4d8807d29ed9f14b2b7ef26b81c245f458b404925929eef0dc4
-  data.tar.gz: d301b85ab74162be2fe8ef587e702bf9f108f170b323fb51fa9a1049b71bdd21c42dea5c2a633a31dcd9ab20864c089d40a5a6eef137ae27591747802a6c338e
+  metadata.gz: c41626edde5f66fe935a7f5f99f73845312cc4ee932dbdf73556020c5b1362b1ac51a0ab705ed701475f9b138546f16d78454a7e1bc8c430782ea733cfc539ed
+  data.tar.gz: 2609de80a34de2da857405734bb1cc06c506300ee09f17b3f77e099651dea85e62055788e466df7dc437a33b2abdc20d4cca8f340dd70d52bc5f77f8c5f320ec

data/CHANGELOG.md

@@ -1,8 +1,14 @@
 # Changelog
 
-## [0.1.8] - unreleased
+## [0.1.9]
 
-- 
+- add conference fields `tags`, `banner_filter_percentage`
+- add attendee fields `start_time`, `coupon_used`
+- add webhooks related fields
+
+## [0.1.8] - 2022-05-20
+
+- loosen faraday dependency
 
 ## [0.1.7] - 2022-05-20
 

data/CODE_OF_CONDUCT.md

@@ -39,7 +39,7 @@ This Code of Conduct applies within all community spaces, and also applies when
 
 ## Enforcement
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at bvk@capinside.com. All complaints will be reviewed and investigated promptly and fairly.
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the [community leaders responsible for enforcement](mailto:core-crew@capinside.com). All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the reporter of any incident.
 

data/README.md

@@ -1,8 +1,6 @@
 # BigMarkerClient
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/bigmarker_client`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+This is a lightweight wrapper for rails around the [BigMarker API](https://docs.bigmarker.com/). You will need an API key to be able to use it, set it in the configuration.
 
 ## Installation
 
@@ -24,6 +22,8 @@ Or install it yourself as:
 
 As this is a lightweight wrapper around the BigMarker API, mostly refer to [their documentation](https://docs.bigmarker.com/). Most notably the creation of conferences will require a brief look into their requirements.
 
+To be able to connect to BigMarker you need to set the `BigMarkerClient::Config.api_key`, as a default this will look for an environment variable `BIGMARKER_API_KEY` to read the key from.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -36,11 +36,11 @@ Only a limited set of all API functions are currently implemented, however the e
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://gitlab.com/capinside-oss/big_marker_client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://gitlab.com/capinside-oss/big_marker_client/-/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://gitlab.com/capinside-oss/big_marker_client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://gitlab.com/capinside/big_marker_client/-/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). BigMarker is a registered trademark of BigMarker.com LLC., Chicago Illinois USA.
 
 ## Code of Conduct
 

data/lib/big_marker_client/base.rb

@@ -100,7 +100,9 @@ module BigMarkerClient
         return true if break_on_full_metadata?(results: results, result: result, page: page) ||
                        break_on_partial_metadata?(results: results, result: result, page: page)
 
+        # rubocop:disable Style/ZeroLengthPredicate
         results.length.zero? || (results.length % page_size) != 0 || (results.length.to_f / page_size) < page
+        # rubocop:enable Style/ZeroLengthPredicate
       end
 
       def break_on_full_metadata?(results:, result:, page:)

data/lib/big_marker_client/models/attendee.rb

@@ -4,7 +4,7 @@ module BigMarkerClient
       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,
                     :time_zone, :country, :certificate_of_completion, :chats_count, :qas_count, :polls_count, :polls,
-                    :questions, :handouts, :browser_name, :browser_version, :device_name
+                    :questions, :handouts, :browser_name, :browser_version, :device_name, :start_time, :coupon_used
       attr_reader :view_handout, :download_handout, :survey_results
 
       def download_handout=(handout_array)

data/lib/big_marker_client/models/conference.rb

@@ -3,22 +3,36 @@ module BigMarkerClient
     ##
     # for supported values for time_zone please compare [the documentation](https://docs.bigmarker.com/#time-zones)
     class Conference < Base
-      attr_accessor :id, :title, :event_type, :display_language, :meeting_mode, :type, :conference_copy_id,
-                    :master_webinar_id, :max_attendance, :purpose, :start_time, :duration_minutes, :conference_address,
-                    :custom_event_id, :channel_id, :webcast_mode, :end_time, :moderator_open_time, :audience_open_time,
-                    :first_admin_enter_time, :manual_end_time, :privacy, :exit_url, :enable_registration_email,
-                    :enable_knock_to_enter, :send_reminder_emails_to_presenters, :review_emails,
-                    :poll_results, :enable_ie_safari, :enable_twitter, :auto_invite_all_channel_members,
-                    :send_cancellation_email, :show_reviews, :registration_required_to_view_recording,
-                    :who_can_watch_recording, :show_handout_on_page, :background_image_url, :room_logo, :agenda_topics,
-                    :disclaimer, :recorded, :recording_url, :recording_iframe,
+      attr_accessor :agenda_topics, :audience_open_time, :auto_invite_all_channel_members, :background_image_url,
+                    :banner_filter_percentage, :channel_id, :conference_address, :conference_copy_id, :custom_event_id,
+                    :disclaimer, :display_language, :duration_minutes, :enable_ie_safari, :enable_knock_to_enter,
+                    :enable_registration_email, :enable_twitter, :end_time, :event_type, :exit_url,
+                    :first_admin_enter_time, :id, :manual_end_time, :master_webinar_id, :max_attendance, :meeting_mode,
+                    :moderator_open_time, :poll_results, :privacy, :purpose, :recorded, :recording_duration,
+                    :recording_iframe, :recording_url, :registration_required_to_view_recording, :review_emails,
+                    :room_logo, :send_cancellation_email, :send_reminder_emails_to_presenters, :show_handout_on_page,
+                    :show_reviews, :start_time, :time_zone, :title, :type, :webcast_mode, :webhook_url, :webinar_tags,
+                    :who_can_watch_recording,
+                    ## CCs seems unused?
+                    :enable_closed_caption, :cc_original_language, :cc_display_language,
+                    # breakout room related
+                    :enable_breakout_rooms, :enable_breakout_time, :breakout_time_limit, :breakout_mode,
+                    :allow_breakout_mic, :allow_breakout_cam, :allow_breakout_screen, :allow_breakout_whiteboard,
+                    :allow_breakout_slide, :main_room_return, :unnassigned_attendee, :unnassigned_presenter,
+                    :breakout_room_total,
                     # for conference creation
-                    :sub_url, :enable_dial_in, :time_zone, :schedule_type, :recurring_start_times,
-                    :presenter_advanced_enter_time, :attendee_advanced_enter_time, :webinar_format,
-                    :registration_conf_emails, :send_notification_emails_to_presenters, :webhook_url, :channel_admin_id,
-                    :free_for_all, :room_type, :room_sub_title
+                    :sub_url, :enable_dial_in, :room_sub_title, :schedule_type, :recurring_start_times,
+                    :presenter_advanced_enter_time, :attendee_advanced_enter_time, :webinar_format, :ondemand_video_url,
+                    :registration_conf_emails, :send_notification_emails_to_presenters, :channel_admin_id,
+                    :room_type, :icon,
+                    # webhook related
+                    :enable_create_webinar_reg_webhook, :enable_new_reg_webhook,
+                    :enable_webinar_start_webhook, :webinar_start_webhook_url, :enable_waiting_room_open_webhook,
+                    :waiting_room_open_webhook_url, :enable_webinar_end_webhook, :webinar_end_webhook_url,
+                    :enable_live_attendee_data_webhook, :live_attendee_data_webhook_url,
+                    :enable_on_demand_viewer_webhook, :on_demand_viewer_webhook_url
 
-      attr_reader :dial_in_information, :preload_files, :presenters, :webinar_stats, :associated_series
+      attr_reader :associated_series, :dial_in_information, :preload_files, :presenters, :webinar_stats
 
       # differences between creation and retrieval, use creation as leading (oh well)
       alias can_view_poll_results poll_results
@@ -31,6 +45,8 @@ module BigMarkerClient
       alias language= display_language=
       alias copy_webinar_id conference_copy_id
       alias copy_webinar_id= conference_copy_id=
+      alias tags webinar_tags
+      alias tags= webinar_tags=
 
       def dial_in_information=(dial_in_hash)
         @dial_in_information = if dial_in_hash.nil? || !dial_in_hash.is_a?(Hash)

data/lib/big_marker_client/version.rb

@@ -1,3 +1,3 @@
 module BigMarkerClient
-  VERSION = "0.1.8".freeze
+  VERSION = "0.1.9".freeze
 end

data/spec/factories/big_marker/attendee.rb

@@ -28,16 +28,18 @@ FactoryBot.define do
     download_handout { [] }
     view_handout { [] }
     certificate_of_completion { "" }
+    start_time { (Time.now - (45 * BigMarkerClient::TestSupport::MINUTES)).strftime("%FT%T%:z") }
+    coupon_used { nil }
 
     initialize_with do
       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,
+          entered_at: entered_at, leaved_at: leaved_at, total_duration: total_duration, start_time: start_time,
           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, certificate_of_completion: certificate_of_completion)
+          view_handout: view_handout, certificate_of_completion: certificate_of_completion, coupon_used: coupon_used)
     end
 
     trait :with_view_handouts do

data/spec/factories/big_marker/conference.rb

@@ -18,6 +18,7 @@ FactoryBot.define do
     duration_minutes { 60 }
     sequence(:conference_address) { |n| "https://host.example.com/example_channel/event-#{n}" }
     custom_event_id { nil }
+    banner_filter_percentage { Random.rand.round(2) }
     channel_id { "example_channel" }
     webcast_mode { "automatic" }
     end_time { (start_time_obj + (duration_minutes * BigMarkerClient::TestSupport::MINUTES)).strftime("%FT%T%:z") }
@@ -45,6 +46,7 @@ FactoryBot.define do
     agenda_topics { [] }
     disclaimer { "disclaimer" }
     recorded { false }
+    recording_duration { 0 }
     recording_url { nil }
     recording_iframe { nil }
     sequence(:sub_url) { |n| "event-#{n}" }
@@ -59,9 +61,11 @@ FactoryBot.define do
     send_notification_emails_to_presenters { true }
     webhook_url { nil }
     channel_admin_id { nil }
-    free_for_all { false }
     room_type { nil }
     room_sub_title { nil }
+    ondemand_video_url { nil }
+    webinar_tags { [] }
+    icon { nil }
     dial_in_information { nil }
     preload_files { [] }
     presenters { [] }
@@ -73,13 +77,14 @@ FactoryBot.define do
           type: type, conference_copy_id: conference_copy_id, master_webinar_id: master_webinar_id,
           max_attendance: max_attendance, purpose: purpose, start_time: start_time, duration_minutes: duration_minutes,
           channel_id: channel_id, conference_address: conference_address, custom_event_id: custom_event_id,
+          banner_filter_percentage: banner_filter_percentage, recording_duration: recording_duration,
           webcast_mode: webcast_mode, end_time: end_time, moderator_open_time: moderator_open_time,
           audience_open_time: audience_open_time, first_admin_enter_time: first_admin_enter_time,
           manual_end_time: manual_end_time, privacy: privacy, exit_url: exit_url,
           enable_registration_email: enable_registration_email, enable_knock_to_enter: enable_knock_to_enter,
           review_emails: review_emails, send_reminder_emails_to_presenters: send_reminder_emails_to_presenters,
           poll_results: poll_results, enable_ie_safari: enable_ie_safari, enable_twitter: enable_twitter,
-          auto_invite_all_channel_members: auto_invite_all_channel_members,
+          auto_invite_all_channel_members: auto_invite_all_channel_members, icon: icon,
           send_cancellation_email: send_cancellation_email, show_reviews: show_reviews,
           registration_required_to_view_recording: registration_required_to_view_recording,
           who_can_watch_recording: who_can_watch_recording, show_handout_on_page: show_handout_on_page,
@@ -88,18 +93,14 @@ FactoryBot.define do
           sub_url: sub_url, enable_dial_in: enable_dial_in, time_zone: time_zone, schedule_type: schedule_type,
           recurring_start_times: recurring_start_times, presenter_advanced_enter_time: presenter_advanced_enter_time,
           attendee_advanced_enter_time: attendee_advanced_enter_time, webinar_format: webinar_format,
-          registration_conf_emails: registration_conf_emails,
+          registration_conf_emails: registration_conf_emails, webinar_tags: webinar_tags,
           send_notification_emails_to_presenters: send_notification_emails_to_presenters,
-          webhook_url: webhook_url, channel_admin_id: channel_admin_id, free_for_all: free_for_all,
+          webhook_url: webhook_url, channel_admin_id: channel_admin_id, ondemand_video_url: ondemand_video_url,
           room_type: room_type, room_sub_title: room_sub_title, dial_in_information: dial_in_information,
           preload_files: preload_files, presenters: presenters, webinar_stats: webinar_stats,
           associated_series: associated_series)
     end
 
-    trait :with_presenters do
-      presenters { build_list(:big_marker_presenter, 2, conference_id: id).map(&:to_h) }
-    end
-
     trait :with_dial_in_information do
       dial_in_information { build(:big_marker_dial_in_information).to_h }
     end
@@ -108,6 +109,10 @@ FactoryBot.define do
       preload_files { build_list(:big_marker_preload_file, 2).map(&:to_h) }
     end
 
+    trait :with_presenters do
+      presenters { build_list(:big_marker_presenter, 2, conference_id: id).map(&:to_h) }
+    end
+
     trait :with_webinar_stats do
       webinar_stats { build(:big_marker_webinar_stats).to_h }
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: big_marker_client
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors:
 - Burkhard Vogel-Kreykenbohm
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-20 00:00:00.000000000 Z
+date: 2023-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -106,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.1
 signing_key:
 specification_version: 4
 summary: simple client library to access the BigMarker API