Merge pull request #18 from jobready/timeout

s01ipsist · web-flow · commit 5983e86141ec · 2017-04-10T13:45:27.000+10:00
Add timeout feature
diff --git a/lib/moodle_rb.rb b/lib/moodle_rb.rb
@@ -10,7 +10,7 @@
 require 'moodle_rb/users'
 
 module MoodleRb
-  def self.new(token, url)
-    Client.new(token, url)
+  def self.new(token, url, query_options = {})
+    Client.new(token, url, query_options)
   end
 end
diff --git a/lib/moodle_rb/categories.rb b/lib/moodle_rb/categories.rb
@@ -3,11 +3,12 @@ class Categories
     include HTTParty
     include Utility
 
-    attr_reader :token
+    attr_reader :token, :query_options
     ROOT_CATEGORY = 0
 
-    def initialize(token, url)
+    def initialize(token, url, query_options)
       @token = token
+      @query_options = query_options
       self.class.base_uri url
     end
 
@@ -16,7 +17,7 @@ def index
         '/webservice/rest/server.php',
         {
           :query => query_hash('core_course_get_categories', token)
-        }
+        }.merge(query_options)
       )
       check_for_errors(response)
       response.parsed_response
@@ -47,7 +48,7 @@ def create(params)
               }
             }
           }
-        }
+        }.merge(query_options)
       )
       check_for_errors(response)
       response.parsed_response.first
@@ -66,7 +67,7 @@ def show(id)
               }
             }
           }
-        }
+        }.merge(query_options)
       )
       check_for_errors(response)
       response.parsed_response.first
@@ -85,7 +86,7 @@ def destroy(id)
               }
             }
           }
-        }
+        }.merge(query_options)
       )
       check_for_errors(response)
       response.parsed_response.nil?
diff --git a/lib/moodle_rb/client.rb b/lib/moodle_rb/client.rb
@@ -3,11 +3,12 @@ class Client
     include HTTParty
     include Utility
 
-    attr_reader :token, :url
+    attr_reader :token, :url, :query_options
 
-    def initialize(token, url)
+    def initialize(token, url, query_options)
       @token = token
       @url = url
+      @query_options = query_options
       self.class.base_uri url
     end
 
@@ -16,30 +17,30 @@ def site_info
         '/webservice/rest/server.php',
         {
           :query => query_hash('core_webservice_get_site_info', token)
-        }
+        }.merge(query_options)
       )
       check_for_errors(response)
       response.parsed_response
     end
 
     def courses
-      MoodleRb::Courses.new(token, url)
+      MoodleRb::Courses.new(token, url, query_options)
     end
 
     def categories
-      MoodleRb::Categories.new(token, url)
+      MoodleRb::Categories.new(token, url, query_options)
     end
 
     def users
-      MoodleRb::Users.new(token, url)
+      MoodleRb::Users.new(token, url, query_options)
     end
 
     def enrolments
-      MoodleRb::Enrolments.new(token, url)
+      MoodleRb::Enrolments.new(token, url, query_options)
     end
 
     def grades
-      MoodleRb::Grades.new(token, url)
+      MoodleRb::Grades.new(token, url, query_options)
     end
   end
 end
diff --git a/lib/moodle_rb/courses.rb b/lib/moodle_rb/courses.rb
@@ -3,10 +3,11 @@ class Courses
     include HTTParty
     include Utility
 
-    attr_reader :token
+    attr_reader :token, :query_options
 
-    def initialize(token, url)
+    def initialize(token, url, query_options)
       @token = token
+      @query_options = query_options
       self.class.base_uri url
     end
 
@@ -15,7 +16,7 @@ def index
         '/webservice/rest/server.php',
         {
           :query => query_hash('core_course_get_courses', token)
-        }
+        }.merge(query_options)
       )
       check_for_errors(response)
       response.parsed_response
@@ -45,7 +46,7 @@ def create(params)
               }
             }
           }
-        }
+        }.merge(query_options)
       )
       check_for_errors(response)
       response.parsed_response.first
@@ -63,7 +64,7 @@ def show(id)
               }
             }
           }
-        }
+        }.merge(query_options)
       )
       check_for_errors(response)
       response.parsed_response.first
@@ -79,7 +80,7 @@ def destroy(id)
               '0' => id
             }
           }
-        }
+        }.merge(query_options)
       )
       check_for_errors(response)
       response.parsed_response
@@ -93,7 +94,7 @@ def enrolled_users(course_id)
           :body => {
             :courseid => course_id
           }
-        }
+        }.merge(query_options)
       )
       check_for_errors(response)
       response.parsed_response
diff --git a/lib/moodle_rb/enrolments.rb b/lib/moodle_rb/enrolments.rb
@@ -3,11 +3,12 @@ class Enrolments
     include HTTParty
     include Utility
 
-    attr_reader :token
+    attr_reader :token, :query_options
     STUDENT_ROLE_ID = 5
 
-    def initialize(token, url)
+    def initialize(token, url, query_options)
       @token = token
+      @query_options = query_options
       self.class.base_uri url
     end
 
@@ -27,7 +28,7 @@ def create(params)
               }
             }
           }
-        }
+        }.merge(query_options)
       )
       check_for_errors(response)
       response.code == 200 && response.parsed_response.nil?
diff --git a/lib/moodle_rb/grades.rb b/lib/moodle_rb/grades.rb
@@ -3,10 +3,11 @@ class Grades
     include HTTParty
     include Utility
 
-    attr_reader :token
+    attr_reader :token, :query_options
 
-    def initialize(token, url)
+    def initialize(token, url, query_options)
       @token = token
+      @query_options = query_options
       self.class.base_uri url
     end
 
@@ -18,7 +19,7 @@ def by_assignment(assignment_id)
           :body => {
             :assignmentids => api_array(assignment_id)
           }
-        }
+        }.merge(query_options)
       )
       check_for_errors(response)
       response.parsed_response['assignments']
@@ -33,7 +34,7 @@ def by_course(course_id, *user_ids)
             :courseid => course_id,
             :userids => api_array(user_ids)
           }
-        }
+        }.merge(query_options)
       )
       check_for_errors(response)
       response.parsed_response['items']
diff --git a/lib/moodle_rb/users.rb b/lib/moodle_rb/users.rb
@@ -3,10 +3,11 @@ class Users
     include HTTParty
     include Utility
 
-    attr_reader :token
+    attr_reader :token, :query_options
 
-    def initialize(token, url)
+    def initialize(token, url, query_options)
       @token = token
+      @query_options = query_options
       self.class.base_uri url
     end
 
@@ -25,7 +26,7 @@ def create(params)
               '0' => params
             }
           }
-        }
+        }.merge(query_options)
       )
       check_for_errors(response)
       response.parsed_response.first
@@ -44,7 +45,7 @@ def show(id)
               }
             }
           }
-        }
+        }.merge(query_options)
       )
       check_for_errors(response)
       response.parsed_response['users'] &&
@@ -61,7 +62,7 @@ def destroy(id)
               '0' => id
             }
           }
-        }
+        }.merge(query_options)
       )
       check_for_errors(response)
       response.parsed_response.nil?
@@ -75,7 +76,7 @@ def enrolled_courses(user_id)
           :body => {
             :userid => user_id
           }
-        }
+        }.merge(query_options)
       )
       check_for_errors(response)
       response.parsed_response
@@ -91,7 +92,7 @@ def search(params = {})
           :body => {
             :criteria => key_value_query_format(params)
           }
-        }
+        }.merge(query_options)
       )
       check_for_errors(response)
       response.parsed_response['users']
@@ -110,7 +111,7 @@ def update(params)
               '0' => params
             }
           }
-        }
+        }.merge(query_options)
       )
       check_for_errors(response)
       response.response.code == '200'
diff --git a/lib/moodle_rb/version.rb b/lib/moodle_rb/version.rb
@@ -1,5 +1,5 @@
 module MoodleRb
-  VERSION = '1.0.3' unless defined?(self::VERSION)
+  VERSION = '1.0.4' unless defined?(self::VERSION)
 
   def self.version
     VERSION

Original file line number	Diff line number	Diff line change
`@@ -3,11 +3,12 @@ class Categories`
`3`	`3`	`include HTTParty`
`4`	`4`	`include Utility`
`5`	`5`
`6`		`- attr_reader :token`
	`6`	`+ attr_reader :token, :query_options`
`7`	`7`	`ROOT_CATEGORY = 0`
`8`	`8`
`9`		`- def initialize(token, url)`
	`9`	`+ def initialize(token, url, query_options)`
`10`	`10`	`@token = token`
	`11`	`+ @query_options = query_options`
`11`	`12`	`self.class.base_uri url`
`12`	`13`	`end`
`13`	`14`
`@@ -16,7 +17,7 @@ def index`
`16`	`17`	`'/webservice/rest/server.php',`
`17`	`18`	`{`
`18`	`19`	`:query => query_hash('core_course_get_categories', token)`
`19`		`- }`
	`20`	`+ }.merge(query_options)`
`20`	`21`	`)`
`21`	`22`	`check_for_errors(response)`
`22`	`23`	`response.parsed_response`
`@@ -47,7 +48,7 @@ def create(params)`
`47`	`48`	`}`
`48`	`49`	`}`
`49`	`50`	`}`
`50`		`- }`
	`51`	`+ }.merge(query_options)`
`51`	`52`	`)`
`52`	`53`	`check_for_errors(response)`
`53`	`54`	`response.parsed_response.first`
`@@ -66,7 +67,7 @@ def show(id)`
`66`	`67`	`}`
`67`	`68`	`}`
`68`	`69`	`}`
`69`		`- }`
	`70`	`+ }.merge(query_options)`
`70`	`71`	`)`
`71`	`72`	`check_for_errors(response)`
`72`	`73`	`response.parsed_response.first`
`@@ -85,7 +86,7 @@ def destroy(id)`
`85`	`86`	`}`
`86`	`87`	`}`
`87`	`88`	`}`
`88`		`- }`
	`89`	`+ }.merge(query_options)`
`89`	`90`	`)`
`90`	`91`	`check_for_errors(response)`
`91`	`92`	`response.parsed_response.nil?`
Original file line number	Diff line number	Diff line change
`@@ -3,10 +3,11 @@ class Courses`
`3`	`3`	`include HTTParty`
`4`	`4`	`include Utility`
`5`	`5`
`6`		`- attr_reader :token`
	`6`	`+ attr_reader :token, :query_options`
`7`	`7`
`8`		`- def initialize(token, url)`
	`8`	`+ def initialize(token, url, query_options)`
`9`	`9`	`@token = token`
	`10`	`+ @query_options = query_options`
`10`	`11`	`self.class.base_uri url`
`11`	`12`	`end`
`12`	`13`
`@@ -15,7 +16,7 @@ def index`
`15`	`16`	`'/webservice/rest/server.php',`
`16`	`17`	`{`
`17`	`18`	`:query => query_hash('core_course_get_courses', token)`
`18`		`- }`
	`19`	`+ }.merge(query_options)`
`19`	`20`	`)`
`20`	`21`	`check_for_errors(response)`
`21`	`22`	`response.parsed_response`
`@@ -45,7 +46,7 @@ def create(params)`
`45`	`46`	`}`
`46`	`47`	`}`
`47`	`48`	`}`
`48`		`- }`
	`49`	`+ }.merge(query_options)`
`49`	`50`	`)`
`50`	`51`	`check_for_errors(response)`
`51`	`52`	`response.parsed_response.first`
`@@ -63,7 +64,7 @@ def show(id)`
`63`	`64`	`}`
`64`	`65`	`}`
`65`	`66`	`}`
`66`		`- }`
	`67`	`+ }.merge(query_options)`
`67`	`68`	`)`
`68`	`69`	`check_for_errors(response)`
`69`	`70`	`response.parsed_response.first`
`@@ -79,7 +80,7 @@ def destroy(id)`
`79`	`80`	`'0' => id`
`80`	`81`	`}`
`81`	`82`	`}`
`82`		`- }`
	`83`	`+ }.merge(query_options)`
`83`	`84`	`)`
`84`	`85`	`check_for_errors(response)`
`85`	`86`	`response.parsed_response`
`@@ -93,7 +94,7 @@ def enrolled_users(course_id)`
`93`	`94`	`:body => {`
`94`	`95`	`:courseid => course_id`
`95`	`96`	`}`
`96`		`- }`
	`97`	`+ }.merge(query_options)`
`97`	`98`	`)`
`98`	`99`	`check_for_errors(response)`
`99`	`100`	`response.parsed_response`
Original file line number	Diff line number	Diff line change
`@@ -3,11 +3,12 @@ class Enrolments`
`3`	`3`	`include HTTParty`
`4`	`4`	`include Utility`
`5`	`5`
`6`		`- attr_reader :token`
	`6`	`+ attr_reader :token, :query_options`
`7`	`7`	`STUDENT_ROLE_ID = 5`
`8`	`8`
`9`		`- def initialize(token, url)`
	`9`	`+ def initialize(token, url, query_options)`
`10`	`10`	`@token = token`
	`11`	`+ @query_options = query_options`
`11`	`12`	`self.class.base_uri url`
`12`	`13`	`end`
`13`	`14`
`@@ -27,7 +28,7 @@ def create(params)`
`27`	`28`	`}`
`28`	`29`	`}`
`29`	`30`	`}`
`30`		`- }`
	`31`	`+ }.merge(query_options)`
`31`	`32`	`)`
`32`	`33`	`check_for_errors(response)`
`33`	`34`	`response.code == 200 && response.parsed_response.nil?`
Original file line number	Diff line number	Diff line change
`@@ -3,10 +3,11 @@ class Users`
`3`	`3`	`include HTTParty`
`4`	`4`	`include Utility`
`5`	`5`
`6`		`- attr_reader :token`
	`6`	`+ attr_reader :token, :query_options`
`7`	`7`
`8`		`- def initialize(token, url)`
	`8`	`+ def initialize(token, url, query_options)`
`9`	`9`	`@token = token`
	`10`	`+ @query_options = query_options`
`10`	`11`	`self.class.base_uri url`
`11`	`12`	`end`
`12`	`13`
`@@ -25,7 +26,7 @@ def create(params)`
`25`	`26`	`'0' => params`
`26`	`27`	`}`
`27`	`28`	`}`
`28`		`- }`
	`29`	`+ }.merge(query_options)`
`29`	`30`	`)`
`30`	`31`	`check_for_errors(response)`
`31`	`32`	`response.parsed_response.first`
`@@ -44,7 +45,7 @@ def show(id)`
`44`	`45`	`}`
`45`	`46`	`}`
`46`	`47`	`}`
`47`		`- }`
	`48`	`+ }.merge(query_options)`
`48`	`49`	`)`
`49`	`50`	`check_for_errors(response)`
`50`	`51`	`response.parsed_response['users'] &&`
`@@ -61,7 +62,7 @@ def destroy(id)`
`61`	`62`	`'0' => id`
`62`	`63`	`}`
`63`	`64`	`}`
`64`		`- }`
	`65`	`+ }.merge(query_options)`
`65`	`66`	`)`
`66`	`67`	`check_for_errors(response)`
`67`	`68`	`response.parsed_response.nil?`
`@@ -75,7 +76,7 @@ def enrolled_courses(user_id)`
`75`	`76`	`:body => {`
`76`	`77`	`:userid => user_id`
`77`	`78`	`}`
`78`		`- }`
	`79`	`+ }.merge(query_options)`
`79`	`80`	`)`
`80`	`81`	`check_for_errors(response)`
`81`	`82`	`response.parsed_response`
`@@ -91,7 +92,7 @@ def search(params = {})`
`91`	`92`	`:body => {`
`92`	`93`	`:criteria => key_value_query_format(params)`
`93`	`94`	`}`
`94`		`- }`
	`95`	`+ }.merge(query_options)`
`95`	`96`	`)`
`96`	`97`	`check_for_errors(response)`
`97`	`98`	`response.parsed_response['users']`
`@@ -110,7 +111,7 @@ def update(params)`
`110`	`111`	`'0' => params`
`111`	`112`	`}`
`112`	`113`	`}`
`113`		`- }`
	`114`	`+ }.merge(query_options)`
`114`	`115`	`)`
`115`	`116`	`check_for_errors(response)`
`116`	`117`	`response.response.code == '200'`