canvas_connect 0.0.2 → 0.0.5

data/.gitignore

@@ -3,6 +3,7 @@
 .bundle
 .config
 .yardoc
+.rvmrc
 Gemfile.lock
 InstalledFiles
 _yardoc

data/app/models/adobe_connect_conference.rb

@@ -17,6 +17,7 @@
 #
 
 class AdobeConnectConference < WebConference
+
   # Public: Start a new conference and return its key. (required by WebConference)
   #
   # Returns a conference key string.
@@ -50,8 +51,14 @@ class AdobeConnectConference < WebConference
   # 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}"
+    connect_settings = {
+      :username => user.username,
+      :password => user.password,
+      :domain   => CanvasConnect.config[:domain]
+    }
+    ac_service = AdobeConnect::Service.new(connect_settings)
+    ac_service.log_in
+    "#{meeting_url}?session=#{ac_session.session}"
   end
 
   # Public: Add a participant to the conference and create a meeting URL.
@@ -89,7 +96,7 @@ class AdobeConnectConference < WebConference
   #
   # Returns the CanvasConnect::ConnectUser.
   def add_host(user)
-    connect_user = CanvasConnect::ConnectUser.find_or_create(user)
+    connect_user = AdobeConnect::User.find(user) || AdobeConnect::User.create(user)
     connect_service.permissions_update(
       :acl_id => find_conference_key,
       :principal_id => connect_user.id,
@@ -115,7 +122,7 @@ class AdobeConnectConference < WebConference
       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_container]}' doesn't exist!")
+        raise CanvasConnect::MeetingFolderError.new("Folder '#{config[:meeting_container]}' doesn't exist!")
       end
 
       return nil
@@ -144,10 +151,38 @@ class AdobeConnectConference < WebConference
     result.body.xpath('//status[@code="ok"]').present?
   end
 
+  def meeting_name
+    @cached_meeting_name ||= generate_meeting_name
+  end
+
+  def meeting_url
+    @cached_meeting_url ||= generate_meeting_url
+  end
+
+  def meeting_url_suffix
+    @cached_meeting_url_suffix ||= generate_meeting_url_suffix
+  end
+
+  # Internal: Get and cache a reference to the remote folder.
+  #
+  # Returns a CanvasConnect::MeetingFolder.
+  def meeting_folder
+    @meeting_folder ||= AdobeConnect::MeetingFolder.find(config[:meeting_container], CanvasConnect.client)
+  end
+
+  # Internal: Manage a connection to an Adobe Connect API.
+  #
+  # Returns a CanvasConnect::Service object.
+  def connect_service
+    CanvasConnect.client
+  end
+
+  private
+
   # Internal: Create a unique meeting name from the course and conference IDs.
   #
   # Returns a meeting name string.
-  def meeting_name
+  def generate_meeting_name
     course_code = if self.context.respond_to?(:course_code)
                     self.context.course_code
                   elsif self.context.context.respond_to?(:course_code)
@@ -157,34 +192,17 @@ class AdobeConnectConference < WebConference
                   end
     "#{course_code}: #{self.title} [#{self.id}]"
   end
-  memoize :meeting_name
 
   # Internal: Generate the base URL for the meeting.
-  def meeting_url
+  def generate_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
+  def generate_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/canvas_connect.gemspec

@@ -16,5 +16,8 @@ Gem::Specification.new do |gem|
   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_dependency 'rake', '>= 0.9.6'
+  gem.add_dependency 'adobe_connect', '>= 0.0.6'
 end
 

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

@@ -30,6 +30,7 @@ module Canvas
         #
         # Returns false on error or a hash of settings options.
         def self.validate(settings, plugin_setting)
+          settings.stringify_keys!
           filtered_settings = settings.slice(*REQUIRED_KEYS)
           if all_empty?(filtered_settings)
             # Allow no settings.

data/lib/canvas_connect.rb

@@ -16,13 +16,11 @@
 # with this program. If not, see <http://www.gnu.org/licenses/>.
 #
 
+require 'adobe_connect'
+
 require_dependency "canvas_connect/version"
 require_dependency "canvas/plugins/validators/adobe_connect_validator"
 require_dependency "canvas/plugins/adobe_connect"
-require_dependency "canvas_connect/response"
-require_dependency "canvas_connect/meeting_folder"
-require_dependency "canvas_connect/connect_user"
-require_dependency "canvas_connect/service"
 
 module CanvasConnect
   class ConnectionError < StandardError; end
@@ -38,7 +36,7 @@ module CanvasConnect
         ApplicationController.view_paths.unshift(view_path)
       end
 
-      require_dependency "models/adobe_connect_conference"
+      require_dependency File.expand_path("./../app/models/adobe_connect_conference", File.dirname(__FILE__))
 
       Canvas::Plugins::AdobeConnect.new
     end
@@ -48,15 +46,27 @@ module CanvasConnect
   #
   # Returns a settings hash.
   def self.config
-    Canvas::Plugin.find('adobe_connect').settings || {}
+    settings = Canvas::Plugin.find('adobe_connect').settings || {}
+    AdobeConnect::Config.declare do
+      username settings[:login]
+      password settings[:password_dec]
+      domain   settings[:domain]
+    end
+    settings
   end
 
   # Return a cached Connect Service object to make requests with.
   #
-  # Returns a CanvasConnect::Service.
+  # Returns a AdobeConnect::Service.
   def self.client
     unless @client
-      @client = Service.new(*self.config.values_at(:login, :password_dec, :domain))
+      settings = self.config
+      connect_settings = {
+        :username => settings[:login],
+        :password => settings[:password_dec],
+        :domain   => settings[:domain]
+      }
+      @client = AdobeConnect::Service.new(connect_settings)
       @client.log_in
     end
 

data/lib/canvas_connect/version.rb

@@ -1,22 +1,3 @@
-#
-# 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 CanvasConnect
-  VERSION = "0.0.2"
+  VERSION = '0.0.5'
 end
-

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: canvas_connect
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,40 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-21 00:00:00.000000000 Z
-dependencies: []
+date: 2013-02-13 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
+        version: 0.0.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.6
 description: 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.
@@ -31,10 +63,6 @@ files:
 - lib/canvas/plugins/adobe_connect.rb
 - lib/canvas/plugins/validators/adobe_connect_validator.rb
 - lib/canvas_connect.rb
-- lib/canvas_connect/connect_user.rb
-- lib/canvas_connect/meeting_folder.rb
-- lib/canvas_connect/response.rb
-- lib/canvas_connect/service.rb
 - lib/canvas_connect/version.rb
 - spec_canvas/lib/canvas/plugins/validators/adobe_connect_validator_spec.rb
 - spec_canvas/lib/canvas_connect/response_spec.rb
@@ -61,7 +89,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Adobe Connect integration for Instructure Canvas (http://instructure.com).

data/lib/canvas_connect/connect_user.rb

@@ -1,105 +0,0 @@
-#
-# 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 CanvasConnect
-  class ConnectUser
-    attr_accessor :id, :canvas_user
-    attr_reader :client
-
-    # Public: Create a new ConnectUser instance.
-    #
-    # canvas_user - A Canvas User object.
-    # client - A CanvasConnect::Service instance. (default: CanvasConnect.client)
-    def initialize(canvas_user, client = CanvasConnect.client)
-      @canvas_user, @client = [canvas_user, client]
-    end
-
-    # Public: Save this user to the Adobe Connect instance.
-    #
-    # Returns true.
-    def save
-      response = @client.principal_update(
-        :first_name => @canvas_user.first_name.present? ? @canvas_user.first_name : 'Unknown',
-        :last_name => @canvas_user.last_name.present? ? @canvas_user.last_name : 'Unknown',
-        :login => username,
-        :password => password,
-        :type => 'user',
-        :has_children => 0,
-        :email => @canvas_user.email)
-      @id = response.at_xpath('//principal')['principal-id']
-      true
-    end
-
-    # Public: Generate a unique Adobe Connect username for this user.
-    #
-    # Examples
-    #
-    #   connect_user.username #=> canvas_user_15
-    #
-    # Returns a username string.
-    def username
-      @canvas_user.email
-    end
-
-    # Internal: Generate a 10 character password for Adobe Connect.
-    #
-    # Returns a password string.
-    def password
-      @password ||= Digest::SHA1.hexdigest(@canvas_user.uuid)[0..9]
-    end
-
-    class << self
-      # Public: Find a Canvas user on an Adobe Connect instance.
-      #
-      # user - A Canvas user object.
-      #
-      # Returns a CanvasConnect::ConnectUser or nil.
-      def find(user)
-        connect_user = ConnectUser.new(user)
-        response = connect_user.client.principal_list(:filter_login => connect_user.username)
-        if found_user = response.at_xpath('//principal')
-          connect_user.id = found_user['principal-id']
-          connect_user
-        else
-          nil
-        end
-      end
-
-      # Public: Create an Adobe Connect user for the given Canvas user.
-      #
-      # user - The Canvas user to create in Connect.
-      #
-      # Returns a new CanvasConnect::ConnectUser.
-      def create(user)
-        new_user = ConnectUser.new(user)
-        new_user.save
-
-        new_user
-      end
-
-      # Public: Find the given user in Connect or, if they don't exist, create them.
-      #
-      # user - A Canvas user.
-      #
-      # Returns a CanvasConnect::ConnectUser.
-      def find_or_create(user)
-        find(user) || create(user)
-      end
-    end
-  end
-end

data/lib/canvas_connect/meeting_folder.rb

@@ -1,60 +0,0 @@
-#
-# 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 CanvasConnect
-  class MeetingFolder
-    attr_accessor :name
-
-    extend ActiveSupport::Memoizable
-
-    # Public: Create a new MeetingFolder.
-    #
-    # name - The name of the folder on Adobe Connect (must already exist).
-    # client - A CanvasConnect::Service to make requests with. (default: CanvasConnect.client)
-    def initialize(name, client = CanvasConnect.client)
-      @name   = name
-      @client = client
-    end
-
-    # Public: Get the SCO ID for this folder.
-    #
-    # Returns an SCO ID string or nil if it doesn't exist.
-    def id
-      container     = @client.sco_shortcuts.at_xpath('//sco[@type="user-meetings"]')
-      remote_folder = @client.sco_expanded_contents(:sco_id => container['sco-id'],
-                                                   :filter_name => @name)
-
-      remote_folder.at_xpath('//sco')['sco-id']
-    rescue NoMethodError
-      # Return nil if the container or remote_folder can't be found.
-      nil
-    end
-    memoize :id
-
-    # Public: Get the URL path for this folder.
-    #
-    # Returns a URL fragment string or nil if it can't be queried.
-    def url_path
-      response = @client.sco_info(:sco_id => @id)
-      response.at_xpath('//url-path').text
-    rescue NoMethodError
-      nil
-    end
-    memoize :url_path
-  end
-end

data/lib/canvas_connect/response.rb

@@ -1,29 +0,0 @@
-#
-# 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 CanvasConnect
-  class Response < SimpleDelegator
-    attr_reader :status, :headers, :body
-
-    def initialize(status, headers, body)
-      @status, @headers, @body = [status.to_i, headers, Nokogiri::XML(body)]
-      super(@body)
-    end
-  end
-end
-

data/lib/canvas_connect/service.rb

@@ -1,138 +0,0 @@
-#
-# 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 CanvasConnect
-  class Service
-    attr_reader :username, :domain, :is_authenticated
-
-    def initialize(username, password, domain)
-      @username, @password, @domain = [username, password, domain]
-    end
-
-    # Public: Authenticate against the Adobe Connect server.
-    #
-    # Returns true.
-    def log_in
-      unless logged_in?
-        response = login(:login => @username, :password => @password)
-        if response.xpath('//status[@code="ok"]').empty?
-          raise ConnectionError.new("Could not log in to #{@domain} as #{@username}.")
-        end
-
-      @is_authenticated = true
-      end
-
-      true
-    end
-
-    # Public: Determine if the current session is authenticated.
-    #
-    # Returns a boolean.
-    def logged_in?
-      @is_authenticated
-    end
-
-    # Public: Proxy any unknown methods to the Adobe Connect API.
-    #
-    # method - The snake-cased name of an Adobe Connect method, e.g. `common_info`.
-    # args - Two optional arguments: a hash of GET params, and a skip_session boolean.
-    #
-    # Returns a CanvasConnect::Response.
-    def method_missing(method, *args)
-      action = "#{method}".dasherize
-      params, skip_session = args
-      params ||= {}
-
-      request(action, params, !skip_session)
-    end
-
-    # Public: Create a new Connect session for the given user.
-    #
-    # user - A CanvasConnect::ConnectUser.
-    # domain - The domain to authenticate against.
-    def self.user_session(user, domain)
-      service = CanvasConnect::Service.new(user.username, user.password, domain)
-      service.log_in
-
-      service.session_key
-    end
-
-    # Public: Get a session token for future requests.
-    #
-    # Returns a session token.
-    def session_key
-      unless @session_key
-        response     = request('common-info', {}, false)
-        @session_key = response.xpath('//cookie').text
-      end
-
-      @session_key
-    end
-
-    protected
-    # Internal: Create and/or return a Net::HTTP instance.
-    #
-    # Returns a Net::HTTP instance.
-    def client
-      unless @client
-        uri = URI.parse(@domain)
-        @client = Net::HTTP.new(uri.host, uri.port)
-        @client.use_ssl = (uri.scheme == 'https')
-      end
-
-      @client
-    end
-
-    # Internal: Make a request to the Adobe Connect API.
-    #
-    # action - The name of the Connect API action to call.
-    # params - A hash of parameters to pass with the request. (default: {})
-    # with_session - If true, make the request inside a new or existing session. (default: true)
-    #
-    # Returns a CanvasConnect::Response object.
-    def request(action, params = {}, with_session = true)
-      params[:session] = session_key if with_session
-      response = client.get("/api/xml?action=#{action}#{format_params(params)}")
-
-      CanvasConnect::Response.new(response.code, response.each_header { |h| }, response.body)
-    rescue SocketError, TimeoutError => e
-      # Return an empty, timed-out request.
-      Rails.logger.error "Adobe Connect Request Error on #{action}: #{e.message}"
-      CanvasConnect::Response.new(408, {}, '')
-    end
-
-    # Internal: Convert snake-cased hash keys to dashed.
-    #
-    # params - A hash of parameters with snake-cased string or symbol keys.
-    #
-    # Examples
-    #
-    #   format_params({param_name: 'value', other_param: 'value 2'})
-    #
-    #   # Returns "&param-name=value&other-param=value%202"
-    #
-    # Returns a query string prefixed with a '&' (because it assumes action will be included).
-    def format_params(params)
-      params.inject(['']) do |arr, p|
-        key, value = p
-        arr << "#{key.to_s.dasherize}=#{URI.escape(value.to_s)}"
-      end.join('&')
-    end
-  end
-end
-