aws-sdk-resources 2.0.0.pre

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

@@ -0,0 +1,137 @@
+module Aws
+  module Resources
+    class Resource
+
+      extend OperationMethods
+
+      # @overload initialize(options = {})
+      # @overload initialize(*identifiers, options = {})
+      # @param options Options except `:data` and identifier options are
+      #   used to construct a {Client} unless `:client` is given.
+      # @option options [Client] :client
+      def initialize(*args)
+        options = args.last.is_a?(Hash) ? args.pop.dup : {}
+        @identifiers = extract_identifiers(args, options)
+        @data = options.delete(:data)
+        @client = extract_client(options)
+      end
+
+      # Marked private to prevent double documentation
+      # @return [Client]
+      attr_reader :client
+
+      # Marked private to prevent double documentation
+      # @return [Hash<Symbol,String>]
+      attr_reader :identifiers
+
+      # @return [Struct]
+      def data
+        load unless @data
+        @data
+      end
+
+      # @return [Boolean] Returns `true` if {#data} has been loaded.
+      def data_loaded?
+        !@data.nil?
+      end
+
+      # Loads data for this resource.
+      # @note Calling this method will send a request to AWS.
+      # @return [self]
+      def load
+        if load_operation = self.class.load_operation
+          @data = load_operation.call(resource:self, client:client)
+          self
+        else
+          raise NotImplementedError, "#load not defined for #{self.class.name}"
+        end
+      end
+      alias reload load
+
+      # @api private
+      def inspect
+        identifiers = self.identifiers.map do |name, value|
+          "#{name}=#{value.inspect}"
+        end.join(', ')
+        "#<#{[self.class.name, identifiers].join(' ').strip}>"
+      end
+
+      private
+
+      def extract_client(options)
+        if options[:client]
+          options[:client]
+        else
+          self.class.client_class.new(options)
+        end
+      end
+
+      def extract_identifiers(args, options)
+        identifiers = {}
+        self.class.identifiers.each.with_index do |name, n|
+          if args[n]
+            identifiers[name] = args[n]
+          elsif options.key?(name)
+            identifiers[name] = options.delete(name)
+          else
+            raise ArgumentError, "missing required option #{name.inspect}"
+          end
+        end
+        identifiers
+      end
+
+      class << self
+
+        # @return [String, nil] The resource name.
+        attr_accessor :resource_name
+
+        # @return [Class<Client>, nil] When constructing
+        #   a resource, the client will default to an instance of the
+        #   this class.
+        attr_accessor :client_class
+
+        # @return [Operations::DataOperation, nil]
+        attr_accessor :load_operation
+
+        # @return [Array<Symbol>]
+        # @see add_identifier
+        # @see #identifiers
+        def identifiers
+          @identifiers.dup
+        end
+
+        # @param [Symbol] name
+        # @return [void]
+        def add_identifier(name)
+          name = name.to_sym
+          safe_define_method(name) { @identifiers[name] }
+          @identifiers << name
+        end
+
+        # Registers a data attribute.  This defines a simple getter
+        # for the attribute which will access {#data}, loading the
+        # resource if necessary.
+        # @param [Symbol] name
+        # @return [void]
+        def add_data_attribute(name)
+          safe_define_method(name) { data[name] }
+          @data_attributes << name
+        end
+
+        # @return [Array<Symbol>] Returns an array of symbolized data
+        #   attribute names.
+        def data_attributes
+          @data_attributes.dup
+        end
+
+        # @api private
+        def inherited(subclass)
+          subclass.send(:instance_variable_set, "@identifiers", [])
+          subclass.send(:instance_variable_set, "@data_attributes", [])
+          super
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+require 'json'
+
+module Aws
+  module Resources
+    class Source
+
+      def initialize(definition, file = nil)
+        @definition = definition
+        @file = file
+      end
+
+      # @return [Hash]
+      attr_reader :definition
+
+      # @return [String, nil]
+      attr_reader :file
+
+      def format
+        json = JSON.pretty_generate(definition, indent: '  ', space: '')
+        stack = [[]]
+        json.lines.each do |line|
+          if line.match(/({|\[)$/)
+            stack.push([])
+          end
+          stack.last.push(line)
+          if line.match(/(}|\]),?$/)
+            frame = stack.pop
+            if frame.size == 3 && !frame[1].match(/[{}]/)
+              frame = [frame[0].rstrip, '', frame[1].strip, '', frame[2].lstrip]
+            end
+            stack.last.push(frame.join)
+          end
+        end
+        stack.last.join
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,152 @@
+require 'multi_json'
+require 'json-schema'
+require 'aws-sdk-resources/validator/context'
+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
+          end
+          errors
+        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))
+            end
+          end
+        end
+
+      end
+
+      match('#/resources/(\w+)/shape') do |context|
+        ShapeValidator.new(context, context.value).validate
+      end
+
+      match('#/resources/(\w+)/identifiers') do |context|
+        context.value.each.with_index do |identifier, index|
+          IdentifierValidator.new(context, identifier, index).validate
+        end
+      end
+
+      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)
+        end
+        v.validate_path_set
+        v.validate_resource_not_set
+      end
+
+      match('#/resources/(\w+)/actions/\w+') do |context|
+        v = OperationValidator.new(context)
+        v.validate_request
+        if v.resource_set?
+          v.validate_resource
+          v.validate_path(origin: :response, target: :resource)
+        else
+          v.validate_path(origin: :response)
+        end
+      end
+
+      match('#/resources/(\w+)/batchActions/\w+') do |context|
+        # TODO : much like a normal action???
+      end
+
+      match('#/resources/(\w+)/hasMany/\w+') do |context|
+        v = OperationValidator.new(context)
+        v.validate_request
+        v.validate_resource do
+          # at least one of the identifier sources must be plural
+        end
+        if v.path_set?
+          v.validate_path(origin: :response, target: :resource)
+          v.validate_path_is_plural
+        end
+      end
+
+      match('#/resources/(\w+)/(hasSome|hasOne)/\w+') do |context|
+        v = OperationValidator.new(context)
+        v.validate_request_not_set
+        v.validate_resource do
+          # disallow requestParameter
+          # disallow responsepath
+        end
+        # path must resolve FROM the resource data shape
+        # to the target resource data
+        v.validate_path(origin: :self, target: :resource)
+
+        if context.matches[2] == 'hasSome'
+          # at least one identifier source must be plural
+          # path must be plural if given
+        else
+          # identifier sources must be singular
+          # path must be singular if given
+        end
+      end
+
+      match('#/resources/(\w+)/subResources') do |context|
+        # TODO : validate subResources
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,60 @@
+module Aws
+  module Resources
+    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 = []
+        end
+
+        # @return [String]
+        attr_reader :path
+
+        # @return [Object]
+        attr_reader :value
+
+        # @return [Hash]
+        attr_reader :definition
+
+        # @return [Hash]
+        attr_reader :api
+
+        # @return [MatchData]
+        attr_reader :matches
+
+        # @return [Array<String>]
+        attr_reader :errors
+
+        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
+end

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

@@ -0,0 +1,107 @@
+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