moodle_rb 1.0.4 → 1.2.0

data/spec/cassettes/MoodleRb_Users/_search_identity/when_using_invalid_token/.yml

@@ -0,0 +1,52 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://localhost:8888/moodle28/webservice/rest/server.php?moodlewsrestformat=json&wsfunction=core_user_search_identity&wstoken=
+    body:
+      encoding: UTF-8
+      string: query=moodle_student%40mailinator.com
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Accept-Ranges:
+      - bytes
+      - none
+      Access-Control-Allow-Origin:
+      - "*"
+      Age:
+      - '0'
+      Cache-Control:
+      - private, must-revalidate, pre-check=0, post-check=0, max-age=0
+      Content-Type:
+      - application/json
+      Date:
+      - Tue, 11 Jan 2022 21:28:57 GMT
+      Expires:
+      - Thu, 01 Jan 1970 00:00:00 GMT
+      Pragma:
+      - no-cache
+      Server:
+      - Moodle
+      X-Cache:
+      - MISS
+      X-Clacks-Overhead:
+      - GNU Terry Pratchett
+      X-Ec2-Instance-Id:
+      - i-0afd4744d7a60c5d7
+      X-Powered-By:
+      - Moodle Ninjas
+      Content-Length:
+      - '103'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: '{"exception":"moodle_exception","errorcode":"invalidtoken","message":"Invalid
+        token - token not found"}'
+    http_version:
+  recorded_at: Tue, 11 Jan 2022 21:28:24 GMT
+recorded_with: VCR 2.9.3

data/spec/cassettes/MoodleRb_Users/_show/.yml

@@ -1,39 +1,39 @@
---- 
+---
 recorded_with: VCR 2.9.3
-http_interactions: 
-- request: 
+http_interactions:
+- request:
     method: post
     uri: http://localhost:8888/moodle28/webservice/rest/server.php?moodlewsrestformat=json&wsfunction=core_user_get_users&wstoken=60fc9c9415259404795094957e4ab32f
-    body: 
+    body:
       string: criteria[0][key]=id&criteria[0][value]=5
     headers: {}
 
-  response: 
-    status: 
+  response:
+    status:
       code: 200
       message: OK
-    headers: 
-      Server: 
+    headers:
+      Server:
       - Apache/2.2.29 (Unix) mod_fastcgi/2.4.6 mod_wsgi/3.4 Python/2.7.8 PHP/5.6.2 mod_ssl/2.2.29 OpenSSL/0.9.8zd DAV/2 mod_perl/2.0.8 Perl/v5.20.0
-      Pragma: 
+      Pragma:
       - no-cache
-      Date: 
+      Date:
       - Sun, 12 Apr 2015 01:01:44 GMT
-      Access-Control-Allow-Origin: 
+      Access-Control-Allow-Origin:
       - "*"
-      Content-Length: 
+      Content-Length:
       - "353"
-      X-Powered-By: 
+      X-Powered-By:
       - PHP/5.6.2
-      Expires: 
+      Expires:
       - Thu, 01 Jan 1970 00:00:00 GMT
-      Cache-Control: 
+      Cache-Control:
       - private, must-revalidate, pre-check=0, post-check=0, max-age=0
-      Content-Type: 
+      Content-Type:
       - application/json
-      Accept-Ranges: 
+      Accept-Ranges:
       - none
-    body: 
+    body:
       string: "{\"users\":[{\"id\":5,\"firstname\":\"Austin\",\"lastname\":\"Powers\",\"fullname\":\"Austin Powers\",\"email\":\"austinp1@jobready.com.au\",\"firstaccess\":0,\"lastaccess\":0,\"profileimageurlsmall\":\"http:\\/\\/localhost:8888\\/moodle28\\/pluginfile.php\\/69\\/user\\/icon\\/f2\",\"profileimageurl\":\"http:\\/\\/localhost:8888\\/moodle28\\/pluginfile.php\\/69\\/user\\/icon\\/f1\"}],\"warnings\":[]}"
-    http_version: 
+    http_version:
   recorded_at: Sun, 12 Apr 2015 01:01:44 GMT

data/spec/cassettes/MoodleRb_Users/_show/when_using_invalid_token/.yml

@@ -1,39 +1,39 @@
---- 
+---
 recorded_with: VCR 2.9.3
-http_interactions: 
-- request: 
+http_interactions:
+- request:
     method: post
-    uri: http://localhost:8888/moodle29/webservice/rest/server.php?moodlewsrestformat=json&wsfunction=core_user_get_users&wstoken=
-    body: 
+    uri: http://localhost:8888/moodle28/webservice/rest/server.php?moodlewsrestformat=json&wsfunction=core_user_get_users&wstoken=
+    body:
       string: criteria[0][value]=5&criteria[0][key]=id
     headers: {}
 
-  response: 
-    status: 
+  response:
+    status:
       code: 200
       message: OK
-    headers: 
-      Cache-Control: 
+    headers:
+      Cache-Control:
       - private, must-revalidate, pre-check=0, post-check=0, max-age=0
-      Pragma: 
+      Pragma:
       - no-cache
-      Server: 
+      Server:
       - Apache/2.2.29 (Unix) mod_fastcgi/2.4.6 mod_wsgi/3.4 Python/2.7.8 PHP/5.6.2 mod_ssl/2.2.29 OpenSSL/0.9.8zg DAV/2 mod_perl/2.0.8 Perl/v5.20.0
-      Accept-Ranges: 
+      Accept-Ranges:
       - none
-      Content-Type: 
+      Content-Type:
       - application/json
-      Date: 
+      Date:
       - Mon, 20 Jun 2016 22:30:45 GMT
-      Expires: 
+      Expires:
       - Thu, 01 Jan 1970 00:00:00 GMT
-      Access-Control-Allow-Origin: 
+      Access-Control-Allow-Origin:
       - "*"
-      Content-Length: 
+      Content-Length:
       - "103"
-      X-Powered-By: 
+      X-Powered-By:
       - PHP/5.6.2
-    body: 
+    body:
       string: "{\"exception\":\"moodle_exception\",\"errorcode\":\"invalidtoken\",\"message\":\"Invalid token - token not found\"}"
-    http_version: 
+    http_version:
   recorded_at: Mon, 20 Jun 2016 22:30:45 GMT

data/spec/cassettes/MoodleRb_Users/_update/.yml

@@ -1,39 +1,39 @@
---- 
-http_interactions: 
-- request: 
+---
+http_interactions:
+- request:
     method: post
-    uri: http://localhost:8888/moodle29/webservice/rest/server.php?moodlewsrestformat=json&wsfunction=core_user_update_users&wstoken=87b95af2df709fa60b395b5c59a3fc2e
-    body: 
+    uri: http://localhost:8888/moodle28/webservice/rest/server.php?moodlewsrestformat=json&wsfunction=core_user_update_users&wstoken=60fc9c9415259404795094957e4ab32f
+    body:
       string: users[0][email]=samg%40jobready.com.au&users[0][id]=4
     headers: {}
 
-  response: 
-    status: 
+  response:
+    status:
       code: 200
       message: OK
-    headers: 
-      Expires: 
+    headers:
+      Expires:
       - Thu, 01 Jan 1970 00:00:00 GMT
-      X-Powered-By: 
+      X-Powered-By:
       - PHP/5.6.2
-      Content-Type: 
+      Content-Type:
       - application/json
-      Content-Length: 
+      Content-Length:
       - "4"
-      Date: 
+      Date:
       - Wed, 08 Jun 2016 06:40:27 GMT
-      Access-Control-Allow-Origin: 
+      Access-Control-Allow-Origin:
       - "*"
-      Accept-Ranges: 
+      Accept-Ranges:
       - none
-      Pragma: 
+      Pragma:
       - no-cache
-      Server: 
+      Server:
       - Apache/2.2.29 (Unix) mod_fastcgi/2.4.6 mod_wsgi/3.4 Python/2.7.8 PHP/5.6.2 mod_ssl/2.2.29 OpenSSL/0.9.8zg DAV/2 mod_perl/2.0.8 Perl/v5.20.0
-      Cache-Control: 
+      Cache-Control:
       - private, must-revalidate, pre-check=0, post-check=0, max-age=0
-    body: 
+    body:
       string: "null"
-    http_version: 
+    http_version:
   recorded_at: Wed, 08 Jun 2016 06:40:27 GMT
 recorded_with: VCR 2.9.3

data/spec/cassettes/MoodleRb_Users/_update/when_using_invalid_token/.yml

@@ -1,39 +1,39 @@
---- 
-http_interactions: 
-- request: 
+---
+http_interactions:
+- request:
     method: post
-    uri: http://localhost:8888/moodle29/webservice/rest/server.php?moodlewsrestformat=json&wsfunction=core_user_update_users&wstoken=
-    body: 
+    uri: http://localhost:8888/moodle28/webservice/rest/server.php?moodlewsrestformat=json&wsfunction=core_user_update_users&wstoken=
+    body:
       string: users[0][email]=&users[0][id]=4
     headers: {}
 
-  response: 
-    status: 
+  response:
+    status:
       code: 200
       message: OK
-    headers: 
-      X-Powered-By: 
+    headers:
+      X-Powered-By:
       - PHP/5.6.2
-      Accept-Ranges: 
+      Accept-Ranges:
       - none
-      Server: 
+      Server:
       - Apache/2.2.29 (Unix) mod_fastcgi/2.4.6 mod_wsgi/3.4 Python/2.7.8 PHP/5.6.2 mod_ssl/2.2.29 OpenSSL/0.9.8zg DAV/2 mod_perl/2.0.8 Perl/v5.20.0
-      Pragma: 
+      Pragma:
       - no-cache
-      Content-Type: 
+      Content-Type:
       - application/json
-      Access-Control-Allow-Origin: 
+      Access-Control-Allow-Origin:
       - "*"
-      Expires: 
+      Expires:
       - Thu, 01 Jan 1970 00:00:00 GMT
-      Date: 
+      Date:
       - Mon, 20 Jun 2016 22:39:11 GMT
-      Cache-Control: 
+      Cache-Control:
       - private, must-revalidate, pre-check=0, post-check=0, max-age=0
-      Content-Length: 
+      Content-Length:
       - "103"
-    body: 
+    body:
       string: "{\"exception\":\"moodle_exception\",\"errorcode\":\"invalidtoken\",\"message\":\"Invalid token - token not found\"}"
-    http_version: 
+    http_version:
   recorded_at: Mon, 20 Jun 2016 22:39:11 GMT
 recorded_with: VCR 2.9.3

data/spec/lib/moodle_rb/categories_spec.rb

@@ -1,12 +1,12 @@
 require 'spec_helper'
 
 describe MoodleRb::Categories do
-  let(:url) { ENV['MOODLE_URL'] || 'localhost' }
-  let(:token) { ENV['MOODLE_TOKEN'] || '' }
+  let(:url) { ENV['MOODLE_URL'] || 'localhost:8888/moodle28' }
+  let(:token) { ENV['MOODLE_TOKEN'] || '60fc9c9415259404795094957e4ab32f' }
   let(:category_moodle_rb) { MoodleRb.new(token, url).categories }
 
   describe '#index', :vcr => {
-    :match_requests_on => [:body, :headers], :record => :once
+    :match_requests_on => [:body, :path], :record => :once
   } do
     let(:result) { category_moodle_rb.index }
 
@@ -27,7 +27,7 @@ describe MoodleRb::Categories do
   end
 
   describe '#create', :vcr => {
-    :match_requests_on => [:headers], :record => :once
+    :match_requests_on => [:path], :record => :once
   } do
     let(:params) do
       {
@@ -60,7 +60,7 @@ describe MoodleRb::Categories do
   end
 
   describe '#show', :vcr => {
-    :match_requests_on => [:headers], :record => :once
+    :match_requests_on => [:path], :record => :once
   } do
     let(:id) { 1 }
     let(:result) { category_moodle_rb.show(id) }
@@ -82,7 +82,7 @@ describe MoodleRb::Categories do
   end
 
   describe '#destroy', :vcr => {
-    :match_requests_on => [:headers], :record => :once
+    :match_requests_on => [:path], :record => :once
   } do
     context 'when using valid token' do
       let!(:id) { category_moodle_rb.create(:name => '_')['id'] }

data/spec/lib/moodle_rb/client_spec.rb

@@ -1,12 +1,12 @@
 require 'spec_helper'
 
 describe MoodleRb::Client do
-  let(:url) { ENV['MOODLE_URL'] || 'localhost' }
-  let(:token) { ENV['MOODLE_TOKEN'] || '' }
+  let(:url) { ENV['MOODLE_URL'] || 'localhost:8888/moodle28' }
+  let(:token) { ENV['MOODLE_TOKEN'] || '60fc9c9415259404795094957e4ab32f' }
   let(:moodle_rb) { MoodleRb.new(token, url) }
 
   describe '#site_info', :vcr => {
-    :match_requests_on => [:body, :headers], :record => :once
+    :match_requests_on => [:body, :path], :record => :once
   } do
     let(:result) { moodle_rb.site_info }
 

data/spec/lib/moodle_rb/courses_spec.rb

@@ -1,20 +1,22 @@
 require 'spec_helper'
 
 describe MoodleRb::Courses do
-  let(:url) { ENV['MOODLE_URL'] || 'localhost' }
-  let(:token) { ENV['MOODLE_TOKEN'] || '' }
+  let(:url) { ENV['MOODLE_URL'] || 'localhost:8888/moodle28' }
+  let(:token) { ENV['MOODLE_TOKEN'] || '60fc9c9415259404795094957e4ab32f' }
   let(:course_moodle_rb) { MoodleRb.new(token, url).courses }
   let(:params) do
     {
       :full_name => 'Test Course',
       :short_name => 'TestC1',
       :parent_category => 1,
-      :idnumber => 'ExtRef'
+      :idnumber => 'ExtRef',
+      :start_date => 1646312400,
+      :end_date => 1646398800
     }
   end
 
   describe '#index', :vcr => {
-    :match_requests_on => [:body, :headers], :record => :once
+    :match_requests_on => [:body, :path], :record => :once
   } do
     let(:result) { course_moodle_rb.index }
 
@@ -35,7 +37,7 @@ describe MoodleRb::Courses do
   end
 
   describe '#create', :vcr => {
-    :match_requests_on => [:headers], :record => :once
+    :match_requests_on => [:path], :record => :once
   } do
     let(:result) { course_moodle_rb.create(params) }
 
@@ -60,7 +62,7 @@ describe MoodleRb::Courses do
   end
 
   describe '#show', :vcr => {
-    :match_requests_on => [:headers], :record => :once
+    :match_requests_on => [:path], :record => :once
   } do
     let(:id) { 1 }
     let(:result) { course_moodle_rb.show(id) }
@@ -82,7 +84,7 @@ describe MoodleRb::Courses do
   end
 
   describe '#destroy', :vcr => {
-    :match_requests_on => [:headers], :record => :once
+    :match_requests_on => [:path], :record => :once
   } do
     context 'when using valid token' do
       let(:id) { course_moodle_rb.create(params)['id'] }
@@ -117,7 +119,7 @@ describe MoodleRb::Courses do
   end
 
   describe '#enrolled_users', :vcr => {
-    :match_requests_on => [:headers], :record => :once
+    :match_requests_on => [:path], :record => :once
   } do
     let(:course_id) { 8 }
 
@@ -146,4 +148,82 @@ describe MoodleRb::Courses do
       end
     end
   end
+
+  describe '#grade_items', :vcr => {
+    :match_requests_on => [:path], :record => :once
+  } do
+    let(:course_id) { 5 }
+
+    context 'when using valid token' do
+      let(:result) { course_moodle_rb.grade_items(course_id) }
+      let(:user_grades) { result.first }
+
+      specify do
+        expect(result).to be_a Array
+        expect(user_grades).to have_key 'gradeitems'
+      end
+    end
+
+    context 'when using invalid token' do
+      let(:token) { '' }
+      specify do
+        expect{ course_moodle_rb.grade_items(course_id) }.to raise_error(
+          MoodleRb::MoodleError,
+          'Invalid token - token not found'
+        )
+      end
+    end
+  end
+
+  describe '#contents', :vcr => {
+    :match_requests_on => [:path], :record => :once
+  } do
+    let(:course_id) { 5 }
+
+    context 'when using valid token' do
+      let(:result) { course_moodle_rb.contents(course_id) }
+      let(:enrolment) { result.first }
+
+      specify do
+        expect(result).to be_a Hash
+        expect(result).to have_key 'modules'
+      end
+    end
+
+    context 'when using invalid token' do
+      let(:token) { '' }
+      specify do
+        expect{ course_moodle_rb.contents(course_id) }.to raise_error(
+          MoodleRb::MoodleError,
+          'Invalid token - token not found'
+        )
+      end
+    end
+  end
+
+  describe '#module', :vcr => {
+    :match_requests_on => [:path], :record => :once
+  } do
+    let(:course_module_id) { 21 }
+
+    context 'when using valid token' do
+      let(:result) { course_moodle_rb.module(course_module_id) }
+
+      specify do
+        expect(result).to be_a Hash
+        expect(result).to have_key 'name'
+        expect(result).to have_key 'gradepass'
+      end
+    end
+
+    context 'when using invalid token' do
+      let(:token) { '' }
+      specify do
+        expect{ course_moodle_rb.module(course_module_id) }.to raise_error(
+          MoodleRb::MoodleError,
+          'Invalid token - token not found'
+        )
+      end
+    end
+  end
 end

data/spec/lib/moodle_rb/enrolments_spec.rb

@@ -1,17 +1,19 @@
 require 'spec_helper'
 
 describe MoodleRb::Enrolments do
-  let(:url) { ENV['MOODLE_URL'] || 'localhost' }
-  let(:token) { ENV['MOODLE_TOKEN'] || '' }
+  let(:url) { ENV['MOODLE_URL'] || 'localhost:8888/moodle28' }
+  let(:token) { ENV['MOODLE_TOKEN'] || '60fc9c9415259404795094957e4ab32f' }
   let(:enrolment_moodle_rb) { MoodleRb.new(token, url).enrolments }
 
   describe '#create', :vcr => {
-    :match_requests_on => [:headers], :record => :once
+    :match_requests_on => [:path], :record => :once
   } do
     let(:params) do
       {
         :user_id => 3,
-        :course_id => 8
+        :course_id => 8,
+        :time_start => 1646312400,
+        :time_end => 1646398800
       }
     end
     let(:result) { enrolment_moodle_rb.create(params) }
@@ -36,4 +38,37 @@ describe MoodleRb::Enrolments do
       end
     end
   end
+
+  describe '#destroy', :vcr => {
+    :match_requests_on => [:path], :record => :once
+  } do
+    let(:params) do
+      {
+        :user_id => '7',
+        :course_id => '5'
+      }
+    end
+
+    let(:result) { enrolment_moodle_rb.destroy(params) }
+
+    specify do
+      expect(result).to eq true
+    end
+
+    context 'when user or course id is invalid' do
+      let(:params) do
+        {
+          :user_id => 9999,
+          :course_id => 9999
+        }
+      end
+
+      specify do
+        expect{ result }.to raise_error(
+          MoodleRb::MoodleError,
+          "Can't find data record in database table course."
+        )
+      end
+    end
+  end
 end

data/spec/lib/moodle_rb/grades_spec.rb

@@ -1,12 +1,12 @@
 require 'spec_helper'
 
 describe MoodleRb::Grades do
-  let(:url) { ENV['MOODLE_URL'] || 'localhost' }
-  let(:token) { ENV['MOODLE_TOKEN'] || '' }
+  let(:url) { ENV['MOODLE_URL'] || 'localhost:8888/moodle28' }
+  let(:token) { ENV['MOODLE_TOKEN'] || '60fc9c9415259404795094957e4ab32f' }
   let(:grade_moodle_rb) { MoodleRb.new(token, url).grades }
 
   describe '#by_assignment', :vcr => {
-    :match_requests_on => [:body, :headers], :record => :once
+    :match_requests_on => [:path], :record => :once
   } do
     let(:assignment_id) { 1 }
     let(:result) { grade_moodle_rb.by_assignment(assignment_id) }
@@ -18,7 +18,7 @@ describe MoodleRb::Grades do
   end
 
   describe '#by_course', :vcr => {
-    :match_requests_on => [:headers], :record => :once
+    :match_requests_on => [:path], :record => :once
   } do
     let(:course_id) { 8 }
     let(:user_ids) { 5 }

data/spec/lib/moodle_rb/users_spec.rb

@@ -1,12 +1,12 @@
 require 'spec_helper'
 
 describe MoodleRb::Users do
-  let(:url) { ENV['MOODLE_URL'] || 'localhost' }
-  let(:token) { ENV['MOODLE_TOKEN'] || '' }
+  let(:url) { ENV['MOODLE_URL'] || 'localhost:8888/moodle28' }
+  let(:token) { ENV['MOODLE_TOKEN'] || '60fc9c9415259404795094957e4ab32f' }
   let(:user_moodle_rb) { MoodleRb.new(token, url).users }
 
   describe '#create', :vcr => {
-    :match_requests_on => [:headers], :record => :once
+    :match_requests_on => [:path], :record => :once
   } do
     let(:params) do
       {
@@ -43,7 +43,7 @@ describe MoodleRb::Users do
   end
 
   describe '#show', :vcr => {
-    :match_requests_on => [:headers], :record => :once
+    :match_requests_on => [:path], :record => :once
   } do
     let(:id) { 5 }
     let(:result) { user_moodle_rb.show(id) }
@@ -65,7 +65,7 @@ describe MoodleRb::Users do
   end
 
   describe '#destroy', :vcr => {
-    :match_requests_on => [:headers], :record => :once
+    :match_requests_on => [:path], :record => :once
   } do
     let(:id) { 5 }
     let(:result) { user_moodle_rb.destroy(id) }
@@ -96,7 +96,7 @@ describe MoodleRb::Users do
   end
 
   describe '#enrolled_courses', :vcr => {
-    :match_requests_on => [:headers], :record => :once
+    :match_requests_on => [:path], :record => :once
   } do
     let(:user_id) { 3 }
     let(:result) { user_moodle_rb.enrolled_courses(user_id) }
@@ -119,7 +119,7 @@ describe MoodleRb::Users do
   end
 
   describe '#search', :vcr => {
-    :match_requests_on => [:headers], :record => :once
+    :match_requests_on => [:path], :record => :once
   } do
     let(:results) { user_moodle_rb.search({ :firstname => 'Guest%' }) }
 
@@ -140,8 +140,37 @@ describe MoodleRb::Users do
     end
   end
 
+  describe '#search_identity', :vcr => {
+    :match_requests_on => [:path], :record => :once
+  } do
+    let(:results) { user_moodle_rb.search_identity('moodle_student@mailinator.com') }
+
+    specify do
+      expect(results).to be_a Array
+      expect(results.first).to be_a Hash
+      expect(results.first['id']).to eq 25
+      expect(results.first['fullname']).to eq 'Moodle Student'
+      expect(results.first['extrafields'].first['name']).to eq 'idnumber'
+      expect(results.first['extrafields'].first['value']).to eq 'MS01'
+      expect(results.first['extrafields'].last['name']).to eq 'email'
+      expect(results.first['extrafields'].last['value']).to eq 'moodle_student@mailinator.com'
+    end
+
+    context 'when using invalid token' do
+      let(:token) { '' }
+      specify do
+        expect do
+          user_moodle_rb.search_identity('moodle_student@mailinator.com')
+        end.to raise_error(
+          MoodleRb::MoodleError,
+          'Invalid token - token not found'
+        )
+      end
+    end
+  end
+
   describe '#update', :vcr => {
-    :match_requests_on => [:headers], :record => :once
+    :match_requests_on => [:path], :record => :once
   } do
     let(:user_id) { 4 }
     let(:result) do

data/spec/lib/moodle_rb_spec.rb

@@ -1,8 +1,8 @@
 require 'spec_helper'
 
 describe MoodleRb do
-  let(:url) { ENV['MOODLE_URL'] || 'localhost' }
-  let(:token) { ENV['MOODLE_TOKEN'] || '' }
+  let(:url) { ENV['MOODLE_URL'] || 'localhost:8888/moodle28' }
+  let(:token) { ENV['MOODLE_TOKEN'] || '60fc9c9415259404795094957e4ab32f' }
   let(:moodle_rb) { MoodleRb.new(token, url) }
 
   describe 'new' do