moodle_rb 1.0.4 → 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c24b87d882e5df0daac0aef1915eea376a0870c8f01b2472166ea8774f63e207
+  data.tar.gz: 1deb290c7d76b1b29ffd84d8b62d8c20d8c5992a8aa2fb9c6b56b1362bd67145
+SHA512:
+  metadata.gz: 0c061f236ff7982cc418458c88c37f00890b1f84982e1f33335905fdccb50198fa7fa5b13205e3f548fd067b2314f2f3403df5b24053e36056dcfc0ef8bebc61
+  data.tar.gz: a0a7d9d39cda28af8c4aa12a56f3850a2cfe198406c95934c4e87af1e1ae14ebf5867213ab6c1bb0b8685f104d1984938098d0bcc496b465d590b12ad0d4d31b

data/.github/workflows/build.yml

@@ -0,0 +1,36 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Build
+
+on:
+  push:
+    branches: [ develop ]
+  pull_request:
+    branches: [ develop ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.3']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler: 1.17.3
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rspec spec

data/.github/workflows/publish.yml

@@ -0,0 +1,27 @@
+name: Publish
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.7
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '2.7'
+
+    - name: Publish to RubyGems
+      run: |
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/Dockerfile

@@ -0,0 +1,10 @@
+FROM ruby:2.3-slim
+
+RUN apt-get update -y && apt-get install -y git
+
+WORKDIR /app
+ADD . .
+RUN bundle install
+
+# ENV MOODLE_URL=http://localhost:8888/moodle29/
+# ENV MOODLE_TOKEN=87b95af2df709fa60b395b5c59a3fc2e

data/README.md

@@ -1,4 +1,9 @@
 # MoodleRb
+
+[![Build](https://github.com/jobready/moodle-rb/actions/workflows/build.yml/badge.svg)](https://github.com/jobready/moodle-rb/actions/workflows/build.yml) 
+
+[![Gem Version](https://badge.fury.io/rb/moodle_rb.svg)](https://badge.fury.io/rb/moodle_rb)
+
 A Ruby Client for the Moodle REST API.
 
 https://docs.moodle.org/dev/Web_services#Developer_documentation
@@ -23,7 +28,9 @@ moodle.courses.create(
   :full_name => 'My Course',
   :short_name => 'MyC',
   :parent_category => 5,
-  :idnumber => 'ExtRef'
+  :idnumber => 'ExtRef',
+  :startdate => 1646312400,
+  :enddate => 1646398800
 )
 ```
 
@@ -42,6 +49,21 @@ Delete a course
 moodle.courses.destroy(course_id)
 ```
 
+Get course grades
+```
+moodle.courses.grade_items(course_id)
+```
+
+Get course contents
+```
+moodle.courses.contents(course_id)
+```
+
+Get course module
+```
+moodle.courses.module(course_module_id)
+```
+
 ### Categories
 
 Create a category
@@ -68,7 +90,7 @@ moodle.categories.destroy(category_id)
 
 ### Enrolments
 
-Create an enrolment
+Create a student enrolment
 ```
 moodle.enrolments.create(
   :user_id => user_id,
@@ -76,6 +98,25 @@ moodle.enrolments.create(
 )
 ```
 
+Create a teacher enrolment
+```
+moodle.enrolments.create(
+  :user_id => user_id,
+  :course_id => course_id,
+  :role_id => 3,
+  :timestart=> 1646312400,
+  :timeend=> 1646398800
+)
+```
+
+Delete an enrolment
+```
+moodle.enrolments.destroy(
+  :user_id => user_id,
+  :course_id => course_id
+)
+```
+
 View enrolled users by course
 ```
 moodle.courses.enrolled_users(course_id)
@@ -114,16 +155,51 @@ Search for a user
 moodle.users.search(:email => 'admin@localhost')
 ```
 
+Search for a user via identity
+```
+moodle.users.search_identity('admin@localhost')
+```
+
 Update a user
 ```
 moodle.users.update(:id => 4, :email => 'bwayne@wayneenterprises.com')
 ```
 
+## Development
+
+To start development, spin up a container
+
+```
+docker build -t moodle .
+```
+
+To run the test suite with docker
+
+
+```
+docker run -v "$(pwd):/app" --rm moodle rspec spec
+```
+
+Docker compose
+
+```
+docker-compose build
+docker-compose run app bundle exec rspec spec
+```
+
 ## Tests
 
+Tests must be written for new lines of code added as part of a pull request and the test suite must pass. If creating new cassettes, consider updating the hardcoded moodle token and url parameters throughout the suite. They can also be configured with environment variables.
+
 You will need to set some environment variables to create new cassettes. We build using MAMP https://www.mamp.info/en/ so it might be
 
 ```
 export MOODLE_URL=http://localhost:8888/moodle29/
 export MOODLE_TOKEN=87b95af2df709fa60b395b5c59a3fc2e
 ```
+
+## Deployment
+
+The gem is automatically published when a new release is created on github. If there is an issue or a new release is required, please contact one of the maintainers
+
+- Jordan Huizenga (jordan.huizenga@readytech.io)

data/docker-compose.yml

@@ -0,0 +1,6 @@
+version: '2'
+services:
+  app:
+    build: .
+    volumes:
+      - .:/app

data/lib/moodle_rb/courses.rb

@@ -42,8 +42,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)
@@ -99,5 +101,49 @@ module MoodleRb
       check_for_errors(response)
       response.parsed_response
     end
+
+    def grade_items(course_id, user_id=0, group_id=0)
+      response = self.class.post(
+        '/webservice/rest/server.php',
+        {
+          :query => query_hash('gradereport_user_get_grade_items', token),
+          :body => {
+            :courseid => course_id,
+            :userid => user_id,
+            :groupid => group_id
+          }
+        }.merge(query_options)
+      )
+      check_for_errors(response)
+      response.parsed_response['usergrades']
+    end
+
+    def contents(course_id)
+      response = self.class.post(
+        '/webservice/rest/server.php',
+        {
+          :query => query_hash('core_course_get_contents', token),
+          :body => {
+            :courseid => course_id
+          }
+        }.merge(query_options)
+      )
+      check_for_errors(response)
+      response.parsed_response[0]
+    end
+
+    def module(course_module_id)
+      response = self.class.post(
+        '/webservice/rest/server.php',
+        {
+          :query => query_hash('core_course_get_course_module', token),
+          :body => {
+            :cmid => course_module_id
+          }
+        }.merge(query_options)
+      )
+      check_for_errors(response)
+      response.parsed_response['cm']
+    end
   end
 end

data/lib/moodle_rb/enrolments.rb

@@ -5,6 +5,7 @@ module MoodleRb
 
     attr_reader :token, :query_options
     STUDENT_ROLE_ID = 5
+    TEACHER_ROLE_ID = 3
 
     def initialize(token, url, query_options)
       @token = token
@@ -14,6 +15,8 @@ module MoodleRb
 
     # required params:
     # user_id course_id
+    # optional params:
+    # role_id - defaults to student role id
     def create(params)
       response = self.class.post(
         '/webservice/rest/server.php',
@@ -24,7 +27,33 @@ module MoodleRb
               '0' => {
                 :userid => params[:user_id],
                 :courseid => params[:course_id],
-                :roleid => 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)
+      )
+      check_for_errors(response)
+      response.code == 200 && response.parsed_response.nil?
+    end
+
+    # required params:
+    # user_id course_id
+    # optional params:
+    # role_id - defaults to student role id
+    def destroy(params)
+      response = self.class.post(
+        '/webservice/rest/server.php',
+        {
+          :query => query_hash('enrol_manual_unenrol_users', token),
+          :body => {
+            :enrolments => {
+              '0' => {
+                :userid => params[:user_id],
+                :courseid => params[:course_id],
+                :roleid => params[:role_id] || STUDENT_ROLE_ID
               }
             }
           }

data/lib/moodle_rb/users.rb

@@ -98,6 +98,22 @@ module MoodleRb
       response.parsed_response['users']
     end
 
+    # Return list of users identities matching the given criteria in their name or other identity fields.
+    # Performs a partial match on id, idnumber, fullname, and email
+    def search_identity(search_query)
+      response = self.class.post(
+        '/webservice/rest/server.php',
+        {
+          :query => query_hash('core_user_search_identity', token),
+          :body => {
+            :query => search_query
+          }
+        }.merge(query_options)
+      )
+      check_for_errors(response)
+      response.parsed_response['list']
+    end
+
     # params must include the id of the user
     # it may include any other standard user attributes:
     # username, password, firstname, lastname, email ...

data/lib/moodle_rb/version.rb

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

data/moodle_rb.gemspec

@@ -17,11 +17,10 @@ Gem::Specification.new do |spec|
   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 'webmock', '~> 1.24.6'
   spec.add_development_dependency 'vcr', '~> 2.9'
 
-  spec.add_dependency 'httparty', '~> 0.11.0'
+  spec.add_dependency 'httparty', '>= 0.11.0'
 end

data/spec/cassettes/MoodleRb_Categories/_create/.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_course_create_categories&wstoken=60fc9c9415259404795094957e4ab32f
-    body: 
+    body:
       string: categories[0][description]=&categories[0][idnumber]=&categories[0][parent]=0&categories[0][name]=Test%20category
     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
-      Cache-Control: 
+      Cache-Control:
       - private, must-revalidate, pre-check=0, post-check=0, max-age=0
-      Pragma: 
+      Pragma:
       - no-cache
-      Date: 
+      Date:
       - Sun, 12 Apr 2015 00:40:13 GMT
-      Content-Type: 
+      Content-Type:
       - application/json
-      Expires: 
+      Expires:
       - Thu, 01 Jan 1970 00:00:00 GMT
-      Access-Control-Allow-Origin: 
+      Access-Control-Allow-Origin:
       - "*"
-      Content-Length: 
+      Content-Length:
       - "33"
-      X-Powered-By: 
+      X-Powered-By:
       - PHP/5.6.2
-      Accept-Ranges: 
+      Accept-Ranges:
       - none
-    body: 
+    body:
       string: "[{\"id\":5,\"name\":\"Test category\"}]"
-    http_version: 
+    http_version:
   recorded_at: Sun, 12 Apr 2015 00:40:13 GMT

data/spec/cassettes/MoodleRb_Categories/_create/when_validation_fails/.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_course_create_categories&wstoken=60fc9c9415259404795094957e4ab32f
-    body: 
+    body:
       string: categories[0][description]=&categories[0][idnumber]=CAT101&categories[0][parent]=0&categories[0][name]=Test%20category
     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
-      Cache-Control: 
+      Cache-Control:
       - private, must-revalidate, pre-check=0, post-check=0, max-age=0
-      Pragma: 
+      Pragma:
       - no-cache
-      Date: 
+      Date:
       - Sun, 12 Apr 2015 00:40:13 GMT
-      Content-Type: 
+      Content-Type:
       - application/json
-      Expires: 
+      Expires:
       - Thu, 01 Jan 1970 00:00:00 GMT
-      Access-Control-Allow-Origin: 
+      Access-Control-Allow-Origin:
       - "*"
-      Content-Length: 
+      Content-Length:
       - "127"
-      X-Powered-By: 
+      X-Powered-By:
       - PHP/5.6.2
-      Accept-Ranges: 
+      Accept-Ranges:
       - none
-    body: 
+    body:
       string: "{\"exception\":\"moodle_exception\",\"errorcode\":\"categoryidnumbertaken\",\"message\":\"ID number is already used for another category\"}"
-    http_version: 
+    http_version:
   recorded_at: Sun, 12 Apr 2015 00:40:13 GMT

data/spec/cassettes/MoodleRb_Categories/_destroy/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_course_create_categories&wstoken=
-    body: 
+    uri: http://localhost:8888/moodle28/webservice/rest/server.php?moodlewsrestformat=json&wsfunction=core_course_create_categories&wstoken=
+    body:
       string: categories[0][description]=&categories[0][parent]=0&categories[0][name]=_&categories[0][idnumber]=
     headers: {}
 
-  response: 
-    status: 
+  response:
+    status:
       code: 200
       message: OK
-    headers: 
-      Accept-Ranges: 
+    headers:
+      Accept-Ranges:
       - none
-      X-Powered-By: 
+      X-Powered-By:
       - PHP/5.6.2
-      Content-Type: 
+      Content-Type:
       - application/json
-      Date: 
+      Date:
       - Mon, 20 Jun 2016 23:22:31 GMT
-      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
-      Content-Length: 
+      Content-Length:
       - "103"
-      Expires: 
+      Expires:
       - Thu, 01 Jan 1970 00:00:00 GMT
-      Pragma: 
+      Pragma:
       - no-cache
-      Cache-Control: 
+      Cache-Control:
       - private, must-revalidate, pre-check=0, post-check=0, max-age=0
-      Access-Control-Allow-Origin: 
+      Access-Control-Allow-Origin:
       - "*"
-    body: 
+    body:
       string: "{\"exception\":\"moodle_exception\",\"errorcode\":\"invalidtoken\",\"message\":\"Invalid token - token not found\"}"
-    http_version: 
+    http_version:
   recorded_at: Mon, 20 Jun 2016 23:22:31 GMT

data/spec/cassettes/MoodleRb_Categories/_destroy/when_using_valid_token/.yml

@@ -1,75 +1,76 @@
---- 
+---
 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_course_create_categories&wstoken=87b95af2df709fa60b395b5c59a3fc2e
-    body: 
+    uri: http://localhost:8888/moodle28/webservice/rest/server.php?moodlewsrestformat=json&wsfunction=core_course_create_categories&wstoken=60fc9c9415259404795094957e4ab32f
+    uri: http://localhost:8888/moodle28/webservice/rest/server.php?moodlewsrestformat=json&wsfunction=core_course_create_categories&wstoken=60fc9c9415259404795094957e4ab32f
+    body:
       string: categories[0][description]=&categories[0][parent]=0&categories[0][name]=_&categories[0][idnumber]=
     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.8zg DAV/2 mod_perl/2.0.8 Perl/v5.20.0
-      Access-Control-Allow-Origin: 
+      Access-Control-Allow-Origin:
       - "*"
-      Content-Type: 
+      Content-Type:
       - application/json
-      Expires: 
+      Expires:
       - Thu, 01 Jan 1970 00:00:00 GMT
-      X-Powered-By: 
+      X-Powered-By:
       - PHP/5.6.2
-      Accept-Ranges: 
+      Accept-Ranges:
       - none
-      Cache-Control: 
+      Cache-Control:
       - private, must-revalidate, pre-check=0, post-check=0, max-age=0
-      Date: 
+      Date:
       - Mon, 20 Jun 2016 23:23:47 GMT
-      Content-Length: 
+      Content-Length:
       - "21"
-      Pragma: 
+      Pragma:
       - no-cache
-    body: 
+    body:
       string: "[{\"id\":3,\"name\":\"_\"}]"
-    http_version: 
+    http_version:
   recorded_at: Mon, 20 Jun 2016 23:23:47 GMT
-- request: 
+- request:
     method: post
-    uri: http://localhost:8888/moodle29/webservice/rest/server.php?moodlewsrestformat=json&wsfunction=core_course_delete_categories&wstoken=87b95af2df709fa60b395b5c59a3fc2e
-    body: 
+    uri: http://localhost:8888/moodle28/webservice/rest/server.php?moodlewsrestformat=json&wsfunction=core_course_delete_categories&wstoken=60fc9c9415259404795094957e4ab32f
+    body:
       string: categories[0][recursive]=1&categories[0][id]=3
     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.8zg DAV/2 mod_perl/2.0.8 Perl/v5.20.0
-      Access-Control-Allow-Origin: 
+      Access-Control-Allow-Origin:
       - "*"
-      Content-Type: 
+      Content-Type:
       - application/json
-      Expires: 
+      Expires:
       - Thu, 01 Jan 1970 00:00:00 GMT
-      X-Powered-By: 
+      X-Powered-By:
       - PHP/5.6.2
-      Accept-Ranges: 
+      Accept-Ranges:
       - none
-      Cache-Control: 
+      Cache-Control:
       - private, must-revalidate, pre-check=0, post-check=0, max-age=0
-      Date: 
+      Date:
       - Mon, 20 Jun 2016 23:23:47 GMT
-      Content-Length: 
+      Content-Length:
       - "4"
-      Pragma: 
+      Pragma:
       - no-cache
-    body: 
+    body:
       string: "null"
-    http_version: 
+    http_version:
   recorded_at: Mon, 20 Jun 2016 23:23:47 GMT