vipruby 0.1.4 → 0.1.6.1

data/lib/vipruby/objects/vcenter.rb

@@ -0,0 +1,162 @@
+require 'rest-client'
+require 'json'
+
+# The Following vCenter calls will get vCenter information for all tenants
+module ViprVcenter
+  
+  # Retrive all vCenter Servers registered for all tenants
+  #
+  # @return [Hash] the object converted into Hash format and can be parsed with object[0] or object['id'] notation
+  def get_all_vcenters(auth=nil, cert=nil)
+    rest_get("#{@base_url}/compute/vcenters/bulk", auth.nil? ? @auth_token : auth, cert.nil? ? @verify_cert : cert)
+  end
+
+  # Retrieve information for a single vCenter server using the uid
+  #
+  # @param vcenter_id [String] Requires the string of the vcenter uid
+  # @return [Hash] the object converted into Hash format and can be parsed with object[0] or object['id'] notation
+  #
+  # @example
+  #   x = vipr.get_all_vcenters['id'][0]
+  #   vipr.get_vcenter(x)
+  def get_vcenter(vcenter_id=nil, auth=nil, cert=nil)
+    check_vcenter(vcenter_id)
+    rest_get("#{@base_url}/compute/vcenters/#{vcenter_id}", auth.nil? ? @auth_token : auth, cert.nil? ? @verify_cert : cert)
+  end
+
+  # Retrieve Host information for a single vCenter server using the uid
+  #
+  # @param vcenter_id [String] Requires the string of the vcenter uid
+  # @return [Hash] the object converted into Hash format and can be parsed with object[0] or object['id'] notation
+  #
+  # @example
+  #   x = vipr.get_all_vcenters['id'][0]
+  #   vipr.get_vcenter_hosts(x)
+  def get_vcenter_hosts(vcenter_id=nil, auth=nil, cert=nil)
+    check_vcenter(vcenter_id)
+    rest_get("#{@base_url}/compute/vcenters/#{vcenter_id}/hosts", auth.nil? ? @auth_token : auth, cert.nil? ? @verify_cert : cert)
+  end
+
+  # Retrieve Cluster information for a single vCenter server using the uid
+  #
+  # @param vcenter_id [String] Requires the string of the vcenter uid
+  # @return [Hash] the object converted into Hash format and can be parsed with object[0] or object['id'] notation
+  #
+  # @example
+  #   x = vipr.get_all_vcenters['id'][0]
+  #   vipr.get_vcenter_clusters(x)
+  def get_vcenter_clusters(vcenter_id=nil, auth=nil, cert=nil)
+    check_vcenter(vcenter_id)
+    rest_get("#{@base_url}/compute/vcenters/#{vcenter_id}/clusters", auth.nil? ? @auth_token : auth, cert.nil? ? @verify_cert : cert)
+  end
+
+  # Retrieve Datacenter information for a single vCenter server using the uid
+  #
+  # @param vcenter_id [String] Requires the string of the vcenter uid
+  # @return [Hash] the object converted into Hash format and can be parsed with object[0] or object['id'] notation
+  #
+  # @example
+  #   x = vipr.get_all_vcenters['id'][0]
+  #   vipr.get_vcenter_datacenters(x)
+  def get_vcenter_datacenters(vcenter_id=nil, auth=nil, cert=nil)
+    check_vcenter(vcenter_id)
+    rest_get("#{@base_url}/compute/vcenters/#{vcenter_id}/vcenter-data-centers", auth.nil? ? @auth_token : auth, cert.nil? ? @verify_cert : cert)
+  end
+
+  # Search for vCenters matching a specific parameter
+  #
+  # @param vcenter_search_hash [String] String for searching
+  # @return [Hash] Will return any vCenter objects containing the search string. The object converted into Hash format and can be parsed with object[0] or object['id'] notation
+  #
+  # @example
+  #   vipr.find_vcenter_object('demo')
+  def find_vcenter_object(vcenter_search_hash=nil, auth=nil, cert=nil)
+    check_vcenter_object_hash(vcenter_search_hash)
+    rest_get("#{@base_url}/compute/vcenters/search?name=#{vcenter_search_hash}", auth.nil? ? @auth_token : auth, cert.nil? ? @verify_cert : cert)
+  end
+
+  # Add a vCenters to a specified tenant
+  #
+  # @param fqdn_or_ip [String] FQDN or IP Address of the vCenter server to add. This is a required string.
+  # @param name [String] Name of the vCenter server. This name is arbitrary and only exists within ViPR. This is a required string.
+  # @param user_name [String] User Name that will be used for authenticating against the vCenter Server. This is a required string.
+  # @param password [String] Password for the user_name that will be used for authenticating against the vCenter Server. This is a required string.
+  # @param port [String] Port of the vCenter server. This is an optional parameter. If no parameter is present, the default port of '443' will be used. If registering to a different tenant than default, set this param to nil
+  # @param tenant [String] Specify a tenant_uid where the vCenter will be registered. By default it will be added to the tenant of the current logged in ViPR user. This string is optional.
+  # @return [Hash] The resulted post operation
+  #
+  # @example
+  #   vipr.add_vcenter('vcenter1.mydomain.com', 'vCENTER1', 'DOMAIN\user', 'userpw')
+  #   vipr.add_vcenter('vcenter2.mydomain.com', 'vCENTER2', 'DOMAIN\user', 'userpw', '1092')
+  #   vipr.add_vcenter('vcenter3.mydomain.com', 'vCENTER3', 'DOMAIN\user', 'userpw', nil, 'diff_tenant_uid')
+  def add_vcenter(fqdn_or_ip=nil, name=nil, user_name=nil, password=nil, port=nil, tenant=nil, auth=nil, cert=nil)
+    check_vcenter_post(fqdn_or_ip, name, user_name, password)
+    port.nil? ? port = '443' : port = port
+    payload = {
+        ip_address: fqdn_or_ip,
+        name: name,
+        port_number: port,
+        user_name: user_name,
+        password: password
+      }.to_json
+    rest_post(payload, "#{@base_url}/tenants/#{@tenant_uid}/vcenters", auth.nil? ? @auth_token : auth, cert.nil? ? @verify_cert : cert)
+  end
+
+  # Delete a vCenter from any tenant based on vCenter ID
+  #
+  # @param vcenter_id [String] Requires the string of the vcenter uid
+  # @return [Hash] The resulted post operation
+  #
+  # @example
+  #   x = vipr.get_all_vcenters['id'][0]
+  #   vipr.delete_vcenter(x)
+  def delete_vcenter(vcenter_id=nil, auth=nil, cert=nil)
+    check_vcenter(vcenter_id)
+    payload = {
+      }.to_json
+    rest_post(payload, "#{@base_url}/compute/vcenters/#{vcenter_id}/deactivate", auth.nil? ? @auth_token : auth, cert.nil? ? @verify_cert : cert)
+  end
+
+
+  private 
+
+  # Error Handling method to check for Missing vCenter ID param. If the pass fails, an error exception is raised
+  #
+  # @param vcenter_id [String] Requires the string of the vcenter uid
+  # @return [Boolean] True if pass, false if it fails
+  #
+  # @private
+  def check_vcenter(vcenter_id=nil)
+    if vcenter_id == nil
+        raise "Missing vCenter ID param (vcenter_id)"
+    end
+  end
+
+  # Error Handling method to check for Missing vCenter Object param. If the pass fails, an error exception is raised
+  #
+  # @param vcenter_search_hash [String] Requires the string of something to search
+  # @return [Boolean] True if pass, false if it fails
+  #
+  # @private
+  def check_vcenter_object_hash(vcenter_search_hash=nil)
+    if vcenter_search_hash == nil
+        raise "Missing vCenter Object to search as a param"
+    end
+  end
+
+  # Error Handling method to check for Missing Param. If the pass fails, an error exception is raised
+  #
+  # @param fqdn_or_ip [String] Requires the string of the vcenter FQDN or IP Address
+  # @param name [String] Requires the name of the vCenter
+  # @param user_name [String] Requires the User Name used for authentication to vCenter
+  # @param password [String] Requires the password of the User Name used for authentication to vCenter
+  # @return [Boolean] True if pass, false if it fails
+  #
+  # @private
+  def check_vcenter_post(fqdn_or_ip=nil, name=nil, user_name=nil, password=nil)
+    if fqdn_or_ip == nil || name == nil || user_name == nil || password == nil
+      raise "Missing a Required Param of fqdn_or_ip, name, port, user_name, or password"
+    end
+  end
+
+end

data/lib/vipruby/version.rb

@@ -0,0 +1,6 @@
+# Get Version information for this Gem
+module Vipruby
+
+	# Version of the Gem File
+	VERSION = "0.1.6.1"
+end

data/lib/vipruby/vipr.rb

@@ -0,0 +1,45 @@
+
+require "vipruby/viprbase"
+require "vipruby/objects/vcenter"
+require 'vipruby/objects/storagesystem'
+require 'vipruby/objects/host'
+
+# The base class for the gem. Every subsequent method relies on creating an object from this class
+class Vipr
+  include ViprBase
+  include ViprVcenter
+  include ViprStorageSystem
+  include ViprHost
+
+  # required params used for almost every single method
+  attr_accessor :tenant_uid, :auth_token, :base_url, :verify_cert
+  
+  # Initializes a Vipr object that all methods can follow.
+  #
+  # @param base_url [String] The IP address or FQDN of the ViPR appliance. Do not include 'https' or port numbers
+  # @param user_name [String] Username used to log into ViPR
+  # @param password [String] Password used to log into ViPR
+  # @param verify_cert [Boolean] Should the cert be SSL verified? Setting it to false will work for development purposes. Should be set to true for production
+  # @return [Object] The Vipruby object that can be used with many different methods
+  #
+  # @note 
+  #   Every POST call requires a Tenant UID to create an object.
+  #   This variable gets the current logged in tenant information.
+  #   Nothing else needs to be done if there is a single tenant configured for ViPR
+  #   If resources need to be added to specific tenants, this variable must be overwritten
+  #   by specifying the tenant_uid
+  #
+  # @example New Vipruby Object
+  #   base_url = 'vipr.mydomain.com'
+  #   user_name = 'root'
+  #   password = 'mypw'
+  #   verify_cert = false
+  #   vipr = Vipr.new(base_url,user_name,password,verify_cert)
+  def initialize(base_url,user_name,password,verify_cert)
+    @base_url = generate_base_url(base_url)
+    @verify_cert = to_boolean(verify_cert)
+    @auth_token = get_auth_token(user_name,password)
+    @tenant_uid = get_tenant_uid['id']
+  end
+
+end

data/lib/vipruby/viprbase.rb

@@ -0,0 +1,84 @@
+require 'rest-client'
+require 'json'
+
+#Base methods used for all operations such as logging in and performing API calls
+module ViprBase
+  
+  # Generic API post call
+  #
+  # @param payload [JSON] the JSON payload to be posted
+  # @param api_url [string] the full API URL path
+  # @return [Hash] the object converted into Hash format and can be parsed with object[0] or object['id'] notation
+  def rest_post(payload, api_url, auth=nil, cert=nil)
+    JSON.parse(RestClient::Request.execute(method: :post,
+         url: api_url,
+         verify_ssl: cert.nil? ? @verify_cert : cert,
+         payload: payload,
+         headers: {
+           :'X-SDS-AUTH-TOKEN' => auth.nil? ? @auth_token : auth,
+           content_type: 'application/json',
+           accept: :json
+         }))
+  end
+
+  # Generic API get call
+  #
+  # @param api_url [string] the full API URL path
+  # @return [Hash] the object converted into Hash format and can be parsed with object[0] or object['id'] notation
+  def rest_get(api_url, auth=nil, cert=nil)
+    JSON.parse(RestClient::Request.execute(method: :get,
+      url: api_url,
+      verify_ssl: cert.nil? ? @verify_cert : cert,
+      headers: {
+        :'X-SDS-AUTH-TOKEN' => auth.nil? ? @auth_token : auth,
+        accept: :json
+      }))
+  end
+  
+  # Get the current users Tenant UID
+  #
+  # @return [Hash] Hash return with the Tenant UID ['id'].
+  def get_tenant_uid(base=nil, auth=nil, cert=nil)
+    rest_get(base.nil? ? @base_url + "/tenant" : base + "/tenant", auth.nil? ? @auth_token : auth, cert.nil? ? @verify_cert : cert)
+  end
+  
+  # Login to ViPR
+  #
+  # @param user_name [string] the username used to login
+  # @param password [string] the password for the username
+  # @return [HTML] returns token information in headers
+  def login(user_name, password, cert=nil, base=nil)
+    RestClient::Request.execute(method: :get,
+      url: base.nil? ? @base_url : base + "/login",
+      user: user_name,
+      password: password,
+      verify_ssl: cert.nil? ? @verify_cert : cert
+    )
+  end
+  
+  # Generate the URL for standard ViPR instances using https: and port :443
+  #
+  # @param ip_or_fqdn [string] String representation of the IP Address or Fully Qualified Domain Name of the ViPR instance
+  # @return [strong] returns the full URL for API called
+  def generate_base_url(ip_or_fqdn)
+    return "https://#{ip_or_fqdn}:4443"
+  end
+  
+  # Get User's Authentication Token
+  #
+  # @param user_name [string] the username used to login
+  # @param password [string] the password for the username
+  # @return [String] returns authentication token for the user
+  def get_auth_token(user_name,password, cert=nil, base=nil)
+    login(user_name, password, cert.nil? ? @verify_cert : cert, base.nil? ? @base_url : base).headers[:x_sds_auth_token]
+  end
+  
+  # Ensure value is a boolean
+  #
+  # @param str [string, bool] the value to convert or verify
+  # @return [bool] returns True or False
+  def to_boolean(str)
+    str.to_s.downcase == "true"
+  end
+
+end

data/vipruby.gemspec

@@ -0,0 +1,29 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vipruby/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'vipruby'
+  s.version     = Vipruby::VERSION
+  s.date        = Date.today.to_s
+  s.summary     = "A Ruby Library for EMC's ViPR"
+  s.description = "A Ruby implementation to add & gather information from Storage Arrays, vCenter, and Compute Hosts"
+  s.authors     = ["Craig J Smith", "Kendrick Coleman"]
+  s.email       = 'nctiggy@gmail.com'
+  s.require_paths = %w[lib]
+  s.files         = `git ls-files`.split($/)
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ["lib"]
+  s.homepage    =
+    'https://github.com/nctiggy/Vipruby'
+  s.license       = 'MIT'
+  s.add_runtime_dependency "json",
+    ["~> 1.8"]
+  s.add_runtime_dependency "rest-client",
+    ["= 1.7.2"]
+  s.add_development_dependency 'bundler', '~> 1.3'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'yard'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vipruby
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.6.1
 platform: ruby
 authors:
 - Craig J Smith
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-20 00:00:00.000000000 Z
+date: 2014-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -40,27 +40,117 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.7.2
 - !ruby/object:Gem::Dependency
-  name: nokogiri
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.6.0
-  type: :runtime
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: yard
+  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: 1.6.0
-description: Currently limited to host and initiator add functions along with vCenter
-  and storage additions
+        version: '0'
+description: A Ruby implementation to add & gather information from Storage Arrays,
+  vCenter, and Compute Hosts
 email: nctiggy@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".yardoc/checksums"
+- ".yardoc/object_types"
+- ".yardoc/objects/root.dat"
+- ".yardoc/proxy_types"
+- ".yardopts"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- doc/Host.html
+- doc/Vipr.html
+- doc/ViprBase.html
+- doc/ViprHost.html
+- doc/ViprStorageSystem.html
+- doc/ViprVcenter.html
+- doc/Vipruby.html
+- doc/Vipruby/Auth.html
+- doc/_index.html
+- doc/class_list.html
+- doc/css/common.css
+- doc/css/full_list.css
+- doc/css/style.css
+- doc/file.README.html
+- doc/file_list.html
+- doc/frames.html
+- doc/index.html
+- doc/js/app.js
+- doc/js/full_list.js
+- doc/js/jquery.js
+- doc/method_list.html
+- doc/top-level-namespace.html
+- lib/.yardoc/checksums
+- lib/.yardoc/object_types
+- lib/.yardoc/objects/root.dat
+- lib/.yardoc/proxy_types
 - lib/vipruby.rb
+- lib/vipruby/.yardoc/checksums
+- lib/vipruby/.yardoc/object_types
+- lib/vipruby/.yardoc/objects/root.dat
+- lib/vipruby/.yardoc/proxy_types
+- lib/vipruby/objects/host.rb
+- lib/vipruby/objects/storagesystem.rb
+- lib/vipruby/objects/vcenter.rb
+- lib/vipruby/version.rb
+- lib/vipruby/vipr.rb
+- lib/vipruby/viprbase.rb
+- vipruby.gemspec
 homepage: https://github.com/nctiggy/Vipruby
 licenses:
 - MIT
@@ -81,8 +171,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A Ruby Library for EMC's ViPR
 test_files: []
+has_rdoc: