raml_ruby 0.1.1 → 0.1.2

data/lib/raml/node/abstract_method.rb

@@ -9,6 +9,7 @@ module Raml
     include Validation
     include Bodies
     include Headers
+    include SecuredBy
 
     # @!attribute [rw] protocols
     #   @return [Array<String>, nil] the supported protocols. Nil or an array of up to two string
@@ -28,9 +29,14 @@ module Raml
 
     children_by :query_parameters , :name       , Parameter::QueryParameter
     children_by :responses        , :name       , Response
+    children_by :secured_by       , :name       , SecuritySchemeReference
     
     private
-        
+
+    def validate
+      _validate_secured_by
+    end
+
     def validate_protocols
       if @protocols
         validate_array :protocols, @protocols, String
@@ -51,11 +57,5 @@ module Raml
       validate_hash 'responses', value, [Integer, String], Hash
       value.map { |r_name, r_data| Response.new r_name, r_data, self }
     end
-
-    def parse_secured_by(data)
-      # XXX ignored for now
-      []
-    end
-
   end
 end

data/lib/raml/node/abstract_resource.rb

@@ -7,6 +7,7 @@ module Raml
     include Merge
     include Parent
     include Validation
+    include SecuredBy
 
     # @!attribute [r] base_uri_parameters
     #   @return [Hash<String, Raml::Parameter::BaseUriParameter>] the base URI parameters, keyed
@@ -28,6 +29,7 @@ module Raml
     children_by :methods            , :name, Raml::Method
     children_by :base_uri_parameters, :name, Parameter::BaseUriParameter, true
     children_by :uri_parameters     , :name, Parameter::UriParameter    , true
+    children_by :secured_by         , :name, SecuritySchemeReference
 
     children_of :traits, [ Raml::Trait, Raml::TraitReference ]
 
@@ -77,8 +79,21 @@ module Raml
       @parent.resource_path + self.name
     end
 
+
+    # Returns the last non regex resource name
+    # @return [String] the last non request resource name
+    def resource_path_name
+      resource_path.split('/').reverse.detect do |pathPart|
+        !pathPart.match(/[{}]/)
+      end || ""
+    end
+
     private
-    
+
+    def validate
+      _validate_secured_by
+    end
+
     def validate_parent
       raise InvalidParent, "Parent of resource cannot be nil." if @parent.nil?
     end
@@ -145,15 +160,10 @@ module Raml
       end
     end
 
-    def parse_secured_by(data)
-      # XXX ignored for now
-      []
-    end
-
     def instantiate_resource_type
       reserved_params = {
         'resourcePath'     => resource_path,
-        'resourcePathName' => resource_path.split('/')[-1]
+        'resourcePathName' => resource_path_name
       }
       if ResourceTypeReference === type
         resource_type_declarations[type.name].instantiate type.parameters.merge reserved_params

data/lib/raml/node/body.rb

@@ -1,7 +1,7 @@
 module Raml
   class Body < PropertiesNode
     inherit_class_attributes
-    
+
     include Global
     include Merge
     include Parent
@@ -25,15 +25,13 @@ module Raml
     # @!attribute [r] media\_type
     #   @return [String] media type of the of body.  An alias for #name.
 
-    scalar_property     :example 
+    scalar_property     :example
     non_scalar_property :form_parameters, :schema
 
     alias_method :media_type, :name
-    
-    self.doc_template = relative_path 'body.slim'
-    
+
     children_by :form_parameters, :name, Parameter::FormParameter
-    
+
     child_of :schema, [ Schema, SchemaReference ]
 
     # Returns whether the body is a web form.  Returns true for "application/x-www-form-urlencoded" and
@@ -42,11 +40,11 @@ module Raml
     def web_form?
       [ 'application/x-www-form-urlencoded', 'multipart/form-data' ].include? media_type
     end
-    
+
     # @private
     def merge(other)
       raise MergeError, "Media types don't match." if media_type != other.media_type
-      
+
       super
 
       merge_properties other, :form_parameters
@@ -60,9 +58,13 @@ module Raml
     end
 
     private
-    
+
     def validate_name
-      raise InvalidMediaType, 'body media type is invalid' unless media_type =~ Body::MEDIA_TYPE_RE
+      raise InvalidMediaType, 'body media type is invalid' unless valid_media_type?
+    end
+
+    def valid_media_type?
+       media_type =~ Body::MEDIA_TYPE_RE || media_type == '*/*'
     end
 
     def parse_form_parameters(value)

data/lib/raml/node/documentation.rb

@@ -1,5 +1,3 @@
-require 'kramdown'
-
 module Raml
   class Documentation < PropertiesNode
 
@@ -12,17 +10,11 @@ module Raml
     scalar_property :content
     alias_method :title, :name
 
-    self.doc_template = relative_path 'documentation.slim'
-
     private
 
     def validate
       raise InvalidProperty, 'document title cannot be empty.'   if title.nil?   or title.empty?
       raise InvalidProperty, 'document content cannot be empty.' if content.nil? or content.empty?
     end
-
-    def html_content
-      Kramdown::Document.new(content, input: :GFM).to_html
-    end
   end
 end

data/lib/raml/node/method.rb

@@ -1,7 +1,7 @@
 module Raml
   class Method < AbstractMethod
     inherit_class_attributes
-    
+
     NAMES = %w(options get head post put delete trace connect patch)
 
     # @!attribute [r] traits
@@ -11,8 +11,6 @@ module Raml
 
     children_of :traits, [ Trait, TraitReference ]
 
-    self.doc_template = relative_path 'method.slim'
-
     # @private
     def apply_traits
       # We apply resource traits before method traits, and apply traits at each level in
@@ -48,8 +46,8 @@ module Raml
             false
           else # TraitReference
             self.traits.any? do |self_trait|
-              self_trait.is_a?(TraitReference)                && 
-              self_trait.name       == other_trait.name       && 
+              self_trait.is_a?(TraitReference)                &&
+              self_trait.name       == other_trait.name       &&
               self_trait.parameters == other_trait.parameters
             end
           end
@@ -76,7 +74,7 @@ module Raml
       value.map do |trait|
         if trait.is_a? Hash
           if trait.keys.size == 1 and trait_declarations.include? trait.keys.first
-            raise InvalidProperty, 'is property with map of trait name but params are not a map' unless 
+            raise InvalidProperty, 'is property with map of trait name but params are not a map' unless
               trait.values[0].is_a? Hash
             TraitReference.new( *trait.first, self )
           else
@@ -93,7 +91,7 @@ module Raml
     def instantiate_trait(trait)
       reserved_params = {
         'resourcePath'     => @parent.resource_path,
-        'resourcePathName' => @parent.resource_path.split('/')[-1],
+        'resourcePathName' => @parent.resource_path_name,
         'methodName'       => self.name
       }
       if TraitReference === trait

data/lib/raml/node/parameter/abstract_parameter.rb

@@ -48,8 +48,8 @@ module Raml
       #   @return [Hash<String, Raml::Parameter::AbstractParameter>] if the parameter supports multiple types,
       #     the type alternatives, keyed by the type.
 
-      scalar_property :type       , :enum     , :pattern  , :min_length , 
-                      :max_length , :minimum  , :maximum  , :example    , 
+      scalar_property :type       , :enum     , :pattern  , :min_length ,
+                      :max_length , :minimum  , :maximum  , :example    ,
                       :repeat     , :required , :default
 
       attr_reader_default :type    , 'string'
@@ -58,8 +58,6 @@ module Raml
 
       children_by :types, :type, AbstractParameter
 
-      self.doc_template = relative_path 'abstract_parameter.slim'
-
       # @param name [String] the parameter name.
       # @param parameter_data [Hash, Array<Hash>] the parameter data. If the parameter supports multiple types,
       #  it should be an array of hashes, one hash each for each type.
@@ -80,7 +78,7 @@ module Raml
       def has_multiple_types?
         not children.empty?
       end
-      
+
       # @private
       def merge(other)
         raise MergeError, "#{self.class} names don't match." if name != other.name
@@ -124,7 +122,7 @@ module Raml
       end
 
       private
-      
+
       def validate_type
         raise InvalidParameterType unless VALID_TYPES.include? type
       end
@@ -139,7 +137,7 @@ module Raml
           end
         end
       end
-      
+
       def validate_pattern
         if pattern
           if type == 'string'
@@ -153,10 +151,10 @@ module Raml
             end
           else
             raise InapplicableParameterAttribute, 'pattern attribute is only applicable to string parameters.'
-          end          
+          end
         end
       end
-      
+
       def validate_min_length
         if min_length
           if type != 'string'
@@ -166,7 +164,7 @@ module Raml
           end
         end
       end
-      
+
       def validate_max_length
         if max_length
           if type != 'string'
@@ -176,68 +174,68 @@ module Raml
           end
         end
       end
-      
+
       def validate_minimum
         if minimum
           if %w(integer number).include? type
             raise InvalidParameterAttribute, 'minimum attribute must be numeric' unless minimum.is_a? Numeric
           else
-            raise InapplicableParameterAttribute, 
+            raise InapplicableParameterAttribute,
               'minimum attribute applicable only to number or integer parameters.'
           end
         end
       end
-      
+
       def validate_maximum
         if maximum
           if %w(integer number).include? type
             raise InvalidParameterAttribute, 'maximum attribute must be numeric' unless maximum.is_a? Numeric
           else
-            raise InapplicableParameterAttribute, 
+            raise InapplicableParameterAttribute,
               'maximum attribute applicable only to number or integer parameters.'
           end
         end
       end
-      
+
       def validate_example
         validate_value :example
       end
-      
+
       def validate_repeat
         unless [true, false].include?(repeat)
           raise InvalidParameterAttribute, 'repeat attribute must be true or false.'
         end
       end
-      
+
       def validate_required
         unless [true, false].include?(required)
           raise InvalidParameterAttribute, "required attribute must be true or false: #{required} (#{required.class})"
         end
       end
-      
+
       def validate_default
         validate_value :default
       end
-      
+
       def validate_value(which)
         val = send which
         if val
           err_msg = "#{which} attribute for a %s parameter must be a %s: #{val} (#{val.class})"
           case type
           when 'string'
-            raise InvalidParameterAttribute, 
+            raise InvalidParameterAttribute,
               ( err_msg % [ 'string' , 'string'  ] ) unless val.is_a? String
           when 'number'
-            raise InvalidParameterAttribute, 
+            raise InvalidParameterAttribute,
               ( err_msg % [ 'number' , 'number'  ] ) unless val.is_a? Numeric
           when 'integer'
-            raise InvalidParameterAttribute, 
+            raise InvalidParameterAttribute,
               ( err_msg % [ 'integer', 'integer' ] ) unless val.is_a? Integer
           when 'date'
-            raise InvalidParameterAttribute, 
+            raise InvalidParameterAttribute,
               ( err_msg % [ 'date'   , 'string'  ] ) unless val.is_a? String
           when 'boolean'
-            raise InvalidParameterAttribute, 
+            raise InvalidParameterAttribute,
               ( err_msg % [ 'boolean', 'boolean' ] ) unless [TrueClass, FalseClass].include? val.class
           end
         end

data/lib/raml/node/parametized_reference.rb

@@ -8,8 +8,8 @@ module Raml
     # @param parameters [Hash<String,String>] parameters to interpolate when instantiating the resouce type or trait.
     # @param parent [Raml::Node] the parent node.
     def initialize(name, parameters={}, parent)
-    	super name, parent
-    	@parameters = parameters
+      super name, parent
+      @parameters = parameters
     end
   end
-end
+end

data/lib/raml/node/resource.rb

@@ -9,8 +9,6 @@ module Raml
 
     children_by :resources, :name, Resource
 
-    self.doc_template = relative_path 'resource.slim'
-
     # @private
     def apply_resource_type
       super

data/lib/raml/node/resource_type.rb

@@ -1,20 +1,20 @@
 module Raml
   class ResourceType < Template
-  	class Instance < AbstractResource
-	    inherit_class_attributes
+    class Instance < AbstractResource
+      inherit_class_attributes
 
       # @!attribute [rw] usage
       #   @return [String,nil] how the resource type should be used.
-  		scalar_property :usage
-  	end
+      scalar_property :usage
+    end
 
     # Instantiate a new resource type with the given parameters.
     # @param params [Hash] the parameters to interpolate in the resource type.
     # @return [Raml::ResourceType::Instance] the instantiated resouce type.
-  	def instantiate(params)
-  		instance = Instance.new( *interpolate(params), @parent )
-  		instance.apply_resource_type
-  		instance
-  	end
+    def instantiate(params)
+      instance = Instance.new( *interpolate(params), @parent )
+      instance.apply_resource_type
+      instance
+    end
   end
 end

data/lib/raml/node/resource_type_reference.rb

@@ -1,5 +1,5 @@
 module Raml
-	# A reference to a resource type defined in the root node.
+  # A reference to a resource type defined in the root node.
   class ResourceTypeReference < ParametizedReference
   end
-end
+end

data/lib/raml/node/response.rb

@@ -10,8 +10,6 @@ module Raml
     include Bodies
     include Headers
 
-    self.doc_template = relative_path 'response.slim'
-
     def initialize(name, properties, parent)
       super
       @name = name.to_i

data/lib/raml/node/root.rb

@@ -1,4 +1,3 @@
-require 'sass'
 require 'uri'
 require 'uri_template'
 
@@ -9,6 +8,7 @@ module Raml
 
     include Parent
     include Validation
+    include SecuredBy
 
     # @!attribute [rw] title
     #   @return [String] API title.
@@ -31,7 +31,7 @@ module Raml
 
     # @!attribute [r] base_uri_parameters
     #   @return [Hash<String, Raml::Parameter::BaseUriParameter>] the base URI parameters, keyed
-    #     by the parameter name. 
+    #     by the parameter name.
 
     # @!attribute [r] schemas
     #   @return [Hash<String, Raml::Schema>] the schema definitions, keyed by the schema name.
@@ -45,28 +45,33 @@ module Raml
     # @!attribute [r] resource_types
     #   @return [Hash<String, Raml::ResourceType>] the resource type definitions, keyed by the resource type name.
 
+    # @!attribute [r] security_schemes
+    #   @return [Hash<String, Raml::SecurityScheme>] the security scheme definitions, keyed by the security scheme name.
+
     scalar_property :title      , :version    , :base_uri     ,
                     :protocols  , :media_type
 
-    non_scalar_property :base_uri_parameters, :documentation , :schemas,  :secured_by, 
-                        :security_schemes   , :resource_types, :traits
+    non_scalar_property :base_uri_parameters, :documentation , :schemas,  :secured_by,
+                        :security_schemes   , :resource_types, :traits, :security_schemes
 
     regexp_property( /\A\//, ->(key,value) { Resource.new key, value, self } )
 
     children_of :documents, Documentation
 
-    children_by :base_uri_parameters, :name, Parameter::BaseUriParameter    
+    children_by :base_uri_parameters, :name, Parameter::BaseUriParameter
     children_by :resources          , :name, Resource
     children_by :schemas            , :name, Schema
     children_by :traits             , :name, Trait
     children_by :resource_types     , :name, ResourceType
+    children_by :security_schemes   , :name, SecurityScheme
+    children_by :secured_by         , :name, SecuritySchemeReference
 
-    alias :default_media_type         :media_type
-    alias :trait_declarations         :traits
-    alias :resource_type_declarations :resource_types
-    alias :schema_declarations        :schemas
-
-    self.doc_template = relative_path 'root.slim'
+    alias :default_media_type           :media_type
+    alias :trait_declarations           :traits
+    alias :resource_type_declarations   :resource_types
+    alias :security_scheme_declarations :security_schemes
+    alias :schema_declarations          :schemas
+    alias :secured_by_declarations      :secured_by
 
     def initialize(root_data)
       super nil, root_data, self
@@ -79,7 +84,7 @@ module Raml
         resources.values.each(&:apply_resource_type)
         resources.values.each(&:apply_traits)
         inline_reference SchemaReference, schemas, @children
-        @expanded = true 
+        @expanded = true
       end
     end
 
@@ -94,104 +99,113 @@ module Raml
       raise RequiredPropertyMissing, 'Missing root title property.'  if title.nil?
       raise RequiredPropertyMissing, 'Missing root baseUri property' if base_uri.nil?
       _validate_base_uri
+      _validate_secured_by
     end
 
     def validate_title
       validate_string :title, title
     end
-    
+
     def _validate_base_uri
       validate_string :base_uri, base_uri
-      
+
       # Check whether its a URL.
       uri = parse_uri base_uri
-      
+
       # If the parser doesn't think its a URL or the URL is not for HTTP or HTTPS,
       # try to parse it as a URL template.
       if uri.nil? and not uri.kind_of? URI::HTTP
         template = parse_template
-        
+
         # The template parser did not complain, but does it generate valid URLs?
         uri = template.expand Hash[ template.variables.map {|var| [ var, 'a'] } ]
         uri = parse_uri uri
         raise InvalidProperty, 'baseUri property is not a URL or a URL template.' unless
           uri and uri.kind_of? URI::HTTP
-        
+
         raise RequiredPropertyMissing, 'version property is required when baseUri template has version parameter' if
           template.variables.include? 'version' and version.nil?
       end
     end
-    
+
     def validate_protocols
       if protocols
         validate_array :protocols, protocols, String
-        
+
         @protocols.map!(&:upcase)
-        
-        raise InvalidProperty, 'protocols property elements must be HTTP or HTTPS' unless 
+
+        raise InvalidProperty, 'protocols property elements must be HTTP or HTTPS' unless
           protocols.all? { |p| [ 'HTTP', 'HTTPS'].include? p }
       end
     end
-    
+
     def validate_media_type
       if media_type
         validate_string :media_type, media_type
         raise InvalidProperty, 'mediaType property is malformed' unless media_type =~ Body::MEDIA_TYPE_RE
       end
     end
-    
+
     def parse_schemas(schemas)
       validate_array :schemas, schemas, Hash
-      
-      raise InvalidProperty, 'schemas property must be an array of maps with string keys'   unless 
+
+      raise InvalidProperty, 'schemas property must be an array of maps with string keys'   unless
         schemas.all? {|s| s.keys.all?   {|k| k.is_a? String }}
-      
-      raise InvalidProperty, 'schemas property must be an array of maps with string values' unless 
+
+      raise InvalidProperty, 'schemas property must be an array of maps with string values' unless
         schemas.all? {|s| s.values.all? {|v| v.is_a? String }}
-      
-      raise InvalidProperty, 'schemas property contains duplicate schema names'             unless 
+
+      raise InvalidProperty, 'schemas property contains duplicate schema names'             unless
         schemas.map(&:keys).flatten.uniq!.nil?
 
       schemas.reduce({}) { |memo, map | memo.merge! map }.
               map        { |name, data| Schema.new name, data, self }
     end
-    
+
     def parse_base_uri_parameters(base_uri_parameters)
       validate_hash :base_uri_parameters, base_uri_parameters, String, Hash
-      
+
       raise InvalidProperty, 'baseUriParameters property can\'t contain reserved "version" parameter' if
         base_uri_parameters.include? 'version'
 
       base_uri_parameters.map { |name, data| Parameter::BaseUriParameter.new name, data, self }
     end
-    
+
     def parse_documentation(documentation)
       validate_array :documentation, documentation
-      
-      raise InvalidProperty, 'documentation property must include at least one document or not be included' if 
+
+      raise InvalidProperty, 'documentation property must include at least one document or not be included' if
         documentation.empty?
 
       documentation.map { |doc| doc = doc.dup; Documentation.new doc.delete("title"), doc, self }
     end
-    
-    def parse_secured_by(data)
-      # XXX ignored for now
-    end
 
     def parse_security_schemes(data)
-      # XXX ignored for now
+      validate_array :security_schemes, data, Hash
+
+      raise InvalidProperty, 'securitySchemes property must be an array of maps with string keys'  unless
+        data.all? {|t| t.keys.all?   {|k| k.is_a? String }}
+
+      raise InvalidProperty, 'securitySchemes property must be an array of maps with map values'   unless
+        data.all? {|t| t.values.all? {|v| v.is_a? Hash }}
+
+      raise InvalidProperty, 'securitySchemes property contains duplicate type names'              unless
+        data.map(&:keys).flatten.uniq!.nil?
+
+      data.reduce({}) { |memo, map | memo.merge! map }.
+           map        { |name, data| SecurityScheme.new name, data, self }
     end
 
     def parse_resource_types(types)
       validate_array :resource_types, types, Hash
-      
-      raise InvalidProperty, 'resourceTypes property must be an array of maps with string keys'  unless 
+
+      raise InvalidProperty, 'resourceTypes property must be an array of maps with string keys'  unless
         types.all? {|t| t.keys.all?   {|k| k.is_a? String }}
-      
-      raise InvalidProperty, 'resourceTypes property must be an array of maps with map values'   unless 
+
+      raise InvalidProperty, 'resourceTypes property must be an array of maps with map values'   unless
         types.all? {|t| t.values.all? {|v| v.is_a? Hash }}
-      
-      raise InvalidProperty, 'resourceTypes property contains duplicate type names'              unless 
+
+      raise InvalidProperty, 'resourceTypes property contains duplicate type names'              unless
         types.map(&:keys).flatten.uniq!.nil?
 
       types.reduce({}) { |memo, map | memo.merge! map }.
@@ -200,14 +214,14 @@ module Raml
 
     def parse_traits(traits)
       validate_array :traits, traits, Hash
-      
-      raise InvalidProperty, 'traits property must be an array of maps with string keys'  unless 
+
+      raise InvalidProperty, 'traits property must be an array of maps with string keys'  unless
         traits.all? {|t| t.keys.all?   {|k| k.is_a? String }}
-      
-      raise InvalidProperty, 'traits property must be an array of maps with map values'   unless 
+
+      raise InvalidProperty, 'traits property must be an array of maps with map values'   unless
         traits.all? {|t| t.values.all? {|v| v.is_a? Hash }}
-      
-      raise InvalidProperty, 'traits property contains duplicate trait names'             unless 
+
+      raise InvalidProperty, 'traits property contains duplicate trait names'             unless
         traits.map(&:keys).flatten.uniq!.nil?
 
       traits.reduce({}) { |memo, map | memo.merge! map }.
@@ -219,7 +233,7 @@ module Raml
     rescue URI::InvalidURIError
       nil
     end
-    
+
     def parse_template
       URITemplate::RFC6570.new base_uri
     rescue URITemplate::RFC6570::Invalid
@@ -237,10 +251,5 @@ module Raml
       end
     end
 
-    def style_sheet
-      File.open(self.class.relative_path('style.sass'), 'r') do |file|
-        Sass::Engine.new(file.read, syntax: :scss).render
-      end
-    end
   end
 end