bbbevents 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 402bf3f128e1214280f944e01ee9d205f5957e9b032982a095e61204e679a8a4
-  data.tar.gz: 109f47bab718e9bb1a0479fced8383bcfc6192f418c9ca42c7943cc41e6aa19c
+  metadata.gz: e9f0ea583b187441128084badd6a7671aca2289135b15e11dbe2ca03473f8a89
+  data.tar.gz: 79f8ade1f3d3b035c66d63578118e97c688c62015cd37c782bb50b6c5880aade
 SHA512:
-  metadata.gz: 8c4f90600b6b3d85d9ebb7325e0a6279fc9d7f94ec1ee20d91448f3aca4014ae16a356cd75d74a84b99851cd7e329f5dd7d670e38aff1554f9bdc1f410567117
-  data.tar.gz: '0733278cf563072dc656c51bfceb823491800b4b9089764a835600fa95ee21bec84147c07055840bf08332492a6aca77ccebc8a65497f865bfb90a33fa635c4e'
+  metadata.gz: bb7bdf62e41f2d56101ef656358b33a6a98fe093d6f6abd99e842766906b93c71db103bfdbd7689a1ad4a3414ad1efdddb5fba32e45995bce556d471c681e855
+  data.tar.gz: 84e933f01582767c3e9f1626bb77671fb21ca4ad8d63b159065616aed78b7d10b744d32875c338f4d493700e9db40ce50bbbdc21c10c9bce1716be0bb203f18d

data/.gitignore

@@ -1,6 +1,5 @@
 /.bundle/
 /.yardoc
-/Gemfile.lock
 /_yardoc/
 /coverage/
 /doc/
@@ -13,3 +12,6 @@
 
 # testing csv file
 /spec/testing.csv
+testdata/*.xml
+
+/bbbevents-*

data/Gemfile.lock

@@ -0,0 +1,48 @@
+PATH
+  remote: .
+  specs:
+    bbbevents (1.1.0)
+      activesupport
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    minitest (5.11.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bbbevents!
+  bundler (>= 1.15)
+  rake (~> 10.0)
+  rspec (~> 3.4)
+
+BUNDLED WITH
+   1.16.3

data/README.md

@@ -6,6 +6,18 @@ bbbevents is a simple ruby gem that makes it easier to parse data from a recordi
 
 This gem is currently being used on the recording server to parse events and build meeting dashboards.
 
+## Testing
+
+```
+bundle install --path vendor/bundle
+```
+
+Copy an `events.xml` file into `testdata/` dir.
+
+```
+bundle exec ./example.rb spec/fixtures/files/sample-events.xml
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/bbbevents.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "bundler", ">= 1.15"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.4"
 

data/example.rb

@@ -0,0 +1,44 @@
+#!/usr/bin/ruby
+
+require 'bbbevents'
+
+exit if ARGV.length < 1
+
+eventsxml = ARGV[0]
+
+# Parse the recording's events.xml.
+recording = BBBEvents.parse(eventsxml)
+
+# Access recording data.
+recording.metadata
+recording.meeting_id
+
+# Retrieve start, finish time objects or total duration in seconds.
+recording.start
+recording.finish
+recording.duration
+
+# Returns a list of Attendee objects.
+recording.attendees
+recording.moderators
+recording.viewers
+
+# Returns a list of Poll objects.
+recording.polls
+recording.published_polls
+recording.unpublished_polls
+
+# Returns a list of upload files (names only).
+recording.files
+
+# Generate a CSV file with the data.
+recording.create_csv("data.csv")
+ 
+puts "Writing the JSON data"
+
+# Write JSON data to file.
+File.open("data.json", 'w') do |f|
+  f.write(recording.to_json)
+end
+
+

data/lib/bbbevents/attendee.rb

@@ -7,6 +7,7 @@ module BBBEvents
 
     def initialize(join_event)
       @id        = join_event["userId"]
+      @extUserId = join_event["externalUserId"]
       @name      = join_event["name"]
       @moderator = (join_event["role"] == MODERATOR_ROLE)
 
@@ -57,6 +58,12 @@ module BBBEvents
       ].map(&:to_s)
     end
 
+    def to_h
+      hash = {}
+      instance_variables.each { |var| hash[var[1..-1]] = instance_variable_get(var) }
+      hash
+    end
+
     def to_json
       hash = {}
       instance_variables.each { |var| hash[var[1..-1]] = instance_variable_get(var) }

data/lib/bbbevents/base.rb

@@ -9,8 +9,3 @@ module BBBEvents
     Recording.new(events_xml)
   end
 end
-
-require 'bbbevents/attendee'
-require 'bbbevents/events'
-require 'bbbevents/poll'
-require 'bbbevents/recording'

data/lib/bbbevents/events.rb

@@ -20,18 +20,37 @@ module BBBEvents
 
     # Log a users join.
     def participant_join_event(e)
-      id = e["userId"]
+      intUserId = e['userId']
+      extUserId = e['externalUserId']
 
-      @attendees[id] = Attendee.new(e) unless @attendees.key?(id)
-      @attendees[id].joins << Time.at(timestamp_conversion(e["timestamp"]))
+      # If they don't exist, initialize the user.
+      unless @externalUserId.key?(intUserId)
+        @externalUserId[intUserId] = extUserId
+      end
+
+      # We need to track the user using external userids so that 3rd party
+      # integrations will be able to correlate the users with their own data.
+      unless @attendees.key?(extUserId)
+        @attendees[extUserId] = Attendee.new(e) unless @attendees.key?(extUserId)
+      end
+
+      # Handle updates for re-joining users
+      att = @attendees[extUserId]
+      att.joins << Time.at(timestamp_conversion(e["timestamp"]))
+      att.name = e['name']
+      if e['role'] == 'MODERATOR'
+        att.moderator = true
+      end
     end
 
     # Log a users leave.
     def participant_left_event(e)
-      return unless attendee = @attendees[e["userId"]]
-
-      left = Time.at(timestamp_conversion(e["timestamp"]))
-      attendee.leaves << left
+      intUserId = e['userId']
+      # If the attendee exists, set their leave time.
+      if att = @attendees[@externalUserId[intUserId]]
+        left = Time.at(timestamp_conversion(e["timestamp"]))
+        att.leaves << left
+      end
     end
 
     # Log the uploaded file name.
@@ -41,14 +60,18 @@ module BBBEvents
 
     # Log a users public chat message
     def public_chat_event(e)
-      return unless attendee = @attendees[e["senderId"]]
-
-      attendee.engagement[:chats] += 1 if attendee
+      intUserId = e['senderId']
+      # If the attendee exists, increment their messages.
+      if att = @attendees[@externalUserId[intUserId]]
+        att.engagement[:chats] += 1
+      end
     end
 
     # Log user status changes.
     def participant_status_change_event(e)
-      return unless attendee = @attendees[e["userId"]]
+      intUserId = e['userId']
+
+      return unless attendee = @attendees[@externalUserId[intUserId]]
       status = e["value"]
 
       if attendee
@@ -62,7 +85,9 @@ module BBBEvents
 
     # Log number of speaking events and total talk time.
     def participant_talking_event(e)
-      return unless attendee = @attendees[e["participant"]]
+      intUserId = e["participant"]
+
+      return unless attendee = @attendees[@externalUserId[intUserId]]
 
       if e["talking"] == "true"
         attendee.engagement[:talks] += 1
@@ -82,11 +107,13 @@ module BBBEvents
 
     # Log user responses to polls.
     def user_responded_to_poll_record_event(e)
-      user_id = e["userId"]
-      return unless attendee = @attendees[user_id]
+      intUserId = e['userId']
+      poll_id = e['pollId']
+
+      return unless attendee = @attendees[@externalUserId[intUserId]]
 
-      if poll = @polls[e["pollId"]]
-        poll.votes[user_id] = poll.options[e["answerId"].to_i]
+      if poll = @polls[poll_id]
+        poll.votes[@externalUserId[intUserId]] = poll.options[e["answerId"].to_i]
       end
 
       attendee.engagement[:poll_votes] += 1

data/lib/bbbevents/poll.rb

@@ -13,6 +13,12 @@ module BBBEvents
       @published
     end
 
+    def to_h
+      hash = {}
+      instance_variables.each { |var| hash[var[1..-1]] = instance_variable_get(var) }
+      hash
+    end
+
     def to_json
       hash = {}
       instance_variables.each { |var| hash[var[1..-1]] = instance_variable_get(var) }

data/lib/bbbevents/recording.rb

@@ -21,7 +21,8 @@ module BBBEvents
       raise "#{filename} is missing recording key." unless raw_recording_data.key?("recording")
 
       recording_data = raw_recording_data["recording"]
-      events         = recording_data["event"]
+      events = recording_data["event"]
+      events = [events] unless events.is_a?(Array)
 
       @metadata   = recording_data["metadata"]
       @meeting_id = recording_data["meeting"]["id"]
@@ -38,6 +39,10 @@ module BBBEvents
       @polls     = {}
       @files     = []
 
+      # Map to look up external user id (for @data[:attendees]) from the
+      # internal user id in most recording events
+      @externalUserId = {}
+
       process_events(events)
 
       @attendees.values.each do |att|
@@ -86,17 +91,21 @@ module BBBEvents
       end
     end
 
-    def to_json
+    def to_h
       {
         metadata: @metadata,
         meeting_id: @meeting_id,
         duration: @duration,
         start: @start,
         finish: @finish,
-        attendees: attendees.map(&:to_json),
+        attendees: attendees.map(&:to_h),
         files: @files,
-        polls: polls.map(&:to_json),
-      }.to_json
+        polls: polls.map(&:to_h)
+      }
+    end
+
+    def to_json
+      to_h.to_json
     end
 
     private

data/lib/bbbevents/version.rb

@@ -1,3 +1,3 @@
 module BBBEvents
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/lib/bbbevents.rb

@@ -1 +1,6 @@
 require "bbbevents/base"
+require 'bbbevents/version'
+require 'bbbevents/attendee'
+require 'bbbevents/events'
+require 'bbbevents/poll'
+require 'bbbevents/recording'

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: bbbevents
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Blindside Networks
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-23 00:00:00.000000000 Z
+date: 2019-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.15'
 - !ruby/object:Gem::Dependency
@@ -77,12 +77,14 @@ files:
 - ".rspec"
 - ".travis.yml"
 - Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
 - bbbevents.gemspec
 - bin/console
 - bin/setup
+- example.rb
 - lib/bbbevents.rb
 - lib/bbbevents/attendee.rb
 - lib/bbbevents/base.rb