xclarity_client 0.6.2 → 0.6.3

data/lib/xclarity_client/schemas.rb

@@ -1,194 +1,183 @@
-require 'json-schema'
-
-module XClarityClient
-  class Schemas
-    @remotefs = {
-      "id"         => "create_remotefileserver_profile",
-      "type"       => "object",
-      "required"   => %w(address displayName port protocol),
-      "properties" => {
-        "address"      => {
-          "type" => "string"
-        },
-        "displayName"  => {
-          "type" => "string"
-        },
-        "keyComment"   => {
-          "type" => "string"
-        },
-        "keyPassphras" => {
-          "type" => "string"
-        },
-        "keyType"      => {
-          "type" => "string"
-        },
-        "password"     => {
-          "type" => "string"
-        },
-        "port"         => {
-          "type" => "integer"
-        },
-        "protocol"     => {
-          "type" => "string"
-        },
-        "serverId"     => {
-          "type" => "string"
-        },
-        "username"     => {
-          "type" => "string"
-        }
-      }
-    }
-
-    @hostplatforms = {
-      "id"    => "deploy_osimage",
-      "type"  => "array",
-      "items" => {
-        "type"       => "object",
-        "required"   => %w(networkSettings selectedImage storageSettings uuid),
-        "properties" => {
-          "adusername"        => {
-            "type" => "string"
-          },
-          "adpassword"        => {
-            "type" => "string"
-          },
-          "configFileId"      => {
-            "type" => "string"
-          },
-          "licenseKey"        => {
-            "type" => "string"
-          },
-          "selectedImage"     => {
-            "type" => "string"
-          },
-          "storageSettings"   => {
-            "type" => "object"
-          },
-          "unattendFileId"    => {
-            "type" => "string"
-          },
-          "uuid"              => {
-            "type" => "string"
-          },
-          "windowsDomain"     => {
-            "type" => "string"
-          },
-          "windowsDomainBlob" => {
-            "type" => "string"
-          },
-          "networkSettings"   => {
-            "type"       => "object",
-            "properties" => {
-              "dns1"         => {
-                "type" => "string"
-              },
-              "dns2"         => {
-                "type" => "string"
-              },
-              "gateway"      => {
-                "type" => "string"
-              },
-              "hostname"     => {
-                "type" => "string"
-              },
-              "ipAddress"    => {
-                "type" => "string"
-              },
-              "mtu"          => {
-                "type" => "integer"
-              },
-              "prefixLength" => {
-                "type" => "string"
-              },
-              "selectedMAC"  => {
-                "type" => "string"
-              },
-              "vlanId"       => {
-                "type" => "string"
-              }
-            }
-          }
-        }
-      }
-    }
-
-    @globalsettings = {
-      "id"         => "set_globalsettings",
-      "type"       => "object",
-      "required"   => %w(activeDirectory
-                         ipAssignment
-                         isVLANMode
-                         licenseKeys
-                         credentials),
-      "properties" => {
-        "activeDirectory" => {
-          "type" => "object"
-        },
-        "ipAssignment"    => {
-          "type" => "string"
-        },
-        "isVLANMode"      => {
-          "type" => "boolean"
-        },
-        "licenseKeys"     => {
-          "type" => "object"
-        },
-        "deploySettings"  => {
-          "type" => "string"
-        },
-        "credentials"     => {
-          "type"  => "array",
-          "items" => {
-            "type"       => "object",
-            "required"   => %w(type name password passwordChanged),
-            "properties" => {
-              "type"            => {
-                "type" => "string"
-              },
-              "name"            => {
-                "type" => "string"
-              },
-              "password"        => {
-                "type" => "string"
-              },
-              "passwordChanged" => {
-                "type" => "boolean"
-              }
-            }
-          }
-        }
-      }
-    }
-
-    REQ_SCHEMA = {
-      'deploy_osimage'                  => @hostplatforms,
-      'set_globalsettings'              => @globalsettings,
-      'create_remotefileserver_profile' => @remotefs
-    }.freeze
-
-    def self.validate_input(schema_name, data)
-      x = JSON::Validator.fully_validate(Schemas::REQ_SCHEMA[schema_name], data)
-      if !x.empty?
-        errmsg = "input validation failed for data #{data}"
-        $lxca_log.error(errmsg, '')
-        x.each { |k| $lxca_log.error(k, '') }
-        return nil
-      else
-        return 1
-      end
-    end
-
-    # parameter name should be string
-    def self.validate_input_parameter(name, value, exp_type)
-      if !value.kind_of?(exp_type)
-        errmsg = "invalid #{name} #{value},"\
-                 " expected #{name} of type #{exp_type}"
-        $lxca_log.error(errmsg, '')
-        return nil
-      else
-        return 1
-      end
-    end
-  end
-end
+require 'json-schema'
+
+module XClarityClient
+  class Schemas
+    @remotefs = {
+      "id"         => "create_remotefileserver_profile",
+      "type"       => "object",
+      "required"   => %w(address displayName port protocol),
+      "properties" => {
+        "address"      => {
+          "type" => "string"
+        },
+        "displayName"  => {
+          "type" => "string"
+        },
+        "keyComment"   => {
+          "type" => "string"
+        },
+        "keyPassphras" => {
+          "type" => "string"
+        },
+        "keyType"      => {
+          "type" => "string"
+        },
+        "password"     => {
+          "type" => "string"
+        },
+        "port"         => {
+          "type" => "integer"
+        },
+        "protocol"     => {
+          "type" => "string"
+        },
+        "serverId"     => {
+          "type" => "string"
+        },
+        "username"     => {
+          "type" => "string"
+        }
+      }
+    }
+
+    @hostplatforms = {
+      "id"    => "deploy_osimage",
+      "type"  => "array",
+      "items" => {
+        "type"       => "object",
+        "required"   => %w(networkSettings selectedImage storageSettings uuid),
+        "properties" => {
+          "adusername"        => {
+            "type" => "string"
+          },
+          "adpassword"        => {
+            "type" => "string"
+          },
+          "configFileId"      => {
+            "type" => "string"
+          },
+          "licenseKey"        => {
+            "type" => "string"
+          },
+          "selectedImage"     => {
+            "type" => "string"
+          },
+          "storageSettings"   => {
+            "type" => "object"
+          },
+          "unattendFileId"    => {
+            "type" => "string"
+          },
+          "uuid"              => {
+            "type" => "string"
+          },
+          "windowsDomain"     => {
+            "type" => "string"
+          },
+          "windowsDomainBlob" => {
+            "type" => "string"
+          },
+          "networkSettings"   => {
+            "type"       => "object",
+            "properties" => {
+              "dns1"         => {
+                "type" => "string"
+              },
+              "dns2"         => {
+                "type" => "string"
+              },
+              "gateway"      => {
+                "type" => "string"
+              },
+              "hostname"     => {
+                "type" => "string"
+              },
+              "ipAddress"    => {
+                "type" => "string"
+              },
+              "mtu"          => {
+                "type" => "integer"
+              },
+              "prefixLength" => {
+                "type" => "integer"
+              },
+              "selectedMAC"  => {
+                "type" => "string"
+              },
+              "vlanId"       => {
+                "type" => "integer"
+              }
+            }
+          }
+        }
+      }
+    }
+
+    @globalsettings = {
+      "id"         => "set_globalsettings",
+      "type"       => "object",
+      "required"   => %w(activeDirectory
+                         ipAssignment
+                         isVLANMode
+                         licenseKeys
+                         credentials),
+      "properties" => {
+        "activeDirectory" => {
+          "type" => "object"
+        },
+        "ipAssignment"    => {
+          "type" => "string"
+        },
+        "isVLANMode"      => {
+          "type" => "boolean"
+        },
+        "licenseKeys"     => {
+          "type" => "object"
+        },
+        "deploySettings"  => {
+          "type" => "string"
+        },
+        "credentials"     => {
+          "type"  => "array",
+          "items" => {
+            "type"       => "object",
+            "required"   => %w(type name password passwordChanged),
+            "properties" => {
+              "type"            => {
+                "type" => "string"
+              },
+              "name"            => {
+                "type" => "string"
+              },
+              "password"        => {
+                "type" => "string"
+              },
+              "passwordChanged" => {
+                "type" => "boolean"
+              }
+            }
+          }
+        }
+      }
+    }
+
+    REQ_SCHEMA = {
+      :deploy_osimage                  => @hostplatforms,
+      :set_globalsettings              => @globalsettings,
+      :create_remotefileserver_profile => @remotefs
+    }.freeze
+
+    def self.validate_input(schema_name, data)
+      x = JSON::Validator.fully_validate(self::REQ_SCHEMA[schema_name], data)
+      unless x.empty?
+        errmsg = "input validation failed for data #{data}"
+        $lxca_log.error('XClarityClient::Schemas validate_input', errmsg.to_s)
+        g = ''
+        x.each do |k|
+          $lxca_log.error('XClarityClient::Schemas validate_input', k)
+          g << "#{k},  "
+        end; return { :result => 'Input validation failed', :message => g }
+      end; return { :result => 'success' }
+    end
+  end
+end

data/lib/xclarity_client/services/compliance_policy_management.rb

@@ -17,10 +17,8 @@ module XClarityClient
     end
     
     def get_update_policy(uri, opts = {})
-      query = opts
-      response = @connection.do_get(uri, query)
-      build_response_with_resource_list(response, managed_resource)
-    end 
+      fetch_all(opts, uri)
+    end
 
     def assign_compliance_policy(opts = {}, keep, auto_assign)
       assign_hash = {:policyname => opts["policyname"], :type => opts["type"], :uuid => opts["uuid"]}
@@ -37,14 +35,14 @@ module XClarityClient
 
       assign_hash_str = assign_hash.to_json
       response = @connection.do_post(managed_resource::SUB_URIS[:compareResult], "{\"compliance\": [#{assign_hash_str}]}") 
-      puts response.body
+      response.body
     end
 
     def delete_compliance_policy(policy_name,removePackage)
       query = policy_name.nil? ? "" : "?policyName=" + policy_name
       query = removePackage.nil? ? query : query + "&removePackage=" + removePackage 
       response = @connection.do_delete(managed_resource::BASE_URI + query)
-      puts response.body
+      response.body
     end
 
   end

data/lib/xclarity_client/services/globalsettings_management.rb

@@ -2,24 +2,17 @@ require 'json'
 require 'pathname'
 
 module XClarityClient
-  class GlobalSettingManagement < XClarityBase
-
-    include XClarityClient::ManagementMixin
-
-    def initialize(conf)
-      super(conf, GlobalSetting::BASE_URI)
-    end
-
-    def population
-      response = connection("#{GlobalSetting::BASE_URI}")
-      response = JSON.parse(response.body)
-    end
+  class GlobalSettingManagement < Services::XClarityService
+    manages_endpoint GlobalSetting
 
     def set_globalsettings(opts={})
         request_body = JSON.generate(opts)
-        if Schemas.validate_input("set_globalsettings", request_body)
-          response = do_put("#{GlobalSetting::BASE_URI}", request_body)
-          response = JSON.parse(response.body)
+        res = Schemas.validate_input(:set_globalsettings, request_body)
+        if res[:result] == 'success'
+          response = @connection.do_put("#{GlobalSetting::BASE_URI}",
+                                        request_body)
+        else
+          res
         end
     end
   end

data/lib/xclarity_client/services/hostplatform_management.rb

@@ -2,30 +2,21 @@ require 'json'
 require 'pathname'
 
 module XClarityClient
-  class HostPlatformManagement < XClarityBase
-
-    include XClarityClient::ManagementMixin
-
-    def initialize(conf)
-        super(conf, HostPlatform::BASE_URI)
-    end
-
-    def population
-        get_all_resources(HostPlatform)
-    end
+  class HostPlatformManagement < Services::XClarityService
+    manages_endpoint HostPlatform
 
     def get_osimage_deployment_status(uuid)
-        if Schemas.validate_input_parameter("uuid", uuid, String)
-          response = connection("#{HostPlatform::BASE_URI}/#{uuid}")
-          response = JSON.parse(response.body)
-        end
+        response = @connection.do_get("#{HostPlatform::BASE_URI}/#{uuid}")
     end
 
     def deploy_osimage(opts=[])
         request_body = JSON.generate(opts)
-        if Schemas.validate_input("deploy_osimage", request_body)
-          response = do_put("#{HostPlatform::BASE_URI}", request_body)
-          response = JSON.parse(response.body)
+        res = Schemas.validate_input(:deploy_osimage, request_body)
+        if res[:result] == 'success'
+           response = @connection.do_put("#{HostPlatform::BASE_URI}",
+                                         request_body)
+        else
+           res
         end
     end
   end

data/lib/xclarity_client/services/osimage_management.rb

@@ -2,43 +2,31 @@ require 'json'
 require 'pathname'
 
 module XClarityClient
-  class OsImageManagement < XClarityBase
-
-    include XClarityClient::ManagementMixin
-
-    def initialize(conf)
-      super(conf, OsImage::BASE_URI)
-    end
-
-    def population
-      get_all_resources(OsImage)
-    end
+  class OsImageManagement < Services::XClarityService
+    manages_endpoint OsImage
 
     def import_osimage(server_id, path)
-      return unless Schemas.validate_input_parameter("serverId", server_id, String) ||
-                    Schemas.validate_input_parameter("path", path, String)
-
       msg="inputs serverId=#{server_id},path=#{path}"
       $lxca_log.info self.class.to_s+" "+__method__.to_s, msg
       opts = { :Action => "Init" }
       request_body = JSON.generate(opts)
-      response = do_post("#{OsImage::BASE_URI}?imageType=OS", request_body)
+      response = @connection.do_post("#{OsImage::BASE_URI}?imageType=OS",
+                                     request_body)
       response = JSON.load(response.body).to_hash
       job_id = response["jobId"]
       opts = { :serverId => server_id, :path => path }
       request_body = JSON.generate(opts)
       image_name = path.split(File::SEPARATOR).last
       begin
-        response = do_post(
-          "#{OsImage::BASE_URI}/?jobId=#{job_id}&imageType=OS&imageName=#{image_name}",
-          request_body
-        )
-        JSON.parse(response.body)
+        response = @connection.do_post("#{OsImage::BASE_URI}?jobId=#{job_id}"\
+                                       "&imageType=OS&imageName=#{image_name}",
+                                       request_body)
+        response
       rescue Faraday::TimeoutError => e
-        result = JSON.generate(
-          :result => " Job for importing image is in progress with jobId #{job_id}"
-        )
-        JSON.parse(result)
+        result = {
+          :result => "importing image is in progress with jobId #{job_id}"
+        }
+        result
       end
     end
   end

data/lib/xclarity_client/services/remotefileserver_management.rb

@@ -1,41 +1,29 @@
 require 'json'
 
 module XClarityClient
-  class RemoteFileServerManagement < XClarityBase
-
-    include XClarityClient::ManagementMixin
-
-    def initialize(conf)
-      super(conf, RemoteFileServer::BASE_URI)
-    end
-
-    def population
-      get_all_resources(RemoteFileServer)
-    end
+  class RemoteFileServerManagement < Services::XClarityService
+    manages_endpoint RemoteFileServer
 
     def create_remotefileserver_profile(opts) 
       request_body = JSON.generate(opts)
-      if Schemas.validate_input("create_remotefileserver_profile", request_body)
-        response = do_post(RemoteFileServer::BASE_URI, request_body)
-        msg = "remote file server profile created #{response.body}"
-        $lxca_log.info self.class.to_s+" "+__method__.to_s, msg
-        response = JSON.parse(response.body)
+      res = Schemas.validate_input(:create_remotefileserver_profile,
+                                   request_body)
+      if res[:result] == 'success'
+        response = @connection.do_post(RemoteFileServer::BASE_URI,
+                                       request_body)
+      else
+        res
       end
     end
 
     def delete_remotefileserver_profile(serverId)
-      if not Schemas.validate_input_parameter("serverId", serverId, String)
-         return
-      end
-      response = do_delete("#{RemoteFileServer::BASE_URI}/#{serverId}")
-      response = JSON.parse(response.body)
+        response = @connection.do_delete("#{RemoteFileServer::BASE_URI}/"\
+                                         "#{serverId}")
     end
 
     def get_remotefileserver_profile(serverId)
-      if Schemas.validate_input_parameter("serverId", serverId, String)
-        response = connection("#{RemoteFileServer::BASE_URI}/#{serverId}")
-        response = JSON.parse(response.body)
-      end
+        response = @connection.do_get("#{RemoteFileServer::BASE_URI}/"\
+                                      "#{serverId}")
     end
   end
 end

data/lib/xclarity_client/services/update_repo_management.rb

@@ -33,5 +33,63 @@ module XClarityClient
         updatesByMtByComp
       )
     end
+
+    public
+
+    def check_file_types(file_types)
+      x = 'Invalid value for argument file_types. Allowed values are'\
+               + ' - all and payloads'
+      raise x unless file_types.casecmp('payloads').zero? ||
+                     file_types.casecmp('all').zero?
+    end
+
+    def read_update_repo
+      response = @connection.do_put(UpdateRepo::BASE_URI + '?action=read')
+      response.body
+    end
+
+    def refresh_update_repo(scope, mt, os)
+      if scope.casecmp('all') != 0 && scope.casecmp('latest') != 0
+        raise 'Invalid argument combination of action and scope. Action'\
+               + ' refresh can have scope as either all or latest'
+      end
+      refresh_req = JSON.generate(:mt => mt, :os => os, :type => 'catalog')
+      response = @connection.do_put(UpdateRepo::BASE_URI\
+                                    + '?action=refresh&with='\
+                                    + scope.downcase, refresh_req)
+      response.body
+    end
+
+    def acquire_firmware_updates(scope, fixids, mt)
+      if scope.casecmp('payloads') != 0
+        raise 'Invalid argument combination of action and scope. Action'\
+               + ' acquire can have scope as payloads'
+      end
+      acquire_req = JSON.generate(:mt => mt, :fixids => fixids,
+                                  :type => 'latest')
+      response = @connection.do_put(UpdateRepo::BASE_URI\
+                                    + '?action=acquire&with='\
+                                    + scope.downcase, acquire_req)
+      response.body
+    end
+
+    def delete_firmware_updates(file_types, fixids)
+      check_file_types(file_types)
+      delete_req = JSON.generate(:fixids => fixids)
+      response = @connection.do_put(UpdateRepo::BASE_URI + '?action='\
+                                    + 'delete&filetypes=' + file_types.downcase,
+                                    delete_req)
+      response.body
+    end
+
+    def export_firmware_updates(file_types, fixids)
+      check_file_types(file_types)
+
+      export_req = JSON.generate(:fixids => fixids)
+      response = @connection.do_put(UpdateRepo::BASE_URI\
+                                    + '?action=export&filetypes='\
+                                    + file_types.downcase, export_req)
+      response.body
+    end
   end
 end