brujula 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 627bde01017a2c5a99bb77c5888f7658675204c5
+  data.tar.gz: 09b0aa8cd8ef8373365e39215c72ac2caadaee6b
+SHA512:
+  metadata.gz: 56b5d1e7b3f629efc13cd78921795dd1d0ffd30383b42d209b62258453a12ba1c708662f6853196d9bbe7be6ae6e301b41f5f256fe57d85e6870f68a99ec690e
+  data.tar.gz: 3ab91bd63e736f10fae5fdd6e5c116dd177cf56a9a270c1b3e2da214f517b3a338db8adbd2f4ff09901d8926650eb4b1bb47d62a9b5e8f59997d3bb208132dab

data/CONTRIBUTING.md

@@ -0,0 +1,9 @@
+## Contributing
+
+_TBC with more information. But for now, you know how this works_
+
+1. Fork it
+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

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "codeclimate-test-reporter", group: :test, require: nil
+
+gemspec

data/README.md

@@ -0,0 +1,64 @@
+Brújula
+========
+
+[![Build Status](https://travis-ci.org/nogates/brujula.svg?branch=master)](https://travis-ci.org/nogates/brujula)
+[![Code Climate](https://codeclimate.com/github/nogates/brujula/badges/gpa.svg)](https://codeclimate.com/github/nogates/brujula)
+[![Test Coverage](https://codeclimate.com/github/nogates/brujula/badges/coverage.svg)](https://codeclimate.com/github/nogates/brujula)
+
+_Yet another Ruby RAML parser aiming for version 1.0 fully support_
+
+# Status
+
+Brujula is still under development and not the full RAML specification is covered. Please see `SPEC_SUPPORT.md` for more information.
+
+# Use
+
+Install the gem `brujula` via your preferred method, and use `parse_file` to load and parse any RAML file
+
+```ruby
+require 'brujula'
+
+root = Brujula.parse_file('path/my_example_api.raml')
+
+# Alternatively
+
+raml = <<-RAML
+# version 1.0
+title: 'My example API'
+/examples:
+  get:
+
+RAML
+
+root = Brujula.parse(raml)
+```
+
+As expected, the properties of the root object can be accessed from the root object
+
+```ruby
+root.title
+=> 'My example API'
+```
+
+Object collections, such as Resources, Methods or Security Schemes, inherits from `Brujula::MapObject`, which implements the `Enumerable` module. Thus, you can use any of this module's method to get collection objects.
+
+```ruby
+root.resources.each_with_object([]) do |resource, resource_names|
+  resource_names << resource.name
+end
+```
+
+Alternatively, you can you use hash methods such as `[]` or `fetch` to get specific objects by its key name
+
+```ruby
+root.resources['/examples']
+```
+
+
+## Contributing
+
+Pull request are kindly requested. Specially in the form of RAML examples. If you are using some advances features of RAML 1.0 spec, like annotations, type inheritance or libraries, and you would like to help this project, please have a look at `CONTRIBUTING.md`.
+
+## License
+
+See [LICENSE](https://raw.githubusercontent.com/lonelyplanet/brujula/master/LICENSE).

data/Rakefile

@@ -0,0 +1,21 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'cucumber/rake/task'
+
+Cucumber::Rake::Task.new(:cucumber) do |t|
+  t.cucumber_opts = '--tags ~@wip'
+end
+
+RSpec::Core::RakeTask.new(:spec)
+
+# desc 'Clear tmp folders'
+# task :clobber do
+#   FileUtils.rm_rf(File.join(__dir__, 'coverage'))
+# end
+
+# Not sure why simplecov is preventing cucumber for being run after spec
+# when running rake default. That is why I am using commands to execute them
+task :default do
+  raise 'Cucumber Failed' unless system('bundle exec rake cucumber')
+  raise 'RSpec Failed'    unless system('bundle exec rake spec')
+end

data/SPEC_SUPPORT.md

@@ -0,0 +1,183 @@
+# Raml 1.0 (rc2) Specification support
+
+:white_check_mark: The feature should work as expected
+
+:warning: The feature is not completed yet (see comments)
+
+:x: The feature is not currently supported (PRs are welcome!)
+
+
+- [Raml Root](https://github.com/raml-org/raml-spec/blob/raml-10/versions/raml-10/raml-10.md/#the-root-of-the-document)
+
+Property | Status | Comments
+---|---|---
+description | :white_check_mark: |
+(annotationName)?	| :x: |
+schemas? | :warning: | Basic support. See Types support
+types? | :warning: | Basic support. See Types support
+traits?	| :white_check_mark: :warning: | Definition and merging support. Not fully tested though
+resourceTypes?	| :white_check_mark: :warning: | Definition and merging support. Not fully tested though
+annotationTypes? | :x: |
+securitySchemes? | :white_check_mark: :warning: | Definition and merging support. Not fully tested though
+uses? | :x: |
+title	| :white_check_mark: |
+version	| :white_check_mark: |
+baseUri?	| :white_check_mark: |  
+baseUriParameters? | :white_check_mark: |  
+protocols?	| :white_check_mark: |  
+mediaType? | :white_check_mark: |  
+securedBy? | :warning: | Definition and merging support. Not fully tested though
+/resources?	| :white_check_mark: |
+
+* [Raml Data Types](https://github.com/raml-org/raml-spec/blob/raml-10/versions/raml-10/raml-10.md/#raml-data-types)
+
+_TBC_
+
+* [Base URI and Base URI Parameters](https://github.com/raml-org/raml-spec/blob/raml-10/versions/raml-10/raml-10.md#base-uri-and-base-uri-parameters)
+
+:white_check_mark: Parsing Base Uri and Base parameters as collection should works as expected
+
+:warning: Template validation.
+
+:warning: These two properties should be mutually exclusive.
+
+
+* [Protocols](https://github.com/raml-org/raml-spec/blob/raml-10/versions/raml-10/raml-10.md#protocols)
+
+:white_check_mark: Parsing protocols strings should work as expected
+
+:warning: Any protocol is currently accepted as long as they are strings.
+
+* [Default Media Type](https://github.com/raml-org/raml-spec/blob/raml-10/versions/raml-10/raml-10.md#default-media-type)
+
+
+:white_check_mark: Parsing Media type and using it as default body key
+
+:warning: Media type validation
+
+* [Default Security](https://github.com/raml-org/raml-spec/blob/raml-10/versions/raml-10/raml-10.md#default-security)
+
+:x: Although parsing security schemes is supported, applying their properties to the resources and methods is not yet implemented
+
+* [Resources and Nested Resources](https://github.com/raml-org/raml-spec/blob/raml-10/versions/raml-10/raml-10.md#resources-and-nested-resources)
+
+
+Property | Status | Comments
+---|---|---
+displayName | :white_check_mark: |
+description | :white_check_mark: |
+(annotationName)?	| :x: |
+get? | :white_check_mark: |
+patch? | :white_check_mark: |
+put? | :white_check_mark: |
+post? | :white_check_mark: |
+delete? | :white_check_mark: |
+options? | :white_check_mark: |
+head?	| :white_check_mark: |
+is?	| :white_check_mark: |
+type? | :white_check_mark: |
+securedBy?	| :warning: | Merging of security scheme properties is not yet implemented
+uriParameters?	| :white_check_mark: |
+/relativeUri as resource | :white_check_mark: |
+
+
+* [Template URIs and URI Parameters](https://github.com/raml-org/raml-spec/blob/raml-10/versions/raml-10/raml-10.md#template-uris-and-uri-parameters)
+
+:warning: Parsing Uri Strings and Uri parameters as collection should works as expected
+
+:warning: Template validation.
+
+:warning: These two properties should be mutually exclusive.
+
+* [Methods](https://github.com/raml-org/raml-spec/blob/raml-10/versions/raml-10/raml-10.md#methods)
+
+
+Property | Status | Comments
+---|---|---
+displayName | :white_check_mark: |
+description | :white_check_mark: |
+(annotationName)?	| :x: |
+queryParameters? | :white_check_mark: |
+headers? | :white_check_mark: |
+queryString? | :white_check_mark: |
+responses? | :white_check_mark: |
+body? | :warning: | Same Type limitations
+protocols? | :warning: | Protocols limitations
+is?	| :white_check_mark: |
+securedBy?	| :warning: | Merging of security scheme properties is not yet implemented
+
+* [Headers](https://github.com/raml-org/raml-spec/blob/raml-10/versions/raml-10/raml-10.md#headers)
+
+:white_check_mark: Parsing Headers as a properties declaration should work as expected
+
+:warning: Needs more testing, specially using headers of array type
+
+
+* [Query Strings and Query Parameters](https://github.com/raml-org/raml-spec/blob/raml-10/versions/raml-10/raml-10.md#query-strings-and-query-parameters)
+
+:white_check_mark: Parsing Query Strings and Query parameters as collection should works as expected
+
+:warning: Template validation.
+
+:warning: These two properties should be mutually exclusive.
+
+
+* [Bodies](https://github.com/raml-org/raml-spec/blob/raml-10/versions/raml-10/raml-10.md#bodies)
+
+:white_check_mark: Body declarations using both strings (and therefore, default media type) and objects
+
+:warning: Same limitations as Raml Types
+
+* [Responses](https://github.com/raml-org/raml-spec/blob/raml-10/versions/raml-10/raml-10.md#responses)
+
+:white_check_mark: Responses should work as expected
+
+
+* [Resource Types and Traits](https://github.com/raml-org/raml-spec/blob/raml-10/versions/raml-10/raml-10.md#resource-types-and-traits)
+
+Feature | status | comments
+---|---|---
+Query Parameters, Responses, and Headers collection mergin | :white_check_mark: |
+usage description | :white_check_mark: |
+Optional properties (`/^?/`) | :warning: | Needs testing and real examples
+Algorithm of Merging Traits With Methods | :warning: | Needs testing and real examples
+Parameters (both custom and reserved parameters) | :x: |
+Modifier functions | :x: |
+
+
+* [Security Schemes](https://github.com/raml-org/raml-spec/blob/raml-10-rc2/versions/raml-10/raml-10.md#security-schemes)
+
+Type | Status | Comments
+---|---|---
+OAuth 1.0 | :white_check_mark: |
+OAuth 2.0	| :white_check_mark: |
+Basic Authentication | :white_check_mark: |
+Digest Authentication | :white_check_mark: |
+Pass Through| :white_check_mark: |
+x-{other}	| :white_check_mark: |
+null |  :white_check_mark: |
+
+
+:warning: Merging security schemes is not yet implemented. :warning:
+
+
+* [Annotations](https://github.com/raml-org/raml-spec/blob/raml-10/versions/raml-10/raml-10.md#annotations)
+
+:x: Not even started yet :x:
+
+* [Modularization](https://github.com/raml-org/raml-spec/blob/raml-10-rc2/versions/raml-10/raml-10.md#modularization)
+
+Type | Status | Comments
+---|---|---
+`!include <absolute or relative url>` as Type Fragments | :white_check_mark: |
+`!include <absolute or relative url>#<reference>` as References to inner elements | :x: |
+
+
+* [Libraries](https://github.com/raml-org/raml-spec/blob/raml-10/versions/raml-10/raml-10.md#libraries)
+
+
+:x: Not even started yet :x:
+
+* [Overlays and Extensions](https://github.com/raml-org/raml-spec/blob/raml-10/versions/raml-10/raml-10.md#overlays-and-extensions)
+
+:x: Not even started yet :x:

data/TODO.md

@@ -0,0 +1 @@
+ - Exclusion Between (BaseUri/Query)Parameters and (BaseUri/Query)String

data/lib/brujula.rb

@@ -0,0 +1,71 @@
+require 'inflecto'
+require 'pathname'
+
+require_relative 'brujula/initializers/inflecto_ramelize'
+require_relative 'brujula/initializers/yaml_include'
+
+require_relative 'brujula/object_parser'
+require_relative 'brujula/object_builder'
+require_relative 'brujula/scheme'
+require_relative 'brujula/raml'
+require_relative 'brujula/object'
+require_relative 'brujula/map_object'
+require_relative 'brujula/key'
+require_relative 'brujula/basic_type'
+require_relative 'brujula/raml/exceptions'
+
+# data transformers
+require_relative 'brujula/data_transformers/property_declaration'
+require_relative 'brujula/data_transformers/security_scheme_settings_declaration'
+require_relative 'brujula/data_transformers/body_declaration'
+
+# mergers
+require_relative 'brujula/mergers/merger'
+require_relative 'brujula/mergers/object_merger'
+require_relative 'brujula/mergers/map_object_merger'
+
+# extenders
+require_relative 'brujula/type_extender/resource'
+require_relative 'brujula/type_extender/resource_type'
+require_relative 'brujula/type_extender/method'
+
+# Definitions
+require_relative 'brujula/raml/definition'
+
+# Types
+require_relative 'brujula/raml/v1_0/array'
+require_relative 'brujula/raml/v1_0/string'
+require_relative 'brujula/raml/v1_0/markdown'
+require_relative 'brujula/raml/v1_0/media_type'
+require_relative 'brujula/raml/v1_0/uri_template'
+
+# Objects
+require_relative 'brujula/raml/v1_0/raml_type'
+require_relative 'brujula/raml/v1_0/body_type'
+require_relative 'brujula/raml/v1_0/property'
+require_relative 'brujula/raml/v1_0/trait'
+require_relative 'brujula/raml/v1_0/root'
+require_relative 'brujula/raml/v1_0/header'
+require_relative 'brujula/raml/v1_0/method'
+require_relative 'brujula/raml/v1_0/body'
+require_relative 'brujula/raml/v1_0/response'
+require_relative 'brujula/raml/v1_0/resource'
+require_relative 'brujula/raml/v1_0/resource_type'
+require_relative 'brujula/raml/v1_0/query_parameter'
+require_relative 'brujula/raml/v1_0/uri_parameter'
+require_relative 'brujula/raml/v1_0/security_scheme_part'
+require_relative 'brujula/raml/v1_0/security_scheme_settings'
+require_relative 'brujula/raml/v1_0/security_scheme'
+require_relative 'brujula/raml/v1_0/null_security_scheme'
+
+module Brujula
+  class << self
+    def parse_file(file_path)
+      Brujula::Raml::Definition.from_file(file_path)
+    end
+
+    def parse_string(string)
+      Brujula::Raml::Definition.from_string(string)
+    end
+  end
+end

data/lib/brujula/basic_type.rb

@@ -0,0 +1,46 @@
+module Brujula
+  module BasicTypeMixin
+    attr_reader :parent, :name
+  end
+
+  class BasicType
+    attr_reader :data, :as, :parent, :name
+
+    def initialize(parent: nil, data:, name:, as:)
+      @parent = parent
+      @data   = data
+      @name   = name
+      @as     = as
+    end
+
+    def expand
+      case as
+      when :boolean, :number, :any
+        data
+      else
+        base_class.new(normalized_data).tap do |instance|
+          instance.extend(BasicTypeMixin)
+          instance.define_singleton_method :parent do
+            instance_variable_get("@parent")
+          end
+          instance.instance_variable_set("@name", name)
+        end
+      end
+    end
+
+    private
+
+    def base_class
+      Brujula::Raml::V1_0.const_get(Inflecto.camelize(as.to_s))
+    end
+
+    def normalized_data
+      case as
+      when :string
+        data.to_s
+      else
+        data
+      end
+    end
+  end
+end

data/lib/brujula/data_transformers/body_declaration.rb

@@ -0,0 +1,39 @@
+require 'mime-types'
+
+module Brujula
+  module DataTransformers
+    class BodyDeclaration
+      class << self
+        def call(*args)
+          new(*args).call
+        end
+      end
+
+      attr_reader :data, :parent
+
+      def initialize(parent, data)
+        @parent = parent
+        @data   = data
+      end
+
+      def call
+        case
+        when keys_are_media_type?
+          data
+        else
+          { default_media_type => data }
+        end
+      end
+
+      private
+
+      def keys_are_media_type?
+        data.keys.all? { |key| MIME::Types[key].any? }
+      end
+
+      def default_media_type
+        parent.root.media_type || raise('Default Media Type required')
+      end
+    end
+  end
+end