raml_ruby 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d5b2c3c690054638bb3cdf5dd0ea4fe0cf6e5763
-  data.tar.gz: 913d89301e7cb20ff0e6c73deb7b5104b93b4e47
+  metadata.gz: d78e661c19f75dc28745e0c8fb4daf4573ac2e00
+  data.tar.gz: 05f13dc760016c4f85e02236207ff6961eb77a21
 SHA512:
-  metadata.gz: a2c78f5010254baab46d008805a257e78a0793486f0e339607a514d2622685c6d991550f53b463ed91b1ff03aead6ff3d5ee5077ba44880dc2c2483900b3d033
-  data.tar.gz: 1206b2996083539351d5ece371ee8451658c7994b7c9630ae99db5019b30bdd42933f673722ad28092dbc3be34da5aad19c5e63c681317d61747267db80d82ee
+  metadata.gz: b36dcd3894306113f8f67944fd033b8df6d6133f95e01c98fc816cd9913c1d7784da4759beaa07c3a9bb09067f2281ae5356db0e65d9b3458322b5d1a400b686
+  data.tar.gz: 3ae125b1d5f0c03910050a2080bdff605314a0c8cce7d6360bf5194a88caddaee6133ae5c61e23752bf3c4260d7dae1ae686bd0018a87780689a986d0de35385

data/.travis.yml

@@ -4,3 +4,5 @@ rvm:
   - "2.1.2"
   - jruby-19mode
 script: bundle exec rspec test
+before_install:
+  - gem install bundler -v 1.11.2

data/README.md

@@ -1,6 +1,6 @@
 # RAML ruby
 
-[![Build Status](https://travis-ci.org/eliaslevy/raml_ruby.svg?branch=master)](https://travis-ci.org/eliaslevy/raml_ruby)
+[![Build Status](https://travis-ci.org/coub/raml_ruby.svg?branch=master)](https://travis-ci.org/coub/raml_ruby)
 
 Implementation of a RAML parser in Ruby. It uses the stdlib YAML parser
 (Psych). It can also generate HTML documentation.
@@ -40,14 +40,6 @@ To parse the file:
 
     Raml.parse_file("path/to/your/file.raml")
 
-To generate HTML documentation:
-
-    # write to file
-    Raml.document("/path/to/your/file.raml", "path/to/output/file.html")
-
-    # or just on screen
-    Raml.document("/path/to/your/file.raml")
-
 ## To Do
 
 - Align mergin strategy of conflicting properties of resource types and traits with official Javascript and Java parsers.

data/Rakefile

@@ -1 +1,8 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = FileList['test/raml/**/*_spec.rb']
+end
+
+task default: :spec

data/lib/raml.rb

@@ -38,6 +38,10 @@ require_relative 'raml/node/resource_type_reference'
 
 require_relative 'raml/node/template'
 
+require_relative 'raml/node/security_scheme'
+require_relative 'raml/node/security_scheme_reference'
+require_relative 'raml/mixin/secured_by'
+
 require_relative 'raml/node/abstract_method'
 require_relative 'raml/node/trait'
 require_relative 'raml/node/method'
@@ -71,34 +75,10 @@ module Raml
   def self.parse_file(filepath)
     file = File.new filepath
     raise UnsupportedRamlVersion unless file.readline =~ /\A#%RAML 0.8\s*\z/
-    
+
     path = File.dirname filepath
     path = nil if path == ''
-    
-    Raml::Parser.parse file.read, path
-  end
 
-  # Parses RAML from a file and generates API documentation in HTML.  If no
-  # output filename argument is given, the HTML is returned as a string. If
-  # an output filename argument is given, the HTML is stored to a file at
-  # that location.
-  #
-  # @param filepath [String] the file path of the file containing RAML.
-  # @param out_file [String] the file path of the file to write the documentation to. Defaults to nil.
-  # @return [String] the HTML documentation, if out_file is nil.
-  # @raise [Errno::ENOENT] if the file can't be found.
-  # @raise [Errno::EACCES] if the files can't be read or written.
-  # @raise [RamlError] if the RAML is invalid.
-  def self.document(filepath, out_file=nil)
-    root = parse_file filepath
-    root.expand
-
-    if out_file
-      File.open(out_file, 'w') do |file|
-        file.write root.document
-      end
-    else
-      root.document
-    end
+    Raml::Parser.parse file.read, path
   end
 end

data/lib/raml/exceptions.rb

@@ -21,6 +21,7 @@ module Raml
 
   class UnknownTraitReference           < RamlError; end
   class UnknownResourceTypeReference    < RamlError; end
+  class UnknownSecuritySchemeReference  < RamlError; end
   class MergeError                      < RamlError; end
   class UnknownTypeOrTraitParameter     < RamlError; end
   class UnknownTypeOrTraitParamFunction < RamlError; end

data/lib/raml/mixin/bodies.rb

@@ -9,11 +9,11 @@ module Raml
 
     def self.included(base)
       base.instance_eval do
-		    non_scalar_property :body
-		    children_by :bodies, :media_type , Body
+        non_scalar_property :body
+        children_by :bodies, :media_type , Body
       end
     end
-    
+
     def parse_body(value)
       if value.is_a? Hash and value.keys.all? {|k| k.is_a? String and k =~ /.+\/.+/ }
         # If all keys looks like media types, its not a default media type body.

data/lib/raml/mixin/documentable.rb

@@ -1,5 +1,3 @@
-require 'kramdown'
-
 module Raml
   module Documentable
     # @!attribute [rw] display_name
@@ -9,9 +7,6 @@ module Raml
     #   @return [String, nil] the node's description.
 
     # @private
-    def html_description
-      Kramdown::Document.new(description, input: :GFM).to_html
-    end
 
     private
 
@@ -22,11 +17,11 @@ module Raml
     end
 
     def validate_display_name
-      raise InvalidProperty, "displayName property mus be a string." unless display_name.is_a? String 
+      raise InvalidProperty, "displayName property must be a string." unless display_name.is_a? String
     end
 
     def validate_description
-      raise InvalidProperty, "description property mus be a string." unless description.is_a? String 
+      raise InvalidProperty, "description property must be a string." unless description.is_a? String
     end
   end
-end
+end

data/lib/raml/mixin/global.rb

@@ -5,16 +5,20 @@ module Raml
       @parent.default_media_type
     end
 
-  	def trait_declarations
-  		@parent.trait_declarations
-  	end
+    def trait_declarations
+      @parent.trait_declarations
+    end
 
-  	def resource_type_declarations
-  		@parent.resource_type_declarations
-  	end
+    def resource_type_declarations
+      @parent.resource_type_declarations
+    end
 
-  	def schema_declarations
-  		@parent.schema_declarations
-  	end
+    def schema_declarations
+      @parent.schema_declarations
+    end
+
+    def security_scheme_declarations
+      @parent.security_scheme_declarations
+    end
   end
-end
+end

data/lib/raml/mixin/headers.rb

@@ -9,7 +9,7 @@ module Raml
 
     def self.included(base)
       base.instance_eval do
-		    non_scalar_property :headers
+        non_scalar_property :headers
         children_by :headers, :name, Header
       end
     end

data/lib/raml/mixin/merge.rb

@@ -10,15 +10,15 @@ module Raml
     end
 
     def merge_properties(other, type)
-    	match, no_match = other.send(type).values.partition { |param| self.send(type).has_key? param.name }
+      match, no_match = other.send(type).values.partition { |param| self.send(type).has_key? param.name }
 
-    	match.each { |param| self.send(type)[param.name].merge param }
+      match.each { |param| self.send(type)[param.name].merge param }
 
       # if its an optional property, and there is no match in self, don't merge it.
       no_match.reject! { |node| node.optional      }
       no_match.map!    { |node| node.clone         }
       no_match.each    { |node| node.parent = self }
-    	@children += no_match
+      @children += no_match
     end
   end
-end
+end

data/lib/raml/mixin/secured_by.rb

@@ -0,0 +1,27 @@
+module Raml
+  # @private
+  module SecuredBy
+    def parse_secured_by(data)
+      validate_array :secured_by, data, [String, Hash]
+
+      data.map do |security_scheme|
+        if security_scheme.is_a? Hash
+          raise InvalidProperty, 'is property with map with more than one key' if security_scheme.size > 1
+          raise InvalidProperty, 'is property with map of security_scheme name but params are not a map' unless
+            security_scheme.values[0].is_a? Hash
+          SecuritySchemeReference.new( security_scheme.keys[0], security_scheme.values[0], self )
+        else
+          SecuritySchemeReference.new security_scheme, {}, self
+        end
+      end
+    end
+
+    def _validate_secured_by
+      valid_security_schemes = security_scheme_declarations.keys + ["null"]
+      secured_by.keys.each do |security_scheme_reference|
+        raise UnknownSecuritySchemeReference.new(security_scheme_reference) unless
+          valid_security_schemes.include?(security_scheme_reference)
+      end
+    end
+  end
+end

data/lib/raml/mixin/validation.rb

@@ -1,49 +1,49 @@
 module Raml
   # @private
-	module Validation
+  module Validation
     def validate_property(name, value, classes)
       classes = [ classes ] unless classes.is_a? Array
       raise InvalidProperty, "#{camel_case name} property must be an #{classes_to_s classes}" unless classes.include? value.class
     end
 
-		def validate_string(name, string)
-			validate_property name, string, String
+    def validate_string(name, string)
+      validate_property name, string, String
       raise InvalidProperty, "#{camel_case name} property must be a non-empty string." if     string.empty?
-		end
+    end
 
-		def validate_array(name, array, element_classes=nil)
+    def validate_array(name, array, element_classes=nil)
       raise InvalidProperty, "#{camel_case name} property must be an array" unless
-      	array.is_a? Array
+        array.is_a? Array
 
       if element_classes
-      	element_classes = [ element_classes ] unless element_classes.is_a? Array
-	      raise InvalidProperty, "#{camel_case name} property must be an array of #{classes_to_s element_classes}" unless
-	        array.all? { |element| element_classes.include? element.class }
+        element_classes = [ element_classes ] unless element_classes.is_a? Array
+        raise InvalidProperty, "#{camel_case name} property must be an array of #{classes_to_s element_classes}" unless
+          array.all? { |element| element_classes.include? element.class }
       end
-		end
+    end
 
-		def validate_hash(name, hash, key_class=nil, value_class=nil)
-      raise InvalidProperty, "#{camel_case name} property must be a map" unless 
+    def validate_hash(name, hash, key_class=nil, value_class=nil)
+      raise InvalidProperty, "#{camel_case name} property must be a map" unless
         hash.is_a? Hash
 
       if key_class
-				if key_class.is_a? Array
-		      raise InvalidProperty, "#{camel_case name} property must be a map with #{key_class} keys" unless
-		        hash.keys.all?  {|key| key_class.any? { |kc| key.is_a? kc } }
-				else
-		      raise InvalidProperty, "#{camel_case name} property must be a map with #{key_class} keys" unless
-		        hash.keys.all?  {|key| key.is_a? key_class }
- 				end
+        if key_class.is_a? Array
+          raise InvalidProperty, "#{camel_case name} property must be a map with #{key_class} keys" unless
+            hash.keys.all?  {|key| key_class.any? { |kc| key.is_a? kc } }
+        else
+          raise InvalidProperty, "#{camel_case name} property must be a map with #{key_class} keys" unless
+            hash.keys.all?  {|key| key.is_a? key_class }
+         end
       end
 
       if value_class
-	      raise InvalidProperty, "#{camel_case name} property must be a map with map values: #{hash}" unless
-	      	hash.values.all?  {|value| value.is_a? Hash }
+        raise InvalidProperty, "#{camel_case name} property must be a map with map values: #{hash}" unless
+          hash.values.all?  {|value| value.is_a?(Hash) || value.nil? }
       end
-		end
+    end
 
-		def classes_to_s(classes)
-			classes.join(', ').gsub(/, (\w)\z/, ' or \1')
-		end
-	end
-end
+    def classes_to_s(classes)
+      classes.join(', ').gsub(/, (\w)\z/, ' or \1')
+    end
+  end
+end

data/lib/raml/node.rb

@@ -1,34 +1,14 @@
 require 'active_support'
 require 'active_support/core_ext/class/attribute'
-require 'rouge'
-require 'slim'
 
 module Raml
   class Node
-    class_attribute :doc_template, :doc_template_compiled
-
-    class << self
-      # @private
-      def relative_path(file)
-        File.join(
-          *File.dirname(__FILE__).
-            split(File::SEPARATOR).
-            reverse.
-            drop_while { |p| p != 'lib' }.
-            drop(1).
-            reverse,
-          'templates',
-          file
-        )
-      end
-    end
-
     # @!attribute [r] name
-    #   @return [String,Integer] the node name (e.g. resource path, header name, etc). Usually a 
+    #   @return [String,Integer] the node name (e.g. resource path, header name, etc). Usually a
     #     String.  Can be an Integer for methods.
     attr_reader   :name
     # @!attribute [rw] parent
-    #   @return [Raml::Node] the node's parent. 
+    #   @return [Raml::Node] the node's parent.
     attr_accessor :parent
 
     def initialize(name, parent)
@@ -36,17 +16,6 @@ module Raml
       @parent = parent
     end
 
-    # Returns HTML documenting the node and child nodes.
-    # @return [String] HTML documentation.
-    def document
-      if doc_template
-        self.doc_template_compiled ||= Slim::Template.new(doc_template, format: :html5, pretty: true)
-        doc_template_compiled.render self
-      else
-        nil
-      end
-    end
-
     private
 
     def underscore(camel_cased_word)
@@ -61,35 +30,6 @@ module Raml
       w = underscored_word.to_s.split('_')
       (w[0...1] + w[1..-1].map(&:capitalize)).join
     end
-
-    def collapse(level, title, display_name=nil, &block)
-      @@cid ||= 0
-      @@cid  += 1
-
-      @@context_class ||= Struct.new(:cid, :title, :level, :display_name, :content) do
-        def highlight_url_params(url)
-          url.gsub(/({[^}]+})/, '<span class="url_param">\1</span>')
-        end 
-      end
-
-      context = @@context_class.new @@cid, title, level, display_name, yield
-
-      @@collapse ||= Slim::Template.new(self.class.relative_path('collapse.slim'), format: :html5, pretty: true)
-      @@collapse.render context
-    end
-
-    def highlight_url_params(url)
-      url.gsub(/({[^}]+})/, '<span class="url_param">\1</span>')
-    end 
-
-    def highlight(source, mimetype=nil)
-      opts = { source: source }
-      opts[:mimetype] = mimetype if mimetype
-
-      formatter = Rouge::Formatters::HTML.new css_class: 'highlight'
-      lexer = Rouge::Lexer.guess(opts).new
-      formatter.format lexer.lex source
-    end
   end
 
   class ValueNode < Node
@@ -139,14 +79,14 @@ module Raml
     # @private
     def non_scalar_properties; self.class.non_scalar_properties; end
     # @private
-    def _regexp_property     ; self.class._regexp_property     ; end 
+    def _regexp_property     ; self.class._regexp_property     ; end
 
     # @!attribute [rw] optional
     #   @return [Boolean] whether the property is optional. Only valid
     #     for decendant nodes a {Trait::Instance} or {ResourceType::Instance}.
     #     Indicated by a trailing "?" on the property name in the RAML source.
     attr_accessor :optional
-    
+
     def initialize(name, properties, parent)
       if name.is_a? String and name.end_with? '?'
         allow_optional? parent
@@ -176,26 +116,28 @@ module Raml
       maybe_exec :validate_name
       maybe_exec :validate_parent
 
-      properties.each do |prop_name, prop_value|
-        prop_name       = prop_name.to_s
-        under_prop_name = underscore prop_name
+      if !properties.nil?
+        properties.each do |prop_name, prop_value|
+          prop_name       = prop_name.to_s
+          under_prop_name = underscore prop_name
 
-        if scalar_properties.include? under_prop_name
-          send "#{under_prop_name}=", prop_value
-          maybe_exec "validate_#{under_prop_name}"
+          if scalar_properties.include? under_prop_name
+            send "#{under_prop_name}=", prop_value
+            maybe_exec "validate_#{under_prop_name}"
 
-        elsif non_scalar_properties.include? under_prop_name
-          parsed = send "parse_#{under_prop_name}", prop_value
-          parsed = [ parsed ] unless parsed.is_a? Array
-          @children += parsed
+          elsif non_scalar_properties.include? under_prop_name
+            parsed = send "parse_#{under_prop_name}", prop_value
+            parsed = [ parsed ] unless parsed.is_a? Array
+            @children += parsed
 
-        elsif _regexp_property and _regexp_property[0].match prop_name
-          parsed = self.instance_exec(prop_name, prop_value, &_regexp_property[1])
-          parsed = [ parsed ] unless parsed.is_a? Array
-          @children += parsed
+          elsif _regexp_property and _regexp_property[0].match prop_name
+            parsed = self.instance_exec(prop_name, prop_value, &_regexp_property[1])
+            parsed = [ parsed ] unless parsed.is_a? Array
+            @children += parsed
 
-        else
-          raise UnknownProperty, "#{prop_name} is an unknown property with value of #{prop_value}."
+          else
+            raise UnknownProperty, "#{prop_name} is an unknown property with value of #{prop_value}."
+          end
         end
       end