raml-rb 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f32149c287b8afb783fe1e9505634c1d913d0a5e
-  data.tar.gz: c4cff4f2e32605588cd5495eb72509cef3387b1c
+  metadata.gz: 4457c134a65fe34fe1f266e3e834542e4a9dbf8c
+  data.tar.gz: 4ae3a0f6701619e430215480b27d039278a2ecf5
 SHA512:
-  metadata.gz: c88c819e3af6f4b49c1e13cb9dac144f0be1f0c999bc6502638e7e2bc100088d1cc2fc40d66ae2850bb1c6163646ebbf32c41320bcf8da0cec9c4bbd1c7c9bbb
-  data.tar.gz: 77596856bd5b3383fb42e33761b2708d78bd634b7ea228f4c1940bd2e00e7a63b145c9cdbfeb0f66291030e08b7f8263ba9ffb8b82beaf78ff57ab3f8f2e2aec
+  metadata.gz: 32d69e8c922a5581370d890d0b0885817db1a7895763fb23b11f1af05d7040833fca8ec36c011c97201e0b601453afcb2d54348a7d7974cfb65adce043dfaa7e
+  data.tar.gz: 22b4f168b1d3af5fd2be83bb6e894384b92c637662ad2f7ec531946584b5b30062ed033c749016bdae29d7fbacce06081d6c756fd66c18330ce6edfc54658b15

data/lib/raml/body.rb

@@ -1,6 +1,6 @@
 module Raml
   class Body
-    attr_accessor :content_type, :schema
+    attr_accessor :content_type, :schema, :example
 
     def initialize(content_type)
       @content_type = content_type

data/lib/raml/parser/body.rb

@@ -7,7 +7,7 @@ module Raml
     class Body
       include Raml::Parser::Util
 
-      BASIC_ATTRIBUTES = %w[schema]
+      BASIC_ATTRIBUTES = %w[schema example]
 
       attr_accessor :body, :attributes
 

data/lib/raml/parser/query_parameter.rb

@@ -7,7 +7,7 @@ module Raml
     class QueryParameter
       include Raml::Parser::Util
 
-      BASIC_ATTRIBUTES = %w[description type example]
+      BASIC_ATTRIBUTES = %w[description type example required]
 
       attr_accessor :query_parameter, :attributes
 

data/lib/raml/parser/resource.rb

@@ -14,7 +14,6 @@ module Raml
       METHODS = %w[get put post delete]
 
       attr_accessor :parent_node, :resource, :trait_names, :attributes
-      def_delegators :@parent_node, :resources
       def_delegators :@parent, :traits, :resource_types
 
       def initialize(parent)
@@ -37,7 +36,7 @@ module Raml
             key = underscore(key)
             case key
             when /^\//
-              resources << Raml::Parser::Resource.new(self).parse(resource, key, value)
+              resource.resources << Raml::Parser::Resource.new(self).parse(resource, key, value)
             when *METHODS
               resource.methods << Raml::Parser::Method.new(self).parse(key, value)
             when 'is'

data/lib/raml/query_parameter.rb

@@ -1,9 +1,10 @@
 module Raml
   class QueryParameter
-    attr_accessor :name, :description, :type, :example
+    attr_accessor :name, :description, :type, :example, :required
 
     def initialize(name)
       @name = name
+      @required = false
     end
 
   end

data/lib/raml/resource.rb

@@ -1,11 +1,12 @@
 module Raml
   class Resource
-    attr_accessor :parent, :methods, :uri_partial
+    attr_accessor :parent, :methods, :uri_partial, :resources
 
     def initialize(parent, uri_partial)
       @parent = parent
       @uri_partial = uri_partial
       @methods = []
+      @resources = []
     end
 
     def path

data/lib/raml/version.rb

@@ -1,3 +1,3 @@
 module Raml
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

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

@@ -49,6 +49,8 @@ traits:
                   },
                   "required": [ "title", "artist" ]
                 }
+              example: |
+                {"artist":"Pink Floyd", "title":"Wish You Were Here"}
     delete:
       description: |
         This method will *delete* an **individual song**

data/spec/fixtures/basic.raml

@@ -35,6 +35,8 @@ traits:
                   },
                   "required": [ "title", "artist" ]
                 }
+              example: |
+                {"artist":"Pink Floyd", "title":"Wish You Were Here"}
             application/xml:
     delete:
       description: |

data/spec/lib/raml/body_spec.rb

@@ -21,4 +21,11 @@ describe Raml::Body do
     it { should == 'schema' }
   end
 
+  describe '#example' do
+    let(:body) { Raml::Body.new('the content_type') }
+    before { body.example = 'example' }
+    subject { body.example }
+    it { should == 'example' }
+  end
+
 end

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

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

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

@@ -4,6 +4,7 @@ describe Raml::Parser::Resource do
 
   let(:parent) { double(resource_types: { 'cats' => { 'post' => {} } }) }
   let(:resources) { double('<<'.to_sym => nil) }
+  let(:resource) { double('<<'.to_sym => nil, resources: resources) }
   let(:parent_node) { double(resources: resources) }
   let(:instance) { Raml::Parser::Resource.new(parent) }
   let(:uri_partial) { '/cats' }
@@ -14,10 +15,13 @@ describe Raml::Parser::Resource do
     it { should be_kind_of Raml::Resource }
 
     context 'resource' do
-      before { subject }
+      before do
+        allow(instance).to receive(:resource).and_return(resource)
+        subject
+      end
       let(:attributes) { { '/bar' => {} } }
       it 'should create a method' do
-        resources.should have_received('<<').with(kind_of(Raml::Resource))
+        resource.resources.should have_received('<<').with(kind_of(Raml::Resource))
       end
     end
 

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

@@ -11,21 +11,24 @@ describe Raml::Parser::Root do
     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.count') { should == 1 }
     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('resources.first.methods.first.responses.count') { should == 0 }
+    its('resources.first.methods.first.query_parameters.count') { should == 2 }
     its('documentation.count') { should == 0 }
+    its('resources.first.resources.first.methods.first.responses.first.bodies.first.example') do
+      should include '{"artist":"Pink Floyd", "title":"Wish You Were Here"}'
+    end
 
     context 'trait-inherited attributes' do
-      subject { Raml::Parser::Root.new.parse(raml).resources.fetch(1).methods.first.query_parameters.first }
+      subject { Raml::Parser::Root.new.parse(raml).resources.first.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 }
+      subject { Raml::Parser::Root.new.parse(raml).resources.first.methods.first.query_parameters.last }
       its(:name) { should == 'genre' }
       its(:description) { should == 'filter the songs by genre' }
       its(:type) { should == nil }

metadata

@@ -1,69 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: raml-rb
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - James Brennan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-20 00:00:00.000000000 Z
+date: 2014-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rspec-its
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
 description: 
@@ -73,8 +73,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
+- ".gitignore"
+- ".rspec"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -130,12 +130,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
@@ -164,4 +164,3 @@ test_files:
 - spec/lib/raml/response_spec.rb
 - spec/lib/raml/root_spec.rb
 - spec/spec_helper.rb
-has_rdoc: