swaggable 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bf18bc08944dd205e9633c7e85a69ac1e0fe9908
-  data.tar.gz: 10a0e3fb8a88842000cd28b29838609106b7c7a4
+  metadata.gz: 808c9b125e0ebb98bf9307f3922375344f073e2d
+  data.tar.gz: e50cd856a8362d1f15e7e95cf70c5307b31c264b
 SHA512:
-  metadata.gz: d5e0e8fdd32d892ffe06e0b5d801db1d7286a9e67dd64d3edbbc339636b8e3ab652d8cbf5b12ace2e9e9587feb288bbe93dee5089a4e7590939cb79514c68a03
-  data.tar.gz: 42f21abe51eb383ff37bbdc8c018d19f2246a2f78d59a9b66fb045d9a48c3d6f93283a1e5799c2c0d55aae4fd413179c41e47de9083ed201a2b8c49a60c3ef56
+  metadata.gz: eeb0d8a2698ff01a16bd477f7a43d7ad6d52dabb191cd8f366e341bd7ba46cd444fa58bdcaf221962f3fd95174d6d44cff5eff7d67222b0795371f748f9b21d3
+  data.tar.gz: 8f5d5d91cb25766ebe780ee784b9a49599439b5eddda1343fe507d22f42972715bd6c91c1c892ea3e3663230335fe99100480f468a1734b0cc374259e72edb79

data/lib/swaggable.rb

@@ -1,20 +1,45 @@
 require 'swaggable/version'
 
 module Swaggable
+  # Rack
+  autoload :RackApp, 'swaggable/rack_app'
+  autoload :RackRedirect, 'swaggable/rack_redirect'
+  autoload :ValidatingRackApp, 'swaggable/validating_rack_app'
+  autoload :RackRequestAdapter, 'swaggable/rack_request_adapter'
+  autoload :RackResponseAdapter, 'swaggable/rack_response_adapter'
+
+  # Definitions
+  autoload :DefinitionBase, 'swaggable/definition_base'
   autoload :ApiDefinition, 'swaggable/api_definition'
   autoload :EndpointDefinition, 'swaggable/endpoint_definition'
-  autoload :ParameterDefinition, 'swaggable/parameter_definition'
   autoload :TagDefinition, 'swaggable/tag_definition'
+  autoload :ParameterDefinition, 'swaggable/parameter_definition'
   autoload :ResponseDefinition, 'swaggable/response_definition'
-  autoload :RackApp, 'swaggable/rack_app'
+  autoload :MimeTypeDefinition, 'swaggable/mime_type_definition'
+  autoload :MimeTypesCollection, 'swaggable/mime_types_collection'
+  autoload :SchemaDefinition, 'swaggable/schema_definition'
+  autoload :AttributeDefinition, 'swaggable/attribute_definition'
+
+  # Grape
   autoload :GrapeAdapter, 'swaggable/grape_adapter'
   autoload :GrapeEntityTranslator, 'swaggable/grape_entity_translator'
+
+  # Swagger
   autoload :Swagger2Serializer, 'swaggable/swagger_2_serializer'
   autoload :Swagger2Validator, 'swaggable/swagger_2_validator'
-  autoload :EndpointIndex, 'swaggable/endpoint_index'
-  autoload :DefinitionBase, 'swaggable/definition_base'
+
+  # Validators
+  autoload :ApiValidator, 'swaggable/api_validator'
+  autoload :EndpointValidator, 'swaggable/endpoint_validator'
+  autoload :CheckRequestContentType, 'swaggable/check_request_content_type'
+  autoload :CheckMandatoryParameters, 'swaggable/check_mandatory_parameters'
+  autoload :CheckExpectedParameters, 'swaggable/check_expected_parameters'
+  autoload :CheckBodySchema, 'swaggable/check_body_schema'
+  autoload :CheckResponseContentType, 'swaggable/check_response_content_type'
+  autoload :CheckResponseCode, 'swaggable/check_response_code'
+
+  # Others
+  autoload :Errors, 'swaggable/errors'
   autoload :EnumerableAttributes, 'swaggable/enumerable_attributes'
-  autoload :SchemaDefinition, 'swaggable/schema_definition'
-  autoload :AttributeDefinition, 'swaggable/attribute_definition'
-  autoload :RackRedirect, 'swaggable/rack_redirect'
+  autoload :QueryParams, 'swaggable/query_params'
 end

data/lib/swaggable/api_validator.rb

@@ -0,0 +1,42 @@
+module Swaggable
+  class ApiValidator
+    attr_accessor(
+      :definition,
+      :request,
+    )
+
+    def initialize opts = {}
+      @definition, @request = opts.values_at(:definition, :request)
+    end
+
+    def errors_for_request
+      endpoint_validator.errors_for_request request
+    end
+
+    def errors_for_response response
+      endpoint_validator.errors_for_response response
+    end
+
+    def endpoint
+      definition.endpoints.detect do |e|
+        e.match? *request_signature
+      end || raise_endpoint_not_found
+    end
+
+    def endpoint_validator
+      @endpoint_validator ||= EndpointValidator.new(endpoint: endpoint)
+    end
+
+    private
+
+    def raise_endpoint_not_found
+      raise Errors::EndpointNotFound.new(
+        "No endpoint matched #{request_signature.join(" ")}"
+      )
+    end
+
+    def request_signature
+      [request['REQUEST_METHOD'], request['PATH_INFO']]
+    end
+  end
+end

data/lib/swaggable/check_body_schema.rb

@@ -0,0 +1,72 @@
+module Swaggable
+  class CheckBodySchema
+    attr_reader :endpoint, :request
+
+    def initialize args
+      @endpoint = args.fetch(:endpoint)
+      @request = args.fetch(:request)
+    end
+
+    def self.call(*args)
+      new(*args).send :errors
+    end
+
+    private
+
+    def errors
+      Errors::ValidationsCollection.new.tap do |errors|
+        errors_for_required_parameters_in_body.each {|e| errors << e }
+      end
+    end
+
+    private
+
+    def errors_for_required_parameters_in_body
+      if body_definition == nil
+        []
+      elsif !body_definition.required?
+        []
+      elsif !request.body
+        [Errors::Validation.new("Missing body")]
+      elsif body_definition.schema.empty?
+        []
+      else
+        missing_attribute_errors + unexpected_attribute_errors
+      end
+    end
+
+    def missing_attribute_errors
+      [].tap do |errors|
+        schema.attributes.select(&:required?).each do |attr|
+          unless body.has_key? attr.name
+            errors << Errors::Validation.new("Missing body parameter #{attr.inspect}")
+          end
+        end
+      end
+    end
+
+    def unexpected_attribute_errors
+      [].tap do |errors|
+        body.each do |key, value|
+          unless schema.attributes[key]
+            errors << Errors::Validation.new("Unexpected body parameter #{key.inspect}")
+          end
+        end
+      end
+    end
+
+    private
+
+    def body_definition
+      endpoint.body
+    end
+
+    def schema
+      body_definition.schema
+    end
+
+    def body
+      request.parsed_body
+    end
+  end
+end

data/lib/swaggable/check_expected_parameters.rb

@@ -0,0 +1,26 @@
+module Swaggable
+  class CheckExpectedParameters
+    attr_reader :endpoint, :request
+
+    def initialize args
+      @endpoint = args.fetch(:endpoint)
+      @request = args.fetch(:request)
+    end
+
+    def self.call(*args)
+      new(*args).send :errors
+    end
+
+    private
+
+    def errors
+      Errors::ValidationsCollection.new.tap do |errors|
+        request.parameters(endpoint).each do |parameter|
+          unless endpoint.parameters.include? parameter
+            errors << Errors::Validation.new("Unexpected parameter #{parameter.inspect}")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/swaggable/check_mandatory_parameters.rb

@@ -0,0 +1,26 @@
+module Swaggable
+  class CheckMandatoryParameters
+    attr_reader :endpoint, :request
+
+    def initialize args
+      @endpoint = args.fetch(:endpoint)
+      @request = args.fetch(:request)
+    end
+
+    def self.call(*args)
+      new(*args).send :errors
+    end
+
+    private
+
+    def errors
+      Errors::ValidationsCollection.new.tap do |errors|
+        endpoint.parameters.select(&:required).each do |parameter|
+          unless request.parameters(endpoint).include? parameter
+            errors << Errors::Validation.new("Missing parameter #{parameter.inspect}")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/swaggable/check_request_content_type.rb

@@ -0,0 +1,26 @@
+module Swaggable
+  class CheckRequestContentType
+    attr_reader :endpoint, :request
+
+    def initialize args
+      @endpoint = args.fetch(:endpoint)
+      @request = args.fetch(:request)
+    end
+
+    def self.call(*args)
+      new(*args).send :errors
+    end
+
+    private
+
+    def errors
+      Errors::ValidationsCollection.new.tap do |errors|
+        type = request.content_type
+
+        unless type.nil? || endpoint.consumes.include?(type)
+          errors << Errors::UnsupportedContentType.new("Content-Type #{type} not supported")
+        end
+      end
+    end
+  end
+end

data/lib/swaggable/check_response_code.rb

@@ -0,0 +1,24 @@
+module Swaggable
+  class CheckResponseCode
+    attr_reader :endpoint, :response
+
+    def initialize args
+      @endpoint = args.fetch(:endpoint)
+      @response = args.fetch(:response)
+    end
+
+    def self.call(*args)
+      new(*args).send :errors
+    end
+
+    private
+
+    def errors
+      Errors::ValidationsCollection.new.tap do |errors|
+        unless endpoint.responses[response.code]
+          errors << Errors::Validation.new("Status code #{response.code.inspect} not supported")
+        end
+      end
+    end
+  end
+end

data/lib/swaggable/check_response_content_type.rb

@@ -0,0 +1,26 @@
+module Swaggable
+  class CheckResponseContentType
+    attr_reader :endpoint, :response
+
+    def initialize args
+      @endpoint = args.fetch(:endpoint)
+      @response = args.fetch(:response)
+    end
+
+    def self.call(*args)
+      new(*args).send :errors
+    end
+
+    private
+
+    def errors
+      Errors::ValidationsCollection.new.tap do |errors|
+        type = response.content_type
+
+        unless type.nil? || endpoint.produces.include?(type)
+          errors << Errors::UnsupportedContentType.new("Content-Type #{type} not supported")
+        end
+      end
+    end
+  end
+end

data/lib/swaggable/endpoint_definition.rb

@@ -1,5 +1,6 @@
 require 'forwarding_dsl'
 require 'mini_object'
+require 'addressable/template'
 
 module Swaggable
   class EndpointDefinition
@@ -12,6 +13,11 @@ module Swaggable
       :summary,
     )
 
+    def initialize *args, &block
+      self.verb = 'GET'
+      super *args, &block
+    end
+
     def tags
       @tags ||= MiniObject::IndexedList.new.tap do |l|
         l.build { TagDefinition.new }
@@ -34,16 +40,38 @@ module Swaggable
     end
 
     def consumes
-      @consumes ||= Set.new
+      @consumes ||= MimeTypesCollection.new
     end
 
     def produces
-      @produces ||= Set.new
+      @produces ||= MimeTypesCollection.new
     end
 
     def configure &block
       ForwardingDsl.run(self, &block)
       self
     end
+
+    def match? v, p
+      v.to_s.upcase == verb.to_s.upcase && !!(path_template.match p)
+    end
+
+    def verb= value
+      @verb = value.to_s.upcase
+    end
+
+    def path_parameters_for path
+      path_template.extract(path) || {}
+    end
+
+    def body
+      parameters.detect {|p| p.location == :body }
+    end
+
+    private
+
+    def path_template
+      Addressable::Template.new path
+    end
   end
 end

data/lib/swaggable/endpoint_validator.rb

@@ -0,0 +1,27 @@
+module Swaggable
+  class EndpointValidator
+    attr_accessor(
+      :endpoint,
+    )
+
+    def initialize(args)
+      @endpoint = args.fetch(:endpoint)
+    end
+
+    def errors_for_request request
+      Errors::ValidationsCollection.new.tap do |errors|
+        errors.merge! CheckRequestContentType.(endpoint: endpoint, request: request)
+        errors.merge! CheckMandatoryParameters.(endpoint: endpoint, request: request)
+        errors.merge! CheckExpectedParameters.(endpoint: endpoint, request: request)
+        errors.merge! CheckBodySchema.(endpoint: endpoint, request: request)
+      end
+    end
+
+    def errors_for_response response
+      Errors::ValidationsCollection.new.tap do |errors|
+        errors.merge! CheckResponseContentType.(endpoint: endpoint, response: response)
+        errors.merge! CheckResponseCode.(endpoint: endpoint, response: response)
+      end
+    end
+  end
+end

data/lib/swaggable/errors.rb

@@ -0,0 +1,9 @@
+module Swaggable
+  module Errors
+    autoload :ValidationsCollection, 'swaggable/errors/validations_collection'
+
+    Validation = Class.new StandardError
+    EndpointNotFound = Class.new StandardError
+    UnsupportedContentType = Class.new Validation
+  end
+end

data/lib/swaggable/errors/validations_collection.rb

@@ -0,0 +1,44 @@
+module Swaggable
+  module Errors
+    class ValidationsCollection < Validation
+      include Enumerable
+      extend Forwardable
+
+      def_delegators(
+        :@list,
+        :last,
+        :first,
+        :count,
+        :empty?,
+      )
+
+      def initialize
+        @list = []
+      end
+
+      def << entry
+        list << entry
+      end
+
+      def each *args, &block
+        list.each(*args, &block)
+      end
+
+      def inspect
+        "#<#{self.class.name}: #{message}>"
+      end
+
+      def merge! other
+        other.each {|e| self << e }
+      end
+
+      def message
+        list.map(&:message).join('. ') + '.'
+      end
+
+      protected
+
+      attr_reader :list
+    end
+  end
+end