rightscale_selfservice 0.0.1

data/lib/rightscale_selfservice/api/resource.rb

@@ -0,0 +1,72 @@
+# 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.
+
+module RightScaleSelfService
+  module Api
+    class Resource
+      attr_accessor :name
+      attr_accessor :service
+
+      def initialize(name, service)
+        @name = name
+        @service = service
+      end
+
+      # Finds the specified action and executes it for this resource
+      #
+      def method_missing(name, *args)
+        actions_with_name = @service.client.interface["services"][@service.name][@service.version][@name]["controller"]["actions"].select{|a| a["name"] == name.to_s}
+        actions = @service.client.interface["services"][@service.name][@service.version][@name]["controller"]["actions"].map{|a| a["name"]}
+        unless actions_with_name.length > 0
+          raise "No action named \"#{name}\" was found on resource \"#{@name}\" in version \"#{@service.version}\" of service \"#{@service.name}\". Available actions are [#{actions.join(',')}]"
+        end
+
+        action = actions_with_name.first
+        method = action["urls"].first.first.downcase.to_sym
+        url = @service.base_url
+        url += action["urls"].first.last
+        tokens = RightScaleSelfService::Api::Client.get_known_account_id_tokens
+        tokens.each do |token|
+          url.gsub!(token, @service.client.account_id)
+        end
+
+        params = {:method => method, :url => url, :headers => {"X_API_VERSION" => @service.version}}
+        if args.length > 0
+          args[0].each do |k,v|
+            if url.include? ":#{k}"
+              url.gsub!(":#{k}",v)
+              args[0].delete(k)
+            end
+          end
+
+          if args[0].length > 0
+            params[:payload] = URI.encode_www_form(args[0])
+          end
+        end
+
+        request = @service.client.get_authorized_rest_client_request(params)
+        if args.length > 1 && args[1]
+          request
+        else
+          response = request.execute
+        end
+      end
+    end
+  end
+end

data/lib/rightscale_selfservice/api/service.rb

@@ -0,0 +1,57 @@
+# 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.
+
+module RightScaleSelfService
+  module Api
+    # A base class for behavior shared with all SS API Services.  Today
+    # they are (designer,catalog,manager)
+    #
+    # @see http://support.rightscale.com/12-Guides/Self-Service
+    class Service
+      attr_accessor :name
+
+      attr_accessor :client
+
+      attr_accessor :version
+
+      attr_accessor :base_url
+
+      def initialize(name, version, base_url, client)
+        @resources = {}
+        @name = name
+        @version = version
+        @base_url = base_url
+        @client = client
+      end
+
+      def method_missing(name, *arguments)
+        unless client.interface["services"][@name][@version].has_key?(name.to_s)
+          raise "No resource named \"#{name}\" was found in version \"#{@version}\" of service \"#{@name}\". Available resources are [#{client.interface["services"][@name][@version].keys.join(',')}]"
+        end
+
+        if @resources.has_key?(name.to_s)
+          @resources[name.to_s]
+        else
+          resource = RightScaleSelfService::Api::Resource.new(name.to_s, self)
+          @resources[name.to_s] = resource
+        end
+      end
+    end
+  end
+end

data/lib/rightscale_selfservice/cli/base.rb

@@ -0,0 +1,52 @@
+# 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.
+
+module RightScaleSelfService
+  module Cli
+    class Base < Thor
+      class_option :auth_hash, :type => :hash, :banner => "<auth-hash>", :desc => "A hash of auth parameters in the form (email:foo@bar.baz password:password account_id:12345)"
+      class_option :auth_file, :banner => "<auth-filepath>", :desc => "A yaml file containing auth parameters to use for authentication"
+
+      no_commands {
+        def get_api_client()
+          client_auth_params = {}
+          thor_shell = Thor::Shell::Color.new
+          unless @options.keys.include?('auth_file') | @options.keys.include?('auth_hash')
+            message = <<EOF
+  You must supply authentication details as either a hash or
+  a yaml authentication file!
+EOF
+            thor_shell.say(thor_shell.set_color(message, :red))
+            exit 1
+          end
+          if @options['auth_file']
+            client_auth_params = YAML.load_file(File.expand_path(@options['auth_file'], Dir.pwd))
+          end
+
+          if @options['auth_hash']
+            # Thanks - http://stackoverflow.com/questions/800122/best-way-to-convert-strings-to-symbols-in-hash
+            client_auth_params = @options['auth_hash'].inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
+          end
+
+          RightScaleSelfService::Api::Client.new(client_auth_params)
+        end
+      }
+    end
+  end
+end

data/lib/rightscale_selfservice/cli/main.rb

@@ -0,0 +1,29 @@
+# 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 File.expand_path(File.join(File.dirname(__FILE__), 'template.rb'))
+
+module RightScaleSelfService
+  module Cli
+    class Main < Base
+      desc "template", "Self Service Template Commands"
+      subcommand "template", Template
+    end
+  end
+end

data/lib/rightscale_selfservice/cli/template.rb

@@ -0,0 +1,45 @@
+# 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.
+
+module RightScaleSelfService
+  module Cli
+    class Template < Base
+      desc "preprocess <filepath>", "Processes <filepath>, #include:/path/to/file statements with file contents. Will create a new file in the same location prefixed with 'processed-', or in the location specified by -o"
+      option :o, :banner => "<output filepath>"
+      def preprocess(filepath)
+        source_filepath = File.expand_path(filepath, Dir.pwd)
+        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}")
+        result = RightScaleSelfService::Utilities::Template.preprocess(source_filepath)
+        File.open(dest_filepath, 'w') {|f| f.write(result)}
+      end
+
+      desc "compile <filepath>", "Uploads <filepath> to SS, validating the syntax. Will report errors if any are found."
+      def compile(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()
+        client.designer.template.compile(:source => result)
+      end
+    end
+  end
+end

data/lib/rightscale_selfservice/utilities/template.rb

@@ -0,0 +1,92 @@
+# 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 'yaml'
+
+module RightScaleSelfService
+  module Utilities
+    class Template
+      # Validates that the specified file exists, raising an error if it does not.
+      # Then reads the file into a string which is returned
+      #
+      # @param file [String] the path to the file which should be returned as a string
+      #
+      # @raise [Errno::ENOENT] If the file does not exist
+      # @return [String] the content of the supplied file
+      def self.file_to_str_and_validate(file)
+        cat_str = File.open(File.expand_path(file), 'r') { |f| f.read }
+      end
+
+      # Returns a de duped hash of files to include by recursively parsing and
+      # looking for #include:<relative file path> in the file and all included
+      # files.
+      #
+      # @param file [String] the path of the file to parse for includes
+      #
+      # @raise [Errno::ENOENT] if the specified file, or any included files do
+      #   not exist
+      #
+      # @return [Hash] a de duped hash of include files, where the key is the
+      #   fully qualified path and filename, and the values are the relative
+      #   path supplied in the include statement.
+      def self.get_include_list(file)
+        dedupe_include_list = {}
+        contents = file_to_str_and_validate(file)
+        contents.scan(/#include:(.*)$/).each do |include|
+          include_filepath = File.expand_path(include.first, File.dirname(file))
+          dedupe_include_list.merge!({include_filepath => include.first})
+          # This merges only the new keys by doing a diff
+          child_includes_hash = get_include_list(include_filepath)
+          new_keys = child_includes_hash.keys() - dedupe_include_list.keys()
+          merge_these = child_includes_hash.select {|k,v| new_keys.include?(k) }
+          dedupe_include_list.merge!(merge_these)
+        end
+        dedupe_include_list
+      end
+
+      def self.preprocess(file)
+        parent_template = file_to_str_and_validate(file)
+        dedup_include_list = get_include_list(file)
+
+        dedup_include_list.each do |key,val|
+          include_filepath = key
+          include_contents = <<EOF
+###############################################################################
+# BEGIN Include from #{val}
+###############################################################################
+EOF
+
+          include_contents += file_to_str_and_validate(key)
+
+          include_contents += <<EOF
+###############################################################################
+# END Include from #{val}
+###############################################################################
+EOF
+
+          parent_template.sub!("#include:#{val}",include_contents)
+        end
+        # Clear all include lines from templates which were included from other templates
+        parent_template.gsub!(/#include:(.*)$/,"")
+        parent_template
+      end
+
+    end
+  end
+end

data/lib/rightscale_selfservice.rb

@@ -0,0 +1,23 @@
+# 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 'thor'
+require 'logger-better'
+glob_path = File.expand_path(File.join(File.dirname(__FILE__), 'rightscale_selfservice')) + '/**/*.rb'
+Dir.glob(glob_path, &method(:require))

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: rightscale_selfservice
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ryan J. Geyer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: logger-better
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: A rubygem with a buncha useful CLI bits for RightScale Self Service,
+  including a test harness for Cloud Application Templates
+email: me@ryangeyer.com
+executables:
+- rightscale_selfservice
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/rightscale_selfservice
+- lib/rightscale_selfservice.rb
+- lib/rightscale_selfservice/api/client.rb
+- lib/rightscale_selfservice/api/interface.json
+- lib/rightscale_selfservice/api/resource.rb
+- lib/rightscale_selfservice/api/service.rb
+- lib/rightscale_selfservice/cli/base.rb
+- lib/rightscale_selfservice/cli/main.rb
+- lib/rightscale_selfservice/cli/template.rb
+- lib/rightscale_selfservice/utilities/template.rb
+homepage: https://github.com/rgeyer/rightscale_selfservice
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A rubygem with a buncha useful CLI bits for RightScale Self Service, including
+  a test harness for Cloud Application Templates
+test_files: []