sinatra-swagger 0.3.1 → 0.4.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZDc0OTRhNWUyNTY5YWI2MjAxODBhMmRhODk4ODBlNmExMGMxOTRiYg==
+    NTI2YmQ2ZGUxOTJmNjk0YmZlNTRhNTNlYmE4MjM1YTAzYjk2ZWZkNw==
   data.tar.gz: !binary |-
-    YWNlNDJiZWY2YTc3ZDg1MDFmNTYyOWVkMjI1NjMxNDUzYjFhMjYwYw==
+    YzMxYzIzOTRmNTcyZWIyYTM2NTIxMGRkZjc3Yzk3Njk1MzQzODU0MQ==
 SHA512:
   metadata.gz: !binary |-
-    ZTU0NWQ4YmExNDZhZmUwNDM2Mjg5YWNkNTc0YzQxNzQ3ZDIxY2RmZWRkYzBi
-    MzNhYjI1MmMzZmE3YWU0ZTU0MDhjMDRiMzk4Njg0Y2M0MmY3ZDAwNGRmZjc3
-    ZWZkODJlMjc0MWQ2MTc3NTM3Zjc0OThjYzNmOWE5NWIyZjQ0OTk=
+    ODdhYTJlYzVjZDUzOWU5MTVhOTNjNTczYzdhMmY2M2VjNDliZjM4YzQ0Y2Ri
+    YzgyMTM1ZjU4NmE4ZDA4MzU3MzZhNjQ5Y2ExMjc5NWYwYjMzMGI4MzdhNDU5
+    Mjg2MTk1MDliZjFiNjJlMzZkNzQwY2VlNDRjYzMyOWVmNGZjMWU=
   data.tar.gz: !binary |-
-    MzZjZTU0N2JkYjlhYjUxNTVlNDA2OTFhMDViMjYxYzlhNTIwZTA4NDlhMDUx
-    YTdlYjkxNGE2NjQ4ZDI3NmE1ZTEyMzAzZTM0ZTEyNzliZmUzMDA5Y2I3MDI4
-    ZjBmOTdiODJjYTMyZTdlNWVjZDc4MzhhODIwMzQ0NzMzYmFmY2Q=
+    MDZlZjU2YzZmN2EzYzdjMmFiZjRhYTQyMTkzYjBhMTk4OGRjZjlhMWU4N2Ew
+    ZWU1MzM3OWI2NjIxMjMzMGMyZWYxMmUzMDllNDJiYmVkNjgwOWNiMjM2YzI2
+    YjJmYjQ4ZDliMDBmMTgzMWZlYTU4N2U2MjQzNjJmY2NjYWQxNzM=

data/README.md

@@ -4,6 +4,31 @@ Extensions & helper methods for accesing your swagger documentation from within
 
 This library is in the *very* early stages of development, there will be 'obvious' features that are missing and wild inefficiencies, but please feel free to file issues/enhancements if there's anything you think would be useful.
 
+## Recommended Setup
+
+This extension encorporates all the extensions in a way that makes sense for most web applications, it's included by default for "classic" style applications.
+
+```
+require "sinatra"
+require "sinatra/swagger"
+
+swagger "my-swagger.yaml"
+
+# …etc
+```
+
+```
+require "sinatra/base"
+require "sinatra/swagger"
+
+class Search < Sinatra::Base
+  register Sinatra::Swagger::RecommendedSetup
+  swagger "my-swagger.yaml"
+
+  # …etc
+end
+```
+
 ## Param Validator
 
 This extension will use the `parameters` component of the route being accessed from your Swagger document to type cast your incoming parameters and raise `400` errors if any are incorrect:
@@ -115,4 +140,50 @@ end
 
 The `after` hook will check the response body and will run the schema validation and raise a `JSON::Schema::ValidationError` exception as the output doesn't match the schema.
 
-In order to not be restrictive, if the output doesn't look like JSON or if there's no schema defined, then no action will be taken and the body will be sent to the client.
+In order to not be restrictive, if the output doesn't look like JSON or if there's no schema defined, then no action will be taken and the body will be sent to the client.
+
+## Spec Verb
+
+This module configures your application to respond to requests to the root (`/`) using the **SPEC** verb. The response is `text/vnd.swagger.v2+yaml` with the full swagger document that your server is using.
+
+```ruby
+require "sinatra/base"
+require "sinatra/swagger"
+
+class Search < Sinatra::Base
+  register Sinatra::Swagger::SpecVerb
+  swagger "swagger/shows.yaml"
+end
+```
+
+Inspecting a curl request:
+
+```bash
+$ curl -v -X SPEC http://127.0.0.1:9292
+> SPEC / HTTP/1.1
+> User-Agent: curl/7.37.1
+> Host: 127.0.0.1:9292
+> Accept: */*
+>
+< HTTP/1.1 200 OK
+< Content-Type: text/vnd.swagger.v2+yaml; charset=utf-8
+---
+swagger: 2.0
+paths:
+  /shows/{showId}:
+  # …etc
+```
+
+## Version Header
+
+Adds an `X-Application-Version` header to every response which is set to the application title and version as set in the Swagger document, eg. `X-Application-Version: Application Title (0.1.0)`
+
+```ruby
+require "sinatra/base"
+require "sinatra/swagger"
+
+class Search < Sinatra::Base
+  register Sinatra::Swagger::VersionHeader
+  swagger "swagger/shows.yaml"
+end
+```

data/VERSION

@@ -1 +1 @@
-0.3.1
+0.4.0

data/lib/sinatra/swagger/param_validator.rb

@@ -107,6 +107,4 @@ module Sinatra
       end
     end
   end
-
-  register Swagger::ParamValidator
 end

data/lib/sinatra/swagger/recommended_setup.rb

@@ -0,0 +1,19 @@
+require "sinatra/swagger/param_validator"
+require "sinatra/swagger/spec_enforcer"
+require "sinatra/swagger/spec_verb"
+require "sinatra/swagger/version_header"
+
+module Sinatra
+  module Swagger
+    module RecommendedSetup
+      def self.registered(app)
+        app.register Sinatra::Swagger::SpecEnforcer unless app.production?
+        app.register Sinatra::Swagger::ParamValidator
+        app.register Sinatra::Swagger::SpecVerb
+        app.register Sinatra::Swagger::VersionHeader
+      end
+    end
+  end
+
+  register Swagger::RecommendedSetup
+end

data/lib/sinatra/swagger/spec_verb.rb

@@ -0,0 +1,18 @@
+require "sinatra/multi_route"
+require "sinatra/swagger/swagger_linked"
+
+module Sinatra
+  module Swagger
+    module SpecVerb
+      def self.registered(app)
+        app.register Sinatra::MultiRoute
+        app.register Swagger::SwaggerLinked
+
+        app.route 'SPEC', '/' do
+          content_type "text/vnd.swagger.v2+yaml; charset=utf-8"
+          YAML.dump(settings.swagger.spec)
+        end
+      end
+    end
+  end
+end

data/lib/sinatra/swagger/version_header.rb

@@ -0,0 +1,15 @@
+require "sinatra/swagger/swagger_linked"
+
+module Sinatra
+  module Swagger
+    module VersionHeader
+      def self.registered(app)
+        app.register Swagger::SwaggerLinked
+
+        app.before do
+          headers['X-Application-Version'] = "#{settings.swagger['info']['title']} (#{settings.swagger['info']['version']})"
+        end
+      end
+    end
+  end
+end

data/lib/sinatra/swagger.rb

@@ -1,3 +1,6 @@
 require "sinatra/swagger/version"
 require "sinatra/swagger/param_validator"
 require "sinatra/swagger/spec_enforcer"
+require "sinatra/swagger/spec_verb"
+require "sinatra/swagger/version_header"
+require "sinatra/swagger/recommended"

data/lib/swagger/base.rb

@@ -19,6 +19,8 @@ module Swagger
   end
 
   class Base
+    attr_reader :spec
+    
     # Pre-load JSON-schema files used for validation
     Dir.glob(File.join(__dir__, "../../schema/*-schema.json")) do |schema|
       data = JSON.parse(File.read(schema))

data/sinatra-swagger.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency "json-schema", "~> 2.5", ">= 2.5.1"
   s.add_dependency "sinatra", "~> 1.4"
+  s.add_dependency "sinatra-contrib", "~>1.4"
 
   s.add_development_dependency "rake", "~> 10.4"
   s.add_development_dependency "rspec", "~> 3.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sinatra-swagger
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - JP Hastings-Spital
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-24 00:00:00.000000000 Z
+date: 2015-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-schema
@@ -44,6 +44,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: sinatra-contrib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -88,9 +102,12 @@ files:
 - VERSION
 - lib/sinatra/swagger.rb
 - lib/sinatra/swagger/param_validator.rb
+- lib/sinatra/swagger/recommended_setup.rb
 - lib/sinatra/swagger/spec_enforcer.rb
+- lib/sinatra/swagger/spec_verb.rb
 - lib/sinatra/swagger/swagger_linked.rb
 - lib/sinatra/swagger/version.rb
+- lib/sinatra/swagger/version_header.rb
 - lib/swagger/base.rb
 - lib/swagger/rack.rb
 - schema/README.md