moodle 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3ac635580be17fb36b6b0b1f12bffbf9592ff773
+  data.tar.gz: ab7c1465b102719613c1499ad3a84341fea0b703
+SHA512:
+  metadata.gz: 159208b1c4ca10250fd7265ff86bf43e46d177a9dd30941425aa71d99d39af3198e24f2edc474b2bbd17fb48a3869188487dce5bb2330ace753236c24c525717
+  data.tar.gz: 812371e44861ed813083ee50062d85fc52708567a0e6afecf8c69dcb7aa6dc8a58bb05467bbe1865364b02d23b1100aa6ce5e4ce7c4bb83e2cb613a5af9311f2

data/.gitignore

@@ -0,0 +1,2 @@
+coverage
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gem 'simplecov', :require => false, :group => :test
+gem 'mocha', :require => false, :group => :test
+gem 'rest-client'
+gem 'sanitize'
+gem 'hashie'
+gem 'json'

data/LICENSE.md

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Robert Boloc
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,96 @@
+# Moodle
+Ruby gem to interact with the Moodle via web services.
+
+## Table of contents
+- [Installation](#installation)
+- [Usage](#usage)
+- [Protocols](#protocols)
+- [Functions](#functions)
+
+## Installation
+```shell
+gem install moodle
+```
+
+## Usage
+To use this gem you must first have configured the moodle web services. To do that use the official documentation.
+
+### Without a token
+If you don't have a token, you can create an instance of the client using your username and password.
+The client will then obtain a token for you.
+```ruby
+client = Moodle::Client.new(
+  :username => 'myusername',
+  :password => 'secret',
+  :protocol => 'rest',
+  :domain => 'http://mydomain/moodle',
+  :service => 'myservice',
+  :format => 'json'
+)
+```
+
+### Using a token
+If you already have a token the client can be created without a username and password:
+```ruby
+client = Moodle::Client.new(
+  :token => 'b31dde13bade28f25d548a31fa994816',
+  :protocol => 'rest',
+  :domain => 'http://mydomain/moodle',
+  :service => 'myservice',
+  :format => 'json'
+)
+```
+
+### Short syntax
+When creating the client you can use a shorter and simpler syntax:
+```ruby
+client = Moodle.new(
+  :token => 'b31dde13bade28f25d548a31fa994816',
+  :protocol => 'rest',
+  :domain => 'http://mydomain/moodle',
+  :service => 'myservice',
+  :format => 'json'
+)
+```
+
+### Global configuration
+Configuration can be set globally.
+```ruby
+# Using a hash
+Moodle.configure(
+  :token => 'b31dde13bade28f25d548a31fa994816',
+  :protocol => 'rest',
+  :domain => 'http://mydomain/moodle',
+  :service => 'myservice',
+  :format => 'json'
+)
+
+# Using a file
+Moodle.configure_with(/path/to/yaml/file)
+
+client = Moodle.new
+```
+
+Once you have an instance of the client it's only a matter of calling the moodle web services functions.
+
+## Protocols
+Moodle implements 4 protocols: AMF, REST, SOAP, XML-RPC. Currently this gem only supports REST.
+
+## Functions
+These are the currently implemented web services functions:
+
+### 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])
+
+user.id                   # => 2,
+user.firstname            # => Test
+user.lastname             # => User
+user.fullname             # => Test User
+user.email                # => webservicetester@gmail.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
+```

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Running tests"
+task :default => :test

data/lib/moodle.rb

@@ -0,0 +1,39 @@
+$:.unshift File.dirname(__FILE__)
+
+require 'moodle/client'
+require 'yaml'
+
+module Moodle
+  @@config = {
+    :username => nil,
+    :password => nil,
+    :token => nil,
+    :protocol => nil,
+    :domain => nil,
+    :service => nil,
+    :format => 'json'
+  }
+
+  @valid_config_keys = @@config.keys
+
+  # Configuration is for the instance only
+  def self.new(options={})
+    Moodle::Client.new(options)
+  end
+
+  # Configure at global level trough hash
+  def self.configure(options={})
+    options.each {|k,v| @@config[k.to_sym] = v if @valid_config_keys.include? k.to_sym}
+  end
+
+  # Configure at global level through yaml file
+  def self.configure_with(path_to_yaml_file)
+    config = YAML::load(IO.read(path_to_yaml_file))
+    configure(config)
+  end
+
+  # Obtain the global configuration
+  def self.config
+    @@config
+  end
+end

data/lib/moodle/client.rb

@@ -0,0 +1,65 @@
+require 'moodle/protocols/rest'
+require 'moodle/services/user'
+require 'hashie'
+require 'json'
+
+module Moodle
+  class Client
+    include Moodle::Service::User
+
+    attr_reader :username, :password, :domain, :protocol, :service, :format, :token
+
+    def initialize(options={})
+      @username = options[:username] || Moodle.config[:username]
+      @password = options[:password] || Moodle.config[:password]
+      @domain   = options[:domain]   || Moodle.config[:domain]
+      @protocol = options[:protocol] || Moodle.config[:protocol]
+      @service  = options[:service]  || Moodle.config[:service]
+      @format   = options[:format]   || Moodle.config[:format]
+      @token    = options[:token]    || Moodle.config[:token]
+
+      # If no token is provided generate one
+      if @token.nil?
+        @token = self.obtain_token
+      end
+    end
+
+    # Retuns a Moodle::Protocol client instance
+    def client
+      if @client.nil?
+        # Instantiate the client protocol
+        case @protocol
+        when 'rest'
+          @client = Moodle::Protocol::Rest.new
+        else
+          @client = Moodle::Protocol::Rest.new
+        end
+      end
+      @client
+    end
+
+    # Obtains a token from the username and password
+    def obtain_token
+      response = client.request(@domain + '/login/token.php', {
+        :username => @username, 
+        :password => @password, 
+        :service  => @service
+      })
+      # @TODO: deal with error response
+      response.token
+    end
+
+    # Make a request using the desired protocol and format
+    def request(params={})
+      params.merge!(
+        :wstoken => @token,
+        :moodlewsrestformat => @format,
+        :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
+    end
+  end
+end

data/lib/moodle/protocols/rest.rb

@@ -0,0 +1,13 @@
+require 'rest-client'
+require 'sanitize'
+
+module Moodle
+  module Protocol
+    class Rest
+      # Return must be sanitized oh html as debug on moodle site can be active 
+      def request(url, params={})
+        Sanitize.clean(RestClient.get(url, :params => params), :remove_contents => true)
+      end
+    end  
+  end 
+end

data/lib/moodle/services/user.rb

@@ -0,0 +1,21 @@
+module Moodle
+  module Service
+    module User
+        # Get users by field
+        def core_user_get_users_by_field(field, values)
+          params = {
+            :field => field
+          }
+
+          # Add all the userids as array params
+          counter = 0
+          values.each do |id|
+            params['values[' + counter.to_s + ']'] = id
+            counter = counter + 1
+          end
+
+          request(params)
+        end
+    end
+  end
+end

data/moodle.gemspec

@@ -0,0 +1,13 @@
+Gem::Specification.new do |spec|
+  spec.name        = 'moodle'
+  spec.version     = '0.0.1'
+  spec.date        = '2014-02-14'
+  spec.summary     = "Moodle web services from ruby"
+  spec.description = "Interact with Moodle from ruby"
+  spec.authors     = ["Robert Boloc"]
+  spec.email       = 'robertboloc@gmail.com'
+  spec.files       = `git ls-files`.split("\n")
+  spec.homepage    =
+    'http://robertboloc.github.com/moodle'
+  spec.license     = 'MIT'
+end

data/test/fixtures/config.yml

@@ -0,0 +1,2 @@
+username: 'test_username'
+password: 'test_password'

data/test/test_client.rb

@@ -0,0 +1,34 @@
+require 'test_helper'
+require 'moodle/client'
+
+class ClientTest < Test::Unit::TestCase
+  # Test initialization with hash
+  def test_initialize_with_hash
+    client = Moodle::Client.new({
+      :username => 'test_username',
+      :password => 'test_password',
+      :domain   => 'test_domain',
+      :protocol => 'test_protocol',
+      :service => 'test_service',
+      :format => 'test_format',
+      :token => 'test_token'
+    })
+
+    assert_equal 'test_username', client.username
+    assert_equal 'test_password', client.password
+    assert_equal 'test_domain', client.domain
+    assert_equal 'test_protocol', client.protocol
+    assert_equal 'test_service', client.service
+    assert_equal 'test_format', client.format
+    assert_equal 'test_token', client.token
+  end
+
+  # Test obtaining a token
+  def test_obtain_token
+    client = Moodle::Protocol::Rest.new
+    client.stubs(:request).returns('{"token" : "12345"}')
+    moodle_client = Moodle::Client.new({:token => 'dummy', :domain => 'test'})
+    moodle_client.stubs(:client).returns(client)
+    assert_equal '12345', moodle_client.obtain_token()
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+require 'simplecov'
+
+SimpleCov.start do
+    # Exclude test files from coverage
+    add_filter "test_"
+end
+
+require 'test/unit'
+require 'mocha/setup'

data/test/test_moodle.rb

@@ -0,0 +1,29 @@
+require 'test_helper'
+require 'moodle'
+
+class MoodleTest < Test::Unit::TestCase
+  # Test creating new instance
+  def test_new_with_token
+    client = Moodle.new(:token => 'test')
+    assert client.instance_of?(Moodle::Client)
+  end
+
+  # Test that global configuration can be set with hash
+  def test_configure
+    Moodle.configure({
+      :username => 'test_username',
+      :password => 'test_password'
+    })
+
+    assert_equal 'test_username', Moodle.config[:username]
+    assert_equal 'test_password', Moodle.config[:password]
+  end
+
+  # Test that global configuration can be set with yaml
+  def test_configure_with
+    Moodle.configure_with('test/fixtures/config.yml')
+
+    assert_equal 'test_username', Moodle.config[:username]
+    assert_equal 'test_password', Moodle.config[:password]
+  end
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: moodle
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Robert Boloc
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-14 00:00:00.000000000 Z
+dependencies: []
+description: Interact with Moodle from ruby
+email: robertboloc@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- lib/moodle.rb
+- lib/moodle/client.rb
+- lib/moodle/protocols/rest.rb
+- lib/moodle/services/user.rb
+- moodle.gemspec
+- test/fixtures/config.yml
+- test/test_client.rb
+- test/test_helper.rb
+- test/test_moodle.rb
+homepage: http://robertboloc.github.com/moodle
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Moodle web services from ruby
+test_files: []