sinatra-swagger-exposer-ng 0.5.0

data/lib/sinatra/swagger-exposer/processing/swagger-file-processor-dispatcher.rb

@@ -0,0 +1,35 @@
+require_relative '../swagger-parameter-helper'
+
+module Sinatra
+
+  module SwaggerExposer
+
+    module Processing
+
+      # Fake dispatcher for files
+      class SwaggerFileProcessorDispatcher
+
+        # Initialize
+        # @param name [String] the name
+        # @param required [TrueClass] if the parameter is required
+        def initialize(name, required)
+          @name = name
+          @required = required
+        end
+
+        def useful?
+          @required
+        end
+
+        # Process the value
+        def process(app, parsed_body)
+          if app.params.key?(@name.to_s) && (!app.params[@name.to_s].nil?)
+          elsif @required
+            raise SwaggerInvalidException.new("Mandatory value [#{@name}] is missing")
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/sinatra/swagger-exposer/processing/swagger-primitive-value-processor.rb

@@ -0,0 +1,165 @@
+require 'date'
+
+require_relative 'swagger-base-value-processor'
+require_relative '../swagger-parameter-helper'
+require_relative '../swagger-invalid-exception'
+
+module Sinatra
+
+  module SwaggerExposer
+
+    module Processing
+
+      # Validate primitive value
+      class SwaggerPrimitiveValueProcessor < SwaggerBaseValueProcessor
+
+        include Sinatra::SwaggerExposer::SwaggerParameterHelper
+
+        attr_reader :type, :params
+
+        # Initialize
+        # @param name [String] the name
+        # @param required [TrueClass] if the parameter is required
+        # @param type [String] the type name
+        # @param default [Object] the default value
+        # @param params [Hash] parameters
+        def initialize(name, required, type, default, params)
+          super(name, required, default)
+          @type = type
+          @params = params
+        end
+
+        def useful?
+          super ||
+            [TYPE_NUMBER, TYPE_INTEGER, TYPE_BOOLEAN, TYPE_DATE_TIME].include?(@type) || # Must check type
+            (@params.key? PARAMS_MIN_LENGTH) || (@params.key? PARAMS_MAX_LENGTH) # Must check string
+        end
+
+        # Dispatch method
+        def validate_value(value)
+          case @type
+            when TYPE_NUMBER
+              return validate_value_number(value)
+            when TYPE_INTEGER
+              return validate_value_integer(value)
+            when TYPE_BOOLEAN
+              return validate_value_boolean(value)
+            when TYPE_DATE_TIME
+              return validate_value_date_time(value)
+            else
+              return validate_value_string(value)
+          end
+        end
+
+        # Validate a boolean
+        def validate_value_boolean(value)
+          if (value == 'true') || value.is_a?(TrueClass)
+            true
+          elsif (value == 'false') || value.is_a?(FalseClass)
+            false
+          else
+            raise SwaggerInvalidException.new("Value [#{name}] should be an boolean but is [#{value}]")
+          end
+        end
+
+        # Validate an integer
+        def validate_value_integer(value)
+          begin
+            f = Float(value)
+            i = Integer(value)
+            if f == i
+              i
+            else
+              raise SwaggerInvalidException.new("Value [#{name}] should be an integer but is [#{value}]")
+            end
+            value = Integer(value)
+            validate_numerical_value(value)
+            value
+          rescue ArgumentError
+            raise SwaggerInvalidException.new("Value [#{name}] should be an integer but is [#{value}]")
+          rescue TypeError
+            raise SwaggerInvalidException.new("Value [#{name}] should be an integer but is [#{value}]")
+          end
+        end
+
+        # Validate a number value
+        def validate_value_number(value)
+          begin
+            value = Float(value)
+            validate_numerical_value(value)
+            return value
+          rescue ArgumentError
+            raise SwaggerInvalidException.new("Value [#{name}] should be a float but is [#{value}]")
+          rescue TypeError
+            raise SwaggerInvalidException.new("Value [#{name}] should be a float but is [#{value}]")
+          end
+        end
+
+        # Validate a numerical value
+        # @param value [Numeric] the value
+        def validate_numerical_value(value)
+          validate_numerical_value_internal(
+            value,
+            PARAMS_MINIMUM,
+            PARAMS_EXCLUSIVE_MINIMUM,
+            '>=',
+            '>')
+          validate_numerical_value_internal(
+            value,
+            PARAMS_MAXIMUM,
+            PARAMS_EXCLUSIVE_MAXIMUM,
+            '<=',
+            '<')
+        end
+
+        # Validate a date time
+        def validate_value_date_time(value)
+          begin
+            DateTime.rfc3339(value)
+          rescue ArgumentError
+            raise SwaggerInvalidException.new("Value [#{name}] should be a date time but is [#{value}]")
+          end
+        end
+
+        # Validate a string
+        def validate_value_string(value)
+          if value
+            validate_value_string_length(value, PARAMS_MIN_LENGTH, '>=')
+            validate_value_string_length(value, PARAMS_MAX_LENGTH, '<=')
+          end
+          value
+        end
+
+        # Validate the length of a string
+        # @param value the value to check
+        # @param limit_param_name [Symbol] the param that contain the value to compare to
+        # @param limit_param_method [String] the comparison method to call
+        def validate_value_string_length(value, limit_param_name, limit_param_method)
+          if @params.key? limit_param_name
+            target_value = @params[limit_param_name]
+            unless value.length.send(limit_param_method, target_value)
+              raise SwaggerInvalidException.new("Value [#{name}] length should be #{limit_param_method} than #{target_value} but is #{value.length} for [#{value}]")
+            end
+          end
+        end
+
+        # Validate the value of a number
+        # @param value the value to check
+        # @param limit_param_name [Symbol] the param that contain the value to compare to
+        # @param exclusive_limit_param_name [Symbol] the param that indicates if the comparison is absolute
+        # @param limit_param_method [String] the comparison method to call
+        # @param exclusive_limit_param_method [String] the absolute comparison method to call
+        def validate_numerical_value_internal(value, limit_param_name, exclusive_limit_param_name, limit_param_method, exclusive_limit_param_method)
+          if @params.key? limit_param_name
+            target_value = @params[limit_param_name]
+            method_to_call = @params[exclusive_limit_param_name] ? exclusive_limit_param_method : limit_param_method
+            unless value.send(method_to_call, target_value)
+              raise SwaggerInvalidException.new("Value [#{name}] should be #{method_to_call} than [#{target_value}] but is [#{value}]")
+            end
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/sinatra/swagger-exposer/processing/swagger-processor-dispatcher.rb

@@ -0,0 +1,69 @@
+require_relative '../swagger-parameter-helper'
+
+module Sinatra
+
+  module SwaggerExposer
+
+    module Processing
+
+      # Make headers available as a Hash
+      class HashForHeaders < Hash
+
+        def initialize(app)
+          @app = app
+        end
+
+        def [](name)
+          @app.request.env[key_to_header_key(name)]
+        end
+
+        def key?(name)
+          @app.request.env.key?(key_to_header_key(name))
+        end
+
+        private
+
+        # In rack the headers name are transformed
+        def key_to_header_key(key)
+          "HTTP_#{key.gsub(/-/o, '_').upcase}"
+        end
+
+      end
+
+      # Dispatch content to a processor
+      class SwaggerProcessorDispatcher
+
+        attr_reader :how_to_pass, :processor
+
+        include Sinatra::SwaggerExposer::SwaggerParameterHelper
+
+        # Initialize
+        # @param how_to_pass how the value should be passed to the processor
+        # @param processor [Sinatra::SwaggerExposer::Processing::SwaggerBaseValueProcessor] processor for the values
+        def initialize(how_to_pass, processor)
+          @how_to_pass = how_to_pass
+          @processor = processor
+        end
+
+        def useful?
+          (@how_to_pass != HOW_TO_PASS_PATH) && @processor.useful?
+        end
+
+        # Process the value
+        def process(app, parsed_body)
+          case @how_to_pass
+            when HOW_TO_PASS_PATH
+              # can't validate
+            when HOW_TO_PASS_QUERY
+              @processor.process(app.params)
+            when HOW_TO_PASS_HEADER
+              @processor.process(HashForHeaders.new(app))
+            when HOW_TO_PASS_BODY
+              @processor.process(parsed_body || {})
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/sinatra/swagger-exposer/processing/swagger-request-processor.rb

@@ -0,0 +1,128 @@
+require 'json'
+require 'mime-types'
+
+require_relative '../swagger-invalid-exception'
+
+module Sinatra
+
+  module SwaggerExposer
+
+    module Processing
+
+      # Custom mime types that matches everything when '*' is in list
+      class AllMimesTypes
+
+        def like?(other)
+          true
+        end
+
+      end
+
+      # A processor for a request, apply the parameters processors then execute the query code
+      class SwaggerRequestProcessor
+
+        attr_reader :processors_dispatchers, :response_processors, :produces
+
+        # @param produces [Array<String>]
+        def initialize(produces = nil)
+          @processors_dispatchers = []
+          @response_processors = {}
+          @produces = produces
+          if produces
+            @produces_types = produces.collect do |produce|
+              if produce == '*'
+                [Sinatra::SwaggerExposer::Processing::AllMimesTypes.new]
+              else
+                MIME::Types[produce]
+              end
+            end.flatten
+          end
+        end
+
+        # @param dispatcher [Sinatra::SwaggerExposer::Processing::SwaggerProcessorDispatcher]
+        def add_dispatcher(dispatcher)
+          @processors_dispatchers << dispatcher
+        end
+
+        # @param response_processor [Sinatra::SwaggerExposer::Processing::SwaggerResponseProcessor]
+        def add_response_processor(code, response_processor)
+          @response_processors[code] = response_processor
+        end
+
+        JSON_CONTENT_TYPE = MIME::Types['application/json'].first
+        HTML_CONTENT_TYPE = MIME::Types['text/html'].first
+
+        # Run the processor the call the route content
+        # @param app the sinatra app being run
+        # @param block_params [Array] the block parameters
+        # @param block the block containing the route content
+        def run(app, block_params, &block)
+          parsed_body = {}
+          if JSON_CONTENT_TYPE.like?(app.env['CONTENT_TYPE'])
+            body = app.request.body.read
+            unless body.empty?
+              begin
+                parsed_body = JSON.parse(body)
+              rescue JSON::ParserError => e
+                return [400, {:code => 400, :message => e.message}.to_json]
+              end
+            end
+          end
+          app.params['parsed_body'] = parsed_body
+          unless @processors_dispatchers.empty?
+            @processors_dispatchers.each do |processor_dispatcher|
+              begin
+                processor_dispatcher.process(app, parsed_body)
+              rescue SwaggerInvalidException => e
+                app.content_type :json
+                return [400, {:code => 400, :message => e.message}.to_json]
+              end
+            end
+          end
+          if block
+            # Execute the block in the context of the app
+            app.instance_exec(*block_params, &block)
+          else
+            ''
+          end
+        end
+
+        # Validate the response
+        # @param response_body [String] the body
+        # @param content_type [String] the content type
+        # @param response_status [Integer] the status
+        def validate_response(response_body, content_type, response_status)
+          validate_response_content_type(content_type, response_status)
+          if @response_processors.key?(response_status)
+            response_processor = response_processors[response_status]
+            if JSON_CONTENT_TYPE.like?(content_type) && response_processor
+              response_processor.validate_response(response_body)
+            end
+          else
+            raise SwaggerInvalidException.new("Status with unknown response status [#{response_status}], known statuses are [#{@response_processors.keys.join(', ')}] response value is #{response_body}")
+          end
+        end
+
+        # Validate a response content type
+        # @param content_type [String] the content type to validate
+        # @param response_status [Integer] the status
+        def validate_response_content_type(content_type, response_status)
+          if content_type.nil? && (response_status == 204)
+            # No content and no content type => everything is OK
+          elsif @produces
+            # if there is no content type Sinatra will default to html so we simulate it here
+            if content_type.nil? && @produces_types.any? { |produce| produce.like?(HTML_CONTENT_TYPE) }
+              content_type = HTML_CONTENT_TYPE
+            end
+            unless @produces_types.any? { |produce| produce.like?(content_type) }
+              raise SwaggerInvalidException.new("Undeclared content type [#{content_type}], declared content type are [#{@produces.join(', ')}]")
+            end
+          elsif !JSON_CONTENT_TYPE.like?(content_type)
+            raise SwaggerInvalidException.new("Undeclared content type [#{content_type}], if no declaration for the endpoint you should only return json")
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/sinatra/swagger-exposer/processing/swagger-response-processor.rb

@@ -0,0 +1,47 @@
+require_relative '../swagger-parameter-helper'
+
+module Sinatra
+
+  module SwaggerExposer
+
+    module Processing
+
+      # Process a response
+      class SwaggerResponseProcessor
+
+        include Sinatra::SwaggerExposer::SwaggerParameterHelper
+
+        attr_reader :endpoint_response, :processor
+
+        # Initialize
+        # @param endpoint_response [Sinatra::SwaggerExposer::Configuration::SwaggerEndpointResponse]
+        # @param processor [Sinatra::SwaggerExposer::Processing::SwaggerTypeValueProcessor]
+        def initialize(endpoint_response, processor)
+          @endpoint_response = endpoint_response
+          @processor = processor
+        end
+
+        # Test if the processor is useful
+        # @return [TrueClass]
+        def useful?
+          (@endpoint_response && (@endpoint_response.type != TYPE_FILE)) || @processor
+        end
+
+        # Validate a response
+        # @param response_body [String] the body
+        def validate_response(response_body)
+          parsed_response_body = nil
+          begin
+            parsed_response_body = ::JSON.parse(response_body)
+          rescue ::JSON::ParserError => e
+            raise SwaggerInvalidException.new("Response is not a valid json [#{response_body}]")
+          end
+          if @processor
+            @processor.validate_value(parsed_response_body)
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/sinatra/swagger-exposer/processing/swagger-type-value-processor.rb

@@ -0,0 +1,37 @@
+require_relative 'swagger-base-value-processor'
+
+module Sinatra
+
+  module SwaggerExposer
+
+    module Processing
+
+      # A processor for a type parameter
+      class SwaggerTypeValueProcessor < SwaggerBaseValueProcessor
+
+        attr_reader :attributes_processors
+
+        # Initialize
+        # @param name [String] the name
+        # @param required [TrueClass] if the parameter is required
+        # @param attributes_processors [Array<Sinatra::SwaggerExposer::Processing::SwaggerBaseValueProcessor>] the attributes processors
+        def initialize(name, required, attributes_processors)
+          super(name, required, nil)
+          @attributes_processors = attributes_processors
+        end
+
+        def useful?
+          super || (!(@attributes_processors.empty?))
+        end
+
+        def validate_value(value)
+          @attributes_processors.each do |attribute_processor|
+            attribute_processor.process(value)
+          end
+          value
+        end
+
+      end
+    end
+  end
+end

data/lib/sinatra/swagger-exposer/swagger-content-creator.rb

@@ -0,0 +1,55 @@
+module Sinatra
+
+  module SwaggerExposer
+
+    # Create the swagger content
+    class SwaggerContentCreator
+
+      def initialize(swagger_info, swagger_types, swagger_endpoints)
+        @swagger_info = swagger_info
+        @swagger_types = swagger_types
+        @swagger_endpoints = swagger_endpoints
+      end
+
+      def to_swagger
+        result = {
+          swagger: '2.0',
+          consumes: ['application/json'],
+          produces: ['application/json'],
+        }
+        if @swagger_info
+          result[:info] = @swagger_info.to_swagger
+        end
+
+        swagger_types_as_swagger = @swagger_types.to_swagger
+        if swagger_types_as_swagger
+          result[:definitions] = swagger_types_as_swagger
+        end
+
+        unless @swagger_endpoints.empty?
+          result_endpoints = {}
+
+          # swagger need the endpoints to be grouped by path
+          endpoints_by_path = @swagger_endpoints.group_by { |endpoint| endpoint.path }
+          endpoints_by_path.keys.sort.each do |path|
+            endpoints = endpoints_by_path[path]
+
+            result_endpoints_for_path = {}
+            endpoints.each do |endpoint|
+              result_endpoints_for_path[endpoint.type] = endpoint.to_swagger
+            end
+
+            result_endpoints[path] = result_endpoints_for_path
+
+          end
+          result[:paths] = result_endpoints
+        end
+
+        result
+      end
+
+    end
+
+  end
+
+end