proctorserv-api 1.1.0 → 1.4.0

data/README.md

@@ -43,16 +43,29 @@ The workflow involves
   
   - createSessionEvent
   
-    Creating a severity-defined session event based on regular and irregular session activity such as irregular eye movement, checking into a session, etc. A list of session events can be found in SessionEvent.php. 
+    Creating a severity-defined session event based on regular and irregular session activity such as irregular eye movement, checking into a session, etc. A list of session events can be found 
+    [here](https://github.com/ProctorCam/web-integration/wiki/Create-Session-Event#event-types) 
   
     Session events are documented by the proctor and can be seen in the web interface after logging in with one's customer account. 
  
     
- - ####Reviewing the sesison
+ - ####Reviewing the session
  
    - generateSecureReviewUrl 
    
-    Generating a secure URL that grants temporary customer access to the review screen of one of their users' sessions. The review screen consists of the exam taker's audio, video, and desktop activity as recorded by ProctorApp. It can be accessed live or after the session has ended. 
+      Generating a secure URL that grants temporary customer access to the review screen of one of their users' sessions. The review screen consists of the exam taker's audio, video, and desktop activity as recorded by ProctorApp. It can be accessed live or after the session has ended. 
+
+- ####Obtaining session details
+   
+    - dataRetrievals 
+     
+      Will return data associated with a list of sessions. Users can find such information as the url to review a past session, url to download the video of a past session, url to download the photo of the id provided by the sessions test taker, a url to download the photo of test taker and a list of all session activity.
+
+- ####Deleting sessions
+   
+    - dataDeletions 
+     
+      Will delete all identifying data associated with a set of sessions
 
 
 ### Example workflow 
@@ -98,6 +111,16 @@ An exam taker in the integrating system is searching for a time to schedule a se
 - The integrating system makes an API request to generate a secure review URL for the customer
 - The secure review URL can be loaded into an iframe or a new window
 
+#####*Obtaining information about a list of sessions* (dataRetrievals)
+- A customer wants to get information about a list of sessions
+- The integrating system makes an API request retrieve the information requested
+- The integrating system gets sent a list of all data available based on the information requested for those sessions.
+
+#####*Deleting a session* (sessionDeletion)
+- A customer wants to delete a list of sessions
+- The integrating system makes an API request to delete a list of sessions and all associated data
+- The integrating system gets sent a list of all sessions that were sucessfully deleted
+
 #### Installation
 
 The Client API requires Ruby version >= 1.9.2. To find out what your verions is, use:
@@ -158,8 +181,11 @@ proctorserv_api.cancel_reservation
 proctorserv_api.generate_jsonp_token
 proctorserv_api.generate_secure_review_url
 proctorserv_api.create_session_event
+proctorserv_api.data_deletions
+proctorserv_api.data_retrievals
 ```
 
+
 ### Full Documentation
 
-Further documentation for these methods can be found [here](http://rubydoc.info/github/ProctorCam/proctorserv-api-rb/master/frames)
+Complete documentation can be found in our online developers guide [located here](http://guide.proctorcam.com/developers/). You will be able to find complete details regarding our api's, concepts, and getting started code recipes.

data/lib/proctorserv_api.rb

@@ -3,6 +3,7 @@ require 'proctorserv_api/exceptions/invalid_client_exception'
 require 'proctorserv_api/exceptions/invalid_ip_exception'
 require 'proctorserv_api/exceptions/invalid_signature_exception'
 require 'proctorserv_api/exceptions/missing_required_parameter_exception'
+require 'proctorserv_api/version'
 
 #
 # proctorserv_api.rb
@@ -28,8 +29,6 @@ require 'proctorserv_api/exceptions/missing_required_parameter_exception'
 module ProctorCam
   module Proctorserv
     class ProctorservApi
-
-      VERSION = "1.1.0"
       
       def initialize(api_identifier, shared_secret, service_protocol = "https", service_url = "service.proctorcam.com")
         @service_protocol = service_protocol
@@ -149,6 +148,44 @@ module ProctorCam
         parsed_response
       end
 
+      # get_access_code
+      #   Will return a hash containing access code and its expiration date time based
+      #   on a session ID provided in the request
+      #
+      #   required parameters:
+      #   - session_id     Integer
+      #
+      def get_access_code(options) 
+        requires_of options, [:session_id]
+        url = "#{@service_protocol}://#{@service_url}/api/access_code/#{__method__}"
+        response = RestRequestClient.new.make_post_request url, @api_identifier, @shared_secret, options
+
+        parsed_response = JSON.parse response.body
+        raise_exception_if_necessary(parsed_response) if response.code != 200
+
+        return parsed_response["message"] if parsed_response["message"]
+        parsed_response["access_code"]
+      end
+
+      # reset_access_code
+      #   Will return a hash containing new access code for a session
+      #   based on a session ID provided in the request
+      #
+      #   required parameters:
+      #   - session_id     Integer
+      #
+      def reset_access_code(options) 
+        requires_of options, [:session_id]
+        url = "#{@service_protocol}://#{@service_url}/api/access_code/#{__method__}"
+        response = RestRequestClient.new.make_post_request url, @api_identifier, @shared_secret, options
+
+        parsed_response = JSON.parse response.body
+        raise_exception_if_necessary(parsed_response) if response.code != 200
+        
+        return parsed_response if parsed_response["message"]
+        parsed_response["access_code"]
+      end
+
       ## dataDeletions
       #
       #   Will delete all identifying data associated with a set of sessions

data/lib/proctorserv_api/rest_request_client.rb

@@ -37,7 +37,7 @@ module ProctorCam
 
       def make_post_request(url, customer_identifier, shared_secret, params)
         HashedAuthenticator.apply_reverse_guid_and_sign(params, customer_identifier, shared_secret)
-        return RestClient.post url, params, :accept => :json, :content_type => :json do |response, request, result, &block|
+        return RestClient.post url, params.to_json, :accept => :json, :content_type => :json do |response, request, result, &block|
           return response
         end
       end

data/lib/proctorserv_api/version.rb

@@ -0,0 +1,28 @@
+#
+# version.rb
+# ProctorservApi
+#
+# Copyright 2013 ProctorCam, Inc
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# Created by Max Lahey on 4/7/14.
+#
+
+module ProctorCam
+  module Proctorserv
+    class ProctorservApi
+      VERSION = "1.4.0"
+    end
+  end
+end

data/spec/proctorserv_api_spec.rb

@@ -75,6 +75,47 @@ describe ProctorCam::Proctorserv::ProctorservApi do
 
   end
 
+
+  describe "get_access_code" do
+
+    it "raises missing_required_parameter_exception when not passed sesison_id in options hash" do
+      expect{@proctorserv_api.get_access_code({:wrong => 10})}.to raise_error ProctorCam::Proctorserv::MissingRequiredParameterException
+    end
+
+    it "returns an error message stating session id doesn't exist if improper session id is provided" do
+      options  = {:session_id => 2}
+      response = @proctorserv_api.get_access_code(options)
+      expect(response).to eql("Session id does not exist") 
+    end
+
+    it "returns an access code and expiration date time" do
+      options  = {:session_id => 1700}
+      response = @proctorserv_api.get_access_code(options)
+      puts response
+      expect(response["code"].to_s.size).to eql(9) 
+    end
+  end
+
+    describe "reset_access_code" do
+
+    it "raises missing_required_parameter_exception when not passed sesison_id in options hash" do
+      expect{@proctorserv_api.reset_access_code({:wrong => 10})}.to raise_error ProctorCam::Proctorserv::MissingRequiredParameterException
+    end
+
+    it "returns an error message stating session id doesn't exist if improper session id is provided" do
+      options  = {:session_id => 582309823907}
+      response = @proctorserv_api.reset_access_code(options)
+      expect(response["message"]).to eql("Session id does not exist") 
+    end
+
+    it "returns an access code and expiration date time" do
+      options  = {:session_id => 57}
+      response = @proctorserv_api.reset_access_code(options)
+
+      expect(response["new_access_code"].to_s.size).to eql(9)
+    end
+  end
+
   describe "get_available_timeslots_around" do
 
     it "raises missing_required_parameter_exception when not passed time, num_slots, and session_duration in options hash" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: proctorserv-api
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-25 00:00:00.000000000 Z
+date: 2014-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -57,6 +57,7 @@ files:
 - lib/proctorserv_api/exceptions/missing_required_parameter_exception.rb
 - lib/proctorserv_api/hashed_authenticator.rb
 - lib/proctorserv_api/rest_request_client.rb
+- lib/proctorserv_api/version.rb
 - lib/proctorserv_api.rb
 - LICENSE
 - README.md