moodle_rb 1.0.1 → 1.0.2

data/README.md

@@ -108,3 +108,22 @@ Delete a user
 ```
 moodle.users.destroy(user_id)
 ```
+
+Search for a user
+```
+moodle.users.search(:email => 'admin@localhost')
+```
+
+Update a user
+```
+moodle.users.update(:id => 4, :email => 'bwayne@wayneenterprises.com')
+```
+
+## Tests
+
+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
+```

data/lib/moodle_rb/users.rb

@@ -79,5 +79,42 @@ module MoodleRb
       )
       response.parsed_response
     end
+
+    # input keys must be in the list of supported user columns to search
+    # id, lastname, firstname, idnumber, username, email
+    def search(params = {})
+      response = self.class.post(
+        '/webservice/rest/server.php',
+        {
+          :query => query_hash('core_user_get_users', token),
+          :body => {
+            :criteria => key_value_query_format(params)
+          }
+        }
+      )
+      response.parsed_response['users']
+    end
+
+    # params must include the id of the user
+    # it may include any other standard user attributes:
+    # username, password, firstname, lastname, email ...
+    def update(params)
+      response = self.class.post(
+        '/webservice/rest/server.php',
+        {
+          :query => query_hash('core_user_update_users', token),
+          :body => {
+            :users => {
+              '0' => params
+            }
+          }
+        }
+      )
+      if error_response?(response)
+        raise MoodleError.new(response.parsed_response)
+      else
+        response.response.code == '200'
+      end
+    end
   end
-end
+end

data/lib/moodle_rb/utility.rb

@@ -17,6 +17,16 @@ module MoodleRb
       end
     end
 
+    def key_value_query_format(hash)
+      {}.tap do |h|
+        hash.each_with_index do |key_value_array, i|
+          h[i] = {}
+          h[i][:key] = key_value_array[0]
+          h[i][:value] = key_value_array[1]
+        end
+      end
+    end
+
     def error_response?(response)
       response && response.parsed_response.is_a?(Hash) &&
         response.parsed_response.has_key?('exception')

data/lib/moodle_rb/version.rb

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

data/spec/cassettes/MoodleRb_Users/_search/.yml

@@ -0,0 +1,39 @@
+--- 
+http_interactions: 
+- request: 
+    method: post
+    uri: http://localhost:8888/moodle29/webservice/rest/server.php?moodlewsrestformat=json&wsfunction=core_user_get_users&wstoken=87b95af2df709fa60b395b5c59a3fc2e
+    body: 
+      string: criteria[0][value]=Guest%25&criteria[0][key]=firstname
+    headers: {}
+
+  response: 
+    status: 
+      code: 200
+      message: OK
+    headers: 
+      Date: 
+      - Wed, 08 Jun 2016 06:25:46 GMT
+      Expires: 
+      - Thu, 01 Jan 1970 00:00:00 GMT
+      Pragma: 
+      - no-cache
+      X-Powered-By: 
+      - PHP/5.6.2
+      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-Type: 
+      - application/json
+      Access-Control-Allow-Origin: 
+      - "*"
+      Content-Length: 
+      - "339"
+      Accept-Ranges: 
+      - none
+      Cache-Control: 
+      - private, must-revalidate, pre-check=0, post-check=0, max-age=0
+    body: 
+      string: "{\"users\":[{\"id\":1,\"firstname\":\"Guest user\",\"lastname\":\" \",\"fullname\":\"Guest user  \",\"email\":\"root@localhost\",\"firstaccess\":0,\"lastaccess\":0,\"profileimageurlsmall\":\"http:\\/\\/localhost:8888\\/moodle29\\/pluginfile.php\\/4\\/user\\/icon\\/f2\",\"profileimageurl\":\"http:\\/\\/localhost:8888\\/moodle29\\/pluginfile.php\\/4\\/user\\/icon\\/f1\"}],\"warnings\":[]}"
+    http_version: 
+  recorded_at: Wed, 08 Jun 2016 06:25:46 GMT
+recorded_with: VCR 2.9.3

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

@@ -0,0 +1,39 @@
+--- 
+http_interactions: 
+- request: 
+    method: post
+    uri: http://localhost:8888/moodle29/webservice/rest/server.php?moodlewsrestformat=json&wsfunction=core_user_update_users&wstoken=87b95af2df709fa60b395b5c59a3fc2e
+    body: 
+      string: users[0][email]=samg%40jobready.com.au&users[0][id]=4
+    headers: {}
+
+  response: 
+    status: 
+      code: 200
+      message: OK
+    headers: 
+      Expires: 
+      - Thu, 01 Jan 1970 00:00:00 GMT
+      X-Powered-By: 
+      - PHP/5.6.2
+      Content-Type: 
+      - application/json
+      Content-Length: 
+      - "4"
+      Date: 
+      - Wed, 08 Jun 2016 06:40:27 GMT
+      Access-Control-Allow-Origin: 
+      - "*"
+      Accept-Ranges: 
+      - none
+      Pragma: 
+      - no-cache
+      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: 
+      - private, must-revalidate, pre-check=0, post-check=0, max-age=0
+    body: 
+      string: "null"
+    http_version: 
+  recorded_at: Wed, 08 Jun 2016 06:40:27 GMT
+recorded_with: VCR 2.9.3

data/spec/lib/moodle_rb/users_spec.rb

@@ -84,4 +84,29 @@ describe MoodleRb::Users do
       expect(enrolment).to have_key 'shortname'
     end
   end
+
+  describe '#search', :vcr => {
+    :match_requests_on => [:headers], :record => :once
+  } do
+    let(:results) { user_moodle_rb.search({ :firstname => 'Guest%' }) }
+
+    specify do
+      expect(results).to be_a Array
+      expect(results.first).to be_a Hash
+      expect(results.first['firstname']).to eq 'Guest user'
+    end
+  end
+
+  describe '#update', :vcr => {
+    :match_requests_on => [:headers], :record => :once
+  } do
+    let(:user_id) { 4 }
+    let(:result) do
+      user_moodle_rb.update(:id => user_id, :email => 'samg@jobready.com.au')
+    end
+
+    specify do
+      expect(result).to eq true
+    end
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: moodle_rb
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: 
   segments: 
   - 1
   - 0
-  - 1
-  version: 1.0.1
+  - 2
+  version: 1.0.2
 platform: ruby
 authors: 
 - Sam Giffney
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2015-06-10 00:00:00 Z
+date: 2016-06-08 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: bundler
@@ -173,7 +173,9 @@ files:
 - spec/cassettes/MoodleRb_Users/_destroy/.yml
 - spec/cassettes/MoodleRb_Users/_destroy/when_id_does_not_exist/.yml
 - spec/cassettes/MoodleRb_Users/_enrolled_courses/.yml
+- spec/cassettes/MoodleRb_Users/_search/.yml
 - spec/cassettes/MoodleRb_Users/_show/.yml
+- spec/cassettes/MoodleRb_Users/_update/.yml
 - spec/lib/moodle_rb/categories_spec.rb
 - spec/lib/moodle_rb/client_spec.rb
 - spec/lib/moodle_rb/courses_spec.rb
@@ -241,7 +243,9 @@ test_files:
 - spec/cassettes/MoodleRb_Users/_destroy/.yml
 - spec/cassettes/MoodleRb_Users/_destroy/when_id_does_not_exist/.yml
 - spec/cassettes/MoodleRb_Users/_enrolled_courses/.yml
+- spec/cassettes/MoodleRb_Users/_search/.yml
 - spec/cassettes/MoodleRb_Users/_show/.yml
+- spec/cassettes/MoodleRb_Users/_update/.yml
 - spec/lib/moodle_rb/categories_spec.rb
 - spec/lib/moodle_rb/client_spec.rb
 - spec/lib/moodle_rb/courses_spec.rb