xclarity_client 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf0c21b4fa01b0e4b17558a1427f7cba659a4db359c759ff1cb7a602a987293b
-  data.tar.gz: 9fdf8103464d28c42d343488b013ce5a3294b1f758607b178031c4459c1151bb
+  metadata.gz: 5e827883dbabbf1114a1d83987846517654887296d94e0579206ba9da134d115
+  data.tar.gz: aeda36e0bd91c198b00c0c624c7412a023b8bc3588fa141762cf50ab1db0ebcd
 SHA512:
-  metadata.gz: e608b1208b908366e1db064b8bf775edad14c7a0f1f39499c5a64c59fdbb6d87089fb024dfe0267351b0730f2e3b1b38b29d09d008cc153c5a3feb0234d4dcb3
-  data.tar.gz: 46b3b54cce30d7c123eb905528f492a483f7e1f10a1be07b2e7160bf308c8f00557a79906f14c0c842b5b11ab578425b0c8fb61e85a838bc2649ff973fab59da
+  metadata.gz: 623be4a6ae9382ce763ea3e8defdbbe53e04ec1c6ec80750252a77f512b9b4a24b69c703237e23a747f4bbbb00dbb82438f6a871013cbb652233287023f28612
+  data.tar.gz: 7fc5643fd28d48178647c8605a3f9fd0cd3f043307445c8d55a044cd558e2bbf74d4e58e53e917ca4622407c1a5bb0a67fd63122b4467eec262cb366023b3ff5

data/.whitesource

@@ -0,0 +1,3 @@
+{
+  "settingsInheritedFrom": "ManageIQ/whitesource-config@master"
+}

data/lib/xclarity_client/configuration.rb

@@ -13,7 +13,7 @@ module XClarityClient
       validate_port
       validate_timeout
 
-      $lxca_log.info(HEADER_MESSAGE, 'Configuration built successfully')
+      XClarityClient.logger.info("[#{HEADER_MESSAGE}] - Configuration built successfully")
     end
 
     def validate_port
@@ -60,7 +60,7 @@ module XClarityClient
     end
 
     def raise_exception(message)
-      $lxca_log.error(HEADER_MESSAGE, message)
+      XClarityClient.logger.error("[#{HEADER_MESSAGE}] - #{message}")
       raise(ArgumentError, message)
     end
   end

data/lib/xclarity_client/connection/connection.rb

@@ -47,10 +47,10 @@ module XClarityClient
           headers.map { |key, value| req.headers[key] = value }
         end
       end
-    rescue Faraday::Error::ConnectionFailed, Timeout::Error => e
+    rescue Faraday::ConnectionFailed, Timeout::Error => e
       msg = "Error trying to send a GET to #{uri + url_query} "\
             "the reason: #{e.message}"
-      $lxca_log.error(HEADER_MESSAGE + ' do_get', msg)
+      XClarityClient.logger.error("[#{HEADER_MESSAGE} do_get] - #{msg}")
       Faraday::Response.new
     end
 
@@ -111,12 +111,12 @@ module XClarityClient
         request.headers['Content-Type'] = 'application/json' unless multipart
         request.body = body
       end
-    rescue Faraday::Error::ConnectionFailed => e
+    rescue Faraday::ConnectionFailed => e
       header = HEADER_MESSAGE + " do_#{method}"
       msg = "Error trying to send a #{method} to #{url} " \
             "the reason: #{e.message}"
-      $lxca_log.error(header, msg)
-      $lxca_log.error(header, "Request sent: #{body}")
+      XClarityClient.logger.error("[#{header}] - #{msg}")
+      XClarityClient.logger.error("[#{header}] - Request sent: #{body}")
       Faraday::Response.new
     end
 
@@ -129,7 +129,7 @@ module XClarityClient
       username = configuration.username
       password = configuration.password
       connection.request(:authorization, :basic, username, password) if basic_auth
-      $lxca_log.info(header, 'Connection created Successfuly')
+      XClarityClient.logger.info("[#{header}] - Connection created Successfuly")
       connection
     end
 
@@ -137,7 +137,7 @@ module XClarityClient
       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.response(:logger, XClarityClient.logger) # log requests to log file
         faraday.use(:cookie_jar) if configuration.auth_type == 'token'
         faraday.adapter(:httpclient) unless n_http || multipart
         faraday.adapter(:net_http) if n_http || multipart # with net_http
@@ -152,14 +152,14 @@ module XClarityClient
 
     def build(configuration, multipart = false, n_http = false)
       header = HEADER_MESSAGE + ' build'
-      $lxca_log.info(header, 'Building the connection')
+      XClarityClient.logger.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}")
+      XClarityClient.logger.info("[#{header}] - Creating connection to #{url}")
       build_connection(url, configuration, multipart, n_http)
     end
   end

data/lib/xclarity_client/discover.rb

@@ -6,7 +6,7 @@ module XClarityClient
     def self.responds?(ipAddress, port)
       conf = Faraday.new(url: build_uri(ipAddress, port).to_s) do |faraday|
         faraday.request  :url_encoded             # form-encode POST params
-        faraday.response :logger, $lxca_log.log   # log requests to STDOUT -- This line, should be uncommented if you wanna inspect the URL Request
+        faraday.response :logger, XClarityClient.logger
         faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
         faraday.ssl[:verify] = false
       end
@@ -31,4 +31,4 @@ module XClarityClient
       URI("https://" + ipAddress+ ":" + port)
     end
   end
-end
+end

data/lib/xclarity_client/endpoints/buildable_resource_mixin.rb

@@ -41,9 +41,8 @@ module XClarityClient
         send("#{key}=", value)
       rescue
         unless defined?(Rails).nil?
-          $lxca_log.info(
-            'XClarityClient::Endpoints::BuildableResourceMixin',
-            "UNEXISTING ATTRIBUTES FOR #{self.class}: #{key}"
+          XClarityClient.logger.info(
+            "[XClarityClient::Endpoints::BuildableResourceMixin] - UNEXISTING ATTRIBUTES FOR #{self.class}: #{key}"
           )
         end
       end

data/lib/xclarity_client/logging.rb

@@ -0,0 +1,11 @@
+require 'logger'
+
+module XClarityClient
+  class << self
+    attr_writer :logger
+
+    def logger
+      @logger ||= ::Logger.new(IO::NULL)
+    end
+  end
+end

data/lib/xclarity_client/schemas.rb

@@ -171,10 +171,10 @@ module XClarityClient
       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)
+        XClarityClient.logger.error("[XClarityClient::Schemas validate_input] - #{errmsg}")
         g = ''
         x.each do |k|
-          $lxca_log.error('XClarityClient::Schemas validate_input', k)
+          XClarityClient.logger.error("[XClarityClient::Schemas validate_input] - #{k}")
           g << "#{k},  "
         end; return { :result => 'Input validation failed', :message => g }
       end; return { :result => 'success' }

data/lib/xclarity_client/services/management_server_management.rb

@@ -39,7 +39,7 @@ module XClarityClient
       base_url = ManagementServer::BASE_URI
       url = key.nil? ? base_url : "#{base_url}?key=#{key}"
       msg = "input key=#{key}"
-      $lxca_log.info(self.class.to_s + ' ' + __method__.to_s, msg)
+      XClarityClient.logger.info("[#{self.class} #{__method__}] - #{msg}")
       @connection.do_get(url)
     end
 
@@ -59,7 +59,7 @@ module XClarityClient
       request_body = JSON.generate(:files => payload_files)
       response = @connection.do_post(url, request_body)
       jobid = JSON.parse(response.body)['jobid']
-      $lxca_log.info(self.class.to_s + ' ' + __method__.to_s, "jobid: #{jobid}")
+      XClarityClient.logger.info("[#{self.class} #{__method__}] - jobid: #{jobid}")
       start_management_server_updates_import_job(file_type_dict, files, jobid)
     end
 

data/lib/xclarity_client/services/mixins/power_action_sender_mixin.rb

@@ -22,7 +22,7 @@ module XClarityClient
         unless valid_arguments?(uuid, state, managed_resource::POWER_ACTIONS)
           error = 'Invalid target or power state requested'
           source = "#{self.class.name} set_power_state"
-          $lxca_log.info(source, error)
+          XClarityClient.logger.info("[#{source}] - #{error}")
           raise ArgumentError, error
         end
 
@@ -45,7 +45,7 @@ module XClarityClient
         unless valid_arguments?(uuid, state, managed_resource::LED_STATES)
           error = 'Invalid target or power state requested'
           source = "#{self.class.name} set_loc_led_state"
-          $lxca_log.info(source, error)
+          XClarityClient.logger.info("[#{source}] - #{error}")
           raise ArgumentError, error
         end
 
@@ -68,7 +68,7 @@ module XClarityClient
         response = @connection.do_put(uri, power_request)
         msg = "Power state action has been sent with request #{power_request}"
 
-        $lxca_log.info("#{self.class.name} send_power_request", msg)
+        XClarityClient.logger.info("[#{self.class.name} send_power_request] - #{msg}")
         response
       end
 
@@ -93,7 +93,7 @@ module XClarityClient
         response = @connection.do_put(uri, request)
         msg = "LED state request has been sent with request #{request}"
 
-        $lxca_log.info("#{self.class.name} send_led_state_request", msg)
+        XClarityClient.logger.info("[#{self.class.name} send_led_state_request] - #{msg}")
         response
       end
 

data/lib/xclarity_client/services/node_management.rb

@@ -14,7 +14,7 @@ module XClarityClient
       if [uuid, requested_state].any? { |item| item.nil? }
         error = 'Invalid target or power state requested'
         source = 'XClarity::NodeManagement set_bmc_power_state'
-        $lxca_log.info source, error
+        XClarityClient.logger.info("[#{source}] - #{error}")
         raise ArgumentError, error
       end
 

data/lib/xclarity_client/services/osimage_management.rb

@@ -7,7 +7,7 @@ module XClarityClient
 
     def import_osimage(server_id, path)
       msg="inputs serverId=#{server_id},path=#{path}"
-      $lxca_log.info self.class.to_s+" "+__method__.to_s, msg
+      XClarityClient.logger.info("[#{self.class} #{__method__}] - #{msg}")
       opts = { :Action => "Init" }
       request_body = JSON.generate(opts)
       response = @connection.do_post("#{OsImage::BASE_URI}?imageType=OS",

data/lib/xclarity_client/services/remote_access_management.rb

@@ -14,7 +14,7 @@ module XClarityClient
       )
 
       unless con.success?
-        $lxca_log.error "XClarityClient::RemoteAccessManagement remote_control", "Request failed"
+        XClarityClient.logger.error("[XClarityClient::RemoteAccessManagement remote_control] - Request failed")
         raise 'Request failed'
       end
 
@@ -33,9 +33,8 @@ module XClarityClient
       when /application\/x-java-jnlp-file/
         build_jnlp_remote_access_object(connection.body)
       else
-        $lxca_log.error(
-          "XClarityClient::RemoteAccessManagement build_remote_access_object",
-          "Unexpected server response. Expected Content-Type header to be one of these: #{SUPPORTED_MIME_TYPES}."
+        XClarityClient.logger.error(
+          "[XClarityClient::RemoteAccessManagement build_remote_access_object] - Unexpected server response. Expected Content-Type header to be one of these: #{SUPPORTED_MIME_TYPES}."
         )
         raise 'Unexpected Content-Type header'
       end

data/lib/xclarity_client/services/virtual_appliance_management.rb

@@ -22,7 +22,7 @@ module XClarityClient
 
     def ip_enablement_state
       uri = BASE_URI+NETWORK_URI+IPDISABLE_URI
-      $lxca_log.info "XclarityClient::VirtualApplianceManagement ip_enablement_state", "Action has been sent to #{uri}"
+      XClarityClient.logger.info("[XclarityClient::VirtualApplianceManagement ip_enablement_state] - Action has been sent to #{uri}")
 
       @connection.do_get(uri)
     end
@@ -33,7 +33,7 @@ module XClarityClient
 
     def host_settings
       uri = BASE_URI+NETWORK_URI+IPDISABLE_URI
-      $lxca_log.info "XclarityClient::VirtualApplianceManagement host_settings", "Action has been sent to #{uri}"
+      XClarityClient.logger.info("[XclarityClient::VirtualApplianceManagement host_settings] - Action has been sent to #{uri}")
 
       @connection.do_get(uri)
     end
@@ -44,7 +44,7 @@ module XClarityClient
 
     def network_interface_settings(interface)
       uri = BASE_URI+NETWORK_URI+INTERFACES_URI+"/#{interface}"
-      $lxca_log.info "XclarityClient::VirtualApplianceManagement network_interface_settings", "Action has been sent to #{uri}"
+      XClarityClient.logger.info("[XclarityClient::VirtualApplianceManagement network_interface_settings] - Action has been sent to #{uri}")
 
       @connection.do_get(uri)
     end
@@ -55,7 +55,7 @@ module XClarityClient
 
     def route_settings
       uri = BASE_URI+NETWORK_URI+ROUTES_URI
-      $lxca_log.info "XclarityClient::VirtualApplianceManagement route_settings", "Action has been sent to #{uri}"
+      XClarityClient.logger.info("[XclarityClient::VirtualApplianceManagement route_settings] - Action has been sent to #{uri}")
 
       @connection.do_get(uri)
     end
@@ -66,7 +66,7 @@ module XClarityClient
 
     def subscriptions
       uri = BASE_URI+SUBSCRIPTIONS_URI
-      $lxca_log.info "XclarityClient::VirtualApplianceManagement subscriptions", "Action has been sent to #{uri}"
+      XClarityClient.logger.info("[XclarityClient::VirtualApplianceManagement subscriptions] - Action has been sent to #{uri}")
 
       @connection.do_get(uri)
     end

data/lib/xclarity_client/services/xclarity_management_mixin.rb

@@ -1,11 +1,11 @@
 module XClarityClient
   module ManagementMixin
     def get_all_resources (resource, opts = {})
-      $lxca_log.info "XclarityClient::ManagementMixin get_all_resources", "Sending request to #{resource} resource"
+      XClarityClient.logger.info("[XclarityClient::ManagementMixin get_all_resources] - Sending request to #{resource} resource")
 
       response = connection(resource::BASE_URI, opts)
 
-      $lxca_log.info "XclarityClient::ManagementMixin get_all_resources", "Response received from #{resource::BASE_URI}"
+      XClarityClient.logger.info("[XclarityClient::ManagementMixin get_all_resources] - Response received from #{resource::BASE_URI}")
 
       return [] unless response.success?
 
@@ -23,7 +23,7 @@ module XClarityClient
 
     def get_object(uuids, includeAttributes, excludeAttributes, resource)
 
-      $lxca_log.info "XclarityClient::ManagementMixin get_object", "Sending request to #{resource} resource"
+      XClarityClient.logger.info("[XclarityClient::ManagementMixin get_object] - Sending request to #{resource} resource")
 
       uuids.reject! { |uuid| UUID.validate(uuid).nil? } unless uuids.nil?
 
@@ -49,7 +49,7 @@ module XClarityClient
 
     def get_object_with_include_attributes(uuids, attributes, resource)
 
-      $lxca_log.info "XclarityClient::ManagementMixin get_object_with_include", "Sending request to #{resource} resource including the following attributes: #{attributes.join(",")}"
+      XClarityClient.logger.info("[XclarityClient::ManagementMixin get_object_with_include] - Sending request to #{resource} resource including the following attributes: #{attributes.join(",")}")
 
       uuids.reject! { |uuid| UUID.validate(uuid).nil? } unless uuids.nil?
 
@@ -63,7 +63,7 @@ module XClarityClient
 
     def get_object_with_exclude_attributes(uuids, attributes, resource)
 
-      $lxca_log.info "XclarityClient::ManagementMixin get_object_with_include", "Sending request to #{resource} resource excluding the following attributes: #{attributes.join(",")}"
+      XClarityClient.logger.info("[XclarityClient::ManagementMixin get_object_with_include] - Sending request to #{resource} resource excluding the following attributes: #{attributes.join(",")}")
 
       uuids.reject! { |uuid| UUID.validate(uuid).nil? } unless uuids.nil?
 
@@ -134,8 +134,8 @@ module XClarityClient
         else
           filter += "?type=#{opts["type"]}"
         end
-      $lxca_log.info "XclarityClient::ManagementMixin get_object_with_include", "Sending request to #{resource} resource using the following filter: #{filter}"
-      connection(resource::BASE_URI + filter)
+        XClarityClient.logger.info("[XclarityClient::ManagementMixin get_object_with_include] - Sending request to #{resource} resource using the following filter: #{filter}")
+        connection(resource::BASE_URI + filter)
       end
 
       return [] unless response.success?

data/lib/xclarity_client/services/xclarity_service.rb

@@ -21,20 +21,17 @@ module XClarityClient
       def fetch_all(opts = {}, uri = {})
         uri = managed_resource::BASE_URI if uri.empty? || uri.nil?
 
-        $lxca_log.info "XclarityClient::Endpoints::XClarityService fetch_all",
-                       "Sending request to #{managed_resource} resource"
+        XClarityClient.logger.info("[XclarityClient::Endpoints::XClarityService fetch_all] - Sending request to #{managed_resource} resource")
 
         response = @connection.do_get(uri, :query => opts)
 
-        $lxca_log.info("XclarityClient::Endpoints::XClarityService fetch_all",
-                       "Response received from #{uri}")
+        XClarityClient.logger.info("[XclarityClient::Endpoints::XClarityService fetch_all] - Response received from #{uri}")
 
         build_response_with_resource_list(response, managed_resource)
       end
 
       def get_object(uuids, includeAttributes, excludeAttributes)
-        $lxca_log.info "XclarityClient::Endpoints::XClarityService get_object",
-                       "Sending request to #{managed_resource} resource"
+        XClarityClient.logger.info("[XclarityClient::Endpoints::XClarityService get_object] - Sending request to #{managed_resource} resource")
 
         uuid_array = uuids&.reject { |uuid| uuid.nil? || uuid.empty? }
 
@@ -92,8 +89,7 @@ module XClarityClient
       end
 
       def get_object_with_include_attributes(uuids, attributes)
-        $lxca_log.info "XclarityClient::ManagementMixin get_object_with_include",
-                       "Sending request to #{managed_resource} resource including the following attributes: #{attributes.join(",")}"
+        XClarityClient.logger.info("[XclarityClient::ManagementMixin get_object_with_include] - Sending request to #{managed_resource} resource including the following attributes: #{attributes.join(",")}")
 
         response = if not uuids.nil?
           @connection.do_get(managed_resource::BASE_URI + "/" + uuids.join(",") + "?includeAttributes=" + attributes.join(","))
@@ -104,8 +100,7 @@ module XClarityClient
       end
 
       def get_object_with_exclude_attributes(uuids, attributes)
-        $lxca_log.info "XclarityClient::ManagementMixin get_object_with_include",
-                       "Sending request to #{managed_resource} resource excluding the following attributes: #{attributes.join(",")}"
+        XClarityClient.logger.info("[XclarityClient::ManagementMixin get_object_with_include] - Sending request to #{managed_resource} resource excluding the following attributes: #{attributes.join(",")}")
 
         response = if not uuids.nil?
           @connection.do_get(managed_resource::BASE_URI + "/#{uuids.join(",")}"+"?excludeAttributes=#{attributes.join(",")}")

data/lib/xclarity_client/version.rb

@@ -1,3 +1,3 @@
 module XClarityClient
-  VERSION = '0.7.0'.freeze
+  VERSION = '0.8.0'.freeze
 end

data/lib/xclarity_client/xclarity_credentials_validator.rb

@@ -10,11 +10,11 @@ module XClarityClient
     end
 
     def validate
-      $lxca_log.info 'XClarityClient::XClarityValidate validate', 'Creating session ...'
+      XClarityClient.logger.info('[XClarityClient::XClarityValidate validate] - Creating session ...')
       build_session(@configuration)
 
       id_session = JSON.parse(@response.body)['messages'].first['id']
-      $lxca_log.info 'XClarityClient::XClarityValidate validate', 'Session created ...'
+      XClarityClient.logger.info('[XClarityClient::XClarityValidate validate] - Session created ...')
 
       close_session(id_session)
     rescue => err
@@ -38,7 +38,7 @@ module XClarityClient
         :password => conf.password
       }.to_json)
 
-      raise Faraday::Error::ConnectionFailed unless @response.success?
+      raise Faraday::ConnectionFailed unless @response.success?
     end
 
     def close_session(id_session)

data/lib/xclarity_client.rb

@@ -1,12 +1,6 @@
 require 'xclarity_client/version'
-require 'utils/logger'
-
-module XClarityClient
-  $lxca_log = XClarityClient::XClarityLogger.new
-end
-
+require 'xclarity_client/logging'
 require 'xclarity_client/errors/errors'
-
 require 'xclarity_client/configuration'
 require 'xclarity_client/xclarity_credentials_validator'
 require 'xclarity_client/discover'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xclarity_client
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Manasa Rao
@@ -205,6 +205,7 @@ files:
 - ".rubocop_base.yml"
 - ".rubocop_cc.yml"
 - ".travis.yml"
+- ".whitesource"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE
@@ -244,7 +245,6 @@ files:
 - docs/apib/update_repo.apib
 - docs/apib/users.apib
 - example/simple.rb
-- lib/utils/logger.rb
 - lib/xclarity_client.rb
 - lib/xclarity_client/client.rb
 - lib/xclarity_client/configuration.rb
@@ -292,6 +292,7 @@ files:
 - lib/xclarity_client/errors/connection_refused.rb
 - lib/xclarity_client/errors/errors.rb
 - lib/xclarity_client/errors/hostname_unknown.rb
+- lib/xclarity_client/logging.rb
 - lib/xclarity_client/mixins/aicc_mixin.rb
 - lib/xclarity_client/mixins/cabinet_mixin.rb
 - lib/xclarity_client/mixins/canister_mixin.rb

data/lib/utils/logger.rb

@@ -1,34 +0,0 @@
-require 'logger'
-require 'fileutils'
-module XClarityClient
-
-  class XClarityLogger
-    attr_accessor :log
-    
-    def initialize(global_log=nil)
-      # This block below looks for a log in the project which uses 
-      # this client or a defined log coming from initialize param.
-      # If none of these logs exists, is created a log by default.
-      @log = $lenovo_log ||= $log ||= global_log
-
-      if not @log
-        FileUtils::mkdir_p 'logs'
-        file = File.open('logs/lxca_client.log', 'a+')
-        file.sync = true
-        @log = Logger.new file
-      end
-
-    end
-
-    def info(header, msg)
-      @log.level = Logger::DEBUG
-      @log.info "[#{header}] - #{msg}"
-    end
-
-    def error(header, msg)
-      @log.level = Logger::ERROR
-      @log.error "[#{header}] - #{msg}"
-    end
-  end
-
-end