raml_parser 0.1

data/spec/examples/raml/external/json_schema.json

@@ -0,0 +1,18 @@
+{
+  "title": "Example Schema",
+  "type": "object",
+  "properties": {
+    "firstName": {
+                    "type": "string"
+    },
+    "lastName": {
+      "type": "string"
+    },
+    "age": {
+      "description": "Age in years",
+      "type": "integer",
+      "minimum": 0
+    }
+  },
+  "required": ["firstName", "lastName"]
+}

data/spec/examples/raml/external/jukebox-api.raml

@@ -0,0 +1,191 @@
+#%RAML 0.8
+---
+title: Jukebox API
+baseUri: http://jukebox.api.com
+version: v1
+
+schemas:
+ - song: !include jukebox-include-song.schema
+ - artist: !include jukebox-include-artist.schema
+ - album: !include jukebox-include-album.schema
+
+
+resourceTypes:
+  - readOnlyCollection:
+      description: Collection of available <<resourcePathName>> in Jukebox.
+      get:
+        description: Get a list of <<resourcePathName>>.
+        responses:
+          200:
+            body:
+              application/json:
+                example: |
+                  <<exampleCollection>>
+  - collection:
+      description: Collection of available <<resourcePathName>> in Jukebox.
+      get:
+        description: Get a list of <<resourcePathName>>.
+        responses:
+          200:
+            body:
+              application/json:
+                example: |
+                  <<exampleCollection>>
+      post:
+        description: |
+          Add a new <<resourcePathName|!singularize>> to Jukebox.
+        queryParameters:
+          access_token:
+            description: "The access token provided by the authentication application"
+            example: AABBCCDD
+            required: true
+            type: string
+        body:
+          application/json:
+            schema: <<resourcePathName|!singularize>>
+            example: |
+              <<exampleItem>>
+        responses:
+          200:
+            body:
+              application/json:
+                example: |
+                  { "message": "The <<resourcePathName|!singularize>> has been properly entered" }
+  - collection-item:
+      description: Entity representing a <<resourcePathName|!singularize>>
+      get:
+        description: |
+          Get the <<resourcePathName|!singularize>>
+          with <<resourcePathName|!singularize>>Id =
+          {<<resourcePathName|!singularize>>Id}
+        responses:
+          200:
+            body:
+              application/json:
+                example: |
+                  <<exampleItem>>
+          404:
+            body:
+              application/json:
+                example: |
+                  {"message": "<<resourcePathName|!singularize>> not found" }
+traits:
+  - searchable:
+      queryParameters:
+        query:
+          description: |
+            JSON array [{"field1","value1","operator1"},{"field2","value2","operator2"},...,{"fieldN","valueN","operatorN"}] <<description>>
+          example: |
+            <<example>>
+  - orderable:
+      queryParameters:
+        orderBy:
+          description: |
+            Order by field: <<fieldsList>>
+          type: string
+          required: false
+        order:
+          description: Order
+          enum: [desc, asc]
+          default: desc
+          required: false
+  - pageable:
+      queryParameters:
+        offset:
+          description: Skip over a number of elements by specifying an offset value for the query
+          type: integer
+          required: false
+          example: 20
+          default: 0
+        limit:
+          description: Limit the number of elements on the response
+          type: integer
+          required: false
+          example: 80
+          default: 10
+
+/songs:
+  type:
+    collection:
+      exampleCollection: !include jukebox-include-songs.sample
+      exampleItem: !include jukebox-include-song-new.sample
+  get:
+    is: [
+          searchable: {description: "with valid searchable fields: songTitle", example: "[\"songTitle\", \"Get L\", \"like\"]"},
+          orderable: {fieldsList: "songTitle"},
+          pageable
+        ]
+  /{songId}:
+    type:
+      collection-item:
+        exampleItem: !include jukebox-include-song-retrieve.sample
+    /file-content:
+      description: The file to be reproduced by the client
+      get:
+        description: Get the file content
+        responses:
+          200:
+            body:
+              binary/octet-stream:
+      post:
+        description: |
+           Enters the file content for an existing song entity.
+
+           The song needs to be created for the `/songs/{songId}/file-content` to exist.
+           You can use this second resource to get and post the file to reproduce.
+
+           Use the "binary/octet-stream" content type to specify the content from any consumer (excepting web-browsers).
+           Use the "multipart-form/data" content type to upload a file which content will become the file-content
+        body:
+          binary/octet-stream:
+          multipart/form-data:
+            formParameters:
+              file:
+                description: The file to be uploaded
+                required: true
+                type: file
+/artists:
+  type:
+    collection:
+      exampleCollection: !include jukebox-include-artists.sample
+      exampleItem: !include jukebox-include-artist-new.sample
+  get:
+    is: [
+          searchable: {description: "with valid searchable fields: countryCode", example: "[\"countryCode\", \"FRA\", \"equals\"]"},
+          orderable: {fieldsList: "artistName, nationality"},
+          pageable
+        ]
+  /{artistId}:
+    type:
+      collection-item:
+        exampleItem: !include jukebox-include-artist-retrieve.sample
+    /albums:
+      type:
+        readOnlyCollection:
+          exampleCollection: !include jukebox-include-artist-albums.sample
+      description: Collection of albulms belonging to the artist
+      get:
+        description: Get a specific artist's albums list
+        is: [orderable: {fieldsList: "albumName"}, pageable]
+/albums:
+  type:
+    collection:
+      exampleCollection: !include jukebox-include-albums.sample
+      exampleItem: !include jukebox-include-album-new.sample
+  get:
+    is: [
+          searchable: {description: "with valid searchable fields: genreCode", example: "[\"genreCode\", \"ELE\", \"equals\"]"},
+          orderable: {fieldsList: "albumName, genre"},
+          pageable
+        ]
+  /{albumId}:
+    type:
+      collection-item:
+        exampleItem: !include jukebox-include-album-retrieve.sample
+    /songs:
+      type:
+        readOnlyCollection:
+          exampleCollection: !include jukebox-include-album-songs.sample
+      get:
+        is: [orderable: {fieldsList: "songTitle"}]
+        description: Get the list of songs for the album with `albumId = {albumId}`

data/spec/examples/raml/external/jukebox-include-album-new.sample

@@ -0,0 +1,8 @@
+{
+  "albumId": "183100e3-0e2b-4404-a716-66104d440550",
+  "albumName": "Random Access Memories",
+  "year": "2013",
+  "imageURL": "http://upload.wikimedia.org/wikipedia/en/a/a7/Random_Access_Memories.jpg",
+  "genreCode": "ELE",
+  "artistId": "110e8300-e32b-41d4-a716-664400445500"
+}

data/spec/examples/raml/external/jukebox-include-album-retrieve.sample

@@ -0,0 +1,30 @@
+{
+  "albumId": "183100e3-0e2b-4404-a716-66104d440550",
+  "albumName": "Random Access Memories",
+  "year": "2013",
+  "genre": "Electric Funk",
+  "imageURL": "http://upload.wikimedia.org/wikipedia/en/a/a7/Random_Access_Memories.jpg",
+  "genre": {
+    "countryCode": "ELE",
+    "countryName": "Electronict"
+  },
+  "songs": [
+    {
+      "songId": "550e8400-e29b-41d4-a716-446655440000",
+      "songTitle": "Get Lucky"
+    },
+    {
+      "songId": "550e8400-e29b-41d4-a716-446655440111",
+      "songTitle": "Loose yourself to dance"
+    },
+    {
+      "songId": "550e8400-e29b-41d4-a716-446655440222",
+      "songTitle": "Gio sorgio by Moroder"
+    }
+  ],
+  "artist": {
+    "artistId": "110e8300-e32b-41d4-a716-664400445500",
+    "artistName": "Daft Punk",
+    "imageURL": "http://travelhymns.com/wp-content/uploads/2013/06/random-access-memories1.jpg"
+  }
+}

data/spec/examples/raml/external/jukebox-include-album-songs.sample

@@ -0,0 +1,14 @@
+[
+  {
+    "songId": "550e8400-e29b-41d4-a716-446655440000",
+    "songTitle": "Get Lucky"
+  },
+  {
+    "songId": "550e8400-e29b-41d4-a716-446655440111",
+    "songTitle": "Loose yourself to dance"
+  },
+  {
+    "songId": "550e8400-e29b-41d4-a716-446655440222",
+    "songTitle": "Gio sorgio by Moroder"
+  }
+]

data/spec/examples/raml/external/jukebox-include-album.schema

@@ -0,0 +1,36 @@
+{
+  "type": "object",
+  "$schema": "http://json-schema.org/draft-03/schema",
+  "id": "http://jsonschema.net",
+  "required":false,
+  "properties": {
+    "albumId": {
+      "type": "string",
+      "required":true,
+      "minLength": 36,
+      "maxLength": 36
+    },
+    "albumName": {
+      "type": "string",
+      "required": true
+    },
+    "year": {
+      "type": "string",
+      "required": false
+    },
+    "iamgeURL": {
+      "type": "string",
+      "required": false
+    },
+    "genreCode": {
+      "type": "string",
+      "required": true
+    },
+    "artistId": {
+      "type": "string",
+      "required":true,
+      "minLength": 36,
+      "maxLength": 36
+    }
+  }
+} 

data/spec/examples/raml/external/jukebox-include-albums.sample

@@ -0,0 +1,32 @@
+[
+  {
+    "albumId": "183100e3-0e2b-4404-a716-66104d440550",
+    "albumName": "Random Access Memories",
+    "imageURL": "http://upload.wikimedia.org/wikipedia/en/a/a7/Random_Access_Memories.jpg",
+    "artistId": "110e8300-e32b-41d4-a716-664400445500",
+    "genre": {
+      "countryCode": "ELE",
+      "countryName": "Electronic"
+    }
+  },
+  {
+    "albumId": "183100e3-0e2b-4404-3123-66111d4de520",
+    "albumName": "OK Computer",
+    "imageURL": "http://www.greenplastic.com/dev/wp-content/uploads/2010/12/ok-computer.jpg",
+    "artistId": "11032be3-41d4-4455-a716-664400a71600",
+    "genre": {
+      "countryCode": "ALT",
+      "countryName": "Alternative Rock"
+    }
+  },
+  {
+    "albumId": "183100e3-cccc-4404-1111-63204d64coda",
+    "albumName": "The Dark Side of the Moon",
+    "imageURL": "http://upload.wikimedia.org/wikipedia/en/3/3b/Dark_Side_of_the_Moon.png",
+    "artistId": "110e8300-e32b-41d4-a716-229932554400",
+    "genre": {
+      "countryCode": "PRO",
+      "countryName": "Progressive Rock"
+    }
+  }
+]

data/spec/examples/raml/external/jukebox-include-artist-albums.sample

@@ -0,0 +1,42 @@
+[
+  {
+    "albumId": "183100e3-0e2b-4404-a716-66104d440550",
+    "albumName": "Random Access Memories",
+    "imageURL": "http://upload.wikimedia.org/wikipedia/en/a/a7/Random_Access_Memories.jpg"
+  },
+  {
+    "albumId": "183100e3-0e2b-4404-a716-66104d440551",
+    "albumName": "TRON: Legacy R3CONF1GUR3D",
+    "imageURL": "http://ecx.images-amazon.com/images/I/51Tvo-iArBL.jpg"
+  },
+  {
+    "albumId": "183100e3-0e2b-4404-a716-66104d440552",
+    "albumName": "TRON: Legacy",
+    "imageURL": "http://upload.wikimedia.org/wikipedia/en/3/39/Tron_Legacy_Soundtrack.jpg"
+  },
+  {
+    "albumId": "183100e3-0e2b-4404-a716-66104d440553",
+    "albumName": "Alive",
+    "imageURL": "http://upload.wikimedia.org/wikipedia/en/4/49/Daft_Punk_Alive_2007.JPG"
+  },
+  {
+    "albumId": "183100e3-0e2b-4404-a716-66104d440554",
+    "albumName": "Musique Vol. 1",
+    "imageURL": "http://upload.wikimedia.org/wikipedia/en/a/ab/Musique_Vol._1_1993%E2%80%932005.png"
+  },
+  {
+    "albumId": "183100e3-0e2b-4404-a716-66104d440555",
+    "albumName": "Human After All",
+    "imageURL": "http://upload.wikimedia.org/wikipedia/en/0/0d/Humanafterall.jpg"
+  },
+  {
+    "albumId": "183100e3-0e2b-4404-a716-66104d440556",
+    "albumName": "Daft Club",
+    "imageURL": "http://upload.wikimedia.org/wikipedia/en/f/fc/Daftclub.jpg"
+  },
+  {
+    "albumId": "183100e3-0e2b-4404-a716-66104d440557",
+    "albumName": "Discovery",
+    "imageURL": "http://ecx.images-amazon.com/images/I/71bsHTr6idL._SL1500_.jpg"
+  }
+]

data/spec/examples/raml/external/jukebox-include-artist-new.sample

@@ -0,0 +1,5 @@
+{
+  "artistName": "Daft Punk",
+  "description": "French electronic music duo consisting of musicians Guy-Manuel de Homem-Christo and Thomas Bangalter",
+  "imageURL": "http://travelhymns.com/wp-content/uploads/2013/06/random-access-memories1.jpg"
+}

data/spec/examples/raml/external/jukebox-include-artist-retrieve.sample

@@ -0,0 +1,52 @@
+{
+  "artistId": "110e8300-e32b-41d4-a716-664400445500",
+  "artistName": "Daft Punk",
+  "description": "French electronic music duo consisting of musicians Guy-Manuel de Homem-Christo and Thomas Bangalter",
+  "imageURL": "http://travelhymns.com/wp-content/uploads/2013/06/random-access-memories1.jpg",
+  "nationality": {
+    "countryCode": "FRA",
+    "countryName": "France"
+  },
+  "albums": [
+    {
+      "albumId": "183100e3-0e2b-4404-a716-66104d440550",
+      "albumName": "Random Access Memories",
+      "imageURL": "http://upload.wikimedia.org/wikipedia/en/a/a7/Random_Access_Memories.jpg"
+    },
+    {
+      "albumId": "183100e3-0e2b-4404-a716-66104d440551",
+      "albumName": "TRON: Legacy R3CONF1GUR3D",
+      "imageURL": "http://ecx.images-amazon.com/images/I/51Tvo-iArBL.jpg"
+    },
+    {
+      "albumId": "183100e3-0e2b-4404-a716-66104d440552",
+      "albumName": "TRON: Legacy",
+      "imageURL": "http://upload.wikimedia.org/wikipedia/en/3/39/Tron_Legacy_Soundtrack.jpg"
+    },
+    {
+      "albumId": "183100e3-0e2b-4404-a716-66104d440553",
+      "albumName": "Alive",
+      "imageURL": "http://upload.wikimedia.org/wikipedia/en/4/49/Daft_Punk_Alive_2007.JPG"
+    },
+    {
+      "albumId": "183100e3-0e2b-4404-a716-66104d440554",
+      "albumName": "Musique Vol. 1",
+      "imageURL": "http://upload.wikimedia.org/wikipedia/en/a/ab/Musique_Vol._1_1993%E2%80%932005.png"
+    },
+    {
+      "albumId": "183100e3-0e2b-4404-a716-66104d440555",
+      "albumName": "Human After All",
+      "imageURL": "http://upload.wikimedia.org/wikipedia/en/0/0d/Humanafterall.jpg"
+    },
+    {
+      "albumId": "183100e3-0e2b-4404-a716-66104d440556",
+      "albumName": "Daft Club",
+      "imageURL": "http://upload.wikimedia.org/wikipedia/en/f/fc/Daftclub.jpg"
+    },
+    {
+      "albumId": "183100e3-0e2b-4404-a716-66104d440557",
+      "albumName": "Discovery",
+      "imageURL": "http://ecx.images-amazon.com/images/I/71bsHTr6idL._SL1500_.jpg"
+    }
+  ]
+}

data/spec/examples/raml/external/jukebox-include-artist.schema

@@ -0,0 +1,20 @@
+{
+  "type": "object",
+  "$schema": "http://json-schema.org/draft-03/schema",
+  "id": "http://jsonschema.net",
+  "required":false,
+  "properties": {
+    "artistName": {
+      "type": "string",
+      "required":true
+    },
+    "description": {
+      "type": "string",
+      "required": false
+    },
+    "imageURL": {
+      "type": "string",
+      "required": false
+    }
+  }
+}