aws-sdk-resources 2.0.12.pre → 2.0.13.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4ca487789f2a39ff784ba8b39432b8a59d94038c
-  data.tar.gz: ddf5b991bd762e79fc62a542e140a06f4fa10e9f
+  metadata.gz: ff2f764f68c866a503270c19514bf242b4792568
+  data.tar.gz: 67ab6b0a7031a0a0c3a03419a6f5ca01277bd386
 SHA512:
-  metadata.gz: 7ebe4e9108017edfc0d2eac908a5518b3440d584b576f4eec4e53325e60af98390375ef2731e07ced6c065e752effc9ce53fa08f0fdd2452915af063933f0493
-  data.tar.gz: 7827a636fbfe52562a591c977f62a0ace65bd148fd7a2871e5676218e3c6c3eea31017c83a1cfb118db53cb6a67a93dcf3ab80a8ecc96a9d4b1f7972b91902bc
+  metadata.gz: 9361ee57211a9e41cc6aabf7439057e96e58f24f0125eceb51370f84be1207237ad0ba394c3238ef89d5c46f7dbd6fc8eb114397c30975808fce80bf41fca309
+  data.tar.gz: ae03b019c1171424808fc8ce56701eff0e03af8f1e515d20e57748be68d2875c26b07d1f718214d629fdd4cf78fa7a92db12e2224634ca4682dae62a7cb544c0

data/lib/aws-sdk-resources/documenter.rb

@@ -11,6 +11,40 @@ module Aws
       autoload :ResourceOperationDocumenter, 'aws-sdk-resources/documenter/resource_operation_documenter'
       autoload :WaiterOperationDocumenter, 'aws-sdk-resources/documenter/waiter_operation_documenter'
 
+      class << self
+
+        def apply_customizations
+          document_s3_object_upload_file_additional_options
+        end
+
+        private
+
+        def document_s3_object_upload_file_additional_options
+          input = Aws::S3::Client.api.operation(:create_multipart_upload).input
+          opts = input.member_names - [:bucket, :key]
+          tags = opts.map do |opt|
+            shape = input.member(opt)
+            type = case shape
+            when Seahorse::Model::Shapes::Structure then 'Structure'
+            when Seahorse::Model::Shapes::List then 'Array'
+            when Seahorse::Model::Shapes::Map then 'Hash'
+            when Seahorse::Model::Shapes::String then 'String'
+            when Seahorse::Model::Shapes::Integer then 'Integer'
+            when Seahorse::Model::Shapes::Float then 'Float'
+            when Seahorse::Model::Shapes::Boolean then 'Boolean'
+            when Seahorse::Model::Shapes::Timestamp then 'Time'
+            when Seahorse::Model::Shapes::Blob then 'IO'
+            else
+              raise "unhandled shape class `#{shape.class.name}'"
+            end
+            "@option options [#{type}] :#{opt} #{shape.documentation}"
+          end
+          tags = YARD::DocstringParser.new.parse(tags).to_docstring.tags
+          m = YARD::Registry['Aws::S3::Object#upload_file']
+          tags.each { |tag| m.add_tag(tag) }
+        end
+
+      end
     end
   end
 end

data/lib/aws-sdk-resources/operations.rb

@@ -3,7 +3,7 @@ module Aws
     module Operations
 
       # Base class for operations. An operation is any object that responds
-      # to {#call} receiving a hash of options including:
+      # to `#call` receiving a hash of options including:
       #
       # * `:resource` - The resource object the operation is invoked against.
       # * `:args` - An array of arguments given by the caller

data/lib/aws-sdk-resources/services/s3/object.rb

@@ -65,12 +65,20 @@ module Aws
 
       # Uploads a file from disk to the current object in S3.
       #
-      # @example
-      #
+      #     # small files are uploaded in a single API call
       #     obj.upload_file('/path/to/file')
       #
+      # Files larger than `:multipart_threshold` are uploaded using the
+      # Amazon S3 multipart upload APIs.
+      #
+      #     # large files are automatically split into parts
+      #     # and the parts are uploaded in parallel
+      #     obj.upload_file('/path/to/very_large_file')
+      #
       # @param [String,Pathname,File,Tempfile] source A file or path to a file
       #   on the local file system that should be uploaded to this object.
+      #   If you pass an open file object, then it is your responsibility
+      #   to close the file object once the upload completes.
       #
       # @option options [Integer] :multipart_threshold (15728640) Files larger
       #   than `:multipart_threshold` are uploaded using the S3 multipart APIs.
@@ -82,13 +90,15 @@ module Aws
       #   method that returns the failures that caused the upload to be
       #   aborted.
       #
-      # @return [void]
+      # @return [Boolean] Returns `true` when the object is uploaded
+      #   without any errors.
       #
       def upload_file(source, options = {})
         uploader = FileUploader.new(
           multipart_threshold: options.delete(:multipart_threshold),
           client: client)
         uploader.upload(source, options.merge(bucket: bucket_name, key: key))
+        true
       end
 
     end

data/lib/aws-sdk-resources/services/s3/public_url.rb

@@ -13,9 +13,9 @@ module Aws
         # @option options [required, String] :object_key Key of the object
         #   to generate a URL for.
         #
-        # @param [Boolean] :force_path_style (false) When `true`, the bucket
-        #   name will always be part of the URI path. When `false`, DNS
-        #   compatible bucket names will be the endpoint host subdomain.
+        # @option options [Boolean] :force_path_style (false) When `true`,
+        #   the bucket name will always be part of the URI path. When `false`,
+        #   DNS compatible bucket names will be the endpoint host subdomain.
         #
         #       # path style
         #       "https://s3.amazonaws.com/bucket-name/key"

data/lib/aws-sdk-resources/validator/dsl.rb

@@ -56,8 +56,7 @@ module Aws
 
         # Recursively lints the resource definition hash against the given
         # api.
-        # @param [Hash] definition
-        # @param [Hash] api
+        # @param [Context] context
         # @return [Array<String>] Returns an array of schema validation errors.
         #   Returns an empty array if there are no errors.
         def lint(context)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-resources
 version: !ruby/object:Gem::Version
-  version: 2.0.12.pre
+  version: 2.0.13.pre
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-04 00:00:00.000000000 Z
+date: 2014-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.0.12
+        version: 2.0.13
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.0.12
+        version: 2.0.13
 description: Provides resource-oriented abstractions for AWS.
 email: 
 executables: []