redsnow 0.0.8

data/lib/redsnow/object.rb

@@ -0,0 +1,18 @@
+# Essential extensions to base object class
+module RedSnow
+  # Class from MatterCompiler as ascendant
+  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
+end

data/lib/redsnow/parseresult.rb

@@ -0,0 +1,107 @@
+module RedSnow
+
+  # Parse Result
+  # @see https://github.com/apiaryio/api-blueprint-ast/blob/master/Parse%20Result.md
+  # @param ast [Blueprint]
+  # @param error [Hash] Description of a parsing error as occurred during parsing. If this field is present and code different from 0 then the content of ast field should be ignored.
+  # @param warnings [Array<Hash>] Ordered array of parser warnings as occurred during the parsing.
+  class ParseResult
+    attr_accessor :ast
+    attr_accessor :error
+    attr_accessor :warnings
+
+    # Version key
+    VERSION_KEY = :_version
+    # Supported version of Api Blueprint
+    SUPPORTED_VERSIONS = ["2.0"]
+
+    # @param result_handle [FFI::Pointer]
+    def initialize(blueprint_handle, result_handle)
+
+      @ast = Blueprint.new(blueprint_handle)
+      warnings = RedSnow::Binding.sc_warnings_handler(result_handle)
+      warningsSize = RedSnow::Binding.sc_warnings_size(warnings)
+      @warnings = Array.new
+      for index in 0..(warningsSize - 1) do
+        sc_warning_handler = RedSnow::Binding.sc_warning_handler(warnings, index)
+
+        warning = Hash.new
+        warning[:message] = RedSnow::Binding.sc_warning_message(sc_warning_handler)
+        warning[:code] = RedSnow::Binding.sc_warning_code(sc_warning_handler)
+        warning[:ok] = RedSnow::Binding.sc_warning_ok(sc_warning_handler)
+
+        sc_location_handler = RedSnow::Binding.sc_location_handler(sc_warning_handler)
+        sc_location_size = RedSnow::Binding.sc_location_size(sc_location_handler)
+        warning[:location] = Array.new
+        if sc_location_size > 0
+          for index in 0..(sc_location_size - 1)
+            location = Location.new(sc_location_handler, index)
+            warning[:location] << location
+          end
+        end
+        @warnings << warning
+      end
+
+      error_handler = RedSnow::Binding.sc_error_handler(result_handle)
+      @error = Hash.new
+      @error[:message] = RedSnow::Binding.sc_error_message(error_handler)
+      @error[:code] = RedSnow::Binding.sc_error_code(error_handler)
+      @error[:ok] = RedSnow::Binding.sc_error_ok(error_handler)
+
+      sc_location_handler = RedSnow::Binding.sc_location_handler(error_handler)
+      sc_location_size = RedSnow::Binding.sc_location_size(sc_location_handler)
+      @error[:location] = Array.new
+      if sc_location_size > 0
+        for index in 0..(sc_location_size - 1) do
+          location = Location.new(sc_location_handler, index)
+          @error[:location] << location
+        end
+      end
+    end
+  end
+
+  # Array of possibly non-continuous blocks of the source API Blueprint.
+  # @param index [Number] Zero-based index of the character where warning has occurred.
+  # @param length [Number] Number of the characters from index where warning has occurred.
+  class Location
+
+    attr_accessor :index
+    attr_accessor :length
+
+    # @param location_hander [FFI:Pointer]
+    # @param index [Number]
+    def initialize(location_hander, index)
+      @length = RedSnow::Binding.sc_location_length(location_hander, index)
+      @index = RedSnow::Binding.sc_location_location(location_hander, index)
+    end
+
+  end
+
+  # Warnning Codes
+  # @see https://github.com/apiaryio/snowcrash/blob/master/src/SourceAnnotation.h#L128
+  class WarningCodes
+    NoWarning = 0
+    APINameWarning = 1
+    DuplicateWarning = 2
+    FormattingWarning = 3
+    RedefinitionWarning = 4
+    IgnoringWarning = 5
+    EmptyDefinitionWarning = 6
+    NotEmptyDefinitionWarning = 7
+    LogicalErrorWarning = 8
+    DeprecatedWarning = 9
+    IndentationWarning = 10
+    AmbiguityWarning = 11
+    URIWarning = 12
+
+  end
+  # Error Codes
+  # @see https://github.com/apiaryio/snowcrash/blob/master/src/SourceAnnotation.h#L113
+  class ErrorCodes
+    NoError = 0
+    ApplicationError = 1
+    BusinessError = 2
+    SymbolError = 3
+  end
+
+end

data/lib/redsnow/version.rb

@@ -0,0 +1,4 @@
+module RedSnow
+  # Gem version
+  VERSION = "0.0.8"
+end

data/provisioning.sh

@@ -0,0 +1,20 @@
+#!/bin/bash
+
+# GCC 4.7
+sudo apt-get update -y
+sudo apt-get install -y python-software-properties
+sudo add-apt-repository -y ppa:ubuntu-toolchain-r/test
+sudo apt-get update -y
+sudo apt-get install -y gcc-4.7 g++-4.7 gdb build-essential git-core curl mc vim
+sudo update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-4.6 60 --slave /usr/bin/g++ g++ /usr/bin/g++-4.6
+sudo update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-4.7 70 --slave /usr/bin/g++ g++ /usr/bin/g++-4.7
+
+#sudo update-alternatives --config gcc
+
+# Ruby
+gem install bundler
+# RVM
+curl -sSL https://get.rvm.io | bash -s stable
+/home/vagrant/.rvm/bin/rvm install 2.1.0
+rvm ruby-2.1.0
+gem install bundler

data/redsnow.gemspec

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'redsnow/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "redsnow"
+  gem.version       = RedSnow::VERSION
+  gem.authors       = ["Ladislav Prskavec"]
+  gem.email         = ["ladislav@apiary.io"]
+  gem.description   = %q{Ruby bindings for Snow Crash}
+  gem.summary       = %q{Ruby bindings for Snow Crash}
+  gem.homepage      = "https://github.com/apiaryio/redsnow"
+  gem.license       = "MIT"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.files         << Dir[ 'ext/snowcrash/**/*' ].reject { |f| f =~ /cmdline|test|features|README*|LICENSE|Gemfile*|\.xcode*/   }
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib", "ext"]
+
+  gem.required_ruby_version = '>= 1.9.3'
+
+  gem.extensions   = %w(Rakefile)
+
+  gem.add_dependency "ffi", "~> 1.9.3"
+  gem.add_dependency "rake", "~> 10.3.2"
+  gem.add_dependency "yard", "~> 0.8.7.4"
+
+  gem.add_development_dependency "shoulda"
+  gem.add_development_dependency "mocha"
+  gem.add_development_dependency "turn"
+  gem.add_development_dependency "unindent"
+
+end

data/test/_helper.rb

@@ -0,0 +1,15 @@
+require 'bundler/setup'
+
+require 'test/unit'
+require 'shoulda'
+require 'turn' unless ENV["TM_FILEPATH"] || ENV["CI"]
+require 'mocha'
+require File.join(File.expand_path('../../lib/redsnow.rb', __FILE__))
+
+class Test::Unit::TestCase
+
+  def fixture_file(name)
+    File.read File.expand_path("../fixtures/#{name}", __FILE__)
+  end
+
+end

data/test/fixtures/sample-api-ast.json

@@ -0,0 +1,97 @@
+{
+  "_version": "2.0",
+  "metadata": [
+    {
+      "name": "FORMAT",
+      "value": "1A"
+    }
+  ],
+  "name": "",
+  "description": "",
+  "resourceGroups": [
+    {
+      "name": "Messages",
+      "description": "",
+      "resources": [
+        {
+          "name": "Message",
+          "description": "",
+          "uriTemplate": "/messages/{id}",
+          "model": {},
+          "parameters": [
+            {
+              "name": "id",
+              "description": "Id of a message",
+              "type": "",
+              "required": true,
+              "default": "",
+              "example": "",
+              "values": [
+                {
+                  "value": "1"
+                },
+                {
+                  "value": "2"
+                },
+                {
+                  "value": "3"
+                }
+              ]
+            }
+          ],
+          "actions": [
+            {
+              "name": "Retrieve Message",
+              "description": "",
+              "method": "GET",
+              "parameters": [],
+              "examples": [
+                {
+                  "name": "",
+                  "description": "",
+                  "requests": [],
+                  "responses": [
+                    {
+                      "name": "200",
+                      "description": "",
+                      "headers": [
+                        {
+                          "name": "Content-Type",
+                          "value": "text/plain"
+                        }
+                      ],
+                      "body": "Hello World!\n",
+                      "schema": ""
+                    }
+                  ]
+                }
+              ]
+            },
+            {
+              "name": "Delete Message",
+              "description": "",
+              "method": "DELETE",
+              "parameters": [],
+              "examples": [
+                {
+                  "name": "",
+                  "description": "",
+                  "requests": [],
+                  "responses": [
+                    {
+                      "name": "204",
+                      "description": "",
+                      "headers": [],
+                      "body": "",
+                      "schema": ""
+                    }
+                  ]
+                }
+              ]
+            }
+          ]
+        }
+      ]
+    }
+  ]
+}

data/test/fixtures/sample-api.apib

@@ -0,0 +1,20 @@
+FORMAT: 1A
+
+# Group Messages
+
+# Message [/messages/{id}]
+
++ Parameters
+    + id ... Id of a message
+        + Values
+            + `1`
+            + `2`
+            + `3`
+
+## Retrieve Message [GET]
++ Response 200 (text/plain)
+
+        Hello World!
+
+## Delete Message [DELETE]
++ Response 204

data/test/redsnow_binding_test.rb

@@ -0,0 +1,35 @@
+require '_helper'
+
+class RedSnowBindingTest < Test::Unit::TestCase
+
+  context "RedSnow Binding" do
+    should "convert API Blueprint to AST" do
+
+      blueprint = FFI::MemoryPointer.new :pointer
+      result = FFI::MemoryPointer.new :pointer
+
+      ret = RedSnow::Binding.sc_c_parse("meta: data\nfoo:bar\n#XXXX\ndescription for it", 0, result, blueprint)
+
+      blueprint = blueprint.get_pointer(0)
+      result = result.get_pointer(0)
+      assert_equal "XXXX", RedSnow::Binding.sc_blueprint_name(blueprint)
+
+      assert_equal "description for it", RedSnow::Binding.sc_blueprint_description(blueprint)
+
+      meta_data_col = RedSnow::Binding.sc_metadata_collection_handle(blueprint)
+      assert_equal 2, RedSnow::Binding.sc_metadata_collection_size(meta_data_col)
+
+      warnings = RedSnow::Binding.sc_warnings_handler(result)
+      assert_equal 0, RedSnow::Binding.sc_warnings_size(warnings)
+
+      error = RedSnow::Binding.sc_error_handler(result)
+      assert_equal '', RedSnow::Binding.sc_error_message(error)
+      assert_equal 0, RedSnow::Binding.sc_error_code(error)
+      assert_equal 0, RedSnow::Binding.sc_error_ok(error)
+
+      RedSnow::Binding.sc_blueprint_free(blueprint)
+      RedSnow::Binding.sc_result_free(result)
+
+    end
+  end
+end

data/test/redsnow_parseresult_test.rb

@@ -0,0 +1,50 @@
+require '_helper'
+require 'unindent'
+
+class RedSnowParseResultTest < Test::Unit::TestCase
+
+  context "Simple API" do
+    setup do
+      @result = RedSnow.parse("# My API")
+    end
+
+    should "have name" do
+      assert_equal "My API", @result.ast.name
+    end
+
+    should "don't have error" do
+      assert_equal 0, @result.error[:ok]
+    end
+  end
+
+  context "Simple API with warning" do
+    setup do
+      @source = <<-STR
+        FORMAT: 1A
+        # My API
+        ## GET /
+      STR
+      @result = RedSnow.parse(@source.unindent)
+    end
+
+    should "have name" do
+      assert_equal "My API", @result.ast.name
+    end
+
+    should "don't have error" do
+      assert_equal 0, @result.error[:code]
+    end
+
+    should "have some warning" do
+      assert_equal RedSnow::WarningCodes::EmptyDefinitionWarning, @result.warnings[0][:code]
+      assert_equal "no response defined for 'GET /'", @result.warnings[0][:message]
+
+      assert_equal 20, @result.warnings[0][:location][0].index
+      assert_equal 9, @result.warnings[0][:location][0].length
+
+      assert_equal "## GET /\n", @source.unindent[20..@source.unindent.length]
+      # Line in blueprint
+      assert_equal 3, @source.unindent[0..20].lines.count
+    end
+  end
+end

data/test/redsnow_test.rb

@@ -0,0 +1,285 @@
+require '_helper'
+require 'unindent'
+
+class RedSnowParsingTest < Test::Unit::TestCase
+
+  # https://github.com/apiaryio/protagonist/blob/master/test/parser-test.coffee
+  context "API Blueprint parser" do
+
+    context "API" do
+      setup do
+        @result = RedSnow.parse("# My API")
+      end
+
+      should "have name" do
+        assert_equal "My API", @result.ast.name
+      end
+    end
+
+    context "API" do
+      setup do
+        source = <<-STR
+        **description**
+        STR
+
+        @result = RedSnow.parse(source.unindent)
+      end
+
+      should "have description" do
+        assert_equal "", @result.ast.name
+        assert_equal "**description**\n", @result.ast.description
+      end
+    end
+
+    context "Group" do
+      setup do
+        source = <<-STR
+          # Group Name
+          _description_
+        STR
+
+        @result = RedSnow.parse(source.unindent)
+      end
+      should "have resource group" do
+        assert_equal 1, @result.ast.resource_groups.count
+        assert_equal "Name", @result.ast.resource_groups[0].name
+        assert_equal "_description_\n", @result.ast.resource_groups[0].description
+      end
+    end
+
+    context "Resource" do
+
+      setup do
+
+        source = <<-STR
+          # My Resource [/resource]
+          Resource description
+
+          + Model (text/plain)
+
+                  Hello World
+
+          ## Retrieve Resource [GET]
+          Method description
+
+          + Response 200 (text/plain)
+
+            Response description
+
+            + Headers
+
+                      X-Response-Header: Fighter
+
+            + Body
+
+                      Y.T.
+
+            + Schema
+
+                      Kourier
+
+          ## Delete Resource [DELETE]
+
+          + Response 200
+
+              [My Resource][]
+
+          STR
+
+        @result = RedSnow.parse(source.unindent)
+        @resourceGroup = @result.ast.resource_groups[0]
+        @resource = @resourceGroup.resources[0]
+        @action = @resource.actions[0]
+      end
+
+      should "have resource group" do
+        assert_equal 1, @result.ast.resource_groups.count
+        assert_equal "", @resourceGroup.name
+        assert_equal "", @resourceGroup.description
+        assert_equal 1, @resourceGroup.resources.count
+      end
+
+      should "have resource" do
+        assert_equal "/resource", @resource.uri_template
+        assert_equal "My Resource", @resource.name
+        assert_equal "Resource description\n\n", @resource.description
+      end
+
+      should "have resource model" do
+        assert_equal "My Resource", @resource.model.name
+        assert_equal "", @resource.model.description
+        assert_equal "Hello World\n", @resource.model.body
+        assert_equal 1, @resource.model.headers.collection.count
+        assert_equal "Content-Type", @resource.model.headers.collection[0][:name]
+        assert_equal "text/plain", @resource.model.headers.collection[0][:value]
+      end
+
+      should "have actions" do
+        assert_equal 2, @resource.actions.count
+        assert_equal "GET", @action.method
+        assert_equal "Retrieve Resource", @action.name
+        assert_equal "Method description\n\n", @action.description
+      end
+
+    end
+
+    context "parses blueprint metadata" do
+      setup do
+        source = <<-STR
+          FORMAT: 1A
+          A: 1
+          B: 2
+          C: 3
+
+          # API Name
+        STR
+
+        @result = RedSnow.parse(source.unindent)
+        @metadata = @result.ast.metadata.collection
+      end
+
+      should "have metadata" do
+        assert_equal 'FORMAT', @metadata[0][:name]
+        assert_equal '1A', @metadata[0][:value]
+
+        assert_equal 'A', @metadata[1][:name]
+        assert_equal '1', @metadata[1][:value]
+
+        assert_equal 'B', @metadata[2][:name]
+        assert_equal '2', @metadata[2][:value]
+
+        assert_equal 'C', @metadata[3][:name]
+        assert_equal '3', @metadata[3][:value]
+      end
+    end
+
+    context "parses resource parameters" do
+      setup do
+        source = <<-STR
+        # /machine{?limit}
+
+        + Parameters
+            + limit = `20` (optional, number, `42`) ... This is a limit
+              + Values
+                  + `20`
+                  + `42`
+                  + `53`
+
+        ## GET
+
+        + Response 204
+        STR
+
+        @result = RedSnow.parse(source.unindent)
+        @resourceGroup = @result.ast.resource_groups[0]
+        @resource = @resourceGroup.resources[0]
+        @parameter = @resource.parameters.collection[0]
+        @values = @parameter.values
+      end
+
+      should "have parameters" do
+        assert_equal 'limit', @parameter.name
+        assert_equal 'This is a limit', @parameter.description
+        assert_equal 'number', @parameter.type
+        assert_equal :optional, @parameter.use
+        assert_equal '20', @parameter.default_value
+        assert_equal '42', @parameter.example_value
+        assert_equal 3, @parameter.values.count
+
+
+        assert_equal '20', @values[0]
+        assert_equal '42', @values[1]
+        assert_equal '53', @values[2]
+      end
+    end
+
+    context "parses action parameters" do
+      setup do
+        source = <<-STR
+        # GET /coupons/{id}
+
+        + Parameters
+            + id (number, `1001`) ... Id of coupon
+
+        + Response 204
+        STR
+
+        @result = RedSnow.parse(source.unindent)
+        @resourceGroup = @result.ast.resource_groups[0]
+        @resource = @resourceGroup.resources[0]
+        @action = @resource.actions[0]
+        @parameter = @action.parameters.collection[0]
+      end
+
+      should "have parameters" do
+        assert_equal 'id', @parameter.name
+        assert_equal :undefined, @parameter.use
+      end
+    end
+
+    context "parses multiple transactions" do
+      setup do
+        source = <<-STR
+        ## Notes Collection [/notes?id={id}&testingGroup={testtingGroup}&collection={collection}]
+        ### Create a Note [POST]
+        + Request Create a note
+
+            + Headers
+
+                    Content-Type: application/json
+                    Prefer: creating
+
+            + Body
+
+                    { "title": "Buy cheese and bread for breakfast." }
+
+        + Response 201 (application/json)
+
+                { "id": 3, "title": "Buy cheese and bread for breakfast." }
+
+        + Request Unable to create note
+
+            + Headers
+
+                    Content-Type: application/json
+                    Prefer: testing
+
+
+            + Body
+
+                    { "ti": "Buy cheese and bread for breakfast." }
+
+        + Response 500
+
+                { "error": "can't create record" }
+        STR
+        @result = RedSnow.parse(source.unindent)
+        @resourceGroup = @result.ast.resource_groups[0]
+        @examples = @resourceGroup.resources[0].actions[0].examples
+      end
+
+      should "have multiple requests and responses" do
+        assert_equal 2, @examples.count
+        assert_equal 1, @examples[0].requests.count
+        assert_equal 1, @examples[0].responses.count
+        assert_equal "", @examples[0].name
+        assert_equal "", @examples[0].description
+        assert_equal "Create a note", @examples[0].requests[0].name
+        assert_equal "Content-Type", @examples[0].requests[0].headers.collection[0][:name]
+        assert_equal "application/json", @examples[0].requests[0].headers.collection[0][:value]
+        assert_equal "Prefer", @examples[0].requests[0].headers.collection[1][:name]
+        assert_equal "creating", @examples[0].requests[0].headers.collection[1][:value]
+        assert_equal "201", @examples[0].responses[0].name
+        assert_equal "Unable to create note", @examples[1].requests[0].name
+        assert_equal "Content-Type", @examples[1].requests[0].headers.collection[0][:name]
+        assert_equal "application/json", @examples[1].requests[0].headers.collection[0][:value]
+        assert_equal "Prefer", @examples[1].requests[0].headers.collection[1][:name]
+        assert_equal "testing", @examples[1].requests[0].headers.collection[1][:value]
+        assert_equal '{ "ti": "Buy cheese and bread for breakfast." }' + "\n", @examples[1].requests[0].body
+        assert_equal "500", @examples[1].responses[0].name
+      end
+    end
+
+  end
+
+end