oneview-sdk 3.1.0 → 4.0.0

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

@@ -0,0 +1,26 @@
+# (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
+      # Artifacts Bundle resource implementation for Image Streamer
+      # @note This resource is unimplemented/unfinished at this point, so use at your own risk.
+      #   This resource is subject to change drastically in the near future without a major version
+      #   bump, which may break your code.
+      class ArtifactsBundle < Resource
+        BASE_URI = '/rest/artifact-bundles'.freeze
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# (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
+      # Build Plan resource implementation for Image Streamer
+      # @note This resource is unimplemented/unfinished at this point, so use at your own risk.
+      #   This resource is subject to change drastically in the near future without a major version
+      #   bump, which may break your code.
+      class BuildPlan < Resource
+        BASE_URI = '/rest/build-plans'.freeze
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# (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
+      # Deployment Plan resource implementation for Image Streamer
+      # @note This resource is unimplemented/unfinished at this point, so use at your own risk.
+      #   This resource is subject to change drastically in the near future without a major version
+      #   bump, which may break your code.
+      class DeploymentPlan < Resource
+        BASE_URI = '/rest/deployment-plans'.freeze
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# (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
+      # @note This resource is unimplemented/unfinished at this point, so use at your own risk.
+      #   This resource is subject to change drastically in the near future without a major version
+      #   bump, which may break your code.
+      class GoldenImage < Resource
+        BASE_URI = '/rest/golden-images'.freeze
+      end
+    end
+  end
+end

data/lib/oneview-sdk/{resource/api300/synergy/logical_switch_group.rb → image-streamer/resource/api300/os_volume.rb}

@@ -1,4 +1,4 @@
-# (C) Copyright 2016 Hewlett Packard Enterprise Development LP
+# (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.
@@ -9,35 +9,39 @@
 # CONDITIONS OF ANY KIND, either express or implied. See the License for the specific
 # language governing permissions and limitations under the License.
 
-require_relative '../../api200/logical_switch_group'
+require_relative 'resource'
 
 module OneviewSDK
-  module API300
-    module Synergy
-      # Logical switch group resource implementation for API300 Synergy
-      class LogicalSwitchGroup < OneviewSDK::API200::LogicalSwitchGroup
+  module ImageStreamer
+    module API300
+      # OS Volume resource implementation for Image Streamer
+      class OSVolume < Resource
+        BASE_URI = '/rest/os-volumes'.freeze
+
         # Method is not available
         # @raise [OneviewSDK::MethodUnavailable] method is not available
-        def create
+        def create(*)
           unavailable_method
         end
 
         # Method is not available
         # @raise [OneviewSDK::MethodUnavailable] method is not available
-        def update
+        def update(*)
           unavailable_method
         end
 
         # Method is not available
         # @raise [OneviewSDK::MethodUnavailable] method is not available
-        def delete
+        def delete(*)
           unavailable_method
         end
 
-        # Method is not available
-        # @raise [OneviewSDK::MethodUnavailable] method is not available
-        def set_grouping_parameters
-          unavailable_method
+        # Get the details of the archived OS volume with the specified attribute.
+        # @return [Hash] The details of the archived OS volume with the specified attribute
+        def get_details_archive
+          ensure_client && ensure_uri
+          response = @client.rest_get("#{BASE_URI}/archive/#{data['uri'].split('/').last}")
+          @client.response_handler(response)
         end
       end
     end

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

@@ -0,0 +1,42 @@
+# (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
+      # Plan Script resource implementation for Image Streamer
+      class PlanScript < Resource
+        BASE_URI = '/rest/plan-scripts'.freeze
+
+        # 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'] ||= 'PlanScript'
+        end
+
+        # Retrieves the modified contents of the selected Plan Script as per the selected attributes.
+        # @return [Hash] The script differences of the selected Plan Script.
+        def retrieve_differences
+          ensure_client && ensure_uri
+          path = "#{BASE_URI}/differences/#{@data['uri'].split('/').last}"
+          response = @client.rest_post(path, { 'Content-Type' => 'none' }, @api_version)
+          @client.response_handler(response)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# (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
+      class Resource < OneviewSDK::Resource
+      end
+    end
+  end
+end

data/lib/oneview-sdk/image-streamer/resource/api_300.rb

@@ -0,0 +1,39 @@
+# (c) Copyright 2016 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 Image Streamer
+  module ImageStreamer
+    # Module API 300
+    module API300
+      # Get resource class that matches the type given
+      # @param [String] type Name of the desired class type
+      # @param [String] variant There is only 1 variant for this module, so this is not used.
+      #   It exists only so that the parameters match API modules that do have multiple variants.
+      # @return [Class] Resource class or nil if not found
+      def self.resource_named(type, _variant = nil)
+        new_type = type.to_s.downcase.gsub(/[ -_]/, '')
+        constants.each do |c|
+          klass = const_get(c)
+          next unless klass.is_a?(Class) && klass < OneviewSDK::Resource
+          name = klass.name.split('::').last.downcase.delete('_').delete('-')
+          return klass if new_type =~ /^#{name}[s]?$/
+        end
+        nil
+      end
+    end
+  end
+end
+
+# Load all API-specific resources:
+Dir[File.dirname(__FILE__) + '/api300/*.rb'].each { |file| require file }

data/lib/oneview-sdk/image_streamer.rb

@@ -0,0 +1,68 @@
+# (c) Copyright 2016 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 'version'
+require_relative 'exceptions'
+require_relative 'image-streamer/client'
+require_relative 'resource'
+Dir[File.dirname(__FILE__) + '/image-streamer/resource/*.rb'].each { |file| require file }
+
+# Module for interacting with the HPE OneView API
+module OneviewSDK
+  # Module for interacting with the Image Streamer
+  module ImageStreamer
+    SUPPORTED_API_VERSIONS = [300].freeze
+    DEFAULT_API_VERSION = 300
+    @api_version = DEFAULT_API_VERSION
+    @api_version_updated = false # Whether or not the API version has been set by the user
+
+    # Get the current API version
+    def self.api_version
+      @api_version
+    end
+
+    # Set the default API version
+    def self.api_version=(version)
+      version = version.to_i rescue version
+      raise "API version #{version} is not supported!" unless SUPPORTED_API_VERSIONS.include?(version)
+      raise "The module for API version #{@api_version} is undefined" unless constants.include?("API#{@api_version}".to_sym)
+      @api_version_updated = true
+      @api_version = version
+    end
+
+    # Has the API version been set by the user?
+    # @return [TrueClass, FalseClass]
+    def self.api_version_updated?
+      @api_version_updated
+    end
+
+    # Helps redirect resources to the correct API module for Image Streamer
+    def self.const_missing(const)
+      api_module = OneviewSDK::ImageStreamer.const_get("API#{@api_version}")
+      api_module.const_get(const)
+    rescue NameError
+      raise NameError, "The #{const} method or resource does not exist for Image Streamer API version #{@api_version}."
+    end
+
+    # Get resource class that matches the type given
+    # @param [String] type Name of the desired class type
+    # @param [Fixnum] api_ver API module version to fetch resource from
+    # @param [String] variant API module variant to fetch resource from
+    # @return [Class] Resource class or nil if not found
+    def self.resource_named(type, api_ver = @api_version, variant = nil)
+      unless SUPPORTED_API_VERSIONS.include?(api_ver)
+        raise UnsupportedVersion, "API version #{api_ver} is not supported! Try one of: #{SUPPORTED_API_VERSIONS}"
+      end
+      api_module = OneviewSDK::ImageStreamer.const_get("API#{api_ver}")
+      variant ? api_module.resource_named(type, variant) : api_module.resource_named(type)
+    end
+  end
+end

data/lib/oneview-sdk/resource.rb

@@ -10,6 +10,7 @@
 # language governing permissions and limitations under the License.
 
 require_relative 'client'
+require_relative 'image-streamer/client'
 
 # OneviewSDK Resources
 module OneviewSDK
@@ -30,7 +31,7 @@ module OneviewSDK
     # @param [Integer] api_ver The api version to use when interracting with this resource.
     #   Defaults to the client.api_version if it exists, or the OneviewSDK::Client::DEFAULT_API_VERSION.
     def initialize(client, params = {}, api_ver = nil)
-      raise InvalidClient, 'Must specify a valid client' unless client.is_a?(OneviewSDK::Client)
+      raise InvalidClient, 'Must specify a valid client' unless client.is_a?(OneviewSDK::Client) || client.is_a?(OneviewSDK::ImageStreamer::Client)
       @client = client
       @logger = @client.logger
       @api_version = api_ver || @client.api_version
@@ -322,6 +323,17 @@ module OneviewSDK
       true
     end
 
+    # Gets all the URIs for the specified resources
+    # @param [Array<OneviewSDK::Resource>] resources The list of resources
+    # @return [Array<String>] List of uris
+    # @raise IncompleteResource if 'uri' is not set for each resource.
+    def ensure_and_get_uris(resources)
+      resources.map do |resource|
+        resource.ensure_uri
+        resource['uri']
+      end
+    end
+
     # 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"

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

@@ -30,13 +30,13 @@ module OneviewSDK
 
       # Method is not available
       # @raise [OneviewSDK::MethodUnavailable] method is not available
-      def create
+      def create(*)
         unavailable_method
       end
 
       # Method is not available
       # @raise [OneviewSDK::MethodUnavailable] method is not available
-      def delete
+      def delete(*)
         unavailable_method
       end
 

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

@@ -40,13 +40,13 @@ module OneviewSDK
 
       # Method is not available
       # @raise [OneviewSDK::MethodUnavailable] method is not available
-      def create
+      def create(*)
         unavailable_method
       end
 
       # Method is not available
       # @raise [OneviewSDK::MethodUnavailable] method is not available
-      def delete
+      def delete(*)
         unavailable_method
       end
 

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

@@ -37,13 +37,13 @@ module OneviewSDK
 
       # Method is not available
       # @raise [OneviewSDK::MethodUnavailable] method is not available
-      def create
+      def create(*)
         unavailable_method
       end
 
       # Method is not available
       # @raise [OneviewSDK::MethodUnavailable] method is not available
-      def delete
+      def delete(*)
         unavailable_method
       end
 

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

@@ -49,16 +49,21 @@ module OneviewSDK
 
       # Adds the logical interconnect group
       # @param [OneviewSDK::LogicalInterconnectGroup] lig Logical Interconnect Group
+      # @raise [OneviewSDK::NotFound] if the LIG uri is not set and cannot be retrieved
+      # @return [OneviewSDK::EnclosureGroup] self
       def add_logical_interconnect_group(lig)
         lig.retrieve! unless lig['uri']
+        raise(NotFound, "The logical interconnect group #{lig['name']} was not found.") unless lig['uri']
         lig['interconnectMapTemplate']['interconnectMapEntryTemplates'].each do |entry|
           entry['logicalLocation']['locationEntries'].each do |location|
             add_lig_to_bay(location['relativeValue'], lig) if location['type'] == 'Bay' && entry['permittedInterconnectTypeUri']
           end
         end
+        self
       end
 
       # Creates the interconnect bay mapping
+      # @return [OneviewSDK::EnclosureGroup] self
       def create_interconnect_bay_mapping
         @data['interconnectBayMappings'] = []
         1.upto(@data['interconnectBayMappingCount']) do |bay_number|
@@ -68,6 +73,7 @@ module OneviewSDK
           }
           @data['interconnectBayMappings'] << entry
         end
+        self
       end
 
       private