canvas_connect 0.1.0 → 0.1.1

data/Gemfile

@@ -1,3 +1,3 @@
-source :rubygems
+source 'https://rubygems.org/'
 
 gemspec

data/app/models/adobe_connect_conference.rb

@@ -36,9 +36,7 @@ class AdobeConnectConference < WebConference
   #
   # Returns conference status as a symbol (either :active or :closed).
   def conference_status
-    if meeting_exists? && end_at.present? && Time.now < end_at
-      :active
-    elsif meeting_exists?
+    if meeting_exists?
       :active
     else
       :closed
@@ -53,13 +51,18 @@ class AdobeConnectConference < WebConference
   # Returns a meeting URL string.
   def admin_join_url(admin, _ = nil)
     user = add_host(admin)
-    settings = { :username => user.username, :password => user.password,
-      :domain => CanvasConnect.config[:domain] }
 
-    service = AdobeConnect::Service.new(settings)
-    service.log_in
+    if config[:use_sis_ids] == "no" 
+      settings = { :username => user.username, :password => user.password,
+        :domain => CanvasConnect.config[:domain] }
+
+      service = AdobeConnect::Service.new(settings)
+      service.log_in
 
-    "#{meeting_url}?session=#{service.session}"
+      "#{meeting_url}?session=#{service.session}"
+    else
+      meeting_url
+    end 
   end
 
   # Public: Add a participant to the conference and create a meeting URL.
@@ -73,8 +76,10 @@ class AdobeConnectConference < WebConference
   def participant_join_url(user, _ = nil)
     if grants_right?(user, nil, :initiate)
       admin_join_url(user)
-    else
+    elsif config[:use_sis_ids] == "no" 
       "#{meeting_url}?guestName=#{URI.escape(user.name)}"
+    else 
+      meeting_url
     end
   end
 
@@ -84,11 +89,14 @@ class AdobeConnectConference < WebConference
   # Returns an SCO-ID string.
   def find_conference_key
     unless conference_key.present?
-      self.conference_key = meeting_folder.
-        contents.
-        xpath("//sco[name=#{meeting_name.inspect}]").
-        attr('sco-id').
-        value
+      meeting_node = meeting_folder.contents.xpath("//sco[name=#{meeting_name.inspect}]")
+      # if meeting node exists, get that value
+      if meeting_node.present?
+        self.conference_key = meeting_node.attr('sco-id').value
+      else
+        # meeting node not found (by name)
+        raise CanvasConnect::MeetingNotFound, "Meeting with name '#{meeting_name}' not found"
+      end
     end
 
     conference_key
@@ -100,8 +108,21 @@ class AdobeConnectConference < WebConference
   #
   # Returns the CanvasConnect::ConnectUser.
   def add_host(user)
-    options = { first_name: user.first_name, last_name: user.last_name,
-      email: connect_username(user), username: connect_username(user), uuid: user.uuid }
+    options = config[:use_sis_ids] == "yes" ?
+      {
+        first_name: user.first_name,
+        last_name:  user.last_name,
+        email:      user.email,
+        username:   user.sis_pseudonym_for(user.account).try(:sis_user_id),
+        uuid:       user.uuid
+      } :
+      {
+        first_name:   user.first_name,
+        last_name:    user.last_name,
+        email:        connect_username(user),
+        username:     connect_username(user),
+        uuid:         user.uuid
+      }
 
     connect_user = AdobeConnect::User.find(options) || AdobeConnect::User.create(options)
     connect_service.permissions_update(
@@ -142,11 +163,13 @@ class AdobeConnectConference < WebConference
   #
   # Returns nothing.
   def create_meeting
+    url_id = meeting_url_suffix
+
     params = { :type => 'meeting',
                :name => meeting_name,
                :folder_id => meeting_folder.id,
                :date_begin => start_at.iso8601,
-               :url_path => meeting_url_suffix }
+               :url_path => url_id }
     params[:end_at] = end_at.iso8601 if end_at.present?
 
     result = connect_service.sco_update(params)
@@ -161,6 +184,9 @@ class AdobeConnectConference < WebConference
       return nil
     end
 
+    # if made it here, meeting was successfully created. Cache the meeting_url_suffix being used.
+    self.meeting_url_id = url_id
+
     sco_id = result.body.at_xpath('//sco')['sco-id']
     make_meeting_public(sco_id)
   end
@@ -180,7 +206,7 @@ class AdobeConnectConference < WebConference
   #
   # Returns a boolean.
   def meeting_exists?
-    result = connect_service.sco_by_url(:url_path => meeting_url_suffix)
+    result = connect_service.sco_by_url(:url_path => meeting_url_id)
     result.body.xpath('//status[@code="ok"]').present?
   end
 
@@ -189,11 +215,7 @@ class AdobeConnectConference < WebConference
   end
 
   def meeting_url
-    @cached_meeting_url ||= generate_meeting_url
-  end
-
-  def meeting_url_suffix
-    @cached_meeting_url_suffix ||= generate_meeting_url_suffix
+    "#{config[:domain]}/#{meeting_url_id}"
   end
 
   # Internal: Get and cache a reference to the remote folder.
@@ -226,17 +248,32 @@ class AdobeConnectConference < WebConference
     "#{course_code}: #{self.title} [#{self.id}]"
   end
 
-  # Internal: Generate the base URL for the meeting.
+  # Internal: Get the unique ID to identify the meeting in an Adobe url.
+  #
+  # Returns a string or nil.
+  def meeting_url_id
+    # Return the stored setting value if present. If missing, return the legacy generated format.
+    settings[:meeting_url_id] || meeting_url_suffix_legacy
+  end
+
+  # Internal: Track the unique ID to identify the meeting in an Adobe url.
   #
-  # Returns a meeting string.
-  def generate_meeting_url
-    "#{config[:domain]}/#{meeting_url_suffix}"
+  # Returns nothing
+  def meeting_url_id=(value)
+    settings[:meeting_url_id] = value
+  end
+
+  # Internal: Generate a URL suffix for this conference. Uses a more globally unique approach.
+  #
+  # Returns a URL suffix string of format "canvas-meeting-:root_acount_global_id-:id-:created_at_as_integer".
+  def meeting_url_suffix
+    "canvas-mtg-#{self.context.root_account.global_id}-#{self.id}-#{self.created_at.to_i}"
   end
 
-  # Internal: Generate a URL suffix for this conference.
+  # Internal: Generate a URL suffix for this conference. Uses the legacy approach with overly simple uniqueness
   #
   # Returns a URL suffix string of format "canvas-meeting-:id".
-  def generate_meeting_url_suffix
+  def meeting_url_suffix_legacy
     "canvas-meeting-#{self.id}"
   end
 end

data/app/views/plugins/_connect_settings.html.erb

@@ -32,6 +32,15 @@
           <%= f.password_field :password, :autocomplete => false %><br>
         </td>
       </tr>
+      <tr>
+        <td><%= f.label :use_sis_ids, "Use SIS IDs" %></td>
+        <td>
+          <%= f.check_box "use_sis_ids", {}, 'yes', 'no' %><br />
+          <small class="help-text">
+            <%= t(:use_sis_ids_description, "Use a user's SIS as their Connect login ID") %>
+          </small>
+        </td>
+      <tr>
     </tbody>
   </table>
 <% end %>

data/lib/canvas/plugins/validators/adobe_connect_validator.rb

@@ -21,7 +21,7 @@ module Canvas
     module Validators
       module AdobeConnectValidator
         # Public: An array of allowed plugin settings.
-        REQUIRED_KEYS = %w{domain login password meeting_container}
+        REQUIRED_KEYS = %w{domain login password meeting_container use_sis_ids}
 
         # Public: Validate setting input for this plugin.
         #

data/lib/canvas_connect.rb

@@ -22,6 +22,7 @@ require 'canvas_connect/version'
 module CanvasConnect
   class ConnectionError < StandardError; end
   class MeetingFolderError < StandardError; end
+  class MeetingNotFound < StandardError; end
 
   # Public: Configure as a Canvas plugin.
   #

data/lib/canvas_connect/version.rb

@@ -1,3 +1,3 @@
 module CanvasConnect
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/spec_canvas/models/adobe_connect_conference_spec.rb

@@ -28,8 +28,8 @@ describe AdobeConnectConference do
   }
 
   before(:each) do
-    AdobeConnectConference.stubs(:config).returns(CONNECT_CONFIG)
     @conference = AdobeConnectConference.new
+    @conference.stubs(:config).returns(CONNECT_CONFIG)
   end
 
   subject { AdobeConnectConference.new }
@@ -37,11 +37,17 @@ describe AdobeConnectConference do
   context 'with an admin participant' do
     before(:each) do
       @user = User.new(:name => 'Don Draper')
+      AdobeConnect::Service.stubs(:user_session).returns('CookieValue')
+      @conference.expects(:add_host).with(@user).returns(@user)
     end
 
-    it 'should generate an admin url' do
-      CanvasConnect::Service.stubs(:user_session).returns('CookieValue')
-      @conference.expects(:add_host).with(@user).returns(@user)
+    it 'should generate an admin url using unique format if stored' do
+      stored_url = 'canvas-mtg-ACCOUNT_ID-ID-CREATED_SECONDS'
+      @conference.settings[:meeting_url_id] = stored_url
+      @conference.admin_join_url(@user).should == "http://connect.example.com/#{stored_url}"
+    end
+
+    it 'should generate an admin url using legacy format' do
       @conference.admin_join_url(@user).should == "http://connect.example.com/canvas-meeting-#{@conference.id}"
     end
   end

metadata

@@ -1,32 +1,36 @@
 --- !ruby/object:Gem::Specification
 name: canvas_connect
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
+  prerelease: 
 platform: ruby
 authors:
 - Zach Pendleton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-09 00:00:00.000000000 Z
+date: 2013-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.9.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.9.6
 - !ruby/object:Gem::Dependency
   name: adobe_connect
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -34,6 +38,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -65,26 +70,28 @@ files:
 - spec_canvas/models/adobe_connect_conference_spec.rb
 homepage: http://instructure.com
 licenses: []
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - app
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.0
+rubygems_version: 1.8.25
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Adobe Connect integration for Instructure Canvas (http://instructure.com).
 test_files: []
+has_rdoc: 

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: b78cf0edc21638b06e639c666bcd9256646dd93a
-  data.tar.gz: 3f92a2cf1aa6fa71844742663d0a520c3f9398fb
-SHA512:
-  metadata.gz: b0b9419da7ee66e6f63f8b99166eaac2fc6144931329de7350321b452c16d90a5c443316a601da462c17260ee2d4a7482b61d6c4cee19f4be0a609abb39caf70
-  data.tar.gz: f1a7c1a1df733b26493ac64f1e3e462a7c925784a2d3fbcfb0da721c9433adc94ceb9e7f2b34a50ed87eed3b9713e30dcf053cfb99b6b0a6a6bac41aded6a83f