redsnow 0.0.8

data/ext/snowcrash/tools/homebrew/snowcrash.rb

@@ -0,0 +1,11 @@
+require 'formula'
+
+class Snowcrash < Formula
+  homepage 'http://apiblueprint.org'
+  head 'https://github.com/apiaryio/snowcrash.git', :tag => 'v0.12.0'
+
+  def install
+    system "./configure"
+    system "make", "install"
+  end
+end

data/ext/snowcrash/vcbuild.bat

@@ -0,0 +1,184 @@
+@echo off
+
+@rem Attribution Notice
+@rem ------------------
+@rem This file uses parts of Node.js `vcbuild.bat`.
+@rem Please refer to https://github.com/joyent/node.
+
+cd %~dp0
+
+if /i "%1"=="help" goto help
+if /i "%1"=="--help" goto help
+if /i "%1"=="-help" goto help
+if /i "%1"=="/help" goto help
+if /i "%1"=="?" goto help
+if /i "%1"=="-?" goto help
+if /i "%1"=="--?" goto help
+if /i "%1"=="/?" goto help
+
+@rem Process arguments.
+set config=Release
+set target=Build
+set target_arch=ia32
+set noprojgen=
+set nobuild=
+set test=
+
+:next-arg
+if "%1"=="" goto args-done
+if /i "%1"=="debug"         set config=Debug&goto arg-ok
+if /i "%1"=="release"       set config=Release&goto arg-ok
+if /i "%1"=="clean"         set target=Clean&goto arg-ok
+if /i "%1"=="ia32"          set target_arch=ia32&goto arg-ok
+if /i "%1"=="x86"           set target_arch=ia32&goto arg-ok
+if /i "%1"=="x64"           set target_arch=x64&goto arg-ok
+if /i "%1"=="noprojgen"     set noprojgen=1&goto arg-ok
+if /i "%1"=="nobuild"       set nobuild=1&goto arg-ok
+if /i "%1"=="test"          set test=test&goto arg-ok
+if /i "%1"=="inttest"       set inttest=1&goto arg-ok
+if /i "%1"=="MSVC2012"      set GYP_MSVS_VERSION=2012&goto arg-ok
+if /i "%1"=="MSVC2010"      set GYP_MSVS_VERSION=2010&goto arg-ok
+if /i "%1"=="MSVC2008"      set GYP_MSVS_VERSION=2008&goto arg-ok
+
+echo Warning: ignoring invalid command line option `%1`.
+
+:arg-ok
+shift
+goto next-arg
+
+:args-done
+if "%config%"=="Debug" set debug_arg=--debug
+
+:project-gen
+@rem Skip project generation if requested.
+if defined noprojgen goto msbuild
+if "%GYP_MSVS_VERSION%"=="" set GYP_MSVS_VERSION=2012
+
+@rem Generate the VS project.
+SETLOCAL
+  if defined VS100COMNTOOLS call "%VS100COMNTOOLS%\VCVarsQueryRegistry.bat"
+  if defined inttest python configure %debug_arg% --dest-cpu=%target_arch% --include-integration-tests
+  if not defined inttest python configure %debug_arg% --dest-cpu=%target_arch%
+  if errorlevel 1 goto create-msvs-files-failed
+  if not exist build/snowcrash.sln goto create-msvs-files-failed
+  echo Project files generated.
+ENDLOCAL
+
+@rem Skip to the end for now
+@rem goto exit
+
+:msbuild
+@rem Skip project generation if requested.
+if defined nobuild goto exit
+if "%GYP_MSVS_VERSION%"=="2010" goto vc-set-2010
+if "%GYP_MSVS_VERSION%"=="2008" goto vc-set-2008
+
+@rem Look for Visual Studio 2012
+if not defined VS110COMNTOOLS goto vc-set-2010
+if not exist "%VS110COMNTOOLS%\..\..\vc\vcvarsall.bat" goto vc-set-2010
+call "%VS110COMNTOOLS%\..\..\vc\vcvarsall.bat"
+if not defined VCINSTALLDIR goto msbuild-not-found
+goto msbuild-found
+
+:vc-set-2010
+if not defined VS100COMNTOOLS goto vc-set-2008
+if not exist "%VS100COMNTOOLS%\..\..\vc\vcvarsall.bat" goto vc-set-2008
+call "%VS100COMNTOOLS%\..\..\vc\vcvarsall.bat"
+if not defined VCINSTALLDIR goto msbuild-not-found
+goto msbuild-found
+
+:vc-set-2008
+if not defined VS90COMNTOOLS goto msbuild-not-found
+if not exist "%VS90COMNTOOLS%\..\..\vc\vcvarsall.bat" goto msbuild-not-found
+call "%VS90COMNTOOLS%\..\..\vc\vcvarsall.bat"
+if not defined VCINSTALLDIR goto msbuild-not-found
+goto msbuild-found
+
+:msbuild-not-found
+echo Build skipped. To build, this file needs to run from VS cmd prompt.
+goto exit
+
+:msbuild-found
+@rem Build the sln with msbuild.
+@rem Refer to http://msdn.microsoft.com/en-us/library/ms164311.aspx
+echo Building Snow Crash...
+msbuild build/snowcrash.sln /m /clp:NoSummary;NoItemAndPropertyList;Verbosity=normal /nologo /property:Configuration=%config%
+if errorlevel 1 goto exit
+
+:run
+@rem Run tests if requested.
+if "%test%"=="" goto intigration-test
+echo Running tests...
+.\build\%config%\test-libsnowcrash.exe
+
+:intigration-test
+if defined inttest goto run-integration-test
+
+@rem All Done
+goto exit
+
+:run-integration-test
+if "%config%"=="Debug" (
+SET "Replacement=      ENV['PATH'] = "../../build/Debug""
+goto :run-cucumber
+)
+SET "Replacement=      ENV['PATH'] = "../../build/Release""
+goto :run-cucumber
+
+:run-cucumber
+SET "file=features\support\env-win.rb"
+if exist "%file%" goto env-exist
+SETLOCAL ENABLEDELAYEDEXPANSION
+SET "line=require 'aruba/cucumber'"
+ECHO !line! >"%file%"
+SET "line=require 'rbconfig'"
+ECHO !line! >>"%file%"
+SET "line=Before do"
+ECHO !line! >>"%file%"
+SET "line=  @dirs << "../../features/fixtures""
+ECHO !line! >>"%file%"
+SET "line=  case RbConfig::CONFIG['host_os']"
+ECHO !line! >>"%file%"
+SET "line=    when /mswin|msys|mingw|cygwin|bccwin|wince|emc/"
+ECHO !line! >>"%file%"
+ECHO !Replacement! >>"%file%"
+SET "line=end"
+ECHO !line! >>"%file%"
+SET "line=end"
+ECHO !line! >>"%file%"
+ENDLOCAL
+
+bundle exec cucumber
+goto exit
+
+:env-exist
+SET /a Line#ToSearch=7
+(FOR /f "tokens=1*delims=:" %%a IN ('findstr /n "^" "%file%"') DO (
+    SET "Line=%%b"
+    IF %%a equ %Line#ToSearch% SET "Line=%Replacement%"
+    SETLOCAL ENABLEDELAYEDEXPANSION
+    ECHO(!Line!)
+    ENDLOCAL
+)>"%file%.new"
+MOVE "%file%.new" "%file%" >nul
+
+bundle exec cucumber
+goto exit
+
+:create-msvs-files-failed
+echo Failed to create vc project files. 
+goto exit
+
+:help
+echo vcbuild.bat [debug/release] [test] [clean] [noprojgen] [nobuild] [x86/x64] [inttest] [MSVC2008/MSVC2010/MSVC2012]
+echo Examples:
+echo   vcbuild.bat                : builds release build
+echo   vcbuild.bat nobuild        : generate MSVS project files only
+echo   vcbuild.bat debug          : builds debug build
+echo   vcbuild.bat test           : builds debug build and runs tests
+echo   vcbuild.bat inttest        : include integration tests
+echo   vcbuild.bat MSVC2012       : indicate target solution's version, could also define as MSVC2008 , MSVC2010 , MSVC2012
+goto exit
+
+:exit
+goto :EOF

data/lib/redsnow.rb

@@ -0,0 +1,31 @@
+require "redsnow/version"
+require "redsnow/binding"
+require "redsnow/blueprint"
+require "redsnow/parseresult"
+require "ffi"
+
+module RedSnow
+  include Binding
+  # parse
+  #   parsing API Blueprint into Ruby objects
+  # @param rawBlueprint [String] API Blueprint
+  # @param options [Number] Parsing Options
+  #
+  # @return [ParseResult]
+  def self.parse(rawBlueprint, options = 0)
+    blueprint = FFI::MemoryPointer.new :pointer
+    result = FFI::MemoryPointer.new :pointer
+    ret = RedSnow::Binding.sc_c_parse(rawBlueprint, options, result, blueprint)
+
+    blueprint = blueprint.get_pointer(0)
+    result = result.get_pointer(0)
+
+    parseResult = ParseResult.new(blueprint, result)
+
+    return parseResult
+  ensure
+    RedSnow::Binding.sc_blueprint_free(blueprint)
+    RedSnow::Binding.sc_result_free(result)
+  end
+
+end

data/lib/redsnow/binding.rb

@@ -0,0 +1,132 @@
+require "ffi"
+
+module RedSnow
+  # C-binding with Snow Crash Library using [FFI](https://github.com/ffi/ffi)
+  # @see https://github.com/apiaryio/snowcrash/blob/master/src/csnowcrash.cc
+  # @see https://github.com/apiaryio/snowcrash/blob/master/src/CBlueprint.cc
+  module Binding
+    extend FFI::Library
+
+    prefix = "lib.target/"
+    if FFI::Platform.mac?
+      prefix = ""
+    end
+
+    ffi_lib File.expand_path("../../../ext/snowcrash/build/out/Release/#{prefix}libsnowcrash.#{FFI::Platform::LIBSUFFIX}", __FILE__)
+    # @see https://github.com/apiaryio/snowcrash/blob/master/src/BlueprintParserCore.h#L31
+    enum :option, [
+        :render_descriptions_option,
+        :require_blueprint_name_option
+    ]
+
+    attach_function("sc_c_parse", "sc_c_parse", [ :string, :option, :pointer, :pointer ], :int)
+
+    attach_function("sc_blueprint_free", "sc_blueprint_free", [ :pointer ], :void)
+    attach_function("sc_blueprint_name", "sc_blueprint_name", [ :pointer ], :string)
+    attach_function("sc_blueprint_description", "sc_blueprint_description", [ :pointer ], :string)
+
+    attach_function("sc_metadata_collection_handle", "sc_metadata_collection_handle", [ :pointer ], :pointer)
+    attach_function("sc_metadata_collection_size", "sc_metadata_collection_size", [ :pointer ], :int)
+
+    attach_function("sc_metadata_handle", "sc_metadata_handle", [ :pointer, :int ], :pointer)
+    attach_function("sc_metadata_key", "sc_metadata_key", [ :pointer ], :string)
+    attach_function("sc_metadata_value", "sc_metadata_value",[ :pointer ], :string)
+
+    attach_function("sc_resource_groups_collection_handle", "sc_resource_groups_collection_handle", [ :pointer ], :pointer)
+    attach_function("sc_resource_groups_collection_size", "sc_resource_groups_collection_size", [ :pointer ], :int)
+
+    attach_function("sc_resource_groups_handle", "sc_resource_groups_handle", [ :pointer, :int ], :pointer)
+    attach_function("sc_resource_groups_name", "sc_resource_groups_name", [ :pointer ], :string)
+    attach_function("sc_resource_groups_description", "sc_resource_groups_description", [ :pointer ], :string)
+
+    attach_function("sc_resource_collection_handle", "sc_resource_collection_handle", [ :pointer ] , :pointer)
+    attach_function("sc_resource_collection_size", "sc_resource_collection_size", [ :pointer ], :int)
+    # Resource
+    attach_function("sc_resource_handle", "sc_resource_handle", [ :pointer, :int ] , :pointer)
+    attach_function("sc_resource_uritemplate", "sc_resource_uritemplate", [ :pointer ], :string)
+    attach_function("sc_resource_name", "sc_resource_name", [ :pointer ], :string)
+    attach_function("sc_resource_description", "sc_resource_description", [ :pointer ], :string)
+
+    attach_function("sc_payload_collection_handle_requests", "sc_payload_collection_handle_requests", [ :pointer ], :pointer)
+    attach_function("sc_payload_collection_handle_responses", "sc_payload_collection_handle_responses", [ :pointer ], :pointer)
+    attach_function("sc_payload_collection_size", "sc_payload_collection_size", [ :pointer ], :int)
+    # Resource.model
+    attach_function("sc_payload_handle", "sc_payload_handle", [ :pointer, :int ], :pointer)
+    attach_function("sc_payload_handle_resource", "sc_payload_handle_resource", [ :pointer ], :pointer)
+    attach_function("sc_payload_name", "sc_payload_name", [ :pointer ], :string)
+    attach_function("sc_payload_description", "sc_payload_description", [ :pointer ], :string)
+    attach_function("sc_payload_body", "sc_payload_body", [ :pointer ], :string)
+    attach_function("sc_payload_schema", "sc_payload_schema", [ :pointer ], :string)
+
+    attach_function("sc_parameter_collection_handle_payload", "sc_parameter_collection_handle_payload", [ :pointer ], :pointer)
+    attach_function("sc_parameter_collection_handle_resource", "sc_parameter_collection_handle_resource", [ :pointer ], :pointer)
+    attach_function("sc_parameter_collection_handle_action", "sc_parameter_collection_handle_action", [ :pointer ], :pointer)
+    attach_function("sc_parameter_collection_size", "sc_parameter_collection_size", [ :pointer ], :int)
+
+    # @see https://github.com/apiaryio/snowcrash/blob/master/src/Blueprint.h#L85
+    enum :parameter_use, [:undefined,
+                          :optional,
+                          :required,
+                         ]
+
+    attach_function("sc_parameter_handle", "sc_parameter_handle", [ :pointer, :int ], :pointer)
+    attach_function("sc_parameter_name", "sc_parameter_name", [ :pointer ], :string)
+    attach_function("sc_parameter_description", "sc_parameter_description", [ :pointer ], :string)
+    attach_function("sc_parameter_type", "sc_parameter_type", [ :pointer ], :string)
+    attach_function("sc_parameter_parameter_use", "sc_parameter_parameter_use", [ :pointer ], :parameter_use)
+    attach_function("sc_parameter_default_value", "sc_parameter_default_value", [ :pointer ], :string)
+    attach_function("sc_parameter_example_value", "sc_parameter_example_value", [ :pointer ], :string)
+
+    attach_function("sc_value_collection_handle", "sc_value_collection_handle", [ :pointer], :pointer)
+    attach_function("sc_value_collection_size", "sc_value_collection_size", [ :pointer ], :int)
+
+    attach_function("sc_value_handle", "sc_value_handle", [ :pointer, :int ], :pointer)
+    attach_function("sc_value_string", "sc_value_string", [ :pointer], :string)
+
+    attach_function("sc_header_collection_handle_payload", "sc_header_collection_handle_payload", [ :pointer ], :pointer)
+    attach_function("sc_header_collection_handle_resource", "sc_header_collection_handle_resource", [ :pointer ], :pointer)
+    attach_function("sc_header_collection_handle_action", "sc_header_collection_handle_action", [ :pointer ], :pointer)
+    attach_function("sc_header_collection_size", "sc_header_collection_size", [ :pointer ], :int)
+
+    attach_function("sc_header_handle", "sc_header_handle", [ :pointer, :int ], :pointer)
+    attach_function("sc_header_key", "sc_header_key", [ :pointer ], :string)
+    attach_function("sc_header_value", "sc_header_value", [ :pointer], :string)
+
+    attach_function("sc_action_collection_handle", "sc_action_collection_handle", [ :pointer ], :pointer)
+    attach_function("sc_action_collection_size", "sc_action_collection_size", [ :pointer], :int)
+
+    attach_function("sc_action_handle", "sc_action_handle", [ :pointer, :int ], :pointer)
+    attach_function("sc_action_httpmethod", "sc_action_httpmethod", [ :pointer], :string)
+    attach_function("sc_action_name", "sc_action_name", [ :pointer], :string)
+    attach_function("sc_action_description", "sc_action_description", [ :pointer ], :string)
+
+    attach_function("sc_transaction_example_collection_handle", "sc_transaction_example_collection_handle", [ :pointer ], :pointer)
+    attach_function("sc_transaction_example_collection_size", "sc_transaction_example_collection_size", [ :pointer ], :int)
+
+    attach_function("sc_transaction_example_handle", "sc_transaction_example_handle", [ :pointer, :int ], :pointer)
+    attach_function("sc_transaction_example_name", "sc_transaction_example_name", [ :pointer ], :string)
+    attach_function("sc_transaction_example_description", "sc_transaction_example_description", [ :pointer ], :string)
+
+    attach_function("sc_result_free", "sc_result_free", [ :pointer ], :void)
+
+    attach_function("sc_location_handler", "sc_location_handler", [ :pointer ], :pointer)
+    attach_function("sc_location_size", "sc_location_size", [ :pointer ], :int)
+    attach_function("sc_location_length", "sc_location_length", [ :pointer, :int ], :int)
+    attach_function("sc_location_location", "sc_location_location", [ :pointer, :int ], :int)
+
+    attach_function("sc_error_handler", "sc_error_handler", [ :pointer ], :pointer)
+    attach_function("sc_error_message", "sc_error_message", [ :pointer ], :string)
+    attach_function("sc_error_code", "sc_error_code", [ :pointer ], :int)
+    attach_function("sc_error_ok", "sc_error_ok", [ :pointer ], :int)
+
+    attach_function("sc_warnings_handler", "sc_warnings_handler", [ :pointer ], :pointer)
+    attach_function("sc_warnings_size", "sc_warnings_size", [ :pointer ], :int)
+    attach_function("sc_warning_handler", "sc_warning_handler", [ :pointer, :int ], :pointer)
+    attach_function("sc_warning_message", "sc_warning_message", [ :pointer ], :string)
+    attach_function("sc_warning_code", "sc_warning_code", [ :pointer], :int)
+    attach_function("sc_warning_ok", "sc_warning_ok", [ :pointer ], :int)
+
+
+  end
+
+end

data/lib/redsnow/blueprint.rb

@@ -0,0 +1,365 @@
+require "redsnow/object"
+
+# The classes in this module should be 1:1 with the Snow Crash AST
+# counterparts (https://github.com/apiaryio/snowcrash/blob/master/src/Blueprint.h).
+module RedSnow
+
+  # Blueprint AST node
+  #   Base class for API Blueprint AST nodes
+  #
+  # @abstract
+  class BlueprintNode
+  end
+
+  # Blueprint AST node with name and description associated
+  #
+  # @attr name [String] name of the node
+  # @attr description [String] description of the node
+  #
+  # @abstract
+  class NamedBlueprintNode < BlueprintNode
+
+    attr_accessor :name
+    attr_accessor :description
+
+    # Ensure the input string buffer ends with two newlines.
+    #
+    # @param buffer [String] a buffer to check
+    #   If the buffer does not ends with two newlines the newlines are added.
+    def ensure_description_newlines(buffer)
+      return if description.empty?
+
+      if description[-1, 1] != "\n"
+        buffer << "\n\n"
+      elsif description.length > 1 && description[-2, 1] != "\n"
+        buffer << "\n"
+      end
+    end
+  end
+
+  # Blueprint AST node for key-value collections
+  #
+  # @abstract
+  # @attr collection [Array<Hash>] array of key value hashes
+  class KeyValueCollection < BlueprintNode
+
+    attr_accessor :collection
+
+    # Filter collection keys
+    #
+    # @return [Array<Hash>] collection without ignored keys
+    def filter_collection(ignore_keys)
+      return @collection if ignore_keys.blank?
+      @collection.select { |kv_item| !ignore_keys.include?(kv_item.keys.first) }
+    end
+  end
+
+  # Metadata collection Blueprint AST node
+  #   represents 'metadata section'
+  class Metadata < KeyValueCollection
+    # Constructor
+    # @param sc_metadata_collection_handle [FFI::Pointer]
+    def initialize(sc_metadata_collection_handle)
+      sc_metadata_collection_size = RedSnow::Binding.sc_metadata_collection_size(sc_metadata_collection_handle)
+      if sc_metadata_collection_size > 0
+        metadata_size = sc_metadata_collection_size - 1
+        @collection = Array.new
+        for index in 0..metadata_size do
+          sc_metadata_handle = RedSnow::Binding.sc_metadata_handle(sc_metadata_collection_handle, index)
+          @collection << Hash[:name => RedSnow::Binding.sc_metadata_key(sc_metadata_handle), :value => RedSnow::Binding.sc_metadata_value(sc_metadata_handle)]
+        end
+      end
+    end
+  end
+
+  # Headers collection Blueprint AST node
+  #   represents 'headers section'
+  class Headers < KeyValueCollection
+
+    # HTTP 'Content-Type' header
+    CONTENT_TYPE_HEADER_KEY = :'Content-Type'
+
+
+    # @return [String] the value of 'Content-type' header if present or nil
+    def content_type
+      content_type_header = @collection.detect { |header| header.has_key?(CONTENT_TYPE_HEADER_KEY) }
+      return (content_type_header.nil?) ? nil : content_type_header[CONTENT_TYPE_HEADER_KEY]
+    end
+    # @param sc_header_collection_handle_payload [FFI::Pointer]
+    def initialize(sc_header_collection_handle_payload)
+      sc_header_collection_size = RedSnow::Binding.sc_header_collection_size(sc_header_collection_handle_payload)
+      if sc_header_collection_size > 0
+        headers_size = sc_header_collection_size - 1
+        @collection = Array.new
+        for index in 0..headers_size do
+          sc_header_handle = RedSnow::Binding.sc_header_handle(sc_header_collection_handle_payload, index)
+          @collection << Hash[:name => RedSnow::Binding.sc_header_key(sc_header_handle), :value => RedSnow::Binding.sc_header_value(sc_header_handle)]
+        end
+      end
+    end
+
+  end
+
+  # URI parameter Blueprint AST node
+  #   represents one 'parameters section' parameter
+  #
+  # @attr type [String] an arbitrary type of the parameter or nil
+  # @attr use [Symbol] parameter necessity flag, `:required` or `:optional`
+  # @attr default_value [String] default value of the parameter or nil
+  #   This is a value used when the parameter is ommited in the request.
+  # @attr example_value [String] example value of the parameter or nil
+  # @attr values [Array<String>] an enumeration of possible parameter values
+  class Parameter < NamedBlueprintNode
+
+    attr_accessor :type
+    attr_accessor :use
+    attr_accessor :default_value
+    attr_accessor :example_value
+    attr_accessor :values
+    # @param sc_parameter_handle [FFI::Pointer]
+    def initialize(sc_parameter_handle)
+      @name = RedSnow::Binding.sc_parameter_name(sc_parameter_handle)
+      @description = RedSnow::Binding.sc_parameter_description(sc_parameter_handle)
+      @type = RedSnow::Binding.sc_parameter_type(sc_parameter_handle)
+      @use =  RedSnow::Binding.sc_parameter_parameter_use(sc_parameter_handle)
+      @default_value = RedSnow::Binding.sc_parameter_default_value(sc_parameter_handle)
+      @example_value = RedSnow::Binding.sc_parameter_example_value(sc_parameter_handle)
+      @values = Array.new
+      sc_value_collection_handle = RedSnow::Binding.sc_value_collection_handle(sc_parameter_handle)
+      sc_value_collection_size = RedSnow::Binding.sc_value_collection_size(sc_value_collection_handle)
+      if sc_value_collection_size > 0
+        values_size = sc_value_collection_size - 1
+        for valueIndex in 0..values_size do
+          sc_value_handle = RedSnow::Binding.sc_value_handle(sc_value_collection_handle, valueIndex)
+          value = RedSnow::Binding.sc_value_string(sc_value_handle)
+          @values << value
+        end
+      end
+    end
+
+  end
+
+  # Collection of URI parameters Blueprint AST node
+  #   represents 'parameters section'
+  #
+  # @attr collection [Array<Parameter>] an array of URI parameters
+  class Parameters < BlueprintNode
+
+    attr_accessor :collection
+    # @param sc_parameter_collection_handle [FFI::Pointer]
+    def initialize(sc_parameter_collection_handle)
+      sc_parameter_collection_size = RedSnow::Binding.sc_parameter_collection_size(sc_parameter_collection_handle)
+      @collection = Array.new
+      if sc_parameter_collection_size > 0
+        parameters_size = sc_parameter_collection_size - 1
+        for index in 0..parameters_size do
+          sc_parameter_handle = RedSnow::Binding.sc_parameter_handle(sc_parameter_collection_handle, index)
+          parameter = Parameter.new(sc_parameter_handle)
+          @collection << parameter
+        end
+      end
+    end
+
+  end
+
+  # HTTP message payload Blueprint AST node
+  #   base class for 'payload sections'
+  #
+  # @abstract
+  # @attr parameters [Array] ignored
+  # @attr headers [Array<Headers>] array of HTTP header fields of the message or nil
+  # @attr body [String] HTTP-message body or nil
+  # @attr schema [String] HTTP-message body validation schema or nil
+  class Payload < NamedBlueprintNode
+
+    attr_accessor :parameters
+    attr_accessor :headers
+    attr_accessor :body
+    attr_accessor :schema
+    # @param sc_payload_handle_resource [FFI::Pointer]
+    def initialize(sc_payload_handle_resource)
+      @name = RedSnow::Binding.sc_payload_name(sc_payload_handle_resource)
+      @description = RedSnow::Binding.sc_payload_description(sc_payload_handle_resource)
+      @body = RedSnow::Binding.sc_payload_body(sc_payload_handle_resource)
+      @schema = RedSnow::Binding.sc_payload_schema(sc_payload_handle_resource)
+
+      sc_header_collection_handle_payload = RedSnow::Binding.sc_header_collection_handle_payload(sc_payload_handle_resource)
+      @headers = Headers.new(sc_header_collection_handle_payload)
+    end
+
+  end
+
+  # Transaction example Blueprint AST node
+  #
+  # @attr requests [Array<Request>] example request payloads
+  # @attr response [Array<Response>] example response payloads
+  class TransactionExample < NamedBlueprintNode
+
+    attr_accessor :requests
+    attr_accessor :responses
+    # @param sc_transaction_example_handle [FFI::Pointer]
+    def initialize(sc_transaction_example_handle)
+      @name  = RedSnow::Binding.sc_transaction_example_name(sc_transaction_example_handle)
+      @description = RedSnow::Binding.sc_transaction_example_description(sc_transaction_example_handle)
+      # BP Resource Actions Examples Requests
+      @requests = Array.new
+      sc_payload_collection_handle_requests = RedSnow::Binding.sc_payload_collection_handle_requests(sc_transaction_example_handle)
+      sc_payload_collection_size_requests = RedSnow::Binding.sc_payload_collection_size(sc_payload_collection_handle_requests)
+      if sc_payload_collection_size_requests > 0
+        requests_size = sc_payload_collection_size_requests - 1
+        for index in 0..requests_size do
+          request = Payload.new(RedSnow::Binding.sc_payload_handle(sc_payload_collection_handle_requests, index))
+          @requests << request
+        end
+      end
+      # BP Resource Actions Examples Responses
+      @responses = Array.new
+      sc_payload_collection_handle_responses = RedSnow::Binding.sc_payload_collection_handle_responses(sc_transaction_example_handle)
+      sc_payload_collection_size_responses = RedSnow::Binding.sc_payload_collection_size(sc_payload_collection_handle_responses)
+      if sc_payload_collection_size_responses > 0
+        responses_size = sc_payload_collection_size_responses - 1
+        for index in 0..responses_size do
+          response = Payload.new(RedSnow::Binding.sc_payload_handle(sc_payload_collection_handle_responses, index))
+          @responses << response
+        end
+      end
+
+    end
+
+  end
+
+  # Action Blueprint AST node
+  #   represetns 'action sction'
+  #
+  # @attr method [String] HTTP request method or nil
+  # @attr parameters [Parameters] action-specific URI parameters or nil
+  # @attr examples [Array<TransactionExample>] action transaction examples
+  class Action < NamedBlueprintNode
+
+    attr_accessor :method
+    attr_accessor :parameters
+    attr_accessor :examples
+    # @param sc_action_handle [FFI::Pointer]
+    def initialize(sc_action_handle)
+      @name = RedSnow::Binding.sc_action_name(sc_action_handle)
+      @description = RedSnow::Binding.sc_action_description(sc_action_handle)
+
+      @method = RedSnow::Binding.sc_action_httpmethod(sc_action_handle)
+
+      @parameters = Parameters.new(RedSnow::Binding.sc_parameter_collection_handle_action(sc_action_handle))
+
+      @examples = Array.new
+      sc_transaction_example_collection_handle = RedSnow::Binding.sc_transaction_example_collection_handle(sc_action_handle)
+      sc_transaction_example_collection_size = RedSnow::Binding.sc_transaction_example_collection_size(sc_transaction_example_collection_handle)
+      if sc_transaction_example_collection_size > 0
+        examples_size = sc_transaction_example_collection_size - 1
+        for index in 0..examples_size do
+          example = TransactionExample.new(RedSnow::Binding.sc_transaction_example_handle(sc_transaction_example_collection_handle, index))
+          @examples << example
+        end
+      end
+    end
+
+  end
+
+  # Resource Blueprint AST node
+  #   represents 'resource section'
+  #
+  # @attr uri_template [String] RFC 6570 URI template
+  # @attr model [Model] model payload for the resource or nil
+  # @attr parameters [Parameters] action-specific URI parameters or nil
+  # @attr actions [Array<Action>] array of resource actions or nil
+  class Resource < NamedBlueprintNode
+
+    attr_accessor :uri_template
+    attr_accessor :model
+    attr_accessor :parameters
+    attr_accessor :actions
+    # @param sc_resource_handle [FFI::Pointer]
+    def initialize(sc_resource_handle)
+      @name = RedSnow::Binding.sc_resource_name(sc_resource_handle)
+      @description = RedSnow::Binding.sc_resource_description(sc_resource_handle)
+      @uri_template = RedSnow::Binding.sc_resource_uritemplate(sc_resource_handle)
+
+      sc_payload_handle_resource = RedSnow::Binding.sc_payload_handle_resource(sc_resource_handle)
+      @model = Payload.new(sc_payload_handle_resource)
+
+      @actions = Array.new
+      sc_action_collection_handle = RedSnow::Binding.sc_action_collection_handle(sc_resource_handle)
+      sc_action_collection_size = RedSnow::Binding.sc_action_collection_size(sc_action_collection_handle)
+      if sc_action_collection_size > 0
+        action_size = sc_action_collection_size - 1
+        for index in 0..action_size do
+          @actions << Action.new(RedSnow::Binding.sc_action_handle(sc_action_collection_handle, index))
+        end
+      end
+      @parameters = Parameters.new(RedSnow::Binding.sc_parameter_collection_handle_resource(sc_resource_handle))
+    end
+
+  end
+
+  # Resource group Blueprint AST node
+  #   represents 'resource group section'
+  #
+  # @attr resources [Array<Resource>] array of resources in the group
+  class ResourceGroup < NamedBlueprintNode
+
+    attr_accessor :resources
+    # @param sc_resource_groups_handle [FFI::Pointer]
+    def initialize(sc_resource_groups_handle)
+      @name = RedSnow::Binding.sc_resource_groups_name(sc_resource_groups_handle)
+      @description = RedSnow::Binding.sc_resource_groups_description(sc_resource_groups_handle)
+
+      @resources = Array.new
+      sc_resource_collection_handle = RedSnow::Binding.sc_resource_collection_handle(sc_resource_groups_handle)
+      sc_resource_collection_size = RedSnow::Binding.sc_resource_collection_size(sc_resource_collection_handle)
+      if sc_resource_collection_size > 0
+        resource_size = sc_resource_collection_size - 1
+        for index in 0..resource_size do
+          sc_resource_handle = RedSnow::Binding.sc_resource_handle(sc_resource_collection_handle, index)
+          res = Resource.new(sc_resource_handle)
+        end
+      end
+      @resources << res
+    end
+
+  end
+
+
+  # Top-level Blueprint AST node
+  #   represents 'blueprint section'
+  #
+  # @attr metadata [Metadata] tool-specific metadata collection or nil
+  # @attr resource_groups [Array<ResourceGroup>] array of blueprint resource groups
+  class Blueprint < NamedBlueprintNode
+
+    attr_accessor :metadata
+    attr_accessor :resource_groups
+    # Version key
+    VERSION_KEY = :_version
+    # Supported version of Api Blueprint
+    SUPPORTED_VERSIONS = ["2.0"]
+    # @param handle [FFI:Pointer]
+    def initialize(handle)
+      # BP name, desc
+      @name = RedSnow::Binding.sc_blueprint_name(handle)
+      @description = RedSnow::Binding.sc_blueprint_description(handle)
+
+      # BP metadata
+      sc_metadata_collection_handle = RedSnow::Binding.sc_metadata_collection_handle(handle)
+      @metadata = Metadata.new(sc_metadata_collection_handle)
+
+      # BP Resource Groups
+      sc_resource_groups_collection_handle = RedSnow::Binding.sc_resource_groups_collection_handle(handle)
+      sc_resource_groups_collection_size = RedSnow::Binding.sc_resource_groups_collection_size(sc_resource_groups_collection_handle)
+      @resource_groups = Array.new
+      if sc_resource_groups_collection_size > 0
+        group_size = sc_resource_groups_collection_size - 1
+        for index in 0..group_size do
+          sc_resource_groups_handle = RedSnow::Binding.sc_resource_groups_handle(sc_resource_groups_collection_handle, index)
+          @resource_groups << ResourceGroup.new(sc_resource_groups_handle)
+        end
+      end
+    end
+  end
+end