raml-rb 0.0.2

data/spec/fixtures/all-the-things.raml

@@ -0,0 +1,54 @@
+#%RAML 0.8
+
+title: World Music API
+baseUri: http://example.api.com/{version}
+version: v1
+documentation:
+  - title: RAML Baml
+    content: |
+      - Project: [source code](https://github.com/jpb/raml-rb)
+traits:
+  - paged:
+      queryParameters:
+        pages:
+          description: The number of pages to return
+          type: number
+  - secured: !include http://raml-example.com/secured.yml
+/songs:
+  is: [ paged, secured ]
+  get:
+    queryParameters:
+      genre:
+        description: filter the songs by genre
+  post:
+  /{songId}:
+    get:
+      responses:
+        200:
+          body:
+            text/xml:
+              schema: |
+                <xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">
+                  <xs:element name="api-request">
+                    <xs:complexType>
+                      <xs:sequence>
+                        <xs:element type="xs:string" name="title"/>
+                        <xs:element type="xs:string" name="artist"/>
+                      </xs:sequence>
+                    </xs:complexType>
+                  </xs:element>
+                </xs:schema>
+            application/json:
+              schema: |
+                { "$schema": "http://json-schema.org/schema",
+                  "type": "object",
+                  "description": "A canonical song",
+                  "properties": {
+                    "title":  { "type": "string" },
+                    "artist": { "type": "string" }
+                  },
+                  "required": [ "title", "artist" ]
+                }
+    delete:
+      description: |
+        This method will *delete* an **individual song**

data/spec/fixtures/basic.raml

@@ -0,0 +1,41 @@
+#%RAML 0.8
+
+title: World Music API
+baseUri: http://example.api.com/{version}
+version: v1
+traits:
+  - paged:
+      queryParameters:
+        pages:
+          description: The number of pages to return
+          type: number
+  - secured: !include http://raml-example.com/secured.yml
+  - notApplied:
+      fake: value
+/songs:
+  is: [ paged, secured ]
+  get:
+    queryParameters:
+      genre:
+        description: filter the songs by genre
+  post:
+  /{songId}:
+    get:
+      responses:
+        200:
+          body:
+            application/json:
+              schema: |
+                { "$schema": "http://json-schema.org/schema",
+                  "type": "object",
+                  "description": "A canonical song",
+                  "properties": {
+                    "title":  { "type": "string" },
+                    "artist": { "type": "string" }
+                  },
+                  "required": [ "title", "artist" ]
+                }
+            application/xml:
+    delete:
+      description: |
+        This method will *delete* an **individual song**

data/spec/lib/raml/body_spec.rb

@@ -0,0 +1,24 @@
+require 'raml/body'
+
+describe Raml::Body do
+
+  describe '.new' do
+    subject { Raml::Body.new('the type') }
+    its(:type) { should == 'the type' }
+  end
+
+  describe '#type' do
+    let(:body) { Raml::Body.new('the type') }
+    before { body.type = 'type' }
+    subject { body.type }
+    it { should == 'type' }
+  end
+
+  describe '#schema' do
+    let(:body) { Raml::Body.new('the type') }
+    before { body.schema = 'schema' }
+    subject { body.schema }
+    it { should == 'schema' }
+  end
+
+end

data/spec/lib/raml/documentation_spec.rb

@@ -0,0 +1,19 @@
+require 'raml/documentation'
+
+describe Raml::Documentation do
+
+  describe '#title' do
+    let(:documentation) { Raml::Documentation.new }
+    before { documentation.title = 'the title' }
+    subject { documentation.title }
+    it { should == 'the title' }
+  end
+
+  describe '#content' do
+    let(:documentation) { Raml::Documentation.new }
+    before { documentation.content = 'the content' }
+    subject { documentation.content }
+    it { should == 'the content' }
+  end
+
+end

data/spec/lib/raml/method_spec.rb

@@ -0,0 +1,17 @@
+require 'raml/method'
+
+describe Raml::Method do
+
+  describe '.new' do
+    subject { Raml::Method.new('delete') }
+    its(:method) { should == 'delete' }
+  end
+
+  describe '#title' do
+    let(:documentation) { Raml::Documentation.new }
+    before { documentation.title = 'the title' }
+    subject { documentation.title }
+    it { should == 'the title' }
+  end
+
+end

data/spec/lib/raml/parser/body_spec.rb

@@ -0,0 +1,21 @@
+require 'raml/parser/body'
+
+describe Raml::Parser::Body do
+  let(:instance) { Raml::Parser::Body.new }
+  let(:type) { 'application/json' }
+  let(:attribute) { { 'schema' => 'dogs' } }
+
+  describe '#parse' do
+    subject { instance.parse(type, attribute) }
+
+    it { should be_kind_of Raml::Body }
+    its(:schema) { should == 'dogs' }
+  end
+
+  describe '#body' do
+    before { instance.parse(type, attribute) }
+    subject { instance.body }
+    it { should be_kind_of Raml::Body }
+  end
+
+end

data/spec/lib/raml/parser/documentation_spec.rb

@@ -0,0 +1,15 @@
+require 'raml/parser/documentation'
+
+describe Raml::Parser::Documentation do
+
+  describe '#parse' do
+    let(:attribute) { { 'title' => 'The title', 'content' => 'The content' } }
+    let(:trait_names) { nil }
+    subject { Raml::Parser::Documentation.new.parse(attribute) }
+
+    it { should be_kind_of Raml::Documentation }
+    its(:title) { should == 'The title' }
+    its(:content) { should == 'The content' }
+  end
+
+end

data/spec/lib/raml/parser/method_spec.rb

@@ -0,0 +1,35 @@
+require 'raml/parser/method'
+
+describe Raml::Parser::Method do
+
+  describe '#parse' do
+    let(:attributes) { { 'description' => 'The description', 'headers' => [{ 'key' => 'value' }], 'responses' => ['cats'], 'query_parameters' => ['dogs'] } }
+    let(:parent) { double(traits: { 'cats' => { 'description' => 'Trait description', 'headers' => { 'trait_key' => 'trait_value' } } }, trait_names: nil) }
+    before do
+      Raml::Parser::Response.any_instance.stub(:parse).and_return('cats')
+      Raml::Parser::QueryParameter.any_instance.stub(:parse).and_return('dogs')
+    end
+    subject { Raml::Parser::Method.new(parent).parse('get', attributes) }
+
+    it { should be_kind_of Raml::Method }
+    its(:method) { should == 'get' }
+    its(:description) { should == 'The description' }
+    its(:headers) { should == [ { 'key' => 'value' } ] }
+    its(:responses) { should == ['cats'] }
+    its(:query_parameters) { should == ['dogs'] }
+
+    context 'with trait' do
+      let(:attributes) { { 'is' => [ 'cats' ], 'responses' => ['cats'], 'query_parameters' => ['dogs'] } }
+      its(:description) { should == 'Trait description' }
+      its(:headers) { [ { 'trait_key' => 'trait_value' } ] }
+    end
+
+    context 'override trait attributes' do
+      let(:attributes) { { 'is' => [ 'cats' ], 'description' => 'The description', 'headers' => [{ 'key' => 'value' }], 'responses' => ['cats'], 'query_parameters' => ['dogs'] } }
+      its(:description) { should == 'The description' }
+      its(:headers) { should == [ { 'key' => 'value' } ] }
+    end
+
+  end
+
+end

data/spec/lib/raml/parser/query_parameter_spec.rb

@@ -0,0 +1,23 @@
+require 'raml/parser/query_parameter'
+
+describe Raml::Parser::QueryParameter do
+  let(:instance) { Raml::Parser::QueryParameter.new }
+  let(:type) { 'application/json' }
+  let(:attribute) { { 'description' => 'dogs', 'type' => 'cats', 'example' => 'birds' } }
+
+  describe '#parse' do
+    subject { instance.parse(type, attribute) }
+
+    it { should be_kind_of Raml::QueryParameter }
+    its(:description) { should == 'dogs' }
+    its(:type) { should == 'cats' }
+    its(:example) { should == 'birds' }
+  end
+
+  describe '#query_parameter' do
+    before { instance.parse(type, attribute) }
+    subject { instance.query_parameter }
+    it { should be_kind_of Raml::QueryParameter }
+  end
+
+end

data/spec/lib/raml/parser/resource_spec.rb

@@ -0,0 +1,49 @@
+require 'raml/parser/resource'
+
+describe Raml::Parser::Resource do
+
+  let(:parent) { double(resource_types: { 'cats' => { 'post' => {} } }) }
+  let(:resources) { double('<<'.to_sym => nil) }
+  let(:parent_node) { double(resources: resources) }
+  let(:instance) { Raml::Parser::Resource.new(parent) }
+  let(:uri_partial) { '/cats' }
+  let(:attributes) { { } }
+
+  describe '#parse' do
+    subject { instance.parse(parent_node, uri_partial, attributes) }
+    it { should be_kind_of Raml::Resource }
+
+    context 'resource' do
+      before { subject }
+      let(:attributes) { { '/bar' => {} } }
+      it 'should create a method' do
+        resources.should have_received('<<').with(kind_of(Raml::Resource))
+      end
+    end
+
+    %w[get put post delete].each do |method|
+      context method do
+        let(:attributes) { { method => 'method attributess' } }
+        it 'should call through to method parser' do
+          expect_any_instance_of(Raml::Parser::Method).to receive(:parse).with(method, 'method attributess').once
+          instance.parse(parent_node, uri_partial, attributes)
+        end
+      end
+    end
+
+    context 'resource type' do
+      let(:attributes) { { 'type' => 'cats' } }
+      it 'should call through to method parser' do
+        expect_any_instance_of(Raml::Parser::Method).to receive(:parse).with('post', {}).once
+        instance.parse(parent_node, uri_partial, attributes)
+      end
+    end
+  end
+
+  describe '#resource' do
+    before { instance.parse(parent_node, uri_partial, attributes) }
+    subject { instance.resource }
+    it { should be_kind_of Raml::Resource }
+  end
+
+end

data/spec/lib/raml/parser/response_spec.rb

@@ -0,0 +1,30 @@
+require 'raml/parser/response'
+
+describe Raml::Parser::Response do
+  let(:instance) { Raml::Parser::Response.new }
+  let(:code) { 201 }
+  let(:attribute) { { 'body' => { 'cats' => {} } } }
+
+  describe '#parse' do
+    subject { instance.parse(code, attribute) }
+
+    before do
+      Raml::Parser::Body.any_instance.stub(:parse)
+    end
+
+    it { should be_kind_of Raml::Response }
+    its(:code) { should == 201 }
+    it 'should call through to body' do
+      expect_any_instance_of(Raml::Parser::Body).to receive(:parse).with('cats', {}).once
+      subject
+    end
+  end
+
+  describe '#response' do
+    before { instance.parse(code, attribute) }
+    subject { instance.response }
+    it { should be_kind_of Raml::Response }
+  end
+
+end
+

data/spec/lib/raml/parser/root_spec.rb

@@ -0,0 +1,35 @@
+require 'raml/parser/root'
+require 'yaml'
+
+describe Raml::Parser::Root do
+
+  describe '#parse' do
+    let(:raml) { YAML.load File.read('spec/fixtures/basic.raml') }
+    subject { Raml::Parser::Root.new.parse(raml) }
+
+    it { should be_kind_of Raml::Root }
+    its(:base_uri) { should == 'http://example.api.com/{version}' }
+    its(:uri) { should == 'http://example.api.com/v1' }
+    its(:version) { should == 'v1' }
+    its('resources.count') { should == 2 }
+    its('resources.first.methods.count') { should == 2 }
+    its('resources.first.methods.first.responses.count') { should == 1 }
+    its('resources.first.methods.first.query_parameters.count') { should == 0 }
+    its('documentation.count') { should == 0 }
+
+    context 'trait-inherited attributes' do
+      subject { Raml::Parser::Root.new.parse(raml).resources.fetch(1).methods.first.query_parameters.first }
+      its(:name) { should == 'pages' }
+      its(:description) { should == 'The number of pages to return' }
+      its(:type) { should == 'number' }
+    end
+
+    context 'non trait-inherited attributes' do
+      subject { Raml::Parser::Root.new.parse(raml).resources.fetch(1).methods.first.query_parameters.last }
+      its(:name) { should == 'genre' }
+      its(:description) { should == 'filter the songs by genre' }
+      its(:type) { should == nil }
+    end
+  end
+
+end

data/spec/lib/raml/parser.rb

@@ -0,0 +1,49 @@
+require 'raml/parser'
+require 'yaml'
+
+describe Raml::Parser do
+
+  describe '#parse' do
+    let(:raml) { File.read('spec/fixtures/basic.raml') }
+    before do
+      subject.stub(:parse)
+      Raml::Parser.new.parse(raml)
+    end
+    subject { Raml::Parser::Root.any_instance }
+
+    it { should have_received(:stub).with(YAML.load(raml)) }
+  end
+
+  describe '.parse' do
+    let(:raml) { File.read('spec/fixtures/basic.raml') }
+    before do
+      subject.stub(:parse)
+      Raml::Parser.parse(raml)
+    end
+    subject { Raml::Parser.any_instance }
+
+    it { should have_received(:parse).with(raml) }
+  end
+
+  describe '.parse_file' do
+    let(:raml) { File.read('spec/fixtures/basic.raml') }
+    before do
+      subject.stub(:parse)
+      Raml::Parser.parse_file('spec/fixtures/basic.raml')
+    end
+    subject { Raml::Parser.any_instance }
+
+    it { should have_received(:parse).with(raml) }
+  end
+
+  describe '.parse_file' do
+    before do
+      subject.stub(:parse_file)
+      Raml::Parser.parse_file('path/to/file.raml')
+    end
+    subject { Raml::Parser.any_instance }
+
+    it { should have_received(:parse_file).with('path/to/file.raml') }
+  end
+
+end

data/spec/lib/raml/query_parameter_spec.rb

@@ -0,0 +1,40 @@
+require 'raml/query_parameter'
+
+describe Raml::QueryParameter do
+
+  describe '.new' do
+    let(:query_parameter) { Raml::QueryParameter.new('name') }
+    subject { query_parameter.name }
+    it { should == 'name' }
+  end
+
+  describe '#name' do
+    let(:query_parameter) { Raml::QueryParameter.new('name') }
+    before { query_parameter.name = 'the name' }
+    subject { query_parameter.name }
+    it { should == 'the name' }
+  end
+
+  describe '#description' do
+    let(:query_parameter) { Raml::QueryParameter.new('name') }
+    before { query_parameter.description = 'the description' }
+    subject { query_parameter.description }
+    it { should == 'the description' }
+  end
+
+  describe '#type' do
+    let(:query_parameter) { Raml::QueryParameter.new('name') }
+    before { query_parameter.type = 'the type' }
+    subject { query_parameter.type }
+    it { should == 'the type' }
+  end
+
+  describe '#example' do
+    let(:query_parameter) { Raml::QueryParameter.new('name') }
+    before { query_parameter.example = 'the example' }
+    subject { query_parameter.example }
+    it { should == 'the example' }
+  end
+
+end
+

data/spec/lib/raml/resource_spec.rb

@@ -0,0 +1,36 @@
+require 'raml/resource'
+
+describe Raml::Resource do
+
+  describe '.new' do
+    let(:parent) { double(uri: 'http://www.example.com') }
+    subject { Raml::Resource.new(parent, '/cats') }
+    its(:parent) { should == parent }
+    its(:uri_partial) { should == '/cats' }
+    its(:methods) { should == [] }
+  end
+
+  describe '#uri' do
+    let(:parent) { double(uri: 'http://www.example.com') }
+    let(:uri_partial) { '/cats' }
+    subject { Raml::Resource.new(parent, uri_partial).uri }
+    it { should == 'http://www.example.com/cats' }
+
+    context 'partial no slash' do
+      let(:uri_partial) { 'cats' }
+      it { should == 'http://www.example.com/cats' }
+    end
+
+    context 'base trailing slash' do
+      let(:parent) { double(uri: 'http://www.example.com') }
+      it { should == 'http://www.example.com/cats' }
+
+      context 'partial no slash' do
+        let(:uri_partial) { 'cats' }
+        it { should == 'http://www.example.com/cats' }
+      end
+    end
+  end
+
+end
+

data/spec/lib/raml/response_spec.rb

@@ -0,0 +1,25 @@
+require 'raml/response'
+
+describe Raml::Response do
+
+  describe '.new' do
+    subject { Raml::Response.new(201) }
+    its(:code) { should == 201 }
+    its(:bodies) { should == [] }
+  end
+
+  describe '#code' do
+    let(:response) { Raml::Response.new(201) }
+    before { response.code = 'the code' }
+    subject { response.code }
+    it { should == 'the code' }
+  end
+
+  describe '#bodies' do
+    let(:response) { Raml::Response.new(201) }
+    before { response.bodies = 'the bodies' }
+    subject { response.bodies }
+    it { should == 'the bodies' }
+  end
+
+end

data/spec/lib/raml/root_spec.rb

@@ -0,0 +1,36 @@
+require 'raml/root'
+
+describe Raml::Root do
+
+  describe '#resources' do
+    subject { Raml::Root.new.resources }
+    it { should be_kind_of Array }
+  end
+
+  describe '#documentation' do
+    subject { Raml::Root.new.documentation }
+    it { should be_kind_of Array }
+  end
+
+  describe '#uri' do
+    let(:root) { Raml::Root.new }
+    before { root.base_uri = 'http://example.com' }
+    subject { root.uri }
+    it { should == 'http://example.com' }
+  end
+
+  describe '#title' do
+    let(:root) { Raml::Root.new }
+    before { root.title = 'My RAML' }
+    subject { root.title }
+    it { should == 'My RAML' }
+  end
+
+  describe '#version' do
+    let(:root) { Raml::Root.new }
+    before { root.version = '1.0' }
+    subject { root.version }
+    it { should == '1.0' }
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'rspec/its'
+
+RSpec.configure do |config|
+
+  config.expect_with :rspec do |expectations|
+    expectations.syntax = [:should, :expect]
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.syntax = [:expect, :should]
+    mocks.verify_partial_doubles = true
+  end
+
+end