matter_compiler 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f19e325ef7a0cbf7f7694b87d6b4a2947658e2e1
+  data.tar.gz: 7f46dbae5982e326b5bb2111bbf405fa8a9c1d17
+SHA512:
+  metadata.gz: daabff21fb92ea1d400c256fc2745cfe54c0dca159690ee826af45afc219bcef81d9c1534aca7c0498d6fe7ec7e77f4d96609bc234e7351535381eed5640c0cf
+  data.tar.gz: 1167484610a8a5a500dff8249a4c5222c9c9559536da38acfd0c71da23d8eb3e0538aad2b3c72b45ab4614c85e4df66c44ade92ecb11bba33859c16c8816d522

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.1.0
+before_install: gem update bundler
+notifications:
+  email:
+    recipients:
+      - z@apiary.io  
+    on_success: change
+    on_failure: always
+  hipchat:
+    secure: "m5NzHq8NoO6dvKFCgOuo8sV3ALe601IcZ4nvFSmmG79tx9YhwC5dOaZ0YgihZrLvdyxRDe7Tf9jtgicMkZ//uEiQ8+0qkXvxRkfu8KbdR09JbkbkkgoD3mIvw5f09H0HDhddZWcPHmBOjjGLrlWlBXfbqBX3gEHpHeumWdJ6nRA="

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in matter_compiler.gemspec
+gemspec
+
+# Override aruba to include the latest version from its repository
+group :development do
+  gem 'aruba', :git => 'git://github.com/cucumber/aruba.git'
+end

data/Gemfile.lock

@@ -0,0 +1,47 @@
+GIT
+  remote: git://github.com/cucumber/aruba.git
+  revision: 7afbc5c0cbae9c9a946d70c4c2735ccb86e00f08
+  specs:
+    aruba (0.5.3)
+      childprocess (>= 0.3.6)
+      cucumber (>= 1.1.1)
+      rspec-expectations (>= 2.7.0)
+
+PATH
+  remote: .
+  specs:
+    matter_compiler (0.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    builder (3.2.2)
+    childprocess (0.3.9)
+      ffi (~> 1.0, >= 1.0.11)
+    cucumber (1.3.10)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 2.12)
+      multi_json (>= 1.7.5, < 2.0)
+      multi_test (>= 0.0.2)
+    diff-lcs (1.2.5)
+    ffi (1.9.3)
+    gherkin (2.12.2)
+      multi_json (~> 1.3)
+    minitest (4.7.5)
+    multi_json (1.8.2)
+    multi_test (0.0.3)
+    rake (10.1.1)
+    rspec-expectations (2.14.4)
+      diff-lcs (>= 1.1.3, < 2.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aruba!
+  bundler (~> 1.5)
+  cucumber
+  matter_compiler!
+  minitest
+  rake

data/LICENSE

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2013 Apiary Inc. <support@apiary.io>.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,37 @@
+# Matter Compiler [![Build Status](https://travis-ci.org/apiaryio/matter_compiler.png?branch=master)](https://travis-ci.org/apiaryio/matter_compiler)
+
+Matter Compiler is a [API Blueprint AST Media Types](https://github.com/apiaryio/snowcrash/wiki/API-Blueprint-AST-Media-Types) to [API Blueprint](https://apiblueprint.org) conversion tool. It composes an API blueprint from its serialzed AST media-type.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'matter_compiler'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install matter_compiler
+
+## Usage
+To compose a blueprint from a serialized AST media-type run:
+
+```sh
+$ matter_compiler path/to/ast.yaml
+```
+
+See the [compose feature](features/compose.feature) for details or run `matter_compiler --help`.
+
+## Contributing
+
+1. Fork it (https://github.com/apiaryio/matter_compiler/fork)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+MIT License. See the [LICENSE](LICENSE) file.

data/Rakefile

@@ -0,0 +1,21 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+require 'cucumber/rake/task'
+
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end
+
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = "features --format pretty"
+end
+
+desc "Run all CI tests" 
+task :test_ci do
+  Rake::Task['test'].invoke 
+  Rake::Task['features'].invoke
+end
+
+task :default => :test_ci

data/bin/matter_compiler

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require 'matter_compiler/cli'
+MatterCompiler::CLI.start

data/features/compose.feature

@@ -0,0 +1,364 @@
+  Feature: Compose
+
+  Background:
+    Given a file named "blueprint.md" with:
+      """
+      FORMAT: 1A
+
+      # My API
+      Description of *My API*.
+
+      ## /
+      ### GET
+      + Response 200 (text/plain)
+
+              Hello World!
+
+      # Group Red
+      Description of *Red* Group.
+
+      ## My Resource [/myresource/{id}]
+      Description of *My Resource*
+
+      + Model (application/json)
+          + Headers
+
+                  X-Header: 1
+
+          + Body
+
+                  { "message": "Hello World" }
+
+          + Schema
+
+                  { "$schema": "http://json-schema.org/draft-03/schema" }
+
+      + Parameters
+          + id = `42` (number, optional, `1000`) ... Parameter `id` description.
+
+      ### Retrieve My Resource [GET]
+      + Response 200 (application/json)
+          + Headers
+
+                  X-Header: 1
+
+          + Body
+
+                  { "message": "Hello World" }
+
+          + Schema
+
+                  { "$schema": "http://json-schema.org/draft-03/schema" }
+
+      ### Create My Resource [POST]
+      + Request (text/plain)
+
+              Ni Hao!
+
+      + Response 204
+
+"""
+
+    And a file named "ast.yaml" with:
+      """
+      _version: 1.0
+      metadata:
+        FORMAT:
+          value: 1A
+      name: My API
+      description: "Description of *My API*.\n\n"
+      resourceGroups:
+      - name:
+        description:
+        resources:
+        - name:
+          description:
+          uriTemplate: /
+          model:
+          parameters:
+          headers:
+          actions:
+          - name:
+            description:
+            method: GET
+            parameters:
+            headers:
+            examples:
+            - name:
+              description:
+              requests:
+              responses:
+              - name: 200
+                description:
+                headers:
+                  Content-Type:
+                    value: text/plain
+                body: "Hello World!\n"
+                schema:
+      - name: Red
+        description: "Description of *Red* Group.\n\n"
+        resources:
+        - name: My Resource
+          description: "Description of *My Resource*\n\n"
+          uriTemplate: "/myresource/{id}"
+          model:
+            name: My Resource
+            description:
+            headers:
+              Content-Type:
+                value: application/json
+              X-Header:
+                value: 1
+            body: "{ \"message\": \"Hello World\" }\n"
+            schema: "{ \"$schema\": \"http://json-schema.org/draft-03/schema\" }\n"
+          parameters:
+            id:
+              description: "Parameter `id` description.\n"
+              type: number
+              required: false
+              default: 42
+              example: 1000
+              values:
+          headers:
+          actions:
+          - name: Retrieve My Resource
+            description:
+            method: GET
+            parameters:
+            headers:
+            examples:
+            - name:
+              description:
+              requests:
+              responses:
+              - name: 200
+                description:
+                headers:
+                  Content-Type:
+                    value: application/json
+                  X-Header:
+                    value: 1
+                body: "{ \"message\": \"Hello World\" }\n"
+                schema: "{ \"$schema\": \"http://json-schema.org/draft-03/schema\" }\n"
+          - name: Create My Resource
+            description:
+            method: POST
+            parameters:
+            headers:
+            examples:
+            - name:
+              description:
+              requests:
+              - name:
+                description:
+                headers:
+                  Content-Type:
+                    value: text/plain
+                body: "Ni Hao!\n"
+                schema:
+              responses:
+              - name: 204
+                description:
+                headers:
+                body:
+                schema:
+
+      """
+
+    And a file named "ast.json" with:
+      """
+      {
+        "_version": "1.0",
+        "metadata": {
+          "FORMAT": {
+            "value": "1A"
+          }
+        },
+        "name": "My API",
+        "description": "Description of *My API*.\n\n",
+        "resourceGroups": [
+          {
+            "name": "",
+            "description": "",
+            "resources": [
+              {
+                "name": "",
+                "description": "",
+                "uriTemplate": "/",
+                "model": {},
+                "parameters": {},
+                "headers": {},
+                "actions": [
+                  {
+                    "name": "",
+                    "description": "",
+                    "method": "GET",
+                    "parameters": {},
+                    "headers": {},
+                    "examples": [
+                      {
+                        "name": "",
+                        "description": "",
+                        "requests": [],
+                        "responses": [
+                          {
+                            "name": "200",
+                            "description": "",
+                            "headers": {
+                              "Content-Type": {
+                                "value": "text/plain"
+                              }
+                            },
+                            "body": "Hello World!\n",
+                            "schema": ""
+                          }
+                        ]
+                      }
+                    ]
+                  }
+                ]
+              }
+            ]
+          },
+          {
+            "name": "Red",
+            "description": "Description of *Red* Group.\n\n",
+            "resources": [
+              {
+                "name": "My Resource",
+                "description": "Description of *My Resource*\n\n",
+                "uriTemplate": "/myresource/{id}",
+                "model": {
+                    "name": "My Resource",
+                    "description": "",
+                    "headers": {
+                      "Content-Type": {
+                        "value": "application/json"
+                      },
+                      "X-Header": {
+                        "value": "1"
+                      }
+                    },
+                    "body": "{ \"message\": \"Hello World\" }\n",
+                    "schema": "{ \"$schema\": \"http://json-schema.org/draft-03/schema\" }\n"
+                  },
+                "parameters": {
+                  "id": {
+                    "description": "Parameter `id` description.\n",
+                    "type": "number",
+                    "required": false,
+                    "default": "42",
+                    "example": "1000",
+                    "values": []
+                  }
+                },
+                "headers": {},
+                "actions": [
+                  {
+                    "name": "Retrieve My Resource",
+                    "description": "",
+                    "method": "GET",
+                    "parameters": {},
+                    "headers": {},
+                    "examples": [
+                      {
+                        "name": "",
+                        "description": "",
+                        "requests": [],
+                        "responses": [
+                          {
+                            "name": "200",
+                            "description": "",
+                            "headers": {
+                              "Content-Type": {
+                                "value": "application/json"
+                              },
+                              "X-Header": {
+                                "value": "1"
+                              }
+                            },
+                            "body": "{ \"message\": \"Hello World\" }\n",
+                            "schema": "{ \"$schema\": \"http://json-schema.org/draft-03/schema\" }\n"
+                          }
+                        ]
+                      }
+                    ]
+                  },
+                  {
+                    "name": "Create My Resource",
+                    "description": "",
+                    "method": "POST",
+                    "parameters": {},
+                    "headers": {},
+                    "examples": [
+                      {
+                        "name": "",
+                        "description": "",
+                        "requests": [
+                          {
+                            "name": "",
+                            "description": "",
+                            "headers": {
+                              "Content-Type": {
+                                "value": "text/plain"
+                              }
+                            },
+                            "body": "Ni Hao!\n",
+                            "schema": ""
+                          }
+                        ],
+                        "responses": [
+                          {
+                            "name": "204",
+                            "description": "",
+                            "headers": {},
+                            "body": "",
+                            "schema": ""
+                          }
+                        ]
+                      }
+                    ]
+                  }
+                ]
+              }
+            ]
+          }
+        ]
+      }
+
+      """
+
+  Scenario: Compose blueprint from an YAML stdin input
+    When I run `matter_compiler --format yaml` interactively
+    When I pipe in the file "ast.yaml"
+    Then the output should contain the content file "blueprint.md"
+
+  Scenario: Compose blueprint from an YAML file
+    When I run `matter_compiler ast.yaml`
+    Then the output should contain the content file "blueprint.md"    
+
+  Scenario: Compose blueprint from a JSON stdin input
+    When I run `matter_compiler --format json` interactively
+    When I pipe in the file "ast.json"
+    Then the output should contain the content file "blueprint.md"
+
+  Scenario: Compose blueprint from a JSON file
+    When I run `matter_compiler ast.json`
+    Then the output should contain the content file "blueprint.md"
+
+
+  Scenario: Copose unsupported version of blueprint AST
+    Given a file named "future_ast.yaml" with:
+    """
+    _version: 42000.0.0
+    metadata:
+    name:
+    description:
+    resourceGroups:
+    """
+    When I run `matter_compiler future_ast.yaml`
+    Then it should fail with:
+    """
+    unsupported AST version
+    """
+