cf-uaac 1.3.0

data/.gitignore

@@ -0,0 +1,8 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/
+doc/
+coverage/
+spec_reports/
+vendor/

data/Gemfile

@@ -0,0 +1,16 @@
+# Cloud Foundry 2012.02.03 Beta
+# Copyright (c) [2009-2012] VMware, Inc. All Rights Reserved.
+#
+# This product is licensed to you under the Apache License, Version 2.0 (the "License").
+# You may not use this product except in compliance with the License.
+#
+# This product includes a number of subcomponents with
+# separate copyright notices and license terms. Your use of these
+# subcomponents is subject to the terms and conditions of the
+# subcomponent's license, as noted in the LICENSE file.
+#
+
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in uaa.gemspec
+gemspec

data/README.md

@@ -0,0 +1,48 @@
+# CloudFoundry UAA Command Line Client
+
+Command line gem for interacting with the CloudFoundry UAA server.
+
+Set up a local ruby environment (so sudo not required):
+
+  `$ rvm use 1.9.2`
+
+or
+
+  `$ rbenv global 1.9.2-p180`
+
+see: https://rvm.io/ or http://rbenv.org/
+
+Build the gem
+
+  `$ bundle install`
+  `$ gem build cf-uaac.gemspec`
+
+Install it
+
+  `$ gem install cf-uaac*.gem`
+
+Run it
+
+  `$ uaac help`
+  `$ uaac target uaa.cloudfoundry.com`
+  `$ uaac token get <your-cf-username>`
+  `$ uaac token decode`
+
+To use the APIs, see: https://github.com/cloudfoundry/cf-uaa-lib
+
+## Tests
+
+Run the tests with rake:
+
+  `$ bundle exec rake test`
+
+Run the tests and see a fancy coverage report:
+
+  `$ bundle exec rake cov`
+
+Run integration tests (on a server running on localhost:8080/uaa):
+
+  `$ export UAA_CLIENT_ID="admin"`
+  `$ export UAA_CLIENT_SECRET="adminsecret"`
+  `$ export UAA_CLIENT_TARGET="http://localhost:8080/uaa"`
+  `$ bundle exec rspec spec/integration_spec.rb`

data/Rakefile

@@ -0,0 +1,50 @@
+# Cloud Foundry 2012.02.03 Beta
+# Copyright (c) [2009-2012] VMware, Inc. All Rights Reserved.
+#
+# This product is licensed to you under the Apache License, Version 2.0 (the "License").
+# You may not use this product except in compliance with the License.
+#
+# This product includes a number of subcomponents with
+# separate copyright notices and license terms. Your use of these
+# subcomponents is subject to the terms and conditions of the
+# subcomponent's license, as noted in the LICENSE file.
+#
+
+require "rdoc/task"
+require "rspec/core/rake_task"
+require "bundler/gem_tasks" # only available in bundler >= 1.0.15
+require "ci/reporter/rake/rspec"
+
+ENV['CI_REPORTS'] = File.expand_path("spec_reports")
+COV_REPORTS = File.expand_path("coverage")
+
+task :default => [:test]
+task :tests => [:test]
+task :spec => [:test]
+
+RSpec::Core::RakeTask.new("test") do |t|
+  t.rspec_opts = ["--format", "documentation", "--colour"]
+  t.pattern = "spec/**/*_spec.rb"
+end
+
+RDoc::Task.new do |rd|
+  rd.rdoc_files.include("lib/**/*.rb")
+  rd.rdoc_dir = "doc"
+end
+
+task :ci => [:pre_coverage, :rcov_reports, "ci:setup:rspec", :test]
+task :cov => [:pre_coverage, :test, :view_coverage]
+task :coverage => [:pre_coverage, :test]
+
+task :pre_coverage do
+  rm_rf COV_REPORTS
+  ENV['COVERAGE'] = "exclude-spec exclude-vendor"
+end
+
+task :rcov_reports do
+  ENV['COVERAGE'] += " rcov"
+end
+
+task :view_coverage do
+  `firefox #{File.join(COV_REPORTS, 'index.html')}`
+end

data/bin/completion-helper

@@ -0,0 +1,80 @@
+#!/usr/bin/env ruby
+
+# given the indents, find sub-commands of a given command
+def find_sub_commands (lines, indents, i)
+  result = Array.new
+  x = i+1
+  while x < lines.size && indents[x] > indents[i]
+    if indents[x] - indents[i] == 1
+      result.push(x)
+    end
+    x = x+1
+  end
+  result
+end
+
+def find_sub_command_index (lines, sub_command_indices, sub_command)
+  sub_command_indices.each do |i|
+    if lines[i] == sub_command
+      return i
+    end
+  end
+  -1
+end
+
+# traverse sub-command tree with the given list of args
+def traverse_command_tree(lines, sub_command_indices, args)
+  #puts "traversing for #{args}"
+  x = 0
+  args.drop(1).each do |arg|
+    next if arg.start_with? ("-")
+    nx = find_sub_command_index(lines, sub_command_indices[x], arg)
+    if nx != -1
+      x = nx
+    end
+  end
+  x
+end
+
+# use values in array1 as indices into array2 and find the subset from array2
+def find_subset(values, indices)
+  result = Array.new
+  indices.each do |i|
+    result.push(values[i])
+  end
+  result.join(' ')
+end
+
+def get_cache_filename(cmd)
+  curr_user = `whoami`.chomp
+  home_dir = `echo ~#{curr_user}`.chomp
+  "#{home_dir}/.#{cmd}-commands"
+end
+
+indent_char = "\t"
+command_file_name = get_cache_filename(ARGV[0])
+if !FileTest.exists?(command_file_name)
+  `#{ARGV[0]} help commands > #{command_file_name}`
+end
+lines = File.readlines(command_file_name)
+children = Array.new
+indents = Array.new
+
+lines.each_with_index do |line, i|
+  indents[i] = line.count(indent_char)
+end
+
+# now that we have computed the indent level for each line, remove new-lines and tabs
+lines.collect! { |line| line.gsub(/[#{indent_char}]/, '') }
+lines.collect! { |line| line.gsub(/[\n]/, '') }
+
+# pre-processing: find the sub-commands for command (using indent levels)
+lines.each_with_index do |line, i|
+  children[i] = find_sub_commands(lines, indents, i)
+end
+
+# now that a sub-command tree is available, parse it using the input arguments to find the auto-completion options
+x = traverse_command_tree(lines, children, ARGV.drop(1))
+puts x == -1 ? "" : find_subset(lines, children[x])
+
+

data/bin/uaac

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.expand_path File.join __FILE__, '..', '..', 'lib'
+require 'cli'
+exit CF::UAA::Cli.configure("#{ENV['HOME']}/.uaac.yml").run ? 0 : 1

data/bin/uaac-completion.sh

@@ -0,0 +1,34 @@
+#! /bin/bash
+GLOBAL_OPTS="--help --no-help -h --version --no-version -v --debug --no-debug -d --trace --no-trace -t --config"
+
+_debug() {
+	if [[ $UAAC_DEBUG -eq 1 ]] ; then
+		echo "$@;"
+	fi
+}
+
+_add_completion_options() {
+	local current="${COMP_WORDS[${COMP_CWORD}]}"
+	COMPREPLY=( "${COMPREPLY[@]}" $(compgen -W "$1" -- $current) )
+}
+
+_uaac() {
+	local current="${COMP_WORDS[${COMP_CWORD}]}"
+	local helper_input=()
+	if [[ "$current" == "" ]] || [[ "$current" == " " ]] || [[ $current == -* ]] ; then
+		helper_input=( ${COMP_WORDS[@]} )
+	else
+		helper_input=( ${COMP_WORDS[@]/$current/} )
+	fi
+
+	local parent_command="${COMP_WORDS[0]}"
+	local uaac_opts=$(completion-helper "${parent_command}" "${helper_input[@]}")
+	local opts=$uaac_opts
+	if [[ $current == -* ]] ; then
+		opts="${GLOBAL_OPTS} ${uaac_opts}"
+	fi
+	_add_completion_options "${opts}"
+
+}
+
+complete -F _uaac uaac

data/bin/uaas

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.expand_path File.join __FILE__, '..', '..', 'lib'
+require 'stub/uaa'
+
+CF::UAA::Util.default_logger(:trace)
+CF::UAA::StubUAA.new.run('localhost', 8080)

data/cf-uaac.gemspec

@@ -0,0 +1,48 @@
+# -*- encoding: utf-8 -*-
+#
+# Cloud Foundry 2012.02.03 Beta
+# Copyright (c) [2009-2012] VMware, Inc. All Rights Reserved.
+#
+# This product is licensed to you under the Apache License, Version 2.0 (the "License").
+# You may not use this product except in compliance with the License.
+#
+# This product includes a number of subcomponents with
+# separate copyright notices and license terms. Your use of these
+# subcomponents is subject to the terms and conditions of the
+# subcomponent's license, as noted in the LICENSE file.
+#
+
+$:.push File.expand_path("../lib", __FILE__)
+require "cli/version"
+
+Gem::Specification.new do |s|
+  s.name        = "cf-uaac"
+  s.version     = CF::UAA::CLI_VERSION
+  s.authors     = ["Dave Syer", "Dale Olds", "Joel D'sa", "Vidya Valmikinathan", "Luke Taylor"]
+  s.email       = ["dsyer@vmware.com", "olds@vmware.com", "jdsa@vmware.com", "vidya@vmware.com", "ltaylor@vmware.com"]
+  s.homepage    = "https://github.com/cloudfoundry/cf-uaac"
+  s.summary     = %q{Command line interface for CloudFoundry UAA}
+  s.description = %q{Client command line tools for interacting with the CloudFoundry User Account and Authorization (UAA) server.  The UAA is an OAuth2 Authorization Server so it can be used by webapps and command line apps to obtain access tokens to act on behalf of users.  The tokens can then be used to access protected resources in a Resource Server.  This library can be used by clients (as a convenient wrapper for mainstream oauth gems) or by resource servers.}
+
+  s.rubyforge_project = "cf-uaac"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # dependencies
+  s.add_development_dependency "bundler"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "simplecov"
+  s.add_development_dependency "simplecov-rcov"
+  s.add_development_dependency "ci_reporter"
+  s.add_runtime_dependency "highline"
+  s.add_runtime_dependency "cf-uaa-lib", ">= 1.3.0"
+  s.add_runtime_dependency "multi_json"
+  s.add_runtime_dependency "eventmachine"
+  s.add_runtime_dependency "launchy"
+  s.add_runtime_dependency "em-http-request", ">= 1.0.0.beta.3"
+
+end

data/lib/cli.rb

@@ -0,0 +1,15 @@
+#--
+# Cloud Foundry 2012.02.03 Beta
+# Copyright (c) [2009-2012] VMware, Inc. All Rights Reserved.
+#
+# This product is licensed to you under the Apache License, Version 2.0 (the "License").
+# You may not use this product except in compliance with the License.
+#
+# This product includes a number of subcomponents with
+# separate copyright notices and license terms. Your use of these
+# subcomponents is subject to the terms and conditions of the
+# subcomponent's license, as noted in the LICENSE file.
+#++
+
+require "cli/version"
+require "cli/runner"

data/lib/cli/base.rb

@@ -0,0 +1,277 @@
+#--
+# Cloud Foundry 2012.02.03 Beta
+# Copyright (c) [2009-2012] VMware, Inc. All Rights Reserved.
+#
+# This product is licensed to you under the Apache License, Version 2.0 (the "License").
+# You may not use this product except in compliance with the License.
+#
+# This product includes a number of subcomponents with
+# separate copyright notices and license terms. Your use of these
+# subcomponents is subject to the terms and conditions of the
+# subcomponent's license, as noted in the LICENSE file.
+#++
+
+require 'highline'
+require 'optparse'
+
+module CF; module UAA end end
+
+module CF::UAA
+
+class Topic
+
+  class << self; attr_reader :synonyms end
+
+  def self.option_defs ; @option_defs || {} end
+  def self.commands; @commands || {} end
+  def self.topic(*args)
+    return @description if args.empty?
+    @synonyms = (args[0].split(' ') + args[1..-1]).map(&:downcase)
+    @description = args[0]
+  end
+
+  def self.define_option(key, *args)
+    @option_defs ||= {}
+    raise "conflicting option definition for #{key}" if @option_defs.key?(key) && @option_defs[key] != args
+    @option_defs[key] = args
+  end
+
+  def self.desc(template, desc, *options, &handler)
+    parts, argc = template.split(' '), 0
+    cmd = parts.each_with_object([]) { |p, o|
+      if p =~ /^\[/
+        argc = parts[-1] =~ /\.\.\.\]$/ ? -1 : parts.length - o.length
+        break o
+      end
+      o << p
+    }
+    cmd_key = cmd.join('_').to_sym
+    define_method(cmd_key, handler)
+    @commands ||= {}
+    @commands[cmd_key] = {parts: cmd, argc: argc, template: template, desc: desc, options: options}
+  end
+
+  def initialize(cli_class, options = {}, input = $stdin, output = $stdout)
+    @cli_class, @options, @input, @output = cli_class, options, input, output
+    @highline = HighLine.new(input, output)
+  end
+
+  def ask(prompt); @highline.ask("#{prompt}:  ") end
+  def ask_pwd(prompt); @highline.ask("#{prompt}:  ") { |q| q.echo = '*' } end
+  def say(msg); @output.puts(msg); msg end
+  def gripe(msg); @output.puts(msg) end
+  def opts; @options end
+
+  def terminal_columns
+    return @terminal_columns ||= 0 if @terminal_columns || !@output.tty?
+    cols = HighLine::SystemExtensions.terminal_size.first rescue 0
+    @terminal_columns = !cols || cols < 40 ? 0 : cols
+  end
+
+  def help_col_start
+    return @help_col_start ||= 35 if @help_col_start || terminal_columns == 0 || terminal_columns > 80
+    @help_col_start = terminal_columns / 2
+  end
+
+  def pp(obj, indent = 0, wrap = terminal_columns, label = nil)
+    case obj
+    when Array
+      if obj.empty? || !obj[0].is_a?(Hash) && !obj[0].is_a?(Array)
+        say_definition(indent, ("#{label}: " if label), Util.strlist(obj), nil, wrap)
+      else
+        say_definition(indent, "#{label}: ", nil, nil, wrap) if label
+        obj.each {|o| pp o, indent, wrap, '-' }
+      end
+    when Hash
+      say_definition(indent, label, nil, nil, wrap) if label
+      obj.each {|k, v| pp v, indent + 2, wrap, k.to_s}
+    when nil
+    else say_definition(indent, ("#{label}: " if label), obj.to_s, nil, wrap)
+    end
+    obj
+  end
+
+  def say_definition(indent, term, text = nil, start = help_col_start, wrap = terminal_columns)
+    cur = indent + (term ? term.length : 0)
+    indent < 1 ? @output.printf("%s", term) : @output.printf("%*c%s", indent, ' ', term)
+    if start.nil?
+      start = 2 if (start = indent + 4) > wrap
+    else
+      start = 2 if start > wrap
+      if cur < start
+        @output.printf("%*c", start - cur, ' ')
+      elsif cur > start
+        @output.printf("\n%*c", start, ' ')
+      end
+      cur = start
+    end
+    return @output.printf("\n") unless text && !text.empty?
+    text = text.dup
+    text.each_line do |line|
+      width = wrap == 0 ? 4096 : wrap - cur
+      line = line.chomp
+      while line.length > width
+        i = line.rindex(' ', width) || width
+        @output.printf("%s\n%*c", line[0..i - 1], start, ' ')
+        width = wrap == 0 ? 4096 : wrap - start
+        line = line[i..-1].strip
+      end
+      @output.printf("%s\n", line)
+      cur = start
+    end
+    nil
+  end
+
+  def opt_help(key, args)
+    raise "missing option definition for #{key}" unless args
+    long = short = desc = nil
+    args.each do |a|
+      case a
+      when /^-.$/ then short = a
+      when /^--.*/ then long = a
+      else desc = a
+      end
+    end
+    raise "option definition must include long form (--#{key})" unless long
+    [ short ? "#{short} | #{long}" : "#{long}", desc]
+  end
+
+  def opt_strs(opts)
+    opts.each_with_object([]) { |o, a|
+      @cli_class.option_defs[o].each { |d|
+        case d
+        when /^--\[no-\](\S+)/ then a << "--#{$1} --no-#{$1}"
+        when /^--(\S+)/ then a << "--#{$1}"
+        end
+      }
+    }.join(' ')
+  end
+
+  def say_cmd_helper(info, suffix = nil)
+    say_definition 2, info[:template], info[:desc]
+    info[:options].each do |o|
+      odef, desc = opt_help(o, @cli_class.option_defs[o])
+      say_definition help_col_start, "", desc ? "#{odef}, #{desc}" : odef
+    end
+    @output.print suffix
+  end
+
+  def say_command_help(args)
+    say ""
+    @cli_class.topics.each do |tpc|
+      tpc.commands.each do |k, v|
+        if args[0..v[:parts].length - 1] == v[:parts]
+          say_cmd_helper(v, "\n")
+          return "help command"
+        end
+      end
+    end
+    args = args.map(&:downcase)
+    @cli_class.topics.each { |tpc| return say_help(tpc) unless (args & tpc.synonyms).empty? }
+    gripe "No command or topic found to match: #{args.join(' ')}\n"
+  end
+
+  def say_help(topic = nil)
+    @output.print "\n#{@cli_class.overview}\n" unless topic
+    @cli_class.topics.each do |tpc|
+      next if topic && topic != tpc
+      @output.print "\n#{tpc.topic}\n"
+      tpc.commands.each { |k, v| say_cmd_helper v }
+    end
+    if topic || !@cli_class.global_options
+      @output.print("\n")
+      return topic ? "help topic" : "help"
+    end
+    @output.print "\nGlobal options:\n"
+    @cli_class.global_options.each do |o|
+      odef, desc = opt_help(o, @cli_class.option_defs[o])
+      say_definition 2, odef, desc
+    end
+    @output.print("\n")
+    "help"
+  end
+
+  def add_command(branches, parts, opts = nil)
+    if parts.empty?
+      return if opts.nil? || opts.empty?
+      return branches << {label: opt_strs(opts)}
+    end
+    if i = branches.find_index { |b| parts[0] == b[:label] }
+      parts.shift
+    else
+      branches << {label: parts.shift, sub: []}
+      i = -1
+    end
+    add_command(branches[i][:sub], parts, opts)
+  end
+
+  def print_tree(branches, indent)
+    return unless branches
+    branches.each do |b|
+      indent.times { @output.print "\t" };
+      @output.puts b[:label]
+      print_tree b[:sub], indent + 1
+    end
+  end
+
+  def say_commands
+    tree = {label: File.basename($0), sub: []}
+    @cli_class.topics.each {|t| t.commands.each {|k, v| add_command(tree[:sub], v[:parts].dup, v[:options])}}
+    add_command(tree[:sub], [], @cli_class.global_options)
+    @output.puts tree[:label]
+    print_tree(tree[:sub], 1)
+    "help commands"
+  end
+
+end
+
+class BaseCli
+
+  class << self
+    attr_reader :input, :output, :option_defs
+    attr_accessor :overview, :topics, :global_options
+  end
+
+  def self.preprocess_options(args, opts); end # to be implemented in subclass
+  def self.too_many_args(cmd); end # to be implemented in subclass
+
+  def self.run(args = ARGV)
+    @input ||= $stdin
+    @output ||= $stdout
+    @option_defs = {}
+    @output.string = "" if @output.respond_to?(:string)
+    args = args.split if args.respond_to?(:split)
+    @parser = OptionParser.new
+    opts = @topics.each_with_object({}) do |tpc, o|
+      tpc.option_defs.each do |k, optdef|
+        @parser.on(*optdef) { |v| o[k] = v }
+        @option_defs[k] = optdef
+      end
+    end
+    @parser.parse! args
+    preprocess_options(args, opts)
+    @topics.each do |tpc|
+      tpc.commands.each do |k, v|
+        next unless args[0..v[:parts].length - 1] == v[:parts]
+        args = args[v[:parts].length..-1]
+        if v[:argc] == -1
+          # variable args, leave args alone
+        elsif args.length > v[:argc]
+          too_many_args(v[:parts].dup)
+          return nil
+        elsif args.length < v[:argc]
+          (v[:argc] - args.length).times { args << nil }
+        end
+        return tpc.new(self, opts, @input, @output).send(k, *args)
+      end
+    end
+    @output.puts "#{File.basename($0)}: subcommand not found"
+  rescue Exception => e
+    @output.puts "#{File.basename($0)} error", "#{e.class}: #{e.message}", (e.backtrace if opts[:trace])
+  ensure
+    puts @output.string if opts[:trace] && @print_on_trace
+  end
+
+end
+
+end