moodle 0.1.0 → 0.1.1

data/Rakefile

@@ -1,8 +1,8 @@
-require 'rake/testtask'
-
-Rake::TestTask.new do |t|
-  t.libs << 'test'
-end
-
-desc "Running tests"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Running tests"
 task :default => :test

data/lib/moodle.rb

@@ -1,39 +1,39 @@
-$:.unshift File.dirname(__FILE__)
-
-require 'moodle/client'
-require 'yaml'
-
-module Moodle
-  @@config = {
-    :username => nil,
-    :password => nil,
-    :token => nil,
-    :protocol => nil,
-    :domain => nil,
-    :service => nil,
-    :format => 'json'
-  }
-
-  @valid_config_keys = @@config.keys
-
-  # Configuration is for the instance only
-  def self.new(options={})
-    Moodle::Client.new(options)
-  end
-
-  # Configure at global level trough hash
-  def self.configure(options={})
-    options.each {|k,v| @@config[k.to_sym] = v if @valid_config_keys.include? k.to_sym}
-  end
-
-  # Configure at global level through yaml file
-  def self.configure_with(path_to_yaml_file)
-    config = YAML::load(IO.read(path_to_yaml_file))
-    configure(config)
-  end
-
-  # Obtain the global configuration
-  def self.config
-    @@config
-  end
-end
+$:.unshift File.dirname(__FILE__)
+
+require 'moodle/client'
+require 'yaml'
+
+module Moodle
+  @@config = {
+    :username => nil,
+    :password => nil,
+    :token => nil,
+    :protocol => nil,
+    :domain => nil,
+    :service => nil,
+    :format => 'json'
+  }
+
+  @valid_config_keys = @@config.keys
+
+  # Configuration is for the instance only
+  def self.new(options={})
+    Moodle::Client.new(options)
+  end
+
+  # Configure at global level trough hash
+  def self.configure(options={})
+    options.each {|k,v| @@config[k.to_sym] = v if @valid_config_keys.include? k.to_sym}
+  end
+
+  # Configure at global level through yaml file
+  def self.configure_with(path_to_yaml_file)
+    config = YAML::load(IO.read(path_to_yaml_file))
+    configure(config)
+  end
+
+  # Obtain the global configuration
+  def self.config
+    @@config
+  end
+end

data/lib/moodle/client.rb

@@ -1,69 +1,71 @@
-require 'moodle/protocols/rest'
-require 'moodle/services/user'
-require 'moodle/services/course'
-require 'moodle/services/webservice'
-require 'hashie'
-require 'json'
-
-module Moodle
-  class Client
-    include Moodle::Service::User
-    include Moodle::Service::Course
-    include Moodle::Service::Webservice
-
-    attr_reader :username, :password, :domain, :protocol, :service, :format, :token
-
-    def initialize(options={})
-      @username = options[:username] || Moodle.config[:username]
-      @password = options[:password] || Moodle.config[:password]
-      @domain   = options[:domain]   || Moodle.config[:domain]
-      @protocol = options[:protocol] || Moodle.config[:protocol]
-      @service  = options[:service]  || Moodle.config[:service]
-      @format   = options[:format]   || Moodle.config[:format]
-      @token    = options[:token]    || Moodle.config[:token]
-
-      # If no token is provided generate one
-      if @token.nil?
-        @token = self.obtain_token
-      end
-    end
-
-    # Retuns a Moodle::Protocol client instance
-    def client
-      if @client.nil?
-        # Instantiate the client protocol
-        case @protocol
-        when 'rest'
-          @client = Moodle::Protocol::Rest.new
-        else
-          @client = Moodle::Protocol::Rest.new
-        end
-      end
-      @client
-    end
-
-    # Obtains a token from the username and password
-    def obtain_token
-      response = client.request(@domain + '/login/token.php', {
-        :username => @username, 
-        :password => @password, 
-        :service  => @service
-      })
-
-      parsed = JSON.parse(response)
-      parsed['token']
-    end
-
-    # Make a request using the desired protocol and format
-    def request(params={})
-      params.merge!(
-        :wstoken => @token,
-        :moodlewsrestformat => @format,
-        :wsfunction => caller[0][/`.*'/][1..-2]
-      )
-      response = client.request(@domain + '/webservice/' + @protocol + '/server.php', params)
-
-      JSON.parse(response)
-    end
-  end
+require 'moodle/protocols/rest'
+require 'moodle/services/user'
+require 'moodle/services/course'
+require 'moodle/services/cohort'
+require 'moodle/services/webservice'
+require 'hashie'
+require 'json'
+
+module Moodle
+  class Client
+    include Moodle::Service::User
+    include Moodle::Service::Course
+    include Moodle::Service::Cohort
+    include Moodle::Service::Webservice
+
+    attr_reader :username, :password, :domain, :protocol, :service, :format, :token
+
+    def initialize(options={})
+      @username = options[:username] || Moodle.config[:username]
+      @password = options[:password] || Moodle.config[:password]
+      @domain   = options[:domain]   || Moodle.config[:domain]
+      @protocol = options[:protocol] || Moodle.config[:protocol]
+      @service  = options[:service]  || Moodle.config[:service]
+      @format   = options[:format]   || Moodle.config[:format]
+      @token    = options[:token]    || Moodle.config[:token]
+
+      # If no token is provided generate one
+      if @token.nil?
+        @token = self.obtain_token
+      end
+    end
+
+    # Retuns a Moodle::Protocol client instance
+    def client
+      if @client.nil?
+        # Instantiate the client protocol
+        case @protocol
+        when 'rest'
+          @client = Moodle::Protocol::Rest.new
+        else
+          @client = Moodle::Protocol::Rest.new
+        end
+      end
+      @client
+    end
+
+    # Obtains a token from the username and password
+    def obtain_token
+      response = client.request(@domain + '/login/token.php', {
+        :username => @username, 
+        :password => @password, 
+        :service  => @service
+      })
+
+      parsed = JSON.parse(response)
+      parsed['token']
+    end
+
+    # Make a request using the desired protocol and format
+    def request(params={})
+      params.merge!(
+        :wstoken => @token,
+        :moodlewsrestformat => @format,
+        :wsfunction => caller[0][/`.*'/][1..-2]
+      )
+      response = client.request(@domain + '/webservice/' + @protocol + '/server.php', params)
+
+      JSON.parse(response)
+    end
+  end
 end

data/lib/moodle/helper.rb

@@ -1,11 +1,11 @@
-require 'hashie'
-require 'json'
-
-module Moodle
-  class Helper
-  	
-  	def to_object(json)
-
-  	end
-  end
-end
+require 'hashie'
+require 'json'
+
+module Moodle
+  class Helper
+  	
+  	def to_object(json)
+
+  	end
+  end
+end

data/lib/moodle/protocols/rest.rb

@@ -1,13 +1,12 @@
-require 'rest-client'
-require 'sanitize'
-
-module Moodle
-  module Protocol
-    class Rest
-      # Return must be sanitized oh html as debug on moodle site can be active 
-      def request(url, params={})
-        Sanitize.clean(RestClient.get(url, :params => params), :remove_contents => true)
-      end
-    end  
-  end 
+require 'rest-client'
+
+module Moodle
+  module Protocol
+    class Rest
+
+      def request(url, params={})
+        RestClient.get(url, :params => params)
+      end
+    end  
+  end 
 end

data/lib/moodle/services/cohort.rb

@@ -0,0 +1,22 @@
+module Moodle
+  module Service
+    module Cohort
+      # Returns cohort details
+      def core_cohort_get_cohorts(ids)
+        params = {}
+
+        counter = 0
+        ids.each do |id|
+          params['cohortids[' + counter.to_s + ']'] = id
+          counter = counter + 1
+        end
+
+        response = request(params)
+
+        if response.any?
+          cohorts = response.map { |cohort| Hashie::Mash.new(cohort) }
+        end
+      end
+    end
+  end
+end

data/lib/moodle/services/course.rb

@@ -1,22 +1,22 @@
-module Moodle
-  module Service
-    module Course
-      # Return course details
-      def core_course_get_courses(options)
-        params = {}
-
-        counter = 0
-        options.each do |id|
-          params['options[ids][' + counter.to_s + ']'] = id
-          counter = counter + 1
-        end
-
-        response = request(params)
-
-        if response.any?
-          courses = response.map { |course| Hashie::Mash.new(course) }
-        end
-      end
-    end
-  end
+module Moodle
+  module Service
+    module Course
+      # Return course details
+      def core_course_get_courses(options)
+        params = {}
+
+        counter = 0
+        options.each do |id|
+          params['options[ids][' + counter.to_s + ']'] = id
+          counter = counter + 1
+        end
+
+        response = request(params)
+
+        if response.any?
+          courses = response.map { |course| Hashie::Mash.new(course) }
+        end
+      end
+    end
+  end
 end

data/lib/moodle/services/user.rb

@@ -1,40 +1,40 @@
-module Moodle
-  module Service
-    module User
-        # Get users by field
-        def core_user_get_users_by_field(field, values)
-          params = {
-            :field => field
-          }
-
-          # Add all the userids as array params
-          counter = 0
-          values.each do |id|
-            params['values[' + counter.to_s + ']'] = id
-            counter = counter + 1
-          end
-
-          response = request(params)
-          Hashie::Mash.new *response
-        end
-
-        # Search for users matching the criteria
-        def core_user_get_users(criteria)
-          params = {}
-
-          counter = 0
-          criteria.each do |key,value|
-            params['criteria[' + counter.to_s + '][key]'] = key.to_s
-            params['criteria[' + counter.to_s + '][value]'] = value
-            counter = counter + 1
-          end
-
-          response = request(params)
-
-          if response['users']
-            users = response['users'].map { |user| Hashie::Mash.new(user) }
-          end
-        end
-    end
-  end
+module Moodle
+  module Service
+    module User
+        # Get users by field
+        def core_user_get_users_by_field(field, values)
+          params = {
+            :field => field
+          }
+
+          # Add all the userids as array params
+          counter = 0
+          values.each do |id|
+            params['values[' + counter.to_s + ']'] = id
+            counter = counter + 1
+          end
+
+          response = request(params)
+          Hashie::Mash.new *response
+        end
+
+        # Search for users matching the criteria
+        def core_user_get_users(criteria)
+          params = {}
+
+          counter = 0
+          criteria.each do |key,value|
+            params['criteria[' + counter.to_s + '][key]'] = key.to_s
+            params['criteria[' + counter.to_s + '][value]'] = value
+            counter = counter + 1
+          end
+
+          response = request(params)
+
+          if response['users']
+            users = response['users'].map { |user| Hashie::Mash.new(user) }
+          end
+        end
+    end
+  end
 end

data/lib/moodle/services/webservice.rb

@@ -1,10 +1,10 @@
-module Moodle
-  module Service
-    module Webservice
-      # Return some site info / user info / list web service functions
-      def core_webservice_get_site_info
-        Hashie::Mash.new request
-      end
-    end
-  end
+module Moodle
+  module Service
+    module Webservice
+      # Return some site info / user info / list web service functions
+      def core_webservice_get_site_info
+        Hashie::Mash.new request
+      end
+    end
+  end
 end