adobe_connect 0.0.2 → 0.0.3

data/README.md

@@ -1,5 +1,7 @@
 # AdobeConnect
 
+[![Build Status](https://secure.travis-ci.org/zachpendleton/adobe_connect.png)](http://travis-ci.org/zachpendleton/adobe_connect)
+
 This gem provides a wrapper for interacting with the Adobe Connect API that
 (hopefully) sucks less than interacting with the Adobe Connect API by itself.
 
@@ -7,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.1'
+    gem 'adobe_connect', '0.0.3'
 
 And then run:
 

data/Rakefile

@@ -1,6 +1,8 @@
 require 'bundler/gem_tasks'
 require 'rake/testtask'
 
+task :default => [:test]
+
 Rake::TestTask.new do |t|
   t.pattern = 'test/**/*_test.rb'
   t.libs.push('test')

data/adobe_connect.gemspec

@@ -22,6 +22,8 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'pry',           '>= 0.9.11.4'
   gem.add_dependency 'rake',          '~> 10.0.3'
 
-  gem.add_development_dependency 'minitest', '~> 4.6.0'
-  gem.add_development_dependency 'mocha',    '~> 0.13.2'
+  gem.add_development_dependency 'minitest',    '~> 4.6.0'
+  gem.add_development_dependency 'mocha',       '~> 0.13.2'
+  gem.add_development_dependency 'yard',        '~> 0.8.4.1'
+  gem.add_development_dependency 'yard-tomdoc', '~> 0.6.0'
 end

data/lib/adobe_connect.rb

@@ -5,7 +5,6 @@ require 'nokogiri'
 
 require 'adobe_connect/config'
 require 'adobe_connect/response'
-require 'adobe_connect/session'
 require 'adobe_connect/service'
 require 'adobe_connect/param_formatter'
 require 'adobe_connect/meeting_folder'

data/lib/adobe_connect/meeting_folder.rb

@@ -15,9 +15,9 @@ module AdobeConnect
 
     def self.find(name, service = AdobeConnect::Service.new)
       response = service.sco_search_by_field(
-        query: name,
-        filter_type: 'folder',
-        field: 'name')
+        :query       => name,
+        :filter_type => 'folder',
+        :field       => 'name')
 
       MeetingFolder.new(response.at_xpath('//sco').attr('sco-id'),
         response.at_xpath('//name').text,

data/lib/adobe_connect/service.rb

@@ -10,7 +10,7 @@ module AdobeConnect
     end
 
     def log_in
-      response = request('login', { login: username, password: password }, false)
+      response = request('login', { :login => username, :password => password }, false)
       if response.at_xpath('//status').attr('code') == 'ok'
         @session       = response.fetch('set-cookie').match(/(?<=BREEZESESSION=)[^;]+/)[0]
         @authenticated = true

data/lib/adobe_connect/user.rb

@@ -1,26 +1,26 @@
 module AdobeConnect
   class User
-    attr_reader :id, :canvas_user, :service, :errors
+    attr_reader :id, :app_user, :service, :errors
 
-    def initialize(canvas_user, service = Service.new)
-      @canvas_user = canvas_user
-      @service     = service
-      @errors      = []
+    def initialize(app_user, service = Service.new)
+      @app_user = app_user
+      @service  = service
+      @errors   = []
     end
 
     def username
-      canvas_user.email
+      app_user.email
     end
 
     def password
-      Digest::MD5.hexdigest(@canvas_user.uuid)[0..9]
+      Digest::MD5.hexdigest(@app_user.uuid)[0..9]
     end
 
     def save
-      response = service.principal_update(first_name: canvas_user.first_name,
-        last_name: canvas_user.last_name, login: canvas_user.email,
-        password: password, type: 'user', has_children: 0,
-        email: canvas_user.email)
+      response = service.principal_update(:first_name => app_user.first_name,
+        :last_name => app_user.last_name, :login => app_user.email,
+        :password => password, :type => 'user', :has_children => 0,
+        :email => app_user.email)
 
       if response.at_xpath('//status').attr('code') == 'ok'
         true
@@ -30,16 +30,16 @@ module AdobeConnect
       end
     end
 
-    def self.create(canvas_user)
-      user = AdobeConnect::User.new(canvas_user)
+    def self.create(app_user)
+      user = AdobeConnect::User.new(app_user)
       user.save
 
       user
     end
 
-    def self.find(canvas_user)
-      user     = AdobeConnect::User.new(canvas_user)
-      response = user.service.principal_list(filter_login: user.username)
+    def self.find(app_user)
+      user     = AdobeConnect::User.new(app_user)
+      response = user.service.principal_list(:filter_login => user.username)
 
       if principal = response.at_xpath('//principal')
         user.instance_variable_set(:@id, principal.attr('principal-id'))

data/lib/adobe_connect/version.rb

@@ -1,3 +1,3 @@
 module AdobeConnect
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/test/fixtures/folder_contents.xml

@@ -4,70 +4,70 @@
   <scos>
     <sco sco-id="26013" source-sco-id="" folder-id="25915" type="meeting" icon="meeting" display-seq="0" duration="" is-folder="0">
       <name>BIG-001: Course Conference [12]</name>
-      <url-path>/canvas-meeting-12/</url-path>
+      <url-path>/my-meeting-12/</url-path>
       <date-begin>2013-01-18T10:37:21.000-07:00</date-begin>
       <date-created>2013-01-18T10:37:29.133-07:00</date-created>
       <date-modified>2013-01-18T10:46:37.187-07:00</date-modified>
     </sco>
     <sco sco-id="26102" source-sco-id="" folder-id="25915" type="meeting" icon="meeting" display-seq="0" duration="" is-folder="0">
       <name>BIOL 1550 E01: Course Conference [45]</name>
-      <url-path>/canvas-meeting-45/</url-path>
+      <url-path>/my-meeting-45/</url-path>
       <date-begin>2013-01-25T14:15:19.000-07:00</date-begin>
       <date-created>2013-01-25T14:15:26.890-07:00</date-created>
       <date-modified>2013-01-25T14:28:36.350-07:00</date-modified>
     </sco>
     <sco sco-id="25917" source-sco-id="" folder-id="25915" type="meeting" icon="meeting" display-seq="0" duration="" is-folder="0">
       <name>Discussion Copy 1: Adobe connect conference [18847]</name>
-      <url-path>/canvas-meeting-18847/</url-path>
+      <url-path>/my-meeting-18847/</url-path>
       <date-begin>2013-01-15T12:22:03.000-07:00</date-begin>
       <date-created>2013-01-15T12:22:06.977-07:00</date-created>
       <date-modified>2013-01-15T12:31:13.053-07:00</date-modified>
     </sco>
     <sco sco-id="26109" source-sco-id="" folder-id="25915" type="meeting" icon="meeting" display-seq="0" duration="" is-folder="0">
       <name>ENGL 2600 E01: Course Conference [46]</name>
-      <url-path>/canvas-meeting-46/</url-path>
+      <url-path>/my-meeting-46/</url-path>
       <date-begin>2013-01-25T14:15:39.000-07:00</date-begin>
       <date-created>2013-01-25T14:15:47.287-07:00</date-created>
       <date-modified>2013-01-25T14:27:59.050-07:00</date-modified>
     </sco>
     <sco sco-id="26156" source-sco-id="" folder-id="25915" type="meeting" icon="meeting" display-seq="0" duration="" is-folder="0">
       <name>ENGL-2100: Course Conference [27]</name>
-      <url-path>/canvas-meeting-27/</url-path>
+      <url-path>/my-meeting-27/</url-path>
       <date-begin>2013-01-31T15:04:53.000-07:00</date-begin>
       <date-created>2013-01-31T15:05:00.680-07:00</date-created>
       <date-modified>2013-01-31T15:14:11.273-07:00</date-modified>
     </sco>
     <sco sco-id="25924" source-sco-id="" folder-id="25915" type="meeting" icon="meeting" display-seq="0" duration="" is-folder="0">
       <name>IE9 1/26: Course Conference [18848]</name>
-      <url-path>/canvas-meeting-18848/</url-path>
+      <url-path>/my-meeting-18848/</url-path>
       <date-begin>2013-01-15T12:52:08.000-07:00</date-begin>
       <date-created>2013-01-15T12:52:12.113-07:00</date-created>
       <date-modified>2013-01-15T12:52:12.113-07:00</date-modified>
     </sco>
     <sco sco-id="25930" source-sco-id="" folder-id="25915" type="meeting" icon="meeting" display-seq="0" duration="" is-folder="0">
       <name>IE9 1/26: Group Conference [18849]</name>
-      <url-path>/canvas-meeting-18849/</url-path>
+      <url-path>/my-meeting-18849/</url-path>
       <date-begin>2013-01-15T14:04:35.000-07:00</date-begin>
       <date-created>2013-01-15T14:04:39.303-07:00</date-created>
       <date-modified>2013-01-15T14:16:56.483-07:00</date-modified>
     </sco>
     <sco sco-id="26096" source-sco-id="" folder-id="25915" type="meeting" icon="meeting" display-seq="0" duration="" is-folder="0">
       <name>LTIDemo: Course Conference [44]</name>
-      <url-path>/canvas-meeting-44/</url-path>
+      <url-path>/my-meeting-44/</url-path>
       <date-begin>2013-01-25T14:15:03.000-07:00</date-begin>
       <date-created>2013-01-25T14:15:11.373-07:00</date-created>
       <date-modified>2013-01-25T14:26:22.120-07:00</date-modified>
     </sco>
     <sco sco-id="26122" source-sco-id="" folder-id="25915" type="meeting" icon="meeting" display-seq="0" duration="" is-folder="0">
       <name>LTIDemo: Course Conference [47]</name>
-      <url-path>/canvas-meeting-47/</url-path>
+      <url-path>/my-meeting-47/</url-path>
       <date-begin>2013-01-25T14:17:59.000-07:00</date-begin>
       <date-created>2013-01-25T14:18:06.710-07:00</date-created>
       <date-modified>2013-01-25T14:29:11.300-07:00</date-modified>
     </sco>
     <sco sco-id="26087" source-sco-id="" folder-id="25915" type="meeting" icon="meeting" display-seq="0" duration="" is-folder="0">
       <name>STC: Course Conference [19114]</name>
-      <url-path>/canvas-meeting-19114/</url-path>
+      <url-path>/my-meeting-19114/</url-path>
       <date-begin>2013-01-25T10:16:36.000-07:00</date-begin>
       <date-created>2013-01-25T10:16:44.260-07:00</date-created>
       <date-modified>2013-01-25T10:38:59.190-07:00</date-modified>

data/test/fixtures/folder_success.xml

@@ -3,7 +3,7 @@
   <status code="ok"/>
   <sco-search-by-field-info>
     <sco sco-id="25915" account-id="7" folder-id="11004" type="folder" icon="folder" max-retries="" lang="en" display-seq="0" source-sco-id="" version="0" parent-type="-2" tree-type="6" grand-parent="7">
-      <name>canvas_meetings</name>
+      <name>my_meetings</name>
       <url-path>/meeting-path/</url-path>
       <date-created>2013-01-15T12:21:42.243-07:00</date-created>
       <date-modified>2013-01-15T12:21:42.243-07:00</date-modified>

data/test/lib/adobe_connect/meeting_folder_test.rb

@@ -32,26 +32,26 @@ class AdobeConnectMeetingFolderTest < MiniTest::Unit::TestCase
   end
 
   def test_find_returns_a_new_folder
-    response = mock(status: 200)
+    response = mock(:status => 200)
     response.expects(:body).returns(FOLDER_SUCCESS)
     ac_response = AdobeConnect::Response.new(response)
 
     AdobeConnect::Service.any_instance.
       expects(:request).
-      with('sco-search-by-field', query: 'canvas_meetings',
-        filter_type: 'folder', field: 'name').
+      with('sco-search-by-field', :query => 'my_meetings',
+        :filter_type => 'folder', :field => 'name').
       returns(ac_response)
 
-    folder = AdobeConnect::MeetingFolder.find('canvas_meetings')
+    folder = AdobeConnect::MeetingFolder.find('my_meetings')
 
     assert_instance_of        AdobeConnect::MeetingFolder, folder
-    assert_equal folder.name, 'canvas_meetings'
+    assert_equal folder.name, 'my_meetings'
     assert_equal folder.id,   '25915'
     assert_equal folder.url,  '/meeting-path/'
   end
 
   def test_contents_returns_folder_contents
-    response = mock(status: 200)
+    response = mock(:status => 200)
     response.expects(:body).returns(FOLDER_CONTENTS)
     ac_response = AdobeConnect::Response.new(response)
     @folder.service.expects(:sco_contents).returns(ac_response)

data/test/lib/adobe_connect/param_formatter_test.rb

@@ -2,7 +2,7 @@ require File.expand_path('../../test_helper.rb', File.dirname(__FILE__))
 
 class AdobeConnectParamFormatterTest < MiniTest::Unit::TestCase
   def setup
-    params        = { a: 1, b: 'param value', 'dashed_value' => 3 }
+    params        = { :a => 1, :b => 'param value', 'dashed_value' => 3 }
     @formatter    = AdobeConnect::ParamFormatter.new(params)
     @query_string = @formatter.format
   end

data/test/lib/adobe_connect/response_test.rb

@@ -11,7 +11,7 @@ class AdobeConnectResponseTest < MiniTest::Unit::TestCase
   END
 
   def setup
-    response  = stub(status: 200, headers: TEST_HEADERS, body: TEST_BODY)
+    response  = stub(:status => 200, :headers => TEST_HEADERS, :body => TEST_BODY)
     @response = AdobeConnect::Response.new(response)
   end
 

data/test/lib/adobe_connect/service_test.rb

@@ -5,8 +5,8 @@ class AdobeConnectServiceTest < MiniTest::Unit::TestCase
   LOGIN_FAIL    = File.read('test/fixtures/log_in_fail.xml')
 
   def setup
-    @service = AdobeConnect::Service.new(username: 'name', password: 'password',
-      domain: 'http://example.com')
+    @service = AdobeConnect::Service.new(:username => 'name', :password => 'password',
+      :domain => 'http://example.com')
   end
 
   def test_initialize_takes_a_config_hash
@@ -23,7 +23,7 @@ class AdobeConnectServiceTest < MiniTest::Unit::TestCase
   end
 
   def test_log_in_authenticates
-    response = mock(status: 200)
+    response = mock(:status => 200)
     response.expects(:fetch).returns('BREEZESESSION=12345')
     response.expects(:body).returns(LOGIN_SUCCESS)
     ac_response = AdobeConnect::Response.new(response)
@@ -34,7 +34,7 @@ class AdobeConnectServiceTest < MiniTest::Unit::TestCase
   end
 
   def test_log_in_creates_a_session
-    response = mock(status: 200)
+    response = mock(:status => 200)
     response.expects(:fetch).with('set-cookie').returns('BREEZESESSION=12345;HttpOnly;path=/')
     response.expects(:body).returns(LOGIN_SUCCESS)
     ac_response = AdobeConnect::Response.new(response)
@@ -47,7 +47,7 @@ class AdobeConnectServiceTest < MiniTest::Unit::TestCase
   end
 
   def test_log_in_returns_false_on_failure
-    response = mock(status: 200)
+    response = mock(:status => 200)
     response.expects(:body).returns(LOGIN_FAIL)
     ac_response = AdobeConnect::Response.new(response)
     @service.client.stubs(:get).returns(ac_response)
@@ -56,7 +56,7 @@ class AdobeConnectServiceTest < MiniTest::Unit::TestCase
   end
 
   def test_unknown_methods_are_proxied_to_the_connect_service
-    @service.expects(:request).with('method-name', a: 1)
-    @service.method_name(a: 1)
+    @service.expects(:request).with('method-name', :a => 1)
+    @service.method_name(:a => 1)
   end
 end

data/test/lib/adobe_connect/user_test.rb

@@ -14,17 +14,17 @@ class AdobeConnectUserTest < MiniTest::Unit::TestCase
   FIND_ERROR   = File.read('test/fixtures/user_find_error.xml')
 
   def setup
-    @canvas_user  = stub(first_name: 'Don', last_name: 'Draper',
-      email: 'test@example.com', uuid: '12345')
-    @connect_user = AdobeConnect::User.new(@canvas_user)
+    @app_user  = stub(:first_name => 'Don', :last_name => 'Draper',
+      :email => 'test@example.com', :uuid => '12345')
+    @connect_user = AdobeConnect::User.new(@app_user)
   end
 
   def test_initialize_should_take_a_user
-    assert_equal @connect_user.canvas_user, @canvas_user
+    assert_equal @connect_user.app_user, @app_user
   end
 
-  def test_username_should_be_canvas_user_email
-    assert_equal @connect_user.username, @canvas_user.email
+  def test_username_should_be_app_user_email
+    assert_equal @connect_user.username, @app_user.email
   end
 
   def test_password_should_create_a_unique_password
@@ -36,22 +36,22 @@ class AdobeConnectUserTest < MiniTest::Unit::TestCase
   end
 
   def test_save_persists_user_to_connect_server
-    response = mock(status: 200)
+    response = mock(:status => 200)
     response.expects(:body).returns(SAVE_SUCCESS)
     ac_response = AdobeConnect::Response.new(response)
 
     @connect_user.service.expects(:principal_update).
-      with(first_name: @canvas_user.first_name,
-        last_name: @canvas_user.last_name, login: @connect_user.username,
-        password: @connect_user.password, type: 'user', has_children: 0,
-        email: @canvas_user.email).
+      with(:first_name => @app_user.first_name,
+        :last_name => @app_user.last_name, :login => @connect_user.username,
+        :password => @connect_user.password, :type => 'user', :has_children => 0,
+        :email => @app_user.email).
       returns(ac_response)
 
     assert @connect_user.save
   end
 
   def test_save_returns_false_on_failure
-    response = mock(status: 200)
+    response = mock(:status => 200)
     response.expects(:body).returns(SAVE_ERROR)
     ac_response = AdobeConnect::Response.new(response)
 
@@ -60,7 +60,7 @@ class AdobeConnectUserTest < MiniTest::Unit::TestCase
   end
 
   def test_save_stores_errors_on_failure
-    response = mock(status: 200)
+    response = mock(:status => 200)
     response.expects(:body).returns(SAVE_ERROR)
     ac_response = AdobeConnect::Response.new(response)
 
@@ -72,32 +72,32 @@ class AdobeConnectUserTest < MiniTest::Unit::TestCase
   def test_create_should_return_a_new_user
     AdobeConnect::User.any_instance.expects(:save).returns(true)
 
-    connect_user = AdobeConnect::User.create(@canvas_user)
+    connect_user = AdobeConnect::User.create(@app_user)
     assert_instance_of AdobeConnect::User, connect_user
   end
 
   def test_find_should_return_an_existing_user
-    response = mock(status: 200)
+    response = mock(:status => 200)
     response.expects(:body).returns(FIND_SUCCESS)
     ac_response = AdobeConnect::Response.new(response)
     AdobeConnect::Service.any_instance.expects(:principal_list).
-      with(filter_login: 'test@example.com').
+      with(:filter_login => 'test@example.com').
       returns(ac_response)
 
-    canvas_user  = stub(email: 'test@example.com')
-    connect_user = AdobeConnect::User.find(canvas_user)
+    app_user  = stub(:email => 'test@example.com')
+    connect_user = AdobeConnect::User.find(app_user)
     assert_instance_of AdobeConnect::User, connect_user
   end
 
   def test_find_should_set_user_attributes
-    response = mock(status: 200)
+    response = mock(:status => 200)
     response.expects(:body).returns(FIND_ERROR)
     ac_response = AdobeConnect::Response.new(response)
     AdobeConnect::Service.any_instance.expects(:principal_list).
       returns(ac_response)
 
-    canvas_user  = stub(email: 'notfound@example.com')
-    connect_user = AdobeConnect::User.find(canvas_user)
+    app_user  = stub(:email => 'notfound@example.com')
+    connect_user = AdobeConnect::User.find(app_user)
     assert_nil connect_user
   end
 end

data/travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.3

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: adobe_connect
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-10 00:00:00.000000000 Z
+date: 2013-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -107,6 +107,38 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.13.2
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.4.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.4.1
+- !ruby/object:Gem::Dependency
+  name: yard-tomdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
 description: An API wrapper for interacting with Adobe Connect services.
 email:
 - zachpendleton@gmail.com
@@ -128,7 +160,6 @@ files:
 - lib/adobe_connect/param_formatter.rb
 - lib/adobe_connect/response.rb
 - lib/adobe_connect/service.rb
-- lib/adobe_connect/session.rb
 - lib/adobe_connect/user.rb
 - lib/adobe_connect/version.rb
 - test/fixtures/folder_contents.xml
@@ -146,6 +177,7 @@ files:
 - test/lib/adobe_connect/service_test.rb
 - test/lib/adobe_connect/user_test.rb
 - test/test_helper.rb
+- travis.yml
 homepage: https://github.com/zachpendleton/adobe_connect
 licenses: []
 post_install_message: 

data/lib/adobe_connect/session.rb

@@ -1,19 +0,0 @@
-module AdobeConnect
-  class Session
-    attr_reader :service, :user
-
-    def initialize(user, service = Service.new)
-      @user    = user
-      @service = service
-    end
-
-    def key
-      unless key
-        service.log_in
-        @key = service.session
-      end
-
-      key
-    end
-  end
-end