moodle_rb 0.0.5

data/.gitignore

@@ -0,0 +1,35 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 JobReady Solutions
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -0,0 +1,108 @@
+# MoodleRb
+A Ruby Client for the Moodle REST API.
+
+## Usage
+
+Initialise a MoodleRb client
+```
+moodle = MoodleRb.new(webservices_token, moodle_url)
+```
+
+Get site information
+```
+moodle.site_info
+```
+
+### Courses
+
+Create a course
+```
+moodle.courses.create(
+  :full_name => 'My Course',
+  :short_name => 'MyC',
+  :parent_category => 5,
+  :idnumber => 'ExtRef'
+)
+```
+
+List all courses
+```
+moodle.courses.index
+```
+
+Show a course
+```
+moodle.courses.show(course_id)
+```
+
+Delete a course
+```
+moodle.courses.destroy(course_id)
+```
+
+### Categories
+
+Create a category
+```
+moodle.categories.create(
+  :name => 'Test category'
+)
+```
+
+List all categories
+```
+moodle.categories.index
+```
+
+Show a category
+```
+moodle.categories.show(category_id)
+```
+
+Delete a category
+```
+moodle.categories.destroy(category_id)
+```
+
+### Enrolments
+
+Create an enrolment
+```
+moodle.enrolments.create(
+  :user_id => user_id,
+  :course_id => course_id
+)
+```
+
+View enrolled users by course
+```
+moodle.courses.enrolled_users(course_id)
+```
+
+View enrolled courses by user
+```
+moodle.users.enrolled_courses(user_id)
+```
+
+### Users
+
+Create a user
+```
+moodle.users.create(
+  :username => 'brucew',
+  :password => 'password',
+  :firstname => 'Bruce',
+  :lastname => 'Wayne',
+  :email => 'bruce@wayneenterprises.com'
+)
+```
+
+Show a user
+```
+moodle.users.show(user_id)
+```
+
+Delete a user
+```
+moodle.users.destroy(user_id)
+```

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/moodle_rb/categories.rb

@@ -0,0 +1,94 @@
+module MoodleRb
+  class Categories
+    include HTTParty
+    include Utility
+
+    attr_reader :token
+    ROOT_CATEGORY = 0
+
+    def initialize(token, url)
+      @token = token
+      self.class.base_uri url
+    end
+
+    def index
+      response = self.class.get(
+        '/webservice/rest/server.php',
+        {
+          :query => query_hash('core_course_get_categories', token)
+        }
+      )
+      response.parsed_response
+    end
+
+    # required params:
+    # name
+    # optional params:
+    # parent_category
+    #     the parent category id inside which the new category will be created
+    #     - set to nil for a root category
+    # idnumber
+    #     the new category external reference. must be unique
+    # description
+    #     the new category description
+    def create(params)
+      response = self.class.post(
+        '/webservice/rest/server.php',
+        {
+          :query => query_hash('core_course_create_categories', token),
+          :body => {
+            :categories => {
+              '0' => {
+                :name => params[:name],
+                :parent => (params[:parent_category] || ROOT_CATEGORY),
+                :idnumber => params[:idnumber],
+                :description => params[:description]
+              }
+            }
+          }
+        }
+      )
+      if error_response?(response)
+        raise MoodleError.new(response.parsed_response)
+      else
+        response.parsed_response.first
+      end
+    end
+
+    def show(id)
+      response = self.class.post(
+        '/webservice/rest/server.php',
+        {
+          :query => query_hash('core_course_get_categories', token),
+          :body => {
+            :criteria => {
+              '0' => {
+                :key => 'id',
+                :value => id
+              }
+            }
+          }
+        }
+      )
+      response.parsed_response.first
+    end
+
+    def destroy(id)
+      response = self.class.post(
+        '/webservice/rest/server.php',
+        {
+          :query => query_hash('core_course_delete_categories', token),
+          :body => {
+            :categories => {
+              '0' => {
+                :id => id,
+                :recursive => 1
+              }
+            }
+          }
+        }
+      )
+      response.parsed_response.nil?
+    end
+  end
+end

data/lib/moodle_rb/client.rb

@@ -0,0 +1,44 @@
+module MoodleRb
+  class Client
+    include HTTParty
+    include Utility
+
+    attr_reader :token, :url
+
+    def initialize(token, url)
+      @token = token
+      @url = url
+      self.class.base_uri url
+    end
+
+    def site_info
+      response = self.class.get(
+        '/webservice/rest/server.php',
+        {
+          :query => query_hash('core_webservice_get_site_info', token)
+        }
+      )
+      response.parsed_response
+    end
+
+    def courses
+      MoodleRb::Courses.new(token, url)
+    end
+
+    def categories
+      MoodleRb::Categories.new(token, url)
+    end
+
+    def users
+      MoodleRb::Users.new(token, url)
+    end
+
+    def enrolments
+      MoodleRb::Enrolments.new(token, url)
+    end
+
+    def grades
+      MoodleRb::Grades.new(token, url)
+    end
+  end
+end

data/lib/moodle_rb/courses.rb

@@ -0,0 +1,101 @@
+module MoodleRb
+  class Courses
+    include HTTParty
+    include Utility
+
+    attr_reader :token
+
+    def initialize(token, url)
+      @token = token
+      self.class.base_uri url
+    end
+
+    def index
+      response = self.class.get(
+        '/webservice/rest/server.php',
+        {
+          :query => query_hash('core_course_get_courses', token)
+        }
+      )
+      response.parsed_response
+    end
+
+    # required params:
+    # full_name
+    # short_name
+    #   must be unique
+    # parent_category
+    #   the parent category id inside which the new category will be created
+    # optional params:
+    # idnumber
+    #     the new course external reference. must be unique
+    def create(params)
+      response = self.class.post(
+        '/webservice/rest/server.php',
+        {
+          :query => query_hash('core_course_create_courses', token),
+          :body => {
+            :courses => {
+              '0' => {
+                :fullname => params[:full_name],
+                :shortname => params[:short_name],
+                :categoryid => params[:parent_category],
+                :idnumber => params[:idnumber]
+              }
+            }
+          }
+        }
+      )
+      if error_response?(response)
+        raise MoodleError.new(response.parsed_response)
+      else
+        response.parsed_response.first
+      end
+    end
+
+    def show(id)
+      response = self.class.post(
+        '/webservice/rest/server.php',
+        {
+          :query => query_hash('core_course_get_courses', token),
+          :body => {
+            :options => {
+              :ids => {
+                '0' => id
+              }
+            }
+          }
+        }
+      )
+      response.parsed_response.first
+    end
+
+    def destroy(id)
+      response = self.class.post(
+        '/webservice/rest/server.php',
+        {
+          :query => query_hash('core_course_delete_courses', token),
+          :body => {
+            :courseids => {
+              '0' => id
+            }
+          }
+        }
+      )
+      response.parsed_response.nil?
+    end
+
+    def enrolled_users(course_id)
+      response = self.class.post(
+        '/webservice/rest/server.php',
+        {
+          :query => query_hash('core_enrol_get_enrolled_users', token),
+          :body => {
+            :courseid => course_id
+          }
+        }
+      )
+      response.parsed_response
+    end
+  end
+end

data/lib/moodle_rb/enrolments.rb

@@ -0,0 +1,39 @@
+module MoodleRb
+  class Enrolments
+    include HTTParty
+    include Utility
+
+    attr_reader :token
+    STUDENT_ROLE_ID = 5
+
+    def initialize(token, url)
+      @token = token
+      self.class.base_uri url
+    end
+
+    # required params:
+    # user_id course_id
+    def create(params)
+      response = self.class.post(
+        '/webservice/rest/server.php',
+        {
+          :query => query_hash('enrol_manual_enrol_users', token),
+          :body => {
+            :enrolments => {
+              '0' => {
+                :userid => params[:user_id],
+                :courseid => params[:course_id],
+                :roleid => STUDENT_ROLE_ID
+              }
+            }
+          }
+        }
+      )
+      if error_response?(response)
+        raise MoodleError.new(response.parsed_response)
+      else
+        response.code == 200 && response.parsed_response.nil?
+      end
+    end
+  end
+end

data/lib/moodle_rb/error.rb

@@ -0,0 +1,18 @@
+module MoodleRb
+  class MoodleError < StandardError
+    attr_reader :response_body, :code, :message
+
+    def initialize(response_body)
+      @response_body = response_body
+
+      if response_body.is_a?(Hash)
+        @code       = response_body["errorcode"]
+        @message    = response_body["message"]
+      else
+        @message    = response_body.to_s
+      end
+
+      super(response_body.inspect)
+    end
+  end
+end

data/lib/moodle_rb/grades.rb

@@ -0,0 +1,42 @@
+module MoodleRb
+  class Grades
+    include HTTParty
+    include Utility
+
+    attr_reader :token
+
+    def initialize(token, url)
+      @token = token
+      self.class.base_uri url
+    end
+
+    def by_assignment(assignment_id)
+      response = self.class.post(
+        '/webservice/rest/server.php',
+        {
+          :query => query_hash('mod_assign_get_grades', token),
+          :body => {
+            :assignmentids => api_array(assignment_id)
+          }
+        }
+      )
+      response.parsed_response.is_a?(Hash) &&
+        response.parsed_response['assignments']
+    end
+
+    def by_course(course_id, *user_ids)
+      response = self.class.post(
+        '/webservice/rest/server.php',
+        {
+          :query => query_hash('core_grades_get_grades', token),
+          :body => {
+            :courseid => course_id,
+            :userids => api_array(user_ids)
+          }
+        }
+      )
+      response.parsed_response.is_a?(Hash) &&
+        response.parsed_response['items']
+    end
+  end
+end

data/lib/moodle_rb/users.rb

@@ -0,0 +1,83 @@
+module MoodleRb
+  class Users
+    include HTTParty
+    include Utility
+
+    attr_reader :token
+
+    def initialize(token, url)
+      @token = token
+      self.class.base_uri url
+    end
+
+    # required params:
+    # username password firstname lastname email
+    # optional params:
+    # idnumber
+    #     An arbitrary ID code number perhaps from the institution
+    def create(params)
+      response = self.class.post(
+        '/webservice/rest/server.php',
+        {
+          :query => query_hash('core_user_create_users', token),
+          :body => {
+            :users => {
+              '0' => params
+            }
+          }
+        }
+      )
+      if error_response?(response)
+        raise MoodleError.new(response.parsed_response)
+      else
+        response.parsed_response.first
+      end
+    end
+
+    def show(id)
+      response = self.class.post(
+        '/webservice/rest/server.php',
+        {
+          :query => query_hash('core_user_get_users', token),
+          :body => {
+            :criteria => {
+              '0' => {
+                :key => 'id',
+                :value => id
+              }
+            }
+          }
+        }
+      )
+      response.parsed_response['users'] && response.parsed_response['users'].first
+    end
+
+    def destroy(id)
+      response = self.class.post(
+        '/webservice/rest/server.php',
+        {
+          :query => query_hash('core_user_delete_users', token),
+          :body => {
+            :userids => {
+              '0' => id
+            }
+          }
+        }
+      )
+      response.parsed_response.nil?
+    end
+
+    def enrolled_courses(user_id)
+      response = self.class.post(
+        '/webservice/rest/server.php',
+        {
+          :query => query_hash('core_enrol_get_users_courses', token),
+          :body => {
+            :userid => user_id
+          }
+        }
+      )
+      response.parsed_response
+    end
+  end
+end

data/lib/moodle_rb/utility.rb

@@ -0,0 +1,25 @@
+module MoodleRb
+  module Utility
+    def query_hash(function, token)
+      {
+        :wsfunction => function,
+        :moodlewsrestformat => 'json',
+        :wstoken => token
+      }
+    end
+
+    # The Moodle API requires array arguments to be in this format
+    def api_array(*array)
+      {}.tap do |h|
+        array.flatten.each_with_index do |x, i|
+          h[i] = x
+        end
+      end
+    end
+
+    def error_response?(response)
+      response && response.parsed_response.is_a?(Hash) &&
+        response.parsed_response.has_key?('exception')
+    end
+  end
+end

data/lib/moodle_rb/version.rb

@@ -0,0 +1,7 @@
+module MoodleRb
+  VERSION = '0.0.5' unless defined?(self::VERSION)
+
+  def self.version
+    VERSION
+  end
+end

data/lib/moodle_rb.rb

@@ -0,0 +1,16 @@
+require 'httparty'
+require 'moodle_rb/version'
+require 'moodle_rb/utility'
+require 'moodle_rb/error'
+require 'moodle_rb/client'
+require 'moodle_rb/courses'
+require 'moodle_rb/categories'
+require 'moodle_rb/enrolments'
+require 'moodle_rb/grades'
+require 'moodle_rb/users'
+
+module MoodleRb
+  def self.new(token, url)
+    Client.new(token, url)
+  end
+end

data/moodle_rb.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'moodle_rb/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'moodle_rb'
+  spec.version       = MoodleRb::VERSION
+  spec.authors       = ['Sam Giffney']
+  spec.email         = ['samg@jobready.com.au']
+  spec.summary       = %q{ A Ruby client for the Moodle API }
+  spec.homepage      = 'https://github.com/jobready/moodle-rb'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'ruby-debug', '0.10.4'
+  spec.add_development_dependency 'rake', '~> 0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'webmock', '~> 1.0'
+  spec.add_development_dependency 'vcr', '~> 2.9'
+
+  spec.add_dependency 'httparty', '~> 0.11.0'
+end