sinatra-swagger 0.1.1 → 0.2.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    OGRhZDE4ZTc4ZDFlMDAxYTY1MGI5OTU1MzNmMDRiYTQwM2UwNmZjZA==
+    MjY0OWY2MzkyM2NiOWJhNWUxZjZiNjkwODhhMTgxNDkzMjBiNzI1NA==
   data.tar.gz: !binary |-
-    MTExNmY2MWU5ZTdiNDZiM2YzMmRjMGI0ZmMzY2EzNWYxYjdhMWQzNQ==
+    NTcwYmUxZGNhZTg5OTkwMzc1Y2YwOWYxYzBmNDQ2ZTQ4OGE2MjY3Ng==
 SHA512:
   metadata.gz: !binary |-
-    NzBkMzEzOGFhNzVmN2I1YjUwNzU4OWE5Mjc0NWY0NjE2OTg0YTI0ZTllOTI3
-    NWFlYTBjMzIzOGI2N2IzZjAyYWYwNjI4MDdkNWI5MDA1NDYxNjhkNTAxYmIx
-    MDZjOTNmN2Y2ZDVjYTBhZDc3ZWJjMmZjYmFlYWZiMzAyM2QxNTU=
+    OTFkMjcyNGFjYjJhZDlkMWIyMTA4OGRmNjNjMzI2NWJmMGNiY2I0NTkxYTlk
+    MGY5NTI3ZDRiMTgwZDM0ZmUwMmVkMDdiNzZmMDAwZWQ3NzU1YjVhZTFhMGU1
+    ZjAzZmU2MzRiNTZkOTI2ZTE1OTY1ZTc3NTk5MWQ4YzU0ZTFjMDQ=
   data.tar.gz: !binary |-
-    NjA2YTZjMzg3MmE2OWY2OGU2OTczYmIxNTI5NDdjZWJmZDE1MDFjNDJmYjI4
-    ZmEyZGY3MGY1Y2VhZWMwZjk1ZGVkMTg4OWNhMzQ4NjM5YWQ4ZjgyMTFlMzY5
-    ZjY0Njg2NTY2MDcwMjI0YjY5MDJhMWM2NjNmOTM1MTcwNDA2ZDY=
+    ZWFkNGI4Y2EyYWEzOTU0ZjJkNjExMDEyNWNhNWNmMmE3ZGMyYWMxNDllOWE1
+    YjdjOGI5NjJjODVlZWJjZDQ2NmYzNjdlM2E3M2M2ZWMyM2ZhZDlkYjQ5ODQ0
+    ZWIxYjZhZTQ2NjQ2M2EzNzM3MmVlZDNiM2Q4ZmMzZTM5YzI0NWY=

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/lib/sinatra/swagger/param_validator.rb

@@ -0,0 +1,55 @@
+require "sinatra/swagger/swagger_linked"
+
+module Sinatra
+  module Swagger
+    module ParamValidator
+      def self.registered(app)
+        app.register Swagger::SwaggerLinked
+
+        app.before do
+          next if swagger_spec.nil?
+          _, captures, spec = swagger_spec.values
+
+          invalidities = Hash[(spec['parameters'] || []).map { |details|
+            param_name = details['name']
+
+            parameter = case details['in']
+            when "query"
+              params[param_name]
+            when "path"
+              captures[param_name]
+            else
+              raise NotImplementedError, "Can't cope with #{details['in']} parameters right now"
+            end
+
+            if !parameter
+              next [param_name, :missing] if details['required'] && details['required'] != "false"
+              next unless details['default']
+              parameter = details['default']
+            end
+
+            begin
+              parameter = ::Swagger.cast(parameter.to_s, details['type']) if parameter
+            rescue ArgumentError
+              next [param_name, :incorrect_type]
+            end
+
+            if %w{integer number}.include? details['type']
+              too_large = details['maximum'] && parameter > details['maximum']
+              too_small = details['minimum'] && parameter < details['minimum']
+              next [param_name, :out_of_range] if too_large || too_small
+            end
+
+            params[param_name] = parameter
+
+            nil
+          }.compact]
+
+          halt 400, invalidities.to_json if invalidities.any?
+        end
+      end
+    end
+  end
+
+  register Swagger::ParamValidator
+end

data/lib/sinatra/swagger/spec_enforcer.rb

@@ -1,68 +1,25 @@
-require "yaml"
-require "swagger/rack"
+require "sinatra/swagger/param_validator"
 
 module Sinatra
   module Swagger
     module SpecEnforcer
-      def swagger(filepath)
-        set :swagger, ::Swagger::Base.new(filepath)
-      end
-
       def self.registered(app)
-        app.helpers Helpers
-
-        app.before do
-          spec = swagger_spec
-          unless spec.nil?
-            _, captures, spec = spec.values
-
-            invalidities = Hash[(spec['parameters'] || []).map { |details|
-              param_name = details['name']
-
-              parameter = case details['in']
-              when "query"
-                params[param_name]
-              when "path"
-                captures[param_name]
-              else
-                raise NotImplementedError, "Can't cope with #{details['in']} parameters right now"
-              end
-
-              if !parameter
-                next [param_name, :missing] if details['required'] && details['required'] != "false"
-                next unless details['default']
-                parameter = details['default']
-              end
-
-              begin
-                parameter = ::Swagger.cast(parameter.to_s, details['type']) if parameter
-              rescue ArgumentError
-                next [param_name, :incorrect_type]
-              end
-
-              if %w{integer number}.include? details['type']
-                too_large = details['maximum'] && parameter > details['maximum']
-                too_small = details['minimum'] && parameter < details['minimum']
-                next [param_name, :out_of_range] if too_large || too_small
-              end
-
-              params[param_name] = parameter
-
-              nil
-            }.compact]
-
-            halt 400, invalidities.to_json if invalidities.any?
+        app.register Swagger::SwaggerLinked
+
+        app.after do
+          next unless response.content_type =~ %r{^application/(?:.+\+)?json$}
+          next unless body = JSON.parse(response.body.first) rescue nil
+          next if swagger_spec.nil?
+          schema = schema_from_spec_at("responses/#{response.status}/schema")
+          next if schema.nil?
+          begin
+            JSON::Validator.validate!(schema, body)
+          rescue JSON::Schema::ValidationError => e
+            e.message = "Response JSON did not match the Swagger schema: #{e.message}"
+            raise e
           end
         end
       end
-
-      module Helpers
-        def swagger_spec
-          settings.swagger.request_spec(env: env)
-        end
-      end
     end
   end
-
-  register Swagger::SpecEnforcer
 end

data/lib/sinatra/swagger/swagger_linked.rb

@@ -0,0 +1,32 @@
+require "swagger/rack"
+
+module Sinatra
+  module Swagger
+    module SwaggerLinked
+      def swagger(filepath)
+        set :swagger, ::Swagger::Base.from_file(filepath)
+      end
+
+      def self.registered(app)
+        app.helpers Helpers
+      end
+
+      module Helpers
+        def swagger_spec
+          raise "No swagger file loaded" unless settings.swagger
+          settings.swagger.request_spec(env: env)
+        end
+
+        def schema_from_spec_at(path)
+          schema = swagger_spec[:spec]
+          path.split("/").each do |key|
+            schema = schema[YAML.load(key)]
+            return if schema.nil?
+          end
+          schema['definitions'] = settings.swagger['definitions'] if settings.swagger['definitions']
+          schema
+        end
+      end
+    end
+  end
+end

data/lib/swagger/base.rb

@@ -25,9 +25,17 @@ module Swagger
       JSON::Validator.add_schema(JSON::Schema.new(data, data['id']))
     end
 
-    def initialize(filepath)
-      @spec = YAML.load(open(filepath))
+    def initialize(data)
+      @spec = data
       JSON::Validator.validate!({ "$ref" => "http://swagger.io/v2/schema.json#" }, @spec)
     end
+
+    def self.from_file(filepath)
+      new(YAML.load(open(filepath)))
+    end
+
+    def [](key)
+      @spec[key]
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sinatra-swagger
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - JP Hastings-Spital
@@ -81,7 +81,9 @@ files:
 - Rakefile
 - VERSION
 - lib/sinatra/swagger.rb
+- lib/sinatra/swagger/param_validator.rb
 - lib/sinatra/swagger/spec_enforcer.rb
+- lib/sinatra/swagger/swagger_linked.rb
 - lib/sinatra/swagger/version.rb
 - lib/swagger/base.rb
 - lib/swagger/rack.rb