vcoworkflows 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f0db2d5004d39e1e915ed6951c54a2dad6301f06
-  data.tar.gz: 93b6739926461ec0504308166cdf227bf0fbcc12
+  metadata.gz: d50183ce8d642ade7378ff0c0993cf53daded6c4
+  data.tar.gz: 31b515782d348804ff9f74c8e9dacdda314a2cf6
 SHA512:
-  metadata.gz: d2782bfa11dc901f086ed0e80c5dc3b00fb10551d7bf6e0a16e01ea778549eb57c9faddfed25b6208d3566bb2e550f8fbc9a47b6c6c32d1ba478ea14f24f27be
-  data.tar.gz: 671989455477f0555aca1c0b5d677994b2f11a5bbb6c44307916806719668c849af13d90db548b30ddecc3b2c3c0b9ca9814c1ffdf178f130e5d0199b1c38e5f
+  metadata.gz: 2800e407f0acfe52d4e275a57f420739fdc0cdd73aa6e8dd2e48a30a840588f941d279a14c12095c5e78049d4b1b96d25723f9e1b950e55be6b2594eaa99dfa0
+  data.tar.gz: ff1a54bfcb3afe64467031a57b0c2860e28e6c18655872b76abc73f66b904429b43a34b648286dfccb0a6221b44b89fa664046aff94cf3e7b91aaf8bb33841f1

data/README.md

@@ -1,8 +1,8 @@
 # Vcoworkflows
 
 [![Build Status](https://travis-ci.org/ActiveSCM/vcoworkflows.svg?branch=master)][travis]
-[![Dependency Status](https://gemnasium.com/ActiveSCM/vcoworkflows.svg)](https://gemnasium.com/ActiveSCM/vcoworkflows)
-[![Coverage Status](https://coveralls.io/repos/ActiveSCM/vcoworkflows/badge.svg)](https://coveralls.io/r/ActiveSCM/vcoworkflows)
+[![Dependency Status](https://gemnasium.com/ActiveSCM/vcoworkflows.svg)][gemnasium]
+[![Coverage Status](https://coveralls.io/repos/ActiveSCM/vcoworkflows/badge.png?branch=master)][coveralls]
 [![Inline docs](http://inch-ci.org/github/ActiveSCM/vcoworkflows.png?branch=master)][inch]
 
 [travis]: http://travis-ci.org/ActiveSCM/vcoworkflows
@@ -13,7 +13,7 @@
 `vcoworkflows` provides a Ruby API for finding and executing vCenter
 Orchestrator workflows. You can search for a workflow either by name or
 by GUID, populate the resulting `VcoWorkflows::Workflow` object's
-`inputParameters` with the required values, and then request that the
+input parameters with the required values, and then request that the
 the configured workflow be executed by vCenter Orchestrator.
 
 Under the hood, communcations with vCenter Orchestrator is done via its
@@ -55,12 +55,11 @@ Quick example:
 
 ```ruby
 require 'vcoworkflows'
-my_workflow = VcoWorkflows::Workflow.new(
-    'Request Component,
+workflow = VcoWorkflows::Workflow.new(
+    'Request Component',
     url: 'https://vco.example.com:8281/vco/api',
     username: 'jdoe',
-    password: 's3cr3t',
-
+    password: 's3cr3t'
 )
 
 ```
@@ -73,7 +72,7 @@ class.
 
 It is possible to select a Workflow by GUID (as divined by the vCenter
 Orchestrator client) or by specifying the Workflow's name. If specifying by
-name, however, an exeption will be raised if either no workflows are found,
+name, however, an exception will be raised if either no workflows are found,
 or multiple workflows are found. Therefor, GUID is likely "safer". In either
 case, however, the workflow name must be given, as in the example above.
 
@@ -81,13 +80,12 @@ Selecting a workflow by GUID is done by adding the `id:` parameter when
 creating a new `Workflow` object:
 
 ```ruby
-my_workflow = VcoWorkflows::Workflow.new(
-    'Request Component,
+workflow = VcoWorkflows::Workflow.new(
+    'Request Component',
     id: '6e04a460-4a45-4e16-9603-db2922c24462',
     url: 'https://vco.example.com:8281/vco/api',
     username: 'jdoe',
-    password: 's3cr3t',
-    verify_ssl: false
+    password: 's3cr3t'
 )
 ```
 
@@ -287,4 +285,3 @@ 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/lib/vcoworkflows/cli/auth.rb

@@ -4,14 +4,28 @@ require 'vcoworkflows/constants'
 module VcoWorkflows
   # Cli
   module Cli
-    # Auth
+    # Auth is a very small helper class to allow pulling authentication
+    # credentials from the environment when using one of the executable
+    # commands.
+    #
+    # If credentials aren't passed in as options to the command, we'll
+    # also check the environment for $VCO_USER and $VCO_PASSWD and use
+    # those. Otherwise, command line options will override environment
+    # values.
     class Auth
+      # username
+      # @return [String]
       attr_reader :username
+
+      # password
+      # @return [String]
       attr_reader :password
 
-      # Initialize the Auth object
-      # @param [String] username
-      # @param [String] password
+      # Initialize the Auth object. If the paramaters are nil, look
+      # for values in the environment instead.
+      # @param [String] username vCenter Orchestrator user name
+      # @param [String] password vCenter Orchestrator password
+      # @return [VcoWorkflows::Cli::Auth]
       def initialize(username: nil, password: nil)
         # Set username and password from parameters, if provided, or
         # environment variables $VCO_USER and $VCO_PASSWD, if not.

data/lib/vcoworkflows/cli/execute.rb

@@ -8,7 +8,7 @@ require 'thor/group'
 module VcoWorkflows
   # Cli
   module Cli
-    # Execute
+    # Execute a workflow with the given options.
     class Execute < Thor::Group
       include Thor::Actions
 
@@ -24,6 +24,7 @@ module VcoWorkflows
 
       class_option :parameters, type: :string, required: true, desc: DESC_CLI_EXECUTE_PARAMETERS
 
+      # Thor
       def self.source_root
         File.dirname(__FILE__)
       end

data/lib/vcoworkflows/cli/query.rb

@@ -27,6 +27,7 @@ module VcoWorkflows
       class_option :logs, type: :boolean, aliases: ['-L', '--log'], desc: DESC_CLI_QUERY_EXEC_LOG
       class_option :show_json, type: :boolean, default: false, desc: DESC_CLI_QUERY_JSON
 
+      # Thor
       def self.source_root
         File.dirname(__FILE__)
       end

data/lib/vcoworkflows/constants.rb

@@ -3,25 +3,65 @@ module VcoWorkflows
   # rubocop:disable LineLength
 
   # Options description messages
+
+  # Version
   DESC_VERSION = 'Display the installed version of the VcoWorkflows gem'
+
+  # Execute
   DESC_CLI_EXECUTE = 'Execute the specified workflow'
+
+  # Query
   DESC_CLI_QUERY = 'Query vCO for a workflow'
+
+  # Workflow
   DESC_CLI_WORKFLOW = 'Name of the workflow'
+
+  # ID
   DESC_CLI_WORKFLOW_ID = 'GUID of the workflow'
+
+  # dry-run
   DESC_CLI_DRY_RUN = 'Dry run; do not actually perform operations against vCO'
+
+  # verbose
   DESC_CLI_VERBOSE = 'Show extra information'
+
+  # name
   DESC_CLI_NAME = 'Name of the workflow to execute'
+
+  # server
   DESC_CLI_SERVER = 'VMware vCenter Orchestrator server URL'
+
+  # username
   DESC_CLI_USERNAME = 'vCO user name'
+
+  # password
   DESC_CLI_PASSWORD = 'vCO password'
+
+  # verify certificates
   DESC_CLI_VERIFY_SSL = 'Perform TSL Certificate verification'
+
+  # watch execution
   DESC_CLI_EXECUTE_WATCH = 'Wait around for workflow results'
+
+  # execution parameter list
   DESC_CLI_EXECUTE_PARAMETERS = 'Comma-separated list of key=value parameters for workflow'
+
+  # query exeuction list
   DESC_CLI_QUERY_EXECS = 'Fetch a list of executions for the workflow'
+
+  # limit queried execution list size
   DESC_CLI_QUERY_EXEC_LIM = 'Limit the number of returned executions to the most recent N'
+
+  # exeuction id
   DESC_CLI_QUERY_EXEC_ID = 'Fetch the execution data for this execution GUID'
+
+  # execution state
   DESC_CLI_QUERY_EXEC_STATE = 'Fetch the state of the specified workflow execution'
+
+  # execution log
   DESC_CLI_QUERY_EXEC_LOG = 'In addition to execution data, show the execution log'
+
+  # show JSON
   DESC_CLI_QUERY_JSON = 'Show the JSON document for the requested information'
 
   # What do all the vCO REST URIs start with?

data/lib/vcoworkflows/vcosession.rb

@@ -3,7 +3,8 @@ require 'rest_client'
 
 # VcoWorkflows
 module VcoWorkflows
-  # VcoSession
+  # VcoSession is a simple wrapper for RestClient::Resource, and supports
+  # GET and POST operations against the vCO API.
   class VcoSession
     # Accessor for rest-client object, primarily for testing purposes
     attr_reader :rest_resource

data/lib/vcoworkflows/version.rb

@@ -1,4 +1,5 @@
 # VcoWorkflows
 module VcoWorkflows
-  VERSION = '0.1.1'
+  # Gem Version
+  VERSION = '0.1.2'
 end

data/lib/vcoworkflows/workflow.rb

@@ -11,17 +11,46 @@ module VcoWorkflows
 
   # Class to represent a Workflow as presented by vCenter Orchestrator.
   class Workflow
+    # rubocop:disable LineLength
+
+    # Workflow GUID
+    # @return [String] workflow GUID
     attr_reader :id
+
+    # Workflow name
+    # @return [String] workflow name
     attr_reader :name
+
+    # Workflow version
+    # @return [String] workflow version
     attr_reader :version
+
+    # Workflow description
+    # @return [String] workflow description
     attr_reader :description
+
+    # Workflow Input Parameters
+    # @return [VcoWorkflows::WorkflowParameter{}] Hash of WorkflowParameter objects, keyed by name
     attr_reader :input_parameters
+
+    # Workflow Output Parameters
+    # @return [VcoWorkflows::WorkflowParameter{}] Hash of WorkflowParameter objects, keyed by name
     attr_reader :output_parameters
+
+    # Workflow Service
+    # @return [VcoWorkflows::WorkflowService] The WorkflowService currently being used to interface with vCO
     attr_accessor :service
+
+    # Workflow execution ID
+    # @return [String] workflow execution ID
     attr_reader :execution_id
 
+    # Workflow source JSON
+    # @return [String] the source JSON returned by vCO for this workflow
     attr_reader :source_json
 
+    # rubocop:enable LineLength
+
     # rubocop:disable CyclomaticComplexity, PerceivedComplexity, MethodLength, LineLength
 
     # Create a Workflow object given vCenter Orchestrator's JSON description
@@ -100,18 +129,26 @@ module VcoWorkflows
     end
     # rubocop:enable CyclomaticComplexity, PerceivedComplexity, MethodLength, LineLength
 
+    # vCO API URL used when creating this workflow
+    # @return [String]
     def url
       options[:url]
     end
 
+    # vCO user name used when creating this workflow object
+    # @return [String]
     def username
       options[:username]
     end
 
+    # vCO password used when creating this workflow object
+    # @return [String]
     def password
       options[:password]
     end
 
+    # Verify SSL?
+    # @return [Boolean]
     def verify_ssl?
       options[:verify_ssl]
     end

data/lib/vcoworkflows/workflowexecutionlog.rb

@@ -6,6 +6,8 @@ module VcoWorkflows
   # WorkflowExecutionLog is a simple object to contain the log for an
   # execution of a workflow.
   class WorkflowExecutionLog
+    # Log messages
+    # @return [String[]] Array of log message lines
     attr_reader :messages
 
     # Create an execution log object

data/lib/vcoworkflows/workflowparameter.rb

@@ -5,9 +5,20 @@ module VcoWorkflows
   # WorkflowParameter is an object wrapper for workflow input and output
   # parameters.
   class WorkflowParameter
+    # Parameter name
+    # @return [String] parameter name
     attr_reader :name
+
+    # Parameter type
+    # @return [String] parameter type
     attr_reader :type
+
+    # Parameter subtype (used when type is 'Array')
+    # @return [String] parameter subtype
     attr_reader :subtype
+
+    # Parameter value
+    # @return [Object] parameter value
     attr_reader :value
 
     # rubocop:disable MethodLength

data/lib/vcoworkflows/workflowpresentation.rb

@@ -14,7 +14,12 @@ module VcoWorkflows
   # WorkflowPresentation examines the presentation JSON from vCO to determine
   # whether input parameters for the workflow are required or not.
   class WorkflowPresentation
+    # Accessor for the data structure
+    # @return [Hash] parsed JSON
     attr_reader :presentation_data
+
+    # Get the list of required parameters for the workflow
+    # @return [String[]] Array of strings (names of parameters)
     attr_reader :required
 
     # rubocop:disable LineLength, MethodLength

data/lib/vcoworkflows/workflowservice.rb

@@ -11,7 +11,8 @@ module VcoWorkflows
   # WorkflowService is the object which acts as the interface to the vCO
   # API, and is loosely modeled from the vCO API documentation.
   class WorkflowService
-    # Return the VcoSession
+    # The VcoSession used by this service
+    # @return [VcoWorkflows::VcoSession]
     attr_reader :session
 
     # rubocop:disable LineLength
@@ -26,7 +27,7 @@ module VcoWorkflows
 
     # Get a workflow by GUID
     # @param [String] id Workflow GUID
-    # @return [VcoWorkflows::Workflow] the requested workflow
+    # @return [String] the JSON document of the requested workflow
     def get_workflow_for_id(id)
       @session.get("/workflows/#{id}").body
     end
@@ -40,7 +41,7 @@ module VcoWorkflows
 
     # Get one workflow with a specified name.
     # @param [String] name Name of the workflow
-    # @return [VcoWorkflows::Workflow] the requested workflow
+    # @return [String] the JSON document of the requested workflow
     def get_workflow_for_name(name)
       path = "/workflows?conditions=name=#{url_encode(name)}"
       response = JSON.parse(@session.get(path).body)
@@ -70,7 +71,7 @@ module VcoWorkflows
 
     # Get a list of executions for the given workflow GUID
     # @param [String] workflow_id Workflow GUID
-    # @return [Hash]
+    # @return [Hash] workflow executions, keyed by execution ID
     def get_execution_list(workflow_id)
       path = "/workflows/#{workflow_id}/executions/"
       relations = JSON.parse(@session.get(path).body)['relations']

data/lib/vcoworkflows/workflowtoken.rb

@@ -7,22 +7,66 @@ module VcoWorkflows
   # WorkflowToken is used for workflow execution results, and contains as much
   # data on the given workflow execution instance as vCO can provide.
   class WorkflowToken
+    # rubocop:disable LineLength
+
+    # Workflow execution ID
+    # @return [String] the execution id for this token
     attr_reader :id
+
+    # Workflow ID
+    # @return [String] the GUID for this workflow
     attr_reader :workflow_id
+
+    # Workflow name
+    # @return [String] name of the workflow
     attr_reader :name
+
+    # Execution state
+    # @return [String] current state of the workflow execution
     attr_reader :state
+
+    # Execution href
+    # @return [String] link to this execution via the REST API
     attr_reader :href
+
+    # Execution start date
+    # @return [String] date and time the workflow execution started
     attr_reader :start_date
+
+    # Execution end date
+    # @return [String] date and time the workflow execution ended
     attr_reader :end_date
+
+    # Execution started by
+    # @return [String] vCO user who started this execution
     attr_reader :started_by
+
+    # @return [String]
     attr_reader :current_item_name
+
+    # @return [String]
     attr_reader :current_item_state
+
+    # @return [String]
     attr_reader :content_exception
+
+    # @return [String]
     attr_reader :global_state
+
+    # Workflow execution input parameters
+    # @return [VcoWorkflows::WorkflowParameter{}] Hash of input parameters which were given when the workflow was executed
     attr_reader :input_parameters
+
+    # Workflow execution output parameters
+    # @return [VcoWorkflows::WorkflowParameter{}] Hash of output parameters set by the workflow execution
     attr_reader :output_parameters
+
+    # Source JSON
+    # @return [String] source JSON document returned by vCO for this execution
     attr_reader :json_content
 
+    # rubocop:enable LineLength
+
     # rubocop:disable CyclomaticComplexity, PerceivedComplexity, MethodLength, LineLength
 
     # Create a new workflow token

data/spec/spec_helper.rb

@@ -1,4 +1,4 @@
 $LOAD_PATH << '../../lib'
 
-# require 'coveralls'
-# Coveralls.wear!
+require 'coveralls'
+Coveralls.wear!

data/vcoworkflows.gemspec

@@ -7,8 +7,8 @@ require 'vcoworkflows/version'
 Gem::Specification.new do |spec|
   spec.name          = 'vcoworkflows'
   spec.version       = VcoWorkflows::VERSION
-  spec.authors       = %w('Gregory Ruiz-ade')
-  spec.email         = %w('gregory.ruiz-ade@activenetwork.com')
+  spec.authors       = 'Gregory Ruiz-ade'
+  spec.email         = 'gregory.ruiz-ade@activenetwork.com'
   spec.summary       = 'vCO Workflows REST API Wrapper'
   spec.description   = 'Ruby implementation of vCenter Orchestrator REST API'
   spec.homepage      = ''

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vcoworkflows
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
-- "'Gregory"
-- Ruiz-ade'
+- Gregory Ruiz-ade
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-02 00:00:00.000000000 Z
+date: 2015-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -180,8 +179,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: Ruby implementation of vCenter Orchestrator REST API
-email:
-- "'gregory.ruiz-ade@activenetwork.com'"
+email: gregory.ruiz-ade@activenetwork.com
 executables:
 - vcoworkflows
 extensions: []