zero-rails_openapi 2.0.3 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99c7a0aeaedb2ff14dc929912f7aa734122c7ab76bea448c68186ab512ef79e1
-  data.tar.gz: a2c95b2bf0856dee961183bb10f8f76f7a9031902199fc5874ac195b04eb4691
+  metadata.gz: e1945a762cf400f52a4fbc222c7cd10e6fed4937e3d4afcb9357e4e030edf349
+  data.tar.gz: f6b25115dd788832d34e5f83e4b216c49381367b80e0ae1c33a65fa964726b0d
 SHA512:
-  metadata.gz: 7f868f8ccc21c52f10391dd9153814fa0cad1378fb1044455d07754639ad9e2951b331013d38accc28006e3ddf20944fa3179c1f34f5b460c3dff0072758de3b
-  data.tar.gz: 18b5a70b962887ba16a79e58cd11ae3e16cd8460f4c9e3d2f96812e9effdf482203a7f8bb92697ddd6046b1e7e9f9e9d184eed2624cf601eb905aa909aab4145
+  metadata.gz: 56e62cdd21432ee8394ca955ca63498a9e198da18c553f30fa35840fad8219afc599bccb25e71a1c6565e513be26c3a2422c4e08c51b1e51ab48edd31423d813
+  data.tar.gz: ce16f8ad8b4f83cdf5c7cbc4106b0f81354790a8febdeea0bf19b598f594e77505921260e832b6bf40f807ce580c9bef8c494b95c54de6d6d788e52c5032ef93

data/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

data/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"
+  }
+}

data/lib/oas_objs/response_obj.rb

@@ -9,21 +9,29 @@ module OpenApi
     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 @@ Response of an array of a complex type:
       }
     }
   }
-}
+}

data/lib/open_api/dsl/api.rb

@@ -95,8 +95,8 @@ module OpenApi
         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

data/lib/open_api/dsl/components.rb

@@ -49,8 +49,8 @@ module OpenApi
       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

data/lib/open_api/dsl/helpers.rb

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

data/lib/open_api/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zero-rails_openapi
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.1.0
 platform: ruby
 authors:
 - zhandao
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-12 00:00:00.000000000 Z
+date: 2019-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -149,6 +149,7 @@ files:
 - lib/oas_objs/callback_obj.rb
 - lib/oas_objs/combined_schema.rb
 - lib/oas_objs/example_obj.rb
+- lib/oas_objs/header_obj.rb
 - lib/oas_objs/helpers.rb
 - lib/oas_objs/media_type_obj.rb
 - lib/oas_objs/param_obj.rb