adobe_connect 0.0.6 → 0.0.7

data/.yardopts

@@ -0,0 +1,6 @@
+--title "Adobe Connect"
+--readme README.md
+--protected
+--private
+--plugin yard-tomdoc
+lib

data/README.md

@@ -9,7 +9,7 @@ This gem provides a wrapper for interacting with the Adobe Connect API that
 
 Add this line to your application's Gemfile:
 
-    gem 'adobe_connect', '0.0.5'
+    gem 'adobe_connect', '0.0.7'
 
 And then run:
 

data/adobe_connect.gemspec

@@ -17,13 +17,14 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ['lib']
 
-  gem.add_dependency 'activesupport', '>= 2.3.16'
-  gem.add_dependency 'nokogiri',      '~> 1.5.6'
+  gem.add_dependency 'activesupport', '>= 2.3.17'
+  gem.add_dependency 'nokogiri',      '~> 1.5.5'
   gem.add_dependency 'pry',           '>= 0.9.11.4'
   gem.add_dependency 'rake',          '>= 0.9.2'
 
   gem.add_development_dependency 'minitest',    '~> 4.6.0'
   gem.add_development_dependency 'mocha',       '~> 0.13.2'
+  gem.add_development_dependency 'redcarpet'
   gem.add_development_dependency 'yard',        '~> 0.8.4.1'
   gem.add_development_dependency 'yard-tomdoc', '~> 0.6.0'
 end

data/lib/adobe_connect.rb

@@ -10,4 +10,5 @@ require 'adobe_connect/param_formatter'
 require 'adobe_connect/meeting_folder'
 require 'adobe_connect/user'
 
+# Public: Namespace for AdobeConnect classes/modules.
 module AdobeConnect; end

data/lib/adobe_connect/config.rb

@@ -1,25 +1,68 @@
 module AdobeConnect
+
+	# Public: Manage configuration for AdobeConnect::Service objects, like
+	# username/password/domain.
   module Config
 
     @settings = Hash.new
 
     class << self
+			# Public: Merge the given settings hash into the current settings.
+			#
+			# settings - A hash of setting options.
+			#
+			# Returns nothing.
       def merge(settings)
         @settings.merge(settings)
       end
 
+			# Public: Declare default Connect settings using a block.
+			#
+			# &block - A block with configuration options.
+			#
+			# Examples
+			#
+			# 	AdobeConnect::Config.declare do
+			# 		username 'user@example.com'
+			# 		password 'password'
+			# 		domain   'http://connect.example.com'
+			# 	end
+			#
+			# Returns nothing.
       def declare(&block)
         instance_eval(&block)
       end
 
+			# Public: Fetch a single key value from the current settings.
+			#
+			# key - The key to fetch.
+			#
+			# Examples
+			#
+			# 	AdobeConnect::Config[:username] #=> 'user@example.com'
+			#
+			# Returns the value of the key (usually a string).
       def [](key)
         @settings[key]
       end
 
+			# Public: Set a single key's value.
+			#
+			# key - The name of the key to set.
+			# value - The value to set the key to.
+			#
+			# Examples
+			#
+			# 	AdobeConnect::Config[:username] = 'user@example.com'
+			#
+			# Returns nothing.
       def []=(key, value)
         @settings[key] = value
       end
 
+			# Public: Getter for the internal settings hash.
+			#
+			# Returns a hash.
       def settings; @settings; end
 
       private

data/lib/adobe_connect/meeting_folder.rb

@@ -1,7 +1,15 @@
 module AdobeConnect
+
+  # Public: Represents a folder object inside of Connect.
   class MeetingFolder
     attr_reader :name, :id, :service, :url
 
+    # Public: Create a new AdobeConnect::MeetingFolder.
+    #
+    # id      - The SCO-ID of the folder object.
+    # name    - The name of the folder object.
+    # url     - The Connect URL of the object.
+    # service - An AdobeConnect::Service object (default: Service.new).
     def initialize(id, name, url, service = AdobeConnect::Service.new)
       @name    = name
       @id      = id
@@ -9,10 +17,19 @@ module AdobeConnect
       @url     = url
     end
 
+    # Public: Fetch the contents of this folder.
+    #
+    # Returns a Nokogiri object.
     def contents
       service.sco_contents(:sco_id => id)
     end
 
+    # Public: Find a folder on the current Connect instance.
+    #
+    # name - The name of the folder to find.
+    # service - An AdobeConnect::Service object (default: Service.new).
+    #
+    # Returns a new AdobeConnect::MeetingFolder object.
     def self.find(name, service = AdobeConnect::Service.new)
       response = service.sco_search_by_field(
         :query       => name,

data/lib/adobe_connect/param_formatter.rb

@@ -1,11 +1,20 @@
 module AdobeConnect
+
+  # Public: Responsible for translating params hashes into query strings 
   class ParamFormatter
     attr_reader :params
 
+    # Public: Create a new AdobeConnect::ParamFormatter.
+    #
+    # params - A hash of params to format.
     def initialize(params)
       @params = params
     end
 
+    # Public: Translate a hash of params into a query string. Dasherize any
+    # underscored values, and escape URL unfriendly values.
+    #
+    # Returns a query string.
     def format
       params.sort_by { |k, v| k.to_s }.inject(['']) do |array, param|
         key, value = param.map { |p| ERB::Util.url_encode(p) }

data/lib/adobe_connect/response.rb

@@ -1,21 +1,41 @@
 module AdobeConnect
+
+  # Public: A response from the Connect API.
   class Response
     attr_reader :status, :body
 
+    # Public: Create a new AdobeConnect::Response.
+    #
+    # response - A Net::HTTP response.
     def initialize(response)
       @response = response
       @status   = response.code.to_i
       @body     = Nokogiri::XML(response.body)
     end
 
+    # Public: Fetch the given header's value.
+    #
+    # header - The string name of the header to fetch.
+    #
+    # Returns a header value as a string.
     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

data/lib/adobe_connect/service.rb

@@ -1,7 +1,16 @@
 module AdobeConnect
+
+  # Public: Manages calls to the Connect API.
   class Service
     attr_reader :username, :domain, :session
 
+    # Public: Create a new AdobeConnect::Service.
+    #
+    # options - An AdobeConnect::Config object or a hash with the keys:
+    #           :username - An Adobe Connect username.
+    #           :password - The Connect user's password.
+    #           :domain   - The domain for the Connect instance (with protocol
+    #                       prepended).
     def initialize(options = AdobeConnect::Config)
       @username      = options[:username]
       @password      = options[:password]
@@ -9,6 +18,9 @@ module AdobeConnect
       @authenticated = false
     end
 
+    # Public: Authenticate against the currently configured Connect service.
+    #
+    # Returns a boolean.
     def log_in
       response = request('login', { :login => username, :password => password }, false)
       if response.at_xpath('//status').attr('code') == 'ok'
@@ -20,10 +32,16 @@ module AdobeConnect
       end
     end
 
+    # Public: Get the current authentication status.
+    #
+    # Returns a boolean.
     def authenticated?
       @authenticated
     end
 
+    # Public: Get the HTTP client used to make requests.
+    #
+    # Returns a Net::HTTP instance.
     def client
       if @client.nil?
         @client         = Net::HTTP.new(domain.host, domain.port)
@@ -33,6 +51,17 @@ module AdobeConnect
       @client
     end
 
+    # Public: Forward any missing methods to the Connect instance.
+    #
+    # method - The name of the method called.
+    # *args  - An array of arguments passed to the method.
+    #
+    # Examples
+    #
+    #   service = AdobeConnect::Service.new
+    #   service.sco_by_url(url_path: '/example/') #=> calls service.request.
+    #
+    # Returns an AdobeConnect::Response.
     def method_missing(method, *args)
       action = method.to_s.dasherize
       params = args.first
@@ -43,6 +72,13 @@ module AdobeConnect
     private
     attr_reader :password
 
+    # Public: Execute a call against the Adobe Connect instance.
+    #
+    # action      - The name of the API action to call.
+    # params      - A hash of params to pass in the request.
+    # use_session - If true, require an active session (default: true).
+    #
+    # Returns an AdobeConnect::Response.
     def request(action, params, use_session = true)
       if use_session
         log_in unless authenticated?

data/lib/adobe_connect/user.rb

@@ -1,21 +1,47 @@
 module AdobeConnect
+
+  # Public: Represents a user in a Connect environment.
   class User
-    attr_reader :id, :app_user, :service, :errors
+    # Public: SCO-ID from the Adobe Connect instance.
+    attr_reader :id
+
+    # Public: Generic user object.
+    attr_reader :app_user
+
+    attr_reader :service, :errors
 
+    # Public: Create a new AdobeConnect User.
+    #
+    # app_user - A user object with the following methods:
+    #            first_name - User's first name.
+    #            last_name  - User's last name.
+    #            email      - The email address for the user.
+    #            uuid       - A unique identifier for this user (used to
+    #                          generate a password).
+    # service - An AdobeConnect::Service object (default: Service.new)
     def initialize(app_user, service = Service.new)
       @app_user = app_user
       @service  = service
       @errors   = []
     end
 
+    # Public: Getter for the Connect user's username.
+    #
+    # Returns an email string.
     def username
       app_user.email
     end
 
+    # Public: Generate a password for this connect user.
+    #
+    # Returns a password string.
     def password
       Digest::MD5.hexdigest(@app_user.uuid)[0..9]
     end
 
+    # Public: Save this user to the Adobe Connect instance.
+    #
+    # Returns a boolean.
     def save
       response = service.principal_update(:first_name => app_user.first_name,
         :last_name => app_user.last_name, :login => app_user.email,
@@ -30,6 +56,12 @@ module AdobeConnect
       end
     end
 
+    # Public: Create a Connect user from the given app user.
+    #
+    # app_user - A generic user object (see #initialize for required
+    #   attributes).
+    #
+    # Returns an AdobeConnect::User.
     def self.create(app_user)
       user = AdobeConnect::User.new(app_user)
       user.save
@@ -37,6 +69,12 @@ module AdobeConnect
       user
     end
 
+    # Public: Find the given app user on the Connect server.
+    #
+    # app_user - A generic user object (see #initialize for required
+    #   attributes).
+    #
+    # Returns an AdobeConnect::User or nil.
     def self.find(app_user)
       user     = AdobeConnect::User.new(app_user)
       response = user.service.principal_list(:filter_login => user.username)
@@ -48,6 +86,11 @@ module AdobeConnect
     end
 
     private
+    # Internal: Store request errors in @errors.
+    #
+    # response - An AdobeConnect::Response.
+    #
+    # Returns nothing.
     def save_errors(response)
       @errors = response.xpath('//invalid').map(&:attributes)
     end

data/lib/adobe_connect/version.rb

@@ -1,3 +1,4 @@
 module AdobeConnect
-  VERSION = '0.0.6'
+  # Public: Current Gem version.
+  VERSION = '0.0.7'
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: adobe_connect
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: 
   segments: 
   - 0
   - 0
-  - 6
-  version: 0.0.6
+  - 7
+  version: 0.0.7
 platform: ruby
 authors: 
 - Zach Pendleton
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-02-13 00:00:00 Z
+date: 2013-02-14 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activesupport
@@ -25,12 +25,12 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 35
+        hash: 33
         segments: 
         - 2
         - 3
-        - 16
-        version: 2.3.16
+        - 17
+        version: 2.3.17
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -41,12 +41,12 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 15
+        hash: 9
         segments: 
         - 1
         - 5
-        - 6
-        version: 1.5.6
+        - 5
+        version: 1.5.5
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
@@ -115,9 +115,23 @@ dependencies:
   type: :development
   version_requirements: *id006
 - !ruby/object:Gem::Dependency 
-  name: yard
+  name: redcarpet
   prerelease: false
   requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -130,11 +144,11 @@ dependencies:
         - 1
         version: 0.8.4.1
   type: :development
-  version_requirements: *id007
+  version_requirements: *id008
 - !ruby/object:Gem::Dependency 
   name: yard-tomdoc
   prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -146,7 +160,7 @@ dependencies:
         - 0
         version: 0.6.0
   type: :development
-  version_requirements: *id008
+  version_requirements: *id009
 description: An API wrapper for interacting with Adobe Connect services.
 email: 
 - zachpendleton@gmail.com
@@ -159,6 +173,7 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - .travis.yml
+- .yardopts
 - Gemfile
 - LICENSE.txt
 - README.md