Module: Swagalicious::ExampleHelpers

Includes:
Rack::Test::Methods
Defined in:
lib/swagalicious/example_helpers.rb

Defined Under Namespace

Classes: InvalidResponseTypeError, MockResponse, Parser

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.raise_invalid_response(response:, request:, message:) ⇒ Object

Raises:



16
17
18
19
20
21
22
23
24
 
# File 'lib/swagalicious/example_helpers.rb', line 16

def self.raise_invalid_response(response:, request:, message:)
  raise InvalidResponseTypeError.new(
    headers: response.headers,
    message: message,
    request: request,
    response: response,
    status: response.status,
  )
end

Instance Method Details

#app ⇒ Object 



113
114
115
116
117
118
119
120
121
 
# File 'lib/swagalicious/example_helpers.rb', line 113

def app
  @app ||= if defined?(Rails)
             Rails.application
           elsif Rack::RELEASE >= "3.0.0"
             Rack::Builder.parse_file("config.ru")
           else
             Rack::Builder.parse_file("config.ru").first
           end
end

#client ⇒ Object 



123
124
125
126
127
 
# File 'lib/swagalicious/example_helpers.rb', line 123

def client
  @client ||= Faraday.new do |b|
    b.adapter Faraday::Adapter::Rack, app
  end
end

#submit_request(metadata, mocked: false, mock_name: nil) ⇒ Object 



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/swagalicious/example_helpers.rb', line 129

def submit_request(metadata, mocked: false, mock_name: nil)
  request  = RequestFactory.new.build_request(metadata, self)
  uri      = URI.parse(request[:path])
  uri.path = uri.path.gsub("//", "/")

  response = if mocked
               file_name = File.basename(mock_name || path)

               MockResponse.new(file_name)
             else
               client.public_send(request[:verb]) do |req|
                 req.url uri.to_s
                 req.headers = request[:headers]
                 req.body    = request[:payload]
               end
             end

  Swagalicious::ExampleHelpers.raise_invalid_response(response: response, request: request, message: "Received unexpected response code") unless response.status.to_s == metadata[:response][:code].to_s

  @body = Parser.new(request: request, response: response).parse

  metadata[:paths] ||= []
  metadata[:paths] << request[:path]

  metadata[:response][:requestBody] ||= {}
  metadata[:response][:examples]    ||= {}

  mime_types = metadata[:response][:produces]  || ["application/json"]
  full_title = metadata[:swagger_example_name] || "#{metadata[:operation][:summary]}: #{metadata[:description]}"

  mime_types.each do |mime_type|
    if request[:payload]
      metadata[:response][:requestBody][:content]                                   ||= {}
      metadata[:response][:requestBody][:content][mime_type]                        ||= {}
      metadata[:response][:requestBody][:content][mime_type][:examples]             ||= {}
      metadata[:response][:requestBody][:content][mime_type][:examples][full_title] ||= {}

      metadata[:response][:requestBody][:content][mime_type][:examples][full_title][:value] = Oj.load(request[:payload]).dup
    end

    metadata[:response][:examples][mime_type]           ||= {}
    metadata[:response][:examples][mime_type][full_title] = @body
  end

  # Validates response matches the proper schema
  Swagalicious::ResponseValidator.new.validate!(metadata, response)

  response
end