adobe_connect 1.0.0 → 1.0.2

data/lib/adobe_connect/response.rb

@@ -1,7 +1,9 @@
+require 'delegate'
+
 module AdobeConnect
 
   # Public: A response from the Connect API.
-  class Response
+  class Response < SimpleDelegator
     attr_reader :status, :body
 
     # Public: Create a new AdobeConnect::Response.
@@ -11,6 +13,8 @@ module AdobeConnect
       @response = response
       @status   = response.code.to_i
       @body     = Nokogiri::XML(response.body)
+
+      __setobj__(@body)
     end
 
     # Public: Fetch the given header's value.
@@ -21,23 +25,5 @@ module AdobeConnect
     def fetch(header)
       @response.fetch(header)
     end
-
-    # Public: Execute an xpath call against the response body.
-    #
-    # *args - Arguments to pass to Nokogiri's xpath method.
-    #
-    # Returns a Nokogiri object.
-    def xpath(*args)
-      @body.xpath(*args)
-    end
-
-    # Public: Execute an at_xpath call against the response body.
-    #
-    # *args - Arguments to pass to Nokogiri's xpath method.
-    #
-    # Returns a Nokogiri object.
-    def at_xpath(*args)
-      @body.at_xpath(*args)
-    end
   end
 end

data/lib/adobe_connect/service.rb

@@ -79,7 +79,7 @@ module AdobeConnect
     # use_session - If true, require an active session (default: true).
     #
     # Returns an AdobeConnect::Response.
-    def request(action, params, use_session = true)
+    def request(action, params={}, use_session = true)
       if use_session
         log_in unless authenticated?
         params[:session] = session

data/lib/adobe_connect/telephony_profile.rb

@@ -0,0 +1,87 @@
+module AdobeConnect
+
+  # Public: Represents a Group in a Connect environment.
+  class TelephonyProfile < Base
+    attr_accessor :conf_number, :location, :principal_id,
+      :name, :status, :provider_id
+
+    #
+    # telephony_profile_options - A hash with the following keys:
+    #                name        - The profile's name.
+    #                status      - Status of the profile (enabled or disabled)
+    #                conf_number - Conference number associated with profile
+    #                location    - Country code for conference number, required
+    #                              if conf_number present
+    #                principal_id- ID of User that the profile should belong
+    #                              to, defaults to logged in user
+    #                provider_id - ID of the telephony provider
+    #
+
+    def attrs
+      atrs = { :profile_name => self.name }
+
+      if !self.id.nil?
+        atrs.merge!(:profile_id => self.id)
+      end
+
+      [:id, :status].each do |atr|
+        if !self.send(atr).nil?
+          atrs.merge!("profile_#{atr}".to_sym => self.send(atr))
+        end
+      end
+
+      [:principal_id, :provider_id].each do |atr|
+        if !self.send(atr).nil?
+          atrs.merge!(atr => self.send(atr))
+        end
+      end
+
+      if !self.conf_number.nil? && !self.location.nil?
+        atrs.merge!(:conf_number => self.conf_number, :location => self.location)
+      end
+
+      atrs
+    end
+
+    def self.config
+      super.merge({ :ac_obj_type => 'profile', :delete_method_is_plural => false,
+        :ac_obj_node_name => 'telephony-profile', :ac_method_prefix => 'telephony_profile' })
+    end
+
+    # Public: Find the specified profile on the Connect server.
+    #
+    # name - Profile's name on Connect server
+    # principal_id - ID of user on Connect server that the Telephony
+    #                Profile belongs to. Will use API user by default.
+    #
+    # Returns an AdobeConnect::TelephonyProfile or nil.
+    def self.find_by_name(name, principal_id = nil, service = AdobeConnect::Service.new)
+      params = {}
+      params.merge!(:principal_id => principal_id) unless principal_id.nil?
+
+      response = service.telephony_profile_list(params)
+
+      matching_profiles = response.at_xpath('//telephony-profiles').children.select{|c|
+        name_node = c.children.select{|ch| ch.name == 'profile-name' }[0]
+        name_node.text == name
+      }
+
+      if matching_profiles.count == 1
+        prof_id = matching_profiles[0].attr('profile-id')
+        resp = service.telephony_profile_info(:profile_id => prof_id)
+        self.load_from_xml(resp.at_xpath('//telephony-profile'), principal_id)
+      end
+    end
+
+    private
+    def self.load_from_xml(p, principal_id)
+      self.new({
+          :name => p.at_xpath('//profile-name').text,
+          :id => p.attr('profile-id'),
+          :status => p.attr('profile-status'),
+          :principal_id => principal_id,
+          :provider_id => p.attr('provider-id')
+        })
+    end
+  end
+end

data/lib/adobe_connect/user.rb

@@ -1,26 +1,35 @@
 module AdobeConnect
 
   # Public: Represents a user in a Connect environment.
-  class User
-    # Public: SCO-ID from the Adobe Connect instance.
-    attr_reader :id
+  class User < Base
+    attr_accessor :first_name, :last_name, :email, :username, :uuid, :send_email
 
-    attr_reader :service, :errors
-    attr_accessor :first_name, :last_name, :email, :username, :uuid
-
-    # Public: Create a new AdobeConnect User.
     #
     # user_options - A hash with the following keys:
     #                first_name - User's first name.
     #                last_name  - User's last name.
     #                email      - The email address for the user.
+    #                username   - The login for the connect user.
     #                uuid       - A unique identifier for this user (used to
     #                             generate a password).
-    # service - An AdobeConnect::Service object (default: Service.new)
-    def initialize(user_options, service = Service.new)
-      user_options.each { |key, value| send(:"#{key}=", value) }
-      @service  = service
-      @errors   = []
+    #                send_email - The server sends a welcome e-mail with login information
+    #                             to the user’s e-mail address.
+    #
+
+    def attrs
+      atrs = { :first_name => first_name,
+        :last_name => last_name, :login => username,
+        :email => email, :send_email => send_email,
+        :has_children => 0 }
+      if !self.id.nil?
+        atrs.merge!(:principal_id => self.id)
+      else
+        atrs.merge!(
+          :password => password,
+          :type => 'user'
+        )
+      end
+      atrs
     end
 
     # Public: Getter for the Connect user's username. If no username is
@@ -38,37 +47,6 @@ module AdobeConnect
       Digest::MD5.hexdigest(uuid)[0..9]
     end
 
-    # Public: Save this user to the Adobe Connect instance.
-    #
-    # Returns a boolean.
-    def save
-      response = service.principal_update(:first_name => first_name,
-        :last_name => last_name, :login => username,
-        :password => password, :type => 'user', :has_children => 0,
-        :email => email)
-
-      if response.at_xpath('//status').attr('code') == 'ok'
-        self.id = response.at_xpath('//principal').attr('principal-id')
-        true
-      else
-        save_errors(response)
-        false
-      end
-    end
-
-    # Public: Create a Connect user from the given app user.
-    #
-    # user_options - Generic user options (see #initialize for required
-    #   attributes).
-    #
-    # Returns an AdobeConnect::User.
-    def self.create(user_options)
-      user = AdobeConnect::User.new(user_options)
-      user.save
-
-      user
-    end
-
     # Public: Find the given app user on the Connect server.
     #
     # app_user - Generic user options (see #initialize for required
@@ -84,17 +62,5 @@ module AdobeConnect
         user
       end
     end
-
-    private
-    attr_writer :id
-
-    # Internal: Store request errors in @errors.
-    #
-    # response - An AdobeConnect::Response.
-    #
-    # Returns nothing.
-    def save_errors(response)
-      @errors = response.xpath('//invalid').map(&:attributes)
-    end
   end
 end

data/lib/adobe_connect/version.rb

@@ -1,4 +1,4 @@
 module AdobeConnect
   # Public: Current Gem version.
-  VERSION = '1.0.0'
+  VERSION = '1.0.2'
 end

data/test/fixtures/acl_field_save_error.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="utf-8"?>
+<results>
+  <status code="invalid">
+    <invalid field="prepared-statement" type="long" subcode="format"/>
+  </status>
+</results>

data/test/fixtures/acl_field_save_success.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="utf-8"?>
+<results>
+  <status code="ok"/>
+  <field account-id="7" is-primary="true" is-required="false" field-id="26243" object-type="object-type-principal" display-seq="11" field-type="text" permission-id="manage">
+    <name>Phone</name>
+  </field>
+</results>

data/test/fixtures/acl_field_update_success.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="utf-8"?>
+<results>
+  <status code="ok"/>
+  <field display-seq="12" account-id="7" is-primary="true" is-required="false" field-id="26243" object-type="object-type-principal" field-type="text" permission-id="manage">
+    <name>Phone 2</name>
+  </field>
+</results>

data/test/fixtures/group_is_member.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="utf-8"?>
+<results>
+  <status code="ok"/>
+  <principal-list>
+    <principal principal-id="26243" account-id="7" type="user" has-children="false" is-primary="false" is-hidden="false" training-group-id="">
+      <name>Testing User</name>
+      <login>testinguser@example.com</login>
+      <email>testinguser@example.com</email>
+      <display-uid>testinguser@example.com</display-uid>
+      <is-member>true</is-member>
+    </principal>
+  </principal-list>
+</results>

data/test/fixtures/group_is_not_member.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="utf-8"?>
+<results>
+  <status code="ok"/>
+  <principal-list/>
+</results>

data/test/fixtures/group_save_error.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="utf-8"?>
+<results>
+  <status code="invalid">
+    <invalid field="login" type="string" subcode="duplicate"/>
+  </status>
+</results>

data/test/fixtures/group_save_success.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="utf-8"?>
+<results>
+  <status code="ok"/>
+  <principal type="group" has-children="1" account-id="7" principal-id="26243">
+    <description>This is for testing</description>
+    <name>Test group name</name>
+    <login>Test group name</login>
+  </principal>
+</results>

data/test/fixtures/group_update_success.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="utf-8"?>
+<results>
+  <status code="ok"/>
+  <principal type="group" has-children="1" account-id="7" principal-id="26243">
+    <description>This is for testing updates</description>
+    <name>Test group name</name>
+    <login>Test group name</login>
+  </principal>
+</results>

data/test/fixtures/meeting_find_by_id_error.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="utf-8"?>
+<results>
+  <status code="no-access" subcode="denied"/>
+</results>

data/test/fixtures/meeting_find_by_id_success.xml

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="utf-8"?>
+<results>
+    <status code="ok" />
+    <sco account-id="1234" disabled="" display-seq="0" folder-id="1234567" icon="meeting" lang="en" max-retries="" sco-id="98765" source-sco-id="" type="meeting" version="0">
+        <date-begin>2014-03-05T16:00:00.000-08:00</date-begin>
+        <date-created>2014-03-06T08:40:36.757-08:00</date-created>
+        <date-end>2014-03-05T17:00:00.000-08:00</date-end>
+        <date-modified>2014-03-06T09:51:10.407-08:00</date-modified>
+        <name>THE Meeting</name>
+        <url-path>/r3wrt7zkrpg/</url-path>
+        <update-linked-item>true</update-linked-item>
+    </sco>
+    <seminar-session-expiry-info>
+        <seminar-session-expired>false</seminar-session-expired>
+    </seminar-session-expiry-info>
+</results>

data/test/fixtures/meeting_save_error.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="utf-8"?>
+<results>
+  <status code="invalid">
+    <invalid field="folder-id" type="id" subcode="format"/>
+  </status>
+</results>

data/test/fixtures/meeting_save_success.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="utf-8"?>
+<results>
+  <status code="ok"/>
+  <sco account-id="7" disabled="" display-seq="0" folder-id="12345" icon="meeting" lang="en" max-retries="" sco-id="26243" source-sco-id="" type="meeting" version="0">
+    <date-created>2013-06-22T14:22:14.380-04:00</date-created>
+    <date-modified>2013-06-22T14:22:14.380-04:00</date-modified>
+    <description>This is an important meeting</description>
+    <name>Important Meeting</name>
+    <url-path>/r2zssih0kaq/</url-path>
+  </sco>
+</results>

data/test/fixtures/meeting_update_success.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="utf-8"?>
+<results>
+  <status code="ok"/>
+  <sco account-id="7" disabled="" display-seq="0" folder-id="12345" icon="meeting" lang="en" max-retries="" sco-id="26243" source-sco-id="" type="meeting" version="0">
+    <date-created>2013-06-22T14:22:14.380-04:00</date-created>
+    <date-modified>2013-06-22T14:22:14.380-04:00</date-modified>
+    <description>This is an important meeting</description>
+    <name>Important Meeting</name>
+    <url-path>/r2zssih0kaq/</url-path>
+  </sco>
+</results>

data/test/fixtures/telephony_profile_info_success.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="utf-8"?>
+<results>
+  <status code="ok"/>
+  <telephony-profile profile-id="26243" provider-id="987654321" profile-status="enabled" hide-toll-free="false" provider-type="user-conf">
+    <adaptor-id>987654321-adaptor</adaptor-id>
+    <provider-name>SoundConnect</provider-name>
+    <profile-name>SoundConnect</profile-name>
+    <provider-status>enabled</provider-status>
+  </telephony-profile>
+  <telephony-profile-fields disabled="" hide-toll-free="false" principal-id="123456" profile-id="26243" profile-status="enabled" provider-id="987654321">
+    <profile-name>SoundConnect</profile-name>
+  </telephony-profile-fields>
+ </results>

data/test/fixtures/telephony_profile_list_success.xml

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="utf-8"?>
+<results>
+  <status code="ok"/>
+  <telephony-profiles>
+    <profile profile-id="789456" provider-id="987654321" profile-status="enabled">
+      <adaptor-id>987654321-adaptor</adaptor-id>
+      <name>SoundConnect Provider</name>
+      <profile-name>SoundConnect2</profile-name>
+    </profile>
+    <profile profile-id="26243" provider-id="987654321" profile-status="enabled">
+      <adaptor-id>987654321-adaptor</adaptor-id>
+      <name>SoundConnect Provider</name>
+      <profile-name>SoundConnect</profile-name>
+    </profile>
+  </telephony-profiles>
+</results>

data/test/fixtures/telephony_profile_save_error.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="utf-8"?>
+<results>
+  <status code="invalid">
+    <invalid field="profile-name" type="string" subcode="duplicate"/>
+  </status>
+</results>

data/test/fixtures/telephony_profile_save_success.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="utf-8"?>
+<results>
+  <status code="ok"/>
+  <telephony-profile profile-status="enabled" provider-id="1160437530" principal-id="1144604670" profile-id="26243">
+    <profile-name>SoundConnect</profile-name>
+  </telephony-profile>
+</results>

data/test/fixtures/telephony_profile_update_success.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="utf-8"?>
+<results>
+  <status code="ok"/>
+  <telephony-profile profile-status="enabled" provider-id="1160437530" principal-id="1144604670" profile-id="26243">
+    <profile-name>SoundConnect2</profile-name>
+  </telephony-profile>
+</results>