proctorserv-api 1.0.0 → 1.0.1
Sign up to get free protection for your applications and to get access to all the features.
- data/README.md +29 -3
- data/lib/proctorserv_api.rb +2 -0
- metadata +2 -3
- data/lib/proctorserv_api/version.rb +0 -7
data/README.md
CHANGED
|
@@ -1,14 +1,40 @@
|
|
|
1
1
|
### ProctorservApi Client
|
|
2
2
|
|
|
3
|
-
A ruby wrapper around the Proctorserve scheduling API.
|
|
3
|
+
A ruby wrapper around the Proctorserve scheduling API, which allows a web service to manage various scheduling actions. This gem is framework agnostic -- it will work as part of a Rails or Sinatra project as easily as from a stand-alone script.
|
|
4
|
+
|
|
5
|
+
Creating a session through the scheduling API sets up a future or immediate opportunity for one of your users to take their examination in a proctored and recorded environment. Important identifiers (eg. user or test instance) are required so that an integrating web service can request an individual session to playback or a more involved list (like all test sessions for an exam or all test sessions for a specific user/subject). When required, we further scope our customers' sessions by client.
|
|
6
|
+
|
|
7
|
+
#### Example workflows
|
|
8
|
+
|
|
9
|
+
*Scheduling ahead of time*
|
|
10
|
+
|
|
11
|
+
- A test taker in the integrating system needs to select a time to take their examination.
|
|
12
|
+
- The integrating system makes an API request to Proctorserve to get a list of scheduable times
|
|
13
|
+
- The test taker chooses a schedulable time, triggering an API request to Proctorserve to make a reservation for that user at that time
|
|
14
|
+
- On test day, the integrating system presents the test taker with the Proctorserve launch session component
|
|
15
|
+
- The tast taker downloads the ProctorApp desktop application and completes their session
|
|
16
|
+
|
|
17
|
+
*Scheduling for now*
|
|
18
|
+
|
|
19
|
+
A test taker in the integrating system is ready to take their examination
|
|
20
|
+
|
|
21
|
+
- The integrating system makes an API request to Proctorserve to make an immediate reservation
|
|
22
|
+
- The integrating syste presents the test taker with the Proctorserve launch session component
|
|
23
|
+
- The tast taker downloads the ProctorApp desktop application and completes their session
|
|
4
24
|
|
|
5
25
|
#### Installation
|
|
6
26
|
|
|
7
|
-
|
|
27
|
+
$ gem install proctorserv-api
|
|
28
|
+
|
|
29
|
+
To use our ruby API in a project
|
|
30
|
+
|
|
31
|
+
```ruby
|
|
32
|
+
require 'proctorserv_api'
|
|
33
|
+
```
|
|
8
34
|
|
|
9
35
|
#### Configuration
|
|
10
36
|
|
|
11
|
-
The constructor takes two
|
|
37
|
+
The constructor takes two required parameters: the customer_identifier and shared_secret
|
|
12
38
|
|
|
13
39
|
_What's my customer_identifier?_
|
|
14
40
|
|
data/lib/proctorserv_api.rb
CHANGED
|
@@ -28,6 +28,8 @@ require 'proctorserv_api/exceptions/missing_required_parameter_exception'
|
|
|
28
28
|
module ProctorCam
|
|
29
29
|
module Proctorserv
|
|
30
30
|
class ProctorservApi
|
|
31
|
+
|
|
32
|
+
VERSION = "1.0.1"
|
|
31
33
|
|
|
32
34
|
def initialize(api_identifier, shared_secret, service_protocol = "https", service_url = "service.proctorcam.com")
|
|
33
35
|
@service_protocol = service_protocol
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: proctorserv-api
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 1.0.
|
|
4
|
+
version: 1.0.1
|
|
5
5
|
prerelease:
|
|
6
6
|
platform: ruby
|
|
7
7
|
authors:
|
|
@@ -9,7 +9,7 @@ authors:
|
|
|
9
9
|
autorequire:
|
|
10
10
|
bindir: bin
|
|
11
11
|
cert_chain: []
|
|
12
|
-
date: 2013-06-
|
|
12
|
+
date: 2013-06-10 00:00:00.000000000 Z
|
|
13
13
|
dependencies:
|
|
14
14
|
- !ruby/object:Gem::Dependency
|
|
15
15
|
name: rest-client
|
|
@@ -57,7 +57,6 @@ files:
|
|
|
57
57
|
- lib/proctorserv_api/exceptions/missing_required_parameter_exception.rb
|
|
58
58
|
- lib/proctorserv_api/hashed_authenticator.rb
|
|
59
59
|
- lib/proctorserv_api/rest_request_client.rb
|
|
60
|
-
- lib/proctorserv_api/version.rb
|
|
61
60
|
- lib/proctorserv_api.rb
|
|
62
61
|
- LICENSE
|
|
63
62
|
- README.md
|