proctorserv-api 1.0.0

data/LICENSE

@@ -0,0 +1,13 @@
+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.

data/README.md

@@ -0,0 +1,47 @@
+### ProctorservApi Client
+
+A ruby wrapper around the Proctorserve scheduling API. Supports listing timeslots that are available to schedule a test session for, scheduling a test session, and canceling a test session.
+
+#### Installation
+
+      $ gem install proctorserv-api
+
+#### Configuration
+
+The constructor takes two important options: the customer_identifier and shared_secret
+
+_What's my customer_identifier?_
+
+the Proctorserve service requires that incoming requests identify who is sending them with a `customer_id` parameter. Once your account has been set up, your customer id should be viewable and editable through the web interface. 
+
+_What's the shared_secret for?_
+
+Proctorserve uses a secret key that is shared between customer and service as part of a two-factor authentication scheme. This is also viewable and editable through the web interface. It is important to keep this secure, otherwise a man in the middle can make requests on your behalf.
+
+#### Usage
+
+```ruby
+proctorserv_api = Proctorcam::Proctorserv::ProctorservApi.new("our_customer_identifier", "our_shared_secret")
+options = {
+  :scheduling_window_start => Time.now,
+  :scheduling_window_end => scheduling_window_start + 24 * 60 * 60, # tomorrow at this time
+  :test_length => 60 # minutes
+}
+available_timeslots = proctorserv_api.get_available_timeslots_between options
+# returns a list of available timeslots between now and 24 hours from now.
+```
+
+#### Interface
+
+The following methods are supported
+
+```ruby
+proctorserv_api = Proctorcam::Proctorserv::ProctorservApi.new("our_customer_identifier", "our_shared_secret")
+proctorserv_api.get_available_timeslots_between
+proctorserv_api.get_available_timeslots_around
+proctorserv_api.make_reservation
+proctorserv_api.make_immediate_reservation
+proctorserv_api.cancel_reservation
+```
+
+Further documentation for these methods can be found in the `doc/` folder

data/lib/proctorserv_api/exceptions/invalid_client_exception.rb

@@ -0,0 +1,27 @@
+#
+# invalid_client_exception.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 6/6/13.
+#
+
+module ProctorCam
+  module Proctorserv
+    class InvalidClientException < Exception
+    end
+  end
+end

data/lib/proctorserv_api/exceptions/invalid_ip_exception.rb

@@ -0,0 +1,27 @@
+#
+# invalid_ip_exception.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 6/6/13.
+#
+
+module ProctorCam
+  module Proctorserv
+    class InvalidIpException < Exception
+    end
+  end
+end

data/lib/proctorserv_api/exceptions/invalid_signature_exception.rb

@@ -0,0 +1,27 @@
+#
+# invalid_signature_exception.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 6/6/13.
+#
+
+module ProctorCam
+  module Proctorserv
+    class InvalidSignatureException < Exception
+    end
+  end
+end

data/lib/proctorserv_api/exceptions/missing_required_parameter_exception.rb

@@ -0,0 +1,27 @@
+#
+# missing_required_parameter_exception.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 6/6/13.
+#
+
+module ProctorCam
+  module Proctorserv
+    class MissingRequiredParameterException < Exception
+    end
+  end
+end

data/lib/proctorserv_api/hashed_authenticator.rb

@@ -0,0 +1,39 @@
+require 'digest'
+require 'securerandom'
+
+#
+# hashed_authenticator.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 6/6/13.
+#
+
+module ProctorCam
+  module Proctorserv
+    class HashedAuthenticator
+
+      def self.apply_reverse_guid_and_sign(params, customer_identifier, shared_secret)
+        params[:guid] = SecureRandom.hex(32)
+        params[:customer_id] = customer_identifier
+        query_string = params.map{|k,v| "#{k}=#{v}" }.join('&') + shared_secret
+        params[:guid].reverse!
+        params[:signature] = Digest::SHA256.hexdigest query_string
+      end
+
+    end
+  end
+end

data/lib/proctorserv_api/rest_request_client.rb

@@ -0,0 +1,48 @@
+require 'rest-client'
+require 'json'
+require 'proctorserv_api/hashed_authenticator'
+
+#
+# rest_request_client.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 6/6/13.
+#
+
+module ProctorCam
+  module Proctorserv
+    class RestRequestClient
+      attr_accessor :response
+
+      def make_get_request(url, customer_identifier, shared_secret, params)
+        HashedAuthenticator.apply_reverse_guid_and_sign(params, customer_identifier, shared_secret)
+        RestClient.get url, :params => params, :accept => :json, :content_type => :json do |response, request, result, &block|
+          return response
+        end
+      end
+
+      def make_post_request(url, customer_identifier, shared_secret, params)
+        HashedAuthenticator.apply_reverse_guid_and_sign(params, customer_identifier, shared_secret)
+        RestClient.post url, params.to_json, :accept => :json, :content_type => :json do |response, request, result, &block|
+          return response
+        end
+      end
+
+
+    end
+  end
+end

data/lib/proctorserv_api/version.rb

@@ -0,0 +1,7 @@
+module ProctorCam
+  module Proctorserv
+    module ProctorservApi
+      VERSION = "1.0.0"
+    end
+  end
+end

data/lib/proctorserv_api.rb

@@ -0,0 +1,183 @@
+require 'proctorserv_api/rest_request_client'
+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'
+
+#
+# proctorserv_api.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 6/6/13.
+#
+
+module ProctorCam
+  module Proctorserv
+    class ProctorservApi
+      
+      def initialize(api_identifier, shared_secret, service_protocol = "https", service_url = "service.proctorcam.com")
+        @service_protocol = service_protocol
+        @service_url = service_url
+        @api_identifier = api_identifier
+        @shared_secret = shared_secret
+      end
+
+      # Get a list of schedulable timeslots (represented as Time objects) between two
+      # times for a given test that needs to be scheduled. This API request takes the
+      # provided session_duration into account when comparing Proctorserve business hours.
+      # The timeslots returned are specific for a test of duration provided.
+      #
+      # This method will raise exceptions related to authentication (InvalidClientException, InvalidSignatureException, InvalidIpException) or not providing required data (MissingRequiredParameterException)
+      #
+      # @param [Hash{Symbol => String}] options
+      #   - :lower_bound (Time or int seconds since epoch) - the earlier of two timestamps to find available timeslots between
+      #   - :upper_bound (Time or int seconds since epoch) - the later of two timestamps to find available timeslots between
+      #   - :session_duration (int) - is the length in minutes alloted for this examination
+      # @return [Array<Time>] list of Time objects that represent schedulable timeslots in Proctorserve for a test of length session_duration between lower_bound and upper_bound
+      def get_available_timeslots_between(options)
+        requires_of options, [:lower_bound, :upper_bound, :session_duration]
+        url = "#{@service_protocol}://#{@service_url}/#{__method__}"
+        convert_times_to_integer options, :lower_bound, :upper_bound
+        response = RestRequestClient.new.make_get_request url, @api_identifier, @shared_secret, options
+        parsed_response = JSON.parse response
+        raise_exception_if_necessary(parsed_response) if response.code != 200
+
+        parsed_response.map{|timestamp| Time.at(timestamp)}
+      end
+
+      # Get a list of schedulable timeslots (represented as Time objects) around the
+      # time for a given test that needs to be scheduled. This API request takes the
+      # provided session_duration into account when comparing Proctorserve business hours.
+      # The timeslots returned are specific for a test of duration provided. At most
+      # 20 slots will be returned
+      #
+      # This method will raise exceptions related to authentication (InvalidClientException, InvalidSignatureException, InvalidIpException) or not providing required data (MissingRequiredParameterException)
+      #
+      # @param [Hash{Symbol => String}] options
+      #   - :time (Time or int seconds since epoch) - time around which to find slots
+      #   - :num_slots (int) - number of slots to return
+      #   - :session_duration (int) - length in minutes alloted for this examination
+      # @return [Array<Time>] list (length num_slots or 20) of Time objects that represent schedulable timeslots in Proctorserve for a test of length session_duration around time passed in options hash
+      def get_available_timeslots_around(options)
+        requires_of options, [:time, :num_slots, :session_duration]
+        url = "#{@service_protocol}://#{@service_url}/#{__method__}"
+        convert_times_to_integer options, :time
+        response = RestRequestClient.new.make_get_request url, @api_identifier, @shared_secret, options
+        parsed_response = JSON.parse response
+        raise_exception_if_necessary(parsed_response) if response.code != 200
+
+        parsed_response.map{|timestamp| Time.at(timestamp)}
+      end
+
+      # Makes a reservation for a session if the time passed in options is a schedulable time.
+      #
+      # This method will raise exceptions related to authentication (InvalidClientException, InvalidSignatureException, InvalidIpException) or not providing required data (MissingRequiredParameterException)
+      #
+      # @param [Hash{Symbol => String}] options
+      #   - :time (Time or int seconds since epoch) - Scheduable time for examination, as obtained by get_available_timeslots_between or get_available_timeslots_around
+      #   - :customer_subject_id (String) - Unique identifier in API customer's system for the person taking this test
+      #   - :customer_client_subject_id (String) - Unique identifier in API customer's client's system for the person taking this test
+      #   - :client_code (String) - Unique identifier for API customer's client
+      #   - :reservation_id (String) - Unique identifier representing this test instance in API customer's system
+      #   - :session_duration (int) - Session length in minutes
+      #   - :exam_code (String) - Unique identifier representing the group of tests this specific test instance belongs to
+      # @return [int] session_id - the Proctorserve id for the created session. Will return nil if the time passed is not scheduable.
+      def make_reservation(options)
+        requires_of options, [:time, :customer_subject_id, :customer_client_subject_id, :client_code, :reservation_id, :session_duration, :exam_code]
+        url = "#{@service_protocol}://#{@service_url}/#{__method__}"
+        convert_times_to_integer options, :time
+        response = RestRequestClient.new.make_post_request url, @api_identifier, @shared_secret, options
+
+        parsed_response = JSON.parse response
+        raise_exception_if_necessary(parsed_response) if response.code != 200
+
+        return nil if response.code == 404
+
+        parsed_response["session_id"]
+      end
+
+      # Makes a reservation for a session if now is a schedulable time.
+      #
+      # This method will raise exceptions related to authentication (InvalidClientException, InvalidSignatureException, InvalidIpException) or not providing required data (MissingRequiredParameterException)
+      #
+      # @param [Hash{Symbol => String}] options
+      #   - :customer_subject_id (String) - Unique identifier in API customer's system for the person taking this test
+      #   - :customer_client_subject_id (String) - Unique identifier in API customer's client's system for the person taking this test
+      #   - :client_code (String) - Unique identifier for API customer's client
+      #   - :reservation_id (String) - Unique identifier representing this test instance in API customer's system
+      #   - :session_duration (int) - Session length in minutes
+      #   - :exam_code (String) - Unique identifier representing the group of tests this specific test instance belongs to
+      # @return [int] session_id - the Proctorserve id for the created session. Will return nil if the time passed is not scheduable.
+      def make_immediate_reservation(options)
+        requires_of options, [:customer_subject_id, :customer_client_subject_id, :client_code, :reservation_id, :session_duration, :exam_code]
+        url = "#{@service_protocol}://#{@service_url}/#{__method__}"
+        convert_times_to_integer options, :time
+        response = RestRequestClient.new.make_post_request url, @api_identifier, @shared_secret, options
+
+        parsed_response = JSON.parse response
+        raise_exception_if_necessary(parsed_response) if response.code != 200
+
+        return nil if response.code == 404
+
+        parsed_response["session_id"]
+      end
+
+      # Cancels a reservation for a specific session_id. A session is no longer cancelable if it has already begun or the scheduled time has passed.
+      #
+      # This method will raise exceptions related to authentication (InvalidClientException, InvalidSignatureException, InvalidIpException) or not providing required data (MissingRequiredParameterException)
+      #
+      # @param [int] session_id Proctorserve id for the session to be canceled 
+      # @return [Boolean] whether or not the test was successfully canceled.
+      def cancel_reservation(options)
+        requires_of options, [:session_id]
+        url = "#{@service_protocol}://#{@service_url}/#{__method__}"
+        response = RestRequestClient.new.make_post_request url, @api_identifier, @shared_secret, options
+
+        return true if response.code == 204
+
+        if response.code != 200
+          parsed_response = JSON.parse response
+          raise_exception_if_necessary(parsed_response) 
+        end
+
+        false
+      end
+
+      protected 
+
+      def raise_exception_if_necessary(response)
+        case response["message"]
+        when "Not a valid client"
+          raise InvalidClientException, "The api_identifier for this instance of ProctorservApi does not match up with any for the service."
+        when "Signature hash is invalid"
+          raise InvalidSignatureException, "Authentication failed for the ProctorservApi request. It is most likely that the shared_secret does not match up with the Proctorserve record for your API client."
+        when "Request coming from invalid IP"
+          raise InvalidIpException, "Authentication failed for the ProctorservApi request because the IP address of this machine is not whitelisted for this API client in Proctorserve."
+        end
+      end
+
+      def requires_of(hash, arguments)
+        arguments.each{|argument| raise MissingRequiredParameterException, "#{argument} is a required parameter" unless hash.key? argument}
+      end
+
+      def convert_times_to_integer(hash, *times)
+        times.each{|time| hash[time] = hash[time].to_i}
+      end
+
+    end
+  end
+end

data/spec/proctorserv_api_spec.rb

@@ -0,0 +1,139 @@
+require './lib/proctorserv_api'
+require 'rspec'
+
+#
+# proctorserv_api_spec.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 6/6/13.
+#
+
+describe ProctorCam::Proctorserv::ProctorservApi do
+
+  before :all do
+    @proctorserv_api = ProctorCam::Proctorserv::ProctorservApi.new("api_identifier", "shared_secret", "http", "localhost:3000/api/scheduling")
+  end
+
+  describe "when passed improper credentials" do
+
+    it "raises an invalid_client_exception when api_identifier is wrong" do
+      proctorserv_api = ProctorCam::Proctorserv::ProctorservApi.new("wrong", "shared_secret", "http", "localhost:3000/api/scheduling")
+      expect{proctorserv_api.get_available_timeslots_between({:lower_bound => Time.now.to_i, :upper_bound => Time.now.to_i + 24*60*60, :session_duration => 60})}.to raise_error ProctorCam::Proctorserv::InvalidClientException
+    end
+
+    it "raises an invalid_signature_exception when shared_secret is wrong" do
+      proctorserv_api = ProctorCam::Proctorserv::ProctorservApi.new("api_identifier", "wrong", "http", "localhost:3000/api/scheduling")
+      expect{proctorserv_api.get_available_timeslots_between({:lower_bound => Time.now.to_i, :upper_bound => Time.now.to_i + 24*60*60, :session_duration => 60})}.to raise_error ProctorCam::Proctorserv::InvalidSignatureException
+    end
+
+  end
+
+  describe "get_available_timeslots_between" do
+
+    it "raises missing_required_parameter_exception when not passed lower_bound, upper_bound, and session_duration in options hash" do
+      expect{@proctorserv_api.get_available_timeslots_between({:lower_bound => Time.now.to_i, :upper_bound => Time.now.to_i + 24*60*60})}.to raise_error ProctorCam::Proctorserv::MissingRequiredParameterException
+      expect{@proctorserv_api.get_available_timeslots_between({:lower_bound => Time.now.to_i, :session_duration => 60})}.to raise_error ProctorCam::Proctorserv::MissingRequiredParameterException
+      expect{@proctorserv_api.get_available_timeslots_between({:upper_bound => Time.now.to_i + 24*60*60, :session_duration => 60})}.to raise_error ProctorCam::Proctorserv::MissingRequiredParameterException
+    end
+
+    it "returns a list of schedulable timeslots when passed required parameters" do
+      response = @proctorserv_api.get_available_timeslots_between({:lower_bound => Time.now.to_i, :upper_bound => Time.now.to_i + 24*60*60, :session_duration => 60})
+      response.class.should == Array
+      response.length.should > 0
+    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
+      expect{@proctorserv_api.get_available_timeslots_around({:time => Time.now.to_i, :num_slots => 10})}.to raise_error ProctorCam::Proctorserv::MissingRequiredParameterException
+      expect{@proctorserv_api.get_available_timeslots_around({:time => Time.now.to_i, :session_duration => 60})}.to raise_error ProctorCam::Proctorserv::MissingRequiredParameterException
+      expect{@proctorserv_api.get_available_timeslots_around({:num_slots => 10, :session_duration => 60})}.to raise_error ProctorCam::Proctorserv::MissingRequiredParameterException
+    end
+
+    it "returns a list of schedulable timeslots when passed required parameters" do
+      response = @proctorserv_api.get_available_timeslots_around({:time => Time.now.to_i, :num_slots => 10, :session_duration => 60})
+      response.class.should == Array
+      response.length.should == 10
+    end
+
+  end
+
+  describe "make_reservation" do
+
+    it "raises missing_required_parameter_exception when not passed [:time, :customer_subject_id, :customer_client_subject_id, :client_code, :reservation_id, :session_duration, :exam_code] in options hash" do
+      options = {:time => Time.now.to_i, :customer_subject_id => 'c_sub_1', :customer_client_subject_id => 'c_c_sub_1', :client_code => 'c_code', :reservation_id => 'res_id', :session_duration => 60, :exam_code => 'e-code-15a'}
+      options.each do |k,v|
+        expect{@proctorserv_api.make_reservation options.reject{|key,v| key == k}  }.to raise_error ProctorCam::Proctorserv::MissingRequiredParameterException
+      end
+    end
+
+    it "returns nil when time provided is not schedulable" do
+      options = {:time => Time.new(1970, 1, 1, 6, 0, 0), :customer_subject_id => 'c_sub_1', :customer_client_subject_id => 'c_c_sub_1', :client_code => 'c_code', :reservation_id => 'res_id', :session_duration => 60, :exam_code => 'e-code-15a'}
+      response = @proctorserv_api.make_reservation options
+      response.should == nil
+    end
+
+    it "returns an int value representing session_id when provided a schedulable time and all required parameters" do
+      options = {:time => Time.now.to_i, :customer_subject_id => 'c_sub_1', :customer_client_subject_id => 'c_c_sub_1', :client_code => 'c_code', :reservation_id => 'res_id', :session_duration => 60, :exam_code => 'e-code-15a'}
+      response = @proctorserv_api.make_reservation options
+      response.class.should == Fixnum
+    end
+
+  end
+
+  describe "make_immediate_reservation" do
+
+    it "raises missing_required_parameter_exception when not passed [:customer_subject_id, :customer_client_subject_id, :client_code, :reservation_id, :session_duration, :exam_code] in options hash" do
+      options = {:customer_subject_id => 'c_sub_1', :customer_client_subject_id => 'c_c_sub_1', :client_code => 'c_code', :reservation_id => 'res_id', :session_duration => 60, :exam_code => 'e-code-15a'}
+      options.each do |k,v|
+        expect{@proctorserv_api.make_immediate_reservation options.reject{|key,v| key == k}  }.to raise_error ProctorCam::Proctorserv::MissingRequiredParameterException
+      end
+    end
+
+    it "returns an int value representing session_id when now is a schedulable time and all required parameters" do
+      options = {:customer_subject_id => 'c_sub_1', :customer_client_subject_id => 'c_c_sub_1', :client_code => 'c_code', :reservation_id => 'res_id', :session_duration => 60, :exam_code => 'e-code-15a'}
+      response = @proctorserv_api.make_immediate_reservation options
+      response.class.should == Fixnum
+    end
+
+  end
+
+  describe "cancel_reservation" do
+    
+    it "raises missing_required_parameter_exception when not passed session_id in options hash" do
+      expect{@proctorserv_api.cancel_reservation({})}.to raise_error ProctorCam::Proctorserv::MissingRequiredParameterException
+    end
+
+    it "returns true when passed a session_id that that this client owns that is still cancelable" do
+      options = {:time => Time.now.to_i + 24*60*60, :customer_subject_id => 'c_sub_1', :customer_client_subject_id => 'c_c_sub_1', :client_code => 'c_code', :reservation_id => 'res_id', :session_duration => 60, :exam_code => 'e-code-15a'}
+      session_id = @proctorserv_api.make_reservation options
+      response = @proctorserv_api.cancel_reservation({:session_id => session_id})
+      response.should == true
+    end
+
+    it "returns false when passed a session_id that that this client owns that is no longer cancelable" do
+      options = {:time => Time.now.to_i - 5, :customer_subject_id => 'c_sub_1', :customer_client_subject_id => 'c_c_sub_1', :client_code => 'c_code', :reservation_id => 'res_id', :session_duration => 60, :exam_code => 'e-code-15a'}
+      session_id = @proctorserv_api.make_reservation options
+      response = @proctorserv_api.cancel_reservation({:session_id => session_id})
+      response.should == false
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: proctorserv-api
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Max Lahey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: Supports listing timeslots that are available to schedule a test session
+  for, scheduling a test session, and canceling a test session.
+email:
+- max@proctorcam.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/proctorserv_api/exceptions/invalid_client_exception.rb
+- lib/proctorserv_api/exceptions/invalid_ip_exception.rb
+- lib/proctorserv_api/exceptions/invalid_signature_exception.rb
+- 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
+- spec/proctorserv_api_spec.rb
+homepage: http://github.com/proctorcam/proctorserv-api
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A ruby wrapper around the Proctorserve scheduling API.
+test_files:
+- spec/proctorserv_api_spec.rb
+has_rdoc: