sinatra-swagger 0.2.2 → 0.3.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MDU1MzAwYzE1OTIwMWRhYzllOGY5Mjg0NWM3MWRiNjJkNzI0ZGI0Nw==
+    MTY4N2VlNjk0OTliMGZhNDIwNTEyZjdlYzU5OGVjYWRkYmNjYWI0Yg==
   data.tar.gz: !binary |-
-    ZjQ2MjM1NThmOTM0MDcyYTAxOTk5MGE5ZDcyYWEzYmNiZmZlNTEwYw==
+    NzYyM2FiYjczYzFlNGMwMjgxNmI2MjI3ZmFjMDdiZDI4YzM1NGE1YQ==
 SHA512:
   metadata.gz: !binary |-
-    ZDQwZDY4ODAxZGMxZjg5NGNlMmNlOTU4MzVkNDkzNjRmNmIzNWM3NmY5Zjdj
-    NDZkZGYxZTFjZjQzMWJhMGI5MDk1MzRhMGM3ZGIxODY5ZjlkZWE1YzZhM2Y1
-    ZDY3ZTRlMmY3ZmIxNGM5NDk1ZmMwZGRlY2JkOTA4OTZhMjcyOTM=
+    ZGM5NTY5YzU5MzNjMTA4YzQwN2JjOTIxZWVkZmYyNjlkNTViMGQ0OTAzNDU0
+    YTBkMTg3OTZhMzhiMTczZWY4N2Q0ODU1YTgyMjJkY2U1MjE5ZDAwNDI5Njhh
+    NDA4ODBmZjc5YzliM2JmMGY4YTk1Y2U4YzczZTc4ZWJmNzg1ZDc=
   data.tar.gz: !binary |-
-    OGM5ZWFmNjQxZTMyN2JlYmIzNGMxN2E1MzVmOTM3MDEyYzhmOThkNzVjY2Vj
-    ZWVhODU4OTJjMWZmNjMxNDQ4M2JjMDU4ODc3ZTFlNzNlMjk2ODUyZjJiM2Qz
-    YzkxZGVjZDg2OGE2ODQ3MjAyOTkwZjVhOTEwMjY3NWFiM2U2NWY=
+    YzUwMWI4MWI0Nzk5ZjJiYjY1NDViYWVjMDYxY2Q1YjNkODYzNjEyZDBlNTBm
+    Yzg0MmZiZDE2ZTdlMTc0NDdiN2MxZGNiMTNjMmZhNGE3MjBiOTYxMDQ3ZmU5
+    Nzg1MjFmZGFhZThmZTUwZDA2MGFiMGVjZmU0MDE3YTg5OWRjYzI=

data/VERSION

@@ -1 +1 @@
-0.2.2
+0.3.0

data/lib/sinatra/swagger/param_validator.rb

@@ -8,34 +8,72 @@ module Sinatra
 
         app.helpers do
           def invalid_params(invalidities)
-            content_type :json
-            halt(
-              400,
-              {
-                error: 'invalid_params',
-                developerMessage: 'Some of the given parameters were invalid according to the Swagger spec.',
-                details: {
-                  invalidities: invalidities
+            error_response(
+              'invalid_params',
+              'Some of the given parameters were invalid according to the Swagger spec.',
+              details: { invalidities: invalidities },
+              status: 400
+            )
+          end
+
+          def invalid_content_type(acceptable)
+            error_response(
+              'invalid_content',
+              'The ',
+              details: {
+                content_types: {
+                  acceptable: acceptable,
+                  given: request.content_type
                 }
-              }.to_json
+              },
+              status: 400
             )
           end
+
+          def error_response(code, dev_message, details: {}, status: 400)
+            content_type :json
+            halt(status,{
+              error: code,
+              developerMessage: dev_message,
+              details: details
+            }.to_json)
+          end
         end
 
         app.before do
           next if swagger_spec.nil?
           _, captures, spec = swagger_spec.values
+          invalid_content_type(spec['consumes']) if spec['consumes'] && !spec['consumes'].include?(request.content_type)
+
+          unknown_params = params.keys.select { |k| k.is_a?(String) }
 
           invalidities = Hash[(spec['parameters'] || []).map { |details|
             param_name = details['name']
+            unknown_params.delete(param_name)
 
             parameter = case details['in']
             when "query"
               params[param_name]
             when "path"
               captures[param_name]
+            when "body"
+              request.body.rewind
+              params[:body] = request.body.read
+              next nil unless request.content_type =~ %r{^application/(?:.+\+)?json}
+
+              begin
+                params[:body] = JSON.parse(params[:body])
+              rescue JSON::ParserError
+                next ['POST body', :invalid_json]
+              end
+              next nil unless details['schema']
+
+              schema = details['schema'].merge('definitions' => settings.swagger['definitions'])
+              errors = JSON::Validator.fully_validate(schema, params[:body])
+              next errors.empty? ? nil : ['POST body', errors]
             else
-              raise NotImplementedError, "Can't cope with #{details['in']} parameters right now"
+              # other param types aren't dealt with at the moment
+              next
             end
 
             if !parameter
@@ -61,7 +99,10 @@ module Sinatra
             nil
           }.compact]
 
-          invalid_params(invalidities) if invalidities.any?
+          if invalidities.any?
+            unknown_params.each { |p| invalidities[p] = :unexpected_key }
+            invalid_params(invalidities)
+          end
         end
       end
     end

data/lib/sinatra/swagger/spec_enforcer.rb

@@ -15,7 +15,7 @@ module Sinatra
           begin
             JSON::Validator.validate!(schema, body)
           rescue JSON::Schema::ValidationError => e
-            e.message = "Response JSON did not match the Swagger schema: #{e.message}"
+            e.message = "Response JSON did not match the Swagger schema: #{e.message}\n#{body}"
             raise e
           end
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sinatra-swagger
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - JP Hastings-Spital
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-15 00:00:00.000000000 Z
+date: 2015-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-schema