moodle 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3ac635580be17fb36b6b0b1f12bffbf9592ff773
-  data.tar.gz: ab7c1465b102719613c1499ad3a84341fea0b703
+  metadata.gz: 21dada7b7c2d9a6a9f1918835cba252ad73917b4
+  data.tar.gz: e29af8894d6d2f53d398a26b03cbf8e6c2c147a7
 SHA512:
-  metadata.gz: 159208b1c4ca10250fd7265ff86bf43e46d177a9dd30941425aa71d99d39af3198e24f2edc474b2bbd17fb48a3869188487dce5bb2330ace753236c24c525717
-  data.tar.gz: 812371e44861ed813083ee50062d85fc52708567a0e6afecf8c69dcb7aa6dc8a58bb05467bbe1865364b02d23b1100aa6ce5e4ce7c4bb83e2cb613a5af9311f2
+  metadata.gz: ffa4d6d3fa5f14360e36ca981db5eec18a469db2a7b101d54c3db6ddd365ee563154ebce9d53d6dc8a93920672c888251dc0e3bb79c79a07a59272f6e303b2a4
+  data.tar.gz: 42deb18c2d0de7258ab738ba89c3d3320ee31ee8d5178e6cc29d5f6c511255eff169238edbcbf2d13183cb3978e9a72ee20e4b85a4123fdbcbacec7a7102f2fc

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0

data/Gemfile

@@ -5,4 +5,5 @@ gem 'mocha', :require => false, :group => :test
 gem 'rest-client'
 gem 'sanitize'
 gem 'hashie'
+gem 'rake'
 gem 'json'

data/README.md

@@ -1,5 +1,9 @@
 # Moodle
-Ruby gem to interact with the Moodle via web services.
+[![Build Status](https://travis-ci.org/robertboloc/moodle.png)](https://travis-ci.org/robertboloc/moodle)
+[![Code Climate](https://codeclimate.com/github/robertboloc/moodle.png)](https://codeclimate.com/github/robertboloc/moodle)
+[![Gem Version](https://badge.fury.io/rb/moodle.png)](http://badge.fury.io/rb/moodle)
+
+Ruby gem to interact with Moodle via web services.
 
 ## Table of contents
 - [Installation](#installation)
@@ -79,7 +83,9 @@ Moodle implements 4 protocols: AMF, REST, SOAP, XML-RPC. Currently this gem only
 ## Functions
 These are the currently implemented web services functions:
 
-### core_user_get_users_by_field
+### Users
+
+#### core_user_get_users_by_field
 Retrieve users information for a specified unique field
 ```ruby
 user = client.core_user_get_users_by_field('id', [2])
@@ -93,4 +99,90 @@ user.firstaccess          # => 139240932,
 user.lastaccess           # => 1392471263
 user.profileimageurlsmall # => http://mydomain/moodle/pluginfile.php/5/user/icon/f2
 user.profileimageurl      # => http://mydomain/moodle/pluginfile.php/5/user/icon/f1
+```
+
+#### core_user_get_users
+Search for users matching the criteria
+```ruby
+users = client.core_user_get_users({:email => 'suchemail@test.com'})
+
+users.each do |user|
+  user.id                   # => 2,
+  user.firstname            # => Test
+  user.lastname             # => User
+  user.fullname             # => Test User
+  user.email                # => suchemail@test.com
+  user.firstaccess          # => 139240932,
+  user.lastaccess           # => 1392471263
+  user.profileimageurlsmall # => http://mydomain/moodle/pluginfile.php/5/user/icon/f2
+  user.profileimageurl      # => http://mydomain/moodle/pluginfile.php/5/user/icon/f1
+end
+```
+
+### Courses
+
+#### core_course_get_courses
+Retrieve courses details by ids
+```ruby
+courses = client.core_course_get_courses([2, 3])
+
+courses.each do |course|
+  course.id                # => 2
+  course.shortname         # => T
+  course.categoryid        # => 1
+  course.categorysortorder # => 10002
+  course.fullname          # => Test
+  course.idnumber          # => TX
+  course.summary           # => test
+  course.summaryformat     # => 1
+  course.format            # => weeks
+  course.showgrades        # => 1
+  course.newsitems         # => 5
+  course.startdate         # => 1393718400
+  course.numsections       # => 10
+  course.maxbytes          # => 0
+  course.showreports       # => 0
+  course.visible           # => 1
+  course.hiddensections    # => 0
+  course.groupmode         # => 0
+  course.groupmodeforce    # => 0
+  course.defaultgroupingid # => 0
+  course.timecreated       # => 1393693092
+  course.timemodified      # => 1393693092
+  course.enablecompletion  # => 0
+  course.completionnotify  # => 0
+  course.lang              # => en
+  course.forcetheme        # => test
+  course.courseformatoptions.each do |format|
+    format.name            # => numsections
+    value                  # => 10
+  end
+end
+```
+
+### Webservices
+
+#### core_webservice_get_site_info
+Return some site info / user info / list web service functions
+```ruby
+info = client.core_webservice_get_site_info
+
+info.sitename       # => Webservice test
+info.username       # => test
+info.firstname      # => Test
+info.lastname       # => Webservice
+info.fullname       # => Test Webservice
+info.lang           # => en
+info.userid         # => 3
+info.siteurl        # => http://mydomain/moodle
+info.userpictureurl # => http://mydomain/moodle/pluginfile.php/15/user/icon/f1
+info.functions.each do |f|
+  f.name            # => core_user_get_users_by_field
+  f.version         # => 2013111800.09
+end
+info.downloadfiles  # => 0
+info.uploadfiles    # => 0
+info.release        # => 2.6+ (Build: 20140110)
+info.version        # => 2013111800.09
+info.mobilecssurl   # => ""
 ```

data/lib/moodle/client.rb

@@ -1,11 +1,15 @@
 require 'moodle/protocols/rest'
 require 'moodle/services/user'
+require 'moodle/services/course'
+require 'moodle/services/webservice'
 require 'hashie'
 require 'json'
 
 module Moodle
   class Client
     include Moodle::Service::User
+    include Moodle::Service::Course
+    include Moodle::Service::Webservice
 
     attr_reader :username, :password, :domain, :protocol, :service, :format, :token
 
@@ -45,8 +49,9 @@ module Moodle
         :password => @password, 
         :service  => @service
       })
-      # @TODO: deal with error response
-      response.token
+
+      parsed = JSON.parse(response)
+      parsed['token']
     end
 
     # Make a request using the desired protocol and format
@@ -57,9 +62,8 @@ module Moodle
         :wsfunction => caller[0][/`.*'/][1..-2]
       )
       response = client.request(@domain + '/webservice/' + @protocol + '/server.php', params)
-      array_response = JSON.parse response
-      hash_response = Hash[*array_response]
-      Hashie::Mash.new hash_response
+
+      JSON.parse(response)
     end
   end
 end

data/lib/moodle/helper.rb

@@ -0,0 +1,11 @@
+require 'hashie'
+require 'json'
+
+module Moodle
+  class Helper
+  	
+  	def to_object(json)
+
+  	end
+  end
+end

data/lib/moodle/services/course.rb

@@ -0,0 +1,22 @@
+module Moodle
+  module Service
+    module Course
+      # Return course details
+      def core_course_get_courses(options)
+        params = {}
+
+        counter = 0
+        options.each do |id|
+          params['options[ids][' + counter.to_s + ']'] = id
+          counter = counter + 1
+        end
+
+        response = request(params)
+
+        if response.any?
+          courses = response.map { |course| Hashie::Mash.new(course) }
+        end
+      end
+    end
+  end
+end

data/lib/moodle/services/user.rb

@@ -14,7 +14,26 @@ module Moodle
             counter = counter + 1
           end
 
-          request(params)
+          response = request(params)
+          Hashie::Mash.new *response
+        end
+
+        # Search for users matching the criteria
+        def core_user_get_users(criteria)
+          params = {}
+
+          counter = 0
+          criteria.each do |key,value|
+            params['criteria[' + counter.to_s + '][key]'] = key.to_s
+            params['criteria[' + counter.to_s + '][value]'] = value
+            counter = counter + 1
+          end
+
+          response = request(params)
+
+          if response['users']
+            users = response['users'].map { |user| Hashie::Mash.new(user) }
+          end
         end
     end
   end

data/lib/moodle/services/webservice.rb

@@ -0,0 +1,10 @@
+module Moodle
+  module Service
+    module Webservice
+      # Return some site info / user info / list web service functions
+      def core_webservice_get_site_info
+        Hashie::Mash.new request
+      end
+    end
+  end
+end

data/moodle.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |spec|
   spec.name        = 'moodle'
-  spec.version     = '0.0.1'
-  spec.date        = '2014-02-14'
+  spec.version     = '0.1.0'
+  spec.date        = '2014-03-01'
   spec.summary     = "Moodle web services from ruby"
   spec.description = "Interact with Moodle from ruby"
   spec.authors     = ["Robert Boloc"]
@@ -10,4 +10,4 @@ Gem::Specification.new do |spec|
   spec.homepage    =
     'http://robertboloc.github.com/moodle'
   spec.license     = 'MIT'
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: moodle
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Robert Boloc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-14 00:00:00.000000000 Z
+date: 2014-03-01 00:00:00.000000000 Z
 dependencies: []
 description: Interact with Moodle from ruby
 email: robertboloc@gmail.com
@@ -17,14 +17,18 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE.md
 - README.md
 - Rakefile
 - lib/moodle.rb
 - lib/moodle/client.rb
+- lib/moodle/helper.rb
 - lib/moodle/protocols/rest.rb
+- lib/moodle/services/course.rb
 - lib/moodle/services/user.rb
+- lib/moodle/services/webservice.rb
 - moodle.gemspec
 - test/fixtures/config.yml
 - test/test_client.rb