aws-sdk-resources 2.0.10.pre → 2.0.11.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d46de5c7d6317b5fd48fd9e83b73032fe068a869
-  data.tar.gz: b4ab6d12b99852e7019bae4b88c97f3eece513bf
+  metadata.gz: c40fdd4d2650569c8c2c171fc78ff3b028bcca01
+  data.tar.gz: eaa5e8d378d80948885606de523ab83fa48cd1fa
 SHA512:
-  metadata.gz: 6be0b745b9c9d6a4ec4f25a93fa2b9272692d28da54cd834bf355e4056f5b6e8371f578eaae9d991ec6ec67582b4cc02d5ca3e779403050b7d78bb03b141901d
-  data.tar.gz: 073755fa59df54d46d2260ec9e7161930f93e7c06e95241880d7af448cb494214e04f32351adb31fc2e7439a1d424c17efb0345c8ebb9ea0d9f35a99bf62b444
+  metadata.gz: 0b28aff2fd2739d2412ff3b259a63cf283477485fdcaa45b67d10e5b11d19fa732a636f5efbfdb9b6d9f64590c2e5df42bfc31f358e9936638df63f915fdda5f
+  data.tar.gz: baf2c5ba95436817c23af6caa2bbc5576591ea8e03dbd245479f72612a50514546fd1ff171e52e33990750521728948124df11ce5d5c87c5c64a89a0545caeb5

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

@@ -1,5 +1,3 @@
-require 'jmespath'
-
 module Aws
   module Resources
     module BuilderSources
@@ -118,11 +116,7 @@ module Aws
 
         # @option [required, Seahorse::Client::Response] :response
         def extract(options)
-          if source == '$'
-            response(options).data
-          else
-            JMESPath.search(source, response(options).data)
-          end
+          JMESPath.search(source, response(options).data)
         end
 
         private

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

@@ -236,7 +236,7 @@ module Aws
         end
 
         def resolve_shape(shape, path)
-          if path != '$'
+          if path != '@'
             shape = path.scan(/\w+|\[.*?\]/).inject(shape) do |shape, part|
               if part[0] == '['
                 shape.member

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

@@ -1,5 +1,3 @@
-require 'jmespath'
-
 module Aws
   module Resources
     module Operations
@@ -66,7 +64,7 @@ module Aws
         private
 
         def extract(resp)
-          @path == '$' ? resp.data : JMESPath.search(@path, resp.data)
+          JMESPath.search(@path, resp.data)
         end
 
       end

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

@@ -1,96 +1,187 @@
-require 'multi_json'
 require 'json-schema'
 require 'aws-sdk-resources/validator/context'
+require 'aws-sdk-resources/validator/dsl'
+require 'aws-sdk-resources/validator/path_resolver'
 require 'aws-sdk-resources/validator/rule'
-require 'aws-sdk-resources/validator/shape_validator'
-require 'aws-sdk-resources/validator/identifier_validator'
 require 'aws-sdk-resources/validator/operation_validator'
 
 module Aws
   module Resources
     module Validator
 
-      # @api private
-      RULES = []
-
-      # @api private
-      SCHEMA_PATH = File.expand_path(File.join([
-        File.dirname(__FILE__), '..', '..', 'resources.schema.json'
-      ]))
-
-      class << self
-
-        def match(pattern, &block)
-          RULES << Rule.new(pattern, &block)
-        end
-
-        # @param [Hash] definition
-        # @param [Hash] api
-        # @return [Array<String>]
-        def validate(definition, api)
-          errors = apply_schema(definition)
-          errors = lint('#', definition, definition, api) if errors.empty?
-          errors
-        end
-
-        private
-
-        # Validates the resource definition document against the JSON
-        # schema for resources.
-        # @param [Hash] definition
-        # @return [Array<String>] Returns an array of schema validation errors.
-        #   Returns an empty array if there are no errors.
-        def apply_schema(definition)
-          schema = MultiJson.load(File.read(SCHEMA_PATH))
-          JSON::Validator.fully_validate(schema, definition)
-        end
-
-        # Recursively lints the resource definition hash against the given
-        # api.
-        # @param [Hash] definition
-        # @param [Hash] api
-        # @return [Array<String>] Returns an array of schema validation errors.
-        #   Returns an empty array if there are no errors.
-        def lint(prefix, node, definition, api, errors = [])
-          lint_node(prefix, node, definition, api, errors)
-          case node
-          when Hash
-            node.each do |key, value|
-              lint("#{prefix}/#{key}", value, definition, api, errors)
-            end
-          when Array
-            node.each.with_index do |value, index|
-              lint("#{prefix}/#{index}", value, definition, api, errors)
-            end
+      extend Validator::DSL
+
+      # identifiers_may_not_be_prefixed_by_their_resource_name
+      match('#/resources/(\w+)/identifiers/\d+/name') do |c, matches|
+        resource_name = matches[1]
+        if c.value.match(/^#{resource_name}/)
+          c.error("#{c.path} must not be prefixed with '#{resource_name}'")
+        end
+      end
+
+      # identifiers_must_have_unique_names
+      match('#/resources/\w+/identifiers') do |c|
+        identifiers = c.value.map { |v| v['name'] }
+        identifiers.each.with_index do |identifier, n|
+          unless identifiers.count(identifier) == 1
+            c.error("#{c.path}/#{n}/name must be uniq within #{c.path}/*/name")
           end
-          errors
         end
+      end
 
-        def lint_node(path, value, definition, api, errors)
-          RULES.each do |rule|
-            if rule.applies?(path)
-              errors.concat(rule.validate(path, value, definition, api))
+      # identifiers_with_memberName_require_the_resource_to_have_a_shape
+      match('#/resources/(\w+)/identifiers/(\d+)/memberName') do |c, matches|
+        resource_name = matches[1]
+        shape_path = "#/resources/#{resource_name}/shape"
+        unless c.definition['resources'][resource_name]['shape']
+          c.error("#{c.path} requires #{shape_path} to be set")
+        end
+      end
+
+      # identifiers_with_memberName_require_the_resource_shape_to_have_that_member
+      match('#/resources/(\w+)/identifiers/(\d+)/memberName') do |c, matches|
+        resource_name = matches[1]
+        shape_path = "#/resources/#{resource_name}/shape"
+        shape_name = c.definition['resources'][resource_name]['shape']
+        if
+          shape_name &&
+          c.api['shapes'][shape_name] &&
+          c.api['shapes'][shape_name]['type'] == 'structure' &&
+          !c.api['shapes'][shape_name]['members'].key?(c.value)
+        then
+          c.error("#{c.path} is not defined at api#/shapes/#{shape_name}/members/#{c.value}")
+        end
+      end
+
+      # shape_must_be_defined_in_the_api
+      match('#/resources/\w+/shape') do |c|
+        unless c.api['shapes'][c.value]
+          c.error("#{c.path} not found at api#/shapes/#{c.value}")
+        end
+      end
+
+      # shape_must_be_a_structure
+      # load_requires_shape_to_be_a_structure
+      match('#/resources/\w+/shape') do |c|
+        shape = c.api['shapes'][c.value]
+        if shape && shape['type'] != 'structure'
+          c.error("#{c.path} must resolve to a structure")
+        end
+      end
+
+      # load_requires_shape_to_be_set
+      match('#/resources/(\w+)/load') do |c, matches|
+        resource = matches[1]
+        unless c.definition['resources'][resource]['shape']
+          c.error("#{c.path} requires #/resources/#{resource}/shape to be set")
+        end
+      end
+
+
+      # load_operation_must_exist
+      # TODO : add assertions for service/actions, service/hasMany, actions, etc
+      match(*%w(
+        #/service/actions/\w+/request/operation
+        #/service/hasMany/\w+/request/operation
+        #/resources/\w+/load/request/operation
+        #/resources/\w+/actions/\w+/request/operation
+        #/resources/\w+/batchActions/\w+/request/operation
+        #/resources/\w+/hasMany/\w+/request/operation
+      )) do |c|
+        unless c.api['operations'][c.value]
+          c.error("#{c.path} is set but is not defined at api#/operations/#{c.value}")
+        end
+      end
+
+      # load_operation_must_accept_input_if_params_given
+      match(*%w(
+        #/service/actions/\w+/request
+        #/service/hasMany/\w+/request
+        #/resources/\w+/load/request
+        #/resources/\w+/actions/\w+/request
+        #/resources/\w+/batchActions/\w+/request
+        #/resources/\w+/hasMany/\w+/request
+      )) do |c|
+        # ...
+      end
+
+      # load_path_must_resolve_to_shape
+      match('#/resources/(\w+)/load/path') do |c, matches|
+        operation_name =
+          c.definition['resources'][matches[1]]['load']['request']['operation']
+        if operation = c.api['operations'][operation_name]
+          if from = operation['output']
+            if shape_name = c.definition['resources'][matches[1]]['shape']
+              resolved = PathResolver.new(c.api).resolve(c.value, from)
+              unless resolved == shape_name
+                c.error("#{c.path} must resolve to a '#{shape_name}' shape")
+              end
+            else
+              # resource defines load but does not define shape
             end
+          else
+            # resource load operation does not have output shape reference
           end
+        else
+          # resource load operation not in API model
         end
+      end
+
+      match(*%w(
+        #/service/actions/\w+/request
+        #/resources/\w+/load/request
+        #/resources/\w+/actions/\w+/request
+        #/resources/\w+/batchActions/\w+/request
+        #/resources/\w+/hasMany/\w+/request
+      )) do |c|
+      end
 
+      match(*%w(
+        #/service/hasMany/\w+/resource/type
+        #/resources/\w+/actions/\w+/resource/type
+        #/resources/\w+/batchActions/\w+/resource/type
+        #/resources/\w+/hasMany/\w+/resource/type
+      )) do |c|
       end
 
-      match('#/resources/(\w+)/shape') do |context|
-        ShapeValidator.new(context, context.value).validate
+      match(*%w(
+        #/service/hasMany/\w+/resource/identifiers
+        #/resources/\w+/actions/\w+/resource/identifiers
+        #/resources/\w+/batchActions/\w+/resource/identifiers
+        #/resources/\w+/hasMany/\w+/resource/identifiers
+      )) do |c|
+        # must provide ALL of the identifiers for the target resource
+        # each identifier must resolve from its
       end
 
-      match('#/resources/(\w+)/identifiers') do |context|
-        context.value.each.with_index do |identifier, index|
-          IdentifierValidator.new(context, identifier, index).validate
+      match(*%w(
+        #/service/hasMany/\w+/resource/path
+        #/resources/\w+/actions/\w+/resource/path
+        #/resources/\w+/batchActions/\w+/resource/path
+        #/resources/\w+/hasMany/\w+/resource/path
+      )) do |c|
+        type = c.parent['type']
+        from = c.parent.parent['request']['operation']
+        from = c.api['operations'][from]['output']
+        expected = c.definition['resources'][type]['shape']
+        resolved = PathResolver.new(c.api).resolve(c.value, from)
+        unless expected == resolved
+          c.error("#{c.path} must resolve to a \"#{expected}\" shape")
         end
       end
 
+      # load_params_can_be_nested
+      # load_params_must_match_their_static_types
+      # load_params_must_not_be_dataMembers
+      # load_params_must_resolve
+      # load_path_accepts_dollar_signs
+      # load_path_accepts_nested_paths
+
       match('#/resources/(\w+)/load') do |context|
         v = OperationValidator.new(context)
         v.validate_request do
           v.validate_param_source_type_not_used('dataMember')
-          v.validate_path(origin: :response, target: :self)
+          #v.validate_path(origin: :response, target: :self)
         end
         v.validate_path_set
         v.validate_resource_not_set
@@ -123,7 +214,7 @@ module Aws
         end
       end
 
-      match('#/resources/(\w+)/(hasSome|hasOne)/\w+') do |context|
+      match('#/resources/(\w+)/belongsTo/\w+') do |context, matches|
         v = OperationValidator.new(context)
         v.validate_request_not_set
         v.validate_resource do
@@ -134,7 +225,7 @@ module Aws
         # to the target resource data
         v.validate_path(origin: :self, target: :resource)
 
-        if context.matches[2] == 'hasSome'
+        if matches[2] == 'hasSome'
           # at least one identifier source must be plural
           # path must be plural if given
         else

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

@@ -3,22 +3,29 @@ module Aws
     module Validator
       class Context
 
-        # @option options [required, String] :path
-        # @option options [required, Object] :value
-        # @option options [required, Hash] :definition
-        # @option options [required, Hash] :api
-        # @option options [required, MatchData] :matches
         def initialize(options = {})
-          [:path, :value, :definition, :api, :matches].each do |opt|
-            if options.key?(opt)
-              instance_variable_set("@#{opt}", options[opt])
-            else
-              raise ArgumentError, "missing required option :#{opt}"
-            end
-          end
-          @errors = []
+          @parent = options[:parent]
+          @path = options[:path]
+          @value = options[:value]
+          @definition = options[:definition]
+          @api = options[:api]
+          @errors = options[:errors] || []
         end
 
+        def child(at)
+          Context.new(
+            parent: self,
+            path: "#{path}/#{at}",
+            value: value[at],
+            definition: definition,
+            api: api,
+            errors: errors
+          )
+        end
+
+        # @return [Context,nil]
+        attr_reader :parent
+
         # @return [String]
         attr_reader :path
 
@@ -31,29 +38,18 @@ module Aws
         # @return [Hash]
         attr_reader :api
 
-        # @return [MatchData]
-        attr_reader :matches
-
         # @return [Array<String>]
         attr_reader :errors
 
+        def [] key
+          @value[key]
+        end
+
         def error(msg)
           @errors << msg
           false
         end
 
-        def resource
-          definition['resources'][matches[1]]
-        end
-
-        def resource_name
-          matches[1]
-        end
-
-        def shape(name)
-          api['shapes'][name]
-        end
-
       end
     end
   end

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

@@ -0,0 +1,89 @@
+module Aws
+  module Resources
+    module Validator
+      module DSL
+
+        def self.extended(base)
+
+          # @api private
+          base.const_set(:RULES, [])
+
+          # @api private
+          base.const_set(:SCHEMA_PATH, File.expand_path(File.join([
+            File.dirname(__FILE__), '..', '..', '..', 'resources.schema.json'
+          ])))
+
+        end
+
+        def match(*patterns, &block)
+          patterns.each do |pattern|
+            RULES << Rule.new(pattern, &block)
+          end
+        end
+
+        # @param [Hash] definition
+        # @param [Hash] api
+        # @return [Array<String>]
+        def validate(definition, api)
+          errors = validate_against_schema(definition)
+          if errors.empty?
+            lint(new_context(definition, api))
+          else
+            errors
+          end
+        end
+
+        private
+
+        def new_context(definition, api)
+          Validator::Context.new(
+            path: '#',
+            value: definition,
+            definition: definition,
+            api: api,
+          )
+        end
+
+        # Validates the resource definition document against the JSON
+        # schema for resources.
+        # @param [Hash] definition
+        # @return [Array<String>] Returns an array of schema validation errors.
+        #   Returns an empty array if there are no errors.
+        def validate_against_schema(definition)
+          schema = MultiJson.load(File.read(SCHEMA_PATH))
+          JSON::Validator.fully_validate(schema, definition)
+        end
+
+        # Recursively lints the resource definition hash against the given
+        # api.
+        # @param [Hash] definition
+        # @param [Hash] api
+        # @return [Array<String>] Returns an array of schema validation errors.
+        #   Returns an empty array if there are no errors.
+        def lint(context)
+          lint_node(context)
+          case context.value
+          when Hash
+            context.value.keys.each do |key, value|
+              lint(context.child(key))
+            end
+          when Array
+            (0...context.value.size).each do |index|
+              lint(context.child(index))
+            end
+          end
+          context.errors
+        end
+
+        def lint_node(context)
+          RULES.each do |rule|
+            if matches = rule.matches(context.path)
+              rule.apply(context, matches)
+            end
+          end
+        end
+
+      end
+    end
+  end
+end

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

@@ -319,11 +319,11 @@ module Aws
         end
 
         def validate_operation_exists
-          if api_operation
+          #if api_operation
             true
-          else
-            error("'#{path}/request/operation' is set but is not defined at 'api#/operations/#{operation_name}'.")
-          end
+          #else
+          #  error("'#{path}/request/operation' is set but is not defined at 'api#/operations/#{operation_name}'.")
+          #end
         end
 
         def resource_name

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

@@ -0,0 +1,34 @@
+module Aws
+  module Resources
+    module Validator
+      # @api private
+      class PathResolver
+
+        def initialize(api)
+          @api = api
+        end
+
+        # @param [String<JMESPathExpression>] expression
+        # @param [Hash<Shape Reference>] from The shape reference, typically
+        #   an operation, to resolve the path starting from.
+        # @return [String, nil] Returns the class name resolved, or `nil`
+        #   if the path does not resolve in the model.
+        def resolve(expression, from)
+          ref = expression.scan(/\w+|\[.*?\]/).inject(from) do |ref, part|
+            shape = @api['shapes'][ref['shape']]
+            if part[0] == '['
+              return nil unless shape['type'] == 'list'
+              shape['member']
+            else
+              return nil unless shape['type'] == 'structure'
+              return nil unless shape['members'][part]
+              shape['members'][part]
+            end
+          end
+          ref && ref['shape']
+        end
+
+      end
+    end
+  end
+end

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

@@ -4,39 +4,17 @@ module Aws
       # @api private
       class Rule
 
-        # @param [String] pattern
         def initialize(pattern, &block)
           @pattern = Regexp.new('^' + pattern + '$')
           @block = block
         end
 
-        # @param [String] path
-        # @return [Boolean]
-        def applies?(path)
-          !!path.match(@pattern)
-        end
-
-        # @param [String] path
-        # @return [MatchData]
         def matches(path)
           path.match(@pattern)
         end
 
-        # @param [String] path
-        # @param [Object] value
-        # @param [Hash] definition
-        # @param [Hash] api
-        # @return [Array<String>]
-        def validate(path, value, definition, api)
-          context = Validator::Context.new(
-            path: path,
-            value: value,
-            definition: definition,
-            api: api,
-            matches: matches(path),
-          )
-          @block.call(context)
-          context.errors
+        def apply(context, matches)
+          @block.call(context, matches)
         end
 
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-resources
 version: !ruby/object:Gem::Version
-  version: 2.0.10.pre
+  version: 2.0.11.pre
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-20 00:00:00.000000000 Z
+date: 2014-11-26 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.10
+        version: 2.0.11
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.0.10
+        version: 2.0.11
 description: Provides resource-oriented abstractions for AWS.
 email: 
 executables: []
@@ -64,10 +64,10 @@ files:
 - lib/aws-sdk-resources/services/sqs.rb
 - lib/aws-sdk-resources/source.rb
 - lib/aws-sdk-resources/validator/context.rb
-- lib/aws-sdk-resources/validator/identifier_validator.rb
+- lib/aws-sdk-resources/validator/dsl.rb
 - lib/aws-sdk-resources/validator/operation_validator.rb
+- lib/aws-sdk-resources/validator/path_resolver.rb
 - lib/aws-sdk-resources/validator/rule.rb
-- lib/aws-sdk-resources/validator/shape_validator.rb
 - lib/aws-sdk-resources/validator.rb
 - lib/aws-sdk-resources.rb
 homepage: http://github.com/aws/aws-sdk-core-ruby

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

@@ -1,107 +0,0 @@
-module Aws
-  module Resources
-    module Validator
-      class IdentifierValidator
-
-        # @param [Validator::Context] context
-        # @param [Hash] identifier
-        # @param [Integer] index
-        def initialize(context, identifier, index)
-          @context = context
-          @identifier = identifier
-          @index = index
-        end
-
-        attr_reader :identifier
-
-        attr_reader :index
-
-        def validate
-          validate_name_is_uniq
-          validate_name_is_not_prefixed
-          if member_name
-            validate_resource_has_shape && validate_resource_shape_contains_member
-          end
-        end
-
-        private
-
-        def validate_name_is_uniq
-          if all_identifier_names.count(name) > 1
-            error("#{path("#{index}/name")} must be uniq within #{path('*/name')}.")
-          else
-            true
-          end
-        end
-
-        def validate_name_is_not_prefixed
-          if name.match(/^#{resource_name}/)
-            error("#{path("#{index}/name")} must not be prefixed with '#{resource_name}'.")
-          else
-            true
-          end
-        end
-
-        def validate_resource_has_shape
-          if resource_shape_name
-            true
-          else
-            error("#{path("#{index}/memberName")} requires '#/resources/#{resource_name}/shape' to be set.")
-          end
-        end
-
-        def validate_resource_shape_contains_member
-          if
-            resource_shape['type'] == 'structure' &&
-            resource_shape['members'].key?(member_name)
-          then
-            true
-          else
-            error("#{path("#{index}/memberName")} is not defined at 'api#/shapes/#{resource_shape_name}/members/#{member_name}'.")
-          end
-        end
-
-        def error(msg)
-          @context.error(msg)
-        end
-
-        def path(suffix = nil)
-          if suffix
-            "'#{@context.path}/#{suffix}'"
-          else
-            "'#{@context.path}'"
-          end
-        end
-
-        def name
-          @identifier['name']
-        end
-
-        def member_name
-          @identifier['memberName']
-        end
-
-        def resource_name
-          @context.matches[1]
-        end
-
-        def all_identifier_names
-          @context.value.map { |i| i['name'] }
-        end
-
-        def resource
-          @context.definition['resources'][resource_name]
-        end
-
-        def resource_shape_name
-          resource['shape']
-        end
-
-        def resource_shape
-          @context.api['shapes'][resource_shape_name]
-        end
-
-      end
-    end
-  end
-end

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

@@ -1,47 +0,0 @@
-module Aws
-  module Resources
-    module Validator
-      class ShapeValidator
-
-        # @param [Validator::Context] context
-        # @param [String] shape_name
-        def initialize(context, shape_name)
-          @context = context
-          @shape_name = shape_name
-          @path = context.path
-        end
-
-        attr_reader :shape_name
-
-        attr_reader :path
-
-        def validate
-          validate_shape_is_defined && validate_shape_is_a_structure
-        end
-
-        private
-
-        def validate_shape_is_defined
-          if shape
-            true
-          else
-            @context.error("'#{path}' not found at api#/shapes/#{shape_name}.")
-          end
-        end
-
-        def validate_shape_is_a_structure
-          if shape['type'] == 'structure'
-            true
-          else
-            @context.error("'#{path}' must resolve to a structure shape.")
-          end
-        end
-
-        def shape
-          @context.api['shapes'][shape_name]
-        end
-
-      end
-    end
-  end
-end