RubyGems - ruby-d2l - Versions diffs - 0.2.2 → 0.3.0 - Mend

ruby-d2l 0.2.2 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (7) hide show

data/README.rdoc CHANGED Viewed

@@ -1,6 +1,6 @@
 = ruby-d2l
-Version 0.2.0 - Extremely limited functionality so far.  At this point it's just a proof of concept.  The only SOAP call that works is get_course_template_by_code.
+Extremely limited functionality so far.  At this point it's just a proof of concept.  Only a few SOAP calls are implemented at the moment.
 This hopefully will eventually provide a much easier way to access the Web Services SOAP interface in Desire2Learn.  This code should work with D2L versions 9.4.1 and prior.  As of D2L version 9.4.1, a new REST based interface is available.  This may be re-written to support REST when I get access to a 9.4.1 test system.
@@ -28,7 +28,7 @@ Then in your Ruby application you can use the configure block to set these value
 Code Example:
-    template =  RubyD2L::OrgUnit.get_course_template_by_code("TEMPLATE_CODE").to_hash
+    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

data/VERSION CHANGED Viewed

	@@ -1 +1 @@
1	- 0.2.2
1	+ 0.3.0

data/lib/ruby-d2l/auth.rb CHANGED Viewed

@@ -5,7 +5,6 @@ module RubyD2L
     def self.connect(site_url)
       Savon::Client.new do
-        ap site_url
         wsdl.document = "#{site_url}/d2l/AuthenticationTokenService.asmx?WSDL"
         wsdl.endpoint = "#{site_url}/d2l/AuthenticationTokenService.asmx"
         #http.proxy = @@proxy_server if @@proxy_server != nil

data/lib/ruby-d2l/org_unit.rb CHANGED Viewed

@@ -10,11 +10,11 @@ module RubyD2L
       end
     end
-    def self.list_soap_actions(params)
-      # Get available SOAP actions
+    # = CreateCourseOffering
+    # Get a list of available SOAP actions for OrgUnit
+    def self.list_soap_actions()
-      site_url = params[0]
-      ap connect(site_url).wsdl.soap_actions
+      ap connect(RubyD2L.site_url).wsdl.soap_actions
       # [
       #     [ 0] :link_course_offering_to_navbar,
@@ -88,89 +88,73 @@ module RubyD2L
       # ]
     end
-    def self.create_course_offering(params)
-      # I don't use <Path>'+ @course_path +'</Path>.  Add it if you need it.
+    # = 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.
+    def self.create_course_offering(params={})
+      self.required_params(params, [:offering_name, :offering_code, :template_id])
-      @course_name = ""
-      @course_code = ""
-      @course_path = ""
-      @template_id = ""
-      @is_active = "false"
-      @start_date = DateTime.now.to_s
-      @end_date = DateTime.now.to_s
-      @can_register = "false"
-      @allow_sections = "false"
+      params = {
+        :offering_name => "",
+        :offering_code => "",
+        :template_id => "",
+        :is_active => "false",
+        :start_date => DateTime.now.to_s,
+        :end_date => DateTime.now.to_s,
+        :can_register => "false",
+        :allow_sections => "false"
+      }.merge(params)
-        site_url = params[0]
-        token = params[1]
-        if params[2] == nil || params[2] == "list_params"
-          ap "REQUIRED: [course_name, course_code, template_id]"
-          ap "OPTIONAL: [is_active(T/F), start_date (2011-12-12T00:00:00), end_date, can_register(T/F), allow_sections(T/F)]"
-          ap "Must be comma separated with no spaces. (e.g. -p course_name=CS100,course_code=123,is_active=false)"
-          exit
-        else
-          params[2].split(',').each do |values|
-            vals = values.split('=')
-            instance_variable_set("@#{vals[0]}", vals[1])
-          end
-        end
-        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>
-            <CreateCourseOfferingRequest xmlns="http://www.desire2learn.com/services/oums/wsdl/OrgUnitManagementService-v1_0">
-              <Name>'+ @course_name +'</Name>
-              <Code>'+ @course_code +'</Code>
-              <TemplateId>
-                <Id xmlns="http://www.desire2learn.com/services/common/xsd/common-v1_0">'+ @template_id +'</Id>
-                <Source xmlns="http://www.desire2learn.com/services/common/xsd/common-v1_0">Desire2Learn</Source>
-              </TemplateId>
-              <IsActive>'+ @is_active +'</IsActive>
-              <StartDate>'+ @start_date +'</StartDate>
-              <EndDate>'+ @end_date +'</EndDate>
-              <CanRegister>'+ @can_register +'</CanRegister>
-              <AllowSections>'+ @allow_sections +'</AllowSections>
-            </CreateCourseOfferingRequest>
-          </soap:Body>
-        </soap:Envelope>'
-        orgunit = connect(site_url).request :create_course_offering do
-          soap.xml = the_xml
-        end
-    end
-    def self.create_course_template(params)
-      # I don't use <Path>'+ @template_path +'</Path>.  Add it if you need it.
+      token = RubyD2L::Auth.get_token
-      @template_name = ""
-      @template_code = ""
-      @is_active = "false"
-      @start_date = DateTime.now.to_s
-      @end_date = DateTime.now.to_s
+      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>
+          <CreateCourseOfferingRequest xmlns="http://www.desire2learn.com/services/oums/wsdl/OrgUnitManagementService-v1_0">
+            <Name>'+ params[:offering_name] +'</Name>
+            <Code>'+ params[:offering_code] +'</Code>
+            <TemplateId>
+              <Id xmlns="http://www.desire2learn.com/services/common/xsd/common-v1_0">'+ params[:template_id] +'</Id>
+              <Source xmlns="http://www.desire2learn.com/services/common/xsd/common-v1_0">Desire2Learn</Source>
+            </TemplateId>
+            <IsActive>'+ params[:is_active] +'</IsActive>
+            <StartDate>'+ params[:start_date] +'</StartDate>
+            <EndDate>'+ params[:end_date] +'</EndDate>
+            <CanRegister>'+ params[:can_register] +'</CanRegister>
+            <AllowSections>'+ params[:allow_sections] +'</AllowSections>
+          </CreateCourseOfferingRequest>
+        </soap:Body>
+      </soap:Envelope>'
-      site_url = params[0]
-      token = params[1]
-      if params[2] == nil || params[2] == "list_params"
-        ap "REQUIRED: [template_name, template_code]"
-        ap "OPTIONAL: [is_active(true/false), start_date(YYYY-MM-DDThh:mm:ss), end_date(YYYY-MM-DDThh:mm:ss)]"
-        ap "Must be comma separated with no spaces. (e.g. -p template_name=CS100,template_code=123,is_active=false)"
-        exit
-      else
-        params[2].split(',').each do |values|
-          vals = values.split('=')
-          instance_variable_set("@#{vals[0]}", vals[1])
-        end
+      orgunit = self.connect(RubyD2L.site_url).request :create_course_offering do
+        soap.xml = the_xml
       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) }
+    def self.create_course_template(params={})
+      self.required_params(params, [:template_name, :template_code])
+      params = {
+        :template_name => "",
+        :template_code => "",
+        :is_active => "false",
+        :start_date => DateTime.now.to_s,
+        :end_date => DateTime.now.to_s
+      }.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/">
@@ -183,39 +167,32 @@ module RubyD2L
         </soap:Header>
         <soap:Body>
           <CreateCourseTemplateRequest xmlns="http://www.desire2learn.com/services/oums/wsdl/OrgUnitManagementService-v1_0">
-            <Name>'+ @template_name +'</Name>
-            <Code>'+ @template_code +'</Code>
-            <IsActive>'+ @is_active +'</IsActive>
-            <StartDate>'+ @start_date +'</StartDate>
-            <EndDate>'+ @end_date +'</EndDate>
+            <Name>'+ params[:template_name] +'</Name>
+            <Code>'+ params[:template_code] +'</Code>
+            <IsActive>'+ params[:is_active] +'</IsActive>
+            <StartDate>'+ params[:start_date] +'</StartDate>
+            <EndDate>'+ params[:end_date] +'</EndDate>
           </CreateCourseTemplateRequest>
         </soap:Body>
       </soap:Envelope>'
-      template = connect(site_url).request :create_course_template do
+      template = self.connect(RubyD2L.site_url).request :create_course_template do
         soap.xml = the_xml
       end
     end
-    def self.get_course_template_by_code(template_code)
-      # @template_code = ""
+    # = GetCourseTemplateByCode
+    # REQUIRED: template_code => "CODE"
+    def self.get_course_template_by_code(params={})
+      self.required_params(params, [:template_code])
+      params = {
+        :template_code => ""
+      }.merge(params)
       token = RubyD2L::Auth.get_token
-      # site_url = params[0]
-      # token = params[1]
-      #       if params[2] == nil || params[2] == "list_params"
-      #         ap "REQUIRED: [template_code]"
-      #         exit
-      #       else
-      #         params[2].split(',').each do |values|
-      #           vals = values.split('=')
-      #           instance_variable_set("@#{vals[0]}", vals[1])
-      #         end
-      #       end
       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>
@@ -227,7 +204,7 @@ module RubyD2L
         </soap:Header>
         <soap:Body>
           <GetCourseTemplateByCodeRequest xmlns="http://www.desire2learn.com/services/oums/wsdl/OrgUnitManagementService-v1_0">
-            <Code>'+ template_code +'</Code>
+            <Code>'+ params[:template_code] +'</Code>
           </GetCourseTemplateByCodeRequest>
         </soap:Body>
       </soap:Envelope>'
@@ -237,5 +214,13 @@ module RubyD2L
       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/user.rb CHANGED Viewed

@@ -1,86 +1,89 @@
-class User
+require "savon"
-  def self.connect(site_url)
-    Savon::Client.new do
-      wsdl.document = "#{site_url}/D2LWS/UserManagementService-v1.asmx?WSDL"
-      wsdl.endpoint = "#{site_url}/D2LWS/UserManagementService-v1.asmx"
-      http.proxy = @@proxy_server if @@proxy_server != nil
-      http.auth.ssl.verify_mode = :none
+module RubyD2L
+  class User
+    def self.connect(site_url)
+      Savon::Client.new do
+        wsdl.document = "#{site_url}/D2LWS/UserManagementService-v1.asmx?WSDL"
+        wsdl.endpoint = "#{site_url}/D2LWS/UserManagementService-v1.asmx"
+        http.auth.ssl.verify_mode = :none
+      end
     end
-  end
-  def self.list_soap_actions(params)
-    # Get available SOAP actions
+    def self.list_soap_actions(params)
+      # Get available SOAP actions
-    site_url = params[0]
-    ap connect(site_url).wsdl.soap_actions
+      site_url = params[0]
+      ap connect(site_url).wsdl.soap_actions
-    # [
-    #     [ 0] :get_active_course_offerings_ex,
-    #     [ 1] :get_active_course_offerings,
-    #     [ 2] :activate_users,
-    #     [ 3] :deactivate_users,
-    #     [ 4] :get_user_activation_status,
-    #     [ 5] :create_auditor_relationship,
-    #     [ 6] :remove_auditor_relationship,
-    #     [ 7] :get_auditors,
-    #     [ 8] :get_auditees,
-    #     [ 9] :get_users_by_org_unit_role,
-    #     [10] :create_user,
-    #     [11] :delete_user,
-    #     [12] :get_user,
-    #     [13] :update_user,
-    #     [14] :delete_user_by_user_name,
-    #     [15] :delete_user_by_org_defined_id,
-    #     [16] :get_user_by_user_name,
-    #     [17] :get_user_by_org_defined_id,
-    #     [18] :get_roles,
-    #     [19] :get_role,
-    #     [20] :change_password,
-    #     [21] :enroll_user,
-    #     [22] :unenroll_user,
-    #     [23] :get_org_unit_enrollment,
-    #     [24] :get_enrollments_by_org_unit,
-    #     [25] :get_profile_by_user,
-    #     [26] :get_profile_picture,
-    #     [27] :update_profile,
-    #     [28] :get_users_by_group,
-    #     [29] :get_users_by_section,
-    #     [30] :get_users_by_course_offerings_index,
-    #     [31] :get_permitted_tasks_by_user_org_unit
-    # ]
+      # [
+      #     [ 0] :get_active_course_offerings_ex,
+      #     [ 1] :get_active_course_offerings,
+      #     [ 2] :activate_users,
+      #     [ 3] :deactivate_users,
+      #     [ 4] :get_user_activation_status,
+      #     [ 5] :create_auditor_relationship,
+      #     [ 6] :remove_auditor_relationship,
+      #     [ 7] :get_auditors,
+      #     [ 8] :get_auditees,
+      #     [ 9] :get_users_by_org_unit_role,
+      #     [10] :create_user,
+      #     [11] :delete_user,
+      #     [12] :get_user,
+      #     [13] :update_user,
+      #     [14] :delete_user_by_user_name,
+      #     [15] :delete_user_by_org_defined_id,
+      #     [16] :get_user_by_user_name,
+      #     [17] :get_user_by_org_defined_id,
+      #     [18] :get_roles,
+      #     [19] :get_role,
+      #     [20] :change_password,
+      #     [21] :enroll_user,
+      #     [22] :unenroll_user,
+      #     [23] :get_org_unit_enrollment,
+      #     [24] :get_enrollments_by_org_unit,
+      #     [25] :get_profile_by_user,
+      #     [26] :get_profile_picture,
+      #     [27] :update_profile,
+      #     [28] :get_users_by_group,
+      #     [29] :get_users_by_section,
+      #     [30] :get_users_by_course_offerings_index,
+      #     [31] :get_permitted_tasks_by_user_org_unit
+      # ]
-  end
+    end
-  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
-    else
-      user_name = params[2]
-    end
+    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
+      else
+        user_name = params[2]
+      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>'
+      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>'
+      end
     end
-  end
+  end
 end

data/ruby-d2l.gemspec CHANGED Viewed

@@ -5,7 +5,7 @@
 Gem::Specification.new do |s|
   s.name = %q{ruby-d2l}
-  s.version = "0.2.2"
+  s.version = "0.3.0"
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Matt Mencel"]

metadata CHANGED Viewed

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments:
   - 0
-  - 2
-  - 2
-  version: 0.2.2
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors:
 - Matt Mencel
@@ -126,7 +126,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      hash: -1913843328194899907
+      hash: -3831117481161228882
       segments:
       - 0
       version: "0"