aws-sdk-core 2.0.0.rc1

data/apis/source/swf-2012-01-25.paginators.json

@@ -0,0 +1,46 @@
+{
+  "pagination": {
+    "GetWorkflowExecutionHistory": {
+      "input_token": "nextPageToken",
+      "output_token": "nextPageToken",
+      "limit_key": "maximumPageSize",
+      "result_key": "events"
+    },
+    "ListActivityTypes": {
+      "input_token": "nextPageToken",
+      "output_token": "nextPageToken",
+      "limit_key": "maximumPageSize",
+      "result_key": "typeInfos"
+    },
+    "ListClosedWorkflowExecutions": {
+      "input_token": "nextPageToken",
+      "output_token": "nextPageToken",
+      "limit_key": "maximumPageSize",
+      "result_key": "executionInfos"
+    },
+    "ListDomains": {
+      "input_token": "nextPageToken",
+      "output_token": "nextPageToken",
+      "limit_key": "maximumPageSize",
+      "result_key": "domainInfos"
+    },
+    "ListOpenWorkflowExecutions": {
+      "input_token": "nextPageToken",
+      "output_token": "nextPageToken",
+      "limit_key": "maximumPageSize",
+      "result_key": "executionInfos"
+    },
+    "ListWorkflowTypes": {
+      "input_token": "nextPageToken",
+      "output_token": "nextPageToken",
+      "limit_key": "maximumPageSize",
+      "result_key": "typeInfos"
+    },
+    "PollForDecisionTask": {
+      "input_token": "nextPageToken",
+      "output_token": "nextPageToken",
+      "limit_key": "maximumPageSize",
+      "result_key": "events"
+    }
+  }
+}

data/aws-sdk-core.gemspec

@@ -0,0 +1,21 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'aws/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'aws-sdk-core'
+  spec.version       = Aws::VERSION
+  spec.summary       = 'AWS SDK Core'
+  spec.description   = 'Provides client libraries for AWS.'
+  spec.author        = 'Amazon Web Services'
+  spec.homepage      = 'http://github.com/aws/aws-sdk-core-ruby'
+  spec.license       = 'Apache 2.0'
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(spec|features)/})
+  spec.require_paths = ['lib', 'vendor/seahorse/lib']
+  spec.add_dependency('multi_json', '~> 1.0')
+  spec.add_dependency('multi_xml', '~> 0.5')
+  spec.add_dependency('builder', '~> 3.0')
+end

data/bin/aws.rb

@@ -0,0 +1,156 @@
+#!/usr/bin/env ruby
+
+root = File.dirname(File.dirname(__FILE__))
+$:.unshift(File.join(root, 'lib'))
+$:.unshift(File.join(root, 'vendor', 'seahorse', 'lib'))
+
+require 'rubygems'
+require 'optparse'
+require 'logger'
+
+def env_bool key, default
+  if ENV.key?(key)
+    !['0', 'false', 'no', 'off'].include?(ENV[key].downcase)
+  else
+    default
+  end
+end
+
+# setup default options, check ENV for most
+options = {
+  :repl => env_bool('AWSRB', nil),
+  :log => env_bool('AWSRB_LOG', true),
+  :color => env_bool('AWSRB_COLOR', true),
+  :debug => env_bool('AWSRB_DEBUG', false),
+  :load_paths => [],
+  :require => [],
+  :execute => [],
+}
+
+OptionParser.new do |opts|
+
+  opts.banner = "Usage: aws-rb [options]"
+
+  opts.on("--region NAME", "specify the AWS region, e.g. us-west-2") do |value|
+    options[:region] = value
+  end
+
+  opts.on("--repl REPL", "specify the repl environment, pry or irb") do |value|
+    options[:repl] = value
+  end
+
+  opts.on("-e 'command'", "one line of script. Several -e's allowed.") do |value|
+    options[:execute] << value
+    options[:log] = false unless options[:log_set]
+    options[:debug] = false unless options[:debug_set]
+  end
+
+  opts.on("-l", "--[no-]log", "log client requets, on by default") do |value|
+    options[:log] = value
+    options[:log_set] = true
+  end
+
+  opts.on("-c", "--[no-]color", "colorize request logging, on by default") do |value|
+    options[:color] = value
+  end
+
+  opts.on("-d", "--[no-]debug", "log HTTP wire traces, off by default") do |value|
+    options[:debug] = value
+    options[:debug_set] = true
+  end
+
+  opts.on("-Idirectory", Array, "specify $LOAD_PATH directory (may be used more than once)") do |values|
+    options[:load_paths] += values
+  end
+
+  opts.on("-rlibrary", Array, "require the library") do |values|
+    options[:require] += values
+  end
+
+  opts.on("-v", "--verbose", "enable client logging and HTTP wire tracing") do |value|
+    options[:log] = true
+    options[:log_set] = true
+    options[:debug] = true
+    options[:debug_set] = true
+  end
+
+  opts.on("-q", "--quiet", "disable client logging and HTTP wire tracing") do |value|
+    options[:log] = false
+    options[:log_set] = true
+    options[:debug] = false
+    options[:debug_set] = true
+  end
+
+  opts.on("-h", "--help") do
+    puts opts
+    exit
+  end
+
+end.parse!
+
+# amend the $LOAD_PATH
+options[:load_paths].each do |path|
+  $LOAD_PATH.unshift(path)
+end
+
+require 'aws-sdk-core'
+
+# configure the aws-sdk gem
+
+cfg = {}
+
+cfg[:region] = options[:region] if options[:region]
+
+if options[:log]
+  logger = Logger.new($stdout)
+  logger.formatter = proc {|severity, datetime, progname, msg| msg }
+  cfg[:logger] = logger
+end
+
+if options[:color]
+  cfg[:log_formatter] = Seahorse::Client::Logging::Formatter.colored
+end
+
+if options[:debug]
+  cfg[:http_wire_trace] = true
+end
+
+Aws.config = cfg
+
+options[:require].each do |library|
+  require(library)
+end
+
+unless options[:execute].empty?
+  eval(options[:execute].join("\n"))
+  exit
+end
+
+class PryNotAvailable < StandardError; end
+
+def run_with_pry
+  begin
+    require 'pry'
+  rescue LoadError
+    raise PryNotAvailable
+  end
+  Pry.config.prompt = [proc { "Aws> " }, proc { "Aws| " }]
+  Aws.pry
+end
+
+def run_with_irb
+  require 'irb'
+  IRB.start
+end
+
+case options[:repl]
+when 'pry' then run_with_pry
+when 'irb' then run_with_irb
+else
+  begin
+    run_with_pry
+  rescue PryNotAvailable
+    warn("Pry not available, falling back to irb")
+    run_with_irb
+  end
+end

data/doc-src/plugins/apis.rb

@@ -0,0 +1,205 @@
+root = File.expand_path(File.join(File.dirname(__FILE__), '..', '..'))
+$:.unshift(File.join(root, 'vendor', 'seahorse', 'lib'))
+$:.unshift(File.join(root, 'lib'))
+
+require 'aws-sdk-core'
+
+YARD::Tags::Library.define_tag('CONFIGURATION_OPTIONS', :seahorse_client_option)
+YARD::Tags::Library.define_tag('SERVICE', :service)
+YARD::Tags::Library.define_tag('API_VERSION', :api_version)
+
+YARD::Templates::Engine.register_template_path(File.join(File.dirname(__FILE__), '..', 'templates'))
+
+YARD::Parser::SourceParser.after_parse_list do
+  svc_apis.each do |svc_name, apis|
+    document_svc(svc_name, apis)
+  end
+end
+
+def svc_apis
+  Dir.glob('apis/source/*.json').inject({}) do |apis, path|
+    if matches = path.match(/^apis\/source\/(\w+)-(\d{4}-\d{2}-\d{2}).json$/)
+      api = load_api(path)
+      svc_name = api.metadata['service_class_name']
+      apis[svc_name] ||= []
+      apis[svc_name] << api
+    end
+    apis
+  end
+end
+
+def load_api(path)
+  Aws::Api::Translator.translate(
+    MultiJson.load(File.read(path), max_nesting: nil),
+    documentation: true,
+    errors: true)
+end
+
+def document_svc(svc_name, apis)
+  document_svc_helper(svc_name, apis)
+  document_svc_class(svc_name, apis)
+  apis.each do |api|
+    document_svc_api(svc_name, api)
+  end
+end
+
+def document_svc_helper(svc_name, apis)
+  method_name = svc_name.downcase
+  m = YARD::CodeObjects::MethodObject.new(YARD::Registry['Aws'], method_name)
+  m.scope = :class
+  m.parameters << ['options', '{}']
+  m.docstring = <<-DOC.strip
+Returns a new instance of {#{svc_name}}.
+@option (see Aws::#{svc_name}.new)
+@return (see Aws::#{svc_name}.new)
+  DOC
+end
+
+def document_svc_class(svc_name, apis)
+  namespace = YARD::Registry['Aws']
+  klass = YARD::CodeObjects::ClassObject.new(namespace, svc_name)
+  klass.superclass = YARD::Registry['Aws::Service']
+  klass.docstring = 'A service constructor.'
+  klass.docstring.add_tag(YARD::Tags::Tag.new(:service, svc_name))
+
+  svc = Aws.const_get(svc_name)
+
+  options = {}
+
+  svc.default_client_class.plugins.each do |plugin|
+    if p = YARD::Registry[plugin.name]
+      p.tags.each do |tag|
+        if tag.tag_name == 'seahorse_client_option'
+          option_name = tag.text.match(/.+(:\w+)/)[1]
+          option_text = "@option options " + tag.text.split("\n").join("\n  ")
+          options[option_name] = option_text +
+            "  See {#{plugin.name}} for more details."
+        end
+      end
+    end
+  end
+  options = options.sort_by { |k,v| k }.map(&:last).join("\n")
+
+  docstring = <<-DOCS.strip
+Constructs a versioned client for this service.
+@option options [String<YYYY-MM-DD>] :api_version ('#{svc.latest_api_version}')
+  The API version to use for this service.  Valid values include:
+
+  * #{svc.api_versions.join("\n  * ")}
+#{options}
+@return [#{svc.default_client_class.name}] Returns a versioned client.
+  By default, this will be a client for the latest API version.  Configure
+  the `:api_version` option to affect which client class is constructed.
+  Possible versioned clients are:
+
+  * #{svc.versioned_clients.map{ |k| "{#{k.name}}" }.join("\n  * ")}
+
+  DOCS
+
+  constructor = YARD::CodeObjects::MethodObject.new(klass, :new)
+  constructor.scope = :class
+  constructor.parameters << ['options', '{}']
+  constructor.docstring = docstring
+
+end
+
+def document_svc_api(svc_name, api)
+  namespace = YARD::Registry["Aws::#{svc_name}"]
+  name = "V#{api.version.gsub(/-/, '')}"
+  full_name = api.metadata['service_full_name']
+  klass = YARD::CodeObjects::ClassObject.new(namespace, name)
+  klass.superclass = YARD::Registry['Seahorse::Client::Base']
+  klass.docstring = "A client for the #{full_name} #{api.version} API."
+  klass.docstring.add_tag(YARD::Tags::Tag.new(:api_version, api.version))
+  api.operations.each do |method_name, operation|
+    document_svc_api_operation(svc_name, klass, method_name, operation)
+  end
+
+  constructor = YARD::CodeObjects::MethodObject.new(klass, :initialize)
+  constructor.scope = :instance
+  constructor.parameters << ['options', '{}']
+  constructor.docstring = "@option (see #{svc_name}.new)"
+end
+
+class Tabulator
+
+  def initialize
+    @tabs = []
+    @tab_contents = []
+  end
+
+  def tab(method_name, tab_name, &block)
+    tab_class = tab_name.downcase.gsub(/[^a-z]+/i, '-')
+    tab_id = "#{method_name.gsub(/_/, '-')}-#{tab_class}"
+    class_names = ['tab-contents', tab_class]
+    @tabs << [tab_id, tab_name]
+    @tab_contents << "<div class=\"#{class_names.join(' ')}\" id=\"#{tab_id}\">"
+    @tab_contents << yield
+    @tab_contents << '</div>'
+  end
+
+  def to_html
+    lines = []
+    lines << '<div class="tab-box">'
+    lines << '<ul class="tabs">'
+    @tabs.each do |tab_id, tab_name|
+      lines << "<li data-tab-id=\"#{tab_id}\">#{tab_name}</li>"
+    end
+    lines << '</ul>'
+    lines.concat(@tab_contents)
+    lines << '</div>'
+    lines.join
+  end
+  alias inspect to_html
+  alias to_str to_html
+  alias to_s to_html
+
+end
+
+def without_docs(value)
+  case value
+  when Hash
+    value.inject({}) do |h,(k,v)|
+      h[k] = without_docs(v) unless k == 'documentation'
+      h
+    end
+  when Array then value.map{ |v| without_docs(v) }
+  else value
+  end
+end
+
+def document_svc_api_operation(svc_name, client, method_name, operation)
+
+  documentor = Aws::Api::Documentor.new(svc_name.downcase, method_name, operation)
+
+  tabs = Tabulator.new.tap do |t|
+    t.tab(method_name, 'Formatting Example') do
+      "<pre><code>#{documentor.example}</code></pre>"
+    end
+    t.tab(method_name, 'Request Parameters') do
+      documentor.input
+    end
+    t.tab(method_name, 'Response Structure') do
+      documentor.output
+    end
+    t.tab(method_name, 'API Model') do
+      "<div class=\"api-src\"><pre><code class=\"json\">#{JSON.pretty_generate(without_docs(operation.to_hash), pretty: true, max_nesting: false)}</pre></code></div>"
+    end
+  end
+
+  errors = (operation.errors || []).map { |shape| shape.metadata['shape_name'] }
+  errors = errors.map { |e| "@raise [Errors::#{e}]" }.join("\n")
+
+  m = YARD::CodeObjects::MethodObject.new(client, method_name)
+  m.scope = :instance
+  m.parameters << ['params', '{}']
+  m.docstring = <<-DOCSTRING.strip
+<p>Calls the #{operation.name} operation.<p>
+#{documentor.api_ref(operation)}
+#{tabs}
+@param [Hash] params ({})
+@return [Seahorse::Client::Response]
+#{errors}
+DOCSTRING
+
+end

data/doc-src/templates/default/fulldoc/html/css/common.css

@@ -0,0 +1,90 @@
+
+/* AWS API operation tabs */
+
+ul.tabs {
+  list-style-type: none;
+  margin: 15px 0 0 0;
+  padding: 0 0 0 10px;
+  height: 26px;
+  clear: both;
+}
+
+ul.tabs li {
+  float: left;
+  border: 1px solid #c9c3ba;
+  background-color: #eee;
+  line-height: 25px;
+  height: 25px;
+  padding: 0px 5px;
+  margin: 0 0 0 3px;
+}
+ul.tabs li:hover {
+  cursor: pointer;
+  background-color: #ddd;
+}
+ul.tabs li.active {
+  background-color: #fff;
+  border-bottom: 2px solid #fff;
+}
+.tab-contents {
+  border: 1px solid #ccc;
+  padding: 0.5em;
+  width: 100%;
+}
+
+/* formatting for request parameters and response data */
+
+.params, .params .params {
+  background: url(../images/vline.png) repeat-y;
+  margin: 0;
+  padding: 0;
+}
+
+.params .params {
+  margin-left: 10px;
+}
+
+.params .param {
+  margin: 0;
+  padding: 0 12px;
+  line-height: 20px;
+  background: url(../images/node.png) no-repeat;
+}
+
+.params .param:last-child {
+  background: #fff url(../images/lastnode.png) no-repeat;
+}
+
+.entry {
+  font-family: monospace;
+  display: inline;
+  line-height: 20px;
+  padding: 0 4px;
+}
+
+.entry .key.required {
+  font-weight: bold;
+}
+
+/* documentation provided by the AWS service API reference docs */
+
+.api-ref {
+  margin: 0 0 0 1px;
+  padding-left: 15px;
+  color: #333;
+  border-left: 1px solid #c9c3ba;
+  overflow: hidden;
+}
+
+.params .api-ref {
+  border: none;
+}
+
+.api-src {
+  max-height: 400px;
+  overflow: auto;
+}
+
+pre.code .label {
+  color: #C5060B;
+}