canvas_webex 0.0.1

data/README.md

@@ -0,0 +1,28 @@
+# CanvasWebEx
+
+CanvasWebEx is an WebEx plugin for [Instructure
+Canvas](http://instructure.com). It allows users to create and join Cisco
+WebEx conferences directly from their courses.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'canvas_webex'
+
+## Usage
+
+CanvasWebEx registers itself as a Canvas plugin and can be configured by
+going to /plugins in your Canvas instance and entering your WebEx information.
+
+CanvasWebEx 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,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/app/models/cisco_webex_conference.rb

@@ -0,0 +1,102 @@
+#
+# 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/>.
+#
+
+class CiscoWebexConference < WebConference
+
+  # Public: Start a new conference and return its key. (required by WebConference)
+  #
+  # Returns a meeting.
+  def initiate_conference
+    unless self.conference_key.present?
+      webex_meeting = CanvasWebex::Meeting.create(self.title)
+      options = {}
+      options[:duration] = self.duration || 999999
+      self.conference_key = webex_meeting.meeting_key
+      save
+    end
+    self.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 || self.started_at.nil?
+      :active
+    else
+      self.close unless self.ended_at
+      :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)
+    if meeting
+      meeting.host_url
+    end
+  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 meeting
+      if grants_right?(user, nil, :initiate)
+        meeting.host_url
+      else
+        meeting.join_url
+      end
+    end
+  end
+
+  # Public: List all of the recordings for a meeting
+  #
+  # Returns an Array of recording hashes, or an empty Array if there are no recordings
+  def recordings
+    CanvasWebex::Meeting.recordings(self.conference_key)
+  end
+
+  def after_find
+    conference_status
+  end
+
+  protected
+
+  def webex_client
+    CanvasWebex.client
+  end
+
+  # Protected: Retrieve the meeting if it is still active
+  #
+  # Returns the meeting object, or nil if the meeting is ended
+  def meeting
+    self.conference_key && CanvasWebex::Meeting.retrieve(self.conference_key)
+  end
+
+
+end

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

@@ -0,0 +1,34 @@
+<% fields_for :settings, OpenObject.new(settings) do |f| %>
+    <table class="formtable" style="width: 500px;">
+        <tbody>
+        <tr>
+            <td><%= f.blabel :webex_id, :en => "WebEx ID" %></td>
+            <td>
+                <%= f.text_field :webex_id, :autocomplete => false %><br>
+            </td>
+        </tr>
+        <tr>
+            <td><%= f.blabel :password, :en => "Password" %></td>
+            <td>
+                <%= f.password_field :password, :autocomplete => false %><br>
+            </td>
+        </tr>
+        <tr>
+            <td><%= f.blabel :site_id, "Site ID" %></td>
+            <td>
+                <%= f.text_field :site_id, :autocomplete => false %><br>
+            </td>
+        </tr>
+        <tr>
+            <td><%= f.blabel :site_name, "Site Name" %></td>
+            <td>
+                <%= f.text_field :site_name, :autocomplete => false %><br>
+                <small class="help-text">
+                    <%= t(:site_name_description, "Site name for your WebEx account,
+                    if the url is \"https://school.webex.com\" then your site name is 'school'") %>
+                </small>
+            </td>
+        </tr>
+        </tbody>
+    </table>
+<% end %>

data/canvas_webex.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'canvas_webex/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'canvas_webex'
+  gem.version       = CanvasWebex::VERSION
+  gem.authors       = ['Nathan Mills']
+  gem.email         = ['nathanm@instructure.com']
+  gem.description   = %q{Canvas WebEx is an Cisco Webex plugin for the Instructure Canvas LMS. It allows teachers and administrators to create and launch WEbEx conferences directly from their courses.}
+  gem.summary       = %q{Cisco WebEx 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}
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'nokogiri'
+  gem.add_development_dependency 'webmock'
+  gem.add_development_dependency 'pry'
+end
+

data/lib/canvas/plugins/cisco_webex.rb

@@ -0,0 +1,47 @@
+#
+# 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 CiscoWebex
+
+      # 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('cisco_webex', :web_conferencing, {
+          :name => lambda { t(:name, 'Cisco WebEx') },
+          :description => lambda { t(:description, 'Cisco WebEx web conferencing support.') },
+          :author => 'Instructure',
+          :author_website => 'http://instructure.com',
+          :version => CanvasWebex::VERSION,
+          :settings_partial => 'plugins/webex_settings',
+          :validator => 'CiscoWebexValidator',
+          :encrypted_settings => [:password]
+        })
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,77 @@
+#
+# 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 Canvas
+  module Plugins
+    module Validators
+      class CiscoWebexValidator
+        # Public: An array of allowed plugin settings.
+        REQUIRED_KEYS = %w{webex_id password site_id site_name}
+
+        # 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_webex.rb

@@ -0,0 +1,60 @@
+#
+# 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/>.
+#
+
+require "canvas_webex/version"
+require "canvas/plugins/validators/cisco_webex_validator"
+require "canvas/plugins/cisco_webex"
+require "canvas_webex/service"
+require "canvas_webex/meeting"
+
+module CanvasWebex
+  class ConnectionError < StandardError; end
+
+  # Public: Configure as a Canvas plugin
+  #
+  # Returns nothing.
+  def self.register
+    Rails.configuration.to_prepare do
+      view_path = File.join(File.dirname(__FILE__), '..', 'app', 'views')
+      unless ApplicationController.view_paths.include?(view_path)
+        ApplicationController.view_paths.unshift(view_path)
+      end
+
+      require_dependency "models/cisco_webex_conference"
+
+      Canvas::Plugins::CiscoWebex.new
+    end
+  end
+
+  # Public: Find the plugin configuration.
+  #
+  # Returns a settings hash.
+  def self.config
+    Canvas::Plugin.find('cisco_webex').settings || {}
+  end
+
+  # Return a cached Connect Service object to make requests with.
+  #
+  # Returns a CiscoWwebex::Service.
+  def self.client
+    @client ||= Service.new(*self.config.values_at(:webex_id, :password_dec, :site_id, :site_name, :partner_id))
+  end
+
+end
+
+CanvasWebex.register

data/lib/canvas_webex/meeting.rb

@@ -0,0 +1,84 @@
+#
+# 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 Meeting
+
+    ATTRIBUTES = [:meeting_key, :conf_name, :start_date, :host_joined, :status]
+
+    def self.retrieve(meeting_key, client = CanvasWebex.client)
+      if response = client.get_meeting(meeting_key)
+        Meeting.new(Nokogiri::XML(response.to_xml))
+      end
+    end
+
+    def self.create(meeting_name, client = CanvasWebex.client)
+      if response = client.create_meeting(meeting_name)
+        if meeting_key = response.at_xpath('//meetingkey').try(:text)
+          retrieve(meeting_key, client)
+        end
+      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|
+          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)
+          }
+          if duration = rec_xml.at_xpath('duration').try(:text)
+            recording[:duration_minutes] = duration.to_i / 60
+          end
+          recording
+        end
+      else
+        []
+      end
+    end
+
+    # Public: Create a new Meeting
+    #
+    # meeting_xml - The xml returned for a meeting (must already exist).
+    def initialize(meeting_xml)
+      @attr_cache = {}
+      @xml = meeting_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