raml-rb 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: df2e4d4523124e124d26a17682ad25e97bafeb1f
-  data.tar.gz: 57fecb9fa9a2195963b4918381da41699cb4ccaf
+  metadata.gz: 59af9e03788a3d397e64ae1975dbf11dd6d1e42a
+  data.tar.gz: 321d4c32b2e3c7d8bd5a811cdf210f09f35f36c3
 SHA512:
-  metadata.gz: b2138442d6609232fa226ec002f5143a404ab3c023252eeec71dbc6e58e9695f2bd848577a90362b42e3dbeebbb92b7c578e6d5c694812f00a4ef67edee2bc2b
-  data.tar.gz: 958813a38ecd31dad8d8c6dd588dfa1af9b907d9504346d693769d953cbe6edcf8b02fefa98759b4d2a9ec10efaa8760ddfafee223ff7dbea57d89690c030d78
+  metadata.gz: 8afd602fbcf8746a9b6a4c1d45b82e69e684c89cc97d96f24582afb31815afa21cc7a6ae6e3c7bd9f3d4d70e419f58895f16243dc0b6bd435262049878db85eb
+  data.tar.gz: 2166e49473d3841821eff209b4cd0c34dd6f05e144cd4d6c8677c7813265b4e443f8a10bbb620c966479d7379fb25f65a57274454723554244b480021e495295

data/.gitignore

@@ -20,3 +20,4 @@ tmp
 *.o
 *.a
 mkmf.log
+.byebug_history

data/.travis.yml

@@ -4,7 +4,8 @@ rvm:
   - 2.0.0
   - 2.1.8
   - 2.2.0
-  - 2.3.0
+  - 2.3.3
+  - 2.4.0
 branches:
   only:
     - master

data/Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in raml-rb.gemspec
 gemspec
+
+gem "byebug"

data/lib/raml/body.rb

@@ -1,6 +1,6 @@
 module Raml
   class Body
-    attr_accessor :content_type, :schema, :example
+    attr_accessor :content_type, :schema, :example, :type
 
     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 example]
+      BASIC_ATTRIBUTES = %w[schema example type]
 
       attr_accessor :body, :attributes
 

data/lib/raml/parser/resource.rb

@@ -41,6 +41,8 @@ module Raml
               resource.http_methods << Raml::Parser::Method.new(self).parse(key, value)
             when 'is'
               @trait_names = value
+            when 'uri_parameters'
+              @uri_parameters = value
             else
               raise UnknownAttributeError.new "Unknown resource key: #{key}"
             end

data/lib/raml/parser/root.rb

@@ -9,7 +9,7 @@ module Raml
     class Root
       include Raml::Parser::Util
 
-      BASIC_ATTRIBUTES = %w[title base_uri version base_uri_parameters media_type secured_by security_schemes]
+      BASIC_ATTRIBUTES = %w[title base_uri version base_uri_parameters media_type secured_by security_schemes types schemas]
 
       attr_accessor :root, :traits, :resource_types, :attributes
 
@@ -49,7 +49,7 @@ module Raml
 
         def parse_documentation(documentations)
           documentations.each do |documentation_attributes|
-            root.documentations << Raml::Parser::Documentation.new.parse(documentation_attributes)
+            root.documentation << Raml::Parser::Documentation.new.parse(documentation_attributes)
           end
         end
 
@@ -68,7 +68,6 @@ module Raml
             end
           end
         end
-
     end
   end
 end

data/lib/raml/root.rb

@@ -1,7 +1,8 @@
 module Raml
   class Root
-    attr_accessor :title, :base_uri, :version, :resources, :documentation,
-                  :base_uri_parameters, :media_type, :security_schemes, :secured_by
+    attr_accessor :title, :base_uri, :version, :resources, :documentation, :types,
+                  :base_uri_parameters, :media_type, :security_schemes, :secured_by,
+                  :schemas
 
     def initialize
       @resources = []

data/lib/raml/version.rb

@@ -1,3 +1,3 @@
 module Raml
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/raml-rb.gemspec

@@ -21,5 +21,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake',       '~>10.3'
   spec.add_development_dependency 'rspec',      '~> 3.0'
   spec.add_development_dependency 'rspec-its',  '~> 1.0'
-  spec.add_development_dependency 'coveralls', '~> 0.8'
+  spec.add_development_dependency 'coveralls',  '~> 0.8'
 end

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

@@ -37,6 +37,9 @@ traits:
         description: filter the songs by genre
   post:
   /{songId}:
+    uriParameters:
+      songId:
+        type: integer
     get:
       responses:
         200:

data/spec/fixtures/basic.raml

@@ -24,17 +24,19 @@ traits:
         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 ]
+  is: [ paged ]
   get:
     queryParameters:
       genre:
         description: filter the songs by genre
   post:
   /{songId}:
+    uriParameters:
+      songId:
+        type: integer
     get:
       responses:
         200:

data/spec/fixtures/basic_raml_with_schemas.raml

@@ -0,0 +1,50 @@
+#%RAML 0.8
+---
+title: e-BookMobile API
+baseUri: http://api.e-bookmobile.com/{version}
+version: 1.2
+
+schemas:
+  Author: |
+    {
+      "$schema": "http://json-schema.org/schema",
+      "type": "object",
+      "description: "An author",
+      "properties": {
+        "id": { "type": "integer" },
+        "first_name": { "type": "string" },
+        "last_name": { "type": "string" },
+        "year_of_birth": {
+          "type": "integer",
+          "maxValue": 2017
+        }
+      },
+      "required": [ "first_name", "last_name" ]
+    }
+  Authors: |
+    {
+      "$schema": "http://json-schema.org/schema",
+      "type": "array",
+      "description": "A list of authors",
+      "items": {
+        "type": "object",
+        "properties": {
+          "id": { "type": "integer" },
+          "first_name": { "type": "string" },
+          "last_name": { "type": "string" },
+          "year_of_birth": {
+            "type": "integer",
+            "maxValue": 2017
+          }
+        }
+      }
+    }
+
+/authors:
+  post:
+    description: Add a new author to the system
+    responses:
+      204:
+        body:
+          application/json:
+            schema: Authors

data/spec/fixtures/basic_raml_with_types.raml

@@ -0,0 +1,33 @@
+#%RAML 1.0
+---
+title: e-BookMobile API
+baseUri: http://api.e-bookmobile.com/{version}
+version: v1
+
+types:
+  Author:
+    type: object
+    properties:
+      id: integer
+      first_name:
+        required: true
+        type: string
+      last_name:
+        required: true
+        type: string
+      year_of_birth:
+        required: false
+        type: integer
+        maximum: 2017
+    additionalProperties: false
+  Authors:
+    type: Author[]
+
+/authors:
+  post:
+    description: Add a new author to the system
+    responses:
+      204:
+        body:
+          application/json:
+            type: Authors

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

@@ -38,6 +38,39 @@ describe Raml::Parser::Root do
       its(:description) { should == 'filter the songs by genre' }
       its(:type) { should == nil }
     end
-  end
 
+    context 'using RAML types' do
+      let(:raml) { YAML.load File.read('spec/fixtures/basic_raml_with_types.raml') }
+      subject { Raml::Parser::Root.new.parse(raml) }
+
+      it { is_expected.to be_kind_of Raml::Root }
+      its(:base_uri) { should == 'http://api.e-bookmobile.com/{version}' }
+      its(:uri) { should == 'http://api.e-bookmobile.com/v1' }
+      its(:version) { should == 'v1' }
+      its(:media_type) { should be_nil }
+      its('resources.count') { should == 1 }
+      its('resources.first.http_methods.count') { should == 1 }
+      its('resources.first.http_methods.first.responses.count') { should == 1 }
+      its('resources.first.http_methods.first.query_parameters.count') { should == 0 }
+      its('documentation.count') { should == 0 }
+      its('resources.first.http_methods.first.responses.first.bodies.first.type') { should == 'Authors' }
+    end
+
+    context 'using schemas' do
+      let(:raml) { YAML.load File.read('spec/fixtures/basic_raml_with_schemas.raml') }
+      subject { Raml::Parser::Root.new.parse(raml) }
+
+      it { is_expected.to be_kind_of Raml::Root }
+      its(:base_uri) { should == 'http://api.e-bookmobile.com/{version}' }
+      its(:uri) { should == 'http://api.e-bookmobile.com/1.2' }
+      its(:version) { should == 1.2 }
+      its(:media_type) { should be_nil }
+      its('resources.count') { should == 1 }
+      its('resources.first.http_methods.count') { should == 1 }
+      its('resources.first.http_methods.first.responses.count') { should == 1 }
+      its('resources.first.http_methods.first.query_parameters.count') { should == 0 }
+      its('documentation.count') { should == 0 }
+      its('resources.first.http_methods.first.responses.first.bodies.first.schema') { should == 'Authors' }
+    end
+  end
 end

data/spec/lib/raml/root_spec.rb

@@ -26,6 +26,13 @@ describe Raml::Root do
     it { is_expected.to eq('My RAML') }
   end
 
+  describe '#types' do
+    let(:root) { Raml::Root.new }
+    before { root.types = { "Foo" => { "bar" => "baz" } } }
+    subject { root.types }
+    it { is_expected.to eq({ "Foo" => { "bar" => "baz" } }) }
+  end
+
   describe '#version' do
     let(:root) { Raml::Root.new }
     before { root.version = '1.0' }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: raml-rb
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - James Brennan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-29 00:00:00.000000000 Z
+date: 2017-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -118,6 +118,8 @@ files:
 - raml-rb.gemspec
 - spec/fixtures/all-the-things.raml
 - spec/fixtures/basic.raml
+- spec/fixtures/basic_raml_with_schemas.raml
+- spec/fixtures/basic_raml_with_types.raml
 - spec/lib/core_ext/hash_spec.rb
 - spec/lib/raml/body_spec.rb
 - spec/lib/raml/documentation_spec.rb
@@ -162,6 +164,8 @@ summary: A RAML parser implemented in Ruby
 test_files:
 - spec/fixtures/all-the-things.raml
 - spec/fixtures/basic.raml
+- spec/fixtures/basic_raml_with_schemas.raml
+- spec/fixtures/basic_raml_with_types.raml
 - spec/lib/core_ext/hash_spec.rb
 - spec/lib/raml/body_spec.rb
 - spec/lib/raml/documentation_spec.rb