adobe_connect 0.0.8 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bc223a736c0e1ffd1752dabb467d5bac287c6bff
+  data.tar.gz: d97e1dc9f21b30ff133c97f50ea8afecb13d9e81
+SHA512:
+  metadata.gz: b4c3da73e805853355f007365e74336080d4ed46122d8c6884b3563222cbf8e21550c46aabd1d644d04a1ab2f8475eb561825aafe45272957f511e7f885118b8
+  data.tar.gz: d476b8460774e4ac7546dce81cec16fea8c5c19776af0c433962d60ac9e1d4c123369e0abedd03d88e41fe0b5805fea86e0b72f63caa84fa024245fcc17a0363

data/.gitignore

@@ -8,13 +8,14 @@
 Gemfile.lock
 InstalledFiles
 _yardoc
-coverage
+coverage/
 doc/
 lib/bundler/man
-pkg
-rdoc
+pkg/
+rdoc/
 spec/reports
 test/tmp
 test/version_tmp
-tmp
+tmp/
+vendor/
 .ruby-version

data/.travis.yml

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

data/README.md

@@ -2,14 +2,24 @@
 
 [![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.
+AdobeConnect is a Ruby Gem that provides a wrapper for interacting with the
+Adobe Connect API that (hopefully) sucks less than dealing with the Adobe
+Connect API itself.
+
+It provides methods that correspond to each of the Connect API calls, so you
+can do awesome stuff like:
+
+```ruby
+connect = AdobeConnect::Service.new
+connect.log_in
+connect.principal_list #=> returns a list of users
+```
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'adobe_connect', '0.0.8'
+    gem 'adobe_connect', '1.0.0'
 
 And then run:
 
@@ -22,23 +32,25 @@ Or install it yourself as:
 ## Get started
 
 You can get started by running `adobe_connect_console` in your terminal. This
-will open up a new Pry session with all of the Connect classes loaded.
+will open up a new Pry session with all of the AdobeConnect classes loaded.
 
-    # start by configuring it with a username, password, and domain.
-    AdobeConnect::Config.declare do
-      username 'test@example.com'
-      password 'password'
-      domain   'http://connect.example.com'
-    end
+```ruby
+# start by configuring it with a username, password, and domain.
+AdobeConnect::Config.declare do
+  username 'test@example.com'
+  password 'password'
+  domain   'http://connect.example.com'
+end
 
-    connect = AdobeConnect::Service.new
+connect = AdobeConnect::Service.new
 
-    # log in so you have a session
-    connect.log_in #=> true
+# log in so you have a session
+connect.log_in #=> true
 
-    # get crazy with your bad self
-    connect.principal_list(filter_login: 'test@example.com')
-    connect.sco_contents_by_url(url_path: '/whatever/')
+# get crazy with your bad self
+connect.principal_list(filter_login: 'test@example.com')
+connect.sco_contents_by_url(url_path: '/whatever/')
+```
 
 ## Details
 

data/adobe_connect.gemspec

@@ -10,6 +10,7 @@ Gem::Specification.new do |gem|
   gem.email         = ['zachpendleton@gmail.com']
   gem.description   = %q{An API wrapper for interacting with Adobe Connect services.}
   gem.summary       = %q{An API wrapper for Adobe Connect services.}
+  gem.license       = 'MIT'
   gem.homepage      = 'https://github.com/zachpendleton/adobe_connect'
 
   gem.files         = `git ls-files`.split($/)
@@ -19,11 +20,11 @@ Gem::Specification.new do |gem|
 
   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 'pry',         '>= 0.9.11.4'
   gem.add_development_dependency 'redcarpet'
   gem.add_development_dependency 'yard',        '~> 0.8.4.1'
   gem.add_development_dependency 'yard-tomdoc', '~> 0.6.0'

data/bin/adobe_connect_console

@@ -1,5 +1,16 @@
 #!/usr/bin/env ruby
 
+error_message = <<-END
+ERROR: adobe_connect_console requires pry to be installed.
+
+Run `gem install pry` and try again.
+END
+
 system <<-END
-  pry --require adobe_connect
+  if [ -z `which asdf` ]; then
+    echo '#{error_message}'
+    exit 1
+  else
+    pry --require adobe_connect
+  fi
 END

data/lib/adobe_connect/user.rb

@@ -5,48 +5,47 @@ module AdobeConnect
     # Public: SCO-ID from the Adobe Connect instance.
     attr_reader :id
 
-    # Public: Generic user object.
-    attr_reader :app_user
-
     attr_reader :service, :errors
+    attr_accessor :first_name, :last_name, :email, :username, :uuid
 
     # 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).
+    # 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.
+    #                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
+    def initialize(user_options, service = Service.new)
+      user_options.each { |key, value| send(:"#{key}=", value) }
       @service  = service
       @errors   = []
     end
 
-    # Public: Getter for the Connect user's username.
+    # Public: Getter for the Connect user's username. If no username is
+    #   given, use the email.
     #
-    # Returns an email string.
+    # Returns a username string.
     def username
-      app_user.email
+      @username || email
     end
 
     # Public: Generate a password for this connect user.
     #
     # Returns a password string.
     def password
-      Digest::MD5.hexdigest(@app_user.uuid)[0..9]
+      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 => app_user.first_name,
-        :last_name => app_user.last_name, :login => app_user.email,
+      response = service.principal_update(:first_name => first_name,
+        :last_name => last_name, :login => username,
         :password => password, :type => 'user', :has_children => 0,
-        :email => app_user.email)
+        :email => email)
 
       if response.at_xpath('//status').attr('code') == 'ok'
         self.id = response.at_xpath('//principal').attr('principal-id')
@@ -59,12 +58,12 @@ module AdobeConnect
 
     # Public: Create a Connect user from the given app user.
     #
-    # app_user - A generic user object (see #initialize for required
+    # user_options - Generic user options (see #initialize for required
     #   attributes).
     #
     # Returns an AdobeConnect::User.
-    def self.create(app_user)
-      user = AdobeConnect::User.new(app_user)
+    def self.create(user_options)
+      user = AdobeConnect::User.new(user_options)
       user.save
 
       user
@@ -72,12 +71,12 @@ module AdobeConnect
 
     # Public: Find the given app user on the Connect server.
     #
-    # app_user - A generic user object (see #initialize for required
+    # app_user - Generic user options (see #initialize for required
     #   attributes).
     #
     # Returns an AdobeConnect::User or nil.
-    def self.find(app_user)
-      user     = AdobeConnect::User.new(app_user)
+    def self.find(user_options)
+      user     = AdobeConnect::User.new(user_options)
       response = user.service.principal_list(:filter_login => user.username)
 
       if principal = response.at_xpath('//principal')

data/lib/adobe_connect/version.rb

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

data/test/lib/adobe_connect/user_test.rb

@@ -14,24 +14,31 @@ class AdobeConnectUserTest < MiniTest::Unit::TestCase
   FIND_ERROR   = File.read(File.expand_path('../../fixtures/user_find_error.xml', File.dirname(__FILE__)))
 
   def setup
-    @app_user  = stub(:first_name => 'Don', :last_name => 'Draper',
-      :email => 'test@example.com', :uuid => '12345')
-    @connect_user = AdobeConnect::User.new(@app_user)
+    @user_options = { first_name: 'Don', last_name: 'Draper',
+      email: 'test@example.com', uuid: '12345' }
+    @connect_user = AdobeConnect::User.new(@user_options)
   end
 
-  def test_initialize_should_take_a_user
-    assert_equal @connect_user.app_user, @app_user
+  def test_initialize_takes_a_user
+    @user_options.each do |key, value|
+      assert_equal @connect_user.send(key), value
+    end
   end
 
-  def test_username_should_be_app_user_email
-    assert_equal @connect_user.username, @app_user.email
+  def test_username_falls_back_to_email
+    assert_equal @connect_user.email, @connect_user.username
   end
 
-  def test_password_should_create_a_unique_password
+  def test_username_is_settable
+    @connect_user.username = 'my_username'
+    assert_equal 'my_username', @connect_user.username
+  end
+
+  def test_password_creates_a_unique_password
     assert_equal @connect_user.password, @connect_user.password
   end
 
-  def test_password_should_be_ten_characters_long
+  def test_password_is_ten_characters_long
     assert_equal @connect_user.password.length, 10
   end
 
@@ -41,10 +48,10 @@ class AdobeConnectUserTest < MiniTest::Unit::TestCase
     ac_response = AdobeConnect::Response.new(response)
 
     @connect_user.service.expects(:principal_update).
-      with(:first_name => @app_user.first_name,
-        :last_name => @app_user.last_name, :login => @connect_user.username,
+      with(:first_name => @user_options[:first_name],
+        :last_name => @user_options[:last_name], :login => @connect_user.username,
         :password => @connect_user.password, :type => 'user', :has_children => 0,
-        :email => @app_user.email).
+        :email => @connect_user.email).
       returns(ac_response)
 
     assert @connect_user.save
@@ -56,10 +63,10 @@ class AdobeConnectUserTest < MiniTest::Unit::TestCase
     ac_response = AdobeConnect::Response.new(response)
 
     @connect_user.service.expects(:principal_update).
-      with(:first_name => @app_user.first_name,
-        :last_name => @app_user.last_name, :login => @connect_user.username,
+      with(:first_name => @user_options[:first_name],
+        :last_name => @user_options[:last_name], :login => @connect_user.username,
         :password => @connect_user.password, :type => 'user', :has_children => 0,
-        :email => @app_user.email).
+        :email => @user_options[:email]).
       returns(ac_response)
 
     @connect_user.save
@@ -91,7 +98,7 @@ 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(@app_user)
+    connect_user = AdobeConnect::User.create(@user_options)
     assert_instance_of AdobeConnect::User, connect_user
   end
 
@@ -102,8 +109,7 @@ class AdobeConnectUserTest < MiniTest::Unit::TestCase
       with(:filter_login => 'test@example.com').
       returns(AdobeConnect::Response.new(response))
 
-    app_user  = stub(:email => 'test@example.com')
-    connect_user = AdobeConnect::User.find(app_user)
+    connect_user = AdobeConnect::User.find(email: 'test@example.com')
     assert_instance_of AdobeConnect::User, connect_user
   end
 
@@ -113,8 +119,7 @@ class AdobeConnectUserTest < MiniTest::Unit::TestCase
     AdobeConnect::Service.any_instance.expects(:principal_list).
       returns(AdobeConnect::Response.new(response))
 
-    app_user  = stub(:email => 'notfound@example.com')
-    connect_user = AdobeConnect::User.find(app_user)
+    connect_user = AdobeConnect::User.find(email: 'notfound@example.com')
     assert_nil connect_user
   end
 end

metadata

@@ -1,176 +1,149 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: adobe_connect
-version: !ruby/object:Gem::Version 
-  hash: 15
-  prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 8
-  version: 0.0.8
+version: !ruby/object:Gem::Version
+  version: 1.0.0
 platform: ruby
-authors: 
+authors:
 - Zach Pendleton
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-03-09 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-05-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: activesupport
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 33
-        segments: 
-        - 2
-        - 3
-        - 17
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
         version: 2.3.17
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: nokogiri
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.3.17
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 9
-        segments: 
-        - 1
-        - 5
-        - 5
+      - !ruby/object:Gem::Version
         version: 1.5.5
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: pry
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 35
-        segments: 
-        - 0
-        - 9
-        - 11
-        - 4
-        version: 0.9.11.4
-  type: :runtime
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.5
+- !ruby/object:Gem::Dependency
   name: rake
-  prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 63
-        segments: 
-        - 0
-        - 9
-        - 2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
         version: 0.9.2
   type: :runtime
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: minitest
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 39
-        segments: 
-        - 4
-        - 6
-        - 0
+      - !ruby/object:Gem::Version
         version: 4.6.0
   type: :development
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.6.0
+- !ruby/object:Gem::Dependency
   name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.13.2
+  type: :development
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 47
-        segments: 
-        - 0
-        - 13
-        - 2
+      - !ruby/object:Gem::Version
         version: 0.13.2
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.11.4
   type: :development
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
-  name: redcarpet
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.11.4
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id007
-- !ruby/object:Gem::Dependency 
-  name: yard
   prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 29
-        segments: 
-        - 0
-        - 8
-        - 4
-        - 1
+      - !ruby/object:Gem::Version
         version: 0.8.4.1
   type: :development
-  version_requirements: *id008
-- !ruby/object:Gem::Dependency 
-  name: yard-tomdoc
   prerelease: false
-  requirement: &id009 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.4.1
+- !ruby/object:Gem::Dependency
+  name: yard-tomdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 0
-        - 6
-        - 0
+      - !ruby/object:Gem::Version
         version: 0.6.0
   type: :development
-  version_requirements: *id009
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
 description: An API wrapper for interacting with Adobe Connect services.
-email: 
+email:
 - zachpendleton@gmail.com
-executables: 
+executables:
 - adobe_connect_console
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .travis.yml
 - .yardopts
@@ -204,39 +177,30 @@ files:
 - test/lib/adobe_connect/user_test.rb
 - test/test_helper.rb
 homepage: https://github.com/zachpendleton/adobe_connect
-licenses: []
-
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 2.0.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: An API wrapper for Adobe Connect services.
-test_files: 
+test_files:
 - test/fixtures/folder_contents.xml
 - test/fixtures/folder_success.xml
 - test/fixtures/log_in_fail.xml
@@ -252,4 +216,3 @@ test_files:
 - test/lib/adobe_connect/service_test.rb
 - test/lib/adobe_connect/user_test.rb
 - test/test_helper.rb
-has_rdoc: