adobe_connect 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bc223a736c0e1ffd1752dabb467d5bac287c6bff
-  data.tar.gz: d97e1dc9f21b30ff133c97f50ea8afecb13d9e81
+  metadata.gz: ae95eaae6a338ddf57dc714ddffe464d202deab6
+  data.tar.gz: 19d53983d307144139b25ae5e803f05949499f47
 SHA512:
-  metadata.gz: b4c3da73e805853355f007365e74336080d4ed46122d8c6884b3563222cbf8e21550c46aabd1d644d04a1ab2f8475eb561825aafe45272957f511e7f885118b8
-  data.tar.gz: d476b8460774e4ac7546dce81cec16fea8c5c19776af0c433962d60ac9e1d4c123369e0abedd03d88e41fe0b5805fea86e0b72f63caa84fa024245fcc17a0363
+  metadata.gz: 3c89efd518cec436b43bc20ad90237ba562c6534fe5be57452adb8be03b056f75b5007aaad47e5b7ae625080ddb5081a66604f85609a1fd387fdf586c9ea9182
+  data.tar.gz: 1eef97ab37e4c0edddcfce8b2f65aad63b6bb9be3434be798e1acdb558545489acd80b26494f744ceca1b81fea854e0be16223741a9020d5806f148468485df9

data/adobe_connect.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ['lib']
 
   gem.add_dependency 'activesupport', '>= 2.3.17'
-  gem.add_dependency 'nokogiri',      '~> 1.5.5'
+  gem.add_dependency 'nokogiri',      '>= 1.5.5', '< 1.7'
   gem.add_dependency 'rake',          '>= 0.9.2'
 
   gem.add_development_dependency 'minitest',    '~> 4.6.0'

data/lib/adobe_connect.rb

@@ -7,7 +7,12 @@ require 'adobe_connect/config'
 require 'adobe_connect/response'
 require 'adobe_connect/service'
 require 'adobe_connect/param_formatter'
+require 'adobe_connect/base'
+require 'adobe_connect/acl_field'
+require 'adobe_connect/group'
+require 'adobe_connect/meeting'
 require 'adobe_connect/meeting_folder'
+require 'adobe_connect/telephony_profile'
 require 'adobe_connect/user'
 
 # Public: Namespace for AdobeConnect classes/modules.

data/lib/adobe_connect/acl_field.rb

@@ -0,0 +1,60 @@
+module AdobeConnect
+
+  # Public: Represents a Custom Field object inside of Connect.
+  class AclField < Base
+    attr_accessor :name, :obj_type, :id, :service
+
+    #
+    # id      - The Field-ID of the custom field object.
+    # name    - The name of the Field.
+    # obj_type- The type of Connect Object this applies to. Allowed values
+    #           are: principal, meeting, sco, event, read-only
+    #
+    def attrs
+      atrs = {
+        :object_type => "object-type-#{obj_type}", :permission_id => 'manage',
+        :name => name, :field_type => 'text', :is_required => false,
+        :is_primary => true
+      }
+
+      if !id.nil?
+        atrs.merge!(:field_id => id)
+      end
+
+      atrs
+    end
+
+    def self.config
+      super.merge({ :ac_obj_type => 'field', :ac_method_prefix => 'custom_field' })
+    end
+
+    # Public: Find a folder on the current Connect instance.
+    #
+    # name, obj_type, service - see #attrs for description
+    #
+    # Returns a new AdobeConnect::AclField object.
+    def self.find_or_create(name, obj_type, service = AdobeConnect::Service.new)
+      response = service.custom_fields(:filter_name => name)
+      c_flds = response.at_xpath('//custom-fields').children
+
+      if c_flds.count.zero?
+        #Create
+        fld = self.new({ :name => name, :obj_type => obj_type }, service)
+        fld.save
+      else
+        fld = load_from_xml(c_flds[0])
+      end
+
+      fld
+    end
+
+    private
+    def self.load_from_xml(ac_field, service)
+      self.new({
+          :id => ac_field.attr('field-id'),
+          :name => ac_field.at_xpath('//name').text,
+          :obj_type => ac_field.attr('obj_type')
+        }, service)
+    end
+  end
+end

data/lib/adobe_connect/base.rb

@@ -0,0 +1,128 @@
+module AdobeConnect
+
+  # Provides base interaction with Adobe Connect for a variety of AC Objects
+  class Base
+    # Public: SCO-ID from the Adobe Connect instance.
+    attr_reader :id
+
+    attr_reader :service, :errors
+
+    def initialize(obj_options, service = Service.new)
+      set_attrs(obj_options)
+      @service  = service
+      @errors   = []
+    end
+
+    def attrs
+      {}
+    end
+
+    # Public: Delete this object form Adobe Connect.
+    #
+    # Returns a boolean.
+    def delete
+      response = service.send(:"#{delete_method_prefix}_delete", {:"#{ac_obj_type}_id" => self.id})
+      response.at_xpath('//status').attr('code') == 'ok'
+    end
+
+    # Public: Save this object to the Adobe Connect instance.
+    #
+    # Returns a boolean.
+    def save
+      response = service.send(:"#{method_prefix}_update", self.attrs)
+
+      if response.at_xpath('//status').attr('code') == 'ok'
+        # Load the ID if this was a creation
+        self.id = response.at_xpath("//#{ac_obj_node_name}").attr("#{ac_obj_type}-id") if self.id.nil?
+        true
+      else
+        save_errors(response)
+        false
+      end
+    end
+
+    # Public: Update attributes of the loaded object and save.
+    #
+    # atrs - Generic options (see #initialize for required
+    #   attributes).
+    #
+    # Returns a boolean.
+    def update_attributes(atrs)
+      set_attrs(atrs)
+      self.save
+    end
+
+    # Public: Update permissions on the loaded object for the given principal_id.
+    #
+    # principal_id - id of user
+    # permission_id - AdobeConnect permission value
+    #
+    # Returns a boolean.
+    def permissions_update(principal_id, permission_id)
+      response = service.permissions_update(
+        acl_id: self.id,
+        principal_id: principal_id,
+        permission_id: permission_id
+      )
+
+      response.at_xpath('//status').attr('code') == 'ok'
+    end
+
+    # Public: Create a Connect obj from the given app obj.
+    #
+    # obj_options - Generic options (see #initialize for required
+    #   attributes).
+    #
+    # Returns an instance of this class, with an attempted save.
+    def self.create(obj_options)
+      obj = self.new(obj_options)
+      obj.save
+
+      obj
+    end
+
+    def self.config
+      { :ac_obj_type => 'principal', :delete_method_is_plural => true }
+    end
+
+    private
+    attr_writer :id
+
+    def ac_obj_node_name
+      self.class.config[:ac_obj_node_name] || ac_obj_type
+    end
+
+    def ac_obj_type
+      self.class.config[:ac_obj_type]
+    end
+
+    def delete_method_prefix
+      prefix = method_prefix
+      prefix = prefix.pluralize if self.class.config[:delete_method_is_plural]
+      prefix
+    end
+
+    def method_prefix
+      self.class.config[:ac_method_prefix] || ac_obj_type
+    end
+
+    # Internal: Store request errors in @errors.
+    #
+    # response - An AdobeConnect::Response.
+    #
+    # Returns nothing.
+    def save_errors(response)
+      @errors = response.xpath('//invalid').map(&:attributes)
+    end
+
+    # Internal: Update attributes from an attribute hash
+    #
+    # atrs - A hash of keys that match attributes of this object and
+    #   corresponding values for those attributes.
+    #
+    # Returns nothing.
+    def set_attrs(atrs)
+      atrs.each { |key, value| send(:"#{key}=", value) }
+    end
+  end
+end

data/lib/adobe_connect/group.rb

@@ -0,0 +1,91 @@
+module AdobeConnect
+
+  # Public: Represents a Group in a Connect environment.
+  class Group < Base
+    attr_accessor :description, :name, :id
+
+    #
+    # group_options - A hash with the following keys:
+    #                name        - The group’s name.
+    #                description - The group's description
+    #
+
+    def attrs
+      atrs = { :has_children => 1, :name => name, :description => description }
+
+      if !self.id.nil?
+        atrs.merge!(:principal_id => self.id)
+      else
+        atrs.merge!(
+          :type => 'group'
+        )
+      end
+      atrs
+    end
+
+    # Public: Add a User as a member of this group.
+    #
+    # user - AdobeConnect::User instance
+    #
+    # Returns a boolean of success.
+    def add_member(user)
+      update_membership(user, true)
+    end
+
+    # Public: Find the member of this group.
+    #
+    # email - User's email address
+    #
+    # Returns a boolean.
+    def is_member?(email)
+      return false if self.id.nil?
+
+      response = service.principal_list(:group_id => self.id,
+        :filter_email => email,
+        :filter_is_member => true)
+
+      !response.at_xpath('//principal').nil?
+    end
+
+    # Public: Remove a User from this group.
+    #
+    # user - AdobeConnect::User instance
+    #
+    # Returns a boolean of success.
+    def remove_member(user)
+      update_membership(user, false)
+    end
+
+    # Public: Find the given group on the Connect server.
+    #
+    # name - Group's name on Connect server
+    #
+    # Returns an AdobeConnect::Group or nil.
+    def self.find_by_name(name, service = AdobeConnect::Service.new)
+      response = service.principal_list(:filter_name => name)
+
+      if principal = response.at_xpath('//principal')
+        self.load_from_xml(principal)
+      end
+    end
+
+    private
+    def update_membership(user, status)
+      response = service.group_membership_update({
+          :group_id => self.id,
+          :principal_id => user.id,
+          :is_member => status
+        })
+
+      response.at_xpath('//status').attr('code') == 'ok'
+    end
+
+    def self.load_from_xml(g)
+      self.new({
+          :name => g.at_xpath('//name').children.text,
+          :description => g.at_xpath('//description').try(:children).try(:text),
+          :id => g.attr('principal-id')
+        })
+    end
+  end
+end

data/lib/adobe_connect/meeting.rb

@@ -0,0 +1,99 @@
+module AdobeConnect
+
+  # Public: Represents a meeting in a Connect environment.
+  class Meeting < Base
+    attr_accessor :date_begin, :date_end, :description, :folder_id, :name, :url_path
+
+    #
+    # meeting_options - A hash with the following keys:
+    #                date_begin  - (optional) Datetime that meeting begins.
+    #                date_end    - (optional) Datetime that meeting ends.
+    #                description - A description of the meeting to be displayed to users.
+    #                folder_id   - (Required for creating) ID of the meeting folder
+    #                name        - Name of the meeting
+    #                url_path    - (optional) Custom url for meeting. One will be generated
+    #                              by AC if not provided
+    #
+    def attrs
+      atrs = {:type => 'meeting'}
+
+      [ :date_end, :date_begin, :description, :name, :url_path ].each do |atr|
+        atrs[atr] = send(atr)
+      end
+
+      if !self.id.nil?
+        atrs.merge!(:sco_id => self.id)
+      else
+        atrs.merge!(:folder_id => folder_id)
+      end
+
+      atrs
+    end
+
+    def add_host(principal_id)
+      permissions_update(principal_id, 'host')
+    end
+
+    def add_presenter(principal_id)
+      permissions_update(principal_id, 'mini-host')
+    end
+
+    def add_participant(principal_id)
+      permissions_update(principal_id, 'view')
+    end
+
+    def remove_user(principal_id)
+      permissions_update(principal_id, 'remove')
+    end
+
+    def self.config
+      super.merge({ :ac_obj_type => 'sco', :delete_method_is_plural => false })
+    end
+
+    def self.find_by_id(sco_id, service = AdobeConnect::Service.new)
+      response = service.sco_info(sco_id: sco_id)
+      sco_info = response.at_xpath('//sco')
+
+      if !sco_info.nil?
+        load_from_xml(sco_info, service)
+      else
+        nil
+      end
+    end
+
+    def self.find_by_url_path(url_path, service = AdobeConnect::Service.new)
+      response = service.sco_by_url(:url_path => url_path)
+
+      ac_meeting = response.at_xpath('//sco')
+
+      if !ac_meeting.nil?
+        load_from_xml(ac_meeting, service)
+      else
+        nil
+      end
+    end
+
+    def self.find_within_folder(folder_id, params = {}, service = AdobeConnect::Service.new)
+      response = service.sco_contents( params.merge(:sco_id => folder_id, :type => 'meeting') )
+      ac_meetings = response.at_xpath('//scos')
+      meetings = ac_meetings.children.map{|m| load_from_xml(m, service) }
+    end
+
+    private
+    def self.load_from_xml(ac_meeting, service)
+      meeting = self.new({}, service)
+
+      meeting.attrs.each do |atr,v|
+        chld = ac_meeting.children.select{|c| c.name == atr.to_s.dasherize}[0]
+        if !chld.nil?
+          meeting.send(:"#{atr}=", chld.text)
+        end
+      end
+
+      meeting.folder_id = ac_meeting.attr('folder-id')
+      meeting.instance_variable_set(:@id, ac_meeting.attr('sco-id'))
+
+      meeting
+    end
+  end
+end

data/lib/adobe_connect/meeting_folder.rb

@@ -41,5 +41,17 @@ module AdobeConnect
         response.at_xpath('//url-path').text,
         service)
     end
+
+    # Public: Find the "My Meetings" folder ID of the currently logged in User
+    #
+    # service - An AdobeConnect::Service object (default: Service.new).
+    #
+    # Returns a string of the sco ID of the folder
+    def self.my_meetings_folder_id(service = AdobeConnect::Service.new)
+      response = service.sco_shortcuts({})
+      response.at_xpath('//shortcuts').children.select{|s|
+        s.attr('type') == 'my-meetings'
+      }[0].attr('sco-id')
+    end
   end
 end

data/lib/adobe_connect/param_formatter.rb

@@ -17,9 +17,15 @@ module AdobeConnect
     # Returns a query string.
     def format
       params.sort_by { |k, v| k.to_s }.inject(['']) do |array, param|
+        param[1] = format_datetime(param[1]) if param[1].respond_to?(:strftime)
         key, value = param.map { |p| ERB::Util.url_encode(p) }
         array << "#{key.dasherize}=#{value}"
       end.join('&')
     end
+
+    private
+    def format_datetime(dt)
+      dt.utc.strftime('%Y-%m-%dT%H:%M:%SZ')
+    end
   end
 end