canvas_webex 0.11 → 0.12

data/app/models/cisco_webex_conference.rb

@@ -20,6 +20,18 @@ class CiscoWebexConference < WebConference
 
   after_save :format_scheduled_date
 
+  user_setting_field :webex_service, {
+    name: -> { t('webex_service_setting', 'Service') },
+    description: -> { t('webex_service_setting_description', 'Service') },
+    type: :select,
+    visible: true,
+    location: 'userSettings',
+    options: [
+      {value: 'meeting',  name: -> { t('webex_meeting_center', 'Meeting Center') }},
+      {value: 'training', name:  -> { t('webex_training_center', 'Training Center') }}
+    ]
+  }
+
   user_setting_field :scheduled_date, {
     name: -> { t('scheduled_date_setting', 'Scheduled Date') },
     description: -> { t('scheduled_date_setting_description', 'Scheduled Date') },
@@ -46,11 +58,12 @@ class CiscoWebexConference < WebConference
       options = {
         duration: self.duration || 0,
         emails: settings[:external_emails].nil? ? [] : settings[:external_emails].strip.split(';'),
-        time_zone: user.time_zone
+        time_zone: user.time_zone,
+        service: settings[:webex_service]
       }
       options[:scheduled_date] = scheduled_date.in_time_zone(user.time_zone) if scheduled_date.present?
-      webex_meeting = CanvasWebex::Meeting.create(self.title, options)
-      self.conference_key = webex_meeting.meeting_key
+      webex_session = CanvasWebex::WebexSession.create(self.title, options)
+      self.conference_key = webex_session.session_key
       save
     end
     self.conference_key
@@ -126,7 +139,7 @@ class CiscoWebexConference < WebConference
   #
   # Returns an Array of recording hashes, or an empty Array if there are no recordings
   def recordings
-    CanvasWebex::Meeting.recordings(self.conference_key)
+    CanvasWebex::WebexSession.recordings(self.conference_key)
   end
 
   def after_find
@@ -148,7 +161,14 @@ class CiscoWebexConference < WebConference
   #
   # Returns the meeting object, or nil if the meeting is ended
   def meeting
-    self.conference_key && CanvasWebex::Meeting.retrieve(self.conference_key)
+    @meeting ||= if self.conference_key
+                   case settings[:webex_service]
+                     when 'meeting'
+                       CanvasWebex::Meeting.retrieve(self.conference_key)
+                     when 'training'
+                       CanvasWebex::Training.retrieve(self.conference_key)
+                   end
+                 end
   end
 
   def format_scheduled_date

data/lib/canvas_webex.rb

@@ -33,7 +33,9 @@ module CanvasWebex
     require_dependency File.expand_path('../app/models/cisco_webex_conference.rb', File.dirname(__FILE__))
     require_dependency "canvas/plugins/validators/cisco_webex_validator"
     require_dependency "canvas/plugins/cisco_webex"
+    require_dependency "canvas_webex/webex_session"
     require_dependency "canvas_webex/service"
+    require_dependency "canvas_webex/training"
     require_dependency "canvas_webex/meeting"
 
     Canvas::Plugins::CiscoWebex.new

data/lib/canvas_webex/meeting.rb

@@ -16,7 +16,7 @@
 # with this program. If not, see <http://www.gnu.org/licenses/>.
 #
 module CanvasWebex
-  class Meeting
+  class Meeting < CanvasWebex::WebexSession
 
     ATTRIBUTES = [:meeting_key, :conf_name, :start_date, :host_joined, :status]
 
@@ -34,53 +34,6 @@ module CanvasWebex
       end
     end
 
-    def host_url(client = CanvasWebex.client)
-      if response = client.host_meeting_url(meeting_key, nil)
-        response.at_xpath('hostMeetingURL').try(:text)
-      end
-    end
-
-    def join_url(client = CanvasWebex.client)
-      if response = client.join_meeting_url(meeting_key, nil)
-        response.at_xpath('joinMeetingURL').text
-      end
-    end
-
-    def self.recordings(meeting_key, client = CanvasWebex.client)
-      if response = meeting_key && client.list_recordings(meeting_key)
-        response.search('recording').map do |rec_xml|
-          created_ts = rec_xml.at_xpath('createTime').try(:text)
-          tz_id = rec_xml.at_xpath('timeZoneID').try(:text)
-          created_at = parse_time_stamp(tz_id, created_ts)
-          recording = {
-            recording_id: rec_xml.at_xpath('recordingID').try(:text),
-            title: rec_xml.at_xpath('name').try(:text),
-            playback_url: rec_xml.at_xpath('streamURL').try(:text),
-            created_at: parse_time_stamp(tz_id, created_ts).to_s
-          }
-          if duration = rec_xml.at_xpath('duration').try(:text)
-            recording[:duration_minutes] = duration.to_i / 60
-          end
-          recording
-        end
-      else
-        []
-      end
-    end
-
-    def self.parse_time_stamp(time_zone, time_stamp, client = CanvasWebex.client)
-      if response = client.list_time_zone(time_zone, time_stamp)
-        if m_offset = response.at_xpath('timeZone/gmtOffset').try(:text).try(:to_i)
-          offset_string = "%+0#3d:00" %[(m_offset / 60)]
-          DateTime.strptime(time_stamp + offset_string, '%m/%d/%Y %H:%M:%S%z')
-        else
-          DateTime.strptime(time_stamp, '%m/%d/%Y %H:%M:%S')
-        end
-      else
-        ""
-      end
-    end
-
     # Public: Create a new Meeting
     #
     # meeting_xml - The xml returned for a meeting (must already exist).
@@ -89,6 +42,10 @@ module CanvasWebex
       @xml = meeting_xml
     end
 
+    def session_key
+      meeting_key
+    end
+
     def method_missing(meth, *args, &block)
       if ATTRIBUTES.include?(meth)
         @attr_cache[meth] ||= @xml.at_xpath("//*[contains(translate(name(),'ABCDEFGHIJKLMNOPQRSTUVWXYZ','abcdefghijklmnopqrstuvwxyz'), '#{meth.to_s.camelcase(:lower).downcase}')]").try(:text)

data/lib/canvas_webex/service.rb

@@ -66,6 +66,45 @@ module CanvasWebex
       request(body)
     end
 
+    def create_training_session(confName, options = {})
+      body = xml_request do |xml|
+        xml.bodyContent('xsi:type' =>'java:com.webex.service.binding.training.CreateTrainingSession'){
+          xml.metaData{
+            xml.confName confName
+          }
+          if meeting_password != nil && meeting_password.strip != ''
+            xml.accessControl{
+              xml.sessionPassword meeting_password
+            }
+          end
+          xml.schedule{
+            if options[:scheduled_date].present?
+              xml.startDate options[:scheduled_date].in_time_zone('America/Los_Angeles').strftime("%m/%d/%Y %T") rescue nil
+              xml.timeZoneID 4
+            else
+              xml.startDate
+            end
+            xml.duration(options[:duration].to_i)
+          }
+          if options[:emails]
+            xml.attendees{
+              xml.participants{
+                options[:emails].each do |email|
+                  xml.person {
+                    xml.email email
+                  }
+                end
+              }
+            }
+            xml.attendeeOptions {
+              xml.emailInvitations true
+            }
+          end
+        }
+      end
+      request(body)
+    end
+
     def host_meeting_url(meeting_key, email)
       body = xml_request(email) do |xml|
         xml.bodyContent('xsi:type' => 'java:com.webex.service.binding.meeting.GethosturlMeeting'){
@@ -98,6 +137,19 @@ module CanvasWebex
 
     end
 
+    def get_training_session(session_key)
+      body = xml_request do |xml|
+        xml.bodyContent('xsi:type' => 'java:com.webex.service.binding.training.GetTrainingSession'){
+          xml.sessionKey session_key
+        }
+      end
+      begin
+        request(body)
+      rescue CanvasWebex::ConnectionError
+        nil
+      end
+    end
+
     def list_recordings(meeting_key)
       body = xml_request do |xml|
         xml.bodyContent('xsi:type' => 'java:com.webex.service.binding.ep.LstRecording'){

data/lib/canvas_webex/training.rb

@@ -0,0 +1,55 @@
+#
+# Copyright (C) 2013 Instructure, Inc.
+#
+# This file is part of Canvas.
+#
+# Canvas is free software: you can redistribute it and/or modify it under
+# the terms of the GNU Affero General Public License as published by the Free
+# Software Foundation, version 3 of the License.
+#
+# Canvas is distributed in the hope that it will be useful, but WITHOUT ANY
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
+# A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
+# details.
+#
+# You should have received a copy of the GNU Affero General Public License along
+# with this program. If not, see <http://www.gnu.org/licenses/>.
+#
+module CanvasWebex
+  class Training < CanvasWebex::WebexSession
+
+
+    ATTRIBUTES = [:session_key, :conf_name, :start_date, :status]
+
+    def self.retrieve(session_key, client = CanvasWebex.client)
+      if response = client.get_training_session(session_key)
+        Training.new(Nokogiri::XML(response.to_xml))
+      end
+    end
+
+    def self.create(session_name, options = {}, client = CanvasWebex.client)
+      if response = client.create_training_session(session_name, options)
+        if session_key = response.at_xpath('//sessionkey').try(:text)
+          retrieve(session_key, client)
+        end
+      end
+    end
+
+    # Public: Create a new Training
+    #
+    # training_xml - The xml returned for a training (must already exist).
+    def initialize(training_xml)
+      @attr_cache = {}
+      @xml = training_xml
+    end
+
+    def method_missing(meth, *args, &block)
+      if ATTRIBUTES.include?(meth)
+        @attr_cache[meth] ||= @xml.at_xpath("//*[contains(translate(name(),'ABCDEFGHIJKLMNOPQRSTUVWXYZ','abcdefghijklmnopqrstuvwxyz'), '#{meth.to_s.camelcase(:lower).downcase}')]").try(:text)
+      else
+        super
+      end
+    end
+
+  end
+end

data/lib/canvas_webex/version.rb

@@ -17,6 +17,6 @@
 #
 
 module CanvasWebex
-  VERSION = "0.11"
+  VERSION = "0.12"
 end
 

data/lib/canvas_webex/webex_session.rb

@@ -0,0 +1,78 @@
+#
+# Copyright (C) 2013 Instructure, Inc.
+#
+# This file is part of Canvas.
+#
+# Canvas is free software: you can redistribute it and/or modify it under
+# the terms of the GNU Affero General Public License as published by the Free
+# Software Foundation, version 3 of the License.
+#
+# Canvas is distributed in the hope that it will be useful, but WITHOUT ANY
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
+# A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
+# details.
+#
+# You should have received a copy of the GNU Affero General Public License along
+# with this program. If not, see <http://www.gnu.org/licenses/>.
+#
+module CanvasWebex
+  class WebexSession
+
+    def self.create(meeting_name, options = {}, client = CanvasWebex.client)
+      case options[:service]
+        when 'meeting'
+          CanvasWebex::Meeting.create(meeting_name, options, client)
+        when 'training'
+          CanvasWebex::Training.create(meeting_name, options, client)
+      end
+    end
+
+    def host_url(client = CanvasWebex.client)
+      if response = client.host_meeting_url(session_key, nil)
+        response.at_xpath('hostMeetingURL').try(:text)
+      end
+    end
+
+    def join_url(client = CanvasWebex.client)
+      if response = client.join_meeting_url(session_key, nil)
+        response.at_xpath('joinMeetingURL').text
+      end
+    end
+
+    def self.recordings(session_key, client = CanvasWebex.client)
+      if response = session_key && client.list_recordings(session_key)
+        response.search('recording').map do |rec_xml|
+          created_ts = rec_xml.at_xpath('createTime').try(:text)
+          tz_id = rec_xml.at_xpath('timeZoneID').try(:text)
+          created_at = self.parse_time_stamp(tz_id, created_ts)
+          recording = {
+            recording_id: rec_xml.at_xpath('recordingID').try(:text),
+            title: rec_xml.at_xpath('name').try(:text),
+            playback_url: rec_xml.at_xpath('streamURL').try(:text),
+            created_at: self.parse_time_stamp(tz_id, created_ts).to_s
+          }
+          if duration = rec_xml.at_xpath('duration').try(:text)
+            recording[:duration_minutes] = duration.to_i / 60
+          end
+          recording
+        end
+      else
+        []
+      end
+    end
+
+    def self.parse_time_stamp(time_zone, time_stamp, client = CanvasWebex.client)
+      if response = client.list_time_zone(time_zone, time_stamp)
+        if m_offset = response.at_xpath('timeZone/gmtOffset').try(:text).try(:to_i)
+          offset_string = "%+0#3d:00" %[(m_offset / 60)]
+          DateTime.strptime(time_stamp + offset_string, '%m/%d/%Y %H:%M:%S%z')
+        else
+          DateTime.strptime(time_stamp, '%m/%d/%Y %H:%M:%S')
+        end
+      else
+        ""
+      end
+    end
+
+  end
+end

data/spec/fixtures/get_training.xml

@@ -0,0 +1,123 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<serv:message xmlns:serv="http://www.webex.com/schemas/2002/06/service" xmlns:com="http://www.webex.com/schemas/2002/06/common" xmlns:sess="http://www.webex.com/schemas/2002/06/service/session" xmlns:train="http://www.webex.com/schemas/2002/06/service/trainingsession" xmlns:qti="http://www.webex.com/schemas/2002/06/service/trainingsessionqti" xmlns:qtiasi="http://www.webex.com/schemas/2002/06/service/trainingsessionqtiasi">
+    <serv:header>
+        <serv:response>
+            <serv:result>SUCCESS</serv:result>
+            <serv:gsbStatus>PRIMARY</serv:gsbStatus>
+        </serv:response>
+    </serv:header>
+    <serv:body>
+        <serv:bodyContent xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="train:getTrainingSessionResponse">
+            <sess:accessControl>
+                <sess:listing>PUBLIC</sess:listing>
+                <sess:sessionPassword>Test1234567</sess:sessionPassword>
+            </sess:accessControl>
+            <sess:schedule>
+                <sess:startDate>01/14/2014 11:22:55</sess:startDate>
+                <sess:timeZone>GMT-07:00, Mountain (Denver)</sess:timeZone>
+                <sess:duration>60</sess:duration>
+                <sess:timeZoneID>6</sess:timeZoneID>
+                <sess:hostWebExID>NetAcadTest</sess:hostWebExID>
+                <sess:openTime>0</sess:openTime>
+                <sess:extNotifyTime>0</sess:extNotifyTime>
+                <sess:joinTeleconfBeforeHost>false</sess:joinTeleconfBeforeHost>
+            </sess:schedule>
+            <train:metaData>
+                <sess:confName>test</sess:confName>
+                <train:location>https://ciscolearning.webex.com</train:location>
+                <train:invitation/>
+                <train:sessionType>11</train:sessionType>
+                <train:enableGreeting>false</train:enableGreeting>
+            </train:metaData>
+            <train:enableOptions>
+                <sess:attendeeList>true</sess:attendeeList>
+                <sess:javaClient>true</sess:javaClient>
+                <sess:nativeClient>true</sess:nativeClient>
+                <train:chat>true</train:chat>
+                <train:poll>true</train:poll>
+                <train:audioVideo>true</train:audioVideo>
+                <train:fileShare>true</train:fileShare>
+                <train:presentation>true</train:presentation>
+                <train:applicationShare>true</train:applicationShare>
+                <train:desktopShare>true</train:desktopShare>
+                <train:webTour>true</train:webTour>
+                <train:trainingSessionRecord>true</train:trainingSessionRecord>
+                <train:annotation>false</train:annotation>
+                <train:importDocument>false</train:importDocument>
+                <train:saveDocument>false</train:saveDocument>
+                <train:printDocument>false</train:printDocument>
+                <train:pointer>false</train:pointer>
+                <train:switchPage>false</train:switchPage>
+                <train:fullScreen>false</train:fullScreen>
+                <train:thumbnail>false</train:thumbnail>
+                <train:zoom>false</train:zoom>
+                <train:copyPage>false</train:copyPage>
+                <train:rcAppShare>true</train:rcAppShare>
+                <train:rcDesktopShare>true</train:rcDesktopShare>
+                <train:rcWebTour>true</train:rcWebTour>
+                <train:attendeeRecordTrainingSession>true</train:attendeeRecordTrainingSession>
+                <train:voip>true</train:voip>
+                <train:faxIntoTrainingSession>false</train:faxIntoTrainingSession>
+                <train:autoDeleteAfterMeetingEnd>false</train:autoDeleteAfterMeetingEnd>
+                <train:displayQuickStartHost>true</train:displayQuickStartHost>
+                <train:displayQuickStartAttendees>false</train:displayQuickStartAttendees>
+                <train:supportQandA>true</train:supportQandA>
+                <train:supportFeedback>true</train:supportFeedback>
+                <train:supportBreakoutSessions>true</train:supportBreakoutSessions>
+                <train:supportRemoteComputer>true</train:supportRemoteComputer>
+                <train:supportShareWebContent>true</train:supportShareWebContent>
+                <train:supportUCFRichMedia>true</train:supportUCFRichMedia>
+                <train:networkBasedRecord>true</train:networkBasedRecord>
+                <train:presenterBreakoutSession>true</train:presenterBreakoutSession>
+                <train:attendeeBreakoutSession>false</train:attendeeBreakoutSession>
+                <train:supportPanelists>true</train:supportPanelists>
+                <train:muteOnEntry>false</train:muteOnEntry>
+                <train:multiVideo>false</train:multiVideo>
+                <train:veryLargeSess>false</train:veryLargeSess>
+                <train:HQvideo>true</train:HQvideo>
+            </train:enableOptions>
+            <train:telephony>
+                <sess:telephonySupport>NONE</sess:telephonySupport>
+            </train:telephony>
+            <train:tracking/>
+            <train:repeat>
+                <train:repeatType>SINGLE</train:repeatType>
+                <train:expirationDate>01/14/2014 12:22:55</train:expirationDate>
+                <train:occurenceType>NO_REPEAT</train:occurenceType>
+            </train:repeat>
+            <train:remind>
+                <sess:enableReminder>false</sess:enableReminder>
+                <sess:emails/>
+                <sess:sendEmail>false</sess:sendEmail>
+                <sess:sendMobile>false</sess:sendMobile>
+                <sess:daysAhead>0</sess:daysAhead>
+                <sess:hoursAhead>0</sess:hoursAhead>
+                <sess:minutesAhead>0</sess:minutesAhead>
+                <sess:attendees>
+                    <sess:send>false</sess:send>
+                </sess:attendees>
+                <sess:presenters>
+                    <sess:firstReminder>24HR</sess:firstReminder>
+                </sess:presenters>
+            </train:remind>
+            <train:attendeeOptions>
+                <train:request>false</train:request>
+                <train:registration>false</train:registration>
+                <train:auto>false</train:auto>
+                <train:registrationPWD/>
+                <train:maxRegistrations>0</train:maxRegistrations>
+                <train:participantLimit>0</train:participantLimit>
+            </train:attendeeOptions>
+            <train:handsOnLab>
+                <train:reserveHOL>false</train:reserveHOL>
+                <train:numComputers>0</train:numComputers>
+            </train:handsOnLab>
+            <train:sessionKey>752909833</train:sessionKey>
+            <train:status>NOT_INPROGRESS</train:status>
+            <train:hostKey>274056</train:hostKey>
+            <train:eventID>226053157</train:eventID>
+            <train:guestToken>7e802a5c5964f8d9f857a80beca12e06</train:guestToken>
+            <train:hostType>1019001</train:hostType>
+        </serv:bodyContent>
+    </serv:body>
+</serv:message>

data/spec/lib/canvas_webex/meeting_spec.rb

@@ -28,10 +28,4 @@ describe CanvasWebex::Meeting do
     subject.status.should == "NOT_INPROGRESS"
   end
 
-  it 'parses a cisco timestamp' do
-    stub_call('list_timezones')
-    ts = CanvasWebex::Meeting.parse_time_stamp(4, '01/26/2006 21:00:00', client)
-    ts.to_s.should == '2006-01-26T21:00:00-08:00'
-  end
-
 end

data/spec/lib/canvas_webex/service_spec.rb

@@ -47,7 +47,6 @@ describe CanvasWebex::Service do
       result.name.should == 'bodyContent'
     end
 
-
   end
 
 

data/spec/lib/canvas_webex/training_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe CanvasWebex::Training do
+  let(:client) {CanvasWebex::Service.new('proserv_instructure', 'foo', '123', 'instructure', nil, 'test')}
+  subject{CanvasWebex::Training.retrieve(123, client)}
+
+  before(:each) do
+    stub_call('get_training')
+  end
+
+  it 'returns the session name' do
+    subject.conf_name.should == "test"
+  end
+
+  it 'returns the session key' do
+    subject.session_key.should == "752909833"
+  end
+
+  it 'returns the start date' do
+    subject.start_date.should == "01/14/2014 11:22:55"
+  end
+
+  it 'returns the status' do
+    subject.status.should == "NOT_INPROGRESS"
+  end
+
+end

data/spec/lib/canvas_webex/webex_session_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe CanvasWebex::WebexSession do
+  let(:client) {CanvasWebex::Service.new('proserv_instructure', 'foo', '123', 'instructure', nil, 'test')}
+
+  it 'parses a cisco timestamp' do
+    stub_call('list_timezones')
+    ts = CanvasWebex::WebexSession.parse_time_stamp(4, '01/26/2006 21:00:00', client)
+    ts.to_s.should == '2006-01-26T21:00:00-08:00'
+  end
+
+end

data/spec/spec_helper.rb

@@ -1,5 +1,7 @@
+require 'canvas_webex/webex_session'
 require 'canvas_webex/service'
 require 'canvas_webex/meeting'
+require 'canvas_webex/training'
 require 'nokogiri'
 require 'uri'
 require 'net/http'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: canvas_webex
 version: !ruby/object:Gem::Version
-  version: '0.11'
+  version: '0.12'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-10 00:00:00.000000000 Z
+date: 2014-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -113,9 +113,12 @@ files:
 - lib/canvas_webex.rb
 - lib/canvas_webex/meeting.rb
 - lib/canvas_webex/service.rb
+- lib/canvas_webex/training.rb
 - lib/canvas_webex/version.rb
+- lib/canvas_webex/webex_session.rb
 - spec/fixtures/create_meeting.xml
 - spec/fixtures/get_meeting.xml
+- spec/fixtures/get_training.xml
 - spec/fixtures/host_meeting_url.xml
 - spec/fixtures/join_meeting_url.xml
 - spec/fixtures/list_timezones.xml
@@ -123,6 +126,8 @@ files:
 - spec/fixtures/recording_list.xml
 - spec/lib/canvas_webex/meeting_spec.rb
 - spec/lib/canvas_webex/service_spec.rb
+- spec/lib/canvas_webex/training_spec.rb
+- spec/lib/canvas_webex/webex_session_spec.rb
 - spec/models/cisco_webex_conference_spec.rb
 - spec/spec_helper.rb
 homepage: http://instructure.com
@@ -153,6 +158,7 @@ summary: Cisco WebEx integration for Instructure Canvas (http://instructure.com)
 test_files:
 - spec/fixtures/create_meeting.xml
 - spec/fixtures/get_meeting.xml
+- spec/fixtures/get_training.xml
 - spec/fixtures/host_meeting_url.xml
 - spec/fixtures/join_meeting_url.xml
 - spec/fixtures/list_timezones.xml
@@ -160,6 +166,8 @@ test_files:
 - spec/fixtures/recording_list.xml
 - spec/lib/canvas_webex/meeting_spec.rb
 - spec/lib/canvas_webex/service_spec.rb
+- spec/lib/canvas_webex/training_spec.rb
+- spec/lib/canvas_webex/webex_session_spec.rb
 - spec/models/cisco_webex_conference_spec.rb
 - spec/spec_helper.rb
 has_rdoc: