icws 0.0.3 → 1.0.0

data/lib/icws/icwsclient.rb

@@ -3,38 +3,93 @@ require 'rubygems'
 require 'json'
 
 class ICWS
-  class Client
-    def initialize(connection)
-      @connection = connection
-      headers = {:Cookie => @connection.cookie,"ININ-ICWS-CSRF-Token" => @connection.token}
-      @http_resource = RestClient::Resource.new(@connection.base_uri, :headers => headers)
-    end
-    
-    def post(url, body, headers={})
-      begin
-        JSON.parse @http_resource[url].post body.to_json, headers
-      rescue => e
-        puts e.inspect
-        throw e
-      end
-    end
-    
-    def get(url, headers={})
-      JSON.parse @http_resource[url].get headers 
-    end
-    
-    def delete(url, headers={})
-      @http_resource[url].delete headers
-    end
-    
-    def put(url, body, headers={})
-      begin
-      @http_resource[url].put body.to_json, headers
-      rescue => e
-        puts e.inspect
-        throw e
-      end
-        
+    # REST wrapper around the ICWS connection. This class handles setting the proper cookies and headers for
+    # each request.
+
+    class Client
+        # Creates a new ICWS Client
+        #
+        # == Parameters:
+        # connection::
+        #   ICWS::Connection instance
+        def initialize(connection)
+            @connection = connection
+            headers = {:Cookie => @connection.cookie,"ININ-ICWS-CSRF-Token" => @connection.token}
+            @http_resource = RestClient::Resource.new(@connection.base_uri, :headers => headers)
+        end
+
+        # Makes a POST call to the server.
+        #
+        # == Parameters:
+        # url::
+        #   The Url to call the POST On
+        #
+        # headers::
+        #   Optional additional headers to send
+        #
+        # == Returns:
+        # The response from the server
+        #
+        def post(url, body, headers={})
+            begin
+                JSON.parse @http_resource[url].post body.to_json, headers
+            rescue => e
+                puts e.inspect
+                throw e
+            end
+        end
+
+
+        # Makes a GET call to the server.
+        #
+        # == Parameters:
+        # url::
+        #   The Url to call the GET On
+        #
+        # headers::
+        #   Optional additional headers to send
+        #
+        # == Returns:
+        # The response from the server
+        #
+
+        def get(url, headers={})
+            JSON.parse @http_resource[url].get headers
+        end
+
+        # Makes a DELETE call to the server.
+        #
+        # == Parameters:
+        # url::
+        #   The Url to call the DELETE On
+        #
+        # headers::
+        #   Optional additional headers to send
+        #
+        def delete(url, headers={})
+            @http_resource[url].delete headers
+        end
+
+        # Makes a PUT call to the server.
+        #
+        # == Parameters:
+        # url::
+        #   The Url to call the PUT On
+        #
+        # headers::
+        #   Optional additional headers to send
+        #
+        # == Returns:
+        # The response from the server
+        #
+        def put(url, body, headers={})
+            begin
+                @http_resource[url].put body.to_json, headers
+            rescue => e
+                puts e.inspect
+                throw e
+            end
+
+        end
     end
-  end
 end

data/lib/icws/messages/messagequeue.rb

@@ -1,65 +1,68 @@
 class ICWS
-  class MessageQueue
-    #http://stackoverflow.com/questions/605169/how-to-do-events-in-ruby
-    class EventHandlerArray < Array
-      def add_handler(&block)
-          push(block)
-      end
-      def add
-        raise "error"
-      end
-      def remove_handler(code)
-        delete(code)
-      end
-      def fire(e)
-        reverse_each { |handler| 
-          begin
-            handler.call(e)
-          rescue => e
-            puts e.inspect
-          end
-         }
-      end
+    #The message queue manages callbacks for different objects that are receiving messages from CIC.
+    class MessageQueue
+        class EventHandlerArray < Array
+            def add_handler(&block)
+                push(block)
+            end
+            def add
+                raise "error"
+            end
+            def remove_handler(code)
+                delete(code)
+            end
+            def fire(e)
+                reverse_each { |handler|
+                    begin
+                        handler.call(e)
+                    rescue => e
+                        puts e.inspect
+                    end
+                }
+            end
+        end
+
+        def initialize(connection)
+            @message_handlers = {}
+            @client = ICWS::Client.new connection
+
+            @pollingThread = Thread.new() {
+                poll_loop
+            }
+        end
+
+        #register for a new message type.
+        # @param messageType [String] The type of messages to receive notifications for.
+        # @param block [&block] Block to call when a message of that type is received.
+        def register(messageType, &block)
+            if(@message_handlers[messageType] == nil)
+                @message_handlers[messageType] = EventHandlerArray.new
+            end
+            callback = block
+            @message_handlers[messageType].add_handler {|e| callback.call(e)}
+        end
+
+        def deregister(messageType, code)
+            if(@message_handlers[messageType] == nil)
+                return
+            end
+
+            @message_handlers[messageType].remove_handler(code)
+        end
+
+        private
+        def poll_loop
+            while true
+                messages = @client.get '/messaging/messages'
+                for message in messages
+                    #puts message
+                    type = message['__type']
+                    if @message_handlers[type]
+                        @message_handlers[type].fire(message)
+                    end
+                end
+                sleep 1
+            end
+        end
     end
-    
-    def initialize(connection)
-        @message_handlers = {}
-        @client = ICWS::Client.new connection
-          
-        @pollingThread = Thread.new() {
-          poll_loop
-        }  
-    end
-    
-    def register(messageType, &block)
-      if(@message_handlers[messageType] == nil) 
-        @message_handlers[messageType] = EventHandlerArray.new 
-      end
-      callback = block
-      @message_handlers[messageType].add_handler {|e| callback.call(e)}
-    end
-    
-    def deregister(messageType, code)
-      if(@message_handlers[messageType] == nil) 
-        return 
-      end
-      
-      @message_handlers[messageType].remove_handler(code)
-    end
-    
-    private
-    def poll_loop
-      while true
-        messages = @client.get '/messaging/messages'
-        for message in messages
-          #puts message
-          type = message['__type']
-          if @message_handlers[type]
-            @message_handlers[type].fire(message)
-          end
-        end  
-        sleep 1
-      end
-    end
-  end
-end
+end

data/lib/icws/messages/messagesubscriber.rb

@@ -1,14 +1,15 @@
 class ICWS
-  class MessageSubscriber
-    def initialize(connection, message_queue, messageId)
-      message_queue.register(messageId) {|e| event_received(e)}
-      @application_name = connection.application_name
-      @client = ICWS::Client.new connection
-    
+    #Base class to listen for events from the server.
+    class MessageSubscriber
+        def initialize(connection, message_queue, messageId)
+            message_queue.register(messageId) {|e| event_received(e)}
+            @application_name = connection.application_name
+            @client = ICWS::Client.new connection
+
+        end
+
+        def event_received(message)
+
+        end
     end
-    
-    def event_received(message)
-      
-    end
-  end
-end
+end

data/lib/icws/statistics/statisticcategory.rb

@@ -1,22 +1,30 @@
 require '..\lib\statistics\statisticdefinition.rb'
 
 class ICWS
+    #Defines a category for supervisor statistics
     class StatisticCategory
-      attr_reader :statistic_category_id
-      attr_reader :display_string
-      attr_reader :description
-      attr_reader :statistic_definitions
-      
-      def initialize(propertyMap)
-        @statistic_category_id = propertyMap['statisticCategoryId']
-        @display_string = propertyMap['displayString']
-        @description = propertyMap['description']
-        @statistic_definitions = []
-        propertyMap['statisticDefinitions'].each {|s| @statistic_definitions.push ICWS::StatisticDefinition.new(s)}
-      end
-      
-      def to_s
-        @display_string + '(' + @statistic_category_id + ')'
-      end
-  end
-end
+        #Category Id
+        attr_reader :statistic_category_id
+        #Category display string
+        attr_reader :display_string
+        #Category Description
+        attr_reader :description
+        #List of StatisticDefinition
+        attr_reader :statistic_definitions
+
+        #Creates a new Statistic category.
+        # @param propertyMap [Hash] Map or properties that define the statistic.
+        def initialize(propertyMap)
+            @statistic_category_id = propertyMap['statisticCategoryId']
+            @display_string = propertyMap['displayString']
+            @description = propertyMap['description']
+            @statistic_definitions = []
+            propertyMap['statisticDefinitions'].each {|s| @statistic_definitions.push ICWS::StatisticDefinition.new(s)}
+        end
+
+        #String reporesentation - DisplayString (Category Id)
+        def to_s
+            @display_string + '(' + @statistic_category_id + ')'
+        end
+    end
+end

data/lib/icws/statistics/statisticdefinition.rb

@@ -1,20 +1,28 @@
 
 class ICWS
+    #Definition of a supervisor statistic
     class StatisticDefinition
-      attr_reader :statistic_identifier
-      attr_reader :display_string
-      attr_reader :description
-      attr_reader :units_display
-      
-      def initialize(propertyMap)
-        @statistic_identifier = propertyMap['statisticIdentifier']
-        @display_string = propertyMap['displayString']
-        @description = propertyMap['description']
-        @units_display = propertyMap['unitsDisplay']
-      end
-      
-      def to_s
-        '   ' + @display_string + '(' + @statistic_identifier + ')' 
-      end
-  end
-end
+        #ID of the statistic
+        attr_reader :statistic_identifier
+        #Display String of the statistic
+        attr_reader :display_string
+        #Description of the statistic
+        attr_reader :description
+        #Statistic Units
+        attr_reader :units_display
+
+        #Creates a new Statistic category.
+        # @param propertyMap [Hash] Map or properties that define the statistic.
+        def initialize(propertyMap)
+            @statistic_identifier = propertyMap['statisticIdentifier']
+            @display_string = propertyMap['displayString']
+            @description = propertyMap['description']
+            @units_display = propertyMap['unitsDisplay']
+        end
+
+        #String reporesentation - DisplayString (Stat Id)
+        def to_s
+            '   ' + @display_string + '(' + @statistic_identifier + ')'
+        end
+    end
+end

data/lib/icws/statistics/statistics.rb

@@ -2,23 +2,27 @@ require '..\lib\messages\messagesubscriber.rb'
 require '..\lib\statistics\statisticcategory.rb'
 
 class ICWS
-  class Statistics < MessageSubscriber
-    attr_reader :statistic_catalog
-    
-    def initialize(connection, message_queue)
-      super(connection, message_queue,'urn:inin.com:statistics:statisticCatalogMessage')
-      @client = ICWS::Client.new connection
-      @client.put '/messaging/subscriptions/statistics/statistic-catalog', {}
-      
-    end
-    
-    def event_received(message)
-      if message['__type'] == 'urn:inin.com:statistics:statisticCatalogMessage'
-        @statistic_catalog = []
-        message['statisticCategoryList'].each {|s| @statistic_catalog.push ICWS::StatisticCategory.new(s)}
-        
-      end
+    #Subscribes to Statistics from CIC
+    class Statistics < MessageSubscriber
+        #Hash of Statistics catalogs
+        attr_reader :statistic_catalog
+
+        #Constructor which sets up a new watcher on the statistics catalog
+        def initialize(connection, message_queue)
+            super(connection, message_queue,'urn:inin.com:statistics:statisticCatalogMessage')
+            @client = ICWS::Client.new connection
+            @client.put '/messaging/subscriptions/statistics/statistic-catalog', {}
+
+        end
+
+        #block for when a new stat catalog message comes in
+        def event_received(message)
+            if message['__type'] == 'urn:inin.com:statistics:statisticCatalogMessage'
+                @statistic_catalog = []
+                message['statisticCategoryList'].each {|s| @statistic_catalog.push ICWS::StatisticCategory.new(s)}
+
+            end
+        end
+
     end
-    
-  end
-end
+end

data/lib/icws/status/status.rb

@@ -2,34 +2,45 @@ require 'icws/status/statusmessage'
 require 'icws/status/userstatus'
 
 class ICWS
-  class ICWS::Status
-    
-    def initialize(connection)
-      @client = ICWS::Client.new connection 
-    end
-    
-    def all_system_statuses
-      status_list = @client.get '/status/status-messages'
-      statuses = []
-      status_list['statusMessageList'].each {|s| statuses.push ICWS::StatusMessage.new(s)}
-      return statuses
-    end
-    
-    def allowable_statuses (user_id)
-      status = @client.get '/status/status-messages-user-access/' + user_id
-      status['statusMessages']
-    end
-    
-    def get_user_status(user_id)
-      status = @client.get '/status/user-statuses/' + user_id
-      ICWS::Status::UserStatus.new(status )
-    end
-    
-    def set_user_status(user_id, status_id)
-      status_data = {}
-      status_data[:statusId] = status_id
-      
-      @client.put '/status/user-statuses/' + user_id, status_data
+    #Status message handler
+    class Status
+        #Creates a new instance
+        def initialize(connection)
+            @client = ICWS::Client.new connection
+        end
+        #Retreives all the statuses configured in the system
+        # @return [Array[StatusMessage]] The status messages.
+        def all_system_statuses
+            status_list = @client.get '/status/status-messages'
+            statuses = []
+            status_list['statusMessageList'].each {|s| statuses.push ICWS::StatusMessage.new(s)}
+            return statuses
+        end
+
+        #Retreives all the statuses for a given user.
+        # @param user_id [String] The user Id
+        # @return [Array[StatusMessage]] The status messages.
+        def allowable_statuses (user_id)
+            status = @client.get '/status/status-messages-user-access/' + user_id
+            status['statusMessages']
+        end
+
+        #Retreives the current status for a given user.
+        # @param user_id [String] The user Id
+        # @return [StatusMessage] The user's status.
+        def get_user_status(user_id)
+            status = @client.get '/status/user-statuses/' + user_id
+            ICWS::Status::UserStatus.new(status )
+        end
+
+        #Sets the current status for a given user.
+        # @param user_id [String] The user Id
+        # @param status_id [String] The Id of the status to set to.
+        def set_user_status(user_id, status_id)
+            status_data = {}
+            status_data[:statusId] = status_id
+
+            @client.put '/status/user-statuses/' + user_id, status_data
+        end
     end
-  end
-end
+end