rightscale_selfservice 0.0.1 → 0.0.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NmYzNzk0MWJmMzc4MTIxNGIyOWZkMDJiMTUxMTczNDVhOTg0OGNhMw==
+    YWNkZWUzNjgzZThhOWQ3MTEwNTY4N2IyYzA4NGQxOTU5NzVjNjYwOA==
   data.tar.gz: !binary |-
-    YzA5YjA2NjAyMWE2ODliY2RmMTE3ZjliMmVlYzY3ZGNjNDY4NzVlNA==
+    ZjI4NGY5ZjYxM2JjMjQ0MzZlMDU2NDJmYjVlMWYxYWE2OWJhMDY0NA==
 SHA512:
   metadata.gz: !binary |-
-    Y2Q1OTJlNGY4YTQ4NjNjZjU5NTZlYzEyMTBjMjIzZTViNzFkYTM1MDA5N2Rl
-    YzliM2E2MTI2Yjc5MThmYmJhYjg5Yjg4ODE5OTFiMjNhZTE4OGIzNjdiZTg2
-    MTgwYzJjOWU1Mjk0MGNmOTczOGNiZDY4NzU4ZTBjMmI5MTQ2ODM=
+    ZTkyYjE0ODNmZDcxYWVlNDcwZDNhODUwOTUyMGY0ODc0ODkwZTY5NGUwMzhk
+    M2E2YTUxOGFiNTcyYjk2YmYxOTYzOGJkYWExZmZhODRmZTc2Yzg5MDRhNmQz
+    OGY5ZTc5YTY3YTgyMzRhNWI0YTlkNTc0M2IwZjhlOWZhMDI1NDE=
   data.tar.gz: !binary |-
-    MTNkNGI2ZmU2ZmI4MzRmYjdiZDkzZDQ5MzU4MDBkNDY0NjRlMTQ5OTdhNDUz
-    MjFlM2E1OGNlOTMxYjQyNWM4MmI3OTY4Yzg1NzNjOGNhNWU0M2ZhZjRjYmFm
-    ZjY0Yjc4YzU0NzA4MDkyNGQ5ZmExY2MxMDA0ZTc3OTY1NjkwZTE=
+    NjQzMzU2ZDFkNGEzYjNjYjA0YmRlYzQ1MjYzNGViODU1NDQ1YjE0YTZkMjBl
+    MjJhMTY5MTFlMDVjZDJiMTZiMDAzYjhlNzVmNDk0ZGFmNDU0ZGY2MGU0NjQ4
+    MmFiNjJlNWNjNjFmZTZlNmI1YzE1OTc3MWE5Yzg0YmFjM2I5NTM=

data/README.md

@@ -1,4 +1,264 @@
 rightscale_selfservice
 ======================
 
-A rubygem with a buncha useful CLI bits for RightScale Self Service, including a test harness for Cloud Application Templates
+A rubygem with a self service [API client](#api-client), and buncha useful [CLI](#cli) bits for
+RightScale Self Service, including a test harness for Cloud Application Templates
+
+Travis Build Status: [<img src="https://travis-ci.org/rgeyer/rightscale_selfservice.png" />](https://travis-ci.org/rgeyer/rightscale_selfservice)
+
+## Quick Start
+
+```
+gem install rightscale_selfservice
+```
+
+Setup some [Authentication](#authentication) details
+
+Explore the [CLI](#cli).
+```
+rightscale_selfservice help
+```
+
+Explore the [API Client](#api-client).
+
+## Authentication
+
+rightscale_selfservice can authenticate with the APIs using (roughly) the same
+properties as [right_api_client](https://github.com/rightscale/right_api_client).
+
+The only additional required property is "selfservice_url".
+
+The CLI can use a \*.yml file containing those properties or have them passed in
+on the commandline.  The API Client accepts an input hash with these same
+properties.
+
+An example \*.yml file can be found [here](https://github.com/rightscale/right_api_client/blob/v1.5.24/config/login.yml.example)
+
+A working \*.yml file might look like;
+```
+:account_id: 12345
+:email: user@domain.com
+:password: password
+:api_url: https://us-4.rightscale.com
+:selfservice_url: https://selfservice-4.rightscale.com
+```
+
+## CLI
+
+### Template Includes
+For any of the template commands, the template will be preprocessed
+to replace any #include:/path/to/another/cat/file with the contents of that file.
+
+This allows for shared libraries to be built and stored along side your CATs.
+
+Example:
+
+Main template
+```
+name 'cat-with-includes'
+rs_ca_ver 20131202
+short_description 'has some includes'
+
+#include:../definitions/foo.cat.rb
+```
+
+foo.cat.rb
+```
+define foo() return @clouds do
+  @clouds = rs.clouds.get()
+end
+```
+
+Results in
+```
+name 'cat-with-includes'
+rs_ca_ver 20131202
+short_description 'has some includes'
+
+###############################################################################
+# BEGIN Include from ../definitions/foo.cat.rb
+###############################################################################
+define foo() return @clouds do
+  @clouds = rs.clouds.get()
+end
+###############################################################################
+# END Include from ../definitions/foo.cat.rb
+###############################################################################
+```
+
+You can simply run the preprocessor on your CAT and get a file with all the
+appropriate includes with the "preprocess" command.
+
+```
+rightscale_selfservice template preprocess ~/Code/cat/somecat.cat.rb -o /tmp/processedcat.cat.rb
+```
+
+Then maybe check if all your syntax is good by using the API to "compile" your CAT
+
+```
+rightscale_selfservice template compile ~/Code/cat/somecat.cat.rb --auth-file=~./.right_api_client/login.yml
+```
+
+If that works, maybe start up a Cloud App from it
+
+```
+rightscale_selfservice template execute ~/Code/cat/somecat.cat.rb --auth-file=~/.right_api_client/login.yml
+```
+
+## API Client
+
+The [CLI](#cli) bits consume the API client which is deployed with this gem. The
+goal of this API client is to be as "dumb" and lightweight as is practical.
+
+In practical terms this means that the client doesn't make assumptions about the
+return values from the API, and does not attempt to turn them into ruby objects.
+
+In fact, the default "language" of this client is
+[Rest Client](http://rubygems.org/gems/rest-client) requests and responses.
+
+The API client does handle some of the more mundane things for you though, such
+as authenticating with the API using various means (access_token, refresh_token,
+email & password), and assembling the correct URL for a particular resource
+action.
+
+### Supported Services, Resources and Actions
+The client fetches metadata about the SelfService API using a Rake task which
+generates a JSON file which is deployed with the client/gem.  This means that
+a given version of the client supports the API interface as it existed at the
+time that version of the client/gem was created.
+
+Fear not, supporting the latest functionality is as simple as.
+
+```
+rake update_inteface_json
+# Bump the gemspec
+rake gem
+gem push pkg/<new gem file>
+```
+
+### How it works
+You can access a specific action with the following syntax.
+
+```
+client.<service_name>(<optional_service_version>).<resource_name>.<action_name>(<optional_params_hash>,<optional_boolean>)
+```
+
+Where;
+ * service_name is one of the (currently 3) services listed the [docs](http://support.rightscale.com/12-Guides/Self-Service#Self-Service_API)
+ * optional_service_version is a string version of the service
+ * resource_name is the resource you'd like to operate on (E.G. template, execution, operation, etc.)
+ * action_name is the action you'd like to take (index, show, create, etc.)
+ * optional_params_hash is the parameters you wish to pass to that action
+ * optional_boolean if not supplied, a RestClient::Request will be created and
+    executed and a RestClient::Response will be returned. If supplied and true
+    a ready to execute RestClient::Request will be returned
+
+#### Href Tokens
+If the Href for a particular action contains tokens, any parameter passed to the
+action with the same name as that token will be substituted in the request.
+
+Take a [show](#show-a-template) action on the template resource for example.
+
+The Href is;
+```
+/collections/:collection_id/templates/:id
+```
+
+Which contains the token :id.  In order to specify the template id while calling
+the action, put it in as a parameter.
+
+```
+client.designer.templates.show(:id => "abc123")
+```
+
+The Href will have :id substituted with "abc123", and the id parameter will be
+stripped from the body of the request.
+
+#### Automatic Multipart
+The client automatically URL encodes parameters and puts them in the body.  But
+if you pass any Ruby object which has the methods "path" and "read" (basically
+any file or IO resource) it'll assume you're performing a multipart request
+and build the RestClient::Request accordingly.
+
+See the [Multipart Detection](#multipart-detection) example..
+
+### Some examples...
+
+#### Authentication
+Create the client with email and password
+```
+client = RightScaleSelfService::Client.new(
+  :email => "user@domain.com",
+  :password => "password",
+  :selfservice_url => "https://selfservice-4.rightscale.com",
+  :api_url => "https://us-4.rightscale.com"
+)
+```
+
+Or with an access token
+```
+client = RightScaleSelfService::Client.new(
+  :access_token => "access_token",
+  :selfservice_url => "https://selfservice-4.rightscale.com",
+  :api_url => "https://us-4.rightscale.com"
+)
+```
+
+Or with a refresh token
+```
+client = RightScaleSelfService::Client.new(
+  :refresh_token => "refresh_token",
+  :selfservice_url => "https://selfservice-4.rightscale.com",
+  :api_url => "https://us-4.rightscale.com"
+)
+```
+
+#### Service Versions
+You can specify which version of a service you want.  If you don't the "newest"
+version will be used.
+
+Get version 1.1 (which doesn't presently exist) of the "manager" service
+```
+client.manager("1.1")
+```
+
+Just use the latest version of the "manager" service
+```
+client.manager
+```
+
+#### Executing Actions
+
+##### List operations
+```
+client.manager.operation.index
+```
+
+##### Show a template
+```
+client.designer.template.show(:id => "abc123")
+```
+
+##### Get RestClient::Request Instead of Executing Action
+```
+request = client.catalog.application.index({}, true)
+request.execute
+```
+
+##### Format Errors
+```
+begin
+  client.designer.template.compile(:source => some_source_file)
+rescue RestClient::ExceptionWithResponse => e
+  puts "Failed to compile the template"
+  puts RightScaleSelfService::Api::Client.format_error(e)
+end
+```
+
+##### Multipart Detection
+This'll automatically format the payload for RestClient::Request as a multipart
+request, rather than a standard request with a URL encoded body.
+```
+file = File.open("some.cat.rb", "rb")
+client.designer.template.create(:source => file)
+```

data/lib/rightscale_selfservice/api/client.rb

@@ -21,8 +21,27 @@ require 'rest-client'
 
 module RightScaleSelfService
   module Api
+    # @!attribute [rw] selfservice_url
+    #   @return [String] URL to use for Self Service API requests.
+    #     I.E. https://selfservice-4.rightscale.com
+    # @!attribute [rw] api_url
+    #   @return [String] URL to use for Cloud Management API requests. Only
+    #     used once to authenticate.
+    # @!attribute [rw] logger
+    #   @return [Logger] A logger which will be used, mostly for debug
+    #     purposes
+    # @!attribute [rw] account_id
+    #   @return [String] A RightScale account id
+    # @!attribute [r] interface
+    #   @return [Hash] interface A hash containing details about the services,
+    #     resources, and actions available in this client.
     class Client
 
+      # A list of tokens which might appear in hrefs which need to be replaced
+      # with the RightScale account_id.  This will likely change over time and
+      # some of these will likely go away or change meaning
+      #
+      # @return [Array<String>]
       def self.get_known_account_id_tokens
         [":account_id",":catalog_id",":collection_id",":project_id"]
       end
@@ -37,20 +56,24 @@ module RightScaleSelfService
 
       attr_reader :interface
 
+
+      # @param params [Hash] a hash of parameters where the possible values are
+      #   * account_id [String] (required) A RightScale account id
+      #   * selfservice_url [String] (required) URL to use for Self Service API
+      #     requests.  I.E. https://selfservice-4.rightscale.com
+      #   * api_url [String] (required) URL to use for Cloud Management API
+      #     requests. Only used once to authenticate.
+      #     I.E. https://us-4.rightscale.com
+      #   * access_token [String] A RightScale API OAuth Access Token
+      #   * refresh_token [String] A RightScale API OAuth Refresh Token, which
+      #     will be exchanged for an access token
+      #   * email [String] A RightScale user email address
+      #   * password [String] A RightScale user password
+      #   * logger [Logger] A logger which will be used, mostly for debug purposes
       def initialize(params)
         @services = {}
         @auth = {"cookie" => {}, "authorization" => {}}
         required_params = [:account_id,:selfservice_url,:api_url]
-        # allowed_params = [
-        #   :access_token,
-        #   :refresh_token,
-        #   :account_id,
-        #   :selfservice_url,
-        #   :api_url,
-        #   :email,
-        #   :password,
-        #   :logger
-        # ]
 
         # Use the defined logger, or log to a blackhole
         if params.include?(:logger)
@@ -143,6 +166,15 @@ module RightScaleSelfService
         end
       end
 
+      # Accepts request parameters and returns a Rest Client Request which has
+      # necessary authentication details appended.
+      #
+      # @param request_params [Hash] A hash of params to be passed to
+      #   RestClient::Request.new after it has had API authentication details
+      #   injected
+      #
+      # @return [RestClient::Request] A request which is ready to be executed
+      #   cause it's got necessary authentication details
       def get_authorized_rest_client_request(request_params)
         if @auth["cookie"].length > 0
           request_params[:cookies] = @auth["cookie"]
@@ -159,6 +191,18 @@ module RightScaleSelfService
         RestClient::Request.new(request_params)
       end
 
+      # Returns a service of the specified (or newest) version
+      #
+      # @param name [String] The name of the desired service
+      #
+      # @return [RightScaleSelfService::Api::Service]
+      #
+      # @example Get latest version (1.0) of designer service
+      #   service = client.designer
+      #   service.version #=> "1.0"
+      # @example Get specified version of designer service
+      #   service = client.designer("1.1")
+      #   service.version #=> "1.1"
       def method_missing(name, *args)
         unless interface["services"].has_key?(name.to_s)
           raise "No service named \"#{name}\" can not be found. Available services are [#{interface["services"].keys.join(',')}]"
@@ -183,6 +227,40 @@ module RightScaleSelfService
           @services[service_hash_key] = service
         end
       end
+
+      # Converts the input param to a relative href.
+      # I.E. /api/service/:account_id/resource
+      #
+      # @param url [String] The full url to get the relative href from
+      #
+      # @return [String] A relative href
+      def get_relative_href(url)
+        url.gsub!(@selfservice_url,"")
+      end
+
+      # Accepts various possible responses and formats it into useful error text
+      #
+      # @param [RestClient::ExceptionWithResponse] error The response or error
+      #   to format
+      def self.format_error(error)
+        formatted_text = ""
+        if error
+          if error.is_a?(RestClient::ExceptionWithResponse)
+            formatted_text = "HTTP Response Code: #{error.http_code}\nMessage:\n"
+            if error.response.headers[:content_type] == "application/json"
+              formatted_text += JSON.pretty_generate(
+                JSON.parse(error.response.body)
+              ).gsub('\n',"\n")
+            else
+              formatted_text += error.response.body
+            end
+          end
+        else
+          formatted_text = "Nothing supplied for formatting"
+        end
+        formatted_text
+      end
+
     end
   end
 end

data/lib/rightscale_selfservice/api/resource.rb

@@ -56,7 +56,15 @@ module RightScaleSelfService
           end
 
           if args[0].length > 0
-            params[:payload] = URI.encode_www_form(args[0])
+            # Detect if a param is a file, using the same mechanism as
+            # rest-client
+            #
+            # https://github.com/rest-client/rest-client/blob/master/lib/restclient/payload.rb#L33
+            if args[0].select{|k,v| v.respond_to?(:path) && v.respond_to?(:read) }.length > 0
+              params[:payload] = args[0]
+            else
+              params[:payload] = URI.encode_www_form(args[0])
+            end
           end
         end
 

data/lib/rightscale_selfservice/cli/base.rb

@@ -46,6 +46,10 @@ EOF
 
           RightScaleSelfService::Api::Client.new(client_auth_params)
         end
+
+        def logger()
+          Logger.new(STDOUT)
+        end
       }
     end
   end

data/lib/rightscale_selfservice/cli/execution.rb

@@ -0,0 +1,48 @@
+# Copyright (c) 2014 Ryan Geyer
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy of
+# this software and associated documentation files (the "Software"), to deal in
+# the Software without restriction, including without limitation the rights to
+# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+# the Software, and to permit persons to whom the Software is furnished to do so,
+# subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+# Require base.rb first, to satisfy Travis CI
+require File.expand_path(File.join(File.dirname(__FILE__), 'base'))
+
+module RightScaleSelfService
+  module Cli
+    class Execution < Base
+      desc "list", "List all executions (CloudApps)"
+      option :property, :type => :array, :desc => "When supplied, only the specified properties will be displayed.  By default the entire response is supplied."
+      def list
+        client = get_api_client()
+
+        begin
+          response = client.manager.execution.index
+          executions = JSON.parse(response.body)
+          if @options["property"]
+            executions.each do |execution|
+              execution.delete_if{|k,v| !(@options["property"].include?(k))}
+            end
+          end
+          puts JSON.pretty_generate(executions)
+        rescue RestClient::ExceptionWithResponse => e
+          shell = Thor::Shell::Color.new
+          message = "Failed to list executions\n\n#{RightScaleSelfService::Api::Client.format_error(e)}"
+          logger.error(shell.set_color message, :red)
+        end
+      end
+    end
+  end
+end

data/lib/rightscale_selfservice/cli/main.rb

@@ -17,13 +17,22 @@
 # IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 # CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
+require File.expand_path(File.join(File.dirname(__FILE__), 'base.rb'))
+require File.expand_path(File.join(File.dirname(__FILE__), 'execution.rb'))
 require File.expand_path(File.join(File.dirname(__FILE__), 'template.rb'))
+require File.expand_path(File.join(File.dirname(__FILE__), 'operation.rb'))
 
 module RightScaleSelfService
   module Cli
     class Main < Base
+      desc "execution", "Self Service Execution Commands"
+      subcommand "execution", Execution
+
       desc "template", "Self Service Template Commands"
       subcommand "template", Template
+
+      desc "operation", "Self Service Operation Commands"
+      subcommand "operation", Operation
     end
   end
 end

data/lib/rightscale_selfservice/cli/operation.rb

@@ -0,0 +1,49 @@
+# Copyright (c) 2014 Ryan Geyer
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy of
+# this software and associated documentation files (the "Software"), to deal in
+# the Software without restriction, including without limitation the rights to
+# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+# the Software, and to permit persons to whom the Software is furnished to do so,
+# subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+# Require base.rb first, to satisfy Travis CI
+require File.expand_path(File.join(File.dirname(__FILE__), 'base'))
+
+module RightScaleSelfService
+  module Cli
+    class Operation < Base
+      desc "create <operation_name> <execution_id_or_href>", "Creates a new operation with the name <operation_name> on the execution specified by <execution_id_or_href>.  Optionally pass input parameters using --options-file."
+      option :options_file, :type => :string, :desc => "A filepath to a JSON file containing data which will be passed into the \"options\" parameter of the API call."
+      def create(operation_name, execution_id_or_href)
+        execution_id = execution_id_or_href.split("/").last
+        client = get_api_client()
+        params = {:execution_id => execution_id, :name => operation_name}
+        if @options["options_file"]
+          options_filepath = File.expand_path(@options["options_file"], Dir.pwd)
+          options_str = File.open(File.expand_path(options_filepath), 'r') { |f| f.read }
+          params["options"] = options_str
+        end
+
+        begin
+          response = client.manager.operation.create(params)
+          logger.info("Successfully started operation \"#{operation_name}\" on execution id \"#{execution_id}\". Href: #{response.headers[:location]}")
+        rescue RestClient::ExceptionWithResponse => e
+          shell = Thor::Shell::Color.new
+          message = "Failed to create operation \"#{operation_name}\" on execution id \"#{execution_id}\"\n\n#{RightScaleSelfService::Api::Client.format_error(e)}"
+          logger.error(shell.set_color message, :red)
+        end
+      end
+    end
+  end
+end

data/lib/rightscale_selfservice/cli/template.rb

@@ -17,6 +17,9 @@
 # IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 # CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
+# Require base.rb first, to satisfy Travis CI
+require File.expand_path(File.join(File.dirname(__FILE__), 'base'))
+
 module RightScaleSelfService
   module Cli
     class Template < Base
@@ -27,8 +30,12 @@ module RightScaleSelfService
         source_filename = File.basename(source_filepath)
         source_dir = File.dirname(source_filepath)
         dest_filepath = @options.has_key?('o') ? File.expand_path(@options['o'], Dir.pwd) : File.join(source_dir, "processed-#{source_filename}")
+
+        logger.info("Preprocessing #{source_filepath} and writing result to #{dest_filepath}")
+
         result = RightScaleSelfService::Utilities::Template.preprocess(source_filepath)
         File.open(dest_filepath, 'w') {|f| f.write(result)}
+        logger.info("Done! Find your file at #{dest_filepath}")
       end
 
       desc "compile <filepath>", "Uploads <filepath> to SS, validating the syntax. Will report errors if any are found."
@@ -38,8 +45,142 @@ module RightScaleSelfService
         source_dir = File.dirname(source_filepath)
         result = RightScaleSelfService::Utilities::Template.preprocess(source_filepath)
         client = get_api_client()
-        client.designer.template.compile(:source => result)
+        logger.info("Uploading #{source_filepath} to validate syntax")
+        begin
+          client.designer.template.compile(:source => result)
+          logger.info("#{source_filepath} compiled successfully!")
+        rescue RestClient::ExceptionWithResponse => e
+          shell = Thor::Shell::Color.new
+          message = "Failed to compile template\n\n#{RightScaleSelfService::Api::Client.format_error(e)}"
+          logger.error(shell.set_color message, :red)
+        end
+      end
+
+      desc "upsert <filepath>", "Upload <filepath> to SS as a new template or updates an existing one (based on name)"
+      def upsert(filepath)
+        template_href = ""
+        source_filepath = File.expand_path(filepath, Dir.pwd)
+        source_filename = File.basename(source_filepath)
+        source_dir = File.dirname(source_filepath)
+        template = RightScaleSelfService::Utilities::Template.preprocess(source_filepath)
+        client = get_api_client()
+
+        matches = template.match(/^name\s*"(?<name>.*)"/)
+        tmp_file = matches["name"].gsub("/","-").gsub(" ","-")
+        name = matches["name"]
+
+        logger.info("Fetching a list of existing templates to see if \"#{name}\" exists...")
+
+        templates = JSON.parse(client.designer.template.index.body)
+        existing_templates = templates.select{|t| t["name"] == name }
+
+        tmpfile = Tempfile.new([tmp_file,".cat.rb"])
+        begin
+          tmpfile.write(template)
+          tmpfile.rewind
+          if existing_templates.length != 0
+            logger.info("A template named \"#{name}\" already exists, updating it...")
+            template_id = existing_templates.first()["id"]
+            request = client.designer.template.update({:id => template_id, :source => tmpfile}, true)
+            response = request.execute
+            template_href = client.get_relative_href(request.url)
+          else
+            logger.info("Creating template \"#{name}\"...")
+            response = client.designer.template.create({:source => tmpfile})
+            template_href = response.headers[:location]
+          end
+          logger.info("Successfully upserted \"#{name}\".  Href: #{template_href}")
+        rescue RestClient::ExceptionWithResponse => e
+          shell = Thor::Shell::Color.new
+          message = "Failed to update or create template\n\n#{RightScaleSelfService::Api::Client.format_error(e)}"
+          logger.error(shell.set_color message, :red)
+        ensure
+          tmpfile.close!()
+        end
+        template_href
+      end
+
+      desc "publish <filepath>", "Update and publish a template (based on name)"
+      option :override, :type => :boolean, :default => false, :desc => "When supplied the template will be published even if it already exists in the catalog.  False by default, so an error will be raised if the application already exists."
+      def publish(filepath)
+        shell = Thor::Shell::Color.new
+        template_href = upsert(filepath)
+        template_id = template_href.split("/").last
+        client = get_api_client()
+        logger.info("Publishing template Href: #{template_href}")
+        publish_params = {:id => template_id}
+        begin
+          response = client.designer.template.publish(publish_params)
+          logger.info("Successfully published template.")
+        rescue RestClient::ExceptionWithResponse => e
+          if e.http_code == 409 && @options["override"]
+            logger.warn("Template id \"#{template_id}\" has already been published, but --override was set so we'll try to publish again with the overridden_application_href parameter.")
+            begin
+              app_response = client.catalog.application.index()
+              applications = JSON.parse(app_response.body)
+              matching_apps = applications.select{|a| a["template_info"]["href"] == template_href}
+              if matching_apps == 0
+                logger.error(shell.set_color "Unable to find the published application for template id \"#{template_id}\"")
+              else
+                publish_params[:overridden_application_href] = matching_apps.first["href"]
+                retry
+              end
+            rescue RestClient::ExceptionWithResponse => e
+              message = "Failed to get a list of existing published templates\n\n#{RightScaleSelfService::Api::Client.format_error(e)}"
+              logger.error(shell.set_color message, :red)
+            end
+          else
+            message = "Failed to publish template\n\n#{RightScaleSelfService::Api::Client.format_error(e)}"
+            logger.error(shell.set_color message, :red)
+          end
+        end
+      end
+
+      desc "list", "Lists all templates"
+      option :property, :type => :array, :desc => "When supplied, only the specified properties will be displayed.  By default the entire response is supplied."
+      def list
+        client = get_api_client()
+        begin
+          list_response = client.designer.template.index()
+          templates = JSON.parse(list_response.body)
+          if @options["property"]
+            templates.each do |template|
+              template.delete_if{|k,v| !(@options["property"].include?(k))}
+            end
+          end
+          puts JSON.pretty_generate(templates)
+        rescue RestClient::ExceptionWithResponse => e
+          shell = Thor::Shell::Color.new
+          message = "Failed to list templates\n\n#{RightScaleSelfService::Api::Client.format_error(e)}"
+          logger.error(shell.set_color message, :red)
+        end
+      end
+
+      desc "execute <filepath>", "Create a new execution (CloudApp) from a template. Optionally supply parameter values"
+      option :options_file, :type => :string, :desc => "A filepath to a JSON file containing data which will be passed into the \"options\" parameter of the API call."
+      def execute(filepath)
+        source_filepath = File.expand_path(filepath, Dir.pwd)
+        source_filename = File.basename(source_filepath)
+        source_dir = File.dirname(source_filepath)
+        result = RightScaleSelfService::Utilities::Template.preprocess(source_filepath)
+        client = get_api_client()
+        params = {:source => result}
+        if @options["options_file"]
+          options_filepath = File.expand_path(@options["options_file"], Dir.pwd)
+          options_str = File.open(File.expand_path(options_filepath), 'r') { |f| f.read }
+          params["options"] = options_str
+        end
+
+        begin
+          exec_response = client.manager.execution.create(params)
+          logger.info("Successfully started execution. Href: #{exec_response.headers[:location]}")
+        rescue RestClient::ExceptionWithResponse => e
+          shell = Thor::Shell::Color.new
+          message = "Failed to create execution from template\n\n#{RightScaleSelfService::Api::Client.format_error(e)}"
+          logger.error(shell.set_color message, :red)
+        end
       end
+
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rightscale_selfservice
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Ryan J. Geyer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-10 00:00:00.000000000 Z
+date: 2014-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -69,7 +69,9 @@ files:
 - lib/rightscale_selfservice/api/resource.rb
 - lib/rightscale_selfservice/api/service.rb
 - lib/rightscale_selfservice/cli/base.rb
+- lib/rightscale_selfservice/cli/execution.rb
 - lib/rightscale_selfservice/cli/main.rb
+- lib/rightscale_selfservice/cli/operation.rb
 - lib/rightscale_selfservice/cli/template.rb
 - lib/rightscale_selfservice/utilities/template.rb
 homepage: https://github.com/rgeyer/rightscale_selfservice