sinatra-swagger-exposer-ng 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4fcf6c8efdac0057fcb228a1c7f1c5baaeb1ea7e5a5852dcc706622b4aec6627
+  data.tar.gz: 311b3f769095d3e17f3010eaff435e4947a6ccb3d8263a1f08ff86bcfe9757b0
+SHA512:
+  metadata.gz: 29a5246b5ce296df3a5e6854df5ca1da37545ee3e3f6368d2843f458218f6be73230fd31b200402c30415200a9a91666f8ba59eebcc042a2c1eeb08656e62aa4
+  data.tar.gz: 1cabaa25bd0e87c9dd9d6f05a5ae947a9eb5edbb52e8919f181db0dcfd2216d09ffee354780c85b3f438c466290bc6548628f17734850508b196f253ea8c4a2e

data/CHANGELOG.md

@@ -0,0 +1,37 @@
+# 0.6.0
+
+- Fix when an html content is expected and no content type is specified
+- Prevents conflicts with Sinatra::Json library, fix by Grant McLendon
+
+# 0.5.0
+
+- Fix for header parameters
+- Accept file parameter
+
+# 0.4.0
+
+- Validate responses
+- No validation when the parameter is null
+- Accept :no_swagger param in declaration
+
+# 0.3.0
+
+- Can now accept types as parameters
+- Accept json utf-8 content type
+
+# 0.2.0
+
+- Fix empty value returned from validation when a parameter is a String
+- Added maxLength and minLength validations
+- Add produces parameter
+- Add fluent syntax
+
+# 0.1.0
+
+- Added verification and enrichment form params
+- Added type extends
+- Added validation for min and max value for numbers
+
+# 0.0.1
+
+- First version

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'codeclimate-test-reporter', group: :test, require: nil
+gem 'coveralls', require: false

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Julien Kirch
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,118 @@
+# Sinatra::SwaggerExposer
+
+[![Code Climate](https://codeclimate.com/github/archiloque/sinatra-swagger-exposer/badges/gpa.svg)](https://codeclimate.com/github/archiloque/sinatra-swagger-exposer)
+[![Build Status](https://travis-ci.org/archiloque/sinatra-swagger-exposer.svg?branch=master)](https://travis-ci.org/archiloque/sinatra-swagger-exposer)
+[![Coverage Status](https://coveralls.io/repos/archiloque/sinatra-swagger-exposer/badge.svg?branch=master)](https://coveralls.io/r/archiloque/sinatra-swagger-exposer?branch=master)
+
+Create Swagger endpoint for your Sinatra application.
+
+This Sinatra extension enable you to add metadata to your code to
+
+- expose your API as a [Swagger](http://swagger.io) endpoint.
+- validate and enrich the invocation parameters
+- validate the responses during test and development
+
+I'm adding features as I need them and it currently doesn't use all the Swagger options, so if you need one that is missing please open an issue.
+
+## Design choices
+
+- All the declarations are validated when the server is started
+- The declarations are defined to look as ruby-ish as possible
+- Declarations are used for parameters validation and enrichment
+
+## Usage
+
+Bring in the 'sinatra-swagger-exposer' gem from [rubygems](https://rubygems.org/gems/sinatra-swagger-exposer).
+
+To use it in your app :
+
+```ruby
+require 'sinatra/swagger-exposer/swagger-exposer'
+
+class MyApp < Sinatra::Base
+
+  register Sinatra::SwaggerExposer
+
+  general_info(
+      {
+          version: '0.0.1',
+          title: 'My app',
+          description: 'My wonderful app',
+          license: {
+              name: 'MIT',
+              url: 'http://opensource.org/licenses/MIT'
+          }
+      }
+  )
+
+  type 'Status',
+               {
+                   :properties => {
+                       :status => {
+                           :type => String,
+                           :example => 'OK',
+                       },
+                   },
+                   :required => [:status]
+               }
+
+  endpoint_description 'Base method to ping'
+  endpoint_response 200, 'Status', 'Standard response'
+  endpoint_tags 'Ping'
+  get '/' do
+    json({'status' => 'OK'})
+  end
+
+end
+```
+
+The swagger json endpoint will be exposed at `/swagger_doc.json`.
+
+You can also use a more fluent variant by providing a hash to the `endpoint` method
+
+
+```ruby
+  endpoint :description => 'Base method to ping',
+           :responses { 200 => ['Status', 'Standard response']}
+           :tags 'Ping'
+  get '/' do
+    json({'status' => 'OK'})
+  end
+```
+
+The hash should contains the key `description`, `summary`, `path`, `tags`, `responses` and `params`.
+Note both `responses` and `params` takes a hash as argument `hash(param_name =>param_details)` and `hash(status_code=>res_param)`
+
+If the equivalent methods have more than one param, theses are wrapped in an array.
+
+
+## Detailed example
+
+A more complete example is available [here](https://github.com/archiloque/sinatra-swagger-exposer/tree/master/example).
+
+## About swagger-ui
+
+- If you to use [swagger-ui](https://github.com/swagger-api/swagger-ui) with your app you will need to add croo-origin setup.
+The easiest way is to use the [sinatra-cross_origin](https://github.com/britg/sinatra-cross_origin) gem. Fro a simple sample you can have a look at [example application](https://github.com/archiloque/sinatra-swagger-exposer/tree/master/example).
+- Swagger-ui doesn't work with all the swagger features
+  - Some of them like parameters maximum and minimum values are ignored
+  - Some of them like extending types make the endpoint unusable
+
+## Changes
+
+Changelog is [here](https://github.com/archiloque/sinatra-swagger-exposer/blob/master/CHANGELOG.md).
+
+## Resources
+
+- [Swagger RESTful API Documentation Specification](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md).
+- [Swagger json examples](https://github.com/swagger-api/swagger-spec/tree/master/examples/v2.0/json).
+- [The swagger json schema](https://raw.githubusercontent.com/swagger-api/swagger-spec/master/schemas/v2.0/schema.json).
+
+## Todo
+
+- More parameters taken into account
+- More validations where possible
+
+## License
+
+This software is released under the MIT license.

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/test-*.rb'
+end
+
+task :default => :test

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

@@ -0,0 +1,124 @@
+require_relative '../swagger-invalid-exception'
+require_relative '../swagger-parameter-helper'
+
+module Sinatra
+
+  module SwaggerExposer
+
+    module Configuration
+
+      module SwaggerConfigurationUtilities
+
+        include ::Sinatra::SwaggerExposer::SwaggerParameterHelper
+
+        def ref_to_type(type)
+          {'$ref' => "#/definitions/#{type}"}
+        end
+
+        def hash_to_swagger(hash)
+          result = {}
+          hash.each_pair do |key, value|
+            result[key] = value.to_swagger
+          end
+          result
+        end
+
+        # Transform a type into a String
+        # @return [String]
+        def type_to_s(value)
+          if [TrueClass, FalseClass].include? value
+            TYPE_BOOLEAN
+          elsif value == DateTime
+            TYPE_DATE_TIME
+          elsif value.is_a? Class
+            value.to_s.downcase
+          else
+            value
+          end
+        end
+
+        def get_type(type, possible_values)
+          @type = type
+          if type.nil?
+            raise SwaggerInvalidException.new('Type is nil')
+          elsif type.is_a?(String) || @type.is_a?(Class)
+            @type = type_to_s(@type)
+            check_type(@type, possible_values)
+          elsif @type.is_a? Array
+            @items = type_to_s(get_array_type(@type))
+            check_type(@items, possible_values)
+            @type = TYPE_ARRAY
+          else
+            raise SwaggerInvalidException.new("Type [#{@type}] of has an unknown type, should be a class, a string or an array")
+          end
+        end
+
+        # Validate if a parameter is in a list of available values
+        # @param params [Hash] the parameters
+        # @param allowed_values [Enumerable, #include?] the allowed values
+        # @param ignored_values [Enumerable, #include?] values to ignore
+        # @return [Hash] the filtered hash
+        def white_list_params(params, allowed_values, ignored_values = [])
+          result = {}
+          params.each_pair do |key, value|
+            if allowed_values.include? key
+              result[key] = value
+            elsif !ignored_values.include?(key)
+              raise SwaggerInvalidException.new("Unknown property [#{key}] with value [#{value}]#{list_or_none(allowed_values, 'properties')}")
+            end
+          end
+          result
+        end
+
+        def list_or_none(list, name)
+          if list.empty?
+            ", no available #{name}"
+          else
+            ", possible #{name} are #{list.sort.join(', ')}"
+          end
+        end
+
+        # Validate if a value is suitable for a name
+        # @param name [String] the name
+        # @return [NilClass]
+        def check_name(name)
+          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
+        end
+
+        private
+
+        def get_array_type(array)
+          if array.empty?
+            raise SwaggerInvalidException.new('Type is an empty array, you should specify a type as the array content')
+          elsif array.length > 1
+            raise SwaggerInvalidException.new("Type [#{array}] has more than one entry, it should only have one")
+          else
+            type_to_s(array[0])
+          end
+        end
+
+        # Validate if a type is in a list of available values
+        # @param type [String] the parameter
+        # @param allowed_values [Enumerable, #include?] the allowed values
+        # @return [NilClass]
+        def check_type(type, allowed_values)
+          if allowed_values.empty?
+            raise SwaggerInvalidException.new("Unknown type [#{type}], no available type")
+          elsif !allowed_values.include?(type)
+            raise SwaggerInvalidException.new("Unknown type [#{type}]#{list_or_none(allowed_values, 'types')}")
+          end
+        end
+
+      end
+
+    end
+
+  end
+
+end

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

@@ -0,0 +1,113 @@
+require_relative '../swagger-invalid-exception'
+
+require_relative 'swagger-parameter-validation-helper'
+require_relative 'swagger-type-property'
+require_relative 'swagger-configuration-utilities'
+
+module Sinatra
+
+  module SwaggerExposer
+
+    module Configuration
+
+      class SwaggerEndpointParameter
+
+        include SwaggerConfigurationUtilities
+        include SwaggerParameterValidationHelper
+
+        attr_reader :type, :name, :required, :default, :params, :items, :how_to_pass
+
+        # Create a new instance
+        # @param name [String] the name
+        # @param description [String] the description
+        # @param how_to_pass [String] how to pass the parameter
+        # @param required [TrueClass] if the parameter is required
+        # @param type [String] the type name
+        # @param params [Hash] parameters
+        # @param known_types [Array<String>] known custom types names
+        def initialize(name, description, how_to_pass, required, type, params, known_types)
+          check_name(name)
+          @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 + [TYPE_FILE])
+          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(@type == TYPE_ARRAY ? @items : @type, params)
+          @default = params[PARAMS_DEFAULT]
+          @params = params
+        end
+
+
+        # Return the swagger version
+        # @return [Hash]
+        def to_swagger
+          result = {
+            :name => @name,
+            :in => @how_to_pass,
+            :required => @required
+          }
+
+          if @type
+            if @type == TYPE_ARRAY
+              result[:type] = 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
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,96 @@
+require_relative '../swagger-invalid-exception'
+
+require_relative 'swagger-configuration-utilities'
+
+module Sinatra
+
+  module SwaggerExposer
+
+    module Configuration
+
+      class SwaggerEndpointResponse
+
+        include SwaggerConfigurationUtilities
+
+        attr_reader :type, :items
+
+        RESPONSE_PRIMITIVES_FILES = PRIMITIVE_TYPES + [TYPE_FILE]
+
+        # @param type the type
+        # @param description [String] the description
+        # @param known_types [Array<String>] known custom types names
+        # @param headers [Array<String] the headers names
+        # @param known_headers [Sinatra::SwaggerExposer::Configuration::SwaggerResponseHeaders] the known headers
+        def initialize(type, description, known_types, headers, known_headers)
+          if type
+            get_type(type, known_types + RESPONSE_PRIMITIVES_FILES)
+          end
+
+          if description
+            @description = description
+          end
+
+          @headers = {}
+          headers.each do |header_name|
+            header_name = header_name.to_s
+            if @headers.key? header_name
+              raise SwaggerInvalidException.new("Duplicated header_name [#{header_name}]")
+            end
+            unless known_headers.key? header_name
+              raise SwaggerInvalidException.new("Unknown header_name [#{header_name}]")
+            end
+            @headers[header_name] = known_headers[header_name]
+          end
+
+        end
+
+        def to_swagger
+          result = {}
+
+          if @type
+            if @type == TYPE_ARRAY
+              schema = {:type => 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
+
+          unless @headers.empty?
+            swagged_headers = {}
+            @headers.each_pair do |name, value|
+              swagged_headers[name] = value.to_swagger
+            end
+            result[:headers] = swagged_headers
+          end
+
+          result
+        end
+
+        def to_s
+          {
+            :type => @type,
+            :items => @items,
+            :description => @description,
+          }.to_json
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,101 @@
+require_relative '../swagger-invalid-exception'
+
+require_relative 'swagger-configuration-utilities'
+
+module Sinatra
+
+  module SwaggerExposer
+
+    module Configuration
+
+      # An endpoint
+      class SwaggerEndpoint
+
+        include SwaggerConfigurationUtilities
+
+        attr_reader :path, :type, :parameters, :responses, :produces
+
+        # @param type [String] the http verb
+        # @param sinatra_path [String] the sinatra path
+        # @param parameters [Array<Sinatra::SwaggerExposer::Configuration::SwaggerEndpoint>] the endpoint parameters
+        # @param responses [Hash<Integer, Sinatra::SwaggerExposer::Configuration::SwaggerEndpointResponse>] the endpoint possible responses
+        # @param summary [String] a summary for the endpoint
+        # @param description [String] a description for the endpoint
+        # @param tags [Array<String>] a list of tags
+        # @param explicit_path [String] an explicit path if the sinatra path is a regex
+        # @param produces [Array<String>] the result types
+        def initialize(type, sinatra_path, parameters, responses, summary, description, tags, explicit_path, produces)
+          @type = type
+          @path = swagger_path(sinatra_path, explicit_path)
+
+          @parameters = parameters
+          @responses = responses
+          @produces = produces
+
+          @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
+
+        # Return a swagger version
+        # @return [Hash]
+        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
+end