sinatra-swagger-exposer 0.2.0 → 0.3.0

data/lib/sinatra/swagger-exposer/swagger-utilities.rb

@@ -45,7 +45,7 @@ module Sinatra
         elsif @type.is_a? Array
           @items = type_to_s(get_array_type(@type))
           check_type(@items, possible_values)
-          @type = 'array'
+          @type = TYPE_ARRAY
         else
           raise SwaggerInvalidException.new("Type [#{@type}] of has an unknown type, should be a class, a string or an array")
         end

data/lib/sinatra/swagger-exposer/version.rb

@@ -1,5 +1,5 @@
 module Sinatra
   module SwaggerExposer
-    VERSION = '0.2.0'
+    VERSION = '0.3.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sinatra-swagger-exposer
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Julien Kirch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-26 00:00:00.000000000 Z
+date: 2015-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -107,18 +107,26 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- lib/sinatra/swagger-exposer/configuration/swagger-endpoint-parameter.rb
+- lib/sinatra/swagger-exposer/configuration/swagger-endpoint-response.rb
+- lib/sinatra/swagger-exposer/configuration/swagger-endpoint.rb
+- lib/sinatra/swagger-exposer/configuration/swagger-info.rb
+- lib/sinatra/swagger-exposer/configuration/swagger-parameter-validation-helper.rb
+- lib/sinatra/swagger-exposer/configuration/swagger-type-property.rb
+- lib/sinatra/swagger-exposer/configuration/swagger-type.rb
+- lib/sinatra/swagger-exposer/configuration/swagger-types.rb
+- lib/sinatra/swagger-exposer/processing/swagger-array-value-preprocessor.rb
+- lib/sinatra/swagger-exposer/processing/swagger-base-value-preprocessor.rb
+- lib/sinatra/swagger-exposer/processing/swagger-parameter-preprocessor.rb
+- lib/sinatra/swagger-exposer/processing/swagger-preprocessor-dispatcher.rb
+- lib/sinatra/swagger-exposer/processing/swagger-primitive-value-preprocessor.rb
+- lib/sinatra/swagger-exposer/processing/swagger-request-preprocessor.rb
+- lib/sinatra/swagger-exposer/processing/swagger-type-value-preprocessor.rb
 - lib/sinatra/swagger-exposer/swagger-content-creator.rb
-- lib/sinatra/swagger-exposer/swagger-endpoint-parameter.rb
-- lib/sinatra/swagger-exposer/swagger-endpoint-response.rb
-- lib/sinatra/swagger-exposer/swagger-endpoint.rb
 - lib/sinatra/swagger-exposer/swagger-exposer.rb
-- lib/sinatra/swagger-exposer/swagger-info.rb
 - lib/sinatra/swagger-exposer/swagger-invalid-exception.rb
 - lib/sinatra/swagger-exposer/swagger-parameter-helper.rb
-- lib/sinatra/swagger-exposer/swagger-parameter-preprocessor.rb
-- lib/sinatra/swagger-exposer/swagger-request-preprocessor.rb
-- lib/sinatra/swagger-exposer/swagger-type-property.rb
-- lib/sinatra/swagger-exposer/swagger-type.rb
+- lib/sinatra/swagger-exposer/swagger-preprocessor-creator.rb
 - lib/sinatra/swagger-exposer/swagger-utilities.rb
 - lib/sinatra/swagger-exposer/version.rb
 - sinatra-swagger-exposer.gemspec

data/lib/sinatra/swagger-exposer/swagger-endpoint-parameter.rb

@@ -1,197 +0,0 @@
-require_relative 'swagger-invalid-exception'
-require_relative 'swagger-parameter-helper'
-require_relative 'swagger-parameter-preprocessor'
-require_relative 'swagger-type-property'
-require_relative 'swagger-utilities'
-
-module Sinatra
-
-  module SwaggerExposer
-
-    class SwaggerEndpointParameter
-
-      include SwaggerUtilities
-      include SwaggerParameterHelper
-
-      def initialize(name, description, how_to_pass, required, type, params, known_types)
-        unless name.is_a?(String) || name.is_a?(Symbol)
-          raise SwaggerInvalidException.new("Name [#{name}] should be a string or a symbol")
-        end
-        name = name.to_s
-        if name.empty?
-          raise SwaggerInvalidException.new('Name should not be empty')
-        end
-        @name = name
-
-        if description
-          @description = description
-        end
-
-        how_to_pass = how_to_pass.to_s
-        unless HOW_TO_PASS.include? how_to_pass
-          raise SwaggerInvalidException.new("Unknown how to pass value [#{how_to_pass}]#{list_or_none(HOW_TO_PASS, 'registered types')}")
-        end
-        @how_to_pass = how_to_pass
-
-        if @how_to_pass == HOW_TO_PASS_BODY
-          get_type(type, PRIMITIVE_TYPES + known_types)
-        else
-          get_type(type, PRIMITIVE_TYPES_FOR_NON_BODY)
-        end
-
-        unless [true, false].include? required
-          raise SwaggerInvalidException.new("Required should be a boolean instead of [#{required}]")
-        end
-        @required = required
-
-        params = white_list_params(params, PARAMS_LIST, SwaggerTypeProperty::PROPERTIES)
-        validate_params(params)
-        @params = params
-      end
-
-      # Validate parameters
-      # @param params [Hash]
-      def validate_params(params)
-        validate_limit_parameters(params)
-        validate_length_parameters(params)
-      end
-
-      # Create the corresponding SwaggerParameterPreprocessor
-      # @return [Sinatra::SwaggerExposer::SwaggerParameterPreprocessor]
-      def preprocessor
-        SwaggerParameterPreprocessor.new(@name, @how_to_pass, @required, @type, @params[:default], @params)
-      end
-
-      # Return the swagger version
-      # @return [Hash]
-      def to_swagger
-        result = {
-            :name => @name,
-            :in => @how_to_pass,
-            :required => @required
-        }
-
-        if @type
-          if @type == 'array'
-            result[:type] = 'array'
-            if @items
-              if PRIMITIVE_TYPES.include? @items
-                result[:items] = {:type => @items}
-              else
-                result[:schema] = ref_to_type(@items)
-              end
-            end
-          else
-            if PRIMITIVE_TYPES.include? @type
-              result[:type] = @type
-            else
-              result[:schema] = ref_to_type(@type)
-            end
-          end
-        end
-
-        if @description
-          result[:description] = @description
-        end
-        unless @params.empty?
-          result.merge!(@params)
-        end
-
-        result
-      end
-
-      def to_s
-        {
-            :name => @name,
-            :in => @how_to_pass,
-            :required => @required,
-            :type => @type,
-            :items => @items,
-            :description => @description,
-            :params => @params,
-        }.to_json
-      end
-
-      private
-
-      # Test if a parameter is a boolean
-      # @param name the parameter's name
-      # @param value value the parameter's value
-      # @return [NilClass]
-      def check_boolean(name, value)
-        unless [true, false].include? value
-          raise SwaggerInvalidException.new("Invalid boolean value [#{value}] for [#{name}]")
-        end
-      end
-
-      # Validate the limit parameters
-      # @param params [Hash] the parameters
-      def validate_limit_parameters(params)
-        max = validate_limit_parameter(params, PARAMS_MAXIMUM, PARAMS_EXCLUSIVE_MAXIMUM)
-        min = validate_limit_parameter(params, PARAMS_MINIMUM, PARAMS_EXCLUSIVE_MINIMUM)
-        if min && max && (max < min)
-          raise SwaggerInvalidException.new("Minimum value [#{min}] can't be more than maximum value [#{max}]")
-        end
-      end
-
-      # Validate a limit param like maximum and exclusiveMaximum
-      # @param params [Hash] the parameters
-      # @param limit_param_name [Symbol] the limit parameter name
-      # @param exclusive_limit_param_name [Symbol] the exclusive limit parameter name
-      def validate_limit_parameter(params, limit_param_name, exclusive_limit_param_name)
-        parameter_value = nil
-        if params.key? limit_param_name
-          unless [TYPE_INTEGER, TYPE_NUMBER].include? @type
-            raise SwaggerInvalidException.new("Parameter #{limit_param_name} can only be specified for types #{TYPE_INTEGER} or #{TYPE_NUMBER} and not for [#{@type}]")
-          end
-          parameter_value = params[limit_param_name]
-          unless parameter_value.is_a? Numeric
-            raise SwaggerInvalidException.new("Parameter #{limit_param_name} must be a numeric and can not be [#{parameter_value}]")
-          end
-        end
-
-        if params.key? exclusive_limit_param_name
-          check_boolean(exclusive_limit_param_name, params[exclusive_limit_param_name])
-          unless params.key? limit_param_name
-            raise SwaggerInvalidException.new("You can't have a #{exclusive_limit_param_name} value without a #{limit_param_name}")
-          end
-        end
-        parameter_value
-      end
-
-      # Validate the length parameters minLength and maxLength
-      # @param params [Hash] the parameters
-      def validate_length_parameters(params)
-        min_length = validate_length_parameter(params, PARAMS_MIN_LENGTH)
-        max_length = validate_length_parameter(params, PARAMS_MAX_LENGTH)
-
-        if min_length && max_length && (max_length < min_length)
-          raise SwaggerInvalidException.new("Minimum length #{min_length} can't be more than maximum length #{max_length}")
-        end
-      end
-
-      # Validate a length param like minLength and maxLength
-      # @param params [Hash] the parameters
-      # @param length_param_name [Symbol] the length parameter name
-      # @return [Integer] the parameter value if it is present
-      def validate_length_parameter(params, length_param_name)
-        if params.key? length_param_name
-          if @type == TYPE_STRING
-            parameter_value = params[length_param_name]
-            unless parameter_value.is_a? Integer
-              raise SwaggerInvalidException.new("Parameter #{length_param_name} must be an integer and can not be [#{parameter_value}]")
-            end
-            parameter_value
-          else
-            raise SwaggerInvalidException.new("Parameter #{length_param_name} can only be specified for type #{TYPE_STRING} and not for [#{@type}]")
-          end
-
-        else
-          nil
-        end
-      end
-
-    end
-
-  end
-end

data/lib/sinatra/swagger-exposer/swagger-endpoint-response.rb

@@ -1,63 +0,0 @@
-require_relative 'swagger-utilities'
-require_relative 'swagger-invalid-exception'
-
-module Sinatra
-
-  module SwaggerExposer
-
-    class SwaggerEndpointResponse
-
-      include SwaggerUtilities
-
-      RESPONSE_PRIMITIVES_FILES = PRIMITIVE_TYPES + [TYPE_FILE]
-
-      def initialize(type, description, known_types)
-        get_type(type, known_types + RESPONSE_PRIMITIVES_FILES)
-        if description
-          @description = description
-        end
-      end
-
-      def to_swagger
-        result = {}
-
-        if @type
-          if @type == 'array'
-            schema = {:type => 'array'}
-            if @items
-              if RESPONSE_PRIMITIVES_FILES.include? @items
-                schema[:items] = {:type => @items}
-              else
-                schema[:items] = ref_to_type(@items)
-              end
-            end
-            result[:schema] = schema
-          else
-            if RESPONSE_PRIMITIVES_FILES.include? @type
-              result[:schema] = {:type => @type}
-            else
-              result[:schema] = ref_to_type(@type)
-            end
-          end
-        end
-
-        if @description
-          result[:description] = @description
-        end
-
-        result
-      end
-
-      def to_s
-        {
-            :type => @type,
-            :items => @items,
-            :description => @description,
-        }.to_json
-      end
-
-
-    end
-
-  end
-end

data/lib/sinatra/swagger-exposer/swagger-endpoint.rb

@@ -1,94 +0,0 @@
-require_relative 'swagger-request-preprocessor'
-require_relative 'swagger-utilities'
-
-module Sinatra
-
-  module SwaggerExposer
-
-    # An endpoint
-    class SwaggerEndpoint
-
-      include SwaggerUtilities
-
-      attr_reader :path, :type, :request_preprocessor
-
-      def initialize(type, sinatra_path, parameters, responses, summary, description, tags, explicit_path, produces)
-        @type = type
-        @path = swagger_path(sinatra_path, explicit_path)
-        @request_preprocessor = SwaggerRequestPreprocessor.new
-
-        @parameters = parameters
-        @parameters.each do |parameter|
-          preprocessor = parameter.preprocessor
-          if preprocessor.useful?
-            @request_preprocessor.add_preprocessor preprocessor
-          end
-        end
-
-        @responses = responses
-
-        @attributes = {}
-        if summary
-          @attributes[:summary] = summary
-        end
-        if description
-          @attributes[:description] = description
-        end
-        if tags
-          @attributes[:tags] = tags
-        end
-        if produces
-          @attributes[:produces] = produces
-        end
-      end
-
-      def to_swagger
-        result = @attributes.clone
-
-        unless @parameters.empty?
-          result[:parameters] = @parameters.collect { |parameter| parameter.to_swagger }
-        end
-
-        unless @responses.empty?
-          result[:responses] = hash_to_swagger(@responses)
-        end
-
-        result
-      end
-
-      REGEX_PATH_PARAM_MIDDLE = /\A(.*\/)\:([a-z]+)\/(.+)\z/
-      REGEX_PATH_PARAM_END = /\A(.*)\/:([a-z]+)\z/
-
-      # Get the endpoint swagger path
-      # @param sinatra_path the path declared in the sinatra app
-      # @param explicit_path an explicit path the user can specify
-      def swagger_path(sinatra_path, explicit_path)
-        if explicit_path
-          explicit_path
-        elsif sinatra_path.is_a? String
-          while (m = REGEX_PATH_PARAM_MIDDLE.match(sinatra_path))
-            sinatra_path = "#{m[1]}{#{m[2]}}/#{m[3]}"
-          end
-          if (m = REGEX_PATH_PARAM_END.match(sinatra_path))
-            sinatra_path = "#{m[1]}/{#{m[2]}}"
-          end
-          sinatra_path
-        else
-          raise SwaggerInvalidException.new("You need to specify a path when using a non-string path [#{sinatra_path}]")
-        end
-      end
-
-      def to_s
-        {
-            :type => @type,
-            :path => @path,
-            :attributes => @attributes,
-            :parameters => @parameters,
-            :responses => @responses,
-        }.to_json
-      end
-
-    end
-
-  end
-end

data/lib/sinatra/swagger-exposer/swagger-info.rb

@@ -1,70 +0,0 @@
-require_relative 'swagger-invalid-exception'
-require_relative 'swagger-utilities'
-
-module Sinatra
-
-  module SwaggerExposer
-
-    # The info declaration
-    class SwaggerInfo
-
-      include SwaggerUtilities
-
-      def initialize(values)
-        @values = process(values, 'info', INFO_FIELDS, values)
-      end
-
-      # Known fields for the info field
-      INFO_FIELDS = {
-          :version => String,
-          :title => String,
-          :description => String,
-          :termsOfService => String,
-          :contact => {:name => String, :email => String, :url => String},
-          :license => {:name  => String, :url => String},
-      }
-
-      # Recursive function
-      def process(current_hash, current_field_name, current_fields, top_level_hash)
-        result = {}
-
-        current_hash.each_pair do |current_key, current_value|
-          key_sym = current_key.to_sym
-          if current_fields.key? key_sym
-
-            field_content = current_fields[key_sym]
-            if field_content == String
-              if current_value.is_a? String
-                result[key_sym] = current_value
-              else
-                raise SwaggerInvalidException.new("Property [#{current_key}] value [#{current_value}] should be a String for #{current_field_name}: #{top_level_hash}")
-              end
-            else
-              if current_value.is_a? Hash
-                sub_params = process(current_value, current_field_name, field_content, top_level_hash)
-                if sub_params
-                  result[key_sym] = sub_params
-                end
-              else
-                raise SwaggerInvalidException.new("Property [#{current_key}] value [#{current_value}] should be a Hash for #{current_field_name}: #{top_level_hash}")
-              end
-            end
-          else
-            raise SwaggerInvalidException.new("Unknown property [#{current_key}] for #{current_field_name}#{list_or_none(current_fields.keys, 'values')}")
-          end
-        end
-        result.empty? ? nil : result
-      end
-
-      def to_swagger
-        @values
-      end
-
-      def to_s
-        @values.to_json
-      end
-
-    end
-
-  end
-end