oneview-sdk 5.2.0 → 5.3.0

data/lib/oneview-sdk.rb

@@ -13,6 +13,7 @@ require_relative 'oneview-sdk/version'
 require_relative 'oneview-sdk/exceptions'
 require_relative 'oneview-sdk/client'
 require_relative 'oneview-sdk/resource'
+require_relative 'oneview-sdk/resource_helper'
 Dir[File.dirname(__FILE__) + '/oneview-sdk/resource/*.rb'].each { |file| require file }
 require_relative 'oneview-sdk/scmb'
 require_relative 'oneview-sdk/image_streamer'
@@ -20,9 +21,9 @@ require_relative 'oneview-sdk/cli'
 
 # Module for interacting with the HPE OneView API
 module OneviewSDK
-  env_sdk = %w(ONEVIEWSDK_URL ONEVIEWSDK_USER ONEVIEWSDK_PASSWORD ONEVIEWSDK_TOKEN ONEVIEWSDK_DOMAIN)
-  env_sdk.concat %w(ONEVIEWSDK_SSL_ENABLED ONEVIEWSDK_API_VERSION ONEVIEWSDK_VARIANT)
-  env_i3s = %w(I3S_URL I3S_SSL_ENABLED)
+  env_sdk = %w[ONEVIEWSDK_URL ONEVIEWSDK_USER ONEVIEWSDK_PASSWORD ONEVIEWSDK_TOKEN ONEVIEWSDK_DOMAIN]
+  env_sdk.concat %w[ONEVIEWSDK_SSL_ENABLED ONEVIEWSDK_API_VERSION ONEVIEWSDK_VARIANT]
+  env_i3s = %w[I3S_URL I3S_SSL_ENABLED]
   ENV_VARS = env_sdk.concat(env_i3s).freeze
 
   SUPPORTED_API_VERSIONS = [200, 300, 500].freeze

data/lib/oneview-sdk/cli.rb

@@ -73,7 +73,7 @@ module OneviewSDK
     class_option :log_level,
       desc: 'Log level to use',
       aliases: '-l',
-      enum: %w(debug info warn error),
+      enum: %w[debug info warn error],
       default: :warn
 
     map ['-v', '--version'] => :version
@@ -108,7 +108,7 @@ module OneviewSDK
     method_option :format,
       desc: 'Output format',
       aliases: '-f',
-      enum: %w(json yaml human),
+      enum: %w[json yaml human],
       default: 'human'
     desc 'env', 'Show environment variables for oneview-sdk-ruby'
     # Show environment variables for oneview-sdk-ruby
@@ -117,7 +117,7 @@ module OneviewSDK
       OneviewSDK::ENV_VARS.each { |k| data[k] = ENV[k] }
       if @options['format'] == 'human'
         data.each do |key, value|
-          value = "'#{value}'" if value && !%w(true false).include?(value)
+          value = "'#{value}'" if value && !%w[true false].include?(value)
           printf "%-#{data.keys.max_by(&:length).length}s = %s\n", key, value || 'nil'
         end
       else
@@ -135,7 +135,7 @@ module OneviewSDK
     method_option :format,
       desc: 'Output format',
       aliases: '-f',
-      enum: %w(json yaml human),
+      enum: %w[json yaml human],
       default: 'human'
     desc 'list TYPE', 'List names of resources'
     # List names of resources
@@ -150,7 +150,7 @@ module OneviewSDK
     method_option :format,
       desc: 'Output format',
       aliases: '-f',
-      enum: %w(json yaml human),
+      enum: %w[json yaml human],
       default: 'human'
     method_option :attribute,
       type: :string,
@@ -177,7 +177,7 @@ module OneviewSDK
     method_option :format,
       desc: 'Output format',
       aliases: '-f',
-      enum: %w(json yaml human),
+      enum: %w[json yaml human],
       default: 'human'
     method_option :attribute,
       type: :string,
@@ -218,7 +218,7 @@ module OneviewSDK
     method_option :format,
       desc: 'Output format',
       aliases: '-f',
-      enum: %w(json yaml raw),
+      enum: %w[json yaml raw],
       default: 'json'
     method_option :data,
       desc: 'Data to pass in the request body (in JSON format)',
@@ -384,7 +384,7 @@ module OneviewSDK
     method_option :format,
       desc: 'Output format',
       aliases: '-f',
-      enum: %w(json yaml),
+      enum: %w[json yaml],
       default: 'json'
     desc 'to_file TYPE NAME', 'Save resource details to file'
     # Save resource details to file
@@ -436,7 +436,7 @@ module OneviewSDK
     method_option :format,
       desc: 'Output format',
       aliases: '-f',
-      enum: %w(json yaml raw),
+      enum: %w[json yaml raw],
       default: 'json'
     scmb_examples = "\n  oneview-sdk-ruby scmb -r 'scmb.ethernet-networks.#'"
     scmb_examples << "\n  oneview-sdk-ruby scmb -r 'scmb.ethernet-networks.Created'"

data/lib/oneview-sdk/client.rb

@@ -17,9 +17,9 @@ require_relative 'ssl_helper'
 module OneviewSDK
   # The client defines the connection to the OneView server and handles communication with it.
   class Client
-    attr_reader :max_api_version
+    attr_reader :max_api_version, :log_level
     attr_accessor :url, :user, :token, :password, :domain, :ssl_enabled, :api_version, \
-                  :logger, :log_level, :cert_store, :print_wait_dots, :timeout
+                  :logger, :cert_store, :print_wait_dots, :timeout
 
     include Rest
 
@@ -42,7 +42,7 @@ module OneviewSDK
       options = Hash[options.map { |k, v| [k.to_sym, v] }] # Convert string hash keys to symbols
       STDOUT.sync = true
       @logger = options[:logger] || Logger.new(STDOUT)
-      [:debug, :info, :warn, :error, :level=].each { |m| raise InvalidClient, "Logger must respond to #{m} method " unless @logger.respond_to?(m) }
+      %i[debug info warn error level=].each { |m| raise InvalidClient, "Logger must respond to #{m} method " unless @logger.respond_to?(m) }
       self.log_level = options[:log_level] || :info
       @print_wait_dots = options.fetch(:print_wait_dots, false)
       @url = options[:url] || ENV['ONEVIEWSDK_URL']
@@ -56,8 +56,8 @@ module OneviewSDK
       OneviewSDK.api_version = @api_version unless OneviewSDK.api_version_updated? || !OneviewSDK::SUPPORTED_API_VERSIONS.include?(@api_version)
       @ssl_enabled = true
       if ENV.key?('ONEVIEWSDK_SSL_ENABLED')
-        if %w(true false 1 0).include?(ENV['ONEVIEWSDK_SSL_ENABLED'])
-          @ssl_enabled = !%w(false 0).include?(ENV['ONEVIEWSDK_SSL_ENABLED'])
+        if %w[true false 1 0].include?(ENV['ONEVIEWSDK_SSL_ENABLED'])
+          @ssl_enabled = !%w[false 0].include?(ENV['ONEVIEWSDK_SSL_ENABLED'])
         else
           @logger.warn "Unrecognized ssl_enabled value '#{ENV['ONEVIEWSDK_SSL_ENABLED']}'. Valid options are 'true' & 'false'"
         end
@@ -191,7 +191,7 @@ module OneviewSDK
       response = rest_api(:get, '/rest/version', options)
       version = response_handler(response)['currentVersion']
       raise ConnectionError, "Couldn't get API version" unless version
-      version = version.to_i if version.class != Fixnum
+      version = version.to_i if version.class != Integer
       version
     rescue ConnectionError
       @logger.warn "Failed to get OneView max api version. Using default (#{OneviewSDK::DEFAULT_API_VERSION})"

data/lib/oneview-sdk/image-streamer/client.rb

@@ -39,7 +39,7 @@ module OneviewSDK
         options = Hash[options.map { |k, v| [k.to_sym, v] }] # Convert string hash keys to symbols
         STDOUT.sync = true
         @logger = options[:logger] || Logger.new(STDOUT)
-        [:debug, :info, :warn, :error, :level=].each { |m| raise InvalidClient, "Logger must respond to #{m} method " unless @logger.respond_to?(m) }
+        %i[debug info warn error level=].each { |m| raise InvalidClient, "Logger must respond to #{m} method " unless @logger.respond_to?(m) }
         self.log_level = options[:log_level] || :info
         @print_wait_dots = options.fetch(:print_wait_dots, false)
         @url = options[:url] || ENV['I3S_URL']
@@ -54,8 +54,8 @@ module OneviewSDK
           OneviewSDK::ImageStreamer.api_version_updated? || !OneviewSDK::ImageStreamer::SUPPORTED_API_VERSIONS.include?(@api_version)
         @ssl_enabled = true
         if ENV.key?('I3S_SSL_ENABLED')
-          if %w(true false 1 0).include?(ENV['I3S_SSL_ENABLED'])
-            @ssl_enabled = !%w(false 0).include?(ENV['I3S_SSL_ENABLED'])
+          if %w[true false 1 0].include?(ENV['I3S_SSL_ENABLED'])
+            @ssl_enabled = !%w[false 0].include?(ENV['I3S_SSL_ENABLED'])
           else
             @logger.warn "Unrecognized ssl_enabled value '#{ENV['I3S_SSL_ENABLED']}'. Valid options are 'true' & 'false'"
           end
@@ -88,7 +88,7 @@ module OneviewSDK
         response = rest_api(:get, '/rest/version', options)
         version = response_handler(response)['currentVersion']
         raise ConnectionError, "Couldn't get API version" unless version
-        version = version.to_i if version.class != Fixnum
+        version = version.to_i if version.class != Integer
         version
       rescue ConnectionError
         @logger.warn "Failed to get Image Streamer max api version. Using default (#{OneviewSDK::ImageStreamer::DEFAULT_API_VERSION})"

data/lib/oneview-sdk/image-streamer/resource/api300/artifact_bundle.rb

@@ -16,7 +16,7 @@ module OneviewSDK
     module API300
       # Artifacts Bundle resource implementation for Image Streamer
       class ArtifactBundle < Resource
-        ACCEPTED_FORMATS = %w(.zip .ZIP).freeze # Supported upload extensions
+        ACCEPTED_FORMATS = %w[.zip .ZIP].freeze # Supported upload extensions
 
         BASE_URI = '/rest/artifact-bundles'.freeze
         BACKUPS_URI = "#{BASE_URI}/backups".freeze

data/lib/oneview-sdk/image-streamer/resource/api300/golden_image.rb

@@ -17,7 +17,7 @@ module OneviewSDK
       # Golden Image resource implementation for Image Streamer
       class GoldenImage < Resource
         BASE_URI = '/rest/golden-images'.freeze
-        ACCEPTED_FORMATS = %w(.zip .ZIP).freeze # Supported upload extensions
+        ACCEPTED_FORMATS = %w[.zip .ZIP].freeze # Supported upload extensions
 
         # Create a resource object, associate it with a client, and set its properties.
         # @param [OneviewSDK::ImageStreamer::Client] client The client object for the Image Streamer appliance

data/lib/oneview-sdk/resource.rb

@@ -17,7 +17,7 @@ module OneviewSDK
   # Resource base class that defines all common resource functionality.
   class Resource
     BASE_URI = '/rest'.freeze
-    UNIQUE_IDENTIFIERS = %w(name uri).freeze # Ordered list of unique attributes to search by
+    UNIQUE_IDENTIFIERS = %w[name uri].freeze # Ordered list of unique attributes to search by
     DEFAULT_REQUEST_HEADER = {}.freeze
 
     attr_accessor \
@@ -50,7 +50,7 @@ module OneviewSDK
     # @param [Hash] header The header options for the request (key-value pairs)
     # @return [Boolean] Whether or not retrieve was successful
     def retrieve!(header = self.class::DEFAULT_REQUEST_HEADER)
-      retrieval_keys = self.class::UNIQUE_IDENTIFIERS.select { |k| !@data[k].nil? }
+      retrieval_keys = self.class::UNIQUE_IDENTIFIERS.reject { |k| @data[k].nil? }
       raise IncompleteResource, "Must set resource #{self.class::UNIQUE_IDENTIFIERS.join(' or ')} before trying to retrieve!" if retrieval_keys.empty?
       retrieval_keys.each do |k|
         results = self.class.find_by(@client, { k => @data[k] }, self.class::BASE_URI, header)
@@ -66,7 +66,7 @@ module OneviewSDK
     # @param [Hash] header The header options for the request (key-value pairs)
     # @return [Boolean] Whether or not resource exists
     def exists?(header = self.class::DEFAULT_REQUEST_HEADER)
-      retrieval_keys = self.class::UNIQUE_IDENTIFIERS.select { |k| !@data[k].nil? }
+      retrieval_keys = self.class::UNIQUE_IDENTIFIERS.reject { |k| @data[k].nil? }
       raise IncompleteResource, "Must set resource #{self.class::UNIQUE_IDENTIFIERS.join(' or ')} before trying to retrieve!" if retrieval_keys.empty?
       retrieval_keys.each do |k|
         results = self.class.find_by(@client, { k => @data[k] }, self.class::BASE_URI, header)
@@ -133,7 +133,6 @@ module OneviewSDK
     # @return The value set for the given key
     def []=(key, value)
       set(key, value)
-      value
     end
 
     # Check equality of 2 resources. Same as eql?(other)
@@ -234,7 +233,7 @@ module OneviewSDK
     # @note If a .yml or .yaml file extension is given in the file_path, the format will be set automatically
     # @return [True] The Resource was saved successfully
     def to_file(file_path, format = :json)
-      format = :yml if %w(.yml .yaml).include? File.extname(file_path)
+      format = :yml if %w[.yml .yaml].include? File.extname(file_path)
       temp_data = { type: self.class.name, api_version: @api_version, data: @data }
       case format.to_sym
       when :json
@@ -379,7 +378,7 @@ module OneviewSDK
 
     # Fail for methods that are not available for one resource
     def unavailable_method
-      raise MethodUnavailable, "The method ##{caller[0][/`.*'/][1..-2]} is unavailable for this resource"
+      raise MethodUnavailable, "The method ##{caller(1..1).first[/`.*'/][1..-2]} is unavailable for this resource"
     end
 
     private

data/lib/oneview-sdk/resource/api200/enclosure.rb

@@ -21,7 +21,7 @@ module OneviewSDK
       include OneviewSDK::ResourceHelper::ConfigurationOperation
 
       BASE_URI = '/rest/enclosures'.freeze
-      UNIQUE_IDENTIFIERS = %w(name uri serialNumber activeOaPreferredIP standbyOaPreferredIP).freeze
+      UNIQUE_IDENTIFIERS = %w[name uri serialNumber activeOaPreferredIP standbyOaPreferredIP].freeze
 
       # Remove resource from OneView
       # @return [true] if resource was removed successfully
@@ -37,7 +37,6 @@ module OneviewSDK
         @data['type'] ||= 'EnclosureV200'
       end
 
-
       # Method is not available
       # @raise [OneviewSDK::MethodUnavailable] method is not available
       def create(*)
@@ -55,15 +54,15 @@ module OneviewSDK
       # @return [OneviewSDK::Enclosure] self
       def add
         ensure_client
-        required_attributes = %w(enclosureGroupUri hostname username password licensingIntent)
+        required_attributes = %w[enclosureGroupUri hostname username password licensingIntent]
         required_attributes.each { |k| raise IncompleteResource, "Missing required attribute: '#{k}'" unless @data.key?(k) }
 
-        optional_attrs = %w(enclosureUri firmwareBaselineUri force forceInstallFirmware state unmanagedEnclosure updateFirmwareOn)
+        optional_attrs = %w[enclosureUri firmwareBaselineUri force forceInstallFirmware state unmanagedEnclosure updateFirmwareOn]
         temp_data = @data.select { |k, _v| required_attributes.include?(k) || optional_attrs.include?(k) }
         response = @client.rest_post(self.class::BASE_URI, { 'body' => temp_data }, @api_version)
         new_data = @client.response_handler(response)
-        old_name = @data.select { |k, _v| %w(name rackName).include?(k) } # Save name (if given)
-        %w(username password hostname).each { |k| @data.delete(k) } # These are no longer needed
+        old_name = @data.select { |k, _v| %w[name rackName].include?(k) } # Save name (if given)
+        %w[username password hostname].each { |k| @data.delete(k) } # These are no longer needed
         set_all(new_data)
         set_all(old_name)
         update

data/lib/oneview-sdk/resource/api200/interconnect.rb

@@ -17,7 +17,7 @@ module OneviewSDK
     class Interconnect < Resource
       BASE_URI = '/rest/interconnects'.freeze
       TYPE_URI = '/rest/interconnect-types'.freeze
-      UNIQUE_IDENTIFIERS = %w(name uri serialNumber).freeze
+      UNIQUE_IDENTIFIERS = %w[name uri serialNumber].freeze
 
       # Create a resource object, associate it with a client, and set its properties.
       # @param [OneviewSDK::Client] client The client object for the OneView appliance

data/lib/oneview-sdk/resource/api200/logical_interconnect_group.rb

@@ -63,10 +63,9 @@ module OneviewSDK
           end
         end
 
-        unless entry_already_present
-          new_entry = new_interconnect_entry_template(bay, interconnect_type['uri'])
-          @data['interconnectMapTemplate']['interconnectMapEntryTemplates'] << new_entry
-        end
+        return if entry_already_present
+        new_entry = new_interconnect_entry_template(bay, interconnect_type['uri'])
+        @data['interconnectMapTemplate']['interconnectMapEntryTemplates'] << new_entry
       end
 
       # Adds an uplink set
@@ -85,12 +84,13 @@ module OneviewSDK
 
       # Create the resource on OneView using the current data
       # @note Calls the refresh method to set additional data
+      # @param [Hash] header The header options for the request (key-value pairs)
       # @raise [OneviewSDK::IncompleteResource] if the client is not set
       # @raise [StandardError] if the resource creation fails
       # @return [Resource] self
-      def create
+      def create(header = {})
         verify_interconnects_before_save!
-        super
+        super(DEFAULT_REQUEST_HEADER.merge(header))
       end
 
       # Set data and save to OneView

data/lib/oneview-sdk/resource/api200/logical_switch.rb

@@ -31,16 +31,18 @@ module OneviewSDK
       end
 
       # Create method
+      # @param [Hash] header The header options for the request (key-value pairs)
       # @raise [OneviewSDK::IncompleteResource] if the client is not set
       # @raise [StandardError] if the resource creation fails
       # @return [OneviewSDK::LogicalSwitch] self
-      def create
+      def create(header = {})
         ensure_client
         request_body = {}
         request_body['logicalSwitchCredentials'] = generate_logical_switch_credentials
         request_body['logicalSwitch'] = @data.clone
         request_body['logicalSwitch']['switchCredentialConfiguration'] = generate_logical_switch_credential_configuration
-        response = @client.rest_post(self.class::BASE_URI, { 'body' => request_body }, @api_version)
+        options = DEFAULT_REQUEST_HEADER.merge(header).merge('body' => request_body)
+        response = @client.rest_post(self.class::BASE_URI, options, @api_version)
         body = @client.response_handler(response)
         set_all(body)
         self
@@ -99,7 +101,7 @@ module OneviewSDK
       # @return [Array] List of connection properties for each logical switch
       def generate_logical_switch_credentials
         credentials = []
-        @logical_switch_credentials.each do |_, switch|
+        @logical_switch_credentials.each_value do |switch|
           switch_credentials = []
           switch_credentials << {
             'valueFormat' => 'Unknown',

data/lib/oneview-sdk/resource/api200/login_detail.rb

@@ -0,0 +1,27 @@
+# (C) Copyright 2017 Hewlett Packard Enterprise Development LP
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# You may not use this file except in compliance with the License.
+# You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software distributed
+# under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+# CONDITIONS OF ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+module OneviewSDK
+  module API200
+    # Login Details resource implementation
+    class LoginDetail
+      BASE_URI = '/rest/logindetails'.freeze
+
+      # Gets the login details
+      # @param [OneviewSDK::client] client access for resource endpoint
+      # @return [Hash] Response to the api call
+      def self.get_login_details(client)
+        response = client.rest_get(BASE_URI)
+        client.response_handler(response)
+      end
+    end
+  end
+end

data/lib/oneview-sdk/resource/api200/rack.rb

@@ -16,7 +16,7 @@ module OneviewSDK
     # Rack resource implementation
     class Rack < Resource
       BASE_URI = '/rest/racks'.freeze
-      UNIQUE_IDENTIFIERS = %w(name uri serialNumber).freeze
+      UNIQUE_IDENTIFIERS = %w[name uri serialNumber].freeze
 
       # Add the resource on OneView using the current data
       # @note Calls the refresh method to set additional data
@@ -51,6 +51,13 @@ module OneviewSDK
         unavailable_method
       end
 
+      # Updates a rack
+      # @param [Hash] attributes attributes to be updated
+      # @return [OneviewSDK::Rack] self
+      def update(attributes = {}, header = { 'If-Match' => '*' })
+        super(attributes, header)
+      end
+
       # Adds the rack resource with specified options
       # @param [OneviewSDK::Resource] resource Resource to be added
       # @param [String] options rack options