grape-swagger 0.20.1 → 0.20.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a7b49d3317f5b9d9082b501e10b2a7fd14715cbc
-  data.tar.gz: badfe74ba2b87d06cdfd44c98e9ce3e26a9bb30e
+  metadata.gz: 5e7244ce5e2e54fd314fdf08bb3a948aa85c1981
+  data.tar.gz: c2647e5425cfd200375341daf3ee1f691709863b
 SHA512:
-  metadata.gz: bff5776130052d3c48d45a2a26bc59cef0ad264bfd5adaf197280019ba79476c5e8e6c9566a7c345b595664df5e27ccc259986c9d94d010873636a6d9e49eb6b
-  data.tar.gz: 1685bef67cd8be2e477dab910d42e1236409b38040a34f08697ccc3fdd5ae8871d73b05b00e25f1c8b1ab96f3f158d8f9ee8c6817e83532bd9f5bb2044137ad1
+  metadata.gz: ebce21c42bb460babe20f85d0b4e020d111f5c992be70e4b58595cdd6e3efc9e0c7060eca217f32dba61d6e0c422ba9a3243f995cf41fae265076ab0e6298362
+  data.tar.gz: a6b0ac5ec95360f00a86eeff4107499caa33b2d55c70f243a5132e538945d68d46bae621dd58026a30254d8b005f4e291ca171b50a88bc28d7fe77661d406f59

data/CHANGELOG.md

@@ -4,6 +4,10 @@
 
 #### Fixes
 
+* [#394](https://github.com/ruby-grape/grape-swagger/pull/394): removes overiding default trough example - [@LeFnord](https://github.com/LeFnord).
+* [#393](https://github.com/ruby-grape/grape-swagger/pull/393): properly handle header parameters - [@wleeper](https://github.com/wleeper).
+* [#389](https://github.com/ruby-grape/grape-swagger/pull/389): respect X-Forwarded-Host - [@edvakf](https://github.com/edvakf).
+
 ### 0.20.1 / 2016-04-17
 
 #### Features

data/README.md

@@ -7,6 +7,7 @@
 
 * [What is grape-swagger?](#what)
 * [Related Projects](#related)
+* [Compatibility](#version)
 * [Swagger-Spec](#swagger-spec)
 * [Installation](#install)
 * [Usage](#usage)
@@ -31,9 +32,22 @@ These screenshot is based on the [Hussars](https://github.com/LeFnord/hussars) s
 ## Related Projects
 
 * [Grape](https://github.com/ruby-grape/grape)
+* [Grape Entity](https://github.com/ruby-grape/grape-entity)
 * [Swagger UI](https://github.com/wordnik/swagger-ui)
 
 
+<a name="version" />
+## Compatibility
+
+The following versions of grape, grape-entity and grape-swagger can currently be used together.
+
+grape-swagger | grape                   | grape-entity
+--------------|-------------------------|-------------
+0.10.5        | >= 0.10.0 ... <= 0.14.0 |  < 0.5.0
+0.11.0        |               >= 0.16.2 |  < 0.5.0
+0.20.1        | >= 0.12.0 ... <= 0.14.0 | <= 0.5.1
+
+
 <a name="swagger-spec" />
 ## Swagger-Spec
 

data/lib/grape-swagger/doc_methods.rb

@@ -9,6 +9,7 @@ require 'grape-swagger/doc_methods/path_string'
 require 'grape-swagger/doc_methods/tag_name_description'
 require 'grape-swagger/doc_methods/parse_params'
 require 'grape-swagger/doc_methods/move_params'
+require 'grape-swagger/doc_methods/headers'
 
 module GrapeSwagger
   module DocMethods

data/lib/grape-swagger/doc_methods/headers.rb

@@ -0,0 +1,18 @@
+module GrapeSwagger
+  module DocMethods
+    class Headers
+      class << self
+        def parse(route)
+          route.route_headers.to_a.map do |route_header|
+            route_header.tap do |header|
+              hash = header[1]
+              description = hash.delete('description')
+              hash[:documentation] = { desc: description, in: 'header' }
+              hash[:type] = hash['type'].titleize if hash['type']
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/grape-swagger/doc_methods/parse_params.rb

@@ -43,11 +43,7 @@ module GrapeSwagger
         end
 
         def document_default_value(settings)
-          default_value = settings[:default] || nil
-          example       = settings[:example] || nil
-
-          @parsed_param[:default] = example if example
-          @parsed_param[:default] = default_value if default_value && example.blank?
+          @parsed_param[:default] = settings[:default] if settings[:default].present?
         end
 
         def document_type_and_format(data_type)

data/lib/grape-swagger/endpoint.rb

@@ -24,7 +24,7 @@ module Grape
         swagger:        '2.0',
         produces:       content_types_for(target_class),
         authorizations: options[:authorizations],
-        host:           GrapeSwagger::DocMethods::OptionalObject.build(:host, options, request.env['HTTP_HOST']),
+        host:           GrapeSwagger::DocMethods::OptionalObject.build(:host, options, request.host_with_port),
         basePath:       GrapeSwagger::DocMethods::OptionalObject.build(:base_path, options, request.env['SCRIPT_NAME']),
         tags:           GrapeSwagger::DocMethods::TagNameDescription.build(options),
         schemes:        options[:schemes].is_a?(String) ? [options[:schemes]] : options[:schemes]
@@ -105,7 +105,6 @@ module Grape
     def method_object(route, options, path)
       method = {}
       method[:description] = description_object(route, options[:markdown])
-      method[:headers]     = route.route_headers if route.route_headers
       method[:produces]    = produces_object(route, options[:produces] || options[:format])
       method[:consumes]    = consumes_object(route, options[:format])
       method[:parameters]  = params_object(route)
@@ -194,14 +193,13 @@ module Grape
     def partition_params(route)
       declared_params = route.route_settings[:declared_params] if route.route_settings[:declared_params].present?
       required, exposed = route.route_params.partition { |x| x.first.is_a? String }
-
+      required.concat GrapeSwagger::DocMethods::Headers.parse(route) unless route.route_headers.nil?
       default_type(required)
       default_type(exposed)
 
-      unless declared_params.nil?
+      unless declared_params.nil? && route.route_headers.nil?
         request_params = parse_request_params(required)
       end
-
       if !exposed.empty?
         exposed_params = exposed.each_with_object({}) { |x, memo| memo[x.first] = x.last }
         properties = parse_response_params(exposed_params)
@@ -215,8 +213,7 @@ module Grape
         @definitions[key] = { type: 'object', properties: properties } unless @definitions.key?(key)
         @definitions[key][:properties].merge!(properties) if @definitions.key?(key)
       end
-
-      return route.route_params if route.route_params && !route.route_settings[:declared_params].present?
+      return route.route_params if route.route_params.present? && !route.route_settings[:declared_params].present?
       request_params || {}
     end
 
@@ -244,6 +241,7 @@ module Grape
       return if params.nil?
 
       params.each_with_object({}) do |x, memo|
+        next if x[1].fetch(:documentation, {}).fetch(:in, nil).to_s == 'header'
         x[0] = x.last[:as] if x.last[:as]
 
         model = x.last[:using] if x.last[:using].present?

data/lib/grape-swagger/version.rb

@@ -1,3 +1,3 @@
 module GrapeSwagger
-  VERSION = '0.20.1'.freeze
+  VERSION = '0.20.2'.freeze
 end

data/spec/swagger_v2/api_swagger_v2_headers_spec.rb

@@ -36,9 +36,13 @@ describe 'headers' do
   end
 
   specify do
-    expect(subject['paths']['/use_headers']['get']).to include('headers')
-    expect(subject['paths']['/use_headers']['get']['headers']).to eql({
-      "X-Rate-Limit-Limit"=>{"description"=>"The number of allowed requests in the current period", "type"=>"integer"}
-    })
+    expect(subject['paths']['/use_headers']['get']['parameters']).to eql([
+      {"in"=>"header",
+       "name"=>"X-Rate-Limit-Limit",
+       "description"=>"The number of allowed requests in the current period",
+       "type"=>"integer",
+       "format" => "int32",
+       "required"=>false},
+    ])
   end
 end

data/spec/swagger_v2/host.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe 'host in the swagger_doc' do
+  include_context "the api entities"
+
+  before :all do
+    module TheApi
+      class EmptyApi < Grape::API
+        format :json
+
+        add_swagger_documentation
+      end
+    end
+  end
+
+  def app
+    TheApi::EmptyApi
+  end
+
+  describe 'host should include port' do
+    subject do
+      get 'http://example.com:8080/swagger_doc'
+      JSON.parse(last_response.body)
+    end
+
+    specify do
+      expect(subject['host']).to eq 'example.com:8080'
+    end
+  end
+
+  describe 'respect X-Forwarded-Host over Host header' do
+    subject do
+      header 'Host', 'dummy.example.com'
+      header 'X-Forwarded-Host', 'real.example.com'
+      get '/swagger_doc'
+      JSON.parse(last_response.body)
+    end
+
+    specify do
+      expect(subject['host']).to eq 'real.example.com'
+    end
+  end
+end

data/spec/swagger_v2/param_type_spec.rb

@@ -50,7 +50,7 @@ describe 'Params Types' do
 
     it 'has consistent types' do
       types = subject.map { |param| param['type'] }
-      expect(types).to eq(%w(string))
+      expect(types).to eq(%w(string string))
     end
   end
 end

data/spec/swagger_v2/simple_mounted_api_spec.rb

@@ -97,10 +97,10 @@ describe 'a simple mounted api' do
           "/simple_with_headers"=>{
             "get"=>{
               "description"=>"this gets something else",
-              "headers"=>{
-                "XAuthToken"=>{"description"=>"A required header.", "required"=>true},
-                "XOtherHeader"=>{"description"=>"An optional header.", "required"=>false}},
               "produces"=>["application/json"],
+              "parameters"=>[
+                {"in"=>"header", "name"=>"XAuthToken", "description"=>"A required header.", "type"=>"string", "required"=>true},
+                {"in"=>"header", "name"=>"XOtherHeader", "description"=>"An optional header.", "type"=>"string", "required"=>false}],
               "tags"=>["simple_with_headers"],
               "operationId"=>"getSimpleWithHeaders",
               "responses"=>{
@@ -203,10 +203,10 @@ describe 'a simple mounted api' do
           "/simple_with_headers"=>{
             "get"=>{
               "description"=>"this gets something else",
-              "headers"=>{
-                "XAuthToken"=>{"description"=>"A required header.", "required"=>true},
-                "XOtherHeader"=>{"description"=>"An optional header.", "required"=>false}},
               "produces"=>["application/json"],
+              "parameters"=>[
+                {"in"=>"header", "name"=>"XAuthToken", "description"=>"A required header.", "type"=>"string", "required"=>true},
+                {"in"=>"header", "name"=>"XOtherHeader", "description"=>"An optional header.", "type"=>"string", "required"=>false}],
               "tags"=>["simple_with_headers"],
               "operationId"=>"getSimpleWithHeaders",
               "responses"=>{

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-swagger
 version: !ruby/object:Gem::Version
-  version: 0.20.1
+  version: 0.20.2
 platform: ruby
 authors:
 - Tim Vandecasteele
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-17 00:00:00.000000000 Z
+date: 2016-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -273,6 +273,7 @@ files:
 - lib/grape-swagger/doc_methods.rb
 - lib/grape-swagger/doc_methods/data_type.rb
 - lib/grape-swagger/doc_methods/extensions.rb
+- lib/grape-swagger/doc_methods/headers.rb
 - lib/grape-swagger/doc_methods/move_params.rb
 - lib/grape-swagger/doc_methods/operation_id.rb
 - lib/grape-swagger/doc_methods/optional_object.rb
@@ -325,6 +326,7 @@ files:
 - spec/swagger_v2/form_params_spec.rb
 - spec/swagger_v2/grape-swagger_spec.rb
 - spec/swagger_v2/hide_api_spec.rb
+- spec/swagger_v2/host.rb
 - spec/swagger_v2/mounted_target_class_spec.rb
 - spec/swagger_v2/namespace_tags_prefix_spec.rb
 - spec/swagger_v2/namespace_tags_spec.rb
@@ -403,6 +405,7 @@ test_files:
 - spec/swagger_v2/form_params_spec.rb
 - spec/swagger_v2/grape-swagger_spec.rb
 - spec/swagger_v2/hide_api_spec.rb
+- spec/swagger_v2/host.rb
 - spec/swagger_v2/mounted_target_class_spec.rb
 - spec/swagger_v2/namespace_tags_prefix_spec.rb
 - spec/swagger_v2/namespace_tags_spec.rb