test-oneview 5.18.0

data/Dockerfile

@@ -0,0 +1,21 @@
+FROM ubuntu:18.04
+MAINTAINER "Chebrolu Harika <bala-sai-harika.chebrolu@hpe.com>"
+WORKDIR /root
+RUN apt-get update -y && \
+    apt-get install -y --no-install-recommends --no-upgrade && \
+    apt-get install -y curl vim wget openssl bash ca-certificates git && \
+    apt-get install -y ruby-dev && \
+    apt-get install -y gcc make
+RUN gem install oneview
+ADD . oneview/
+WORKDIR  /root/oneview
+RUN gem install bundler
+RUN bundle update
+
+# Clean and remove not required packages
+RUN DEBIAN_FRONTEND=noninteractive \
+    apt-get autoremove -y && \
+    apt-get clean -y && \
+    rm -rf /var/cache/apt/archives/* /var/cache/apt/lists/* /tmp/* /root/cache/.
+
+CMD ["/bin/bash"]

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+ruby RUBY_VERSION
+gemspec
+
+begin
+  if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.3.1')
+    group :development do
+      gem 'guard-rspec'
+      gem 'guard-rubocop'
+    end
+  end
+rescue StandardError
+  "no big deal; just don't use guard"
+end

data/Guardfile

@@ -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.
+
+guard :rubocop, cmd: 'bundle exec rubocop', cli: ['-D'] do
+  watch('.rubocop.yml')
+  watch(/(.+\.rb)$/)
+  watch(/^(Gemfile|Rakefile)$/)
+end
+
+guard :rspec, cmd: 'bundle exec rspec --color -t ~integration', first_match: true do
+  watch(%r{^spec\/(\w+)\.rb$}) { 'spec/unit' }
+  watch(%r{^(spec\/unit\/.+_spec\.rb)$})
+  watch('lib/oneview-sdk/cli.rb') { 'spec/unit/cli' }
+  watch(%r{^lib\/oneview-sdk\/(.+)\.rb$}) { |m| "spec/unit/#{m[1]}_spec.rb" }
+  watch(%r{^(spec\/support\/\w+\.rb)$}) { 'spec/unit' }
+  watch(%r{^spec\/support\/fixtures\/unit\/(\w+)\/.+$}) { |m| "spec/unit/#{m[1]}" }
+  watch(%r{^lib\/(.+)\.rb$}) { 'spec/unit' } # Everything else
+end

data/LICENSE

@@ -0,0 +1,201 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction,
+and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by
+the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all
+other entities that control, are controlled by, or are under common
+control with that entity. For the purposes of this definition,
+"control" means (i) the power, direct or indirect, to cause the
+direction or management of such entity, whether by contract or
+otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity
+exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications,
+including but not limited to software source code, documentation
+source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical
+transformation or translation of a Source form, including but
+not limited to compiled object code, generated documentation,
+and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or
+Object form, made available under the License, as indicated by a
+copyright notice that is included in or attached to the work
+(an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object
+form, that is based on (or derived from) the Work and for which the
+editorial revisions, annotations, elaborations, or other modifications
+represent, as a whole, an original work of authorship. For the purposes
+of this License, Derivative Works shall not include works that remain
+separable from, or merely link (or bind by name) to the interfaces of,
+the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including
+the original version of the Work and any modifications or additions
+to that Work or Derivative Works thereof, that is intentionally
+submitted to Licensor for inclusion in the Work by the copyright owner
+or by an individual or Legal Entity authorized to submit on behalf of
+the copyright owner. For the purposes of this definition, "submitted"
+means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems,
+and issue tracking systems that are managed by, or on behalf of, the
+Licensor for the purpose of discussing and improving the Work, but
+excluding communication that is conspicuously marked or otherwise
+designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity
+on behalf of whom a Contribution has been received by Licensor and
+subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the
+Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+(except as stated in this section) patent license to make, have made,
+use, offer to sell, sell, import, and otherwise transfer the Work,
+where such license applies only to those patent claims licensable
+by such Contributor that are necessarily infringed by their
+Contribution(s) alone or by combination of their Contribution(s)
+with the Work to which such Contribution(s) was submitted. If You
+institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work
+or a Contribution incorporated within the Work constitutes direct
+or contributory patent infringement, then any patent licenses
+granted to You under this License for that Work shall terminate
+as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+Work or Derivative Works thereof in any medium, with or without
+modifications, and in Source or Object form, provided that You
+meet the following conditions:
+
+(a) You must give any other recipients of the Work or
+Derivative Works a copy of this License; and
+
+(b) You must cause any modified files to carry prominent notices
+stating that You changed the files; and
+
+(c) You must retain, in the Source form of any Derivative Works
+that You distribute, all copyright, patent, trademark, and
+attribution notices from the Source form of the Work,
+excluding those notices that do not pertain to any part of
+the Derivative Works; and
+
+(d) If the Work includes a "NOTICE" text file as part of its
+distribution, then any Derivative Works that You distribute must
+include a readable copy of the attribution notices contained
+within such NOTICE file, excluding those notices that do not
+pertain to any part of the Derivative Works, in at least one
+of the following places: within a NOTICE text file distributed
+as part of the Derivative Works; within the Source form or
+documentation, if provided along with the Derivative Works; or,
+within a display generated by the Derivative Works, if and
+wherever such third-party notices normally appear. The contents
+of the NOTICE file are for informational purposes only and
+do not modify the License. You may add Your own attribution
+notices within Derivative Works that You distribute, alongside
+or as an addendum to the NOTICE text from the Work, provided
+that such additional attribution notices cannot be construed
+as modifying the License.
+
+You may add Your own copyright statement to Your modifications and
+may provide additional or different license terms and conditions
+for use, reproduction, or distribution of Your modifications, or
+for any such Derivative Works as a whole, provided Your use,
+reproduction, and distribution of the Work otherwise complies with
+the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+any Contribution intentionally submitted for inclusion in the Work
+by You to the Licensor shall be under the terms and conditions of
+this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify
+the terms of any separate license agreement you may have executed
+with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+names, trademarks, service marks, or product names of the Licensor,
+except as required for reasonable and customary use in describing the
+origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+agreed to in writing, Licensor provides the Work (and each
+Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied, including, without limitation, any warranties or conditions
+of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+PARTICULAR PURPOSE. You are solely responsible for determining the
+appropriateness of using or redistributing the Work and assume any
+risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+whether in tort (including negligence), contract, or otherwise,
+unless required by applicable law (such as deliberate and grossly
+negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special,
+incidental, or consequential damages of any character arising as a
+result of this License or out of the use or inability to use the
+Work (including but not limited to damages for loss of goodwill,
+work stoppage, computer failure or malfunction, or any and all
+other commercial damages or losses), even if such Contributor
+has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+the Work or Derivative Works thereof, You may choose to offer,
+and charge a fee for, acceptance of support, warranty, indemnity,
+or other liability obligations and/or rights consistent with this
+License. However, in accepting such obligations, You may act only
+on Your own behalf and on Your sole responsibility, not on behalf
+of any other Contributor, and only if You agree to indemnify,
+defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason
+of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+To apply the Apache License to your work, attach the following
+boilerplate notice, with the fields enclosed by brackets "{}"
+replaced with your own identifying information. (Don't include
+the brackets!)  The text should be enclosed in the appropriate
+comment syntax for the file format. We also recommend that a
+file or class name and description of purpose be included on the
+same "printed page" as the copyright notice for easier
+identification within third-party archives.
+
+Copyright 2015-2016 Hewlett Packard Enterprise
+
+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.

data/README.md

@@ -0,0 +1,516 @@
+# 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.
+
+## Installation
+You can either use a docker container which will have the oneview-sdk-ruby installed or perform local installation.
+###  Docker Setup
+We also provide a lightweight and easy way to test and execute `oneview-sdk-ruby`. The `hpe-oneview-sdk-for-ruby:<tag>` docker image contains
+an installation of oneview-sdk-ruby and you can use it by just pulling down the Docker Image:
+The Docker Store image tag consist of two sections: <sdk_version-OV_version>
+
+```bash
+# Download and store a local copy of oneview-sdk-ruby and
+# use it as a Docker image.
+$ docker pull hewlettpackardenterprise/hpe-oneview-sdk-for-ruby:v5.16.0-OV5.4
+# Run docker commands below given, which  will in turn create
+# a sh session where you can create files, issue commands and execute the examples.
+$ docker run -it hewlettpackardenterprise/hpe-oneview-sdk-for-ruby:v5.16.0-OV5.4 /bin/sh
+```
+
+### Local Setup
+- Require the gem in your Gemfile:
+
+  ```ruby
+  gem 'oneview-sdk', '~> 5.4'
+  ```
+
+  Then run `$ bundle install`
+- Or run the command:
+
+  ```bash
+  $ gem install oneview-sdk
+  ```
+
+
+## Configuration
+The OneView client has a few configuration options, which you can pass in during creation:
+
+```ruby
+# Create a OneView client object:
+require 'oneview-sdk'
+client = OneviewSDK::Client.new(
+  url: 'https://oneview.example.com',
+  user: 'Administrator',              # This is the default
+  password: 'secret123',
+  token: 'xxxx...',                   # Set EITHER this or the user & password
+  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: 2000                   # Defaults to appliance's max API version
+)
+```
+
+:lock: Tip: Check the file permissions because the password is stored in clear-text.
+
+The Image Streamer (I3S) client is very similar to the OneView client, but has one key difference:
+it cannot generate it's own token. However, it uses the same token given to or generated by the OneView client,
+so if you need to generate a token, create a OneView client using a user & password, then pass the generated token
+into the Image Streamer client.
+
+```ruby
+# Create an Image Streamer client object:
+require 'oneview-sdk'
+i3s_client = OneviewSDK::ImageStreamer::Client.new(
+  url: 'https://image-streamer.example.com',
+  token: 'xxxx...',                   # Required. Note that you cannot pass the user & password options
+  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
+)
+```
+
+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:
+
+```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'
+export ONEVIEWSDK_PASSWORD='secret123'
+export ONEVIEWSDK_SSL_ENABLED=false
+# NOTE: Disabling SSL is strongly discouraged. Please see the CLI section for import instructions.
+
+# Image Streamer (I3S) client options:
+export I3S_URL='https://image-streamer.example.com'
+export I3S_SSL_ENABLED=false
+# NOTE: Disabling SSL is strongly discouraged. Please see the CLI section for import instructions.
+```
+
+:lock: Tip: Be sure nobody has access to your environment variables, as the password or token is stored in clear-text.
+
+Then you can leave out these options from your config, enabling you to just do:
+
+```ruby
+require 'oneview-sdk'
+client = OneviewSDK::Client.new
+```
+
+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
+```
+
+NOTE: Run `$ oneview-sdk-ruby env` to see a list of available environment variables and their current values.
+
+##### Configuration Files
+
+Configuration files can also be used to define client configuration (json or yaml formats). Here's an example json file:
+
+```json
+{
+  "url": "https://oneview.example.com",
+  "user": "Administrator",
+  "password": "secret123",
+  "api_version": 2000
+}
+```
+
+and load via:
+
+```ruby
+config = OneviewSDK::Config.load("full_file_path.json")
+client = OneviewSDK::Client.new(config)
+```
+
+:lock: Tip: Check the file permissions if the password or token is stored in clear-text.
+
+### Custom logging
+The default logger is a standard logger to STDOUT, but if you want to specify your own, you can.  However, your logger must implement the following methods:
+
+```ruby
+debug(String)
+info(String)
+warn(String)
+error(String)
+level=(Symbol, etc.) # The parameter here will be the log_level attribute
+```
+
+:lock: Tip: When the log_level is set to debug, API request options will be logged (including auth tokens and passwords); be careful to protect secret information.
+
+
+## API Implementation
+
+A status of the HPE OneView REST interfaces that have been implemented in this SDK can be found in the [endpoints-support.md](https://github.com/HewlettPackard/oneview-sdk-ruby/blob/master/endpoints-support.md) file.
+
+### OneView API versions and appliance types
+You may notice resource classes being accessed in a few different ways; for example, `OneviewSDK::EthernetNetwork`, `OneviewSDK::API300::EthernetNetwork`, and `OneviewSDK::API300::C7000::EthernetNetwork`. However, each of these accessors may actually be referring to the same class. This is because in order to keep backwards compatibility and make examples a little more simple, there are module methods in place to redirect/resolve the shorthand accessors to their full namespace identifier. In order to automatically complete the full namespace identifier, there are some defaults in place. Here's some example code that should help clear things up (return values are commented behind the code):
+
+```ruby
+require 'oneview-sdk'
+
+# Show defaults:
+OneviewSDK::SUPPORTED_API_VERSIONS      # [200, 300, 500, 600, 800, 1000, 1200, 1600, 1800, 2000]
+OneviewSDK::DEFAULT_API_VERSION         # 2000
+OneviewSDK.api_version                  # 2000
+OneviewSDK.api_version_updated?         # false
+
+# Notice the automatic redirection/resolution when we use the shorthand accessor:
+OneviewSDK::EthernetNetwork             # OneviewSDK::API200::EthernetNetwork
+
+# Even this comparison is true:
+OneviewSDK::EthernetNetwork == OneviewSDK::API200::EthernetNetwork  # true
+
+# Now let's set a new API version default:
+OneviewSDK.api_version = 300
+OneviewSDK.api_version                  # 300
+OneviewSDK.api_version_updated?         # true
+
+# The API200 module has no variants, but API300 and above has 2 (C7000 & Synergy):
+OneviewSDK::API300::SUPPORTED_VARIANTS  # ['C7000', 'Synergy']
+OneviewSDK::API300::DEFAULT_VARIANT     # 'C7000'
+OneviewSDK::API300.variant              # 'C7000'
+OneviewSDK::API300.variant_updated?     # false
+
+OneviewSDK::API500::SUPPORTED_VARIANTS  # ['C7000', 'Synergy']
+OneviewSDK::API500::DEFAULT_VARIANT     # 'C7000'
+OneviewSDK::API500.variant              # 'C7000'
+OneviewSDK::API500.variant_updated?     # false
+
+OneviewSDK::API600::SUPPORTED_VARIANTS  # ['C7000', 'Synergy']
+OneviewSDK::API600::DEFAULT_VARIANT     # 'C7000'
+OneviewSDK::API600.variant              # 'C7000'
+OneviewSDK::API600.variant_updated?     # false
+
+OneviewSDK::API800::SUPPORTED_VARIANTS  # ['C7000', 'Synergy']
+OneviewSDK::API800::DEFAULT_VARIANT     # 'C7000'
+OneviewSDK::API800.variant              # 'C7000'
+OneviewSDK::API800.variant_updated?     # false
+
+OneviewSDK::API1000::SUPPORTED_VARIANTS  # ['C7000', 'Synergy']
+OneviewSDK::API1000::DEFAULT_VARIANT     # 'C7000'
+OneviewSDK::API1000.variant              # 'C7000'
+OneviewSDK::API1000.variant_updated?     # false
+
+OneviewSDK::API1200::SUPPORTED_VARIANTS  # ['C7000', 'Synergy']
+OneviewSDK::API1200::DEFAULT_VARIANT     # 'C7000'
+OneviewSDK::API1200.variant              # 'C7000'
+OneviewSDK::API1200.variant_updated?     # false
+# Therefore, there is 1 more namespace level to the real resource class name
+OneviewSDK::EthernetNetwork             # OneviewSDK::API300::C7000::EthernetNetwork
+OneviewSDK::API300::EthernetNetwork     # OneviewSDK::API300::C7000::EthernetNetwork
+
+# Likewise, we can set a new default variant for the API300 module:
+OneviewSDK::API300.variant = 'Synergy'
+OneviewSDK::API300.variant              # 'Synergy'
+OneviewSDK::API300.variant_updated?     # true
+OneviewSDK::EthernetNetwork             # OneviewSDK::API300::Synergy::EthernetNetwork
+OneviewSDK::API300::EthernetNetwork     # OneviewSDK::API300::Synergy::EthernetNetwork
+
+OneviewSDK::API1600::SUPPORTED_VARIANTS  # ['C7000', 'Synergy']
+OneviewSDK::API1600::DEFAULT_VARIANT     # 'C7000'
+OneviewSDK::API1600.variant              # 'C7000'
+OneviewSDK::API1600.variant_updated?     # false
+
+OneviewSDK::API1800::SUPPORTED_VARIANTS  # ['C7000', 'Synergy']
+OneviewSDK::API1800::DEFAULT_VARIANT     # 'C7000'
+OneviewSDK::API1800.variant              # 'C7000'
+OneviewSDK::API1800.variant_updated?     # false
+
+OneviewSDK::API2000::SUPPORTED_VARIANTS  # ['C7000', 'Synergy']
+OneviewSDK::API2000::DEFAULT_VARIANT     # 'C7000'
+OneviewSDK::API2000.variant              # 'C7000'
+OneviewSDK::API2000.variant_updated?     # false
+
+# Likewise, we can set a new default variant for the API2000 module:
+OneviewSDK::API2000.variant = 'Synergy'
+OneviewSDK::API2000.variant              # 'Synergy'
+OneviewSDK::API2000.variant_updated?     # true
+# Therefore, there is 1 more namespace level to the real resource class name
+OneviewSDK::EthernetNetwork             # OneviewSDK::API300::C7000::EthernetNetwork
+OneviewSDK::API2000::EthernetNetwork     # OneviewSDK::API2000::C7000::EthernetNetwork
+```
+
+We understand that this can be confusing, so to avoid any confusion or unexpected behavior, we recommend specifying the full namespace identifier in your code. At the very least, set defaults explicitly using `OneviewSDK.api_version = <ver>` and `OneviewSDK::API300.variant = <variant>`, as the defaults may change.
+
+## Resources
+Each OneView and Image Streamer resource is exposed via a Ruby class, enabling CRUD-like functionality (with some exceptions).
+
+Once you instantiate a resource object, you can call intuitive methods such as `resource.create`, `resource.update` and `resource.delete`. In addition, resources respond to helpful methods such as `.each`, `.eql?(other_resource)`, `.like(other_resource)`, `.retrieve!`, and many others.
+
+Please see the [rubydoc.info](http://www.rubydoc.info/gems/oneview-sdk) documentation for complete usage details and the [examples](examples/) directory for more examples and test-scripts, but here are a few examples to get you started:
+
+##### Create a resource
+
+```ruby
+ethernet = OneviewSDK::EthernetNetwork.new(
+  client, { name: 'TestVlan', vlanId:  1001, purpose:  'General', smartLink: false, privateNetwork: false }
+)
+ethernet.create # Tells OneView to create this resource
+```
+
+##### Access resource attributes
+
+```ruby
+ethernet['name'] # Returns 'TestVlan'
+
+ethernet.data # Returns hash of all data
+
+ethernet.each do |key, value|
+  puts "Attribute #{key} = #{value}"
+end
+```
+
+The resource's data is stored in its @data attribute.  However, you can access the data directly using a hash-like syntax on the resource object (recommended). `resource['key']` functions a lot like `resource.data['key']`. The difference is that when using the data attribute, you must be cautious to use the correct key type (Hash vs Symbol).
+The direct hash accessor on the resource converts first-level keys to strings; so `resource[:key]` and `resource['key']` access the same thing: `resource.data['key']`. We recommend using strings exclusively for keys, as the JSON data returned from OneView requests supports strings but not symbols.
+
+##### Update a resource
+
+Notice that there are a few different ways to do things, so pick your poison!
+```ruby
+ethernet.set_all(name: 'newName', vlanId:  1002)
+ethernet['purpose'] = 'General'
+ethernet['ethernetNetworkType'] = 'Tagged'
+ethernet.update # Saves current state to OneView
+
+# Alternatively, you could do this in 1 step with:
+ethernet.update(name: 'newName', vlanId:  1002, purpose: 'General', ethernetNetworkType: 'Tagged')
+```
+
+##### Check resource equality
+
+You can use the `==`  or `.eql?` method to compare resource equality, or `.like` to compare just a subset of attributes.
+```ruby
+ethernet2 = OneviewSDK::EthernetNetwork.new(client, { purpose:  'General' })
+ethernet == ethernet2    # Returns false
+ethernet.eql?(ethernet2) # Returns false
+
+
+# To compare a subset of attributes:
+ethernet.like?(ethernet2)  # Returns true
+ethernet.like?(name: 'TestVlan', purpose: 'General')  # Returns true
+```
+
+
+##### Find resources
+
+```ruby
+ethernet = OneviewSDK::EthernetNetwork.new(client, { name: 'OtherVlan' })
+ethernet.retrieve! # Uses the name attribute to search for the resource on the server and update the data in this object.
+
+
+# Each resource class also has a searching method (NOTE: class method, not instance method)
+ethernet = OneviewSDK::EthernetNetwork.find_by(client, { name: 'OtherVlan' }).first
+
+OneviewSDK::EthernetNetwork.find_by(client, { purpose: 'General' }).each do |network|
+  puts "  #{network['name']}"
+end
+
+# Get all resources:
+networks = client.get_all(:EthernetNetwork)
+```
+
+##### Delete a resource
+
+```ruby
+ethernet = OneviewSDK::EthernetNetwork.find_by(client, { name: 'OtherVlan' }).first
+ethernet.delete # Tells OneView to delete this resource
+```
+
+### Save/Load resources with files
+Resources can be saved to files and loaded again very easily using the built-in `.to_file` & `.from_file` methods.
+
+ - To save a Resource to a file:
+
+   ```ruby
+   ethernet.to_file("full_file_path.json")
+   ```
+ - To load a resource from a file: (note the class method, not instance method)
+
+   ```ruby
+   ethernet4 = OneviewSDK::Resource.from_file(client, "full_file_path.json")
+   ```
+
+
+For more examples and test-scripts, see the [examples](examples/) directory and [rubydoc.info](http://www.rubydoc.info/gems/oneview-sdk) documentation.
+
+## Custom requests
+In most cases, interacting with Resource objects is enough, but sometimes you need to make your own custom requests to OneView.
+This project makes it extremely easy to do with some built-in methods for the Client object. Here are some examples:
+
+```ruby
+# Get the appliance startup progress:
+response = client.rest_api(:get, '/rest/appliance/progress')
+# or even more simple:
+response = client.rest_get('/rest/appliance/progress')
+
+# Then we can validate the response and convert the response body into a hash...
+data = client.response_handler(response)
+```
+
+This example is about as basic as it gets, but you can make any type of OneView request.
+If a resource does not do what you need, this will allow you to do it.
+Please refer to the documentation and [code](lib/oneview-sdk/rest.rb) for complete list of methods and information about how to use them.
+
+
+## CLI
+This gem also comes with a command-line interface to make interacting with OneView possible without the need to create a Ruby program or script.
+
+Note: In order to use this, you will need to make sure your Ruby `bin` directory is in your path.
+Run `$ gem environment` to see where the executable paths are for your Ruby installation.
+
+To get started, run `$ oneview-sdk-ruby --help`.
+
+To communicate with an appliance, you will need to set up a few environment variables so it knows how to communicate. Run `$ oneview-sdk-ruby env` to see the available environment variables.
+
+The CLI does not expose everything in the SDK, but it is great for doing simple tasks such as creating or deleting resources from files, listing resources, and searching. Here are a few examples:
+
+##### List ServerProfiles:
+
+```bash
+# Output a list of ServerProfile names:
+$ oneview-sdk-ruby list ServerProfiles
+# Or to show in yaml format (json is also supported):
+$ oneview-sdk-ruby list ServerProfiles -f yaml
+# Or to show specific attributes only:
+$ oneview-sdk-ruby list ServerProfiles -a uri,state,bios.overriddenSettings
+```
+
+##### Show details for a specific resource:
+
+```bash
+$ oneview-sdk-ruby show ServerProfile profile-1
+# Or to show specific attributes only:
+$ oneview-sdk-ruby show ServerProfile profile-1 -a name,uri,enclosureBay
+```
+
+##### Search by an attribute:
+
+```bash
+$ oneview-sdk-ruby search ServerProfiles --filter state:Normal affinity:Bay
+# By default, it will just show a list of names of matching resources,
+#   but again, you can show only certain attributes by using the -a option
+# You can also chain keys together to search in nested hashes:
+$ oneview-sdk-ruby search ServerProfiles --filter state:Normal boot.manageBoot:true
+# Or to show specific attributes only:
+$ oneview-sdk-ruby search ServerProfile --filter state:Normal -a name,uri,enclosureBay
+```
+
+##### Create or delete resource by file:
+
+```bash
+# Save resource details to a file (to be used with the create and delete methods below)
+$ oneview-sdk-ruby to_file ServerProfile profile-1 /my-server-profile.json
+
+$ oneview-sdk-ruby create_from_file /my-server-profile.json
+$ oneview-sdk-ruby delete_from_file /my-server-profile.json
+```
+
+##### Update resources by name:
+
+```bash
+$ oneview-sdk-ruby update FCNetwork FC1 -h linkStabilityTime:20  # Using hash format
+$ oneview-sdk-ruby update Volume VOL_01 -j '{"shareable": true}' # Using json format
+```
+
+##### Make REST calls:
+
+```bash
+$ oneview-sdk-ruby rest get rest/fc-networks
+$ oneview-sdk-ruby rest PUT rest/enclosures/<id>/configuration
+```
+
+##### Start an interactive console session with a OneView connection:
+
+```bash
+$ oneview-sdk-ruby console
+Console Connected to https://oneview.example.com
+HINT: The @client object is available to you
+>
+```
+
+##### Import a self-signed SSL certificate from your OneView or Image Streamer instance:
+
+Although you can disable SSL validation altogether for the client, this is strongly discouraged.
+Instead, please import the certificate using the built-in CLI cert command:
+```bash
+# Check the certificate first:
+$ oneview-sdk-ruby cert check https://oneview.example.com
+ Checking certificate for 'https://oneview.example.com' ...
+ ERROR: Certificate Validation Failed!
+
+# Import the certificate:
+$ oneview-sdk-ruby cert import https://oneview.example.com
+ Importing certificate for 'https://oneview.example.com' into '/home/users/user1/.oneview-sdk-ruby/trusted_certs.cer'...
+ Cert added to '/home/users/user1/.oneview-sdk-ruby/trusted_certs.cer'
+```
+
+##### Subscribe to the OneView State Change Message Bus (SCMB):
+
+```bash
+$ oneview-sdk-ruby scmb
+$ oneview-sdk-ruby scmb -r 'scmb.ethernet-networks.#'
+```
+
+## License
+This project is licensed under the Apache 2.0 license. Please see [LICENSE](LICENSE) for more info.
+
+## Contributing and feature requests
+**Contributing:** You know the drill. Fork it, branch it, change it, commit it, and pull-request it.
+We are passionate about improving this project, and glad to accept help to make it better.
+
+NOTE: We reserve the right to reject changes that we feel do not fit the scope of this project, so for feature additions, please open an issue to discuss your ideas before doing the work.
+
+**Feature Requests:** If you have a need that is not met by the current implementation, please let us know (via a new issue).
+This feedback is crucial for us to deliver a useful product. Do not assume we have already thought of everything, because we assure you that is not the case.
+
+### Building the Gem
+First run `$ bundle` (requires the bundler gem), then...
+ - To build only, run `$ rake build`.
+ - To build and install the gem, run `$ rake install`.
+
+### Testing
+ - RuboCop: `$ rake rubocop`
+ - Unit: `$ rake spec`
+ - Optional: Start guard to run unit tests & rubocop automatically on file changes: `$ bundle exec guard`
+ - Integration: See the [spec/integration](spec/integration/) README
+ - All: Run `$ rake test:all` to run RuboCop, unit, & integration tests.
+ - Examples: See the [examples](examples/) README
+
+For the full testing reference please look into [TESTING.md](TESTING.md) file.
+
+## Authors
+See the [contributors graph](https://github.com/HewlettPackard/oneview-sdk-ruby/graphs/contributors)