raml_ruby 0.1.1

data/test/raml/schema_spec.rb

@@ -0,0 +1,110 @@
+require_relative 'spec_helper'
+
+describe Raml::Schema do
+  let(:root_data) { {'title' => 'x', 'baseUri' => 'http://foo.com'} }
+  let(:root) { Raml::Root.new root_data }
+  subject { Raml::Schema.new 'MySchema', schema, root }
+  
+  describe '#new' do
+    context 'with a valid schema' do
+      context 'with a JSON Schema' do
+        let(:schema) do 
+          %q|
+            {
+              "$schema": "http://json-schema.org/draft-03/schema#",
+              "properties": {
+                  "input": {
+                      "required": false,
+                      "type": "string"
+                  }
+              },
+              "required": false,
+              "type": "object"
+            }
+          |
+        end
+
+        it { expect { subject }.to_not raise_error }
+        it { subject.should be_json_schema }
+        it { subject.should_not be_xml_schema }
+        it 'stores the schema in value' do
+          subject.value.should == schema
+        end
+        it 'stores the name in name' do
+          subject.name.should == 'MySchema'
+        end
+      end
+      context 'with a XML Schema' do
+        let(:schema) do 
+          %q|
+            <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="input"/>
+                  </xs:sequence>
+                </xs:complexType>
+              </xs:element>
+          </xs:schema>
+          |
+        end
+
+        it { expect { subject }.to_not raise_error }
+        it { subject.should_not be_json_schema }
+        it { subject.should be_xml_schema }
+      end
+      context 'with a schema that is neither JSON Schema or XML Schema' do
+        # A RELAX NG compact XML schema
+        let(:schema) do 
+          %q!
+            # A library patron example
+            default namespace = "http://some.other.url/ns"
+            namespace foo = "http://home.of.foo/ns"
+            datatypes xsd = "http://www.w3.org/2001/XMLSchema-datatypes"
+            ## Annotation here
+            element patron {
+              element name { xsd:string { pattern = "\w{,10}" } }
+              & element id-num { xsd:string }
+              & element book {
+                  ( attribute isbn { text }
+                  | attribute title { text }
+                  | attribute anonymous { empty })
+                }*
+            }
+          !
+        end
+
+        it { expect { subject }.to_not raise_error }
+        it { subject.should_not be_json_schema }
+        it { subject.should_not be_xml_schema }
+      end
+    end
+    context 'with an invalid schema' do
+      context 'with a malformed JSON schema' do
+        let(:schema) do 
+          %q|
+              "$schema": "http://json-schema.org/draft-04/schema#",
+              "multipleOf" : "xxx"
+            }
+          |
+        end
+
+        it { expect { subject }.to raise_error Raml::InvalidSchema }
+      end
+      context 'with an invalid JSON schema' do
+        let(:schema) do 
+          %q|
+            {
+              "$schema": "http://json-schema.org/draft-04/schema#",
+              "multipleOf" : "xxx"
+            }
+          |
+        end
+
+        it { expect { subject }.to raise_error Raml::InvalidSchema }
+      end
+    end
+  end
+end

data/test/raml/spec_helper.rb

@@ -0,0 +1,11 @@
+require_relative '../../lib/raml'
+require 'pry'
+require 'yaml'
+
+RSpec.configure do |config|
+ 	config.expect_with :rspec do |c|
+    c.syntax = [:should, :expect]
+  end
+  config.mock_framework = :rr
+end
+

data/test/raml/template_spec.rb

@@ -0,0 +1,98 @@
+require_relative 'spec_helper'
+
+describe Raml::Template do
+  let(:root) { Raml::Root.new 'title' => 'x', 'baseUri' => 'http://foo.com' }
+
+	describe '#new' do
+	end
+
+	describe '#interpolate' do
+		subject { Raml::Template.new('foo', data, root).interpolate params }
+		context 'when the data requires no parameters' do
+			let(:params) { {} }
+			context 'when its a shallow object' do
+				let(:data  ) { {'aaa' => 'bbb', 'ccc' => 'ddd', 'eee' => 'fff' } }
+				it 'returns the same data that was inputted' do
+					subject[1].should eq data
+				end
+			end
+			context 'when its a nested object' do
+			let(:data  ) { {'aaa' => 'bbb', 'ccc' => [ 'ddd', 'eee' ], 'fff' => { 'ggg' => 'hhh', 'iii' => ['jjj'] } } }
+				it 'returns the same data that was inputted' do
+					subject[1].should eq data
+				end
+			end
+		end
+		context 'when the data requires parameters' do
+			context 'when its a shallow object' do
+				let(:data  ) { {'aaa <<foo>>' => 'bbb', 'ccc' => '<<bar>> ddd', 'eee' => 'fff' } }
+				context 'when a required parameter is missing' do
+					let(:params) { { 'foo' => 'bar' } }
+					it do
+						expect { subject }.to raise_exception Raml::UnknownTypeOrTraitParameter
+					end
+				end
+				context 'when all parameters are given' do
+					let(:params) { { 'foo' => 'bar', 'bar' => 'baz' } }
+					it 'returns the name with the parameter interpolated' do
+						subject[1].should eq ({'aaa bar' => 'bbb', 'ccc' => 'baz ddd', 'eee' => 'fff' })
+					end
+				end
+			end
+			context 'when its a nested object' do
+			let(:data  ) { {'aaa <<foo>>' => 'bbb', 'ccc' => [ '<<bar>> ddd', 'eee' ], 'fff' => { 'ggg' => 'hhh', '<<baz>> iii' => ['<<jaz>> jjj'] } } }
+				context 'when a required parameter is missing' do
+					let(:params) { { 'foo' => 'bar' } }
+					it do
+						expect { subject }.to raise_exception Raml::UnknownTypeOrTraitParameter
+					end
+				end
+				context 'when all parameters are given' do
+					let(:params) { { 'foo' => 'bar', 'bar' => 'baz', 'baz' => 'jaz', 'jaz' => 'max' } }
+					it 'returns the name with the parameter interpolated' do
+						subject[1].should eq ({'aaa bar' => 'bbb', 'ccc' => [ 'baz ddd', 'eee' ], 'fff' => { 'ggg' => 'hhh', 'jaz iii' => ['max jjj'] } })
+					end
+				end
+			end
+		end
+		context 'when function parameters are used' do
+			context 'when the function is not known' do
+				let(:params) { {'some_param' => 'test'} }
+				let(:data  ) { {'bar' => '<<some_param | !unknown>>'} }
+				it do
+					expect { subject }.to raise_exception Raml::UnknownTypeOrTraitParamFunction
+				end
+			end
+			context 'when the function is singularize' do
+				let(:data) { {'bar' => 'some <<some_param | !singularize>>'} }
+				context 'when the parameter is plural' do
+					let(:params) { {'some_param' => 'tests'} }
+					it 'signularizes it' do
+						subject[1]['bar'].should eq  'some test'
+					end
+				end
+				context 'when the parameter is singular' do
+					let(:params) { {'some_param' => 'test'} }
+					it 'keeps it singular' do
+						subject[1]['bar'].should eq  'some test'
+					end
+				end
+			end
+			context 'when the function is pluralize' do
+				let(:data) { {'bar' => 'some <<some_param | !pluralize>>'} }
+				context 'when the parameter is singular' do
+					let(:params) { {'some_param' => 'test'} }
+					it 'pluralizes it' do
+						subject[1]['bar'].should eq  'some tests'
+					end
+				end
+				context 'when the parameter is plural' do
+					let(:params) { {'some_param' => 'tests'} }
+					it 'keeps it plural' do
+						subject[1]['bar'].should eq  'some tests'
+					end
+				end
+			end
+		end
+	end
+end

data/test/raml/trait_spec.rb

@@ -0,0 +1,31 @@
+require_relative 'spec_helper'
+
+describe Raml::Trait do
+	let(:name) { 'secured' }
+  let(:data) {
+    YAML.load(%q(
+      usage: Apply this to any method that needs to be secured
+      description: Some requests require authentication.
+      queryParameters:
+        access_token:
+          description: Access Token
+          type: string
+          example: ACCESS_TOKEN
+          required: true
+    ))
+  }
+  let(:root) { Raml::Root.new 'title' => 'x', 'baseUri' => 'http://foo.com' }
+
+  subject { Raml::Trait.new name, data, root }
+
+  describe '#new' do
+  	context 'when the trait name is not an HTTP method name' do
+      it { expect { subject }.to_not raise_error }
+    end
+    context 'when the usage property is given' do
+	    it 'stores the usage property' do
+	    	subject.instantiate({}).usage.should eq data['usage']
+	    end
+	  end
+  end
+end

metadata

@@ -0,0 +1,337 @@
+--- !ruby/object:Gem::Specification
+name: raml_ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Kirill Gorin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: json-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: rouge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: sass
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: slim
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: uri_template
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !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: rr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: Implementation of RAML parser in Ruby.
+email:
+- me@kgor.in
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fixtures/include_1.raml
+- fixtures/schemas/canonicalSchemas.raml
+- fixtures/schemas/filesystem/file.json
+- fixtures/schemas/filesystem/files.json
+- fixtures/schemas/filesystem/fileupdate.json
+- fixtures/schemas/filesystem/relative/test.json
+- lib/raml.rb
+- lib/raml/exceptions.rb
+- lib/raml/mixin/bodies.rb
+- lib/raml/mixin/documentable.rb
+- lib/raml/mixin/global.rb
+- lib/raml/mixin/headers.rb
+- lib/raml/mixin/merge.rb
+- lib/raml/mixin/parent.rb
+- lib/raml/mixin/validation.rb
+- lib/raml/node.rb
+- lib/raml/node/abstract_method.rb
+- lib/raml/node/abstract_resource.rb
+- lib/raml/node/abstract_resource_circular.rb
+- lib/raml/node/body.rb
+- lib/raml/node/documentation.rb
+- lib/raml/node/header.rb
+- lib/raml/node/method.rb
+- lib/raml/node/parameter/abstract_parameter.rb
+- lib/raml/node/parameter/base_uri_parameter.rb
+- lib/raml/node/parameter/form_parameter.rb
+- lib/raml/node/parameter/query_parameter.rb
+- lib/raml/node/parameter/uri_parameter.rb
+- lib/raml/node/parametized_reference.rb
+- lib/raml/node/reference.rb
+- lib/raml/node/resource.rb
+- lib/raml/node/resource_type.rb
+- lib/raml/node/resource_type_reference.rb
+- lib/raml/node/response.rb
+- lib/raml/node/root.rb
+- lib/raml/node/schema.rb
+- lib/raml/node/schema_reference.rb
+- lib/raml/node/template.rb
+- lib/raml/node/trait.rb
+- lib/raml/node/trait_reference.rb
+- lib/raml/parser.rb
+- lib/raml/parser/include.rb
+- lib/raml/patch/hash.rb
+- lib/raml/patch/module.rb
+- lib/raml/version.rb
+- raml_ruby.gemspec
+- raml_spec_reqs.md
+- templates/abstract_parameter.slim
+- templates/body.slim
+- templates/collapse.slim
+- templates/documentation.slim
+- templates/method.slim
+- templates/resource.slim
+- templates/response.slim
+- templates/root.slim
+- templates/style.sass
+- test/apis/box-api.raml
+- test/apis/instagram-api.raml
+- test/apis/stripe-api.raml
+- test/apis/twilio-rest-api.raml
+- test/apis/twitter-rest-api.raml
+- test/raml/body_spec.rb
+- test/raml/documentation_spec.rb
+- test/raml/header_spec.rb
+- test/raml/include_spec.rb
+- test/raml/method_spec.rb
+- test/raml/parameter/abstract_parameter_spec.rb
+- test/raml/parameter/form_parameter_spec.rb
+- test/raml/parameter/query_parameter_spec.rb
+- test/raml/parameter/uri_parameter_spec.rb
+- test/raml/parser_spec.rb
+- test/raml/raml_spec.rb
+- test/raml/resource_spec.rb
+- test/raml/resource_type_spec.rb
+- test/raml/response_spec.rb
+- test/raml/root_spec.rb
+- test/raml/schema_spec.rb
+- test/raml/spec_helper.rb
+- test/raml/template_spec.rb
+- test/raml/trait_spec.rb
+homepage: https://github.com/coub/raml_ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: raml_ruby is implementation of RAML parser in Ruby.
+test_files:
+- test/apis/box-api.raml
+- test/apis/instagram-api.raml
+- test/apis/stripe-api.raml
+- test/apis/twilio-rest-api.raml
+- test/apis/twitter-rest-api.raml
+- test/raml/body_spec.rb
+- test/raml/documentation_spec.rb
+- test/raml/header_spec.rb
+- test/raml/include_spec.rb
+- test/raml/method_spec.rb
+- test/raml/parameter/abstract_parameter_spec.rb
+- test/raml/parameter/form_parameter_spec.rb
+- test/raml/parameter/query_parameter_spec.rb
+- test/raml/parameter/uri_parameter_spec.rb
+- test/raml/parser_spec.rb
+- test/raml/raml_spec.rb
+- test/raml/resource_spec.rb
+- test/raml/resource_type_spec.rb
+- test/raml/response_spec.rb
+- test/raml/root_spec.rb
+- test/raml/schema_spec.rb
+- test/raml/spec_helper.rb
+- test/raml/template_spec.rb
+- test/raml/trait_spec.rb
+has_rdoc: