moodle_rb 1.1.3 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3fdbc847a70cefe6a1641ceebba2f874b8ab8d1459aa475c23d8f1ae70ef4c11
-  data.tar.gz: 7e4034e714f6ca67e92a928bc9ae323e22b48042d4ebbfbab0bf401ec4a54cec
+  metadata.gz: ec5d80c43c0ed637457438c025e18d3c864a31cf24c5378e28a08a7169ef26c0
+  data.tar.gz: 1338a10d558a046135629df0982cd601fe938a127cb3f08e3648b7782eb49900
 SHA512:
-  metadata.gz: 1e7300716079888fed475a6dea164997ceb375fec6b870370064d88ac8a3a9821a63a63e73579bdf621b63563bfb95e3c33c2be309ecdc6863eda0e7fbf89e5b
-  data.tar.gz: f2613f30e5676831a666a76f8e54cde9e5a2c4b939ab00972833a0c200d86ddd502c50c200fc982ab0c9373b296e47f62b98ddfc525b0ca7dd2cd8df2b275a12
+  metadata.gz: 4669abc20c8fd9749793ae2b3af6359a8a5f908d02607dc84788b45f407dc65688c99aa23a336f0e485bb10fbcbc07b2577e131211a954367fe883b09298f387
+  data.tar.gz: c7cb780a9a535cbb6fe589a2b2d1945deb356ca8afc54ce112a362cbecfdd20bc59208bef8ad87b41b5b1f096ad9d49f782e2e6a62520db6dda824201b2e0d52

data/README.md

@@ -28,7 +28,9 @@ moodle.courses.create(
   :full_name => 'My Course',
   :short_name => 'MyC',
   :parent_category => 5,
-  :idnumber => 'ExtRef'
+  :idnumber => 'ExtRef',
+  :startdate => 1646312400,
+  :enddate => 1646398800
 )
 ```
 
@@ -37,6 +39,11 @@ List all courses
 moodle.courses.index
 ```
 
+Search for a course by name
+```
+moodle.courses.search('My course')
+```
+
 Show a course
 ```
 moodle.courses.show(course_id)
@@ -92,7 +99,9 @@ Create a student enrolment
 ```
 moodle.enrolments.create(
   :user_id => user_id,
-  :course_id => course_id
+  :course_id => course_id,
+  :time_start => 1646312400,
+  :time_end => 1646398800
 )
 ```
 
@@ -101,7 +110,9 @@ Create a teacher enrolment
 moodle.enrolments.create(
   :user_id => user_id,
   :course_id => course_id,
-  :role_id => 3
+  :role_id => 3,
+  :timestart=> 1646312400,
+  :timeend=> 1646398800
 )
 ```
 

data/lib/moodle_rb/courses.rb

@@ -22,6 +22,21 @@ module MoodleRb
       response.parsed_response
     end
 
+    # Search courses by (name, module, block, tag)
+    def search(criteria_value, criteria_name = 'search')
+      response = self.class.get(
+        '/webservice/rest/server.php',
+        {
+          :query => query_hash('core_course_search_courses', token).merge({
+            :criterianame => criteria_name,
+            :criteriavalue => criteria_value
+          })
+        }.merge(query_options)
+      )
+      check_for_errors(response)
+      response.parsed_response
+    end
+
     # required params:
     # full_name
     # short_name
@@ -42,8 +57,10 @@ module MoodleRb
                 :fullname => params[:full_name],
                 :shortname => params[:short_name],
                 :categoryid => params[:parent_category],
-                :idnumber => params[:idnumber]
-              }
+                :idnumber => params[:idnumber],
+                :startdate => params[:start_date],
+                :enddate => params[:end_date]
+              }.select {|k, v| v }
             }
           }
         }.merge(query_options)
@@ -127,7 +144,7 @@ module MoodleRb
         }.merge(query_options)
       )
       check_for_errors(response)
-      response.parsed_response[0]
+      response.parsed_response
     end
 
     def module(course_module_id)

data/lib/moodle_rb/enrolments.rb

@@ -27,8 +27,10 @@ module MoodleRb
               '0' => {
                 :userid => params[:user_id],
                 :courseid => params[:course_id],
-                :roleid => params[:role_id] || STUDENT_ROLE_ID
-              }
+                :roleid => params[:role_id] || STUDENT_ROLE_ID,
+                :timestart => params[:time_start],
+                :timeend => params[:time_end]
+              }.select {|k, v| v }
             }
           }
         }.merge(query_options)

data/lib/moodle_rb/version.rb

@@ -1,5 +1,5 @@
 module MoodleRb
-  VERSION = '1.1.3' unless defined?(self::VERSION)
+  VERSION = '2.1.0' unless defined?(self::VERSION)
 
   def self.version
     VERSION

data/spec/cassettes/MoodleRb_Courses/_search/.yml

@@ -0,0 +1,102 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://localhost:8888/moodle28/webservice/rest/server.php?criterianame=search&criteriavalue=My%20course&moodlewsrestformat=json&wsfunction=core_course_search_courses&wstoken=60fc9c9415259404795094957e4ab32f
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Accept-Ranges:
+      - bytes
+      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:
+      - Wed, 11 May 2022 03:43:20 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-Powered-By:
+      - Moodle Ninjas
+      Content-Length:
+      - '3946'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: '{"total":1,"courses":[{"id":316,"fullname":"My large course","displayname":"My
+        large course","shortname":"MLC","categoryid":8,"categoryname":"VETtrak testing","sortorder":50002,"summary":"Test
+        course 1<br \/>\nLorem ipsum dolor sit amet, consectetuer adipiscing elit.
+        Nulla non arcu lacinia neque faucibus fringilla. Vivamus porttitor turpis
+        ac leo. Integer in sapien. Nullam eget nisl. Aliquam erat volutpat. Cras elementum.
+        Mauris suscipit, ligula sit amet pharetra semper, nibh ante cursus purus,
+        vel sagittis velit mauris vel metus. Integer malesuada. Nullam lectus justo,
+        vulputate eget mollis sed, tempor sed magna. Mauris elementum mauris vitae
+        tortor. Aliquam erat volutpat.<br \/>\nTemporibus autem quibusdam et aut officiis
+        debitis aut rerum necessitatibus saepe eveniet ut et voluptates repudiandae
+        sint et molestiae non recusandae. Pellentesque ipsum. Cras pede libero, dapibus
+        nec, pretium sit amet, tempor quis. Aliquam ante. Proin in tellus sit amet
+        nibh dignissim sagittis. Vivamus porttitor turpis ac leo. Duis bibendum, lectus
+        ut viverra rhoncus, dolor nunc faucibus libero, eget facilisis enim ipsum
+        id lacus. In sem justo, commodo ut, suscipit at, pharetra vitae, orci. Aliquam
+        erat volutpat. Nulla est.<br \/>\nVivamus luctus egestas leo. Aenean fermentum
+        risus id tortor. Mauris dictum facilisis augue. Aliquam erat volutpat. Aliquam
+        ornare wisi eu metus. Aliquam id dolor. Duis condimentum augue id magna semper
+        rutrum. Donec iaculis gravida nulla. Pellentesque ipsum. Etiam dictum tincidunt
+        diam. Quisque tincidunt scelerisque libero. Etiam egestas wisi a erat.<br
+        \/>\nInteger lacinia. Cum sociis natoque penatibus et magnis dis parturient
+        montes, nascetur ridiculus mus. Mauris tincidunt sem sed arcu. Nullam feugiat,
+        turpis at pulvinar vulputate, erat libero tristique tellus, nec bibendum odio
+        risus sit amet ante. Aliquam id dolor. Maecenas sollicitudin. Et harum quidem
+        rerum facilis est et expedita distinctio. Mauris suscipit, ligula sit amet
+        pharetra semper, nibh ante cursus purus, vel sagittis velit mauris vel metus.
+        Nullam dapibus fermentum ipsum. Pellentesque habitant morbi tristique senectus
+        et netus et malesuada fames ac turpis egestas. Nemo enim ipsam voluptatem
+        quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni
+        dolores eos qui ratione voluptatem sequi nesciunt. Pellentesque sapien. Duis
+        risus. Mauris elementum mauris vitae tortor. Suspendisse nisl. Integer rutrum,
+        orci vestibulum ullamcorper ultricies, lacus quam ultricies odio, vitae placerat
+        pede sem sit amet enim.<br \/>\nIn laoreet, magna id viverra tincidunt, sem
+        odio bibendum justo, vel imperdiet sapien wisi sed libero. Proin pede metus,
+        vulputate nec, fermentum fringilla, vehicula vitae, justo. Nullam justo enim,
+        consectetuer nec, ullamcorper ac, vestibulum in, elit. Quis autem vel eum
+        iure reprehenderit qui in ea voluptate velit esse quam nihil molestiae consequatur,
+        vel illum qui dolorem eum fugiat quo voluptas nulla pariatur? Maecenas lorem.
+        Etiam posuere lacus quis dolor. Class aptent taciti sociosqu ad litora torquent
+        per conubia nostra, per inceptos hymenaeos. Curabitur ligula sapien, pulvinar
+        a vestibulum quis, facilisis vel sapien. Nam sed tellus id magna elementum
+        tincidunt. Suspendisse nisl. Vivamus luctus egestas leo. Nulla non arcu lacinia
+        neque faucibus fringilla. Etiam dui sem, fermentum vitae, sagittis id, malesuada
+        in, quam. Etiam dictum tincidunt diam. Etiam commodo dui eget wisi. Nemo enim
+        ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia
+        consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Proin
+        pede metus, vulputate nec, fermentum fringilla, vehicula vitae, justo. Duis
+        ante orci, molestie vitae vehicula venenatis, tincidunt ac pede. Pellentesque
+        sapien.","summaryformat":1,"summaryfiles":[],"overviewfiles":[],"showactivitydates":true,"showcompletionconditions":true,"contacts":[],"enrollmentmethods":["manual"]}],"warnings":[]}'
+    http_version: 
+  recorded_at: Wed, 11 May 2022 03:42:46 GMT
+recorded_with: VCR 2.9.3

data/spec/cassettes/MoodleRb_Courses/_search/when_using_invalid_token/.yml

@@ -0,0 +1,55 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://localhost:8888/moodle28/webservice/rest/server.php?criterianame=search&criteriavalue=My%20course&moodlewsrestformat=json&wsfunction=core_course_search_courses&wstoken=
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Accept-Ranges:
+      - bytes
+      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:
+      - Wed, 11 May 2022 03:43:20 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-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: Wed, 11 May 2022 03:42:46 GMT
+recorded_with: VCR 2.9.3

data/spec/lib/moodle_rb/courses_spec.rb

@@ -9,7 +9,9 @@ describe MoodleRb::Courses do
       :full_name => 'Test Course',
       :short_name => 'TestC1',
       :parent_category => 1,
-      :idnumber => 'ExtRef'
+      :idnumber => 'ExtRef',
+      :start_date => 1646312400,
+      :end_date => 1646398800
     }
   end
 
@@ -34,6 +36,27 @@ describe MoodleRb::Courses do
     end
   end
 
+  describe '#search', :vcr => {
+    :match_requests_on => [:body, :path], :record => :once
+  } do
+    let(:result) { course_moodle_rb.search('My course') }
+
+    specify do
+      expect(result["total"]).to eq 1
+      expect(result["courses"]).to be_a Array
+    end
+
+    context 'when using invalid token' do
+      let(:token) { '' }
+      specify do
+        expect{ course_moodle_rb.search('My course') }.to raise_error(
+          MoodleRb::MoodleError,
+          'Invalid token - token not found'
+        )
+      end
+    end
+  end
+
   describe '#create', :vcr => {
     :match_requests_on => [:path], :record => :once
   } do
@@ -183,8 +206,8 @@ describe MoodleRb::Courses do
       let(:enrolment) { result.first }
 
       specify do
-        expect(result).to be_a Hash
-        expect(result).to have_key 'modules'
+        expect(result).to be_a Array
+        expect(result[0]).to have_key 'modules'
       end
     end
 

data/spec/lib/moodle_rb/enrolments_spec.rb

@@ -11,7 +11,9 @@ describe MoodleRb::Enrolments 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) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: moodle_rb
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 2.1.0
 platform: ruby
 authors:
 - Sam Giffney
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-14 00:00:00.000000000 Z
+date: 2022-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -147,6 +147,8 @@ files:
 - spec/cassettes/MoodleRb_Courses/_index/when_using_invalid_token/.yml
 - spec/cassettes/MoodleRb_Courses/_module/when_using_invalid_token/.yml
 - spec/cassettes/MoodleRb_Courses/_module/when_using_valid_token/.yml
+- spec/cassettes/MoodleRb_Courses/_search/.yml
+- spec/cassettes/MoodleRb_Courses/_search/when_using_invalid_token/.yml
 - spec/cassettes/MoodleRb_Courses/_show/.yml
 - spec/cassettes/MoodleRb_Courses/_show/when_using_invalid_token/.yml
 - spec/cassettes/MoodleRb_Enrolments/_create/.yml
@@ -230,6 +232,8 @@ test_files:
 - spec/cassettes/MoodleRb_Courses/_index/when_using_invalid_token/.yml
 - spec/cassettes/MoodleRb_Courses/_module/when_using_invalid_token/.yml
 - spec/cassettes/MoodleRb_Courses/_module/when_using_valid_token/.yml
+- spec/cassettes/MoodleRb_Courses/_search/.yml
+- spec/cassettes/MoodleRb_Courses/_search/when_using_invalid_token/.yml
 - spec/cassettes/MoodleRb_Courses/_show/.yml
 - spec/cassettes/MoodleRb_Courses/_show/when_using_invalid_token/.yml
 - spec/cassettes/MoodleRb_Enrolments/_create/.yml