moodle-api 1.2 → 1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4f9519237bf033eda8ececd7cee8e59607d175aa
-  data.tar.gz: 093320e00f1d0d13ba9942c250965cba429d98a7
+  metadata.gz: 9e5edfc4de74aa0771bf2197cc68bdda8d33ce20
+  data.tar.gz: 23aa1db0b94479fc0e4938fb2b588b61e442d45d
 SHA512:
-  metadata.gz: 5ee05012161283282b2ab7c726cd17985f5697fc4bcb16933e4dcc73bc47f7f9d72e2308283a1dfd8daa0df5937c62e5e5b013f8ce413b3c12daa81985177e92
-  data.tar.gz: 1a57bc71e6ad4d64940d158e7a7197b8f3824d6b8d9ff6a6daf6c781e63340d34f1c3283b28379f10ccd663e3a2fac8dc9f92c9b338e139154790b0b084fd2bb
+  metadata.gz: 8e3966da9448fedc2e7d545b288769360993cb1f0e841cab86951f0c53288a343178b24c0c6aeb9b07f526d5bb74a7778b229e9267d8a3c821f497dbd24aa1d8
+  data.tar.gz: 8b70a1714bcafe49ba93960695bb4c8f11d6c7cea0b9145eb091c04093555f7018cff7d2d28c962e32e23848144b2cbcf9cea07386f8bbdada43480ae5d0b485

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - ruby-head
+addons:
+  code_climate:
+    repo_token: 9e23768891c8bf9f3a4a034023881eb2ca8d1f96f4b4972e5b265be5f612215d

data/README.md

@@ -1,4 +1,10 @@
-# Moodle
+[![Gem Version](https://badge.fury.io/rb/moodle-api.svg)](http://badge.fury.io/rb/moodle-api)
+[![Code Climate](https://codeclimate.com/repos/559ea924e30ba001ad00a507/badges/bf95c036334b007100d3/gpa.svg)](https://codeclimate.com/repos/559ea924e30ba001ad00a507/feed)
+[![Build Status](https://travis-ci.org/get-smarter/moodle-api.svg?branch=master)](https://travis-ci.org/get-smarter/moodle-api)
+[![Test Coverage](https://codeclimate.com/repos/559ea924e30ba001ad00a507/badges/bf95c036334b007100d3/coverage.svg)](https://codeclimate.com/repos/559ea924e30ba001ad00a507/coverage)
+[![Dependency Status](https://gemnasium.com/get-smarter/moodle-api.svg)](https://gemnasium.com/get-smarter/moodle-api)
+
+# Moodle API
 
 A ruby wrapper for the Moodle REST API.
 
@@ -7,7 +13,7 @@ A ruby wrapper for the Moodle REST API.
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'moodle'
+gem 'moodle-api'
 ```
 
 And then execute:
@@ -16,7 +22,7 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install moodle
+    $ gem install moodle-api
 
 ## Usage
 
@@ -27,24 +33,22 @@ Different ways to configure gem.
 ```ruby
 # Pass block to configure
  Moodle::Api.configure do|c|
-  c.host = 'http://dev.vle.getsmarter.co.za'
-  c.token = '072556801bf07076fff6bff2a463b7c5'
+  c.host = 'http://my_moodle_instance.com'
+  c.token = 'mytoken'
 end
 
 # Set configuration values individually
-Moodle::Api.configuration.host = 'http://dev.vle.getsmarter.co.za'
-Moodle::Api.configuration.token = '072556801bf07076fff6bff2a463b7c5'
+Moodle::Api.configuration.host = 'http://my_moodle_instance.com'
+Moodle::Api.configuration.token = 'mytoken'
 
 # Pass options hash to configure
-Moodle::Api.configure({host: 'http://dev.vle.getsmarter.co.za',
-                  token: '072556801bf07076fff6bff2a463b7c5'})
+Moodle::Api.configure({host: 'http://my_moodle_instance.com',
+                  token: 'mytoken'})
 
-```
-The client can also be instantiated and used.
+# The client can also be instantiated and used.
+client = Moodle:Client.new({host: 'http://my_moodle_instance.com',
+                            token: 'mytoken'})
 
-```ruby
-client = Moodle:Client.new({host: 'http://dev.vle.getsmarter.co.za',
-                            token: '072556801bf07076fff6bff2a463b7c5'})
 client.make_request(:function_name_here, my_params)
 ```
 
@@ -63,21 +67,24 @@ New functions created in Moodle will automatically be available in the gem.
 ### Example
 
 ```ruby
-Moodle::Api.configure({host: 'http://dev.vle.getsmarter.co.za',
-                  token: '072556801bf07076fff6bff2a463b7c5'})
+Moodle::Api.configure({host: 'http://my_moodle_instance.com',
+                  token: 'mytoken'})
 
 params = { 'criteria[0][key]' => 'firstname', 'criteria[0][value]' => 'Jon' }
+
 Moodle::Api.core_user_get_users(params)
 ```
 
 ### Authentication
 Moodle uses token authentication, but sometimes you might not have a token. Users are able to generate tokens automatically when calling services using basic authentication.
 ```ruby
-Moodle::Api.configure({host: 'http://dev.vle.getsmarter.co.za',
+Moodle::Api.configure({host: 'http://my_moodle_instance.com',
                   service: 'my_external_service', # ensure you include the shortname of the external service
                   username: 'jonsnow',
                   password: 'defendthewall'})
+                  
 params = { 'criteria[0][key]' => 'firstname', 'criteria[0][value]' => 'Jon' }
+
 Moodle::Api.core_user_get_users(params)
 ```
 The gem will handle generating the token automatically and making the call to `core_user_get_users` with the token. If you want you can also just generate a token using
@@ -117,11 +124,8 @@ I am always keen to learn so please feel free to create an issue with code revie
 
 ## TODOS
 
-- Add additional protocals
+- Add additional protocols
 - Make cassettes easily rerunnable - will require a parser for the response to remove dynamic data or a funky regex in the specs.
-- Setup travis
-- Setup codeclimate
-- Setup codecoverage
 
 ## Warning
 

data/Rakefile

@@ -1,4 +1,9 @@
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
 
 task :console do
   exec "pry -r moodle -I ./lib"

data/fixtures/vcr_cassettes/external_service/invalid_service.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: post
-    uri: http://dev.vle.getsmarter.co.za/webservice/rest/server.php?criteria%5B0%5D%5Bkey%5D=firstname&criteria%5B0%5D%5Bvalue%5D=Jon&moodlewsrestformat=json&wsfunction=core_user_get_users_invalid&wstoken=072556801bf07076fff6bff2a463b7c5
+    uri: http://my_moodle_instance.com/webservice/rest/server.php?criteria%5B0%5D%5Bkey%5D=firstname&criteria%5B0%5D%5Bvalue%5D=Jon&moodlewsrestformat=json&wsfunction=core_user_get_users_invalid&wstoken=072556801bf07076fff6bff2a463b7c5
     body:
       encoding: US-ASCII
       string: ''
@@ -43,6 +43,6 @@ http_interactions:
         * FROM {external_functions} WHERE name = ?\n[array (\n  0 => ''core_user_get_users_invalid'',\n)]"}'
     http_version: '1.1'
     adapter_metadata:
-      effective_url: http://dev.vle.getsmarter.co.za/webservice/rest/server.php?criteria%5B0%5D%5Bkey%5D=firstname&criteria%5B0%5D%5Bvalue%5D=Jon&moodlewsrestformat=json&wsfunction=core_user_get_users_invalid&wstoken=072556801bf07076fff6bff2a463b7c5
+      effective_url: http://my_moodle_instance.com/webservice/rest/server.php?criteria%5B0%5D%5Bkey%5D=firstname&criteria%5B0%5D%5Bvalue%5D=Jon&moodlewsrestformat=json&wsfunction=core_user_get_users_invalid&wstoken=072556801bf07076fff6bff2a463b7c5
   recorded_at: Wed, 01 Jul 2015 12:33:57 GMT
 recorded_with: VCR 2.9.3

data/fixtures/vcr_cassettes/external_service/token_service.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: post
-    uri: http://dev.vle.getsmarter.co.za/login/token.php?username=ryan.mes%40email.co.za&password=mypassword&service=phoenix_integration
+    uri: http://my_moodle_instance.com/login/token.php?username=ryan.mes%40email.co.za&password=mypassword&service=phoenix_integration
     body:
       encoding: US-ASCII
       string: ''
@@ -34,6 +34,6 @@ http_interactions:
         specified in config.php<\/p>","stacktrace":null,"debuginfo":null,"errorcode":"dbconnectionfailed"}'
     http_version: '1.1'
     adapter_metadata:
-      effective_url: http://dev.vle.getsmarter.co.za/login/token.php?username=ryan.mes%40email.co.za&password=mypassword&service=phoenix_integration
+      effective_url: http://my_moodle_instance.com/login/token.php?username=ryan.mes%40email.co.za&password=mypassword&service=phoenix_integration
   recorded_at: Tue, 07 Jul 2015 08:26:38 GMT
 recorded_with: VCR 2.9.3

data/fixtures/vcr_cassettes/external_service/valid_service.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: post
-    uri: http://dev.vle.getsmarter.co.za/webservice/rest/server.php?criteria%5B0%5D%5Bkey%5D=firstname&criteria%5B0%5D%5Bvalue%5D=Jon&moodlewsrestformat=json&wsfunction=core_user_get_users&wstoken=072556801bf07076fff6bff2a463b7c5
+    uri: http://my_moodle_instance.com/webservice/rest/server.php?criteria%5B0%5D%5Bkey%5D=firstname&criteria%5B0%5D%5Bvalue%5D=Jon&moodlewsrestformat=json&wsfunction=core_user_get_users&wstoken=072556801bf07076fff6bff2a463b7c5
     body:
       encoding: US-ASCII
       string: ''
@@ -40,7 +40,7 @@ http_interactions:
       encoding: UTF-8
       string: '{"users":[{"id":5329,"username":"ryan.mes@email.co.za","firstname":"Jon","lastname":"Snow","fullname":"Jon
         Snow","email":"ryan.mes@email.co.za","department":"","firstaccess":1385623936,"lastaccess":1435753716,"description":"","descriptionformat":1,"city":"Cape
-        Town","profileimageurlsmall":"http:\/\/dev.vle.getsmarter.co.za\/pluginfile.php\/46751\/user\/icon\/f2","profileimageurl":"http:\/\/dev.vle.getsmarter.co.za\/pluginfile.php\/46751\/user\/icon\/f1","customfields":[{"type":"text","value":"GetSmarter","name":"Company","shortname":"company"},{"type":"text","value":"www.getsmarter.co.za","name":"Company
+        Town","profileimageurlsmall":"http:\/\/my_moodle_instance.com\/pluginfile.php\/46751\/user\/icon\/f2","profileimageurl":"http:\/\/my_moodle_instance.com\/pluginfile.php\/46751\/user\/icon\/f1","customfields":[{"type":"text","value":"GetSmarter","name":"Company","shortname":"company"},{"type":"text","value":"www.getsmarter.co.za","name":"Company
         Website","shortname":"companywebsite"},{"type":"text","value":"Lead Developer","name":"Position","shortname":"position"},{"type":"textarea","value":"<p>I
         am an avid adventure racer!<\/p>","name":"More about me","shortname":"moreaboutme"},{"type":"menu","value":"Short
         Course","name":"Enrolled in ","shortname":"programme"},{"type":"datetime","value":"0","name":"Date
@@ -56,6 +56,6 @@ http_interactions:
         names checked","shortname":"certificatenameschecked"}],"preferences":[{"name":"auth_manual_passwordupdatetime","value":"1434626773"},{"name":"block7hidden","value":"0"},{"name":"block9hidden","value":"0"},{"name":"docked_block_instance_7","value":"0"},{"name":"docked_block_instance_9","value":"0"},{"name":"email_bounce_count","value":"0"},{"name":"email_send_count","value":"41"},{"name":"filepicker_recentlicense","value":"allrightsreserved"},{"name":"filepicker_recentrepository","value":"7"},{"name":"htmleditor","value":""},{"name":"login_failed_count_since_success","value":"7"},{"name":"message_beepnewmessage","value":"0"},{"name":"message_blocknoncontacts","value":"0"},{"name":"message_provider_enrol_manual_expiry_notification_loggedin","value":"email"},{"name":"message_provider_enrol_manual_expiry_notification_loggedoff","value":"email"},{"name":"message_provider_enrol_self_expiry_notification_loggedin","value":"email"},{"name":"message_provider_enrol_self_expiry_notification_loggedoff","value":"email"},{"name":"message_provider_mod_assign_assign_notification_loggedin","value":"email"},{"name":"message_provider_mod_assign_assign_notification_loggedoff","value":"email"},{"name":"message_provider_mod_forum_posts_loggedin","value":"email"},{"name":"message_provider_mod_forum_posts_loggedoff","value":"email"},{"name":"message_provider_mod_lesson_graded_essay_loggedin","value":"email"},{"name":"message_provider_mod_lesson_graded_essay_loggedoff","value":"email"},{"name":"message_provider_mod_quiz_attempt_overdue_loggedin","value":"email"},{"name":"message_provider_mod_quiz_attempt_overdue_loggedoff","value":"email"},{"name":"message_provider_mod_quiz_confirmation_loggedin","value":"email"},{"name":"message_provider_mod_quiz_confirmation_loggedoff","value":"email"},{"name":"message_provider_mod_quiz_submission_loggedin","value":"email"},{"name":"message_provider_mod_quiz_submission_loggedoff","value":"email"},{"name":"message_provider_moodle_availableupdate_loggedin","value":"email"},{"name":"message_provider_moodle_availableupdate_loggedoff","value":"email"},{"name":"message_provider_moodle_backup_loggedin","value":"email"},{"name":"message_provider_moodle_backup_loggedoff","value":"email"},{"name":"message_provider_moodle_badgecreatornotice_loggedin","value":"none"},{"name":"message_provider_moodle_badgecreatornotice_loggedoff","value":"email"},{"name":"message_provider_moodle_badgerecipientnotice_loggedin","value":"popup"},{"name":"message_provider_moodle_badgerecipientnotice_loggedoff","value":"popup,email"},{"name":"message_provider_moodle_courserequestapproved_loggedin","value":"email"},{"name":"message_provider_moodle_courserequestapproved_loggedoff","value":"email"},{"name":"message_provider_moodle_courserequested_loggedin","value":"email"},{"name":"message_provider_moodle_courserequested_loggedoff","value":"email"},{"name":"message_provider_moodle_courserequestrejected_loggedin","value":"email"},{"name":"message_provider_moodle_courserequestrejected_loggedoff","value":"email"},{"name":"message_provider_moodle_errors_loggedin","value":"email"},{"name":"message_provider_moodle_errors_loggedoff","value":"email"},{"name":"message_provider_moodle_instantmessage_loggedin","value":"popup"},{"name":"message_provider_moodle_instantmessage_loggedoff","value":"popup,email"},{"name":"message_provider_moodle_notices_loggedin","value":"email"},{"name":"message_provider_moodle_notices_loggedoff","value":"email"},{"name":"userselector_autoselectunique","value":"0"},{"name":"userselector_optionscollapsed","value":"0"},{"name":"userselector_preserveselected","value":"1"},{"name":"userselector_searchanywhere","value":"0"},{"name":"_lastloaded","value":1435753952}]}],"warnings":[]}'
     http_version: '1.1'
     adapter_metadata:
-      effective_url: http://dev.vle.getsmarter.co.za/webservice/rest/server.php?criteria%5B0%5D%5Bkey%5D=firstname&criteria%5B0%5D%5Bvalue%5D=Jon&moodlewsrestformat=json&wsfunction=core_user_get_users&wstoken=072556801bf07076fff6bff2a463b7c5
+      effective_url: http://my_moodle_instance.com/webservice/rest/server.php?criteria%5B0%5D%5Bkey%5D=firstname&criteria%5B0%5D%5Bvalue%5D=Jon&moodlewsrestformat=json&wsfunction=core_user_get_users&wstoken=072556801bf07076fff6bff2a463b7c5
   recorded_at: Wed, 01 Jul 2015 12:32:32 GMT
 recorded_with: VCR 2.9.3

data/fixtures/vcr_cassettes/external_service/valid_service_empty_array_response.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: post
-    uri: http://dev.vle.getsmarter.co.za/webservice/rest/server.php?moodlewsrestformat=json&wsfunction=local_getsmarter_get_quiz_grades&wstoken=072556801bf07076fff6bff2a463b7c5&courseid=92
+    uri: http://my_moodle_instance.com/webservice/rest/server.php?moodlewsrestformat=json&wsfunction=local_getsmarter_get_quiz_grades&wstoken=072556801bf07076fff6bff2a463b7c5&courseid=92
     body:
       encoding: US-ASCII
       string: ''
@@ -41,6 +41,6 @@ http_interactions:
       string: "[]"
     http_version: '1.1'
     adapter_metadata:
-      effective_url: http://dev.vle.getsmarter.co.za/webservice/rest/server.php?moodlewsrestformat=json&wsfunction=local_getsmarter_get_quiz_grades&wstoken=072556801bf07076fff6bff2a463b7c5&courseid=92
+      effective_url: http://my_moodle_instance.com/webservice/rest/server.php?moodlewsrestformat=json&wsfunction=local_getsmarter_get_quiz_grades&wstoken=072556801bf07076fff6bff2a463b7c5&courseid=92
   recorded_at: Thu, 02 Jul 2015 07:10:48 GMT
 recorded_with: VCR 2.9.3

data/fixtures/vcr_cassettes/external_service/valid_service_not_external.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: post
-    uri: http://dev.vle.getsmarter.co.za/webservice/rest/server.php?criteria%5B0%5D%5Bkey%5D=firstname&criteria%5B0%5D%5Bvalue%5D=Jon&moodlewsrestformat=json&wsfunction=core_user_get_users&wstoken=072556801bf07076fff6bff2a463b7c5
+    uri: http://my_moodle_instance.com/webservice/rest/server.php?criteria%5B0%5D%5Bkey%5D=firstname&criteria%5B0%5D%5Bvalue%5D=Jon&moodlewsrestformat=json&wsfunction=core_user_get_users&wstoken=072556801bf07076fff6bff2a463b7c5
     body:
       encoding: US-ASCII
       string: ''
@@ -54,6 +54,6 @@ http_interactions:
         Plugins > Web services > External services and Manage tokens."}'
     http_version: '1.1'
     adapter_metadata:
-      effective_url: http://dev.vle.getsmarter.co.za/webservice/rest/server.php?criteria%5B0%5D%5Bkey%5D=firstname&criteria%5B0%5D%5Bvalue%5D=Jon&moodlewsrestformat=json&wsfunction=core_user_get_users&wstoken=072556801bf07076fff6bff2a463b7c5
+      effective_url: http://my_moodle_instance.com/webservice/rest/server.php?criteria%5B0%5D%5Bkey%5D=firstname&criteria%5B0%5D%5Bvalue%5D=Jon&moodlewsrestformat=json&wsfunction=core_user_get_users&wstoken=072556801bf07076fff6bff2a463b7c5
   recorded_at: Wed, 01 Jul 2015 12:44:52 GMT
 recorded_with: VCR 2.9.3

data/fixtures/vcr_cassettes/external_service/valid_service_returning_null.yml

@@ -0,0 +1,46 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://my_moodle_instance.com/webservice/rest/server.php?enrolments%5B0%5D%5Buserid%5D=11157&enrolments%5B0%5D%5Broleid%5D=5&enrolments%5B0%5D%5Bcourseid%5D=282&moodlewsrestformat=json&wsfunction=enrol_manual_enrol_users&wstoken=mytoken
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Typhoeus - https://github.com/typhoeus/typhoeus
+      Accept:
+      - json
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Tue, 14 Jul 2015 12:07:53 GMT
+      Server:
+      - Apache
+      Cache-Control:
+      - private, must-revalidate, pre-check=0, post-check=0, max-age=0
+      Expires:
+      - Thu, 01 Jan 1970 00:00:00 GMT
+      Pragma:
+      - no-cache
+      Accept-Ranges:
+      - none
+      Access-Control-Allow-Origin:
+      - "*"
+      Vary:
+      - Accept-Encoding
+      Content-Length:
+      - '4'
+      Content-Type:
+      - application/json
+    body:
+      encoding: UTF-8
+      string: 'null'
+    http_version: '1.1'
+    adapter_metadata:
+      effective_url: http://my_moodle_instance.com/webservice/rest/server.php?enrolments%5B0%5D%5Buserid%5D=11157&enrolments%5B0%5D%5Broleid%5D=5&enrolments%5B0%5D%5Bcourseid%5D=282&moodlewsrestformat=json&wsfunction=enrol_manual_enrol_users&wstoken=mytoken
+  recorded_at: Tue, 14 Jul 2015 12:07:55 GMT
+recorded_with: VCR 2.9.3

data/fixtures/vcr_cassettes/external_service/valid_service_with_invalid_token.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: post
-    uri: http://dev.vle.getsmarter.co.za/webservice/rest/server.php?criteria%5B0%5D%5Bkey%5D=firstname&criteria%5B0%5D%5Bvalue%5D=Jon&moodlewsrestformat=json&wsfunction=core_user_get_users&wstoken=invalidtoken
+    uri: http://my_moodle_instance.com/webservice/rest/server.php?criteria%5B0%5D%5Bkey%5D=firstname&criteria%5B0%5D%5Bvalue%5D=Jon&moodlewsrestformat=json&wsfunction=core_user_get_users&wstoken=invalidtoken
     body:
       encoding: US-ASCII
       string: ''
@@ -42,6 +42,6 @@ http_interactions:
         token - token not found"}'
     http_version: '1.1'
     adapter_metadata:
-      effective_url: http://dev.vle.getsmarter.co.za/webservice/rest/server.php?criteria%5B0%5D%5Bkey%5D=firstname&criteria%5B0%5D%5Bvalue%5D=Jon&moodlewsrestformat=json&wsfunction=core_user_get_users&wstoken=invalidtoken
+      effective_url: http://my_moodle_instance.com/webservice/rest/server.php?criteria%5B0%5D%5Bkey%5D=firstname&criteria%5B0%5D%5Bvalue%5D=Jon&moodlewsrestformat=json&wsfunction=core_user_get_users&wstoken=invalidtoken
   recorded_at: Wed, 01 Jul 2015 12:34:04 GMT
 recorded_with: VCR 2.9.3

data/fixtures/vcr_cassettes/token_service/error_invalid_service_token_service.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: post
-    uri: http://dev.vle.getsmarter.co.za/login/token.php?username=ryan.mes%40email.co.za&password=mypassword&service=invalidservice
+    uri: http://my_moodle_instance.com/login/token.php?username=ryan.mes%40email.co.za&password=mypassword&service=invalidservice
     body:
       encoding: US-ASCII
       string: ''
@@ -34,6 +34,6 @@ http_interactions:
         specified in config.php<\/p>","stacktrace":null,"debuginfo":null,"errorcode":"dbconnectionfailed"}'
     http_version: '1.1'
     adapter_metadata:
-      effective_url: http://dev.vle.getsmarter.co.za/login/token.php?username=ryan.mes%40email.co.za&password=mypassword&service=invalidservice
+      effective_url: http://my_moodle_instance.com/login/token.php?username=ryan.mes%40email.co.za&password=mypassword&service=invalidservice
   recorded_at: Tue, 07 Jul 2015 08:35:14 GMT
 recorded_with: VCR 2.9.3

data/fixtures/vcr_cassettes/token_service/invalid_password_token_service.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: post
-    uri: http://dev.vle.getsmarter.co.za/login/token.php?username=ryan.mes%40email.co.za&password=invalidpassword&service=phoenix_integration
+    uri: http://my_moodle_instance.com/login/token.php?username=ryan.mes%40email.co.za&password=invalidpassword&service=phoenix_integration
     body:
       encoding: US-ASCII
       string: ''
@@ -41,9 +41,9 @@ http_interactions:
       encoding: UTF-8
       string: '{"error":"The username was not found in the database","stacktrace":"*
         line 205 of \/login\/token.php: moodle_exception thrown\n","debuginfo":"\nError
-        code: usernamenotfound","reproductionlink":"http:\/\/dev.vle.getsmarter.co.za\/"}'
+        code: usernamenotfound","reproductionlink":"http:\/\/my_moodle_instance.com\/"}'
     http_version: '1.1'
     adapter_metadata:
-      effective_url: http://dev.vle.getsmarter.co.za/login/token.php?username=ryan.mes%40email.co.za&password=invalidpassword&service=phoenix_integration
+      effective_url: http://my_moodle_instance.com/login/token.php?username=ryan.mes%40email.co.za&password=invalidpassword&service=phoenix_integration
   recorded_at: Tue, 07 Jul 2015 09:07:48 GMT
 recorded_with: VCR 2.9.3

data/fixtures/vcr_cassettes/token_service/invalid_permissions_token_service.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: post
-    uri: http://dev.vle.getsmarter.co.za/login/token.php?username=ryan.mes%40email.co.za&password=mypassword&service=
+    uri: http://my_moodle_instance.com/login/token.php?username=ryan.mes%40email.co.za&password=mypassword&service=
     body:
       encoding: US-ASCII
       string: ''
@@ -41,9 +41,9 @@ http_interactions:
       encoding: UTF-8
       string: '{"error":"No permission to create web service token for the service
         .","stacktrace":"* line 187 of \/login\/token.php: moodle_exception thrown\n","debuginfo":"\nError
-        code: cannotcreatetoken","reproductionlink":"http:\/\/dev.vle.getsmarter.co.za\/"}'
+        code: cannotcreatetoken","reproductionlink":"http:\/\/my_moodle_instance.com\/"}'
     http_version: '1.1'
     adapter_metadata:
-      effective_url: http://dev.vle.getsmarter.co.za/login/token.php?username=ryan.mes%40email.co.za&password=mypassword&service=
+      effective_url: http://my_moodle_instance.com/login/token.php?username=ryan.mes%40email.co.za&password=mypassword&service=
   recorded_at: Fri, 03 Jul 2015 11:39:25 GMT
 recorded_with: VCR 2.9.3

data/fixtures/vcr_cassettes/token_service/invalid_service_token_service.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: post
-    uri: http://dev.vle.getsmarter.co.za/login/token.php?username=ryan.mes%40email.co.za&password=mypassword&service=invalidservice
+    uri: http://my_moodle_instance.com/login/token.php?username=ryan.mes%40email.co.za&password=mypassword&service=invalidservice
     body:
       encoding: US-ASCII
       string: ''
@@ -40,9 +40,9 @@ http_interactions:
     body:
       encoding: UTF-8
       string: '{"error":"Web service is not available (it doesn''t exist or might be disabled)","stacktrace":"* line 86 of \/login\/token.php: moodle_exception
-        thrown\n","debuginfo":"\nError code: servicenotavailable","reproductionlink":"http:\/\/dev.vle.getsmarter.co.za\/"}'
+        thrown\n","debuginfo":"\nError code: servicenotavailable","reproductionlink":"http:\/\/my_moodle_instance.com\/"}'
     http_version: '1.1'
     adapter_metadata:
-      effective_url: http://dev.vle.getsmarter.co.za/login/token.php?username=ryan.mes%40email.co.za&password=mypassword&service=invalidservice
+      effective_url: http://my_moodle_instance.com/login/token.php?username=ryan.mes%40email.co.za&password=mypassword&service=invalidservice
   recorded_at: Tue, 07 Jul 2015 09:02:43 GMT
 recorded_with: VCR 2.9.3

data/fixtures/vcr_cassettes/token_service/invalid_user_token_service.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: post
-    uri: http://dev.vle.getsmarter.co.za/login/token.php?username=ryan.mes%40email.co.za&password=phoenix_integration&service=
+    uri: http://my_moodle_instance.com/login/token.php?username=ryan.mes%40email.co.za&password=phoenix_integration&service=
     body:
       encoding: US-ASCII
       string: ''
@@ -41,9 +41,9 @@ http_interactions:
       encoding: UTF-8
       string: '{"error":"The username was not found in the database","stacktrace":"*
         line 205 of \/login\/token.php: moodle_exception thrown\n","debuginfo":"\nError
-        code: usernamenotfound","reproductionlink":"http:\/\/dev.vle.getsmarter.co.za\/"}'
+        code: usernamenotfound","reproductionlink":"http:\/\/my_moodle_instance.com\/"}'
     http_version: '1.1'
     adapter_metadata:
-      effective_url: http://dev.vle.getsmarter.co.za/login/token.php?username=ryan.mes%40email.co.za&password=phoenix_integration&service=
+      effective_url: http://my_moodle_instance.com/login/token.php?username=ryan.mes%40email.co.za&password=phoenix_integration&service=
   recorded_at: Fri, 03 Jul 2015 11:38:14 GMT
 recorded_with: VCR 2.9.3

data/fixtures/vcr_cassettes/token_service/invalid_username_token_service.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: post
-    uri: http://dev.vle.getsmarter.co.za/login/token.php?username=invalidusername&password=mypassword&service=phoenix_integration
+    uri: http://my_moodle_instance.com/login/token.php?username=invalidusername&password=mypassword&service=phoenix_integration
     body:
       encoding: US-ASCII
       string: ''
@@ -41,9 +41,9 @@ http_interactions:
       encoding: UTF-8
       string: '{"error":"The username was not found in the database","stacktrace":"*
         line 205 of \/login\/token.php: moodle_exception thrown\n","debuginfo":"\nError
-        code: usernamenotfound","reproductionlink":"http:\/\/dev.vle.getsmarter.co.za\/"}'
+        code: usernamenotfound","reproductionlink":"http:\/\/my_moodle_instance.com\/"}'
     http_version: '1.1'
     adapter_metadata:
-      effective_url: http://dev.vle.getsmarter.co.za/login/token.php?username=invalidusername&password=mypassword&service=phoenix_integration
+      effective_url: http://my_moodle_instance.com/login/token.php?username=invalidusername&password=mypassword&service=phoenix_integration
   recorded_at: Tue, 07 Jul 2015 09:06:32 GMT
 recorded_with: VCR 2.9.3

data/fixtures/vcr_cassettes/token_service/token_service.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: post
-    uri: http://dev.vle.getsmarter.co.za/login/token.php?username=ryan.mes%40email.co.za&password=mypassword&service=phoenix_integration
+    uri: http://my_moodle_instance.com/login/token.php?username=ryan.mes%40email.co.za&password=mypassword&service=phoenix_integration
     body:
       encoding: US-ASCII
       string: ''
@@ -42,6 +42,6 @@ http_interactions:
       string: '{"token":"072556801bf07076fff6bff2a463b7c5"}'
     http_version: '1.1'
     adapter_metadata:
-      effective_url: http://dev.vle.getsmarter.co.za/login/token.php?username=ryan.mes%40email.co.za&password=mypassword&service=phoenix_integration
+      effective_url: http://my_moodle_instance.com/login/token.php?username=ryan.mes%40email.co.za&password=mypassword&service=phoenix_integration
   recorded_at: Fri, 03 Jul 2015 11:41:10 GMT
 recorded_with: VCR 2.9.3

data/lib/moodle/api/request.rb

@@ -37,8 +37,13 @@ module Moodle
         response_body.is_a?(Hash) && response_body['error']
       end
 
+      # API calls that return null are considered successful
       def response_body
-        JSON.parse(response.body)
+        begin
+          JSON.parse(response.body)
+        rescue JSON::ParserError => e
+          response.body
+        end
       end
     end
   end

data/lib/moodle/api/version.rb

@@ -1,5 +1,5 @@
 module Moodle
   module Api
-    VERSION = "1.2"
+    VERSION = "1.3"
   end
 end

data/moodle-api.gemspec

@@ -33,6 +33,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'guard-rspec'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'codeclimate-test-reporter'
 
   spec.add_dependency 'typhoeus'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: moodle-api
 version: !ruby/object:Gem::Version
-  version: '1.2'
+  version: '1.3'
 platform: ruby
 authors:
 - Ryan-Neal Mes
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-07-09 00:00:00.000000000 Z
+date: 2015-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: typhoeus
   requirement: !ruby/object:Gem::Requirement
@@ -118,6 +132,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".ruby-version"
+- ".travis.yml"
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -130,6 +145,7 @@ files:
 - fixtures/vcr_cassettes/external_service/valid_service.yml
 - fixtures/vcr_cassettes/external_service/valid_service_empty_array_response.yml
 - fixtures/vcr_cassettes/external_service/valid_service_not_external.yml
+- fixtures/vcr_cassettes/external_service/valid_service_returning_null.yml
 - fixtures/vcr_cassettes/external_service/valid_service_with_invalid_token.yml
 - fixtures/vcr_cassettes/token_service/error_invalid_service_token_service.yml
 - fixtures/vcr_cassettes/token_service/invalid_password_token_service.yml