right_api_helper 0.0.1

data/.gitignore

@@ -0,0 +1,25 @@
+spec/cassettes/*
+cache/*
+.DS_Store
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format nested

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in right_api_helper.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2014 RightScale, Inc.
+
+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,66 @@
+# RightApiHelper
+
+A collection of helper objects and methods that encapsulate commonly used idioms for [right_api_client](https://github.com/rightscale/right_api_client) users.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'right_api_helper'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install right_api_helper
+
+## Usage
+
+
+### Getting a connection
+
+Get started by creating a [right_api_client](https://github.com/rightscale/right_api_client) handle:
+
+    @client = RightApiHelper::Session.new.create_client("someemail", "somepasswd", "someaccountid", "https://my.rightscale.com")
+
+or
+
+    @client = RightApiHelper::Session.new.create_client_from_file("~/.right_api_client/login.yml")
+
+### Using a helper
+
+Now pass the client handle to a helper object to use it's methods:
+
+    deployment_helper = RightApiHelper::Deployments.new(@client)
+    my_deployment = @deployment_helper.find_or_create("My Cool Deployment")
+
+### Logging
+
+By default the helpers log to STDOUT.  But you can modify that by passing a custom `Logger` to each helper.  Here is the example from above modified to use a custom logger.
+
+    my_logger = Logger.new("/tmp/right_api.log)
+    deployment_helper = RightApiHelper::Deployments.new(client)
+    deployment_helper.logger(my_logger)
+    my_deployment = @deployment_helper.find_or_create("My Cool Deployment")
+
+You can also pass a logger object to the `right_api_client` gem. For example:
+
+    session = RightApiHelper::Session.new
+    session.logger(my_logger)
+    @client = session.create_client_from_file("~/.right_api_client/login.yml")
+
+
+## TODO
+
+* Need to further sanitize VCR output before including spec/cassettes dir.
+* break `lib/right_api_helper/api15.rb` apart into separate helpers?
+
+## Contributing
+
+1. Fork it ( https://github.com/caryp/right_api_helper/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/bin/organize

@@ -0,0 +1,193 @@
+#!/usr/bin/env ruby
+#
+# Author: cary@rightscale.com
+# Copyright 2014 RightScale, Inc.
+#
+# 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.
+#
+# Example:
+#   bundle exec bin/organize preview demo/deployments.json --deployment-regexps="ec2:Name=([a-z]+)-([a-z])-([a-z]+)[0-9]+"  --name-regexps="ec2:Name=[a-z]+-[a-z]-([a-z]+[0-9]+)"
+#
+# To better view results:
+#
+#   > cd demo
+#   > ./start_server
+#
+# Then point your browser to http://localhost:8000/
+#
+
+require 'rubygems'
+require 'thor'
+require 'right_api_helper'
+
+require 'pry'
+
+class OrganizeApp < Thor
+
+  desc "preview FILE", "generate an organization preview and output to JSON file."
+  option :deployment_regexps, :required => true
+  option :prefix
+  option :name_regexps
+  option :debug, :type => :boolean
+  option :clear_cache, :type => :boolean
+  def preview(filename)
+    # setup
+    setup_logging(options[:debug])
+    initialize_api_client
+    setup_cache_objects(options[:clear_cache])
+
+    # organize
+    result_hash =
+      organize_by_tags(
+        get_tag_array(options[:deployment_regexps]),
+        get_tag_array(options[:name_regexps]),
+        options[:prefix]
+      )
+
+    # write results to a file
+    json = JSON.pretty_generate(result_hash)
+    @log.debug "JSON: #{json}"
+    File.open(filename, "w") { |f| f.write(json)}
+    @log.info("Done. Results written to '#{filename}'")
+  end
+
+  private
+
+  def setup_logging(debug)
+    @log = Logger.new(STDOUT)
+    @log.formatter = proc do |severity, datetime, progname, msg|
+       "#{msg}\n"
+    end
+    @log.level = Logger::INFO
+    @log.level = Logger::DEBUG if debug
+  end
+
+  def initialize_api_client
+    session = RightApiHelper::Session.new
+    session.logger(@log)
+    @client ||= session.create_client_from_file("~/.right_api_client/login.yml")
+  end
+
+  def setup_cache_objects(clear=false)
+    @cache_dir = File.join(".", "cache")
+    @instance_cache ||= RightApiHelper::Cache.new("instances", @cache_dir)
+    @tag_cache ||= RightApiHelper::Cache.new("tags", @cache_dir)
+    if clear
+      @instance_cache.clear ; @tag_cache.clear
+      FileUtils.rmdir(@cache_dir)
+    end
+    FileUtils.mkdir(@cache_dir) unless File.directory?(@cache_dir)
+  end
+
+  def get_tag_array(option)
+    array = []
+    array = option.split(",") if option
+    array
+  end
+
+  def instance_helper
+    @helper ||= RightApiHelper::Instances.new(@client)
+    @helper.logger(@log)
+    @helper
+  end
+
+  # organize into groups based on tags
+  #
+  # All instances who's captures match all deployment_regexps will be grouped
+  # together. The name of the group can be affected by passing in name_regexps and prefix.
+  #
+  # Array : deployment_regexps : list of namespace:key=value_regex values
+  #
+  # Returns: String : JSON object containing instances grouped by deployment_regexps
+  def organize_by_tags(deployment_regexps, name_regexps=[], prefix="")
+    @log.debug "ORGANIZE PARAMS: deployment_regexps: #{deployment_regexps} name_regexps: #{name_regexps}, prefix: #{prefix}"
+    output_hash = {}
+
+    # cached API queries for instances
+    instances_by_href = query_instances
+
+    # uncached tags query
+    instance_hrefs = instances_by_href.keys
+    @log.info "Querying tags from RightScale API..."
+    @log.debug "instance_hrefs: #{instance_hrefs.inspect}"
+    tag_data = @client.tags.by_resource(:resource_hrefs => instance_hrefs)
+
+    tag_data.each do |tag|
+      resources = tag.resource.is_a?(Array) ? tag.resource : [tag.resource]
+      resources.each do |resource|
+        tags = tag.tags.map{|t| t["name"]}
+        href = resource.href
+        relevant_tags_key= gather_relevant_tags(deployment_regexps, tags)
+        new_name = gather_relevant_tags(name_regexps, tags) if name_regexps
+
+        unless relevant_tags_key.empty?
+          instance_name = (new_name.nil? || new_name.empty?) ? instances_by_href[href] : new_name
+          instance_hash = {"href" => href, "type" => "Instance", "name" => instance_name}
+          output_hash[relevant_tags_key] ||= {"name" => "#{prefix}#{relevant_tags_key}", "children" => []}
+          output_hash[relevant_tags_key]["children"] << instance_hash
+        end
+      end
+    end
+    deployments_hash = { "deployments" => [] }
+
+    output_hash.each do |deployment_type, deployment_data|
+      deployments_hash["deployments"] << deployment_data
+    end
+    deployments_hash
+  end
+
+  # query instance data
+  #
+  # Use local cachefile to improve performance
+  #
+  def query_instances
+    instances_by_href = {}
+    if (instances_by_href = @instance_cache.get) == nil
+      @log.info "Querying instances from RightScale API (might take a few minutes)..."
+      instances = instance_helper.get_unmanaged_instances
+      instances_by_href = instances.inject({}) {|new_hash, instance| instance.show ; new_hash[instance.href] = existing_name(instance); new_hash}
+      @instance_cache.set(instances_by_href)
+    end
+    @log.debug "instances_by_href: #{instances_by_href.inspect}"
+    instances_by_href
+  end
+
+  def existing_name(instance)
+    if instance.respond_to?(:name)
+      instance.name
+    elsif instance.respond_to?(:resource_uid)
+      instance.resource_uid
+    else
+      "unknown"
+    end
+  end
+
+  def gather_relevant_tags(tag_regexps, tags, delimiter = '-')
+    return_tags = []
+    tag_regexps.each do |regexp_str|
+      regexp = Regexp.new(regexp_str)
+      match_data = nil
+      tags.detect{|t| match_data = regexp.match(t)}
+      return_tags += match_data.captures if match_data
+    end
+    return_tags.flatten.join(delimiter)
+  end
+
+  def client
+    @client ||= RightApi::Client.new(YAML.load_file(File.expand_path('~/.right_api_client/login.yml', __FILE__)))
+  end
+
+end
+
+params = OrganizeApp.start(ARGV)
+

data/demo/deployments.json

@@ -0,0 +1,44 @@
+{
+  "deployments": [
+    {
+      "name": "zensmartfeedpool-b-zookeeper",
+      "children": [
+        {
+          "href": "/api/clouds/3/instances/CFD3EJB1P9L5D",
+          "type": "Instance",
+          "name": "i-fb8d86a4"
+        }
+      ]
+    },
+    {
+      "name": "zensmartfeedpool-a-zookeeper",
+      "children": [
+        {
+          "href": "/api/clouds/3/instances/C40BA3BLJ77JF",
+          "type": "Instance",
+          "name": "i-858d86da"
+        },
+        {
+          "href": "/api/clouds/3/instances/42S13K03IDSDV",
+          "type": "Instance",
+          "name": "i-808d86df"
+        },
+        {
+          "href": "/api/clouds/3/instances/8BKCHD746OE69",
+          "type": "Instance",
+          "name": "i-b91912e6"
+        }
+      ]
+    },
+    {
+      "name": "zensmartfeedpool-a-zook",
+      "children": [
+        {
+          "href": "/api/clouds/3/instances/80J8V6NUU2TOM",
+          "type": "Instance",
+          "name": "i-d9050e86"
+        }
+      ]
+    }
+  ]
+}

data/demo/index.html

@@ -0,0 +1,83 @@
+<html>
+<style>
+
+body {
+  min-width: 600px;
+  margin:0;
+  padding:0;
+  font-family:'Lucida Grande','Lucida Sans Unicode','Lucida Sans',Verdana,lucida,sans-serif;
+  background:#FFF;
+  height:100%
+}
+
+.banner {
+  background:#235186;
+  padding: 10;
+}
+
+.logo {
+  padding: 3 20 10;
+
+  float: left;
+  height:30px;
+}
+
+.bucket_name {
+  padding: 0 20 10;
+
+  font-size: 19px;
+  color: #F5F0A9;
+  background:#235186;
+}
+
+
+.disclaimer {
+  background: #FFFFFF;
+  margin-left: auto;
+  margin-right: auto;
+  position: relative;
+  color: black;
+  border: 2px solid black;
+  font-weight: normal;
+  font-size: 14px;
+  padding: 2px 20px;
+  position: relative;
+  clear: both;
+}
+
+.jqtree_common, h1, h2, h3 {
+  color: #235186;
+  background:#F5F2A9;
+  padding: 3;
+  margin: 0;
+  text-indent: 10;
+}
+.jqtree-title {
+  font-size: 16px;
+}
+
+
+
+</style>
+<head>
+  <title>jQuery test</title>
+  <script type="text/javascript" src="https://ajax.googleapis.com/ajax/libs/jquery/1.5.1/jquery.min.js"></script>
+  <script src="tree.jquery.js"></script>
+
+  <script type="text/javascript">
+  $(function() {
+    $.getJSON(
+      'deployments.json',
+      function(result) {
+        $('#tree1').tree({ data: result.deployments });
+      });
+  });
+  </script>
+</head>
+  <div class='banner'>
+  <div class='logo'><img alt='Embedded Image' width='140' height='19' src='logo.png' /></div>
+  <div class='bucket_name'>Instance Organize Preview</div>
+
+  </div>
+  <div id="tree1" data-url="."></div>
+</html>

data/demo/start_server.sh

@@ -0,0 +1,12 @@
+#!/bin/bash
+#
+# Run a local http server from this directory on port 8000
+#
+PORT=8000
+
+if [ -z `which python` ]; then
+  echo "FATAL: python must be installed"
+  exit 1
+fi
+
+python -m SimpleHTTPServer $PORT