HewlettPackard/oneview-sdk-ruby

# (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.

require_relative 'resource'

module OneviewSDK
  module ImageStreamer
    module API300
      # 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

        # 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
        # @param [Hash] params The options for this resource (key-value pairs)
        # @param [Integer] api_ver The api version to use when interracting with this resource.
        def initialize(client, params = {}, api_ver = nil)
          super
          # Default values:
          @data['type'] ||= 'GoldenImage'
        end

        # Download the details of the golden image capture logs which has been archived based on the specific attribute ID.
        # @param [String] file_path
        # @return [True] When was saved successfully
        def download_details_archive(file_path)
          ensure_client && ensure_uri
          resp = @client.rest_api(:get, "#{BASE_URI}/archive/#{@data['uri'].split('/').last}")
          File.open(file_path, 'wb') { |file| file.write(resp.body) }
          true
        end

        # Downloads the content of the selected golden image to the specified file path.
        # @param [String] file_path
        # @param [Integer] timeout The number of seconds to wait for the request to complete
        # @return [True] When it was saved successfully
        def download(file_path)
          ensure_client && ensure_uri
          client.download_file("#{BASE_URI}/download/#{@data['uri'].split('/').last}", file_path)
        end

        # Upload a golden image from the specified local file path.
        # Only the .zip format file can be used for upload.
        # @param [OneviewSDK::ImageStreamer::Client] client The client object for the Image Streamer appliance
        # @param [String] file_path
        # @param [Hash] data_options Attributes of the golden image, passed in the request
        # @option data_options [String] :name The name of the Golden Image (required)
        # @option data_options [String] :description The description of the Golden Image (required)
        # @param [Integer] timeout The number of seconds to wait for the request to complete
        # @return [OneviewSDK::ImageStreamer::API300::GoldenImage] if the upload was successful, return a GoldenImage object
        def self.add(client, file_path, data_options, timeout = OneviewSDK::Rest::READ_TIMEOUT)
          data_options = Hash[data_options.map { |k, v| [k.to_s, v] }] # Convert symbols hash keys to string
          raise InvalidFormat, 'ERROR: File with extension not supported!' unless ACCEPTED_FORMATS.include? File.extname(file_path)
          raise IncompleteResource, 'Please set the name of the golden image!' unless data_options['name']
          raise IncompleteResource, 'Please set the description of the golden image!' unless data_options['description']
          data = client.upload_file(file_path, BASE_URI, { 'body' => data_options }, timeout)
          GoldenImage.new(client, data)
        end

        # Sets the OS volume
        # @param [OneviewSDK::ImageStreamer::API300::OSVolume] os_volume
        # @raise [OneviewSDK::NotFound] if the os volume uri is not set and cannot be retrieved
        def set_os_volume(os_volume)
          os_volume.retrieve! unless os_volume['uri']
          raise NotFound, 'The os volume was not found!' unless os_volume['uri']
          set('osVolumeURI', os_volume['uri'])
        end

        # Sets the build plan
        # @param [OneviewSDK::ImageStreamer::API300::BuildPlan] build_plan
        # @raise [OneviewSDK::NotFound] if the build plan uri is not set and cannot be retrieved
        def set_build_plan(build_plan)
          build_plan.retrieve! unless build_plan['uri']
          raise NotFound, 'The build plan was not found!' unless build_plan['uri']
          set('buildPlanUri', build_plan['uri'])
        end
      end
    end
  end
end