ruby-d2l 0.3.0 → 0.4.0

data/README.rdoc

@@ -22,14 +22,15 @@ Then in your Ruby application you can use the configure block to set these value
       config.username = "D2L_WEB_SERVICES_USERNAME"
       config.password = "D2L_WEB_SERVICES_PASSWORD"
       config.site_url = "D2L_INSTANCE_URL"  (e.g. https://d2l.mysite.edu)
+	  config.soap_logging = true (defaults to false unless set)
     end
 
 == Documentation
 
 Code Example:
 
-    template =  RubyD2L::OrgUnit.get_course_template_by_code(:template_code => "TEMPLATE_CODE").to_hash
-    ap template[:get_course_template_response][:course_template][:name].to_s
+    template =  RubyD2L::OrgUnit.get_course_template_by_code(:template_code => "TEMPLATE_CODE")
+    ap template
 
 
 == Contributing to ruby-d2l

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.4.0

data/lib/ruby-d2l/auth.rb

@@ -1,4 +1,4 @@
-require "savon"
+require 'savon'
 
 module RubyD2L
   class Auth

data/lib/ruby-d2l/config.rb

@@ -1,6 +1,5 @@
 module RubyD2L
   module Config
-    
     attr_accessor :username
     
     attr_accessor :password

data/lib/ruby-d2l/org_unit.rb

@@ -88,10 +88,65 @@ module RubyD2L
       # ]
     end
   
+    # = AddChildOrgUnit
+    # REQUIRED:: { :parent_id = "ID", :child_id => "ID" }
+    # RETURNS::  
+    def self.add_child_org_unit(params={})
+      self.required_params(params, [:parent_id, :child_id])
+
+      params = {
+        :parent_id => "",
+        :child_id => ""
+      }.merge(params)
+      
+      token = RubyD2L::Auth.get_token
+    
+      the_xml = '<?xml version="1.0" encoding="utf-8"?>
+      <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
+        <soap:Header>
+          <RequestHeader xmlns="http://www.desire2learn.com/services/common/xsd/common-v1_0">
+            <Version>1.0</Version>
+            <CorellationId>12345</CorellationId>
+            <AuthenticationToken>'+ token +'</AuthenticationToken>
+          </RequestHeader>
+        </soap:Header>
+        <soap:Body>
+          <AddChildOrgUnitRequest xmlns="http://www.desire2learn.com/services/oums/wsdl/OrgUnitManagementService-v1_0">
+            <OrgUnitId>
+              <Id xmlns="http://www.desire2learn.com/services/common/xsd/common-v1_0">'+ params[:parent_id] +'</Id>
+              <Source xmlns="http://www.desire2learn.com/services/common/xsd/common-v1_0">Desire2Learn</Source>
+            </OrgUnitId>
+            <ChildOrgUnitId>
+              <Id xmlns="http://www.desire2learn.com/services/common/xsd/common-v1_0">'+ params[:child_id] +'</Id>
+              <Source xmlns="http://www.desire2learn.com/services/common/xsd/common-v1_0">Desire2Learn</Source>
+            </ChildOrgUnitId>
+          </AddChildOrgUnitRequest>
+        </soap:Body>
+      </soap:Envelope>'
+      
+      add_child = self.connect(RubyD2L.site_url).request :add_child_org_unit do
+        soap.xml = the_xml
+      end
+      
+      if add_child.to_hash.include?(:add_child_org_unit_response)
+        response = add_chile.to_hash[:add_child_org_unit_response]
+        response_hash = Tools.get_all_values_nested(response)
+        if response_hash.keys.any? {|k| k.include? "business_errors"}
+          return response_hash.keep_if {|k,v| k.include? "business_errors"}
+        else
+          return response_hash
+        end
+      else
+        return false
+      end
+            
+    end
+    
+    
     # = CreateCourseOffering
-    # REQUIRED: { :offering_name => "NAME", :offering_code => "CODE" }
-    # OPTIONAL: { :is_active => "true|false", :start_date => DateTime.to_s (e.g. YYYYMMDDThh:mm:ss), :end_date => DateTime.to_s (e.g. YYYYMMDDThh:mm:ss) }
-    # NOT IMPLEMENTED:  I don't use <Path>'+ @course_path +'</Path>.  Add it if you need it.
+    # REQUIRED:: { :offering_name => "NAME", :offering_code => "CODE" }
+    # OPTIONAL:: { :is_active => "true|false", :start_date => DateTime.to_s (e.g. YYYYMMDDThh:mm:ss), :end_date => DateTime.to_s (e.g. YYYYMMDDThh:mm:ss) }
+    # NOT IMPLEMENTED::  I don't use <Path>'+ @course_path +'</Path>.  Add it if you need it.
     def self.create_course_offering(params={})
       self.required_params(params, [:offering_name, :offering_code, :template_id])
       
@@ -134,15 +189,21 @@ module RubyD2L
         </soap:Body>
       </soap:Envelope>'
     
-      orgunit = self.connect(RubyD2L.site_url).request :create_course_offering do
+      create_offering = self.connect(RubyD2L.site_url).request :create_course_offering do
         soap.xml = the_xml
       end
           
+      response = create_offering.to_hash[:create_course_offering_response]
+      if response.include?(:course_offering)
+        return Tools.get_all_values_nested(response)
+      else
+        return false
+      end
     end
 
     # = CreateCourseTemplate
-    # REQUIRED: { :template_name => "NAME", :template_code => "CODE" }
-    # OPTIONAL: { :is_active => "true|false", :start_date => DateTime.to_s (e.g. YYYYMMDDThh:mm:ss), :end_date => DateTime.to_s (e.g. YYYYMMDDThh:mm:ss) }
+    # REQUIRED:: { :template_name => "NAME", :template_code => "CODE" }
+    # OPTIONAL:: { :is_active => "true|false", :start_date => DateTime.to_s (e.g. YYYYMMDDThh:mm:ss), :end_date => DateTime.to_s (e.g. YYYYMMDDThh:mm:ss) }
     def self.create_course_template(params={})
       self.required_params(params, [:template_name, :template_code])
       
@@ -179,11 +240,61 @@ module RubyD2L
       template = self.connect(RubyD2L.site_url).request :create_course_template do
         soap.xml = the_xml
       end
-    
+
+      response = template.to_hash[:create_course_template_response]
+      if response.include?(:course_template)
+        return Tools.get_all_values_nested(response)
+      else
+        return false
+      end
     end
 
+
+    # = GetCourseOfferingByCode
+    # REQUIRED:: offering_code => "CODE"
+    # RETURNS::  false if not found, values hash if found
+    def self.get_course_offering_by_code(params={})
+      self.required_params(params, [:offering_code])
+      
+      params = {
+        :offering_code => ""
+      }.merge(params)
+
+      token = RubyD2L::Auth.get_token
+      
+      the_xml = '<?xml version="1.0" encoding="utf-8"?>
+      <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
+        <soap:Header>
+        <RequestHeader xmlns="http://www.desire2learn.com/services/common/xsd/common-v1_0">
+          <Version>1.0</Version>
+          <CorellationId>12345</CorellationId>
+          <AuthenticationToken>'+ token +'</AuthenticationToken>
+        </RequestHeader>
+        </soap:Header>
+        <soap:Body>
+          <GetCourseOfferingByCodeRequest xmlns="http://www.desire2learn.com/services/oums/wsdl/OrgUnitManagementService-v1_0">
+             <Code>'+ params[:offering_code] +'</Code>
+          </GetCourseOfferingByCodeRequest>
+        </soap:Body>
+      </soap:Envelope>'
+      
+      offering = self.connect(RubyD2L.site_url).request :get_course_offering_by_code do
+        soap.xml = the_xml
+      end
+    
+      response = offering.to_hash[:get_course_offering_response]
+      if response.include?(:course_offering)
+        return Tools.get_all_values_nested(response)
+      else
+        return false
+      end
+      
+    end
+    
+    
     # = GetCourseTemplateByCode
-    # REQUIRED: template_code => "CODE"
+    # REQUIRED:: template_code => "CODE"
+    # RETURNS::  false if not found, values hash if found
     def self.get_course_template_by_code(params={})
       self.required_params(params, [:template_code])
       
@@ -213,8 +324,101 @@ module RubyD2L
         soap.xml = the_xml
       end
     
+      response = template.to_hash[:get_course_template_response]
+      if response.include?(:course_template)
+        return Tools.get_all_values_nested(response)
+      else
+        return false
+      end            
     end
     
+    # = GetChildCourseTemplates
+    # REQUIRED:: org_unit_id => "ID"
+    # RETURNS::  false if not found, values hash if found
+    def self.get_child_course_templates(params={})
+      self.required_params(params, [:org_unit_id])
+            
+      params = {
+        :org_unit_id => ""
+      }.merge(params)
+      
+      token = RubyD2L::Auth.get_token
+      
+      the_xml = '<?xml version="1.0" encoding="utf-8"?>
+      <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
+        <soap:Header>
+        <RequestHeader xmlns="http://www.desire2learn.com/services/common/xsd/common-v1_0">
+          <Version>1.0</Version>
+          <CorellationId>12345</CorellationId>
+          <AuthenticationToken>'+ token +'</AuthenticationToken>
+        </RequestHeader>
+        </soap:Header>
+        <soap:Body>
+            <GetChildCourseTemplatesRequest xmlns="http://www.desire2learn.com/services/oums/wsdl/OrgUnitManagementService-v1_0">
+              <OrgUnitId>
+                <Id xmlns="http://www.desire2learn.com/services/common/xsd/common-v1_0">'+ params[:org_unit_id] +'</Id>
+                <Source xmlns="http://www.desire2learn.com/services/common/xsd/common-v1_0">Desire2Learn</Source>
+              </OrgUnitId>
+            </GetChildCourseTemplatesRequest>
+        </soap:Body>
+      </soap:Envelope>'
+      
+      child_templates = self.connect(RubyD2L.site_url).request :get_child_course_templates do
+        soap.xml = the_xml
+      end
+      
+      response = child_templates.to_hash[:get_course_templates_response]
+      
+      if response.include?(:child_org_units)
+        return Tools.get_all_values_nested(response)
+      else
+        return false
+      end
+            
+    end
+    
+    # = GetDepartmentByCode
+    # REQUIRED:: :org_unit_code => "CODE"
+    # RETURNS::  false if not found, values hash if found
+    def self.get_department_by_code(params={})
+      self.required_params(params, [:org_unit_code])
+            
+      params = {
+        :org_unit_code => ""
+      }.merge(params)
+      
+      token = RubyD2L::Auth.get_token
+      
+      the_xml = '<?xml version="1.0" encoding="utf-8"?>
+      <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
+        <soap:Header>
+        <RequestHeader xmlns="http://www.desire2learn.com/services/common/xsd/common-v1_0">
+          <Version>1.0</Version>
+          <CorellationId>12345</CorellationId>
+          <AuthenticationToken>'+ token +'</AuthenticationToken>
+        </RequestHeader>
+        </soap:Header>
+        <soap:Body>
+          <GetDepartmentByCodeRequest xmlns="http://www.desire2learn.com/services/oums/wsdl/OrgUnitManagementService-v1_0">
+            <Code>'+ params[:org_unit_code] +'</Code>
+          </GetDepartmentByCodeRequest>
+        </soap:Body>
+      </soap:Envelope>'
+      
+      department = self.connect(RubyD2L.site_url).request :get_department_by_code do
+        soap.xml = the_xml
+      end
+      
+      response = department.to_hash[:get_department_response]
+      if response.include?(:department)
+        return Tools.get_all_values_nested(response)
+      else
+        return false
+      end
+      
+    end
+    
+    
     def self.required_params(passed_params={},*args)
       required_params = *args[0]
       required_params.each do |key|

data/lib/ruby-d2l/tools.rb

@@ -0,0 +1,23 @@
+class Tools
+  
+  @path = []
+  
+  @all_values = {}
+   
+  def self.get_all_values_nested(nested_hash={}) 
+    nested_hash.each_pair do |k,v|
+      @path << k
+      case v
+        when Array, DateTime, FalseClass, Fixnum, NilClass, String, TrueClass then 
+          @all_values.merge!({"#{@path.join(".")}" => "#{v}"}) 
+          @path.pop
+        when Hash then get_all_values_nested(v)
+        else raise ArgumentError, "Unhandled type #{v.class}"
+      end
+    end
+    @path.pop
+
+    return @all_values
+  end
+  
+end

data/lib/ruby-d2l/user.rb

@@ -1,5 +1,3 @@
-require "savon"
-
 module RubyD2L
   class User
 
@@ -54,36 +52,150 @@ module RubyD2L
   
     end
 
+    # = EnrollUser
+    # REQUIRED:: { :org_unit_id => "ID, ":user_id => "ID", :role_id => "ID" }
+    # RETURNS::  
+    def self.enroll_user(params={})
+      self.required_params(params, [:org_unit_id, :user_id, :role_id])
+      
+      params = {
+        :org_unit_id => "",
+        :user_id => "",
+        :role_id => ""
+      }.merge(params)
 
-    def self.get_user_by_user_name(params)
-      site_url = params[0]
-      token = params[1]
-      if params[2] == nil || params[2] == "list_params"
-        ap "[user_name] param required by get_user_by_user_name!"
-        exit
+      token = RubyD2L::Auth.get_token
+      
+      the_xml = '<?xml version="1.0" encoding="utf-8"?>
+      <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
+        <soap:Header>
+        <RequestHeader xmlns="http://www.desire2learn.com/services/common/xsd/common-v1_0">
+          <Version>1.0</Version>
+          <CorellationId>12345</CorellationId>
+          <AuthenticationToken>'+ token +'</AuthenticationToken>
+        </RequestHeader>
+        </soap:Header>
+        <soap:Body>
+          <EnrollUserRequest xmlns="http://www.desire2learn.com/services/ums/wsdl/UserManagementService-v1_0">
+            <OrgUnitId>
+              <Id xmlns="http://www.desire2learn.com/services/common/xsd/common-v1_0">'+ params[:org_unit_id] +'</Id>
+              <Source xmlns="http://www.desire2learn.com/services/common/xsd/common-v1_0">Desire2Learn</Source>
+            </OrgUnitId>
+            <UserId>
+              <Id xmlns="http://www.desire2learn.com/services/common/xsd/common-v1_0">'+ params[:user_id] +'</Id>
+              <Source xmlns="http://www.desire2learn.com/services/common/xsd/common-v1_0">Desire2Learn</Source>
+            </UserId>
+            <RoleId>
+              <Id xmlns="http://www.desire2learn.com/services/common/xsd/common-v1_0">'+ params[:role_id] +'</Id>
+              <Source xmlns="http://www.desire2learn.com/services/common/xsd/common-v1_0">Desire2Learn</Source>
+            </RoleId>
+          </EnrollUserRequest>
+        </soap:Body>
+      </soap:Envelope>'
+      
+      enrollment = self.connect(RubyD2L.site_url).request :enroll_user do
+        soap.xml = the_xml
+      end
+      
+      if enrollment.to_hash.include?(:enroll_user_response)
+        response = enrollment.to_hash[:enroll_user_response]
+        response_hash = Tools.get_all_values_nested(response)
+        if response_hash.keys.any? {|k| k.include? "business_errors"}
+          return response_hash.keep_if {|k,v| k.include? "business_errors"}
+        else
+          return response_hash
+        end
       else
-        user_name = params[2]
+        return false
       end
+      
+    end
+
+    # = EnrollUser
+    # REQUIRED:: N/A
+    # RETURNS::  Array of roles
+    def self.get_roles()
+      token = RubyD2L::Auth.get_token
+      
+      the_xml = '<?xml version="1.0" encoding="utf-8"?>
+      <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
+        <soap:Header>
+         <RequestHeader xmlns="http://www.desire2learn.com/services/common/xsd/common-v1_0">
+           <Version>1.0</Version>
+           <CorellationId>12345</CorellationId>
+           <AuthenticationToken>'+ token +'</AuthenticationToken>
+         </RequestHeader>
+        </soap:Header>
+        <soap:Body>
+          <GetRolesRequest xmlns="http://www.desire2learn.com/services/ums/wsdl/UserManagementService-v1_0" />
+        </soap:Body>
+      </soap:Envelope>'
+        
+      roles = self.connect(RubyD2L.site_url).request :get_roles do
+        soap.xml = the_xml
+      end
+      
+      response = roles.to_hash[:get_roles_response]
+      @role_info = []
+      if response.include?(:roles)
+        response[:roles][:role_info].each do |r|
+          @role_info << Tools.get_all_values_nested(r)
+        end
+        return @role_info
+      else
+        return false
+      end
+    end
     
-      user = connect(site_url).request :get_user_by_user_name do
-        soap.xml = '<?xml version="1.0" encoding="utf-8"?>
-        <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
-          <soap:Header>
-            <RequestHeader xmlns="http://www.desire2learn.com/services/common/xsd/common-v1_0">
-              <Version>1.0</Version>
-              <CorellationId>12345</CorellationId>
-              <AuthenticationToken>'+ token +'</AuthenticationToken>
-            </RequestHeader>
-          </soap:Header>
-          <soap:Body>
-            <GetUserByUserNameRequest xmlns="http://www.desire2learn.com/services/ums/wsdl/UserManagementService-v1_0">
-              <UserName>'+ user_name +'</UserName>
-            </GetUserByUserNameRequest>
-          </soap:Body>
-        </soap:Envelope>'
+    
+    
+    def self.get_user_by_user_name(params={})
+      self.required_params(params, :user_name)
+      
+      params = {
+        :user_name => ""
+      }.merge(params)
+    
+      token = RubyD2L::Auth.get_token
+      
+      the_xml = '<?xml version="1.0" encoding="utf-8"?>
+      <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
+        <soap:Header>
+         <RequestHeader xmlns="http://www.desire2learn.com/services/common/xsd/common-v1_0">
+           <Version>1.0</Version>
+           <CorellationId>12345</CorellationId>
+           <AuthenticationToken>'+ token +'</AuthenticationToken>
+         </RequestHeader>
+        </soap:Header>
+        <soap:Body>
+          <GetUserByUserNameRequest xmlns="http://www.desire2learn.com/services/ums/wsdl/UserManagementService-v1_0">
+            <UserName>'+ params[:user_name] +'</UserName>
+          </GetUserByUserNameRequest>
+        </soap:Body>
+      </soap:Envelope>'
+      
+      user = self.connect(RubyD2L.site_url).request :get_user_by_user_name do
+        soap.xml = the_xml
+      end
+      
+      # ap user.to_hash
+      #   exit
+      
+      response = user.to_hash[:get_user_response]
+      if response.include?(:user)
+        return Tools.get_all_values_nested(response)
+      else
+        return false
       end
+  
     end
   
+    def self.required_params(passed_params={},*args)
+      required_params = *args[0]
+      required_params.each do |key|
+        raise ArgumentError.new("MISSING PARAM -- :#{key} parameter is required!") unless passed_params.has_key?(key)
+      end
+    end
   
   end
 end

data/lib/ruby-d2l.rb

@@ -2,6 +2,7 @@ require "ruby-d2l/auth"
 require "ruby-d2l/config"
 require "ruby-d2l/grades"
 require "ruby-d2l/org_unit"
+require "ruby-d2l/tools"
 require "ruby-d2l/user"
 
 
@@ -14,4 +15,11 @@ module RubyD2L
     yield self if block_given?
   end
   
+  Savon.configure do |config|
+    config.log = false
+  end
+  HTTPI.log = false
+  
+  
+    
 end

data/ruby-d2l.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ruby-d2l}
-  s.version = "0.3.0"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Matt Mencel"]
-  s.date = %q{2011-12-13}
+  s.date = %q{2011-12-21}
   s.description = %q{A Ruby SOAP client for accessing Desire2Learn Web Services (D2LWS)}
   s.email = %q{mr-mencel@wiu.edu}
   s.extra_rdoc_files = [
@@ -29,6 +29,7 @@ Gem::Specification.new do |s|
     "lib/ruby-d2l/config.rb",
     "lib/ruby-d2l/grades.rb",
     "lib/ruby-d2l/org_unit.rb",
+    "lib/ruby-d2l/tools.rb",
     "lib/ruby-d2l/user.rb",
     "ruby-d2l.gemspec",
     "test/helper.rb",

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 3
+  - 4
   - 0
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Matt Mencel
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-12-13 00:00:00 -06:00
+date: 2011-12-21 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -108,6 +108,7 @@ files:
 - lib/ruby-d2l/config.rb
 - lib/ruby-d2l/grades.rb
 - lib/ruby-d2l/org_unit.rb
+- lib/ruby-d2l/tools.rb
 - lib/ruby-d2l/user.rb
 - ruby-d2l.gemspec
 - test/helper.rb
@@ -126,7 +127,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -3831117481161228882
+      hash: -3300350606523422764
       segments: 
       - 0
       version: "0"