xclarity_client 0.6.3 → 0.6.8

data/docs/apib/update_repo.apib

@@ -1547,60 +1547,3 @@ FORMAT: 1A
 + Response 404
 + Response 409
 + Response 500
-
-# XClarity Update Repositories [/updatableComponents{?action,with,filetypes}]
-
-+ Parameters
-  + action - The action to take. This can be one of the following values - read, refresh, acquire, delete, export
-  + with - The scope of the action. This can be one of the following values - all, latest, payloads
-  + filetypes - When action=delete or action=export is specified, this parameter is used. Value can be set to payloads
-
-## Update Repo [PUT]
-+ Request (application/json)
-{
-   "mt": [
-      "7167"
-   ],
-   "os": "",
-   "type": "catalog"
-}
-+ Response 200
-
-+ Response 400
-+ Response 401
-+ Response 404
-+ Response 409
-+ Response 500
-
-+ Request (application/json)
-{
-   "fixids": [
-      "brcd_fw_bcsw_nos5.0.1_anyos_noarch",
-      "brcd_fw_cna_3.2.4.0_linux_32-64",
-      "brcd_fw_cna_3.2.3.0_linux_32-64",
-      "lenovo_fw_dsa_dsyte2f-9.61_anyos_32-64"
-   ],
-   "mt": "0000",
-   "type": "latest"
-}
-+ Response 200
-
-+ Response 400
-+ Response 401
-+ Response 404
-+ Response 409
-+ Response 500
-
-+ Request (application/json)
-{
-   "fixids": [
-      "lnvgy_fw_cmm_1aon01k-1.0.0k_anyos_noarch"
-   ]
-}
-+ Response 200
-
-+ Response 400
-+ Response 401
-+ Response 404
-+ Response 409
-+ Response 500

data/lib/xclarity_client.rb

@@ -8,7 +8,6 @@ end
 require 'xclarity_client/errors/errors'
 
 require 'xclarity_client/configuration'
-require 'xclarity_client/xclarity_base'
 require 'xclarity_client/xclarity_credentials_validator'
 require 'xclarity_client/discover'
 require 'xclarity_client/endpoints/endpoints'

data/lib/xclarity_client/client.rb

@@ -31,8 +31,11 @@ module XClarityClient
     include XClarityClient::Mixins::StorageMixin
     include XClarityClient::Mixins::SwitchMixin
     include XClarityClient::Mixins::UnmanageRequestMixin
+    include XClarityClient::Mixins::ManageRequestMixin
     include XClarityClient::Mixins::UpdateRepoMixin
+    include XClarityClient::Mixins::UpdateCompMixin
     include XClarityClient::Mixins::UserMixin
+    include XClarityClient::Mixins::ManagementServerMixin
 
     def initialize(config)
       @config = config

data/lib/xclarity_client/connection/connection.rb

@@ -3,6 +3,7 @@ require 'faraday-cookie_jar'
 require 'uri'
 require 'uri/https'
 require 'timeout'
+require 'net/http'
 
 module XClarityClient
   #
@@ -11,7 +12,6 @@ module XClarityClient
   #
   class Connection
     HEADER_MESSAGE = 'XClarityClient::Connection'.freeze
-    #
     # @param [Hash] configuration - the data to create a connection with the LXCA
     # @option configuration [String] :host             the LXCA host
     # @option configuration [String] :username         the LXCA username
@@ -24,20 +24,23 @@ module XClarityClient
     #
     def initialize(configuration)
       @connection = build(configuration)
-      @timeout    = configuration.timeout
+      @connection_multipart = build(configuration, true)
+      @connection_net_http = build(configuration, false, true)
+      @timeout = configuration.timeout
+      @configuration = configuration
     end
 
-    #
     # Does a GET request to an LXCA endpoint
     #
     # @param [String] uri - endpoint to do the request
     # @param [Hash] query - params to query the endpoint resources
     # @param [Hash] headers - add headers to the request
     #
-    def do_get(uri = "", query: {}, headers: {})
+    def do_get(uri = "", query: {}, headers: {}, n_http: false)
       url_query = query.size > 0 ? "?" + query.map {|k, v| "#{k}=#{v}"}.join("&") : ""
       Timeout.timeout(@timeout) do
-        @connection.get do |req|
+        con = n_http ? @connection_net_http : @connection
+        con.get do |req|
           req.url(uri + url_query)
           headers.map { |key, value| req.headers[key] = value }
         end
@@ -49,41 +52,61 @@ module XClarityClient
       Faraday::Response.new
     end
 
-    #
+    def do_get_file_download(url, file_path)
+      host = @configuration.host
+      username = @configuration.username
+      password = @configuration.password
+
+      uri = 'https://' + host + url unless host.include?('https')
+      uri = host + url if host.include?('https')
+
+      uri = URI(uri)
+      Net::HTTP.start(uri.host, uri.port,
+                      :use_ssl     => true,
+                      :verify_mode => 0) do |http|
+
+        request = Net::HTTP::Get.new(uri.request_uri)
+        request.basic_auth(username, password)
+
+        http.request(request) do |response|
+          open file_path, 'wb' do |io|
+            response.read_body do |chunk|
+              io.write(chunk)
+            end
+          end
+        end
+      end
+    end
+
     # Does a POST request to an LXCA endpoint
     #
     # @param [String] uri - endpoint to do the request
     # @param [JSON] body  - json to be sent in request body
     #
-    def do_post(uri = '', body = '')
-      build_request(:post, uri, body)
+    def do_post(uri = '', body = '', multipart = false)
+      build_request(:post, uri, body, multipart)
     end
 
-    #
     # Does a PUT request to an LXCA endpoint
-    #
     # @param [String] uri - endpoint to do the request
     # @param [JSON] body  - json to be sent in request body
-    #
     def do_put(uri = '', body = '')
       build_request(:put, uri, body)
     end
 
-    #
     # Does a DELETE request to an LXCA endpoint
-    #
     # @param [String] uri - endpoint to do the request
-    #
     def do_delete(uri = '')
       build_request(:delete, uri)
     end
 
     private
 
-    def build_request(method, url, body = '')
-      @connection.send(method) do |request|
+    def build_request(method, url, body = '', multipart = false)
+      con = multipart ? @connection_multipart : @connection
+      con.send(method) do |request|
         request.url(url)
-        request.headers['Content-Type'] = 'application/json'
+        request.headers['Content-Type'] = 'application/json' unless multipart
         request.body = body
       end
     rescue Faraday::Error::ConnectionFailed => e
@@ -95,32 +118,47 @@ module XClarityClient
       Faraday::Response.new
     end
 
-    def build(configuration)
-      header = HEADER_MESSAGE + ' build'
-      $lxca_log.info(header, 'Building the connection')
-
-      hostname = URI.parse(configuration.host)
-
-      url = URI::HTTPS.build({ :host     => hostname.scheme ? hostname.host : hostname.path,
-                               :port     => configuration.port.to_i,
-                               :query    => hostname.query,
-                               :fragment => hostname.fragment }).to_s
-      $lxca_log.info(header, "Creating connection to #{url}")
+    def create_connection_obj(connection, configuration)
+      user_agent_label = configuration.user_agent_label
+      agent_label = user_agent_label.nil? ? "" : user_agent_label
+      header = "LXCA via Ruby Client/#{XClarityClient::VERSION}"
+      connection.headers[:user_agent] = header + agent_label
+      basic_auth = configuration.auth_type == 'basic_auth'
+      username = configuration.username
+      password = configuration.password
+      connection.basic_auth(username, password) if basic_auth
+      $lxca_log.info(header, 'Connection created Successfuly')
+      connection
+    end
 
-      connection = Faraday.new(url: url) do |faraday|
+    def create_faraday_obj(url, configuration, multipart, n_http)
+      Faraday.new(url: url) do |faraday|
+        faraday.request(:multipart) if multipart # multipart form data
         faraday.request(:url_encoded) # form-encode POST params
         faraday.response(:logger, $lxca_log.log) # log requests to log file
         faraday.use(:cookie_jar) if configuration.auth_type == 'token'
-        faraday.adapter(:httpclient) # make requests with HTTPClient
+        faraday.adapter(:httpclient) unless n_http || multipart
+        faraday.adapter(:net_http) if n_http || multipart # with net_http
         faraday.ssl[:verify] = configuration.verify_ssl == 'PEER'
       end
+    end
 
-      connection.headers[:user_agent] = "LXCA via Ruby Client/#{XClarityClient::VERSION}" + (configuration.user_agent_label.nil? ? "" : " (#{configuration.user_agent_label})")
-
-      connection.basic_auth(configuration.username, configuration.password) if configuration.auth_type == 'basic_auth'
-      $lxca_log.info(header, 'Connection created Successfuly')
+    def build_connection(url, configuration, multipart = false, n_http = false)
+      con_obj = create_faraday_obj(url, configuration, multipart, n_http)
+      create_connection_obj(con_obj, configuration)
+    end
 
-      connection
+    def build(configuration, multipart = false, n_http = false)
+      header = HEADER_MESSAGE + ' build'
+      $lxca_log.info(header, 'Building the connection')
+      hostname = URI.parse(configuration.host)
+      host = hostname.scheme ? hostname.host : hostname.path
+      url = URI::HTTPS.build(:host     => host,
+                             :port     => configuration.port.to_i,
+                             :query    => hostname.query,
+                             :fragment => hostname.fragment).to_s
+      $lxca_log.info(header, "Creating connection to #{url}")
+      build_connection(url, configuration, multipart, n_http)
     end
   end
 end

data/lib/xclarity_client/endpoints/endpoints.rb

@@ -26,7 +26,9 @@ require 'xclarity_client/endpoints/scalable_complex'
 require 'xclarity_client/endpoints/switch'
 require 'xclarity_client/endpoints/storage'
 require 'xclarity_client/endpoints/unmanage_request'
+require 'xclarity_client/endpoints/manage_request'
 require 'xclarity_client/endpoints/update_repo'
+require 'xclarity_client/endpoints/update_comp'
 require 'xclarity_client/endpoints/user'
 require 'xclarity_client/endpoints/remote_access'
 require 'xclarity_client/endpoints/globalsettings'
@@ -34,3 +36,4 @@ require 'xclarity_client/endpoints/hostplatform'
 require 'xclarity_client/endpoints/osimage'
 require 'xclarity_client/endpoints/remotefileserver'
 require 'xclarity_client/endpoints/compliance_policy'
+require 'xclarity_client/endpoints/management_server'

data/lib/xclarity_client/endpoints/manage_request.rb

@@ -0,0 +1,11 @@
+module XClarityClient
+  # ManageRequest class
+  class ManageRequest < Endpoints::XclarityEndpoint
+    BASE_URI = '/manageRequest'.freeze
+    LIST_NAME = 'manageRequestList'.freeze
+
+    attr_accessor :progress, :results, :messageBundle, :messageID,
+                  :messageParameters, :result, :resultLongDescription,
+                  :resultShortDescription, :status, :taskid, :time_spent, :uuid
+  end
+end

data/lib/xclarity_client/endpoints/management_server.rb

@@ -0,0 +1,5 @@
+module XClarityClient
+  class ManagementServer < Endpoints::XclarityEndpoint
+    BASE_URI = '/managementServer/updates'.freeze
+  end
+end

data/lib/xclarity_client/endpoints/storage.rb

@@ -6,14 +6,15 @@ module XClarityClient
   # speed, security and high availability
   #
   class Storage < Endpoints::XclarityEndpoint
-    BASE_URI = '/storages'.freeze
+    BASE_URI = '/storage'.freeze
     LIST_NAME = 'storageList'.freeze
 
     attr_accessor :uuid, :name, :type, :accessState, :cmmHealthState,
-                  :enclosures, :overallHealthState, :driveBays,
-                  :enclosureCount, :canisterSlots, :productName,
-                  :machineType, :model, :serialNumber, :contact,
-                  :description, :location, :room, :rack,
-                  :lowestRackUnit, :mgmtProcIPaddress
+                  :enclosures, :canisters, :overallHealthState, :driveBays,
+                  :enclosureCount, :canisterSlots, :parent,
+                  :productName, :machineType, :model,
+                  :serialNumber, :contact, :description,
+                  :location, :room, :rack, :lowestRackUnit,
+                  :mgmtProcIPaddress
   end
 end

data/lib/xclarity_client/endpoints/update_comp.rb

@@ -0,0 +1,18 @@
+module XClarityClient
+  # update component class
+  class UpdateComp < Endpoints::XclarityEndpoint
+    BASE_URI = '/updatableComponents'.freeze
+    LIST_NAME = 'updateCompList'.freeze
+
+    attr_accessor :DeviceList, :CMMList, :ServerList, :StorageList, :SwitchList,
+                  :UpdateStatusMetrics, :TotaldeviceUpdates,
+                  :TotaldeviceUpdatesActive, :TotaldeviceUpdatesComplete,
+                  :TotaldeviceUpdatesInProgress, :TotalJobs, :TotalJobsComplete,
+                  :TotalJobsInProgress, :TotalJobsPercentComplete,
+                  :TotalSupportTasks, :TotalSupportTasksActive, :TotalTasks,
+                  :TotalTasksBlocked, :TotalTasksCanceled, :TotalTasksComplete,
+                  :TotalTasksFailed, :TotalTasksInProgress, :TotalTasksSuccess,
+                  :TotalUpdateTasksActive, :TotalUpdateTasks, :result,
+                  :messages, :id, :text
+  end
+end

data/lib/xclarity_client/mixins/job_mixin.rb

@@ -24,9 +24,5 @@ module XClarityClient
     def delete_job(id = '')
       JobManagement.new(@config).delete_job(id)
     end
-
-    def get_job(job_id = '')
-      JobManagement.new(@config).get_job(job_id)
-    end
   end
 end

data/lib/xclarity_client/mixins/manage_request_mixin.rb

@@ -0,0 +1,54 @@
+module XClarityClient
+  #
+  # Exposes ManageRequestManagement features
+  #
+  module Mixins::ManageRequestMixin
+    def fetch_manage_request(job_id)
+      ManageRequestManagement.new(@config).fetch_manage_request(job_id)
+    end
+
+    def get_job_progress(dji, discovery_job_progress)
+      discovery_result = DiscoverRequestManagement.new(@config)\
+                                                  .monitor_discover_request(dji)
+      discovery_result.map do |req|
+        req.instance_variables.each do |attr|
+          value = req.instance_variable_get(attr)
+          discovery_job_progress = value if attr.id2name.eql?('@progress')
+        end
+      end
+      { :discovery_job_progress => discovery_job_progress,
+        :discovery_result       => discovery_result }
+    end
+
+    def get_discovery_result(discovery_job_id)
+      discovery_job_id = discovery_job_id[:location].split('/')[3]
+      discovery_job_progress = 0
+      return false if discovery_job_id.nil?
+      while discovery_job_progress < 100
+        sleep 30
+        opts = get_job_progress(discovery_job_id, discovery_job_progress)
+        discovery_job_progress = opts[:discovery_job_progress]
+      end
+      opts[:discovery_result]
+    end
+
+    def update_manage_request(manage_request, force, discovery_result)
+      ManageRequestManagement.new(@config)\
+                             .update_manage_request(manage_request,
+                                                    force,
+                                                    discovery_result)
+    end
+
+    def manage_discovered_devices(manage_request, force)
+      discovery_job_id = DiscoverRequestManagement.new(@config)\
+                                                  .discover_manageable_devices(
+                                                    manage_request[:ip_address]
+                                                  )
+      d_res = get_discovery_result(discovery_job_id)
+      raise 'manageable device Discovery failed' unless d_res
+      update_manage_request(manage_request, force, d_res)
+      ManageRequestManagement.new(@config)\
+                             .manage_discovered_devices(manage_request)
+    end
+  end
+end

data/lib/xclarity_client/mixins/management_server_mixin.rb

@@ -0,0 +1,40 @@
+module XClarityClient
+  #
+  # Exposes ManagementServerManagement features
+  #
+  module Mixins::ManagementServerMixin
+    def get_management_server_updates_info(key = nil)
+      obj = ManagementServerManagement.new(@config)
+      obj.get_management_server_updates_info(key)
+    end
+
+    def delete_management_server_updates(fixids)
+      return "parameter 'fixids' should be array" unless fixids.kind_of?(Array)
+      obj = ManagementServerManagement.new(@config)
+      obj.delete_management_server_updates(fixids)
+    end
+
+    def download_management_server_updates(fixids)
+      return "parameter 'fixids' should be array" unless fixids.kind_of?(Array)
+      obj = ManagementServerManagement.new(@config)
+      obj.download_management_server_updates(fixids)
+    end
+
+    def apply_management_server_updates(fixids)
+      return "parameter 'fixids' should be array" unless fixids.kind_of?(Array)
+      obj = ManagementServerManagement.new(@config)
+      obj.apply_management_server_updates(fixids)
+    end
+
+    def refresh_management_server_updates_catalog
+      obj = ManagementServerManagement.new(@config)
+      obj.refresh_management_server_updates_catalog
+    end
+
+    def import_management_server_updates(files)
+      return "parameter 'files' should be array" unless files.kind_of?(Array)
+      obj = ManagementServerManagement.new(@config)
+      obj.import_management_server_updates(files)
+    end
+  end
+end