apiary_blueprint_convertor 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 848054e783c9a61d69e0a2be0dbdb0eef16a7388
+  data.tar.gz: 963c51bb0f6b0ec32a8dd973d3f613973acc2741
+SHA512:
+  metadata.gz: 6060f1dc3dad96ce6af4b5bac882272496cb59d4b27f440806f676a278ce95a77100eaa4bc102c2f3d3dc397d6a3d11bc5b0e4e46b829bef447a8cb127215db6
+  data.tar.gz: 7be67e76e709b687ca30cfe4754f15f5f30ff37c1f50b71a796f24e230c558b99b0cf70f673bbcc0c002f42aff5bcd3336712f25ed397738ce5f6ffa991cfc0f

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,14 @@
+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: "JT63QEBAHHbcM9MiLheYGfpztUCnzwcDuOXmn9A96J9DqMvinOlEhLW2sl0aGr9YsF8mXY9zB03KglpSeP9yLZyroAPjIqNGh2+eLFy+v/ELpDBW4EA1XwBNwz1CvHSReJWupujTSHiV9r4+WPPIb0+KIsqPsOvbh1sGPMhulkA="
+    

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in apiary_blueprint_convertor.gemspec
+gemspec
+
+# Manual Aruba Installation
+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: 99d8e6a5992af17b014783e775409bc3fd422273
+  specs:
+    aruba (0.5.4)
+      childprocess (>= 0.3.6)
+      cucumber (>= 1.1.1)
+      rspec-expectations (>= 2.7.0)
+
+PATH
+  remote: .
+  specs:
+    apiary_blueprint_convertor (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 (5.2.1)
+    multi_json (1.8.4)
+    multi_test (0.0.3)
+    rake (10.1.1)
+    rspec-expectations (2.14.4)
+      diff-lcs (>= 1.1.3, < 2.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  apiary_blueprint_convertor!
+  aruba!
+  bundler (~> 1.5)
+  cucumber
+  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,40 @@
+# Apiary Blueprint AST Convertor [![Build Status](https://travis-ci.org/apiaryio/apiary_blueprint_convertor.png?branch=master)](https://travis-ci.org/apiaryio/apiary_blueprint_convertor)
+A migration tool for legacy [Apiary Blueprint](https://github.com/apiaryio/blueprint-parser) AST into [API Blueprint](http://apiblueprint.org) AST. Converts Apiary Blueprint AST serialized into a JSON file to [API Blueprint AST](https://github.com/apiaryio/snowcrash/wiki/API-Blueprint-AST-Media-Types) JSON representation (`vnd.apiblueprint.ast.raw+json; version=1.0`).
+
+## Installation
+Add this line to your application's Gemfile:
+
+    gem 'apiary_blueprint_convertor'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install apiary_blueprint_convertor
+
+## Usage
+
+```sh
+$ apiary_blueprint_convertor path/to/legacy/ast.json
+```
+
+See the [convert feature](features/convert.feature) for details or run `apiary_blueprint_convertor --help`.
+
+### Convert Legacy Apiary Blueprint to API Blueprint
+Use this convertor together with the legacy [Apiary Blueprint Parser](https://github.com/apiaryio/blueprint-parser) and API Blueprint Composer – [Matter Compiler](https://github.com/apiaryio/matter_compiler). 
+
+1. Parse Legacy Apiary Blueprint into its JSON AST using `Apiary Blueprint Parser`
+2. Convert legacy JSON AST into API Blueprint JSON AST using `apiary_blueprint_convertor`
+3. Compose API Blueprint from API Blueprint JSON AST using `matter_compiler`
+
+## Contributing
+1. Fork this repository (http://github.com/apiaryio/apiary_blueprint_convertor/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/apiary_blueprint_convertor.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'apiary_blueprint_convertor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "apiary_blueprint_convertor"
+  spec.version       = ApiaryBlueprintConvertor::VERSION
+  spec.authors       = ["Zdenek Nemec"]
+  spec.email         = ["z@apiary.io"]
+  spec.summary       = %q{Apiary Blueprint AST convertor.}
+  spec.description   = %q{Convert legacy Apiary Blueprint AST into API Blueprint AST (JSON).}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "cucumber"
+  spec.add_development_dependency "minitest"
+  
+end

data/bin/apiary_blueprint_convertor

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

data/features/convert.feature

@@ -0,0 +1,321 @@
+Feature: Convert AST
+
+  Background: 
+    Given a file named "legacy_ast.json" with:
+    """
+    {
+      "location": "http://www.google.com/",
+      "name": "Sample API v2",
+      "description": "Welcome to our sample API documentation. All comments can be written in (support [Markdown](http://daringfireball.net/projects/markdown/syntax) syntax)",
+      "sections": [
+        {
+          "name": "Shopping Cart Resources",
+          "description": "The following is a section of resources related to the shopping cart",
+          "resources": [
+            {
+              "description": "List products added into your shopping-cart. (comment block again in Markdown)",
+              "method": "GET",
+              "url": "/shopping-cart",
+              "request": {
+                "headers": {},
+                "body": null
+              },
+              "responses": [
+                {
+                  "status": 200,
+                  "headers": {
+                    "Content-Type": "application/json"
+                  },
+                  "body": "{\n    \"items\": [\n        {\n            \"url\": \"/shopping-cart/1\",\n            \"product\": \"2ZY48XPZ\",\n            \"quantity\": 1,\n            \"name\": \"New socks\",\n            \"price\": 1.25\n        }\n    ]\n}"
+                }
+              ]
+            },
+            {
+              "description": "Save new products in your shopping cart",
+              "method": "POST",
+              "url": "/shopping-cart",
+              "request": {
+                "headers": {
+                  "Content-Type": "application/json"
+                },
+                "body": "{\n    \"product\": \"1AB23ORM\",\n    \"quantity\": 2\n}"
+              },
+              "responses": [
+                {
+                  "status": 201,
+                  "headers": {
+                    "Content-Type": "application/json"
+                  },
+                  "body": "{\n    \"status\": \"created\",\n    \"url\": \"/shopping-cart/2\"\n}"
+                },
+                {
+                  "status": 401,
+                  "headers": {
+                    "Content-Type": "application/json; charset=utf-8"
+                  },
+                  "body": "{\n    \"message\": \"You have not provided proper request token\"\n}"
+                }
+              ]
+            }
+          ]
+        },
+        {
+          "name": "Payment Resources",
+          "description": null,
+          "resources": [
+            {
+              "description": "This resource allows you to submit payment information to process your *shopping cart* items",
+              "method": "POST",
+              "url": "/payment",
+              "request": {
+                "headers": {},
+                "body": "{\n    \"cc\": \"12345678900\",\n    \"cvc\": \"123\",\n    \"expiry\": \"0112\"\n}"
+              },
+              "responses": [
+                {
+                  "status": 200,
+                  "headers": {},
+                  "body": "{\n    \"receipt\": \"/payment/receipt/1\"\n}"
+                }
+              ]
+            },
+            {
+              "description": null,
+              "method": "POST",
+              "url": "/resource",
+              "request": {
+                "headers": {
+                  "Content-Type": "application/json"
+                },
+                "body": "{\n    \"a\": \"b\",\n    \"c\": \"0\"\n}"
+              },
+              "responses": [
+                {
+                  "status": 200,
+                  "headers": {},
+                  "body": "{\n    \"status\": \"ok\"\n}"
+                }
+              ]
+            }
+          ]
+        }
+      ],
+      "validations": [
+        {
+          "method": "POST",
+          "url": "/resource",
+          "body": "{\n    \"request\": {\n        \"type\": \"object\",\n        \"properties\": {\n            \"a\": {\n                \"type\": \"string\",\n                \"format\": \"alphanumeric\"\n            },\n            \"c\": {\n                \"type\": \"integer\"\n            }\n        }\n    },\n    \"response\": {\n        \"type\": \"object\",\n        \"properties\": {\n            \"status\": {\n                \"type\": \"string\",\n                \"format\": \"alphanumeric\"\n            }\n        }\n    }\n}"
+        }
+      ]
+    }
+    """
+
+    Given a file named "apiblueprint_ast.json" with:
+    """
+    {
+      "_version": "1.0",
+      "metadata": {
+        "HOST": {
+          "value": "http://www.google.com/"
+        }
+      },
+      "name": "Sample API v2",
+      "description": "Welcome to our sample API documentation. All comments can be written in (support [Markdown](http://daringfireball.net/projects/markdown/syntax) syntax)",
+      "resourceGroups": [
+        {
+          "name": "Shopping Cart Resources",
+          "description": "The following is a section of resources related to the shopping cart",
+          "resources": [
+            {
+              "name": null,
+              "description": null,
+              "uriTemplate": "/shopping-cart",
+              "model": null,
+              "parameters": null,
+              "headers": null,
+              "actions": [
+                {
+                  "name": null,
+                  "description": "List products added into your shopping-cart. (comment block again in Markdown)",
+                  "method": "GET",
+                  "parameters": null,
+                  "headers": null,
+                  "examples": [
+                    {
+                      "name": null,
+                      "description": null,
+                      "requests": null,
+                      "responses": [
+                        {
+                          "name": "200",
+                          "description": null,
+                          "headers": {
+                            "Content-Type": {
+                              "value": "application/json"
+                            }
+                          },
+                          "body": "{\n    \"items\": [\n        {\n            \"url\": \"/shopping-cart/1\",\n            \"product\": \"2ZY48XPZ\",\n            \"quantity\": 1,\n            \"name\": \"New socks\",\n            \"price\": 1.25\n        }\n    ]\n}",
+                          "schema": null
+                        }
+                      ]
+                    }
+                  ]
+                },
+                {
+                  "name": null,
+                  "description": "Save new products in your shopping cart",
+                  "method": "POST",
+                  "parameters": null,
+                  "headers": null,
+                  "examples": [
+                    {
+                      "name": null,
+                      "description": null,
+                      "requests": [
+                        {
+                          "name": null,
+                          "description": null,
+                          "headers": {
+                            "Content-Type": {
+                              "value": "application/json"
+                            }
+                          },
+                          "body": "{\n    \"product\": \"1AB23ORM\",\n    \"quantity\": 2\n}",
+                          "schema": null
+                        }
+                      ],
+                      "responses": [
+                        {
+                          "name": "201",
+                          "description": null,
+                          "headers": {
+                            "Content-Type": {
+                              "value": "application/json"
+                            }
+                          },
+                          "body": "{\n    \"status\": \"created\",\n    \"url\": \"/shopping-cart/2\"\n}",
+                          "schema": null
+                        },
+                        {
+                          "name": "401",
+                          "description": null,
+                          "headers": {
+                            "Content-Type": {
+                              "value": "application/json; charset=utf-8"
+                            }
+                          },
+                          "body": "{\n    \"message\": \"You have not provided proper request token\"\n}",
+                          "schema": null
+                        }
+                      ]
+                    }
+                  ]
+                }
+              ]
+            }
+          ]
+        },
+        {
+          "name": "Payment Resources",
+          "description": null,
+          "resources": [
+            {
+              "name": null,
+              "description": null,
+              "uriTemplate": "/payment",
+              "model": null,
+              "parameters": null,
+              "headers": null,
+              "actions": [
+                {
+                  "name": null,
+                  "description": "This resource allows you to submit payment information to process your *shopping cart* items",
+                  "method": "POST",
+                  "parameters": null,
+                  "headers": null,
+                  "examples": [
+                    {
+                      "name": null,
+                      "description": null,
+                      "requests": [
+                        {
+                          "name": null,
+                          "description": null,
+                          "headers": null,
+                          "body": "{\n    \"cc\": \"12345678900\",\n    \"cvc\": \"123\",\n    \"expiry\": \"0112\"\n}",
+                          "schema": null
+                        }
+                      ],
+                      "responses": [
+                        {
+                          "name": "200",
+                          "description": null,
+                          "headers": null,
+                          "body": "{\n    \"receipt\": \"/payment/receipt/1\"\n}",
+                          "schema": null
+                        }
+                      ]
+                    }
+                  ]
+                }
+              ]
+            },
+            {
+              "name": null,
+              "description": null,
+              "uriTemplate": "/resource",
+              "model": null,
+              "parameters": null,
+              "headers": null,
+              "actions": [
+                {
+                  "name": null,
+                  "description": null,
+                  "method": "POST",
+                  "parameters": null,
+                  "headers": null,
+                  "examples": [
+                    {
+                      "name": null,
+                      "description": null,
+                      "requests": [
+                        {
+                          "name": null,
+                          "description": null,
+                          "headers": {
+                            "Content-Type": {
+                              "value": "application/json"
+                            }
+                          },
+                          "body": "{\n    \"a\": \"b\",\n    \"c\": \"0\"\n}",
+                          "schema": "{\"type\":\"object\",\"properties\":{\"a\":{\"type\":\"string\",\"format\":\"alphanumeric\"},\"c\":{\"type\":\"integer\"}}}"
+                        }
+                      ],
+                      "responses": [
+                        {
+                          "name": "200",
+                          "description": null,
+                          "headers": null,
+                          "body": "{\n    \"status\": \"ok\"\n}",
+                          "schema": "{\"type\":\"object\",\"properties\":{\"status\":{\"type\":\"string\",\"format\":\"alphanumeric\"}}}"
+                        }
+                      ]
+                    }
+                  ]
+                }
+              ]
+            }
+          ]
+        }
+      ]
+    }
+    """
+
+  Scenario: Convert Legacy Apiary Blueprint AST into API Blueprint AST
+    When I run `apiary_blueprint_convertor legacy_ast.json`
+    Then the output should contain the content of file "apiblueprint_ast.json"  
+
+  Scenario: Convert Legacy Apiary Blueprint AST on STDIN into API Blueprint AST
+    When I run `apiary_blueprint_convertor` interactively
+    When I pipe in the file "legacy_ast.json"
+    Then the output should contain the content of file "apiblueprint_ast.json"

data/features/step_definitions/file_content_step.rb

@@ -0,0 +1,8 @@
+Then /^the output should contain the content of file "(.*)"$/ do |filename|
+  expected = nil
+  in_current_dir do
+    expected = File.read(filename)
+  end
+
+  assert_partial_output(expected, all_output)
+end

data/features/support/setup.rb

@@ -0,0 +1 @@
+require 'aruba/cucumber'

data/lib/apiary_blueprint_convertor/cli.rb

@@ -0,0 +1,65 @@
+require 'optparse'
+require 'apiary_blueprint_convertor/version'
+require 'apiary_blueprint_convertor/convertor'
+
+module ApiaryBlueprintConvertor
+  
+  class CLI
+    
+    attr_reader :command
+
+    def self.start
+      cli = CLI.new
+      options = cli.parse_options!(ARGV)
+      cli.runCommand(ARGV, options)
+    end
+
+    def runCommand(args, options)
+      command = :convert if args.first.nil? || @command.nil?
+      command = @command if @command
+
+      case command
+      when :convert
+        Convertor.convert(args.first)
+      when :version
+        puts ApiaryBlueprintConvertor::VERSION
+      else
+        CLI.help
+      end 
+    end
+
+    def parse_options!(args)
+      @command = nil
+      options = {}
+      options_parser = OptionParser.new do |opts|
+        opts.on('-v', '--version') do
+          @command = :version
+        end
+
+        opts.on( '-h', '--help') do
+          @command = :help
+        end
+      end
+
+      options_parser.parse!
+      options
+
+    rescue OptionParser::InvalidOption => e
+      puts e
+      CLI.help
+      exit 1
+    end
+
+    def self.help
+        puts "Usage: apiary_blueprint_convertor <legacy ast file>"
+        puts "\nConvert Legacy Apiary Blueprint AST into API Blueprint AST (JSON)."
+        puts "If no <legacy ast file> is specified 'apiary_blueprint_convertor' will listen on stdin."
+        
+        puts "\nOptions:\n\n"
+        puts "\t-h, --help                      Show this help"
+        puts "\t-v, --version                   Show version"
+        puts "\n"
+    end
+  end
+
+end

data/lib/apiary_blueprint_convertor/convertor.rb

@@ -0,0 +1,319 @@
+require 'json'
+require 'object'
+
+module ApiaryBlueprintConvertor
+  
+  class Convertor
+
+    API_BLUEPRONT_AST_VERSION = "1.0"
+
+    def self.read_file(file)
+      unless File.readable?(file)
+        abort "Unable to read input ast file: #{file.inspect}"
+      end      
+      input = File.read(file)
+    end
+
+    # Read file / input and convert the AST
+    def self.convert(file = nil)
+      # Read input
+      input = nil
+      if file.nil?
+        input = $stdin.read
+      else 
+        input = self.read_file(file)
+      end
+
+      if input.blank?
+        puts "Empty input, bailing out!"
+        exit
+      end
+
+      legacy_ast = JSON.parse(input).deep_symbolize_keys
+      
+      # Top level API Blueprint Template
+      blueprint_ast = {
+        :_version => API_BLUEPRONT_AST_VERSION,
+        :metadata => nil,
+        :name => nil,
+        :description => nil,
+        :resourceGroups => nil
+      }
+
+      # Run the conversion
+      convert_blueprint(legacy_ast, blueprint_ast)
+      
+      # Print output to stdou
+      puts JSON.pretty_generate(blueprint_ast)
+
+    rescue JSON::ParserError => e
+      abort("unable to parse input JSON: #{e}")
+    end
+
+    # Convert AST root
+    def self.convert_blueprint(legacy_ast, blueprint_ast)
+
+      # Location key
+      convert_location(legacy_ast[:location], blueprint_ast) if legacy_ast[:location] 
+
+      # Name key
+      blueprint_ast[:name] = legacy_ast[:name]
+
+      # Description
+      blueprint_ast[:description] = legacy_ast[:description]
+
+      # Sections
+      convert_sections(legacy_ast[:sections], legacy_ast[:validations], blueprint_ast)
+
+      # NOTE: Validations are processed in `convert_sections`.
+    end
+
+    # Convert Location / Metadata key
+    # \param location ... location to convert
+    # \param blueprint_ast ... output AST
+    def self.convert_location(legacy_location, blueprint_ast)
+      if legacy_location.blank?
+        blueprint_ast[:metadata] = nil        
+        return
+      end
+
+      blueprint_ast[:metadata] = {
+        :HOST => {
+          :value => "#{legacy_location}"
+        }
+      }
+    end
+
+    # Convert array of blueprint sections
+    # \param legacy_sections ... sections to convert
+    # \param legacy_validations ... legacy validations
+    # \param blueprint_ast ... output AST
+    def self.convert_sections(legacy_sections, legacy_validations, blueprint_ast)
+      resourceGroups = [];
+      legacy_sections.each do |legact_section|
+        group = {
+          :name => legact_section[:name],
+          :description => legact_section[:description],
+          :resources => nil
+        }
+
+        convert_resources(legact_section[:resources], legacy_validations, group)
+        resourceGroups << group
+      end
+
+      blueprint_ast[:resourceGroups] = resourceGroups unless resourceGroups.blank?
+    end
+
+    # Convert all resources of a resource group
+    # \param legacy_resources ... resources to convert
+    # \param legacy_validations ... legacy validations
+    # \param resource_group ... output resource group    
+    def self.convert_resources(legacy_resources, legacy_validations, resource_group)
+      resources = [];
+      legacy_resources.each do |legacy_resource|
+
+        resource = find_resource(resources, legacy_resource[:url])
+
+        if (resource)
+          # Existing Resource
+          add_resource_action(legacy_resource, legacy_validations, resource)
+        else 
+          # New Resource
+          resource = {
+            :name => nil,
+            :description => nil,
+            :uriTemplate => legacy_resource[:url],
+            :model => nil,
+            :parameters => nil,
+            :headers => nil,
+            :actions => nil
+          }
+          
+          add_resource_action(legacy_resource, legacy_validations, resource)
+          resources << resource
+        end
+      end
+
+      resource_group[:resources] = resources unless resources.blank?
+    end
+
+    # Look for a resource by URL in array of resources
+    # \returns the matching resource or nil
+    def self.find_resource(resources, uri_template)
+      return nil if resources.blank?
+      matches = resources.select { |resource| resource[:uriTemplate] == uri_template }
+      return matches.blank? ? nil : matches.first
+    end
+
+    # Add an action entry in resources
+    # \param legacy_resource ... resource with action to be converted
+    # \param legacy_validations ... legacy validations    
+    # \param resource ... output resource to recieve the action
+    def self.add_resource_action(legacy_resource, legacy_validations, resource)
+
+      action = find_action(resource[:actions], legacy_resource[:method])
+      if action
+        $stderr.write "Ignoring duplicate action definiton for resource '#{resource[:uriTemplate]}' and request method '#{action[:method]}'\n"
+        return
+      end
+
+      action = {
+        :name => nil,
+        :description => legacy_resource[:description],
+        :method => legacy_resource[:method],
+        :parameters => nil,
+        :headers => nil,
+        :examples => nil
+      }
+
+      add_action_example(legacy_resource, legacy_validations, action)
+
+      resource[:actions] = Array.new if resource[:actions].nil?
+      resource[:actions] << action
+    end
+
+    # Look for an action by Method in array of actions
+    # \returns the matching action or nil
+    def self.find_action(actions, method)
+      return nil if actions.blank?
+      matches = actions.select { |action| action[:method] == method }
+      return matches.blank? ? nil : matches.first
+    end
+
+    # Add an example entry in action
+    # \param legacy_resource ... resource with example to be converted
+    # \param legacy_validations ... legacy validations    
+    # \param action ... output action to recieve the example
+    def self.add_action_example(legacy_resource, legacy_validations, action)
+      example = {
+        :name => nil,
+        :description => nil,
+        :requests => nil,
+        :responses => nil
+      }
+
+      schema = resource_schema(legacy_resource, legacy_validations)
+
+      # Convert Request
+      if legacy_resource[:request] && 
+          !(legacy_resource[:request][:headers].blank? && legacy_resource[:request][:body].blank?)
+
+        request = {
+          :name => nil,
+          :description => nil,
+          :headers => create_headers_hash(legacy_resource[:request][:headers]),
+          :body => legacy_resource[:request][:body],
+          :schema => (schema) ? schema[:request] : nil
+        }
+        example[:requests] = Array.new
+        example[:requests] << request
+      end
+
+      # Convert resources
+      unless legacy_resource[:responses].blank?
+        example[:responses] = Array.new
+        
+        legacy_resource[:responses].each do |legacy_response|
+          response = {
+            :name => "#{legacy_response[:status]}",
+            :description => nil,
+            :headers => create_headers_hash(legacy_response[:headers]),
+            :body => legacy_response[:body],
+            :schema => (schema) ? schema[:response] : nil
+          }
+
+          example[:responses] << response
+        end
+      end
+
+      action[:examples] = Array.new if action[:examples].nil?
+      action[:examples] << example
+    end
+
+    # Create an API Blueprint header hash
+    # from legacy headers hash
+    def self.create_headers_hash(legacy_headers)
+      return nil if legacy_headers.blank?
+      headers = {}
+
+      legacy_headers.each do |key, value|
+        headers[key] = {
+          :value => value
+        }
+      end
+
+      headers
+    end
+
+    # Returns legacy resource validation if exists, nil otherwise
+    def self.legacy_resource_validation(legacy_resource, legacy_validations)
+      return nil if legacy_validations.blank?
+
+      matches = legacy_validations.select do |legacy_validation|
+        (legacy_validation[:url] == legacy_resource[:url] && 
+            legacy_validation[:method] == legacy_resource[:method])
+      end
+
+      return nil if matches.blank? || matches.first[:body].blank?
+
+      matches.first[:body]
+    end
+
+    # Attempt to retrieve request and response schema from legacy validations
+    # for given legacy resource
+    def self.resource_schema(legacy_resource, legacy_validations)
+
+      validation = legacy_resource_validation(legacy_resource, legacy_validations)
+      return nil if validation.blank?
+
+      # Attempt to parse validation
+      validation_hash = JSON.parse(validation)
+      validation_hash = validation_hash.deep_symbolize_keys
+
+      schema = {
+        :request => nil,
+        :response => nil
+      }
+
+      if validation_hash.nil?
+        schema[:request] = validation
+        return schema
+      end
+
+      if validation_hash[:request]
+        if validation_hash[:request].is_a?(Hash)
+          schema[:request] = validation_hash[:request].to_json          
+        else
+          schema[:request] = validation_hash[:request]
+        end
+      end
+
+      if validation_hash[:response]
+        if validation_hash[:response].is_a?(Hash)
+          schema[:response] = validation_hash[:response].to_json
+        else
+          schema[:response] = validation_hash[:response]
+        end
+      end
+
+      if validation_hash[:request].nil? && validation_hash[:response].nil?
+        schema[:request] = validation
+      end
+      return schema 
+    rescue
+      return { 
+        :request => validation,
+        :response => nil
+      }
+    end
+  end
+end
+
+
+
+
+
+
+
+
+

data/lib/apiary_blueprint_convertor/version.rb

@@ -0,0 +1,3 @@
+module ApiaryBlueprintConvertor
+  VERSION = "0.1.1"
+end

data/lib/apiary_blueprint_convertor.rb

@@ -0,0 +1,5 @@
+require "apiary_blueprint_convertor/version"
+
+module ApiaryBlueprintConvertor
+  # Your code goes here...
+end

data/lib/object.rb

@@ -0,0 +1,14 @@
+class Object
+
+  # Symbolizes keys of a hash
+  def deep_symbolize_keys
+    return self.inject({}){|memo, (k,v)| memo[k.to_sym] = v.deep_symbolize_keys; memo} if self.is_a? Hash
+    return self.inject([]){|memo, v | memo << v.deep_symbolize_keys; memo} if self.is_a? Array
+    return self
+  end
+
+  # Returns true if object is nil or empty, false otherwise
+  def blank?
+    respond_to?(:empty?) ? empty? : !self
+  end
+end

data/test/convertor_test.rb

@@ -0,0 +1,241 @@
+require 'minitest/autorun'
+require 'apiary_blueprint_convertor/convertor'
+
+class ConvertorTest < Minitest::Test
+  include ApiaryBlueprintConvertor
+
+  VALIDATIONS_AST = [{
+      :url => "/resource2",
+      :method => "POST",
+      :body => "{ \"request\": \"42\", \"response\": \"0xdeadbeef\" }"
+    },
+    {
+      :url => "/resource1",
+      :method => "GET",
+      :body => "GOOD STUFF"
+    }
+  ]
+
+  REQUEST_AST = {
+    :headers => nil,
+    :body => "A"
+  }
+
+  RESPONSES_AST = [{
+      :status => 200,
+      :headers => {
+        :'Content-Type' => "text/plain"
+      },
+      :body => "Hello World!"
+    },
+    {
+      :status => 404,
+      :headers => {
+        :'Content-Type' => "application/json",
+        :'X-Header' => "42"
+      },
+      :body => "42 not found."
+    }
+  ]
+
+  RESOURCES_AST = [{
+      :description => "Ipsum Lorem",
+      :method => "GET",
+      :url => "/resource1",
+      :request => REQUEST_AST,
+      :responses => []
+    },
+    {
+      :description => nil,
+      :method => "POST",
+      :url => "/resource2",
+      :request => REQUEST_AST,
+      :responses => RESPONSES_AST
+    },
+    {
+      :description => nil,
+      :method => "PUT",
+      :url => "/resource1",
+      :request => nil,
+      :responses => []
+    }    
+  ]
+
+  SECTIONS_AST = [{
+      :name => "Section One",
+      :description => "Lorem Ipsum",
+      :resources => []
+    },
+    {
+      :name => "Section TWO",
+      :description => nil,
+      :resources => RESOURCES_AST
+    }
+  ]
+
+  BLUEPRINT_AST = {
+    :location => "http://google.com",
+    :name => "API NAME",
+    :description => "Lorem Ipsum",
+    :sections => SECTIONS_AST,
+    :validations => VALIDATIONS_AST
+  }
+
+  def test_convert_location
+    blueprint_ast = {}
+    Convertor.convert_location("http://google.com", blueprint_ast)
+
+    assert_equal 1, blueprint_ast.keys.length
+    assert_equal :metadata, blueprint_ast.keys.first
+
+    assert_equal 1, blueprint_ast[:metadata].keys.length
+    assert_equal :HOST, blueprint_ast[:metadata].keys.first
+
+    assert_equal 1, blueprint_ast[:metadata][:HOST].keys.length
+    assert_equal :value, blueprint_ast[:metadata][:HOST].keys.first
+
+    assert_equal "http://google.com", blueprint_ast[:metadata][:HOST][:value]
+  end
+
+  def test_convert_blueprint
+    blueprint_ast = {}
+    Convertor.convert_blueprint(BLUEPRINT_AST, blueprint_ast)
+
+    assert_equal 4, blueprint_ast.keys.length
+
+    assert blueprint_ast[:metadata]
+    assert_equal "API NAME", blueprint_ast[:name]
+    assert_equal "Lorem Ipsum", blueprint_ast[:description]
+    assert blueprint_ast[:resourceGroups]
+    assert_equal 2, blueprint_ast[:resourceGroups].length
+
+    #puts "\n\n>>#{JSON.pretty_generate(blueprint_ast)}\n"
+  end
+
+  def test_convert_sections
+    blueprint_ast = {}
+    Convertor.convert_sections(SECTIONS_AST, {}, blueprint_ast)
+
+    assert_equal 1, blueprint_ast.keys.length
+    assert_equal :resourceGroups, blueprint_ast.keys.first
+    assert_instance_of Array, blueprint_ast[:resourceGroups]
+    assert_equal 2, blueprint_ast[:resourceGroups].length
+
+    assert_equal "Section One", blueprint_ast[:resourceGroups][0][:name]
+    assert_equal "Lorem Ipsum", blueprint_ast[:resourceGroups][0][:description]
+    assert_equal nil, blueprint_ast[:resourceGroups][0][:resources]
+
+    assert_equal "Section TWO", blueprint_ast[:resourceGroups][1][:name]
+    assert_equal nil, blueprint_ast[:resourceGroups][1][:description]
+    assert_instance_of Array, blueprint_ast[:resourceGroups][1][:resources]
+    assert_equal 2, blueprint_ast[:resourceGroups][1][:resources].length
+  end
+
+  def test_convert_resources
+    group_ast = {}
+    Convertor.convert_resources(RESOURCES_AST, {}, group_ast)
+
+    assert_equal 1, group_ast.keys.length
+    assert_equal :resources, group_ast.keys.first
+    assert_instance_of Array, group_ast[:resources]
+    assert_equal 2, group_ast[:resources].length
+
+    assert_equal nil, group_ast[:resources][0][:name]
+    assert_equal nil, group_ast[:resources][0][:description]
+    assert_equal "/resource1", group_ast[:resources][0][:uriTemplate]
+    assert_equal nil, group_ast[:resources][0][:model]
+    assert_equal nil, group_ast[:resources][0][:parameters]
+    assert_equal nil, group_ast[:resources][0][:headers]
+    assert group_ast[:resources][0][:actions]
+    assert_equal 2, group_ast[:resources][0][:actions].length
+
+    assert_equal nil, group_ast[:resources][1][:name]
+    assert_equal nil, group_ast[:resources][1][:description]
+    assert_equal "/resource2", group_ast[:resources][1][:uriTemplate]
+    assert_equal nil, group_ast[:resources][1][:model]
+    assert_equal nil, group_ast[:resources][1][:parameters]
+    assert_equal nil, group_ast[:resources][1][:headers]
+    assert group_ast[:resources][1][:actions]
+    assert_equal 1, group_ast[:resources][1][:actions].length
+  end
+
+  def test_add_resource_action
+    resource_ast = {}
+    Convertor.add_resource_action(RESOURCES_AST[0], {}, resource_ast)
+
+    assert resource_ast[:actions], "resource actions exists"
+    assert_equal 1, resource_ast[:actions].length
+    assert_equal "GET", resource_ast[:actions][0][:method]
+    assert_equal "Ipsum Lorem", resource_ast[:actions][0][:description]
+    assert_equal nil, resource_ast[:actions][0][:parameters]
+    assert_equal nil, resource_ast[:actions][0][:headers]
+    assert_instance_of Array, resource_ast[:actions][0][:examples]
+  end
+
+  def test_add_action_example
+    action_ast = {}
+    Convertor.add_action_example(RESOURCES_AST[1], VALIDATIONS_AST, action_ast)
+    
+    assert_instance_of Array, action_ast[:examples]
+    assert_equal 1, action_ast[:examples].length
+    assert_equal nil, action_ast[:examples][0][:name]
+    assert_equal nil, action_ast[:examples][0][:description]
+    
+    assert_instance_of Array, action_ast[:examples][0][:requests]
+    assert_equal 1, action_ast[:examples][0][:requests].length
+    assert_equal nil, action_ast[:examples][0][:requests][0][:name]
+    assert_equal nil, action_ast[:examples][0][:requests][0][:description]
+    assert_equal nil, action_ast[:examples][0][:requests][0][:headers]
+    assert_equal "A", action_ast[:examples][0][:requests][0][:body]
+    assert_equal "42", action_ast[:examples][0][:requests][0][:schema]
+
+    assert_instance_of Array, action_ast[:examples][0][:responses]
+    assert_equal 2, action_ast[:examples][0][:responses].length
+
+    assert_equal "200", action_ast[:examples][0][:responses][0][:name]
+    assert_equal nil, action_ast[:examples][0][:responses][0][:description]
+    
+    assert_instance_of Hash, action_ast[:examples][0][:responses][0][:headers]
+    assert_equal 1, action_ast[:examples][0][:responses][0][:headers].keys.length
+    assert_equal :'Content-Type', action_ast[:examples][0][:responses][0][:headers].keys[0]
+    assert_instance_of Hash, action_ast[:examples][0][:responses][0][:headers][:'Content-Type']
+    assert_equal 1, action_ast[:examples][0][:responses][0][:headers][:'Content-Type'].keys.length
+    assert_equal :value, action_ast[:examples][0][:responses][0][:headers][:'Content-Type'].keys[0]
+    assert_equal "text/plain", action_ast[:examples][0][:responses][0][:headers][:'Content-Type'][:value]
+
+    assert_equal "Hello World!", action_ast[:examples][0][:responses][0][:body]
+    assert_equal "0xdeadbeef", action_ast[:examples][0][:responses][0][:schema]
+
+    assert_equal "404", action_ast[:examples][0][:responses][1][:name]
+    assert_equal nil, action_ast[:examples][0][:responses][1][:description]
+
+    assert_instance_of Hash, action_ast[:examples][0][:responses][1][:headers]
+    assert_equal 2, action_ast[:examples][0][:responses][1][:headers].keys.length
+    
+    assert_equal :'Content-Type', action_ast[:examples][0][:responses][1][:headers].keys[0]
+    assert_instance_of Hash, action_ast[:examples][0][:responses][1][:headers][:'Content-Type']
+    assert_equal 1, action_ast[:examples][0][:responses][1][:headers][:'Content-Type'].keys.length
+    assert_equal :value, action_ast[:examples][0][:responses][1][:headers][:'Content-Type'].keys[0]
+    assert_equal "application/json", action_ast[:examples][0][:responses][1][:headers][:'Content-Type'][:value]
+
+    assert_equal :'X-Header', action_ast[:examples][0][:responses][1][:headers].keys[1]
+    assert_instance_of Hash, action_ast[:examples][0][:responses][1][:headers][:'X-Header']
+    assert_equal 1, action_ast[:examples][0][:responses][1][:headers][:'X-Header'].keys.length
+    assert_equal :value, action_ast[:examples][0][:responses][1][:headers][:'X-Header'].keys[0]
+    assert_equal "42", action_ast[:examples][0][:responses][1][:headers][:'X-Header'][:value]
+
+    assert_equal "42 not found.", action_ast[:examples][0][:responses][1][:body]
+    assert_equal "0xdeadbeef", action_ast[:examples][0][:responses][1][:schema]
+  end
+end
+
+
+
+
+
+
+
+
+
+
+

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: apiary_blueprint_convertor
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Zdenek Nemec
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Convert legacy Apiary Blueprint AST into API Blueprint AST (JSON).
+email:
+- z@apiary.io
+executables:
+- apiary_blueprint_convertor
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- apiary_blueprint_convertor.gemspec
+- bin/apiary_blueprint_convertor
+- features/convert.feature
+- features/step_definitions/file_content_step.rb
+- features/support/setup.rb
+- lib/apiary_blueprint_convertor.rb
+- lib/apiary_blueprint_convertor/cli.rb
+- lib/apiary_blueprint_convertor/convertor.rb
+- lib/apiary_blueprint_convertor/version.rb
+- lib/object.rb
+- test/convertor_test.rb
+homepage: ''
+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.2.0
+signing_key: 
+specification_version: 4
+summary: Apiary Blueprint AST convertor.
+test_files:
+- features/convert.feature
+- features/step_definitions/file_content_step.rb
+- features/support/setup.rb
+- test/convertor_test.rb