raml-rb 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5c055a6b5ac11a427a84bf58f3dd22d1d366c91d
+  data.tar.gz: efeb25b9f8bb5004c9f5f65d50264285739c1bee
+SHA512:
+  metadata.gz: 0ceb137a50546a1a0ebbd5cdd3b30f3f62214cf46dc3084a5da2bdc3717b042c49a45b584e483089f64db07c5941a26425d1471e2535cf6facf92a86e3879687
+  data.tar.gz: 561a64c167180a4b151e644692730197c0b565c1d76342387e269a0c341c839ce189734eb14e28eb565cd55f9372dc23add0764ce069d62d49bf92785844ea56

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--warnings
+--require spec_helper

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in raml-rb.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 James Brennan
+
+MIT License
+
+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,20 @@
+# raml-rb
+
+A RAML parser, implemented in Ruby.
+
+## Usage
+
+```
+raml = Raml::Parser.parse("#%RAML 0.8\ntitle: World Music API\nbaseUri: http://example.api.com/{version}")
+raml = Rank::Parser.parse_file('path/to/file.raml')
+```
+
+## Todo
+
+0. Parameters for Resource Types and Traits.
+0. Ensure all attributes are supported.
+0. Add documentation generator.
+
+## Author
+
+James Brennan (james@jamesbrennan.ca)

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require 'raml'
+  ARGV.clear
+  IRB.start
+end

data/lib/raml/body.rb

@@ -0,0 +1,10 @@
+module Raml
+  class Body
+    attr_accessor :type, :schema
+
+    def initialize(type)
+      @type = type
+    end
+
+  end
+end

data/lib/raml/documentation.rb

@@ -0,0 +1,5 @@
+module Raml
+  class Documentation
+    attr_accessor :title, :content
+  end
+end

data/lib/raml/errors/unknown_attribute_error.rb

@@ -0,0 +1,4 @@
+module Raml
+  class UnknownAttributeError < StandardError
+  end
+end

data/lib/raml/method.rb

@@ -0,0 +1,13 @@
+module Raml
+  class Method
+
+    attr_accessor :method, :description, :headers, :responses, :query_parameters
+
+    def initialize(method)
+      @method = method
+      @responses = []
+      @query_parameters = []
+    end
+
+  end
+end

data/lib/raml/parser/body.rb

@@ -0,0 +1,38 @@
+require 'raml/body'
+require 'raml/parser/util'
+require 'raml/errors/unknown_attribute_error'
+
+module Raml
+  class Parser
+    class Body
+      include Raml::Parser::Util
+
+      BASIC_ATTRIBUTES = %w[schema]
+
+      attr_accessor :body, :attributes
+
+      def parse(type, attributes)
+        @body = Raml::Body.new(type)
+        @attributes = prepare_attributes(attributes)
+
+        parse_attributes
+
+        body
+      end
+
+      private
+
+        def parse_attributes
+          attributes.each do |key, value|
+            case key
+            when *BASIC_ATTRIBUTES
+              body.send("#{key}=".to_sym, value)
+            else
+              raise UnknownAttributeError.new "Unknown body key: #{key}"
+            end
+          end if attributes
+        end
+
+    end
+  end
+end

data/lib/raml/parser/documentation.rb

@@ -0,0 +1,37 @@
+require 'raml/documentation'
+require 'raml/errors/unknown_attribute_error'
+
+module Raml
+  class Parser
+    class Documentation
+      include Raml::Parser::Util
+
+      BASIC_ATTRIBUTES = %w[title content]
+
+      attr_accessor :documentation, :attributes
+
+      def parse(attributes)
+        @documentation = Raml::Documentation.new
+        @attributes = prepare_attributes(attributes)
+
+        parse_attributes
+
+        documentation
+      end
+
+      private
+
+        def parse_attributes
+          attributes.each do |key, value|
+            case key
+            when *BASIC_ATTRIBUTES
+              documentation.send("#{key}=".to_sym, value)
+            else
+              raise UnknownAttributeError.new "Unknown documentation key: #{key}"
+            end
+          end if attributes
+        end
+
+    end
+  end
+end

data/lib/raml/parser/method.rb

@@ -0,0 +1,83 @@
+require 'forwardable'
+require 'raml/method'
+require 'raml/parser/response'
+require 'raml/parser/query_parameter'
+require 'raml/parser/util'
+require 'raml/errors/unknown_attribute_error'
+
+module Raml
+  class Parser
+    class Method
+      extend Forwardable
+      include Raml::Parser::Util
+
+      BASIC_ATTRIBUTES = %w[description headers]
+
+      attr_accessor :method, :parent, :attributes
+      def_delegators :@parent, :traits
+
+      def initialize(parent)
+        @parent = parent
+      end
+
+      def parse(the_method, attributes)
+        @method = Raml::Method.new(the_method)
+        @attributes = prepare_attributes(attributes)
+
+        apply_parents_traits
+        parse_attributes
+
+        method
+      end
+
+      private
+
+        def parse_attributes(attributes = @attributes)
+          attributes.each do |key, value|
+            case key
+            when *BASIC_ATTRIBUTES
+              method.send("#{key}=".to_sym, value)
+            when 'is'
+              apply_traits(value)
+            when 'responses'
+              parse_responses(value)
+            when 'query_parameters'
+              parse_query_parameters(value)
+            else
+              raise UnknownAttributeError.new "Unknown method key: #{key}"
+            end
+          end if attributes
+        end
+
+        def parse_responses(responses)
+          responses.each do |code, response_attributes|
+            method.responses << Raml::Parser::Response.new.parse(code, response_attributes)
+          end
+        end
+
+        def parse_query_parameters(query_parameters)
+          query_parameters.each do |name, parameter_attributes|
+            method.query_parameters << Raml::Parser::QueryParameter.new.parse(name, parameter_attributes)
+          end
+        end
+
+        def apply_parents_traits
+          apply_traits(parent.trait_names) if !parent.trait_names.nil? && parent.trait_names.length
+        end
+
+        def apply_traits(names)
+          names.each do |name|
+            apply_trait(name)
+          end
+        end
+
+        def apply_trait(name)
+          unless traits[name].nil?
+            trait_attributes = prepare_attributes(traits[name])
+            parse_attributes(trait_attributes)
+          end
+        end
+
+    end
+  end
+end

data/lib/raml/parser/query_parameter.rb

@@ -0,0 +1,39 @@
+require 'raml/parser/util'
+require 'raml/query_parameter'
+require 'raml/errors/unknown_attribute_error'
+
+module Raml
+  class Parser
+    class QueryParameter
+      include Raml::Parser::Util
+
+      BASIC_ATTRIBUTES = %w[description type example]
+
+      attr_accessor :query_parameter, :attributes
+
+      def parse(name, attributes)
+        @query_parameter = Raml::QueryParameter.new(name)
+
+        @attributes = prepare_attributes(attributes)
+        parse_attributes(attributes)
+
+        query_parameter
+      end
+
+      private
+
+        def parse_attributes(attributes)
+          attributes.each do |key, value|
+            key = underscore(key)
+            case key
+            when *BASIC_ATTRIBUTES
+              query_parameter.send("#{key}=".to_sym, value)
+            else
+              raise UnknownAttributeError.new "Unknown query paramter key: #{key}"
+            end
+          end if attributes
+        end
+
+    end
+  end
+end

data/lib/raml/parser/resource.rb

@@ -0,0 +1,60 @@
+require 'forwardable'
+require 'raml/resource'
+require 'raml/parser/method'
+require 'raml/parser/util'
+require 'raml/errors/unknown_attribute_error'
+
+module Raml
+  class Parser
+    class Resource
+      extend Forwardable
+      include Raml::Parser::Util
+
+      METHODS = %w[get put post delete]
+
+      attr_accessor :parent_node, :resource, :trait_names, :attributes
+      def_delegators :@parent_node, :resources
+      def_delegators :@parent, :traits, :resource_types
+
+      def initialize(parent)
+        @parent = parent
+      end
+
+      def parse(parent_node, uri_partial, attributes)
+        @parent_node = parent_node
+        @resource = Raml::Resource.new(@parent_node, uri_partial)
+        @attributes = prepare_attributes(attributes)
+        parse_attributes
+        resource
+      end
+
+      private
+
+        def parse_attributes(attributes = @attributes)
+          attributes.each do |key, value|
+            key = underscore(key)
+            case key
+            when /^\//
+              resources << Raml::Parser::Resource.new(self).parse(resource, key, value)
+            when *METHODS
+              resource.methods << Raml::Parser::Method.new(self).parse(key, value)
+            when 'type'
+              apply_resource_type(value)
+            when 'is'
+              @trait_names = value
+            else
+              raise UnknownAttributeError.new "Unknown resource key: #{key}"
+            end
+          end if attributes
+        end
+
+        def apply_resource_type(name)
+          unless resource_types[name].nil?
+            resource_attributes = prepare_attributes(resource_types[name])
+            parse_attributes(resource_attributes)
+          end
+        end
+
+    end
+  end
+end

data/lib/raml/parser/response.rb

@@ -0,0 +1,42 @@
+require 'raml/response'
+require 'raml/parser/util'
+require 'raml/parser/body'
+require 'raml/errors/unknown_attribute_error'
+
+module Raml
+  class Parser
+    class Response
+      include Raml::Parser::Util
+
+      attr_accessor :response, :attributes
+
+      def parse(code, attributes)
+        @response = Raml::Response.new(code)
+        @attributes = prepare_attributes(attributes)
+        parse_attributes
+        response
+      end
+
+      private
+
+        def parse_attributes
+          attributes.each do |key, value|
+            key = underscore(key)
+            case key
+            when 'body'
+              parse_bodies(value)
+            else
+              raise UnknownAttributeError.new "Unknown response key: #{key}"
+            end
+          end if attributes
+        end
+
+        def parse_bodies(bodies)
+          bodies.each do |type, body_attributes|
+            response.bodies << Raml::Parser::Body.new.parse(type, body_attributes)
+          end
+        end
+
+    end
+  end
+end

data/lib/raml/parser/root.rb

@@ -0,0 +1,73 @@
+require 'raml/root'
+require 'raml/parser/resource'
+require 'raml/parser/documentation'
+require 'raml/parser/util'
+require 'raml/errors/unknown_attribute_error'
+
+module Raml
+  class Parser
+    class Root
+      include Raml::Parser::Util
+
+      BASIC_ATTRIBUTES = %w[title base_uri version]
+
+      attr_accessor :root, :traits, :resource_types, :attributes
+
+      def initialize
+        @traits = {}
+      end
+
+      def parse(attributes)
+        @root = Raml::Root.new
+        @attributes = prepare_attributes(attributes)
+        parse_attributes
+        root
+      end
+
+      private
+
+        def parse_attributes
+          attributes.each do |key, value|
+            key = underscore(key)
+            case key
+            when *BASIC_ATTRIBUTES
+              root.send("#{key}=".to_sym, value)
+            when 'traits'
+              parse_traits(value)
+            when 'resource_types'
+              parse_resource_types(value)
+            when 'documentation'
+              parse_documentation(value)
+            when /^\//
+              root.resources << Raml::Parser::Resource.new(self).parse(root, key, value)
+            else
+              raise UnknownAttributeError.new "Unknown root key: #{key}"
+            end
+          end if attributes
+        end
+
+        def parse_documentation(documentations)
+          documentations.each do |documentation_attributes|
+            root.documentations << Raml::Parser::Documentation.new.parse(documentation_attributes)
+          end
+        end
+
+        def parse_resource_types(resource_types)
+          resource_types.each do |type|
+            type.each do |name, type_attributes|
+              @resource_types[name] = type_attributes
+            end
+          end
+        end
+
+        def parse_traits(traits)
+          traits.each do |trait|
+            trait.each do |name, trait_attributes|
+              @traits[name] = trait_attributes
+            end
+          end
+        end
+
+    end
+  end
+end

data/lib/raml/parser/util.rb

@@ -0,0 +1,31 @@
+module Raml
+  class Parser
+    module Util
+
+      private
+
+        def prepare_attributes(attributes)
+          hash = {}
+          attributes.each do |key, value|
+            hash[underscore(key)] = parse_value(value)
+          end if attributes.respond_to?(:each)
+          hash
+        end
+
+        def parse_value(value)
+          if value.is_a?(String) && value.strip.start_with?('include!')
+            File.read value.match(/include!(.*)/)[1].strip
+          else
+            value
+          end
+        end
+
+        def underscore(string)
+          string.gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
+            .gsub(/([a-z\d])([A-Z])/,'\1_\2')
+            .downcase
+        end
+
+    end
+  end
+end

data/lib/raml/parser.rb

@@ -0,0 +1,30 @@
+require 'yaml'
+require 'raml/parser/root'
+require 'raml/parser/resource'
+require 'raml/parser/method'
+require 'raml/parser/response'
+require 'raml/parser/body'
+require 'raml/parser/query_parameter'
+
+module Raml
+  class Parser
+
+    def parse(yaml)
+      raml = YAML.load(yaml)
+      Raml::Parser::Root.new.parse(raml)
+    end
+
+    def parse_file(path)
+      parse File.read(path)
+    end
+
+    def self.parse(yaml)
+      self.new.parse(yaml)
+    end
+
+    def self.parse_file(path)
+      self.new.parse_file(path)
+    end
+
+  end
+end

data/lib/raml/query_parameter.rb

@@ -0,0 +1,10 @@
+module Raml
+  class QueryParameter
+    attr_accessor :name, :description, :type, :example
+
+    def initialize(name)
+      @name = name
+    end
+
+  end
+end

data/lib/raml/resource.rb

@@ -0,0 +1,16 @@
+module Raml
+  class Resource
+    attr_accessor :parent, :methods, :uri_partial
+
+    def initialize(parent, uri_partial)
+      @parent = parent
+      @uri_partial = uri_partial
+      @methods = []
+    end
+
+    def uri
+      File.join(parent.uri, uri_partial)
+    end
+
+  end
+end

data/lib/raml/response.rb

@@ -0,0 +1,11 @@
+module Raml
+  class Response
+    attr_accessor :code, :bodies
+
+    def initialize(code)
+      @code = code
+      @bodies = []
+    end
+
+  end
+end

data/lib/raml/root.rb

@@ -0,0 +1,15 @@
+module Raml
+  class Root
+    attr_accessor :title, :base_uri, :version, :resources, :documentation
+
+    def initialize
+      @resources = []
+      @documentation = []
+    end
+
+    def uri
+      base_uri.sub('{version}', version.to_s)
+    end
+
+  end
+end

data/lib/raml/version.rb

@@ -0,0 +1,3 @@
+module Raml
+  VERSION = '0.0.2'
+end

data/lib/raml-rb.rb

@@ -0,0 +1 @@
+require 'raml'

data/lib/raml.rb

@@ -0,0 +1,12 @@
+require 'raml/version'
+require 'raml/parser'
+require 'raml/errors/unknown_attribute_error'
+require 'raml/root'
+require 'raml/resource'
+require 'raml/method'
+require 'raml/response'
+require 'raml/body'
+require 'raml/query_parameter'
+
+module Raml
+end

data/raml-rb.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'raml/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'raml-rb'
+  spec.version       = Raml::VERSION
+  spec.authors       = ['James Brennan']
+  spec.email         = ['james@jamesbrennan.ca']
+  spec.summary       = %q{A RAML parser implemented in Ruby}
+  spec.homepage      = 'https://github.com/jpb/raml-rb'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split("\n")
+  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.6'
+  spec.add_development_dependency 'rake',       '~>10.3'
+  spec.add_development_dependency 'rspec',      '~> 3.0'
+  spec.add_development_dependency 'rspec-its',  '~> 1.0'
+end