raml_ruby 0.1.1 → 0.1.2

data/test/raml/parameter/abstract_parameter_spec.rb

@@ -90,7 +90,7 @@ describe Raml::Parameter::AbstractParameter do
           let(:parameter_data) { { type: 'string', enum: enum } }
           it { expect { subject }.to raise_error Raml::InvalidParameterAttribute }
         end
-      end    
+      end
       context 'and an pattern attribute is given' do
         let(:parameter_data) { { type: 'string', pattern: pattern } }
         context 'and the value is string representing a valid regexp' do
@@ -132,7 +132,7 @@ describe Raml::Parameter::AbstractParameter do
           let(:pattern) { '[' }
           it { expect { subject }.to raise_error Raml::InvalidParameterAttribute }
         end
-      end    
+      end
     end
     context 'when the parameter type is not string' do
       context 'and a minLength attribute is given' do
@@ -190,7 +190,7 @@ describe Raml::Parameter::AbstractParameter do
         it { expect { subject }.to raise_error Raml::InapplicableParameterAttribute }
       end
     end
-    
+
     [
       [ 'string' , 'string' , '123',  123  ],
       [ 'number' , 'number' ,  12.3, '123' ],
@@ -215,7 +215,7 @@ describe Raml::Parameter::AbstractParameter do
         end
       end
     end
-    
+
     %w{repeat required}.each do |attribute|
       context "when the #{attribute} attribute is not true or false" do
         let(:parameter_data) { { attribute => 111 } }
@@ -237,7 +237,7 @@ describe Raml::Parameter::AbstractParameter do
         end
       end
     end
-    
+
     context 'when example property is given' do
       context 'when the example property is a string' do
         let(:parameter_data) { { 'example' =>  'My Attribute' } }
@@ -245,12 +245,9 @@ describe Raml::Parameter::AbstractParameter do
         it 'should store the value' do
           subject.example.should eq parameter_data['example']
         end
-        it 'uses the description in the documentation' do
-          subject.document.should include parameter_data['example']
-        end
       end
     end
-    
+
     context 'when the parameter has multiple types' do
       let(:parameter_data) {
         YAML.load %q(
@@ -267,13 +264,9 @@ describe Raml::Parameter::AbstractParameter do
         subject.children.should all( be_a Raml::Parameter::AbstractParameter )
         subject.children.map(&:type).should contain_exactly 'string', 'file'
       end
-
-      it "prints out documentation" do
-        subject.document
-      end
     end
   end
-  
+
   describe '#has_multiple_types?' do
     let(:name) { 'file' }
     context 'when the parameter has a single type' do
@@ -289,9 +282,9 @@ describe Raml::Parameter::AbstractParameter do
             description: File to upload. The file must be the last field in the form.
         )
       }
-      
+
       it { subject.has_multiple_types?.should be true }
-    end    
+    end
   end
 
   describe '#merge' do
@@ -543,22 +536,4 @@ describe Raml::Parameter::AbstractParameter do
     end
   end
 
-  describe '#document' do
-    let(:name) { 'page_number' }
-    let(:parameter_data) {
-      {
-        type:     'integer',
-        required: true,
-        example:  253995,
-        minimum:  33
-      }
-    }
-    it 'returns a String' do
-      subject.document.should be_a String
-    end
-    it 'should render the template' do
-      mock(Slim::Template).new(/templates\/abstract_parameter.slim\z/, is_a(Hash)).mock!.render(is_a(Raml::Node)) { '' }
-      subject.document
-    end
-  end
 end

data/test/raml/parameter/query_parameter_spec.rb

@@ -15,19 +15,4 @@ describe Raml::Parameter::QueryParameter do
   it "should instanciate Query parameter" do
     Raml::Parameter::QueryParameter.new(name, data, root)
   end
-
-  describe "#document" do
-    let(:data) {
-      YAML.load(%q(
-        description: Specify the page that you want to retrieve
-        type: integer
-        required: true
-        example: 1
-      ))
-    }
-
-    it "prints out documentation" do
-      subject.document
-    end
-  end
 end

data/test/raml/parameter/uri_parameter_spec.rb

@@ -18,7 +18,7 @@ describe Raml::Parameter::UriParameter do
     it "should instanciate Uri parameter" do
       Raml::Parameter::UriParameter.new(name, data, root)
     end
-    
+
     context 'when no required attribute is given' do
       let(:data) { { } }
       it 'defaults to true' do
@@ -26,19 +26,4 @@ describe Raml::Parameter::UriParameter do
       end
     end
   end
-
-  describe "#document" do
-    let(:data) {
-      YAML.load(%q(
-        description: Specify the page that you want to retrieve
-        type: integer
-        required: true
-        example: 1
-      ))
-    }
-
-    it "prints out documentation" do
-      subject.document
-    end
-  end
 end

data/test/raml/resource_spec.rb

@@ -35,18 +35,15 @@ describe Raml::Resource do
     it "should instanciate Resource" do
       subject
     end
-    
+
     context 'when displayName is given' do
       let(:data) { { 'displayName' => 'My Name', 'description' => 'foo' } }
       it { expect { subject }.to_not raise_error }
       it 'should store the value' do
         subject.display_name.should eq data['displayName']
       end
-      it 'uses the displayName in the documentation' do
-        subject.document.should include data['displayName']
-      end
     end
-    
+
     context 'when description is not given' do
       let(:data) { {} }
       it { expect { subject }.to_not raise_error }
@@ -62,12 +59,9 @@ describe Raml::Resource do
         it 'should store the value' do
           subject.description.should eq data['description']
         end
-        it 'uses the description in the documentation' do
-          subject.document.should include data['description']
-        end
       end
     end
-    
+
     context 'when the uriParameters parameter is given with valid parameters' do
       context 'when the uriParameters property is well formed' do
         it { expect { subject }.to_not raise_error }
@@ -88,7 +82,7 @@ describe Raml::Resource do
         it { expect { subject }.to raise_error Raml::InvalidProperty, /uriParameters/ }
       end
     end
-    
+
     context 'when nested resources are defined' do
       let(:name) { '/{userId}' }
       let(:data) {
@@ -115,7 +109,7 @@ describe Raml::Resource do
         expect( subject.resources.keys   ).to contain_exactly('/followers','/following', '/keys')
       end
     end
-    
+
     context 'when a baseUriParameters property is given' do
       context 'when the baseUriParameters property is well formed' do
         let(:name) { '/files' }
@@ -129,7 +123,7 @@ describe Raml::Resource do
             )
           )
         }
-        
+
         it { expect { subject }.to_not raise_error }
         it 'stores all as Raml::Parameter::UriParameter instances' do
           expect( subject.base_uri_parameters.values ).to all( be_a Raml::Parameter::BaseUriParameter )
@@ -155,7 +149,7 @@ describe Raml::Resource do
     end
 
     context 'when an type property is given' do
-     let(:root) { 
+     let(:root) {
         Raml::Root.new 'title' => 'x', 'baseUri' => 'http://foo.com',  'resourceTypes' => [
           { 'collection'        => {} },
           { 'member'            => {} },
@@ -208,9 +202,9 @@ describe Raml::Resource do
         end
       end
     end
-    
+
     context 'when an is property is given' do
-     let(:root) { 
+     let(:root) {
         Raml::Root.new 'title' => 'x', 'baseUri' => 'http://foo.com',  'traits' => [
           { 'secured'     => {} },
           { 'paged'       => {} },
@@ -227,11 +221,11 @@ describe Raml::Resource do
           end
         end
         context 'when the property is an array of trait references with parameters' do
-          let(:data) { { 
-            'is' => [ 
-              {'secured' => {'tokenName' => 'access_token'}}, 
-              {'paged'   => {'maxPages'  => 10            }} 
-            ] 
+          let(:data) { {
+            'is' => [
+              {'secured' => {'tokenName' => 'access_token'}},
+              {'paged'   => {'maxPages'  => 10            }}
+            ]
           } }
           it { expect { subject }.to_not raise_error }
           it 'should store the trait references' do
@@ -240,11 +234,11 @@ describe Raml::Resource do
           end
         end
         context 'when the property is an array of trait definitions' do
-          let(:data) { { 
-            'is' => [ 
-              {'queryParameters' => {'tokenName' => {'description'=>'foo'}}}, 
+          let(:data) { {
+            'is' => [
+              {'queryParameters' => {'tokenName' => {'description'=>'foo'}}},
               {'queryParameters' => {'numPages'  => {'description'=>'bar'}}}
-            ] 
+            ]
           } }
           it { expect { subject }.to_not raise_error }
           it 'should store the traits' do
@@ -254,12 +248,12 @@ describe Raml::Resource do
           end
         end
         context 'when the property is an array of mixed trait refrences, trait refrences with parameters, and trait definitions' do
-          let(:data) { { 
-            'is' => [ 
-              {'secured' => {'tokenName' => 'access_token'}}, 
+          let(:data) { {
+            'is' => [
+              {'secured' => {'tokenName' => 'access_token'}},
               {'queryParameters' => {'numPages'  => {'description'=>'bar'}}},
               'rateLimited'
-            ] 
+            ]
           } }
           it { expect { subject }.to_not raise_error }
           it 'should store the traits' do
@@ -310,6 +304,33 @@ describe Raml::Resource do
       }
       it { expect { subject }.to raise_error Raml::InvalidProperty, /Optional properties/ }
     end
+
+    context 'when the securedBy property is defined' do
+      let (:root_data) { {'title' => 'x', 'baseUri' => 'http://foo.com', 'securitySchemes' => ['oauth_2_0' => {'type' => 'OAuth 2.0'}, 'oauth_1_0' => {'type' => 'OAuth 1.0'}] } }
+      context 'when the securedBy property is an array of strings' do
+        let(:data) { { 'securedBy' => ['oauth_2_0', 'oauth_1_0'] } }
+        it { expect{ subject }.to_not raise_error }
+      end
+      context 'when the securedBy property is an array of strings and "null"' do
+        let(:data) { { 'securedBy' => ['oauth_2_0', 'null'] } }
+        it { expect{ subject }.to_not raise_error }
+      end
+      context 'when the securedBy property is an array of hash with single key' do
+        let(:data) { { 'securedBy' => ['oauth_2_0' => {'scopes' => 'ADMINISTRATOR'}] } }
+        it { expect{ subject }.to_not raise_error }
+      end
+      context 'when the securedBy property references a missing security scheme' do
+        let(:data) { { 'securedBy' => ['bar'] } }
+        it { expect{ subject }.to raise_error Raml::UnknownSecuritySchemeReference, /bar/}
+      end
+      context 'when the securedBy property is included it is accessible and' do
+        let(:data) { { 'securedBy' => ['oauth_2_0', 'oauth_1_0'] } }
+        it 'exposes the schema references' do
+          expect( subject.secured_by.values ).to all( be_a Raml::SecuritySchemeReference )
+          subject.secured_by.keys.should contain_exactly('oauth_2_0', 'oauth_1_0')
+        end
+      end
+    end
   end
 
   describe '#apply_resource_type' do
@@ -320,9 +341,10 @@ describe Raml::Resource do
       'get'  => {'description' => 'method description'},
       'post' => {},
       '/foo' => {},
-      '/bar' => {}
+      '/bar/{id}' => {}
     } }
     let(:resource) { Raml::Resource.new('/foo', resource_data, root)  }
+    let(:resource_with_parameter) { Raml::Resource.new('/bar/{id}', resource_data, root)  }
     context 'when it has a resource type' do
       it 'merges the resource type to the resource' do
         resource.type.should be_a Raml::ResourceType
@@ -337,6 +359,12 @@ describe Raml::Resource do
         resource.apply_resource_type
         resource.methods['get'].description.should  eq 'method description'
         resource.methods['get'].display_name.should eq 'resource type displayName'
+        resource.resource_path.should eq '/foo'
+        resource.resource_path_name.should eq 'foo'
+      end
+      it 'sets the resource path name stripping out uri parameters' do
+        resource_with_parameter.apply_resource_type
+        resource_with_parameter.resource_path_name.should eq 'bar'
       end
     end
     context 'when it has nested resources' do
@@ -352,7 +380,7 @@ describe Raml::Resource do
     let(:resource_data) { {
       'is' => [
         { 'description' => 'trait1 description' },
-        { 'description' => 'trait2 description' } 
+        { 'description' => 'trait2 description' }
       ],
       'get'  => {},
       'post' => {},
@@ -384,7 +412,7 @@ describe Raml::Resource do
     end
     context 'when called with a ResourceType::Instance' do
       let(:root_data) { {
-        'title'   => 'x', 
+        'title'   => 'x',
         'baseUri' => 'http://foo.com',
         'traits'  => [ {
           'secured' => { 'usage' => 'requires authentication' },
@@ -427,14 +455,4 @@ describe Raml::Resource do
       end
     end
   end
-
-  describe '#document' do
-    it 'returns a String' do
-      subject.document.should be_a String
-    end
-    it 'should render the template' do
-      mock(Slim::Template).new(/templates\/resource.slim\z/, is_a(Hash)).mock!.render(is_a(Raml::Node)) { '' }
-      subject.document
-    end
-  end
 end

data/test/raml/resource_type_spec.rb

@@ -2,7 +2,7 @@
 require_relative 'spec_helper'
 
 describe Raml::ResourceType do
-	let(:name) { 'auditableResource' }
+  let(:name) { 'auditableResource' }
   let(:data) {
     YAML.load(%q(
       post:
@@ -28,24 +28,24 @@ describe Raml::ResourceType do
   subject { Raml::ResourceType.new(name, data, root) }
 
   describe '#new' do
-  	context 'with valid arguments' do
-  	  it { expect { subject }.to_not raise_error }
-  	  it { should be_a Raml::ResourceType }
+    context 'with valid arguments' do
+      it { expect { subject }.to_not raise_error }
+      it { should be_a Raml::ResourceType }
     end
   end
 
   describe '#instantiate' do
     context 'when the usage property is given' do
-  		before { data['usage'] = 'Some text' }
-	    it 'stores the usage property' do
+      before { data['usage'] = 'Some text' }
+      it 'stores the usage property' do
         subject.instantiate({}).usage.should eq data['usage']
-	    end
-	  end
+      end
+    end
     context 'with invalid arguments' do
-    	context 'when the resource type has nested resources' do
-    		before { data['/foo'] = {} }
-    		it { expect { subject.instantiate({}) }.to raise_error Raml::UnknownProperty, /\/foo/ }
-    	end
+      context 'when the resource type has nested resources' do
+        before { data['/foo'] = {} }
+        it { expect { subject.instantiate({}) }.to raise_error Raml::UnknownProperty, /\/foo/ }
+      end
     end
   end
-end
+end

data/test/raml/response_spec.rb

@@ -61,7 +61,7 @@ describe Raml::Response do
         it { expect { subject }.to raise_error Raml::InvalidProperty, /body/ }
       end
     end
-    
+
     context 'when description property is not given' do
       before { response_data.delete 'description' }
       it { expect { subject }.to_not raise_error }
@@ -77,12 +77,9 @@ describe Raml::Response do
         it 'should store the value' do
           subject.description.should eq response_data['description']
         end
-        it 'uses the description in the documentation' do
-          subject.document.should include response_data['description']
-        end
       end
     end
-    
+
     context 'when the headers parameter is given' do
       context 'when the headers property is well formed' do
         it { expect { subject }.to_not raise_error }
@@ -103,7 +100,7 @@ describe Raml::Response do
         before { response_data['headers'] = { '1' => 'x'} }
         it { expect { subject }.to raise_error Raml::InvalidProperty, /headers/ }
       end
-    end    
+    end
   end
 
   describe '#merge' do
@@ -132,9 +129,9 @@ describe Raml::Response do
             end
           end
           context 'headers properties' do
-            let(:mixin_data) { { 
+            let(:mixin_data) { {
               'headers' => {
-                'header1' => {'description' => 'foo'}, 
+                'header1' => {'description' => 'foo'},
                 'header2' => {'description' => 'bar'}
               }
             } }
@@ -143,9 +140,9 @@ describe Raml::Response do
             end
           end
           context 'body property' do
-            let(:mixin_data) { { 
+            let(:mixin_data) { {
               'body' => {
-                'text/mime1' => {'schema' => 'foo'}, 
+                'text/mime1' => {'schema' => 'foo'},
                 'text/mime2' => {'schema' => 'bar'}
               }
             } }
@@ -170,16 +167,16 @@ describe Raml::Response do
             end
           end
           context 'headers properties' do
-            let(:response_data) { { 
+            let(:response_data) { {
               'headers' => {
-                'header1' => {'description' => 'foo'}, 
+                'header1' => {'description' => 'foo'},
                 'header2' => {'description' => 'bar'}
               }
             } }
             context 'when the mixin headers are different from the response headers' do
-              let(:mixin_data) { { 
+              let(:mixin_data) { {
                 'headers' => {
-                  'header3' => {'description' => 'foo2'}, 
+                  'header3' => {'description' => 'foo2'},
                   'header4' => {'description' => 'bar2'}
                 }
               } }
@@ -188,10 +185,10 @@ describe Raml::Response do
               end
             end
             context 'when the mixin headers overlap the the response headers' do
-              let(:mixin_data) { { 
+              let(:mixin_data) { {
                 'headers' => {
-                  'header2' => {'description' => 'bar3', 'displayName' => 'Header 3'}, 
-                  'header3' => {'description' => 'foo2'}, 
+                  'header2' => {'description' => 'bar3', 'displayName' => 'Header 3'},
+                  'header3' => {'description' => 'foo2'},
                   'header4' => {'description' => 'bar2'}
                 }
               } }
@@ -200,19 +197,19 @@ describe Raml::Response do
                  response.headers['header2'].display_name.should eq mixin.headers['header2'].display_name
                  response.headers['header2'].description.should  eq mixin.headers['header2'].description
               end
-            end        
+            end
           end
           context 'body property' do
-            let(:response_data) { { 
+            let(:response_data) { {
               'body' => {
-                'text/mime1' => {'schema' => 'foo'}, 
+                'text/mime1' => {'schema' => 'foo'},
                 'text/mime2' => {'schema' => 'bar'}
               }
             } }
             context 'when the mixin query parameters are different from the response headers' do
-              let(:mixin_data) { { 
+              let(:mixin_data) { {
                 'body' => {
-                  'text/mime3' => {'schema' => 'foo2'}, 
+                  'text/mime3' => {'schema' => 'foo2'},
                   'text/mime4' => {'schema' => 'bar2'}
                 }
               } }
@@ -221,10 +218,10 @@ describe Raml::Response do
               end
             end
             context 'when the mixin query parameters overlap the the response query parameters' do
-              let(:mixin_data) { { 
+              let(:mixin_data) { {
                 'body' => {
-                  'text/mime2' => {'example' => 'Example 2'}, 
-                  'text/mime3' => {'schema'  => 'foo2'}, 
+                  'text/mime2' => {'example' => 'Example 2'},
+                  'text/mime3' => {'schema'  => 'foo2'},
                   'text/mime4' => {'schema'  => 'bar2'}
                 }
               } }
@@ -232,20 +229,10 @@ describe Raml::Response do
                  response.merge(mixin).bodies.keys.should contain_exactly('text/mime1', 'text/mime2', 'text/mime3', 'text/mime4')
                  response.bodies['text/mime2'].example.should eq mixin.bodies['text/mime2'].example
               end
-            end  
+            end
           end
         end
       end
     end
   end
-
-  describe '#document' do
-    it 'returns a String' do
-      subject.document.should be_a String
-    end
-    it 'should render the template' do
-      mock(Slim::Template).new(/templates\/response.slim\z/, is_a(Hash)).mock!.render(is_a(Raml::Node)) { '' }
-      subject.document
-    end
-  end
 end