big_marker_client 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 761022b647bdfeecdd833b29b236ff768cf2713d2d5c82a3986638d5cc67b0d5
-  data.tar.gz: 16707b0d879dd593066b400677c343bdfa47eed6d97e5132a5f99599b94e64e6
+  metadata.gz: ed37646b284700f68cd35dbc2479ab9cfcfb8f03bf5ae0c48e0145ce66ad9fe8
+  data.tar.gz: d4690336aa4d989931f00fdff50ed6c4f328bb6b85e1a3f1d9152eb741fe7b50
 SHA512:
-  metadata.gz: c18cf2836336c335143e01690ccbc3acdfaf96f39bc86d415270fc9e8bf8b97c5069f35d508e664a65dab94bd97cba7d191acada60fd242a710b56828229e948
-  data.tar.gz: 12d4ca8e8394a012f395dbd910c3a9835c9a072b20e88a39167f25adecf1b77d1483cbb42a303f05774b39405fc06bcda4fc806a8056b932003c9533935b36b7
+  metadata.gz: ce98e4e5c230dc9d7dc5ae42c176e4bcae182b729d871eb55434f7e0db3c9c592ef82e6ce68564fc1721088bf949b6bf408ad7a0c2acce2ae111966a53fee289
+  data.tar.gz: bd727a006b800643ef093ca8e1e115a88644826aabaf96c1b1c59fc067d75d84451d7daecfedee75e524235aca91a3d4d7002e6861b27f2c26079f50d98da7ba

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+# Changelog
+
+## [0.1.7] - Unreleased
+
+- 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`
+
 ## [0.1.6] - 2022-01-19
 
 - fix recurring method to return "child_conferences"

data/Gemfile

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

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

@@ -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,5 +1,5 @@
-require "typhoeus"
-require "typhoeus/adapters/faraday"
+require "faraday"
+require "faraday/typhoeus"
 
 module BigMarkerClient
   class Base
@@ -57,7 +57,9 @@ module BigMarkerClient
         params = params.to_json unless %w[get delete].include?(verb.to_s)
         @http_client ||= HttpClient.new
         response = @http_client.connection.send(verb.to_s, base_url(path), params)
-        parse_body(response.body)
+        return parse_body(response.body) if response.success?
+
+        response.body
       end
 
       def check_preconditions(verb, path)

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

@@ -4,10 +4,10 @@ module BigMarkerClient
 
     def initialize
       @connection = Faraday.new(url: Config.base_url) do |faraday|
+        faraday.adapter :typhoeus
         faraday = headers(faraday)
         configure_logging(faraday) if Config.log
       end
-      @connection.adapter :typhoeus
     end
 
     private

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.6".freeze
+  VERSION = "0.1.7".freeze
 end

data/lib/big_marker_client.rb

@@ -32,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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: big_marker_client
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Burkhard Vogel-Kreykenbohm
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-19 00:00:00.000000000 Z
+date: 2022-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -16,56 +16,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: faraday-httpclient
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: json
+  name: faraday-typhoeus
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: typhoeus
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
 description: Encapsulates calls to the BigMarker API to create ond retrieve conferences,
   participants, analytics and more
 email:
@@ -101,6 +101,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
@@ -111,6 +112,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:
@@ -132,7 +134,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !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