canvas_connect 0.0.1

data/README.md

@@ -0,0 +1,28 @@
+# CanvasConnect
+
+CanvasConnect is an Adobe Connect plugin for [Instructure
+Canvas](http://instructure.com). It allows users to create and join Adobe
+Connect conferences directly from their courses.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'canvas_connect'
+
+## Usage
+
+CanvasConnect registers itself as a Canvas plugin and can be configured by
+going to /plugins in your Canvas instance and entering your Connect information.
+
+CanvasConnect assumes that it's being used inside of a Canvas instance, and
+will explode in strange and beautiful ways if you try to run anything in it
+outside of Canvas.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/app/models/adobe_connect_conference.rb

@@ -0,0 +1,190 @@
+#
+# Copyright (C) 2012 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/>.
+#
+
+class AdobeConnectConference < WebConference
+  # Public: Start a new conference and return its key. (required by WebConference)
+  #
+  # Returns a conference key string.
+  def initiate_conference
+    unless @conference_key.present?
+      create_meeting unless meeting_exists?
+      save
+    end
+
+    find_conference_key
+  end
+
+  # Public: Determine the status of the conference (required by 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?
+      :active
+    else
+      :closed
+    end
+  end
+
+  # Public: Add an admin to the conference and create a meeting URL (required by WebConference).
+  #
+  # admin - The user to add to the conference as an admin.
+  # _ - Included for compatibility w/ web_conference.rb
+  #
+  # Returns a meeting URL string.
+  def admin_join_url(admin, _ = nil)
+    user = add_host(admin)
+    key = CanvasConnect::Service.user_session(user, config[:domain])
+    "#{meeting_url}?session=#{key}"
+  end
+
+  # Public: Add a participant to the conference and create a meeting URL.
+  #         Make the user a conference admin if they have permissions to create
+  #         a conference (required by WebConference).
+  #
+  # user - The user to add to the conference as an admin.
+  # _ - Included for compatibility w/ web_conference.rb
+  #
+  # Returns a meeting URL string.
+  def participant_join_url(user, _ = nil)
+    if grants_right?(user, nil, :initiate)
+      admin_join_url(user)
+    else
+      "#{meeting_url}?guestName=#{URI.escape(user.name)}"
+    end
+  end
+
+  protected
+  # Internal: Retrieve the SCO-ID for this meeting.
+  #
+  # Returns an SCO-ID string.
+  def find_conference_key
+    unless @conference_key.present?
+      response = connect_service.sco_by_url(:url_path => meeting_url_suffix)
+      @conference_key = response.body.xpath('//sco[@sco-id]').attr('sco-id').value
+    end
+
+    @conference_key
+  end
+
+  # Internal: Register a participant as a host.
+  #
+  # user - The user to add as a conference admin.
+  #
+  # Returns the CanvasConnect::ConnectUser.
+  def add_host(user)
+    connect_user = CanvasConnect::ConnectUser.find_or_create(user)
+    connect_service.permissions_update(
+      :acl_id => find_conference_key,
+      :principal_id => connect_user.id,
+      :permission_id => 'host')
+
+    connect_user
+  end
+
+  # Internal: Create a new Connect meeting.
+  #
+  # Returns nothing.
+  def create_meeting
+    params = { :type => 'meeting',
+               :name => meeting_name,
+               :folder_id => meeting_folder.id,
+               :date_begin => start_at.iso8601,
+               :url_path => meeting_url_suffix }
+    params[:end_at] = end_at.iso8601 if end_at.present?
+
+    result = connect_service.sco_update(params)
+    if result.body.xpath('//status[@code="ok"]').empty?
+      error = result.body.at_xpath('//invalid')
+      Rails.logger.error "Adobe Connect error on meeting create. Field: #{error['field']}, Value: #{error['subcode']}"
+
+      if error['field'] == 'folder-id'
+        throw CanvasConnect::MeetingFolderError.new("Folder '#{CanvasConnect.config[:meeting_folder]}' doesn't exist!")
+      end
+
+      return nil
+    end
+
+    sco_id = result.body.at_xpath('//sco')['sco-id']
+    make_meeting_public(sco_id)
+  end
+
+  # Internal: Make a given meeting publicly accessible.
+  #
+  # sco_id - The meeting's SCO-ID string.
+  #
+  # Returns the request object.
+  def make_meeting_public(sco_id)
+    connect_service.permissions_update(:acl_id => sco_id,
+                                       :principal_id => 'public-access',
+                                       :permission_id => 'view-hidden')
+  end
+
+  # Internal: Determine if this meeting exists in Adobe Connect.
+  #
+  # Returns a boolean.
+  def meeting_exists?
+    result = connect_service.sco_by_url(:url_path => meeting_url_suffix)
+    result.body.xpath('//status[@code="ok"]').present?
+  end
+
+  # Internal: Create a unique meeting name from the course and conference IDs.
+  #
+  # Returns a meeting name string.
+  def meeting_name
+    course_code = if self.context.respond_to?(:course_code)
+                    self.context.course_code
+                  elsif self.context.context.respond_to?(:course_code)
+                    self.context.context.course_code
+                  else
+                    'Canvas'
+                  end
+    "#{course_code}: #{self.title} [#{self.id}]"
+  end
+  memoize :meeting_name
+
+  # Internal: Generate the base URL for the meeting.
+  def meeting_url
+    "#{config[:domain]}/#{meeting_url_suffix}"
+  end
+  memoize :meeting_url
+
+  # Internal: Generate a URL suffix for this conference.
+  #
+  # Returns a URL suffix string of format "canvas-meeting-:id".
+  def meeting_url_suffix
+    "canvas-meeting-#{self.id}"
+  end
+  memoize :meeting_url_suffix
+
+  # Internal: Get and cache a reference to the remote folder.
+  #
+  # Returns a CanvasConnect::MeetingFolder.
+  def meeting_folder
+    @meeting_folder ||= CanvasConnect::MeetingFolder.new(config[:meeting_container])
+  end
+
+  # Internal: Manage a connection to an Adobe Connect API.
+  #
+  # Returns a CanvasConnect::Service object.
+  def connect_service
+    CanvasConnect.client
+  end
+end
+

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

@@ -0,0 +1,37 @@
+<% fields_for :settings, OpenObject.new(settings) do |f| %>
+  <table class="formtable" style="width: 500px;">
+    <tbody>
+      <tr>
+        <td><%= f.blabel :domain, :en => "Domain" %></td>
+        <td>
+          <%= f.text_field :domain %><br>
+          <small class="help-text">
+            <%= t(:domain_description, "Protocol and hostname or IP address of your Adobe Connect installation (e.g. https://connect.mycompany.com)") %>
+          </small>
+        </td>
+      </tr>
+
+      <tr>
+        <td><%= f.blabel :meeting_container, :en => "Meeting Folder" %></td>
+        <td>
+          <%= f.text_field :meeting_container %><br>
+          <small class="help-text">
+            <%= t(:meeting_container_description, "The name of a folder, inside the \"User Meetings\" folder, where Canvas meetings will be stored. Create this folder before creating any meetings.") %>
+          </small>
+        </td>
+      </tr>
+      <tr>
+        <td><%= f.blabel :login, "Login ID" %></td>
+        <td>
+          <%= f.text_field :login, :autocomplete => false %><br>
+        </td>
+      </tr>
+      <tr>
+        <td><%= f.label :password, "Password" %></td>
+        <td>
+          <%= f.password_field :password, :autocomplete => false %><br>
+        </td>
+      </tr>
+    </tbody>
+  </table>
+<% end %>

data/canvas_connect.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'canvas_connect/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'canvas_connect'
+  gem.version       = CanvasConnect::VERSION
+  gem.authors       = ['Zach Pendleton']
+  gem.email         = ['zachp@instructure.com']
+  gem.description   = %q{Canvas Connect is an Adobe Connect plugin for the Instructure Canvas LMS. It allows teachers and administrators to create and launch Connect conferences directly from their courses.}
+  gem.summary       = %q{Adobe Connect integration for Instructure Canvas (http://instructure.com).}
+  gem.homepage      = 'http://instructure.com'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = %w{app lib}
+end
+

data/lib/canvas/plugins/adobe_connect.rb

@@ -0,0 +1,44 @@
+#
+# Copyright (C) 2012 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 Canvas
+  module Plugins
+    class AdobeConnect
+      # Public: Bootstrap the gem on app load.
+      #
+      # Returns nothing.
+      def initialize; register; end
+
+      protected
+      # Internal: Register as a plugin with Canvas.
+      #
+      # Returns a Canvas plugin object.
+      def register
+        Canvas::Plugin.register('adobe_connect', :web_conferencing, {
+          :name => lambda { t(:name, 'Adobe Connect') },
+          :description => lambda { t(:description, 'Adobe Connect web conferencing support.') },
+          :author => 'OCAD University',
+          :author_website => 'http://www.ocadu.ca',
+          :version => CanvasConnect::VERSION,
+          :settings_partial => 'plugins/connect_settings',
+          :validator => 'AdobeConnectValidator',
+          :encrypted_settings => [:password] })
+      end
+    end
+  end
+end

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

@@ -0,0 +1,78 @@
+#
+# Copyright (C) 2012 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 Canvas
+  module Plugins
+    module Validators
+      module AdobeConnectValidator
+        # Public: An array of allowed plugin settings.
+        REQUIRED_KEYS = %w{domain login password meeting_container}
+
+        # Public: Validate setting input for this plugin.
+        #
+        # settings - A hash of settings params.
+        # plugin_setting - A plugin setting object.
+        #
+        # Returns false on error or a hash of settings options.
+        def self.validate(settings, plugin_setting)
+          filtered_settings = settings.slice(*REQUIRED_KEYS)
+          if all_empty?(filtered_settings)
+            # Allow no settings.
+            {}
+          else
+            if valid?(filtered_settings)
+              filtered_settings
+            else
+              plugin_setting.errors.add_to_base(I18n.t('canvas.plugins.errors.all_fields_required', 'All fields are required'))
+              false
+            end
+          end
+        end
+
+        protected
+        # Internal: Determine if a given settings hash is empty.
+        #
+        # settings - A hash of setting params.
+        #
+        # Returns a boolean.
+        def self.all_empty?(settings)
+          settings.values.all?(&:blank?)
+        end
+
+        # Internal: Determine if any settings are missing from the given hash.
+        #
+        # settings - A hash of setting params.
+        #
+        # Returns a boolean.
+        def self.any_empty?(settings)
+          settings.values.any?(&:blank?)
+        end
+
+        # Internal: Validate that all required settings are present.
+        #
+        # settings - The hash of settings to validate.
+        #
+        # Returns boolean.
+        def self.valid?(settings)
+          !(any_empty?(settings) || (REQUIRED_KEYS & settings.keys) != REQUIRED_KEYS)
+        end
+      end
+    end
+  end
+end
+

data/lib/canvas_connect.rb

@@ -0,0 +1,67 @@
+#
+# Copyright (C) 2012 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/>.
+#
+
+require "canvas_connect/version"
+require "canvas/plugins/validators/adobe_connect_validator"
+require "canvas/plugins/adobe_connect"
+require "canvas_connect/response"
+require "canvas_connect/meeting_folder"
+require "canvas_connect/connect_user"
+require "canvas_connect/service"
+
+module CanvasConnect
+  class ConnectionError < StandardError; end
+  class MeetingFolderError < StandardError; end
+
+  # Public: Configure as a Canvas plugin.
+  #
+  # Returns nothing.
+  def self.register
+    Rails.configuration.to_prepare do
+      view_path = File.dirname(__FILE__) + '/../app/views'
+      unless ApplicationController.view_paths.include?(view_path)
+        ApplicationController.view_paths.unshift(view_path)
+      end
+
+      require "models/adobe_connect_conference"
+
+      Canvas::Plugins::AdobeConnect.new
+    end
+  end
+
+  # Public: Find the plugin configuration.
+  #
+  # Returns a settings hash.
+  def self.config
+    Canvas::Plugin.find('adobe_connect').settings || {}
+  end
+
+  # Return a cached Connect Service object to make requests with.
+  #
+  # Returns a CanvasConnect::Service.
+  def self.client
+    unless @client
+      @client = Service.new(*self.config.values_at(:login, :password_dec, :domain))
+      @client.log_in
+    end
+
+    @client
+  end
+end
+
+CanvasConnect.register