raml_parser 0.1

data/spec/examples/raml/external/xml_example.xml

@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<job>
+  <id>1511685</id>
+        <expiration-timestamp>1304030488000</expiration-timestamp>
+        <company>
+                <id>229433</id>
+                <name>Cloudera</name>
+        </company>
+        <position>
+                <title>Technical Writer</title>
+                <location>
+                        <name>San Francisco Bay Area</name>
+                        <country>
+                                <code>us</code>
+                        </country>
+                </location>
+        </position>
+        <location-description>San Francisco or Palo Alto, CA</location-description>
+        <job-poster>
+                <id>hQ4ruu3J2q</id>
+                <first-name>Paul</first-name>
+                <last-name>Battaglia</last-name>
+                <headline>Technical Writer at Cloudera</headline>
+        </job-poster>
+</job>

data/spec/examples/raml/external/xml_schema.xsd

@@ -0,0 +1,50 @@
+<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">
+  <xs:element name="job">
+    <xs:complexType>
+      <xs:sequence>
+        <xs:element type="xs:int" name="id"/>
+        <xs:element type="xs:long" name="expiration-timestamp"/>
+        <xs:element name="company">
+          <xs:complexType>
+            <xs:sequence>
+              <xs:element type="xs:int" name="id"/>
+              <xs:element type="xs:string" name="name"/>
+            </xs:sequence>
+          </xs:complexType>
+        </xs:element>
+        <xs:element name="position">
+          <xs:complexType>
+            <xs:sequence>
+              <xs:element type="xs:string" name="title"/>
+              <xs:element name="location">
+                <xs:complexType>
+                  <xs:sequence>
+                    <xs:element type="xs:string" name="name"/>
+                    <xs:element name="country">
+                      <xs:complexType>
+                        <xs:sequence>
+                          <xs:element type="xs:string" name="code"/>
+                        </xs:sequence>
+                      </xs:complexType>
+                    </xs:element>
+                  </xs:sequence>
+                </xs:complexType>
+              </xs:element>
+            </xs:sequence>
+          </xs:complexType>
+        </xs:element>
+        <xs:element type="xs:string" name="location-description"/>
+        <xs:element name="job-poster">
+          <xs:complexType>
+            <xs:sequence>
+              <xs:element type="xs:string" name="id"/>
+              <xs:element type="xs:string" name="first-name"/>
+              <xs:element type="xs:string" name="last-name"/>
+              <xs:element type="xs:string" name="headline"/>
+            </xs:sequence>
+          </xs:complexType>
+        </xs:element>
+      </xs:sequence>
+    </xs:complexType>
+  </xs:element>
+</xs:schema>

data/spec/examples/raml/formparameters.raml

@@ -0,0 +1,23 @@
+#%RAML 0.8
+---
+title: Example API
+baseUri: http://localhost:3000
+version: v123
+/a:
+  post:
+    body:
+      application/x-www-form-urlencoded:
+        formParameters:
+          from:
+             description: FROM1
+          to:
+             description: TO1
+/b:
+  post:
+    body:
+      multipart/form-data:
+        formParameters:
+          from:
+             description: FROM2
+          to:
+             description: TO2

data/spec/examples/raml/headers.raml

@@ -0,0 +1,15 @@
+#%RAML 0.8
+---
+title: Example API
+baseUri: http://localhost:3000
+/a:
+  get:
+    headers:
+      X-Foobar-Ping:
+        description: Ping
+    responses:
+      200:
+        headers:
+          X-Foobar-Pong:
+            displayName: PingPong
+            description: Pong

data/spec/examples/raml/issue2.raml

@@ -0,0 +1,51 @@
+#%RAML 0.8
+---
+title: GitHub API
+baseUri: https://api.github.com
+version: v3
+traits:
+  - base:
+      responses:
+        404:
+          description: Not found
+          body:
+            application/json:
+              example: |
+                {
+                  "status_code": 404,
+                  "message": "Not found"
+                }
+        500:
+          description: Internal server error
+          body:
+            application/json:
+              example: |
+                {
+                  "status_code": 500,
+                  "message": "Internal server error"
+                }
+resourceTypes:
+  - collection:
+      post:
+        responses:
+          404:
+            description: Not found
+            body:
+              application/json:
+                example: |
+                  {
+                    "status_code": 404,
+                    "message": "Not found"
+                  }
+          500:
+            description: Internal server error
+            body:
+              application/json:
+                example: |
+                  {
+                    "status_code": 500,
+                    "message": "Internal server error"
+                  }
+/users/{username}:
+  type: collection
+  get:

data/spec/examples/raml/methods.raml

@@ -0,0 +1,9 @@
+#%RAML 0.8
+---
+title: Example API
+baseUri: http://localhost:3000
+/a:
+  get:
+  /b:
+    get:
+      displayName: This is /a/b

data/spec/examples/raml/parameters.raml

@@ -0,0 +1,21 @@
+#%RAML 0.8
+---
+title: Example API
+baseUri: http://localhost:3000
+traits:
+  - first:
+      description: <<resourcePath>> and <<resourcePathName>> and <<methodName>> and <<fooBar>>
+      queryParameters:
+        <<methodName>>:
+          description: Applepie
+resourceTypes:
+  - second:
+      description: <<resourcePath>> and <<resourcePathName>> and <<applePie>>
+/first:
+  get:
+    is: [ first: { fooBar: Hello } ]
+/second:
+  type: { second: { applePie: World } }
+/third:
+  /fourth:
+    type: { second: { applePie: Finish } }

data/spec/examples/raml/parametersinflection.raml

@@ -0,0 +1,21 @@
+#%RAML 0.8
+---
+title: Example API
+baseUri: http://localhost:3000
+traits:
+  - keep:
+      description: Keep <<resourcePathName>>
+  - sing:
+      description: Sing <<resourcePathName | !singularize>>
+  - plu:
+      description: Plu <<resourcePathName | !pluralize>>
+/userName:
+  get:
+    is: [ keep ]
+  post:
+    is: [ plu ]
+/passwords:
+  get:
+    is: [ keep ]
+  post:
+    is: [ sing ]

data/spec/examples/raml/queryparameters.raml

@@ -0,0 +1,14 @@
+#%RAML 0.8
+---
+title: Example API
+baseUri: http://localhost:3000
+/a:
+  get:
+    queryParameters:
+      q1:
+  /b:
+    get:
+      queryParameters:
+        q2:
+          displayName: This is the second query parameter
+          type: integer

data/spec/examples/raml/requestbodies.raml

@@ -0,0 +1,21 @@
+#%RAML 0.8
+---
+title: Example API
+baseUri: http://localhost:3000
+/first:
+  post:
+    body:
+      application/json:
+        example: |
+          {
+            "foo": "bar"
+          }
+      text/xml:
+  put:
+    body:
+      application/json:
+        example: |
+          {
+            "status": "not found",
+            "message: "Resource could not be found"
+          }

data/spec/examples/raml/resources.raml

@@ -0,0 +1,15 @@
+#%RAML 0.8
+---
+title: Example API
+baseUri: http://localhost:3000
+/first:
+  get:
+  /second:
+/third:
+  displayName: This is the third
+/with:
+  /{uri}:
+    /{params}:
+      uriParameters:
+        params:
+          displayName: This are the params

data/spec/examples/raml/resourcetypes.raml

@@ -0,0 +1,16 @@
+#%RAML 0.8
+---
+title: Example API
+baseUri: http://localhost:3000
+resourceTypes:
+  - collection:
+      description: A collection
+      get:
+        description: Get all items
+      post:
+        description: Create a new item
+/a:
+  type: collection
+  put:
+  post:
+    description: Overriden

data/spec/examples/raml/responses.raml

@@ -0,0 +1,25 @@
+#%RAML 0.8
+---
+title: Example API
+baseUri: http://localhost:3000
+/first:
+  get:
+    responses:
+      200:
+        displayName: The first
+        description: This is the first
+        body:
+          application/json:
+            example: |
+              {
+                "foo": "bar"
+              }
+          text/xml:
+      404:
+        body:
+          application/json:
+            example: |
+              {
+                "status": "not found",
+                "message: "Resource could not be found"
+              }

data/spec/examples/raml/securedby1.raml

@@ -0,0 +1,20 @@
+#%RAML 0.8
+---
+title: Example API
+baseUri: http://localhost:3000
+securitySchemes:
+  - oauth_1_0:
+      type: OAuth 1.0
+  - oauth_2_0:
+      type: OAuth 2.0
+/first:
+  get:
+    securedBy: [oauth_1_0]
+  post:
+    securedBy: [oauth_2_0]
+/second:
+  securedBy: [oauth_1_0]
+  get:
+    securedBy: [null, oauth_2_0]
+  post:
+    securedBy: [oauth_2_0]

data/spec/examples/raml/securedby2.raml

@@ -0,0 +1,21 @@
+#%RAML 0.8
+---
+title: Example API
+baseUri: http://localhost:3000
+securedBy: [oauth_2_0]
+securitySchemes:
+  - oauth_1_0:
+      type: OAuth 1.0
+  - oauth_2_0:
+      type: OAuth 2.0
+/first:
+  get:
+    securedBy: [oauth_1_0]
+  post:
+    securedBy: [oauth_2_0]
+/second:
+  securedBy: [oauth_1_0]
+  get:
+    securedBy: [null, oauth_2_0]
+  post:
+    securedBy: [oauth_2_0]

data/spec/examples/raml/securityschemes.raml

@@ -0,0 +1,47 @@
+#%RAML 0.8
+---
+title: Example API
+baseUri: http://localhost:3000
+securitySchemes:
+  - oauth_2_0:
+      description: |
+        Dropbox supports OAuth 2.0 for authenticating all API requests.
+      type: OAuth 2.0
+      describedBy:
+        headers:
+          Authorization:
+            description: |
+             Used to send a valid OAuth 2 access token. Do not use
+             with the "access_token" query string parameter.
+            type: string
+        queryParameters:
+          access_token:
+            description: |
+              Used to send a valid OAuth 2 access token. Do not use together with
+              the "Authorization" header
+              type: string
+        responses:
+          401:
+            description: |
+              Bad or expired token. This can happen if the user or Dropbox
+              revoked or expired an access token. To fix, you should re-
+              authenticate the user.
+          403:
+            description: |
+              Bad OAuth request (wrong consumer key, bad nonce, expired
+              timestamp...). Unfortunately, re-authenticating the user won't help here.
+      settings:
+        authorizationUri: https://www.dropbox.com/1/oauth2/authorize
+        accessTokenUri: https://api.dropbox.com/1/oauth2/token
+        authorizationGrants: [ code, token ]
+  - oauth_1_0:
+      description: |
+        OAuth 1.0 continues to be supported for all API requests, but OAuth 2.0 is now preferred.
+      type: OAuth 1.0
+      settings:
+        requestTokenUri: https://api.dropbox.com/1/oauth/request_token
+        authorizationUri: https://www.dropbox.com/1/oauth/authorize
+        tokenCredentialsUri: https://api.dropbox.com/1/oauth/access_token
+  - customHeader:
+      description: |
+        A custom

data/spec/examples/raml/simple.raml

@@ -0,0 +1,6 @@
+#%RAML 0.8
+---
+title: Example API
+baseUri: http://localhost:3000
+version: v123
+mediaType: application/json

data/spec/examples/raml/traits.raml

@@ -0,0 +1,34 @@
+#%RAML 0.8
+---
+title: Example API
+baseUri: http://localhost:3000
+traits:
+  - searchable:
+      displayName: Foo
+      description: This is searchable
+      queryParameters:
+        q:
+  - sortable:
+      description: This is sortable
+      queryParameters:
+        key:
+        order:
+/a:
+  get:
+    is: [ searchable, sortable ]
+  /b:
+    get:
+      is: [ searchable, sortable ]
+      displayName: /a/b
+      description: This is resource /a/b
+      queryParameters:
+        sort:
+        q:
+          displayName: This is the search term
+/c:
+  is: [ sortable ]
+  get:
+/d:
+  is: [ sortable ]
+  get:
+    is: [ searchable ]