Add Definition#[] to access a raw Hash representation of the OAS do…

…cument

Related to #280

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## Unreleased
 
+- Add `Definition#[]` to access a raw Hash representation of the OAS document
+
 ## 2.0.3
 
 - Fix `OpenapiFirst::Test.register` https://github.com/ahx/openapi_first/issues/276

lib/openapi_first/definition.rb

@@ -5,11 +5,13 @@
 require_relative 'request'
 require_relative 'response'
 require_relative 'builder'
+require 'forwardable'
 
 module OpenapiFirst
   # Represents an OpenAPI API Description document
   # This is returned by OpenapiFirst.load.
   class Definition
+    extend Forwardable
     attr_reader :filepath, :config, :paths, :router
 
     # @param resolved [Hash] The resolved OpenAPI document.
@@ -20,9 +22,12 @@ def initialize(resolved, filepath = nil)
       yield @config if block_given?
       @config.freeze
       @router = Builder.build_router(resolved, @config)
+      @resolved = resolved
       @paths = resolved['paths'].keys # TODO: Move into builder as well
     end
 
+    def_delegators :@resolved, :[]
+
     def routes
       @router.routes
     end

spec/definition_spec.rb

@@ -12,6 +12,15 @@ def build_request(path, method: 'GET')
     end
   end
 
+  describe '#[]' do
+    it 'gives access to the raw hash' do
+      definition = OpenapiFirst.load('./spec/data/train-travel-api/openapi.yaml')
+      expect(definition['webhooks']).to be_a(Hash)
+      expect(definition['webhooks'].dig('newBooking', 'post', 'operationId')).to eq('new-booking')
+      expect(definition['components'].dig('schemas', 'Station', 'type')).to eq('object')
+    end
+  end
+
   describe '#paths' do
     it 'returns all paths' do
       definition = OpenapiFirst.load('./spec/data/petstore.yaml')