oneview-sdk 4.0.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b2cf0ee2e24d1983a8a7bdd7f5e37cf9980117b3
-  data.tar.gz: 38377447be77b778441fd237d8ff1e6c25a89140
+  metadata.gz: 33d01d70d21a357c6e0c4f9295f039d874aea7b1
+  data.tar.gz: f5bd6ddea83a0124bf87c034b2107b7949a1004b
 SHA512:
-  metadata.gz: c288b678eeca3f9bc01230993f76d351410d76a402b1bc85be631177fc09a758eebf9f9e3c130419c9c16632d3a62aab986f0a5a0863810747011071ab6927d8
-  data.tar.gz: 5e2a9af5bd94afdbdf6438fac6a03a2250117dfa87299d6ddce45e1a77491e16ab68c557a9a41714a819f1768f28190a273fb46460ff6aa92e4dc9659ea77f96
+  metadata.gz: 81644b00704bc889c5f62fbeb98fc2ef00fd7c0ba2a66631016aa867a298207bfc109eb904a8f404768779447f34b9f40a1cc17c3fb1efea46f2be3bd64811ae
+  data.tar.gz: d469232c518d22bc5ec52d828b929093a5bdac8a7d8ac12bbf647d4c1ca7f6be6f60ac817638e805d2d47dad578649e3ca7d4a310e9251a2bbdb34ab2c3304eb

data/CHANGELOG.md

@@ -1,4 +1,30 @@
 # Unreleased Changes
+(none)
+
+# v4.1.0
+
+#### New Resources:
+Added full support to Image Streamer Rest API version 300:
+   - Artifact Bundle
+   - Build Plan
+   - Deployment Group
+   - Deployment Plan
+   - Golden Image
+   - OS Volume
+   - Plan Script
+
+#### Bug fixes & Enhancements:
+- Give custom exception classes a data attribute for more error context and default message
+- [#116](https://github.com/HewlettPackard/oneview-sdk-ruby/issues/112) VolumeAttachment::remove_extra_unmanaged_volume throw Unexpected Http Error
+- [#135](https://github.com/HewlettPackard/oneview-sdk-ruby/issues/135) Firmware Bundle timeout does not give proper instructions for user post failure
+- [#146](https://github.com/HewlettPackard/oneview-sdk-ruby/issues/146) Why is Switch the only resource that directly implements #set_scope_uris?
+- [#166](https://github.com/HewlettPackard/oneview-sdk-ruby/issues/166) I3S - Simplify login to i3s through oneview client
+- [#178](https://github.com/HewlettPackard/oneview-sdk-ruby/issues/178) Add client destroy_session method and domain attribute
+- [#174](https://github.com/HewlettPackard/oneview-sdk-ruby/issues/174) I3S - Integration test for Build Plan failing
+- [#176](https://github.com/HewlettPackard/oneview-sdk-ruby/issues/176) OneviewSDK.resource_named now finds resources that are not children of Resource
+- [#183](https://github.com/HewlettPackard/oneview-sdk-ruby/issues/183) Image Streamer Client cannot be created with the OneView environment variables
+- [#184](https://github.com/HewlettPackard/oneview-sdk-ruby/issues/184) Coveralls badge showing coverage as unknown
+- [#196](https://github.com/HewlettPackard/oneview-sdk-ruby/issues/196) Missing endpoint for extract backup in Artifact Bundle
 
 # v4.0.0
 

data/README.md

@@ -1,17 +1,18 @@
 # oneview-sdk for Ruby
 [![Gem Version](https://badge.fury.io/rb/oneview-sdk.svg)](https://badge.fury.io/rb/oneview-sdk)
+[![Yard Docs](https://img.shields.io/badge/yard-docs-yellow.svg)](http://www.rubydoc.info/gems/oneview-sdk)
 
+[![Build Status](https://travis-ci.org/HewlettPackard/oneview-sdk-ruby.svg?branch=master)](https://travis-ci.org/HewlettPackard/oneview-sdk-ruby)
+[![Coverage Status](https://coveralls.io/repos/github/HewlettPackard/oneview-sdk-ruby/badge.svg)](https://coveralls.io/github/HewlettPackard/oneview-sdk-ruby)
+[![Code Climate](https://codeclimate.com/github/HewlettPackard/oneview-sdk-ruby/badges/gpa.svg)](https://codeclimate.com/github/HewlettPackard/oneview-sdk-ruby)
 
 The OneView SDK provides a Ruby library to easily interact with HPE OneView and Image Streamer APIs. The Ruby SDK enables developers to easily build integrations and scalable solutions with HPE OneView and Image Streamer.
 
-Note that currently the Image Streamer resources are a work in progress, so should be treated as experimental.
-Many of these resources are unimplemented, and all are subject to change in ways that are incompatible with current usage & docs.
-
 ## Installation
 - Require the gem in your Gemfile:
 
   ```ruby
-  gem 'oneview-sdk', '~> 4.0'
+  gem 'oneview-sdk', '~> 4.1'
   ```
 
   Then run `$ bundle install`
@@ -36,6 +37,7 @@ client = OneviewSDK::Client.new(
   ssl_enabled: true,                  # This is the default and strongly encouraged
   logger: Logger.new(STDOUT),         # This is the default
   log_level: :info,                   # This is the default
+  domain: 'LOCAL',                    # This is the default
   api_version: 200                    # Defaults to minimum of 200 and appliance's max API version
 )
 ```
@@ -60,6 +62,19 @@ i3s_client = OneviewSDK::ImageStreamer::Client.new(
 )
 ```
 
+You can also create the i3s client through the Oneview client instance.
+```ruby
+# Create an Image Streamer client object through the Oneview client object:
+require 'oneview-sdk'
+i3s_client = client.new_i3s_client(
+  url: 'https://image-streamer.example.com',
+  ssl_enabled: true,                  # This is the default and strongly encouraged
+  logger: Logger.new(STDOUT),         # This is the default
+  log_level: :info,                   # This is the default
+  api_version: 300                    # Defaults to minimum of 300 and appliance's max API version
+)
+```
+
 ##### Environment Variables
 
 You can also set many of the client attributes using environment variables. To set these variables in bash:
@@ -67,6 +82,7 @@ You can also set many of the client attributes using environment variables. To s
 ```bash
 # OneView client options:
 export ONEVIEWSDK_URL='https://oneview.example.com'
+export ONEVIEWSDK_DOMAIN='LOCAL'
 # You can set the token if you know it, or set the user and password to generate one:
 export ONEVIEWSDK_TOKEN='xxxx...'
 export ONEVIEWSDK_USER='Administrator'
@@ -76,7 +92,6 @@ export ONEVIEWSDK_SSL_ENABLED=false
 
 # Image Streamer (I3S) client options:
 export I3S_URL='https://image-streamer.example.com'
-export I3S_TOKEN='xxxx...'
 export I3S_SSL_ENABLED=false
 # NOTE: Disabling SSL is strongly discouraged. Please see the CLI section for import instructions.
 ```
@@ -88,7 +103,18 @@ Then you can leave out these options from your config, enabling you to just do:
 ```ruby
 require 'oneview-sdk'
 client = OneviewSDK::Client.new
-# and/or
+```
+
+You can create the i3s client with environment variables in the following ways:
+```ruby
+require 'oneview-sdk'
+# Note: Both options require the I3S_URL environment variable to be set.
+
+# This way uses the ONEVIEWSDK_URL, ONEVIEWSDK_USER and ONEVIEWSDK_PASSWORD environment variables to generate a token:
+client = OneviewSDK::Client.new
+i3s_client = client.new_i3s_client
+
+# This way uses the ONEVIEWSDK_TOKEN environment variable directly:
 i3s_client = OneviewSDK::ImageStreamer::Client.new
 ```
 
@@ -152,7 +178,7 @@ OneviewSDK.api_version = 300
 OneviewSDK.api_version                  # 300
 OneviewSDK.api_version_updated?         # true
 
-# The API200 module has only 1 variant, but API300 has 2 (C7000 & Synergy):
+# The API200 module has no variants, but API300 has 2 (C7000 & Synergy):
 OneviewSDK::API300::SUPPORTED_VARIANTS  # ['C7000', 'Synergy']
 OneviewSDK::API300::DEFAULT_VARIANT     # 'C7000'
 OneviewSDK::API300.variant              # 'C7000'
@@ -406,7 +432,4 @@ First run `$ bundle` (requires the bundler gem), then...
 Note: run `$ rake -T` to get a list of all the available rake tasks.
 
 ## Authors
- - Jared Smartt - [@jsmartt](https://github.com/jsmartt)
- - Henrique Diomede - [@hdiomede](https://github.com/hdiomede)
- - Thiago Miotto - [@tmiotto](https://github.com/tmiotto)
- - Ricardo Piantola - [@piantola](https://github.com/piantola)
+See the [contributors graph](https://github.com/HewlettPackard/oneview-sdk-ruby/graphs/contributors)

data/Rakefile

@@ -252,6 +252,5 @@ end
 desc 'Run rubocop & integration tests for Image Streamer & specified path'
 task 'test:i3s:path', [:path] do |_t, spec|
   spec_pattern = spec['path']
-  Rake::Task[:rubocop].invoke
   Rake::Task['spec:integration:i3s'].invoke
 end

data/lib/oneview-sdk.rb

@@ -19,9 +19,9 @@ require_relative 'oneview-sdk/image_streamer'
 
 # Module for interacting with the HPE OneView API
 module OneviewSDK
-  env_sdk = %w(ONEVIEWSDK_URL ONEVIEWSDK_USER ONEVIEWSDK_PASSWORD ONEVIEWSDK_TOKEN)
+  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_TOKEN I3S_SSL_ENABLED)
+  env_i3s = %w(I3S_URL I3S_SSL_ENABLED)
   ENV_VARS = env_sdk.concat(env_i3s).freeze
 
   SUPPORTED_API_VERSIONS = [200, 300].freeze
@@ -37,8 +37,10 @@ module OneviewSDK
   # 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)
+    raise UnsupportedVersion, "API version #{version} is not supported!"\
+      unless SUPPORTED_API_VERSIONS.include?(version)
+    raise UnsupportedVariant, "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

data/lib/oneview-sdk/cli.rb

@@ -466,13 +466,13 @@ module OneviewSDK
       r = OneviewSDK.resource_named(type, api_ver, variant)
       # Try default API version as last resort
       r ||= OneviewSDK.resource_named(type, OneviewSDK.api_version, variant) unless api_ver == OneviewSDK.api_version
-      return r if r
+      return r if r && r.respond_to?(:find_by)
       valid_classes = []
       api_module = OneviewSDK.const_get("API#{api_ver}")
       api_module = api_module.const_get(variant.to_s) unless api_ver.to_i == 200
       api_module.constants.each do |c|
         klass = api_module.const_get(c)
-        next unless klass.is_a?(Class) && klass < OneviewSDK::Resource
+        next unless klass.is_a?(Class) && klass.respond_to?(:find_by)
         valid_classes.push(klass.name.split('::').last)
       end
       vc = valid_classes.sort_by!(&:downcase).join("\n  ")

data/lib/oneview-sdk/client.rb

@@ -1,7 +1,7 @@
-# (C) Copyright 2016 Hewlett Packard Enterprise Development LP
+# (c) Copyright 2016-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 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
@@ -18,7 +18,7 @@ module OneviewSDK
   # The client defines the connection to the OneView server and handles communication with it.
   class Client
     attr_reader :max_api_version
-    attr_accessor :url, :user, :token, :password, :ssl_enabled, :api_version, \
+    attr_accessor :url, :user, :token, :password, :domain, :ssl_enabled, :api_version, \
                   :logger, :log_level, :cert_store, :print_wait_dots, :timeout
 
     include Rest
@@ -32,6 +32,7 @@ module OneviewSDK
     # @option options [String] :url URL of OneView appliance
     # @option options [String] :user ('Administrator') The username to use for authentication with the OneView appliance
     # @option options [String] :password (ENV['ONEVIEWSDK_PASSWORD']) The password to use for authentication with OneView appliance
+    # @option options [String] :domain ('LOCAL') The name of the domain directory used for authentication
     # @option options [String] :token (ENV['ONEVIEWSDK_TOKEN']) The token to use for authentication with OneView appliance
     #   Use the token or the username and password (not both). The token has precedence.
     # @option options [Integer] :api_version (200) This is the API version to use by default for requests
@@ -65,12 +66,12 @@ module OneviewSDK
       @timeout = options[:timeout] unless options[:timeout].nil?
       @cert_store = OneviewSDK::SSLHelper.load_trusted_certs if @ssl_enabled
       @token = options[:token] || ENV['ONEVIEWSDK_TOKEN']
-      return if @token
-      @logger.warn 'User option not set. Using default (Administrator)' unless options[:user] || ENV['ONEVIEWSDK_USER']
+      @logger.warn 'User option not set. Using default (Administrator)' unless @token || options[:user] || ENV['ONEVIEWSDK_USER']
       @user = options[:user] || ENV['ONEVIEWSDK_USER'] || 'Administrator'
       @password = options[:password] || ENV['ONEVIEWSDK_PASSWORD']
-      raise InvalidClient, 'Must set user & password options or token option' unless @password
-      @token = login
+      raise InvalidClient, 'Must set user & password options or token option' unless @token || @password
+      @domain = options[:domain] || ENV['ONEVIEWSDK_DOMAIN'] || 'LOCAL'
+      @token ||= login
     end
 
     def log_level=(level)
@@ -157,6 +158,30 @@ module OneviewSDK
       self
     end
 
+    # Delete the session on the appliance, invalidating the client's token.
+    # To generate a new token after calling this method, use the refresh_login method.
+    # Call this after a token expires or the user and/or password is updated on the client object.
+    # @return [OneviewSDK::Client] self
+    def destroy_session
+      response_handler(rest_delete('/rest/login-sessions'))
+      self
+    end
+
+    # Creates the image streamer client object.
+    # @param [Hash] options the options to configure the client
+    # @option options [Logger] :logger (Logger.new(STDOUT)) Logger object to use.
+    #   Must implement debug(String), info(String), warn(String), error(String), & level=
+    # @option options [Symbol] :log_level (:info) Log level. Logger must define a constant with this name. ie Logger::INFO
+    # @option options [Boolean] :print_wait_dots (false) When true, prints status dots while waiting on the tasks to complete.
+    # @option options [String] :url URL of Image Streamer
+    # @option options [Integer] :api_version (300) This is the API version to use by default for requests
+    # @option options [Boolean] :ssl_enabled (true) Use ssl for requests? Respects ENV['I3S_SSL_ENABLED']
+    # @option options [Integer] :timeout (nil) Override the default request timeout value
+    # @return [OneviewSDK::ImageStreamer::Client] New instance of image streamer client
+    def new_i3s_client(options = {})
+      OneviewSDK::ImageStreamer::Client.new(options.merge(token: @token))
+    end
+
 
     private
 
@@ -179,7 +204,7 @@ module OneviewSDK
         'body' => {
           'userName' => @user,
           'password' => @password,
-          'authLoginDomain' => 'LOCAL'
+          'authLoginDomain' => @domain
         }
       }
       response = rest_post('/rest/login-sessions', options)

data/lib/oneview-sdk/exceptions.rb

@@ -1,7 +1,7 @@
-# (C) Copyright 2016 Hewlett Packard Enterprise Development LP
+# (c) Copyright 2016-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 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
@@ -11,45 +11,81 @@
 
 # Contains all the custom Exception classes
 module OneviewSDK
-  class ConnectionError < StandardError # Cannot connect to client/resource
+  # Error class allowing storage of a data attribute
+  class OneViewError < ::StandardError
+    attr_accessor :data
+    MESSAGE = '(No message)'.freeze
+
+    def initialize(msg = self.class::MESSAGE, data = nil)
+      @data = data
+      super(msg)
+    end
+
+    # Shorthand method to raise an error.
+    # @example
+    #   OneviewSDK::OneViewError.raise! 'Message', { data: 'stuff' }
+    def self.raise!(msg = self::MESSAGE, data = nil)
+      raise new(msg, data)
+    end
+  end
+
+  class ConnectionError < OneViewError # Cannot connect to client/resource
+    MESSAGE = 'Cannot connect to client/resource'.freeze
+  end
+
+  class InvalidURL < OneViewError # URL is invalid
+    MESSAGE = 'URL is invalid'.freeze
   end
 
-  class InvalidURL < StandardError # URL is invalid
+  class InvalidClient < OneViewError # Client configuration is invalid
+    MESSAGE = 'Client configuration is invalid'.freeze
   end
 
-  class InvalidClient < StandardError # Client configuration is invalid
+  class InvalidResource < OneViewError # Failed resource validations
+    MESSAGE = 'Failed resource validations'.freeze
   end
 
-  class InvalidResource < StandardError # Failed resource validations
+  class IncompleteResource < OneViewError # Missing required resource data to complete action
+    MESSAGE = 'Missing required resource data to complete action'.freeze
   end
 
-  class IncompleteResource < StandardError # Missing required resource data to complete action
+  class MethodUnavailable < OneViewError # Resource does not support this method
+    MESSAGE = 'Resource does not support this method'.freeze
   end
 
-  class MethodUnavailable < StandardError # Resource does not support this method
+  class UnsupportedVariant < OneViewError # Variant is not supported
+    MESSAGE = 'Variant is not supported'.freeze
   end
 
-  class UnsupportedVersion < StandardError # Resource not supported on this API version
+  class UnsupportedVersion < OneViewError # Resource not supported on this API version
+    MESSAGE = 'Resource not supported on this API version'.freeze
   end
 
-  class InvalidRequest < StandardError # Could not make request
+  class InvalidRequest < OneViewError # Could not make request
+    MESSAGE = 'Could not make request'.freeze
   end
 
-  class BadRequest < StandardError # 400
+  class BadRequest < OneViewError # 400
+    MESSAGE = '400'.freeze
   end
 
-  class Unauthorized < StandardError # 401
+  class Unauthorized < OneViewError # 401
+    MESSAGE = '401'.freeze
   end
 
-  class NotFound < StandardError # 404
+  class NotFound < OneViewError # 404
+    MESSAGE = '404'.freeze
   end
 
-  class RequestError < StandardError # Other bad response codes
+  class RequestError < OneViewError # Other bad response codes
+    MESSAGE = 'Bad response code'.freeze
   end
 
-  class TaskError < StandardError # Task ended in a bad state
+  class TaskError < OneViewError # Task ended in a bad state
+    MESSAGE = 'Task ended in a bad state'.freeze
   end
 
-  class InvalidFormat < StandardError # File format is invalid
+  class InvalidFormat < OneViewError # File format is invalid
+    MESSAGE = 'File format is invalid'.freeze
   end
 end

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

@@ -19,7 +19,10 @@ module OneviewSDK
       undef :user=
       undef :password
       undef :password=
+      undef :domain
+      undef :domain=
       undef :refresh_login
+      undef :destroy_session
 
       # Creates client object, establish connection, and set up logging and api version.
       # @param [Hash] options the options to configure the client
@@ -28,7 +31,7 @@ module OneviewSDK
       # @option options [Symbol] :log_level (:info) Log level. Logger must define a constant with this name. ie Logger::INFO
       # @option options [Boolean] :print_wait_dots (false) When true, prints status dots while waiting on the tasks to complete.
       # @option options [String] :url URL of Image Streamer
-      # @option options [String] :token (ENV['I3S_TOKEN']) The token to use for authentication with Image Streamer
+      # @option options [String] :token (ENV['ONEVIEWSDK_TOKEN']) The token to use for authentication
       # @option options [Integer] :api_version (300) This is the API version to use by default for requests
       # @option options [Boolean] :ssl_enabled (true) Use ssl for requests? Respects ENV['I3S_SSL_ENABLED']
       # @option options [Integer] :timeout (nil) Override the default request timeout value
@@ -60,8 +63,8 @@ module OneviewSDK
         @ssl_enabled = options[:ssl_enabled] unless options[:ssl_enabled].nil?
         @timeout = options[:timeout] unless options[:timeout].nil?
         @cert_store = OneviewSDK::SSLHelper.load_trusted_certs if @ssl_enabled
-        raise InvalidClient, 'Must set token option' unless options[:token] || ENV['I3S_TOKEN']
-        @token = options[:token] || ENV['I3S_TOKEN']
+        raise InvalidClient, 'Must set token option' unless options[:token] || ENV['ONEVIEWSDK_TOKEN']
+        @token = options[:token] || ENV['ONEVIEWSDK_TOKEN']
       end
 
       # Get array of all resources of a specified type

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

@@ -0,0 +1,215 @@
+# (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
+      class ArtifactBundle < Resource
+        ACCEPTED_FORMATS = %w(.zip .ZIP).freeze # Supported upload extensions
+
+        BASE_URI = '/rest/artifact-bundles'.freeze
+        BACKUPS_URI = "#{BASE_URI}/backups".freeze
+        BACKUPS_ARCHIVE_URI = "#{BACKUPS_URI}/archive".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
+          @data['buildPlans']      ||= []
+          @data['planScripts']     ||= []
+          @data['deploymentPlans'] ||= []
+          @data['goldenImages']    ||= []
+        end
+
+        # Creates an artifact bundle resource from the file that is uploaded from admin's local drive
+        # @param [OneviewSDK::ImageStreamer::Client] client The client object for the Image Streamer appliance
+        # @param [String] file_path The file path with file extension
+        # @param [String] artifact_name The name for the artifact that will be created
+        # @param [Integer] timeout The number of seconds to wait for completing the request. Default is 300.
+        # @return [OneviewSDK::ImageStreamer::API300::ArtifactBundle] if the upload was successful, return a ArtifactBundle object
+        def self.create_from_file(client, file_path, artifact_name, timeout = OneviewSDK::Rest::READ_TIMEOUT)
+          ensure_file_path_extension!(file_path)
+
+          file_name = artifact_name.dup
+          if file_name && !file_name.empty?
+            file_name += File.extname(file_path)
+          else
+            file_name = File.basename(file_path)
+          end
+
+          params = { 'name' => file_name }
+          body = client.upload_file(file_path, BASE_URI, params, timeout)
+          ArtifactBundle.new(client, body)
+        end
+
+        # Gets the backup bundles created
+        # @param [OneviewSDK::ImageStreamer::Client] client The client object for the Image Streamer appliance
+        # @return [Array<ArtifactBundle>] Array of ArtifactBundle
+        def self.get_backups(client)
+          find_by(client, {}, BACKUPS_URI)
+        end
+
+        # Creates a backup bundle with all the artifacts present on the appliance.
+        # @param [OneviewSDK::ImageStreamer::Client] client The client object for the Image Streamer appliance
+        # @param [DeploymentGroup] deployment_group The DeploymentGroup with name or uri
+        # @return [Hash] The result hash with DeploymentGroup data
+        def self.create_backup(client, deployment_group)
+          ensure_resource!(deployment_group)
+          response = client.rest_post(BACKUPS_URI, 'body' => { 'deploymentGroupURI' => deployment_group['uri'] })
+          client.response_handler(response)
+        end
+
+        # Creates a backup bundle from the zip file and extract all the artifacts present in the uploaded file
+        #   If there are any artifacts existing, they will be removed before the extract operation.
+        # @param [OneviewSDK::ImageStreamer::Client] client The client object for the Image Streamer appliance
+        # @param [String] file_path The file path with file extension
+        # @param [String] artifact_name The name for the artifact that will be created
+        # @param [Integer] timeout The number of seconds to wait for completing the request. Default is 300.
+        # @return [Hash] The result hash with DeploymentGroup data
+        def self.create_backup_from_file!(client, deployment_group, file_path, artifact_name, timeout = OneviewSDK::Rest::READ_TIMEOUT)
+          ensure_resource!(deployment_group)
+          ensure_file_path_extension!(file_path)
+
+          file_name = artifact_name.dup
+          if file_name && !file_name.empty?
+            file_name += File.extname(file_path)
+          else
+            file_name = File.basename(file_path)
+          end
+
+          params = { 'name' => file_name, 'deploymentGrpUri' => deployment_group['uri'] }
+          client.upload_file(file_path, BACKUPS_ARCHIVE_URI, params, timeout)
+        end
+
+        # Download the backup bundle
+        # @param [OneviewSDK::ImageStreamer::Client] client The client object for the Image Streamer appliance
+        # @param [String] local_drive_path The path where file will be saved
+        # @param [ArtifactBundle] bundle_backup The backup ArtifactBundle with 'downloadURI'
+        # @return [Boolean] true if backup was downloaded
+        def self.download_backup(client, local_drive_path, bundle_backup)
+          raise IncompleteResource, "Missing required attribute 'downloadURI'" unless bundle_backup['downloadURI']
+          client.download_file(bundle_backup['downloadURI'], local_drive_path)
+        end
+
+        # Extracts the existing backup bundle on the appliance and creates all the artifacts.
+        #   If there are any artifacts existing, they will be removed before the extract operation.
+        # @param [DeploymentGroup] deployment_group The DeploymentGroup with 'name' or 'uri'
+        # @param [ArtifactBundle] bundle_backup The backup ArtifactBundle with 'uri'
+        # @return [Boolean] true if backup bundle was extracted
+        # @raise [OneviewSDK::IncompleteResource] if the client or uri is not set
+        def self.extract_backup(client, deployment_group, bundle_backup)
+          ensure_resource!(deployment_group)
+          raise IncompleteResource, "Missing required attribute 'uri' of backup bundle" unless bundle_backup['uri']
+          id = bundle_backup['uri'].split('/').last
+          response = client.rest_put("#{BACKUPS_URI}/#{id}", 'body' => { 'deploymentGroupURI' => deployment_group['uri'] })
+          client.response_handler(response)
+          true
+        end
+
+        # Method is not available
+        # @raise [OneviewSDK::MethodUnavailable] method is not available
+        def update(*)
+          unavailable_method
+        end
+
+        # Update the name of Artifact Bundle
+        # @param [String] new_name Name to update the Artifact Bundle
+        # @return [Boolean] true if name was updated
+        # @raise [OneviewSDK::IncompleteResource] if the client or uri is not set
+        def update_name(new_name)
+          ensure_uri
+          response = @client.rest_put(@data['uri'], 'body' => { 'name' => new_name, 'type' => 'ArtifactsBundle' })
+          @client.response_handler(response)
+          @data['name'] = new_name
+          true
+        end
+
+        # Extracts the artifact bundle and creates the artifacts on the appliance
+        # @param [Boolean] force Forces the extract operation even when there are any conflicts
+        # @return [Boolean] true if artifact bundle was extracted
+        # @raise [OneviewSDK::IncompleteResource] if the client or uri is not set
+        def extract(force = true)
+          ensure_uri
+          options = { 'Content-Type' => 'text/plain' }
+          response = @client.rest_put(@data['uri'] + "?extract=true&forceImport=#{force}", options)
+          @client.response_handler(response)
+          true
+        end
+
+        # Downloads the content of the selected artifact bundle to the admin's local drive.
+        # @param [String] local_drive_path Path to save file downloaded
+        # @return [Boolean] true if the file was downloaded
+        def download(local_drive_path)
+          raise IncompleteResource, "Missing required attribute 'downloadURI'" unless @data['downloadURI']
+          client.download_file(@data['downloadURI'], local_drive_path)
+        end
+
+        # Add a Build Plan to this ArtifactBundle
+        # @param [OneviewSDK::ImageStreamer::API300::BuildPlan] resource The BuildPlan resource with uri
+        # @param [TrueClass, FalseClass] read_only Indicates whether the BuildPlan will be readonly in artifact bundle package
+        # @raise [RuntimeError] if the BuildPlan uri is not set or it is not valid
+        def add_build_plan(resource, read_only = true)
+          add_resource(resource, 'buildPlans', read_only)
+        end
+
+        # Add a Plan Script to this ArtifactBundle
+        # @param [OneviewSDK::ImageStreamer::API300::PlanScript] resource The PlanScripts resource with uri
+        # @param [TrueClass, FalseClass] read_only Indicates whether the PlanScripts will be readonly in artifact bundle package
+        # @raise [RuntimeError] if the PlanScripts uri is not set or it is not valid
+        def add_plan_script(resource, read_only = true)
+          add_resource(resource, 'planScripts', read_only)
+        end
+
+        # Add a Deployment Plan to this ArtifactBundle
+        # @param [OneviewSDK::ImageStreamer::API300::DeploymentPlans] resource The DeploymentPlans resource with uri
+        # @param [TrueClass, FalseClass] read_only Indicates whether the DeploymentPlans will be readonly in artifact bundle package
+        # @raise [RuntimeError] if the DeploymentPlans uri is not set or it is not valid
+        def add_deployment_plan(resource, read_only = true)
+          add_resource(resource, 'deploymentPlans', read_only)
+        end
+
+        # Add a Golden Image to this ArtifactBundle
+        # @param [OneviewSDK::ImageStreamer::API300::GoldenImage] resource The GoldenImage resource with uri
+        # @param [TrueClass, FalseClass] read_only Indicates whether the GoldenImage will be readonly in artifact bundle package
+        # @raise [RuntimeError] if the GoldenImage uri is not set or it is not valid
+        def add_golden_image(resource, read_only = true)
+          add_resource(resource, 'goldenImages', read_only)
+        end
+
+        # Fail unless resource can be retrieved
+        def self.ensure_resource!(resource)
+          raise IncompleteResource, "The resource #{resource.class} can not be retrieved. Ensure it can be retrieved." unless resource.retrieve!
+        end
+
+        # Fail unless file extension of file_path is in ACCEPTED_FORMATS array
+        def self.ensure_file_path_extension!(file_path)
+          raise InvalidFormat, "File extension should be #{ACCEPTED_FORMATS}" unless ACCEPTED_FORMATS.include?(File.extname(file_path))
+        end
+
+        private
+
+        # Add resource data to data hash
+        # @param [OneviewSDK::Resource] resource The resource with uri
+        # @param [String] key_name The hash key of data hash
+        # @param [TrueClass, FalseClass] read_only The value of readOnly attribute
+        def add_resource(resource, key_name, read_only)
+          self.class.ensure_resource!(resource)
+          @data[key_name] << { 'resourceUri' => resource['uri'], 'readOnly' => read_only }
+        end
+      end
+    end
+  end
+end

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

@@ -15,11 +15,18 @@ 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
+
+        # 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'] ||= 'OeBuildPlan'
+        end
       end
     end
   end

data/lib/oneview-sdk/image-streamer/resource/api300/{artifacts_bundle.rb → deployment_group.rb}

@@ -14,12 +14,27 @@ 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
+      # Deployment Group resource implementation for Image Streamer
+      class DeploymentGroup < Resource
+        BASE_URI = '/rest/deployment-groups'.freeze
+
+        # Method is not available
+        # @raise [OneviewSDK::MethodUnavailable] method is not available
+        def create(*)
+          unavailable_method
+        end
+
+        # Method is not available
+        # @raise [OneviewSDK::MethodUnavailable] method is not available
+        def update(*)
+          unavailable_method
+        end
+
+        # Method is not available
+        # @raise [OneviewSDK::MethodUnavailable] method is not available
+        def delete(*)
+          unavailable_method
+        end
       end
     end
   end

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

@@ -15,11 +15,18 @@ 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
+
+        # 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'] ||= 'OEDeploymentPlan'
+        end
       end
     end
   end

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

@@ -10,16 +10,134 @@
 # language governing permissions and limitations under the License.
 
 require_relative 'resource'
+require 'net/http/post/multipart'
 
 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
+        READ_TIMEOUT = 300 # in seconds (5 minutes)
+        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 was saved successfully
+        def download(file_path, timeout = READ_TIMEOUT)
+          ensure_client && ensure_uri
+          uri = URI.parse(URI.escape("#{client.url}#{BASE_URI}/download/#{@data['uri'].split('/').last}"))
+          req = Net::HTTP::Get.new(uri.request_uri)
+
+          options = {}
+          options['Content-Type'] = 'application/json'
+          options['X-Api-Version'] = @client.api_version.to_s
+          options['auth'] = @client.token
+          options.each do |key, val|
+            req[key] = val
+          end
+
+          http_request = Net::HTTP.new(uri.host, uri.port)
+          http_request.use_ssl = true
+          http_request.verify_mode = OpenSSL::SSL::VERIFY_NONE
+          http_request.read_timeout = timeout
+
+          http_request.start do |http|
+            http.request(req) do |res|
+              client.response_handler(res) unless res.code.to_i.between?(200, 204)
+              File.open(file_path, 'wb') do |file|
+                res.read_body do |segment|
+                  file.write(segment)
+                end
+              end
+            end
+          end
+          true
+        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 = READ_TIMEOUT)
+          data_options = Hash[data_options.map { |k, v| [k.to_s, v] }] # Convert symbols hash keys to string
+          raise NotFound, "ERROR: File '#{file_path}' not found!" unless File.file?(file_path)
+          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']
+          options = {}
+          options['Content-Type'] = 'multipart/form-data'
+          options['X-Api-Version'] = client.api_version.to_s
+          options['auth'] = client.token
+          options['file'] = File.basename(file_path)
+          url = URI.parse(URI.escape("#{client.url}#{BASE_URI}"))
+
+          File.open(file_path) do |file|
+            req = Net::HTTP::Post::Multipart.new(
+              url.path,
+              { 'file' => UploadIO.new(file, 'application/octet-stream', File.basename(file_path)) }.merge(data_options),
+              options
+            )
+
+            http_request = Net::HTTP.new(url.host, url.port)
+            http_request.use_ssl = true if url.scheme == 'https'
+            if client.ssl_enabled
+              http_request.cert_store = client.cert_store if client.cert_store
+            else http_request.verify_mode = OpenSSL::SSL::VERIFY_NONE
+            end
+            http_request.read_timeout = timeout
+
+            http_request.start do |http|
+              response = http.request(req)
+              data = client.response_handler(response)
+              return OneviewSDK::ImageStreamer::API300::GoldenImage.new(client, data)
+            end
+          end
+        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

data/lib/oneview-sdk/resource.rb

@@ -31,7 +31,8 @@ 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) || client.is_a?(OneviewSDK::ImageStreamer::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
@@ -364,9 +365,8 @@ module OneviewSDK
   # @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
+    raise UnsupportedVersion, "API version #{api_ver} is not supported! Try one of: #{SUPPORTED_API_VERSIONS}"\
+      unless SUPPORTED_API_VERSIONS.include?(api_ver)
     api_module = OneviewSDK.const_get("API#{api_ver}")
     variant ? api_module.resource_named(type, variant) : api_module.resource_named(type)
   end

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

@@ -21,7 +21,7 @@ module OneviewSDK
       new_type = type.to_s.downcase.gsub(/[ -_]/, '')
       constants.each do |c|
         klass = const_get(c)
-        next unless klass.is_a?(Class) && klass < OneviewSDK::Resource
+        next unless klass.is_a?(Class)
         name = klass.name.split('::').last.downcase.delete('_').delete('-')
         return klass if new_type =~ /^#{name}[s]?$/
       end

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

@@ -22,7 +22,7 @@ module OneviewSDK
       # @param [OneviewSDK::Client] client The client object for the OneView appliance
       # @param [String] file_path
       # @param [Integer] timeout The number of seconds to wait for completing the request
-      # @return [OneviewSDK::FirmwareDriver] if the upload was sucessful, return a FirmwareDriver object
+      # @return [OneviewSDK::FirmwareDriver] if the upload was successful, return a FirmwareDriver object
       def self.add(client, file_path, timeout = READ_TIMEOUT)
         raise NotFound, "ERROR: File '#{file_path}' not found!" unless File.file?(file_path)
         options = {}
@@ -45,9 +45,16 @@ module OneviewSDK
           http_request.read_timeout = timeout
 
           http_request.start do |http|
-            response = http.request(req)
-            data = client.response_handler(response)
-            return OneviewSDK::FirmwareDriver.new(client, data)
+            begin
+              response = http.request(req)
+              data = client.response_handler(response)
+              return OneviewSDK::FirmwareDriver.new(client, data)
+            rescue Net::ReadTimeout
+              raise "The connection was closed because the timeout of #{timeout} seconds has expired."\
+                'You can specify the timeout in seconds by passing the timeout on the method call.'\
+                'Interrupted firmware uploads may result in corrupted firmware remaining in the appliance.'\
+                'HPE recommends checking the appliance for corrupted firmware and removing it.'
+            end
           end
         end
       end

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

@@ -60,7 +60,7 @@ module OneviewSDK
           type: 'ExtraUnmanagedStorageVolumes',
           resourceUri: resource['uri']
         }
-        response = client.rest_post(BASE_URI + '/repair', 'body' => requestBody)
+        response = client.rest_post(BASE_URI + '/repair', { 'Accept-Language' => 'en_US', 'body' => requestBody }, client.api_version)
         client.response_handler(response)
       end
 

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

@@ -27,7 +27,7 @@ module OneviewSDK
       api_module = OneviewSDK::API300.const_get(variant)
       api_module.constants.each do |c|
         klass = api_module.const_get(c)
-        next unless klass.is_a?(Class) && klass < OneviewSDK::Resource
+        next unless klass.is_a?(Class)
         name = klass.name.split('::').last.downcase.delete('_').delete('-')
         return klass if new_type =~ /^#{name}[s]?$/
       end

data/lib/oneview-sdk/resource/api300/c7000/switch.rb

@@ -10,20 +10,20 @@
 # language governing permissions and limitations under the License.
 
 require_relative '../../api200/switch'
+require_relative 'scope'
 
 module OneviewSDK
   module API300
     module C7000
       # Switch resource implementation
       class Switch < OneviewSDK::API200::Switch
+        include OneviewSDK::API300::C7000::Scope::ScopeHelperMethods
 
         # Updates the scope URIs of a specific switch
         # @param [Array] scope_uris Array of scope uri strings
+        # @deprecated Use {#add_scope}, {#remove_scope}, and {#replace_scopes} instead.
         def set_scope_uris(scope_uris)
-          ensure_client && ensure_uri
-          body = { op: 'replace', path: '/scopeUris', value: scope_uris }
-          response = @client.rest_patch(@data['uri'], { 'body' => [body] }, @api_version)
-          @client.response_handler(response)
+          patch('replace', '/scopeUris', scope_uris)
         end
       end
     end

data/lib/oneview-sdk/rest.rb

@@ -13,10 +13,13 @@ require 'uri'
 require 'net/http'
 require 'openssl'
 require 'json'
+require 'net/http/post/multipart'
 
 module OneviewSDK
   # Contains all of the methods for making API REST calls
   module Rest
+    READ_TIMEOUT = 300 # in seconds, 5 minutes
+
     # Makes a restful API request to OneView
     # @param [Symbol] type The rest method/type Options: [:get, :post, :delete, :patch, :put]
     # @param [String] path The path for the request. Usually starts with "/rest/"
@@ -32,17 +35,8 @@ module OneviewSDK
     def rest_api(type, path, options = {}, api_ver = @api_version, redirect_limit = 3)
       @logger.debug "Making :#{type} rest call to #{@url}#{path}"
       raise InvalidRequest, 'Must specify path' unless path
-
       uri = URI.parse(URI.escape(@url + path))
-      http = Net::HTTP.new(uri.host, uri.port)
-      http.use_ssl = true if uri.scheme == 'https'
-      if @ssl_enabled
-        http.cert_store = @cert_store if @cert_store
-      else http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-      end
-      http.read_timeout = @timeout if @timeout # Timeout for a request
-      http.open_timeout = @timeout if @timeout # Timeout for a connection
-
+      http = build_http_object(uri)
       request = build_request(type, uri, options.dup, api_ver)
       response = http.request(request)
       @logger.debug "  Response: Code=#{response.code}. Headers=#{response.to_hash}\n  Body=#{response.body}"
@@ -121,6 +115,64 @@ module OneviewSDK
       rest_api(:delete, path, options, api_ver)
     end
 
+    # Uploads a file to a specific uri
+    # @param [String] file_path
+    # @param [String] path The url path starting with "/"
+    # @param [Hash] body_params The params to append to body of http request. Default is {}.
+    # @option body_params [String] 'name' The name to show (when resource accepts a name)
+    # @param [Integer] timeout The number of seconds to wait for completing the request. Default is 300.
+    # @return [Hash] The parsed JSON body of response
+    def upload_file(file_path, path, body_params = {}, timeout = READ_TIMEOUT)
+      raise NotFound, "ERROR: File '#{file_path}' not found!" unless File.file?(file_path)
+      options = {
+        'Content-Type' => 'multipart/form-data',
+        'X-Api-Version' => @api_version.to_s,
+        'auth' => @token
+      }
+
+      File.open(file_path) do |file|
+        name_to_show = body_params.delete('name') || body_params.delete(:name) || File.basename(file_path)
+        body_params['file'] = UploadIO.new(file, 'application/octet-stream', name_to_show)
+
+        uri = URI.parse(URI.escape(@url + path))
+        http_request = build_http_object(uri)
+        http_request.read_timeout = timeout
+
+        req = Net::HTTP::Post::Multipart.new(
+          uri.path,
+          body_params,
+          options
+        )
+
+        http_request.start do |http|
+          response = http.request(req)
+          return response_handler(response)
+        end
+      end
+    end
+
+    # Download a file from a specific uri
+    # @param [String] path The url path starting with "/"
+    # @param [String] local_drive_path Path to save file downloaded
+    # @return [Boolean] if file was downloaded
+    def download_file(path, local_drive_path)
+      uri = URI.parse(URI.escape(@url + path))
+      http_request = build_http_object(uri)
+      req = build_request(:get, uri, {}, @api_version.to_s)
+
+      http_request.start do |http|
+        http.request(req) do |res|
+          response_handler(res) unless res.code.to_i.between?(200, 204)
+          File.open(local_drive_path, 'wb') do |file|
+            res.read_body do |segment|
+              file.write(segment)
+            end
+          end
+        end
+      end
+      true
+    end
+
     RESPONSE_CODE_OK           = 200
     RESPONSE_CODE_CREATED      = 201
     RESPONSE_CODE_ACCEPTED     = 202
@@ -133,8 +185,7 @@ module OneviewSDK
     #   If an asynchronous task was started, this waits for it to complete.
     # @param [HTTPResponse] response HTTP response
     # @param [Boolean] wait_on_task Wait on task (or just return task details)
-    # @raise [StandardError] if the request failed
-    # @raise [StandardError] if a task was returned that did not complete successfully
+    # @raise [OneviewSDK::OneViewError] if the request failed or a task did not complete successfully
     # @return [Hash] The parsed JSON body
     def response_handler(response, wait_on_task = true)
       case response.code.to_i
@@ -158,19 +209,32 @@ module OneviewSDK
       when RESPONSE_CODE_NO_CONTENT # Synchronous delete
         return {}
       when RESPONSE_CODE_BAD_REQUEST
-        raise BadRequest, "400 BAD REQUEST #{response.body}"
+        BadRequest.raise! "400 BAD REQUEST #{response.body}", response
       when RESPONSE_CODE_UNAUTHORIZED
-        raise Unauthorized, "401 UNAUTHORIZED #{response.body}"
+        Unauthorized.raise! "401 UNAUTHORIZED #{response.body}", response
       when RESPONSE_CODE_NOT_FOUND
-        raise NotFound, "404 NOT FOUND #{response.body}"
+        NotFound.raise! "404 NOT FOUND #{response.body}", response
       else
-        raise RequestError, "#{response.code} #{response.body}"
+        RequestError.raise! "#{response.code} #{response.body}", response
       end
     end
 
 
     private
 
+    # Builds a http object using the data given
+    def build_http_object(uri)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true if uri.scheme == 'https'
+      if @ssl_enabled
+        http.cert_store = @cert_store if @cert_store
+      else http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+      http.read_timeout = @timeout if @timeout # Timeout for a request
+      http.open_timeout = @timeout if @timeout # Timeout for a connection
+      http
+    end
+
     # Builds a request object using the data given
     def build_request(type, uri, options, api_ver)
       case type.downcase.to_sym

data/lib/oneview-sdk/version.rb

@@ -11,5 +11,5 @@
 
 # Gem version defined here
 module OneviewSDK
-  VERSION = '4.0.0'.freeze
+  VERSION = '4.1.0'.freeze
 end

data/oneview-sdk.gemspec

@@ -34,11 +34,11 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'pry'
   spec.add_runtime_dependency 'multipart-post'
 
+  spec.add_development_dependency 'coveralls'
   spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'byebug'
   spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rubocop', '= 0.42.0'
-  spec.add_development_dependency 'byebug'
-
+  spec.add_development_dependency 'simplecov'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oneview-sdk
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.1.0
 platform: ruby
 authors:
 - Henrique Diomede
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-10 00:00:00.000000000 Z
+date: 2017-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -69,6 +69,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -84,7 +98,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -112,7 +126,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -140,7 +154,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.42.0
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -176,8 +190,9 @@ files:
 - lib/oneview-sdk/config_loader.rb
 - lib/oneview-sdk/exceptions.rb
 - lib/oneview-sdk/image-streamer/client.rb
-- lib/oneview-sdk/image-streamer/resource/api300/artifacts_bundle.rb
+- lib/oneview-sdk/image-streamer/resource/api300/artifact_bundle.rb
 - lib/oneview-sdk/image-streamer/resource/api300/build_plan.rb
+- lib/oneview-sdk/image-streamer/resource/api300/deployment_group.rb
 - lib/oneview-sdk/image-streamer/resource/api300/deployment_plan.rb
 - lib/oneview-sdk/image-streamer/resource/api300/golden_image.rb
 - lib/oneview-sdk/image-streamer/resource/api300/os_volume.rb