aws-sdk-resources 2.0.6.pre → 2.0.7.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1836c23ab216964624f76b4e9d5897c005cdb922
-  data.tar.gz: a4c93137ebb9ed5f7a2a5b241e934602f5212a94
+  metadata.gz: d5e78644cbc27978c51cd6615a58fc773be80a38
+  data.tar.gz: 9a99500defb2563b7069aadbcadb7e7300ecb8ed
 SHA512:
-  metadata.gz: 62c9ab0d1fac25872ddbbc823f8f4c770886fb589c201142a63063e45402eb3b23cce44aea07c082366ce1f5d5175ee2d2ed86a5833b53059b3e326f589cf1c0
-  data.tar.gz: 58b60ec8a12570d5c087e0c7a4bd0593deb7a0dc80cb4a8726aed4ec48fcefd33ea693a3829d47fdb54cf399dbdcfd292dcbccc72b69b3e967e3ec45648ef4b2
+  metadata.gz: 135e7a7f1d5b9433a0c513775cb12e7dc8f35a42680329af082c853b8a3fc484c6cf04a3a5d8b9dcfd5f837d4768ea4e80b9c8197243c93df557533950f658c1
+  data.tar.gz: 3869b525d250dc45c62498567cc47ab3c2c29a62994c968d22dfe0b4501a79c0eb44e82b32f5065ee5e5acc7b0f7cb0ef72e37924b68938132b866dc2a40a275

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

@@ -32,7 +32,7 @@ module Aws
     #
     # Batches provide operations that operate on the entire batch. These
     # operations are only defined for resources where the AWS API accepts
-    # multiple inputs. This means a batch operation for n elements will
+    # multiple inputs. This means a batch operation for n resources will
     # only make one request.
     #
     # Resource classes document each of their own batch operations.
@@ -41,7 +41,6 @@ module Aws
     class Batch
 
       include Enumerable
-      extend OperationMethods
 
       # @param [Array<Resource>] resources
       # @option options [Seahorse::Client::Response] :response
@@ -95,6 +94,40 @@ module Aws
         "#<#{self.class.name} resources=#{@resources}>"
       end
 
+      # @api private
+      def respond_to?(method_name, *args)
+        if !empty? && batch_method?(method_name)
+          true
+        else
+          super
+        end
+      end
+
+
+      # @api private
+      def method_missing(method_name, *args, &block)
+        if respond_to?(method_name)
+          invoke_batch_operation(method_name, args, block) unless empty?
+        else
+          super
+        end
+      end
+
+      private
+
+      def batch_method?(method_name)
+        resource_class.batch_operation_names.include?(method_name.to_sym)
+      end
+
+      def resource_class
+        @resources.first.class
+      end
+
+      def invoke_batch_operation(method_name, args, block)
+        operation = resource_class.batch_operation(method_name)
+        operation.call(resource:self, args:args, block:block)
+      end
+
     end
   end
 end

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

@@ -56,7 +56,7 @@ module Aws
           yield(resource) if block_given?
           resource
         end
-        resource_class::Batch.new(resources, options)
+        Batch.new(resources, options)
       end
 
       def build_one(identifiers, options)

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

@@ -4,8 +4,8 @@ module Aws
 
       include Enumerable
 
-      # @param [EnumerateResourceOperation] operation
-      # @option (see EnumerateResourceOperation#call)
+      # @param [HasManyOperation] operation
+      # @option (see HasManyOperation#call)
       # @api private
       def initialize(operation, options)
         @operation = operation
@@ -78,13 +78,13 @@ module Aws
         if count == 1
           limit(1).to_a.first
         else
-          resource_class::Batch.new(limit(count).to_a)
+          Batch.new(limit(count).to_a)
         end
       end
 
       # @api private
       def respond_to?(method_name, *args)
-        if resource_class::Batch.instance_methods.include?(method_name.to_sym)
+        if resource_class.batch_operation_names.include?(method_name.to_sym)
           true
         else
           super

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

@@ -24,8 +24,7 @@ module Aws
           define_batch_actions(namespace, resource, definition['batchActions'] || {})
           define_waiters(namespace, resource, definition['waiters'] || {})
           define_has_many(namespace, resource, definition['hasMany'] || {})
-          define_has_some(namespace, resource, definition['hasSome'] || {})
-          define_has_one(namespace, resource, definition['hasOne'] || {})
+          define_belongs_to(namespace, resource, definition['belongsTo'] || {})
           define_data_attributes(namespace, resource, definition)
           define_subresources(namespace, resource, definition['subResources'] || {})
         end
@@ -43,9 +42,6 @@ module Aws
             resource_class.add_identifier(underscore(identifier['name']))
           end
           namespace.const_set(name, resource_class)
-          unless name == 'Resource'
-            resource_class.const_set(:Batch, Class.new(Batch))
-          end
         end
       end
 
@@ -72,7 +68,7 @@ module Aws
       end
 
       def subresource(namespace, type, identifiers)
-        Operations::ReferenceOperation.new(builder: define_builder(namespace, {
+        Operations::BelongsToOperation.new(builder: define_builder(namespace, {
           'type' => type,
           'identifiers' => identifiers.map { |source, target|
             {
@@ -87,7 +83,7 @@ module Aws
       def define_top_level_references(namespace)
         top_level = Set.new(resource_definitions.keys)
         each_resource_class(namespace) do |resource, definition|
-          unless resource.identifiers.count == 1
+          unless resource.identifiers.count <= 1
             top_level.delete(resource.resource_name)
           end
           ((definition['subResources'] || {})['resources'] || {}).each do |child|
@@ -105,7 +101,7 @@ module Aws
         batch_actions.each do |name, definition|
           method_name = underscore(name)
           operation = build_operation(namespace, resource, definition)
-          resource::Batch.add_operation(method_name, operation)
+          resource.add_batch_operation(method_name, operation)
         end
       end
 
@@ -131,7 +127,7 @@ module Aws
 
       def define_load(namespace, resource, definition)
         return unless definition
-        resource.load_operation = Operations::DataOperation.new(
+        resource.load_operation = Operations::LoadOperation.new(
           request: define_request(definition['request']),
           path: underscore(definition['path']),
           source: source(definition),
@@ -164,28 +160,9 @@ module Aws
         )
       end
 
-      def build_data_operation(namespace, resource, definition)
-        plural = definition['path'].include?('[')
-        source = source(definition)
-        if plural
-          Operations::EnumerateDataOperation.new(
-            request: define_request(definition['request']),
-            path: underscore(definition['path']),
-            source: source,
-            limit_key: limit_key(resource, definition)
-          )
-        else
-          Operations::DataOperation.new(
-            request: define_request(definition['request']),
-            path: underscore(definition['path']),
-            source: source
-          )
-        end
-      end
-
       def build_resource_operation(namespace, resource, definition)
         builder = define_builder(namespace, definition['resource'])
-        if path = definition['path']
+        if path = definition['resource']['path']
           source = underscore(path)
           builder.sources << BuilderSources::ResponsePath.new(source, :data)
         end
@@ -198,11 +175,11 @@ module Aws
 
       def build_enumerate_resource_operation(namespace, resource, definition)
         builder = define_builder(namespace, definition['resource'])
-        if path = definition['path']
+        if path = definition['resource']['path']
           source = underscore(path)
           builder.sources << BuilderSources::ResponsePath.new(source, :data)
         end
-        Operations::EnumerateResourceOperation.new(
+        Operations::HasManyOperation.new(
           request: define_request(definition['request']),
           builder: builder,
           source: source(definition),
@@ -258,25 +235,19 @@ module Aws
         end
       end
 
-      def define_has_some(namespace, resource, has_some)
+      def define_belongs_to(namespace, resource, has_some)
         has_some.each do |name, definition|
           define_reference(namespace, resource, name, definition)
         end
       end
 
-      def define_has_one(namespace, resource, has_one)
-        has_one.each do |name, definition|
-          define_reference(namespace, resource, name, definition)
-        end
-      end
-
       def define_reference(namespace, resource, name, definition)
         builder = define_builder(namespace, definition['resource'])
-        if path = definition['path']
+        if path = definition['resource']['path']
           source = underscore(path)
           builder.sources << BuilderSources::DataMember.new(source, :data)
         end
-        operation = Operations::ReferenceOperation.new(
+        operation = Operations::BelongsToOperation.new(
           builder: builder,
           source: source(definition))
         resource.add_operation(underscore(name), operation)

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

@@ -5,11 +5,9 @@ module Aws
     class Documenter
 
       autoload :BaseOperationDocumenter, 'aws-sdk-resources/documenter/base_operation_documenter'
-      autoload :DataOperationDocumenter, 'aws-sdk-resources/documenter/data_operation_documenter'
-      autoload :EnumerateDataOperationDocumenter, 'aws-sdk-resources/documenter/enumerate_data_operation_documenter'
-      autoload :EnumerateResourceOperationDocumenter, 'aws-sdk-resources/documenter/enumerate_resource_operation_documenter'
+      autoload :BelongsToOperationDocumenter, 'aws-sdk-resources/documenter/belongs_to_operation_documenter'
+      autoload :HasManyOperationDocumenter, 'aws-sdk-resources/documenter/has_many_operation_documenter'
       autoload :OperationDocumenter, 'aws-sdk-resources/documenter/operation_documenter'
-      autoload :ReferenceOperationDocumenter, 'aws-sdk-resources/documenter/reference_operation_documenter'
       autoload :ResourceOperationDocumenter, 'aws-sdk-resources/documenter/resource_operation_documenter'
       autoload :WaiterOperationDocumenter, 'aws-sdk-resources/documenter/waiter_operation_documenter'
 

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

@@ -62,7 +62,7 @@ module Aws
         #   API operation called. Returns `nil` if this operation does not make
         #   any API requests.
         attr_reader :api_request
- 
+
         # @return [Array<Resources::RequestParams::Base>, nil] Returns the
         #   parameters this operation binds to the made request. Returns `nil`
         #   if this operation does not make a request.
@@ -83,10 +83,13 @@ module Aws
         # Constructs and returns a new YARD method object for this operation.
         # @return [YARD::CodeObject::MethodObject]
         def method_object
-          m = YARD::CodeObjects::MethodObject.new(yard_class, operation_name)
+          if m = YARD::Registry[@resource_class.name + "##{operation_name}"]
+          else
+            m = YARD::CodeObjects::MethodObject.new(yard_class, operation_name)
+            m.docstring = docstring
+            m.parameters = parameters
+          end
           m.scope = :instance
-          m.parameters = parameters
-          m.docstring = docstring
           if source
             m.source_type = :json
             m.source = source.format
@@ -106,7 +109,7 @@ module Aws
           if option_tags.empty?
             []
           else
-            [['params', '{}']]
+            [['options', '{}']]
           end
         end
 
@@ -137,7 +140,7 @@ module Aws
               end
               docstring = member_shape.documentation
               req = ' **`required`** &mdash; ' if required.include?(member_name)
-              tags << "@option params [#{param_type(member_shape)}] :#{member_name} #{req}#{docstring}"
+              tags << "@option options [#{param_type(member_shape)}] :#{member_name} #{req}#{docstring}"
             end
             tags = tags.join("\n")
             YARD::DocstringParser.new.parse(tags).to_docstring.tags

data/lib/aws-sdk-resources/documenter/{reference_operation_documenter.rb → belongs_to_operation_documenter.rb}

@@ -1,7 +1,7 @@
 module Aws
   module Resources
     class Documenter
-      class ReferenceOperationDocumenter < BaseOperationDocumenter
+      class BelongsToOperationDocumenter < BaseOperationDocumenter
 
         def docstring
           docs = []

data/lib/aws-sdk-resources/documenter/{enumerate_resource_operation_documenter.rb → has_many_operation_documenter.rb}

@@ -1,7 +1,7 @@
 module Aws
   module Resources
     class Documenter
-      class EnumerateResourceOperationDocumenter < BaseOperationDocumenter
+      class HasManyOperationDocumenter < BaseOperationDocumenter
 
         def docstring
           super + ' ' +<<-DOCSTRING.lstrip

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

@@ -40,7 +40,7 @@ module Aws
           idv = target_resource_class_name.downcase + '-' + id.gsub('_', '-')
           tag = []
           tag << "@example Basic usage"
-          tag << "  #{resp_variable} = #{variable_name}.#{operation_name}(params)"
+          tag << "  #{resp_variable} = #{variable_name}.#{operation_name}(options)"
           if plural?
             tag << "  #{resp_variable}.map(&:#{id})"
             tag << "  #=> [#{idv.inspect}, ...]"

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

@@ -31,9 +31,36 @@ module Aws
         @operations.keys
       end
 
+      # @param [Symbol] name
+      # @return [Operation] Returns the named batch operation.
+      # @raise [Errors::UnknownOperationError]
+      def batch_operation(name)
+        @batch_operations[name.to_sym] or
+          raise Errors::UnknownOperationError.new(name)
+      end
+
+      # @param [Symbol] method_name
+      # @param [Operation] operation
+      # @return [void]
+      def add_batch_operation(method_name, operation = nil, &definition)
+        operation = definition if block_given?
+        @batch_operations[method_name.to_sym] = operation
+      end
+
+      # @return [Hash]
+      def batch_operations(&block)
+        @batch_operations.dup
+      end
+
+      # @return [Array<Symbol>]
+      def batch_operation_names
+        @batch_operations.keys
+      end
+
       # @api private
       def inherited(subclass)
         subclass.send(:instance_variable_set, "@operations", {})
+        subclass.send(:instance_variable_set, "@batch_operations", {})
       end
 
       private

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

@@ -22,14 +22,6 @@ module Aws
         # @return [Source, nil]
         attr_reader :source
 
-        # @option options[required,Resource] :resource
-        # @option options[required,Array<Mixed>] :args
-        # @option options[Proc] :block
-        # @return [Mixed]
-        def call(options = {})
-          raise NotImplementedError
-        end
-
       end
 
       # Makes an API request using the resource client, returning the client
@@ -53,7 +45,7 @@ module Aws
 
       end
 
-      class DataOperation < Operation
+      class LoadOperation < Operation
 
         # @option options [required, Request] :request
         # @option options [required, String<JMESPath>] :path
@@ -79,46 +71,6 @@ module Aws
 
       end
 
-      class EnumerateDataOperation < DataOperation
-
-        # @option options [required, Request] :request
-        # @option options [required, String<JMESPath>] :path
-        # @option options [Symbol] :limit_key
-        def initialize(options = {})
-          @limit_key = options[:limit_key]
-          super
-        end
-
-        # @option (see Base#call)
-        # @option options [Integer] :limit (nil)
-        # @return [Enumerator]
-        def call(options)
-          if options[:limit]
-            enum_for(:limited_each, options[:limit], options)
-          else
-            enum_for(:each, options)
-          end
-        end
-
-        private
-
-        def each(options, &block)
-          @request.call(options).each do |response|
-            extract(response).each(&block)
-          end
-        end
-
-        def limited_each(limit, options, &block)
-          yielded = 0
-          each(options) do |value|
-            yield(value)
-            yielded += 1
-            break if yielded == limit
-          end
-        end
-
-      end
-
       class ResourceOperation < Operation
 
         # @option options [required, Request] :request
@@ -139,7 +91,7 @@ module Aws
 
       end
 
-      class EnumerateResourceOperation < ResourceOperation
+      class HasManyOperation < ResourceOperation
 
         # @option options [required, Request] :request
         # @option options [required, Builder] :builder
@@ -204,7 +156,7 @@ module Aws
 
       end
 
-      class ReferenceOperation < Base
+      class BelongsToOperation < Base
 
         # @option options [required, Builder] :builder
         def initialize(options = {})

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

@@ -91,7 +91,7 @@ module Aws
         #   this class.
         attr_accessor :client_class
 
-        # @return [Operations::DataOperation, nil]
+        # @return [Operations::LoadOperation, nil]
         attr_accessor :load_operation
 
         # @return [Array<Symbol>]

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

@@ -1,3 +1,5 @@
+require 'uri'
+
 module Aws
   module S3
     class Bucket
@@ -26,6 +28,23 @@ module Aws
         delete
       end
 
+      # @return [String] the URL for this bucket.
+      def url
+        url = URI.parse(client.config.endpoint.to_s)
+        if dns_compatible?(url.scheme) && !client.config.force_path_style
+          url.host = "#{name}.#{url.host}"
+        else
+          url.path = "/#{name}"
+        end
+        url.to_s
+      end
+
+      private
+
+      def dns_compatible?(scheme)
+        Plugins::S3BucketDns.dns_compatible?(name, scheme == 'https')
+      end
+
     end
   end
 end

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

@@ -4,15 +4,17 @@ module Aws
 
       alias_method :basic_complete, :complete
 
-      # Completes the MultipartUpload.
+      # Completes the upload, requires a list of completed parts. You can
+      # provide the list of parts with `:part_number` and `:etag` values.
       #
-      # To complete a multipart upload, a list of part numbers and their
-      # ETags is required.
+      #     upload.complete(multipart_upload: { parts: [
+      #       { part_number: 1, etag:'etag1' },
+      #       { part_number: 2, etag:'etag2' },
+      #       ...
+      #     ]})
       #
-      #     upload.complete(multipart_upload: { parts: part_list })
-      #
-      # You can pass `:compute_parts => true` and the {Client#list_parts}
-      # method will be called to generate the part list.
+      # Alternatively, you can pass **`compute_parts: true`** and the part
+      # list will be computed by calling {Client#list_parts}.
       #
       #     upload.complete(compute_parts: true)
       #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-resources
 version: !ruby/object:Gem::Version
-  version: 2.0.6.pre
+  version: 2.0.7.pre
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-30 00:00:00.000000000 Z
+date: 2014-11-06 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.6
+        version: 2.0.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.0.6
+        version: 2.0.7
 description: Provides resource-oriented abstractions for AWS.
 email: 
 executables: []
@@ -36,11 +36,10 @@ files:
 - lib/aws-sdk-resources/collection.rb
 - lib/aws-sdk-resources/definition.rb
 - lib/aws-sdk-resources/documenter/base_operation_documenter.rb
+- lib/aws-sdk-resources/documenter/belongs_to_operation_documenter.rb
 - lib/aws-sdk-resources/documenter/data_operation_documenter.rb
-- lib/aws-sdk-resources/documenter/enumerate_data_operation_documenter.rb
-- lib/aws-sdk-resources/documenter/enumerate_resource_operation_documenter.rb
+- lib/aws-sdk-resources/documenter/has_many_operation_documenter.rb
 - lib/aws-sdk-resources/documenter/operation_documenter.rb
-- lib/aws-sdk-resources/documenter/reference_operation_documenter.rb
 - lib/aws-sdk-resources/documenter/resource_operation_documenter.rb
 - lib/aws-sdk-resources/documenter/waiter_operation_documenter.rb
 - lib/aws-sdk-resources/documenter.rb

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

@@ -1,50 +0,0 @@
-module Aws
-  module Resources
-    class Documenter
-      class EnumerateDataOperationDocumenter < BaseOperationDocumenter
-
-        def docstring
-          super + ' ' + <<-DOCSTRING.lstrip
-Returns an enumerator that yields #{operation_name.gsub('_', ' ')}.
-No API requests are made until you call an enumerable method.
-{#{called_operation}} will be called multiple times until all results
-have been yielded.
-          DOCSTRING
-        end
-
-        def return_type
-          ["Enumerator<#{path_type}>"]
-        end
-
-        def return_message
-          msg = "Returns an enumerator that yields #{operation_name.gsub('_', ' ')}."
-          msg << data_members
-          msg
-        end
-
-        def data_members
-          if path_shape.type == 'structure'
-            msg = "\nEnumerated values have the following properties:\n"
-            path_shape.member_names.each do |name|
-              msg << "\n* `#{name}`"
-            end
-            msg
-          else
-            ''
-          end
-        end
-
-        def example_tags
-          tag = <<-EXAMPLE.strip
-@example Enumerate all #{operation_name}
-  #{variable_name}.#{operation_name}.each do |data|
-    # ...
-  end
-          EXAMPLE
-          YARD::DocstringParser.new.parse(tag).to_docstring.tags
-        end
-
-      end
-    end
-  end
-end