canvas_connect 0.0.1

data/lib/canvas_connect/connect_user.rb

@@ -0,0 +1,105 @@
+#
+# 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_#{@canvas_user.id}"
+    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

@@ -0,0 +1,60 @@
+#
+# 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

@@ -0,0 +1,29 @@
+#
+# 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

@@ -0,0 +1,138 @@
+#
+# 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}.")
+        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
+

data/lib/canvas_connect/version.rb

@@ -0,0 +1,22 @@
+#
+# 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.1"
+end
+

data/spec_canvas/lib/canvas/plugins/validators/adobe_connect_validator_spec.rb

@@ -0,0 +1,45 @@
+#
+# 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 File.expand_path(File.dirname(__FILE__) + '/../../../../../../../../spec/spec_helper')
+
+describe Canvas::Plugins::Validators::AdobeConnectValidator do
+  let(:plugin_setting) { mock }
+
+  subject { Canvas::Plugins::Validators::AdobeConnectValidator }
+
+  it 'should allow an empty hash' do
+    subject.validate({}, plugin_setting).should eql Hash.new
+  end
+
+  it 'should error on missing keys' do
+    plugin_setting.expects(:errors).returns(stub(:add_to_base => true))
+    subject.validate({:domain => 'example.com'}, plugin_setting).should be_false
+  end
+
+  it 'should pass if all keys exist' do
+    valid_keys = {
+      :domain => 'example.com',
+      :login => 'username',
+      :password => 'password',
+      :meeting_container => 'folder_name'
+    }
+
+    subject.validate(valid_keys, plugin_setting).should eql valid_keys
+  end
+end

data/spec_canvas/lib/canvas_connect/response_spec.rb

@@ -0,0 +1,52 @@
+#
+# 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 File.expand_path(File.dirname(__FILE__) + '/../../../../../../spec/spec_helper')
+
+describe CanvasConnect::Response do
+  let(:body) { '<?xml version="1.0"?><items><item>Item Name</item></items>' }
+  subject { CanvasConnect::Response.new(200, {}, body) }
+
+  it { should respond_to(:status) }
+  it { should respond_to(:headers) }
+  it { should respond_to(:body) }
+
+  its(:body) { should be_an_instance_of(Nokogiri::XML::Document) }
+
+  describe 'initialize' do
+    it 'should require a status' do
+      lambda { CanvasConnect::Response.new }.should raise_error(ArgumentError)
+    end
+
+    it 'should require headers' do
+      lambda { CanvasConnect::Response.new(200) }.should raise_error(ArgumentError)
+    end
+
+    it 'should require a body' do
+      lambda { CanvasConnect::Response.new(200, {}) }.should raise_error(ArgumentError)
+    end
+  end
+
+  describe 'simple delegator' do
+    let(:body) { '<?xml version="1.0"?><items><item>Item Name</item></items>' }
+
+    it 'should delegate to body' do
+      subject.xpath('//item').text.should eql 'Item Name'
+    end
+  end
+end