Merge pull request #43 from zhandao/header_obj

Support for definiting headers to Response Object

Author: zhandao

CHANGELOG.md

@@ -2,6 +2,22 @@
 
 ## [Unreleased]
 
+## [2.1.0] - 2019/2/16 - [view diff](https://github.com/zhandao/zero-rails_openapi/compare/v2.0.3...v2.1.0)
+
+See: [PR #43](https://github.com/zhandao/zero-rails_openapi/pull/43)
+
+### Added
+
+Headers in Response Object ([issued by @drjonnicholson](https://github.com/zhandao/zero-rails_openapi/issues/42))
+
+## [2.0.0 - 2.0.3] - 2019/2/12 - [view diff](https://github.com/zhandao/zero-rails_openapi/compare/v1.7.0...v2.0.3)
+
+See: [PR #35](https://github.com/zhandao/zero-rails_openapi/pull/35)
+
+1. Totally refactoring
+2. README rewritten
+3. Removed Or Changed uncommonly used features
+
 ## [1.7.0] - 2018/12/17 - [view diff](https://github.com/zhandao/zero-rails_openapi/compare/v1.6.1...v1.7.0)
 
 ### Added

lib/oas_objs/header_obj.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'oas_objs/helpers'
+
+module OpenApi
+  module DSL
+    # https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#header-object
+    class HeaderObj < Hash
+      include Helpers
+
+      attr_accessor :processed, :schema
+
+      def initialize(desc = '', schema)
+        self.schema = SchemaObj.new(schema)
+        self.processed = { description: desc }
+      end
+
+      def process
+        schema.process
+        processed.merge!(schema: schema)
+      end
+    end
+  end
+end
+
+
+__END__
+
+Header Object Example
+
+{
+  "description": "The number of allowed requests in the current period",
+  "schema": {
+    "type": "integer"
+  }
+}

lib/oas_objs/response_obj.rb

@@ -9,21 +9,29 @@ module DSL
     class ResponseObj < Hash
       include Helpers
 
-      attr_accessor :processed, :media_types
+      attr_accessor :processed, :media_types, :headers
+
       def initialize(desc)
         self.media_types = [ ]
+        self.headers = { }
         self.processed   = { description: desc }
       end
 
-      def absorb(desc, media_type, hash)
+      def absorb(desc, media_type, headers: { }, **media_hash)
         self.processed[:description] = desc if desc.present?
-        media_types << MediaTypeObj.new(media_type, hash)
+        self.headers.merge!(headers)
+        media_types << MediaTypeObj.new(media_type, media_hash)
         self
       end
 
       def process
         content = media_types.map(&:process).reduce({ }, &fusion)
         processed[:content] = content if content.present?
+        _headers = headers.map do |name, schema|
+          schema = schema.is_a?(Hash) ? schema : { type: schema }
+          [ name, HeaderObj.new(schema.delete(:desc), schema).process ]
+        end.to_h
+        processed[:headers] = _headers if _headers.present?
         processed
       end
     end
@@ -49,4 +57,4 @@ def process
       }
     }
   }
-}
+}

lib/open_api/dsl/api.rb

@@ -95,8 +95,8 @@ def data name, type = nil, schema = { }
         form data: { name => schema }
       end
 
-      def response code, desc, media_type = nil, data: { }, **options
-        (self[:responses][code] ||= ResponseObj.new(desc)).absorb(desc, media_type, { data: data, **options })
+      def response code, desc, media_type = nil, headers: { }, data: { }, **options
+        (self[:responses][code] ||= ResponseObj.new(desc)).absorb(desc, media_type, headers: headers, data: data, **options)
       end
 
       alias_method :resp,  :response

lib/open_api/dsl/components.rb

@@ -49,8 +49,8 @@ def request_body component_key, required, media_type, data: { }, desc: '', **opt
       arrow_enable :body
       arrow_enable :body!
 
-      def response component_key, desc, media_type = nil, data: { }, **options
-        (self[:responses][component_key] ||= ResponseObj.new(desc)).absorb(desc, media_type, { data: data, **options })
+      def response component_key, desc, media_type = nil, headers: { }, data: { }, **options
+        (self[:responses][component_key] ||= ResponseObj.new(desc)).absorb(desc, media_type, headers: headers, data: data, **options)
       end
 
       alias_method :resp,  :response

lib/open_api/dsl/helpers.rb

@@ -8,6 +8,7 @@
 require 'oas_objs/ref_obj'
 require 'oas_objs/example_obj'
 require 'oas_objs/callback_obj'
+require 'oas_objs/header_obj'
 
 module OpenApi
   module DSL

lib/open_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OpenApi
-  VERSION = '2.0.3'
+  VERSION = '2.1.0'
 end

spec/api_spec.rb

@@ -186,6 +186,14 @@
       expect_its :description, eq: 'invalid token'
       expect_its :content, has_keys: { 'application/json': [ schema: [:title] ] }
 
+      context 'when passing headers' do
+        api -> do
+          response :success, 'succ', :json, headers: { 'X-Request-Start': String }, data: { }
+        end, has_key!: :success
+        focus_on :success
+        expect_its :headers, has_key: :'X-Request-Start'
+      end
+
       context 'when re-calling through the same code and media-type' do
         api -> do
           response :success, 'success desc1', :json, data: { name: String }