raml_parser 0.1 → 0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 15632f30b43baa8f09f37bb3f06b10fee158f138
-  data.tar.gz: 87d3a333ef6dbb848da083db0f344e9e0041a404
+  metadata.gz: abe1cc6ee7e11604113e202e4c9b301b96bdcbe5
+  data.tar.gz: 98af92840d95058855e4bfe9f599886fffafe2a3
 SHA512:
-  metadata.gz: 251ac847b813be9b1bea013ded667d10208d377b56f75edae87bce4fe5a352ca3f8d94f3fea44297c9527ce6b227521ad4eeded792eadcf2b96acb8c2d2b770a
-  data.tar.gz: 6fbf700a78e581c13ebf1248621fe7c280215580651f8096c974ee80f9b0e3fbff78fa4feb61bc8017879c3d2a1ce8ef8eb8c5ba567cd623dfa127175efdf0c1
+  metadata.gz: f47f74ef12621fe8156078eb71df570f89390e379ec2d46682b5406a3bee6ef872810a03c5105c6b795fe2618fdd12df781f540c18105f1af046293456553050
+  data.tar.gz: 97557ac026a4dc26aaab273e4d9556f30b6e8255d0c92061aa1ac7895c83739a2d32930f4b9da581d30d4ef698341f67bf0771a177f9add568b577bf2760e54c

data/README.md

@@ -1,7 +1,8 @@
 # RamlParser
 
 [![build](https://img.shields.io/travis/ePages-de/raml_parser/develop.svg)](https://travis-ci.org/ePages-de/raml_parser)
-[![license](http://img.shields.io/badge/license-MIT-lightgrey.svg)](http://opensource.org/licenses/MIT)
+[![gem](https://img.shields.io/gem/v/raml_parser.svg)](https://rubygems.org/gems/raml_parser)
+[![license](https://img.shields.io/badge/license-MIT-lightgrey.svg)](http://opensource.org/licenses/MIT)
 
 A parser for the [RAML](http://raml.org/) API modeling language.
 
@@ -10,7 +11,9 @@ A parser for the [RAML](http://raml.org/) API modeling language.
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'raml_parser', :git => 'https://github.com/ePages-de/raml_parser.git', :branch => 'master'
+source 'https://rubygems.org'
+
+gem 'raml_parser'
 ```
 
 And then execute:
@@ -25,8 +28,6 @@ TODO: Write usage instructions here
 
 These are features of the RAML 0.8 specification that are not fully handled yet. This list should be complete, i.e. everything not listed here should work.
 
-* [Base URI Parameters](http://raml.org/spec.html#base-uri-parameters)
-* [Schemas](http://raml.org/spec.html#schemas)
 * [Protocols](http://raml.org/spec.html#protocols)
 * [Named parameters with multiple types](http://raml.org/spec.html#named-parameters-with-multiple-types)
 

data/lib/raml_parser.rb

@@ -3,14 +3,14 @@ require 'raml_parser/model'
 
 module RamlParser
   class Parser
-    attr_reader :path, :root
-
     def self.parse_file(path)
+      ensure_raml_0_8(path)
       node = YamlNode.new(nil, 'root', YamlHelper.read_yaml(path))
       parse_root(node)
     end
 
     def self.parse_file_with_marks(path)
+      ensure_raml_0_8(path)
       node = YamlNode.new(nil, 'root', YamlHelper.read_yaml(path))
       node.mark_all(:unused)
       node.mark(:used)
@@ -20,20 +20,28 @@ module RamlParser
 
     private
 
-    def self.parse_root(node)
-      node.hash('schemas').mark_all(:unsupported) if node.value.has_key? 'schemas'
+    def self.ensure_raml_0_8(path)
+      first_line = File.open(path) { |f| f.readline }.strip
+      raise "File #{path} does not start with RAML 0.8 comment" unless first_line == '#%RAML 0.8'
+    end
 
+    def self.parse_root(node)
       root = Model::Root.new
       root.title = node.hash('title').or_default('').value
-      root.base_uri = node.hash('baseUri').or_default('').value
       root.version = node.hash('version').value
+      root.base_uri = node.hash('baseUri').or_default('').value.gsub('{version}', root.version || '')
       root.media_type = node.hash('mediaType').value
       root.secured_by = node.hash('securedBy').or_default([]).array_map { |n| n.value }
       root.documentation = node.hash('documentation').array_map { |n| parse_documenation(n) }
+      root.schemas = node.hash('schemas').arrayhash_map { |n| n.value }
       root.security_schemes = node.hash('securitySchemes').arrayhash_map { |n| parse_security_scheme(n) }
       root.resource_types = node.hash('resourceTypes').mark_all(:used).arrayhash_map { |n| n }
       root.traits = node.hash('traits').mark_all(:used).arrayhash_map { |n| n }
 
+      implicit_base_uri_parameters = extract_uri_parameters(root.base_uri)
+      explicit_base_uri_parameters = node.hash('baseUriParameters').hash_map { |n| parse_named_parameter(n) }
+      root.base_uri_parameters = implicit_base_uri_parameters.merge(explicit_base_uri_parameters)
+
       root.resources = traverse_resources(node, nil) do |n,parent|
         parent_absolute_uri = parent != nil ? parent.absolute_uri : root.base_uri || ''
         parent_relative_uri = parent != nil ? parent.relative_uri : ''
@@ -45,25 +53,23 @@ module RamlParser
     end
 
     def self.parse_resource(node, root, parent_absolute_uri, parent_relative_uri, parent_uri_parameters, as_resource_type)
-      def self.extract_uri_parameters(relative_uri)
-        names = relative_uri.scan(/\{([a-zA-Z\_\-]+)\}/).map { |m| m.first }
-        Hash[names.map { |name| [name, Model::NamedParameter.new(name, 'string', name)] }]
-      end
-
       node = node.or_default({})
       resource = Model::Resource.new(parent_absolute_uri + node.key, parent_relative_uri + node.key)
       resource.display_name = node.hash('displayName').value
       resource.description = node.hash('description').value
-      resource.uri_parameters = extract_uri_parameters(node.key).merge(parent_uri_parameters.merge(node.hash('uriParameters').hash_map { |n| parse_named_parameter(n) }))
       resource.type = parse_type(node.hash('type'))
       resource.is = parse_is(node.hash('is'))
       resource.secured_by = (root.secured_by + node.hash('securedBy').or_default([]).array_map { |n| n.value }).uniq
+      resource.methods = Hash[find_method_nodes(node).map { |n| [n.key, parse_method(n, root, resource, as_resource_type)] }]
 
-      for m in %w(get post put delete head patch options trace connect) do
-        if node.value.has_key? m
-          resource.methods[m] = parse_method(node.hash(m), root, resource, as_resource_type)
-        end
-      end
+      root_base_uri_parameters = root.base_uri_parameters
+      own_base_uri_parameters = node.hash('baseUriParameters').hash_map { |n| parse_named_parameter(n) }
+      resource.base_uri_parameters = root_base_uri_parameters.merge(own_base_uri_parameters)
+
+      implicit_uri_parameters = extract_uri_parameters(node.key)
+      explicit_uri_parameters = node.hash('uriParameters').hash_map { |n| parse_named_parameter(n) }
+      raise 'Can only explicitly specify URI parameters from the current relative URI' unless as_resource_type or (explicit_uri_parameters.keys - implicit_uri_parameters.keys).empty?
+      resource.uri_parameters = parent_uri_parameters.merge(implicit_uri_parameters).merge(explicit_uri_parameters)
 
       unless as_resource_type
         resource = mixin_resource_types(node, root, resource)
@@ -79,8 +85,8 @@ module RamlParser
       method.display_name = node.hash('displayName').value
       method.description = node.hash('description').value
       method.query_parameters = node.hash('queryParameters').hash_map { |n| parse_named_parameter(n) }
-      method.bodies = node.hash('body').hash_map { |n| parse_body(n) }
-      method.responses = node.hash('responses').hash_map { |n| parse_response(n) }
+      method.bodies = node.hash('body').hash_map { |n| parse_body(n, root) }
+      method.responses = node.hash('responses').hash_map { |n| parse_response(n, root) }
       method.headers = node.hash('headers').hash_map { |n| parse_named_parameter(n) }
       method.secured_by = (resource.secured_by + node.hash('securedBy').or_default([]).array_map { |n| n.value }).uniq if resource
       method.is = parse_is(node.hash('is'))
@@ -93,12 +99,12 @@ module RamlParser
       method
     end
 
-    def self.parse_response(node)
+    def self.parse_response(node, root)
       node = node.or_default({})
       response = Model::Response.new(node.key)
       response.display_name = node.hash('displayName').value
       response.description = node.hash('description').value
-      response.bodies = node.hash('body').hash_map { |n| parse_body(n) }
+      response.bodies = node.hash('body').hash_map { |n| parse_body(n, root) }
       response.headers = node.hash('headers').hash_map { |n| parse_named_parameter(n) }
       response
     end
@@ -128,24 +134,23 @@ module RamlParser
       named_parameter
     end
 
-    def self.parse_body(node)
+    def self.parse_body(node, root)
       node = node.or_default({})
       body = Model::Body.new(node.key)
       body.example = node.hash('example').value
       body.schema = node.hash('schema').value
+      body.schema = root.schemas[body.schema] if root.schemas.has_key? body.schema
       body.form_parameters = node.hash('formParameters').hash_map { |n| parse_named_parameter(n) }
       # TODO: Form parameters are only allowed for media type application/x-www-form-urlencoded or multipart/form-data
       body
     end
 
     def self.parse_security_scheme(node)
-      node.hash('describedBy').mark_all(:unsupported) if node.value.has_key? 'describedBy'
-
       node = node.or_default({})
       security_scheme = Model::SecurityScheme.new(node.key)
       security_scheme.type = node.hash('type').value
       security_scheme.description = node.hash('description').value
-      security_scheme.described_by = node.hash('describedBy').value
+      security_scheme.described_by = parse_method(node.hash('describedBy'), nil, nil, true)
       security_scheme.settings = node.hash('settings').mark_all(:used).value
       security_scheme
     end
@@ -256,15 +261,30 @@ module RamlParser
       YamlNode.new(node.parent, node.key, traverse(node.value, params, node))
     end
 
+    def self.find_resource_nodes(node)
+      def self.is_resource(key)
+        key =~ /^\//
+      end
+      (node.value || {}).select { |k,_| is_resource(k) }.map { |k,_| node.hash(k) }
+    end
+
+    def self.find_method_nodes(node)
+      def self.is_method(key)
+        %w(get post put delete head patch options trace connect).include? key
+      end
+      (node.value || {}).select { |k,_| is_method(k) }.map { |k,_| node.hash(k) }
+    end
+
+    def self.extract_uri_parameters(uri)
+      names = uri.scan(/\{([a-zA-Z\_\-]+)\}/).map { |m| m.first }
+      Hash[names.map { |name| [name, Model::NamedParameter.new(name, 'string', name)] }]
+    end
+
     def self.traverse_resources(node, parent_resource, &code)
-      node.hash_map { |n|
-        if n.key =~ /^\//
-          resource = code.call(n, parent_resource)
-          [resource] + traverse_resources(n, resource, &code)
-        else
-          []
-        end
-      }.values.flatten
+      find_resource_nodes(node).map { |n|
+        resource = code.call(n, parent_resource)
+        [resource] + traverse_resources(n, resource, &code)
+      }.flatten
     end
   end
 end

data/lib/raml_parser/model.rb

@@ -1,14 +1,16 @@
 module RamlParser
   module Model
     class Root
-      attr_accessor :title, :base_uri, :version, :media_type, :security_schemes, :resource_types, :traits, :secured_by, :documentation, :resources
+      attr_accessor :title, :base_uri, :version, :media_type, :schemas, :security_schemes, :base_uri_parameters, :resource_types, :traits, :secured_by, :documentation, :resources
 
-      def initialize(title = nil, base_uri = nil, version = nil, media_type = nil, security_schemes = {}, resource_types = {}, traits = {}, secured_by = [], documentation = [], resources = [])
+      def initialize(title = nil, base_uri = nil, version = nil, media_type = nil, schemas = {}, security_schemes = {}, base_uri_parameters = {}, resource_types = {}, traits = {}, secured_by = [], documentation = [], resources = [])
         @title = title
         @base_uri = base_uri
         @version = version
         @media_type = media_type
+        @schemas = schemas
         @security_schemes = security_schemes
+        @base_uri_parameters = base_uri_parameters
         @resource_types = resource_types
         @traits = traits
         @secured_by = secured_by
@@ -18,13 +20,14 @@ module RamlParser
     end
 
     class Resource
-      attr_accessor :absolute_uri, :relative_uri, :display_name, :description, :uri_parameters, :methods, :type, :is, :secured_by
+      attr_accessor :absolute_uri, :relative_uri, :display_name, :description, :base_uri_parameters, :uri_parameters, :methods, :type, :is, :secured_by
 
-      def initialize(absolute_uri, relative_uri, display_name = nil, description = nil, uri_parameters = {}, methods = {}, type = {}, is = {}, secured_by = [])
+      def initialize(absolute_uri, relative_uri, display_name = nil, description = nil, base_uri_parameters = {}, uri_parameters = {}, methods = {}, type = {}, is = {}, secured_by = [])
         @absolute_uri = absolute_uri
         @relative_uri = relative_uri
         @display_name = display_name
         @description = description
+        @base_uri_parameters = base_uri_parameters
         @uri_parameters = uri_parameters
         @methods = methods
         @type = type
@@ -37,6 +40,7 @@ module RamlParser
 
         resource.display_name = if b.display_name then b.display_name else a.display_name end
         resource.description = if b.description then b.description else a.description end
+        resource.base_uri_parameters = a.base_uri_parameters.merge(b.base_uri_parameters)
         resource.uri_parameters = a.uri_parameters.merge(b.uri_parameters)
         resource.methods = a.methods.merge(b.methods)
         resource.type = a.type.merge(b.type)

data/lib/raml_parser/version.rb

@@ -1,3 +1,3 @@
 module RamlParser
-  VERSION = "0.1"
+  VERSION = "0.2"
 end

data/spec/examples/raml/baseuriparameters1.raml

@@ -0,0 +1,6 @@
+#%RAML 0.8
+---
+title: Example API
+baseUri: http://localhost:3000/{version}
+version: v4
+/a:

data/spec/examples/raml/baseuriparameters2.raml

@@ -0,0 +1,16 @@
+#%RAML 0.8
+---
+title: Example API
+baseUri: http://{user}.domain.com/{version}/{language}
+version: v1
+baseUriParameters:
+  user:
+    description: The user
+/a:
+  /b/{next}:
+    uriParameters:
+      next:
+    /c:
+      baseUriParameters:
+        user:
+          description: Changed

data/spec/examples/raml/schemas.raml

@@ -0,0 +1,41 @@
+#%RAML 0.8
+---
+title: Example API
+baseUri: http://localhost:3000
+schemas:
+  - schema1: |
+      <?xml version="1.1"?>
+      <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
+        <xs:element name="note">
+          <xs:complexType>
+            <xs:sequence>
+              <xs:element name="to" type="xs:string"/>
+            </xs:sequence>
+          </xs:complexType>
+        </xs:element>
+      </xs:schema>
+  - schema2: |
+      <?xml version="1.2"?>
+      <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
+        <xs:element name="note">
+          <xs:complexType>
+            <xs:sequence>
+              <xs:element name="from" type="xs:string"/>
+            </xs:sequence>
+          </xs:complexType>
+        </xs:element>
+      </xs:schema>
+/route:
+  get:
+    body:
+      text/xml:
+        schema: schema1
+  post:
+    body:
+      text/xml:
+        schema: schema2
+  put:
+    body:
+      text/xml:
+        schema: |
+          <?xml version="1.3"?>

data/spec/examples/raml_bad/uriparameters.raml

@@ -0,0 +1,10 @@
+#%RAML 0.8
+---
+title: Example API
+baseUri: http://localhost:3000
+/a:
+  /b/{first}:
+    /{second}:
+      uriParameters:
+        first:
+        second:

data/spec/lib/raml_parser_spec.rb

@@ -25,7 +25,7 @@ RSpec.describe RamlParser::Parser do
     raml = RamlParser::Parser.parse_file('spec/examples/raml/uriparameters.raml')
     expect(raml.resources[0].uri_parameters.map { |_,param| param.name }).to eq []
     expect(raml.resources[1].uri_parameters.map { |_,param| param.name }).to eq ['first']
-    expect(raml.resources[2].uri_parameters.map { |_,param| param.name }).to eq ['second', 'first']
+    expect(raml.resources[2].uri_parameters.map { |_,param| param.name }).to eq ['first', 'second']
     expect(raml.resources[3].uri_parameters.map { |_,param| param.name }).to eq ['third']
     expect(raml.resources[2].uri_parameters['first'].display_name).to eq 'first'
     expect(raml.resources[2].uri_parameters['first'].type).to eq 'string'
@@ -89,6 +89,9 @@ RSpec.describe RamlParser::Parser do
     expect(raml.security_schemes['oauth_2_0'].type).to eq 'OAuth 2.0'
     expect(raml.security_schemes['oauth_1_0'].type).to eq 'OAuth 1.0'
     expect(raml.security_schemes['customHeader'].type).to eq nil
+
+    expect(raml.security_schemes['oauth_2_0'].settings['authorizationUri']).to eq 'https://www.dropbox.com/1/oauth2/authorize'
+    expect(raml.security_schemes['oauth_2_0'].described_by.headers['Authorization'].description).to start_with 'Used to send'
   end
 
   it 'parses documentation' do
@@ -97,6 +100,33 @@ RSpec.describe RamlParser::Parser do
     expect(raml.documentation[1].title).to eq 'FAQ'
   end
 
+  it 'parses schemas' do
+    raml = RamlParser::Parser.parse_file('spec/examples/raml/schemas.raml')
+    expect(raml.schemas['schema1']).to start_with '<?xml version="1.1"?>'
+    expect(raml.schemas['schema2']).to start_with '<?xml version="1.2"?>'
+    expect(raml.resources[0].methods['get'].bodies['text/xml'].schema).to start_with '<?xml version="1.1"?>'
+    expect(raml.resources[0].methods['post'].bodies['text/xml'].schema).to start_with '<?xml version="1.2"?>'
+    expect(raml.resources[0].methods['put'].bodies['text/xml'].schema).to start_with '<?xml version="1.3"?>'
+  end
+
+  it 'parses base URI parameters' do
+    raml1 = RamlParser::Parser.parse_file('spec/examples/raml/baseuriparameters1.raml')
+    expect(raml1.resources[0].absolute_uri).to eq 'http://localhost:3000/v4/a'
+    expect(raml1.base_uri_parameters).to eq ({})
+
+    raml2 = RamlParser::Parser.parse_file('spec/examples/raml/baseuriparameters2.raml')
+    expect(raml2.base_uri_parameters.map { |_,p| p.name }).to eq ['user', 'language']
+    expect(raml2.resources[0].uri_parameters.map { |_,p| p.name }).to eq []
+    expect(raml2.resources[0].base_uri_parameters.map { |_,p| p.name }).to eq ['user', 'language']
+    expect(raml2.resources[1].uri_parameters.map { |_,p| p.name }).to eq ['next']
+    expect(raml2.resources[1].base_uri_parameters.map { |_,p| p.name }).to eq ['user', 'language']
+    expect(raml2.resources[2].uri_parameters.map { |_,p| p.name }).to eq ['next']
+    expect(raml2.resources[2].base_uri_parameters.map { |_,p| p.name }).to eq ['user', 'language']
+    expect(raml2.resources[0].base_uri_parameters['user'].description).to eq 'The user'
+    expect(raml2.resources[1].base_uri_parameters['user'].description).to eq 'The user'
+    expect(raml2.resources[2].base_uri_parameters['user'].description).to eq 'Changed'
+  end
+
   it 'handle secured by' do
     raml1 = RamlParser::Parser.parse_file('spec/examples/raml/securedby1.raml')
     expect(raml1.resources[0].methods['get'].secured_by).to eq ['oauth_1_0']
@@ -180,17 +210,18 @@ RSpec.describe RamlParser::Parser do
   it 'does not fail on any example RAML file' do
     files = Dir.glob('spec/examples/raml/**/*.raml')
     files.each { |f|
-      known_unused = %w()
-      known_unsupported = %w(root.schemas .describedBy .someMultipartFormParamWithMultipleTypes)
-
       result = RamlParser::Parser.parse_file_with_marks(f)
-      unused = result[:marks].select { |_,m| m == :unused }
-      unsupported = result[:marks].select { |_,m| m == :unsupported }
-      unknown = result[:marks].select { |_,m| not [:used, :unused, :unsupported].include? m }
 
-      expect(unused.select { |p,_| not known_unused.any? { |k| p.include? k} }).to eq ({})
-      expect(unsupported.select { |p,_| not known_unsupported.any? { |k| p.include? k} }).to eq ({})
-      expect(unknown).to eq ({})
+      expect(result[:marks]).to all(satisfy do |p,m|
+        m == :used or m == :unsupported
+      end)
+    }
+  end
+
+  it 'fail on any bad example RAML file' do
+    files = Dir.glob('spec/examples/raml_bad/**/*.raml')
+    files.each { |f|
+      expect { RamlParser::Parser.parse_file_with_marks(f) }.to raise_error
     }
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: raml_parser
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: '0.2'
 platform: ruby
 authors:
 - Christian Hoffmeister
@@ -86,6 +86,8 @@ files:
 - lib/raml_parser/version.rb
 - lib/raml_parser/yaml_helper.rb
 - raml_parser.gemspec
+- spec/examples/raml/baseuriparameters1.raml
+- spec/examples/raml/baseuriparameters2.raml
 - spec/examples/raml/documentation.raml
 - spec/examples/raml/external/box.raml
 - spec/examples/raml/external/bug.raml
@@ -131,12 +133,14 @@ files:
 - spec/examples/raml/resources.raml
 - spec/examples/raml/resourcetypes.raml
 - spec/examples/raml/responses.raml
+- spec/examples/raml/schemas.raml
 - spec/examples/raml/securedby1.raml
 - spec/examples/raml/securedby2.raml
 - spec/examples/raml/securityschemes.raml
 - spec/examples/raml/simple.raml
 - spec/examples/raml/traits.raml
 - spec/examples/raml/uriparameters.raml
+- spec/examples/raml_bad/uriparameters.raml
 - spec/examples/yaml/include1.yml
 - spec/examples/yaml/include2.yml
 - spec/examples/yaml/simple.yml
@@ -169,6 +173,8 @@ signing_key:
 specification_version: 4
 summary: A parser for the RAML API modeling language.
 test_files:
+- spec/examples/raml/baseuriparameters1.raml
+- spec/examples/raml/baseuriparameters2.raml
 - spec/examples/raml/documentation.raml
 - spec/examples/raml/external/box.raml
 - spec/examples/raml/external/bug.raml
@@ -214,12 +220,14 @@ test_files:
 - spec/examples/raml/resources.raml
 - spec/examples/raml/resourcetypes.raml
 - spec/examples/raml/responses.raml
+- spec/examples/raml/schemas.raml
 - spec/examples/raml/securedby1.raml
 - spec/examples/raml/securedby2.raml
 - spec/examples/raml/securityschemes.raml
 - spec/examples/raml/simple.raml
 - spec/examples/raml/traits.raml
 - spec/examples/raml/uriparameters.raml
+- spec/examples/raml_bad/uriparameters.raml
 - spec/examples/yaml/include1.yml
 - spec/examples/yaml/include2.yml
 - spec/examples/yaml/simple.yml