moodle_rb 1.0.2 → 1.1.3

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

@@ -0,0 +1,39 @@
+---
+http_interactions:
+- request:
+    method: post
+    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:
+      code: 200
+      message: OK
+    headers:
+      X-Powered-By:
+      - PHP/5.6.2
+      Accept-Ranges:
+      - none
+      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:
+      - no-cache
+      Content-Type:
+      - application/json
+      Access-Control-Allow-Origin:
+      - "*"
+      Expires:
+      - Thu, 01 Jan 1970 00:00:00 GMT
+      Date:
+      - Mon, 20 Jun 2016 22:39:11 GMT
+      Cache-Control:
+      - private, must-revalidate, pre-check=0, post-check=0, max-age=0
+      Content-Length:
+      - "103"
+    body:
+      string: "{\"exception\":\"moodle_exception\",\"errorcode\":\"invalidtoken\",\"message\":\"Invalid token - token not found\"}"
+    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 }
 
@@ -14,10 +14,20 @@ describe MoodleRb::Categories do
       expect(result).to be_a Array
       expect(result.first).to have_key 'id'
     end
+
+    context 'when using invalid token' do
+      let(:token) { '' }
+      specify do
+        expect{ category_moodle_rb.index }.to raise_error(
+          MoodleRb::MoodleError,
+          'Invalid token - token not found'
+        )
+      end
+    end
   end
 
   describe '#create', :vcr => {
-    :match_requests_on => [:headers], :record => :once
+    :match_requests_on => [:path], :record => :once
   } do
     let(:params) do
       {
@@ -50,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) }
@@ -59,16 +69,38 @@ describe MoodleRb::Categories do
       expect(result).to be_a Hash
       expect(result['id']).to eq 1
     end
+
+    context 'when using invalid token' do
+      let(:token) { '' }
+      specify do
+        expect{ category_moodle_rb.show(id) }.to raise_error(
+          MoodleRb::MoodleError,
+          'Invalid token - token not found'
+        )
+      end
+    end
   end
 
   describe '#destroy', :vcr => {
-    :match_requests_on => [:headers], :record => :once
+    :match_requests_on => [:path], :record => :once
   } do
-    let!(:id) { category_moodle_rb.create(:name => '_')['id'] }
-    let(:result) { category_moodle_rb.destroy(id) }
+    context 'when using valid token' do
+      let!(:id) { category_moodle_rb.create(:name => '_')['id'] }
+      let(:result) { category_moodle_rb.destroy(id) }
 
-    specify do
-      expect(result).to eq true
+      specify do
+        expect(result).to eq true
+      end
+    end
+
+    context 'when using invalid token' do
+      let(:token) { '' }
+      specify do
+        expect{ category_moodle_rb.destroy(0) }.to raise_error(
+          MoodleRb::MoodleError,
+          'Invalid token - token not found'
+        )
+      end
     end
   end
 end

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 }
 
@@ -14,8 +14,10 @@ describe MoodleRb::Client do
       let(:token) { 'invalid_moodle_rb_token' }
 
       specify do
-        expect(result).to be_a Hash
-        expect(result['errorcode']).to eq 'invalidtoken'
+        expect{ result }.to raise_error(
+          MoodleRb::MoodleError,
+          'Invalid token - token not found'
+        )
       end
     end
 

data/spec/lib/moodle_rb/courses_spec.rb

@@ -1,8 +1,8 @@
 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
     {
@@ -14,7 +14,7 @@ describe MoodleRb::Courses do
   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 }
 
@@ -22,10 +22,20 @@ describe MoodleRb::Courses do
       expect(result).to be_a Array
       expect(result.first).to have_key 'id'
     end
+
+    context 'when using invalid token' do
+      let(:token) { '' }
+      specify do
+        expect{ course_moodle_rb.index }.to raise_error(
+          MoodleRb::MoodleError,
+          'Invalid token - token not found'
+        )
+      end
+    end
   end
 
   describe '#create', :vcr => {
-    :match_requests_on => [:headers], :record => :once
+    :match_requests_on => [:path], :record => :once
   } do
     let(:result) { course_moodle_rb.create(params) }
 
@@ -50,7 +60,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) }
@@ -59,34 +69,159 @@ describe MoodleRb::Courses do
       expect(result).to be_a Hash
       expect(result['id']).to eq 1
     end
+
+    context 'when using invalid token' do
+      let(:token) { '' }
+      specify do
+        expect{ course_moodle_rb.show(id) }.to raise_error(
+          MoodleRb::MoodleError,
+          'Invalid token - token not found'
+        )
+      end
+    end
   end
 
   describe '#destroy', :vcr => {
-    :match_requests_on => [:headers], :record => :once
+    :match_requests_on => [:path], :record => :once
   } do
-    let(:id) { course_moodle_rb.create(params)['id'] }
-    let(:result) { course_moodle_rb.destroy(id) }
+    context 'when using valid token' do
+      let(:id) { course_moodle_rb.create(params)['id'] }
+      let(:result) { course_moodle_rb.destroy(id) }
 
-    specify do
-      expect(result).to eq true
+      specify do
+          expect(result).to be_a Hash
+          expect(result['warnings']).to be_a Array
+          expect(result['warnings']).to be_empty
+      end
+
+      context 'when using invalid course id' do
+        let(:result) { course_moodle_rb.destroy(-1) }
+
+        specify do
+          expect(result).to be_a Hash
+          expect(result['warnings']).to be_a Array
+          expect(result['warnings'][0]['warningcode']).to eq 'unknowncourseidnumber'
+        end
+      end
+    end
+
+    context 'when using invalid token' do
+      let(:token) { '' }
+      specify do
+        expect{ course_moodle_rb.destroy(-1) }.to raise_error(
+          MoodleRb::MoodleError,
+          'Invalid token - token not found'
+        )
+      end
     end
   end
 
   describe '#enrolled_users', :vcr => {
-    :match_requests_on => [:headers], :record => :once
+    :match_requests_on => [:path], :record => :once
   } do
     let(:course_id) { 8 }
-    let!(:enrolled_user) do
-      MoodleRb.new(token, url).enrolments.create(
-        :user_id => 3, :course_id => course_id)
+
+    context 'when using valid token' do
+      let!(:enrolled_user) do
+        MoodleRb.new(token, url).enrolments.create(
+          :user_id => 3, :course_id => course_id)
+      end
+      let(:result) { course_moodle_rb.enrolled_users(course_id) }
+      let(:enrolment) { result.first }
+
+      specify do
+        expect(result).to be_a Array
+        expect(enrolment).to have_key 'id'
+        expect(enrolment).to have_key 'enrolledcourses'
+      end
     end
-    let(:result) { course_moodle_rb.enrolled_users(course_id) }
-    let(:enrolment) { result.first }
 
-    specify do
-      expect(result).to be_a Array
-      expect(enrolment).to have_key 'id'
-      expect(enrolment).to have_key 'enrolledcourses'
+    context 'when using invalid token' do
+      let(:token) { '' }
+      specify do
+        expect{ course_moodle_rb.enrolled_users(course_id) }.to raise_error(
+          MoodleRb::MoodleError,
+          'Invalid token - token not found'
+        )
+      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,12 +1,12 @@
 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
       {
@@ -36,4 +36,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) }
@@ -52,10 +52,20 @@ describe MoodleRb::Users do
       expect(result).to be_a Hash
       expect(result['id']).to eq 5
     end
+
+    context 'when using invalid token' do
+      let(:token) { '' }
+      specify do
+        expect{ user_moodle_rb.show(id) }.to raise_error(
+          MoodleRb::MoodleError,
+          'Invalid token - token not found'
+        )
+      end
+    end
   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) }
@@ -67,13 +77,26 @@ describe MoodleRb::Users do
     context 'when id does not exist' do
       let(:id) { 999 }
       specify do
-        expect(result).to eq false
+        expect{ result }.to raise_error(
+          MoodleRb::MoodleError,
+          'Invalid user'
+        )
+      end
+    end
+
+    context 'when using invalid token' do
+      let(:token) { '' }
+      specify do
+        expect{ user_moodle_rb.destroy(-1) }.to raise_error(
+          MoodleRb::MoodleError,
+          'Invalid token - token not found'
+        )
       end
     end
   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) }
@@ -83,10 +106,20 @@ describe MoodleRb::Users do
       expect(result).to be_a Array
       expect(enrolment).to have_key 'shortname'
     end
+
+    context 'when using invalid token' do
+      let(:token) { '' }
+      specify do
+        expect{ user_moodle_rb.enrolled_courses(user_id) }.to raise_error(
+          MoodleRb::MoodleError,
+          'Invalid token - token not found'
+        )
+      end
+    end
   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%' }) }
 
@@ -95,10 +128,49 @@ describe MoodleRb::Users do
       expect(results.first).to be_a Hash
       expect(results.first['firstname']).to eq 'Guest user'
     end
+
+    context 'when using invalid token' do
+      let(:token) { '' }
+      specify do
+        expect{ user_moodle_rb.search({ :firstname => '%' }) }.to raise_error(
+          MoodleRb::MoodleError,
+          'Invalid token - token not found'
+        )
+      end
+    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
@@ -108,5 +180,17 @@ describe MoodleRb::Users do
     specify do
       expect(result).to eq true
     end
+
+    context 'when using invalid token' do
+      let(:token) { '' }
+      specify do
+        expect do
+          user_moodle_rb.update(:id => user_id, :email => '')
+        end.to raise_error(
+          MoodleRb::MoodleError,
+          'Invalid token - token not found'
+        )
+      end
+    end
   end
 end