icws 0.0.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4582f84a075afdde9d1679e342dc83d0c62cb97f
-  data.tar.gz: c32ccd82c47d0cbfa157f00cf8d0d6cc2f86657e
+  metadata.gz: 51ae20e8401fa11a039502013feec4fa9ac3bc72
+  data.tar.gz: c47b130b74d603c37d99e970eee2a8ff1f325d73
 SHA512:
-  metadata.gz: 47362ab14203ae5f2be291318011c0f57f7d3fa38430d17ed68a346e6055a04248095ea5217af938147c27740de54e7a93f6caee913642131436a5ccb0375f41
-  data.tar.gz: 9b1a60ce897d7e3ad9c517b91d220e5db0c365b455ab98ab5da6f83f4d540d8956ecd38eb780583a0f55a3df54e76f840fe686bd4a9f5111d4399b015aad16ef
+  metadata.gz: 1e6bda8d7475b21d65995dd848dabefa78d188301e7a57c7567434f3df3f7a50063f2a9ce0909088702cb2dd859d1deb51bc2b5ed825e65650824bba09287da2
+  data.tar.gz: 92d1fe0ffc491192cafa27698db0b962110107c9807c488aa81d4e157d80f871735628b5b030f933de7a1fc8e2a632351a10a04d75eee8b6c54f7fa448cff97e

data/lib/icws/configuration/configurationitem.rb

@@ -2,78 +2,80 @@ require 'icws/connection'
 require 'icws/icwsclient'
 
 class ICWS
-  class Configuration
-    class ConfigurationItem
-      protected
-      def initialize(connection, class_name)
-        @class_name = class_name
-        @uri = '/configuration/'+ @class_name
-        @client = ICWS::Client.new connection
-      end
-      
-      public  
-      # Gets the configuration item with the specified id.
-      # @param id [String] ID of the configuration item.
-      # @param fields [String] Comma ',' deliminated string of fields to return.  Check the ICWS documentation for the available fields.
-      # @return [Object] The configuration item. 
-      def get(id, fields="configurationId")
-        @client.get(@uri + '/' + id + '?select='+ fields)
-      end
-      
-      # Deletes the configuration item with the specified id.
-      # @param id [String] ID of the configuration item.
-      def delete(id)
-        @client.delete @uri + '/' + id
-      end
-      
-      # Gets all of the configured items.
-      # @param fields [String] comma-delimitedstring of fields to return.  Check the ICWS documentation for the available fields.
-      # @param where [String] A comma-delimited list of conditions to apply to the query. Only items that satisfy all conditions will be returned. The following operators can be used: eq - equals, sw - starts with, ct - contains Example: where=configurationId.id sw St
-      # @param order_by [String] The name of the field to sort the results by. The default is to sort by configurationId.id in ascending order. A query can only be sorted by one field.  To order in descending order use: orderBy=configurationId.id desc
-      # @param rights_filter [String] A comma-delimited list of conditions to apply to the query. Only items that satisfy all conditions will be returned. The following operators can be used: eq - equals, sw - starts with, ct - contains Example: where=configurationId.id sw St
-      # @return [Array[Hash]] The configuration items. 
-      def get_all(fields="configurationId", where=nil, order_by="configurationId.id", rights_filter="admin")
-        
-        query_string =  '?select='+ fields + '&orderBy=' + order_by +'rightsFilter=' + rights_filter
-        if where != nil
-          query_string += "&where=" + where
-        end
-        
-        @client.get(@uri + query_string)["items"]
-      end
-      
-      # Creates a new configuration item.
-      # @param id [String] Id of the new item.
-      # @param new_item [Hash] Object with the configuration properties of the new item.  See ICWS documentation for the valid properties.
-      def create_new(id, new_item)
-        if new_item['configurationId'].nil?
-          config_id = {}
-          config_id['id'] = id
-          config_id['displayName'] = id
-          new_item['configurationId'] = config_id
-        end
-        
-        @client.post @uri, new_item
-      end
-      
-      # Updates an existing configuration item.
-      # @param id [String] Id of the item.
-      # @param new_item [Hash] Object with the configuration properties of the new item.  See ICWS documentation for the valid properties.
-      def update(id, configuration_item)
-        if configuration_item['configurationId'].nil?
-          config_id = {}
-          config_id['id'] = id
-          config_id['displayName'] = id
-          configuration_item['configurationId'] = config_id
+    class Configuration
+        # A representation of an object in CIC (User, Workgroup, Station, etc).  This class should be subclassed as the constructor is protected.
+
+        class ConfigurationItem
+            protected
+            def initialize(connection, class_name)
+                @class_name = class_name
+                @uri = '/configuration/'+ @class_name
+                @client = ICWS::Client.new connection
+            end
+
+            public
+            # Gets the configuration item with the specified id.
+            # @param id [String] ID of the configuration item.
+            # @param fields [String] Comma ',' deliminated string of fields to return.  Check the ICWS documentation for the available fields.
+            # @return [Object] The configuration item.
+            def get(id, fields="configurationId")
+                @client.get(@uri + '/' + id + '?select='+ fields)
+            end
+
+            # Deletes the configuration item with the specified id.
+            # @param id [String] ID of the configuration item.
+            def delete(id)
+                @client.delete @uri + '/' + id
+            end
+
+            # Gets all of the configured items.
+            # @param fields [String] comma-delimitedstring of fields to return.  Check the ICWS documentation for the available fields.
+            # @param where [String] A comma-delimited list of conditions to apply to the query. Only items that satisfy all conditions will be returned. The following operators can be used: eq - equals, sw - starts with, ct - contains Example: where=configurationId.id sw St
+            # @param order_by [String] The name of the field to sort the results by. The default is to sort by configurationId.id in ascending order. A query can only be sorted by one field.  To order in descending order use: orderBy=configurationId.id desc
+            # @param rights_filter [String] A comma-delimited list of conditions to apply to the query. Only items that satisfy all conditions will be returned. The following operators can be used: eq - equals, sw - starts with, ct - contains Example: where=configurationId.id sw St
+            # @return [Array[Hash]] The configuration items.
+            def get_all(fields="configurationId", where=nil, order_by="configurationId.id", rights_filter="admin")
+
+                query_string =  '?select='+ fields + '&orderBy=' + order_by +'rightsFilter=' + rights_filter
+                if where != nil
+                    query_string += "&where=" + where
+                end
+
+                @client.get(@uri + query_string)["items"]
+            end
+
+            # Creates a new configuration item.
+            # @param id [String] Id of the new item.
+            # @param new_item [Hash] Object with the configuration properties of the new item.  See ICWS documentation for the valid properties.
+            def create_new(id, new_item)
+                if new_item['configurationId'].nil?
+                    config_id = {}
+                    config_id['id'] = id
+                    config_id['displayName'] = id
+                    new_item['configurationId'] = config_id
+                end
+
+                @client.post @uri, new_item
+            end
+
+            # Updates an existing configuration item.
+            # @param id [String] Id of the item.
+            # @param configuration_item [Hash] Object with the configuration properties of the new item.  See ICWS documentation for the valid properties.
+            def update(id, configuration_item)
+                if configuration_item['configurationId'].nil?
+                    config_id = {}
+                    config_id['id'] = id
+                    config_id['displayName'] = id
+                    configuration_item['configurationId'] = config_id
+                end
+
+                @client.put @uri + '/' + id, configuration_item
+            end
+
+            # Gets the default values for the configuration item.
+            def defaults
+                @client.get '/configuration/defaults/' + @class_name.chomp('s')
+            end
         end
-        
-        @client.put @uri + '/' + id, configuration_item
-      end
-      
-      # Gets the default values for the configuration item.
-      def defaults
-        @client.get '/configuration/defaults/' + @class_name.chomp('s')
-      end
     end
-  end
-end
+end

data/lib/icws/configuration/roles.rb

@@ -2,10 +2,12 @@ require 'icws/configuration/configurationitem'
 
 class ICWS
   class Configuration
+      # Represents the roles configuration in CIC.  This class can perform operations to create/edit/delete roles.
+
     class Roles < ICWS::Configuration::ConfigurationItem
       def initialize(connection)
         super(connection,'roles')
       end
     end
   end
-end
+end

data/lib/icws/configuration/stations.rb

@@ -2,10 +2,12 @@ require 'icws/configuration/configurationitem'
 
 class ICWS
   class Configuration
+      # Represents the stations configuration in CIC.  This class can perform operations to create/edit/delete stations.
+
     class Stations < ICWS::Configuration::ConfigurationItem
       def initialize(connection)
         super(connection,'stations')
       end
     end
   end
-end
+end

data/lib/icws/configuration/users.rb

@@ -1,20 +1,25 @@
 require 'icws/configuration/configurationitem'
 
 class ICWS
-  class Configuration
-    class Users < ICWS::Configuration::ConfigurationItem
-      def initialize(connection)
-        super(connection,'users')
-      end
-      
-      def set_password(user_id, password, force)
-         icws_uri = @uri + '/' + user_id + '/password'
-         puts 'setting password to ' + password
-         puts 'to: ' + icws_uri
-         @client.put icws_uri, 
-                    { :password => password,
-                      :force => force}
-      end
+    class Configuration
+        # Represents the users configuration in CIC.  This class can perform operations to create/edit/delete users.
+        class Users < ICWS::Configuration::ConfigurationItem
+            def initialize(connection)
+                super(connection,'users')
+            end
+
+            #sets the password on a user
+            # @param user_id [String] Id user to change.
+            # @param password [String] new password to change to.
+            # @param force [bool] Forces the password change, false will fail if password does not meet password policies..
+            def set_password(user_id, password, force)
+                icws_uri = @uri + '/' + user_id + '/password'
+                puts 'setting password to ' + password
+                puts 'to: ' + icws_uri
+                @client.put icws_uri,
+                { :password => password,
+                    :force => force}
+                end
+            end
+        end
     end
-  end
-end

data/lib/icws/configuration/workgroups.rb

@@ -1,11 +1,12 @@
 require 'icws/configuration/configurationitem'
 
 class ICWS
-  class Configuration
-    class Workgroups < ICWS::Configuration::ConfigurationItem
-      def initialize(connection)
-        super(connection,'workgroups')
-      end
+    class Configuration
+        # Represents the workgroups configuration in CIC.  This class can perform operations to create/edit/delete Workgroups.
+        class Workgroups < ICWS::Configuration::ConfigurationItem
+            def initialize(connection)
+                super(connection,'workgroups')
+            end
+        end
     end
-  end
-end
+end

data/lib/icws/connection.rb

@@ -4,85 +4,84 @@ require 'json'
 require 'icws/feature'
 
 class ICWS
-  class Connection
-    # Creates a new connection
-    # @param applicationName [String] the name of the application
-    # @param server [String] the server to connect to  
-    def initialize(application_name, server)
-      @application_name = application_name
-      @server = server
-    end
-    
-    # Connects to the server
-    # @param user [String] the name of the user to connect with
-    # @param password [String] the password for the user
-    def connect(user, password)
-      connectResponse = RestClient.post @server +'/icws/connection', 
-                                        { :ininInternalUseOnly => 'aaIZoS5tNSy81oNrtp3r+N2cZVal5Gbk+3vYO5k9nho=',
-                                          '__type' => "urn:inin.com:connection:icAuthConnectionRequestSettings",
-                                          :applicationName => @application_name,
-                                          :userID => user,
-                                          :password => password}.to_json, 
-                                        :content_type => :json, 
-                                        :accept => :json,
-                                        'Accept-Language' => 'en-us'
-                                        
-      response = JSON.parse(connectResponse);
-      @cookie = connectResponse.headers[:set_cookie][0]                                       
-      @csrf_token = response['csrfToken']
-      @session_id = response['sessionId']
-              
-    end
-    
-    # Gets the name of the application.
-    # @return [String] Application name.
-    def application_name
-      @application_name  
-    end
-    
-    # Gets the connection token.
-    # @return [String] connection token
-    def token
-      @csrf_token
-    end
-    
-    # Gets the connection cookie.
-    # @return [String] connection cookie
-    def cookie
-      @cookie
-    end
-    
-    # Gets the url of the server
-    # @return [String] the url of the server
-    def server
-      @server
-    end
-    
-    # Gets the version of the server.
-    # @return the version of the server.
-    def version
-      JSON.parse RestClient.get @server+'/icws/connection/version'
-    end
-    
-    # Gets the features of the server.
-    # @return [Array[ICWS::Connection::Features]] the features of the server
-    def features
-      data = JSON.parse RestClient.get @server+'/icws/connection/features'
-      features = data["featureInfoList"].map { |rd| ICWS::Connection::Feature.new(rd["featureId"], rd["version"]) }
-    end
-    
-    # Generates a full uri given the resource path.
-    # @param path [String] The path to the ReST resource.
-    # @return [String] The full url. 
-    def generate_uri(path)
-      base_uri + path
-    end
-    
-    # Returns the base uri to the server, including the session id
-    # @return [String] The base url with session id.
-    def base_uri
-      @server+'/icws/' + @session_id +'/'
+    #Representation of a connectio nto a CIC server.
+    class Connection
+        # Creates a new connection
+        # @param application_name [String] the name of the application
+        # @param server [String] the server to connect to
+        def initialize(application_name, server)
+            @application_name = application_name
+            @server = server
+        end
+
+        # Connects to the server
+        # @param user [String] the name of the user to connect with
+        # @param password [String] the password for the user
+        def connect(user, password)
+            connectResponse = RestClient.post @server +'/icws/connection',
+            { :applicationName => @application_name,
+                :userID => user,
+                :password => password}.to_json,
+                :content_type => :json,
+                :accept => :json,
+                'Accept-Language' => 'en-us'
+
+                response = JSON.parse(connectResponse);
+                @cookie = connectResponse.headers[:set_cookie][0]
+                @csrf_token = response['csrfToken']
+                @session_id = response['sessionId']
+
+            end
+
+            # Gets the name of the application.
+            # @return [String] Application name.
+            def application_name
+                @application_name
+            end
+
+            # Gets the connection token.
+            # @return [String] connection token
+            def token
+                @csrf_token
+            end
+
+            # Gets the connection cookie.
+            # @return [String] connection cookie
+            def cookie
+                @cookie
+            end
+
+            # Gets the url of the server
+            # @return [String] the url of the server
+            def server
+                @server
+            end
+
+            # Gets the version of the server.
+            # @return the version of the server.
+            def version
+                JSON.parse RestClient.get @server+'/icws/connection/version'
+            end
+
+            # Gets the features of the server.
+            # @return [Array[ICWS::Connection::Features]] the features of the server
+            def features
+                data = JSON.parse RestClient.get @server+'/icws/connection/features'
+                features = data["featureInfoList"].map { |rd| ICWS::Connection::Feature.new(rd["featureId"], rd["version"]) }
+            end
+
+            # Generates a full uri given the resource path.
+            # @param path [String] The path to the ReST resource.
+            # @return [String] The full url.
+            def generate_uri(path)
+                base_uri + path
+            end
+
+            # Returns the base uri to the server, including the session id
+            # @return [String] The base url with session id.
+            def base_uri
+                @server+'/icws/' + @session_id +'/'
+            end
+        end
     end
-  end
 end
-

data/lib/icws/feature.rb

@@ -1,16 +1,17 @@
 class ICWS
-  class Connection
-    class Feature
-      attr_accessor :feature, :version
+    class Connection
+        #A feature of the CIC server
+        class Feature
+            attr_accessor :feature, :version
 
-      def initialize(feature, version)
-        @feature = feature
-        @version = version
-      end
-      
-      def to_s
-        @feature + ' - ' + @version.to_s
-      end
+            def initialize(feature, version)
+                @feature = feature
+                @version = version
+            end
+
+            def to_s
+                @feature + ' - ' + @version.to_s
+            end
+        end
     end
-  end
-end
+end