raml-rb 0.0.6 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6b89803dbf18a158ddc7f781c03b1b5b8b266f89
-  data.tar.gz: 3f97e128ffddc9f7f6db4cad8b741115619876ea
+  metadata.gz: df2e4d4523124e124d26a17682ad25e97bafeb1f
+  data.tar.gz: 57fecb9fa9a2195963b4918381da41699cb4ccaf
 SHA512:
-  metadata.gz: 1f55464b58630ad4e0e50bbfcdf7ed2b4cce179eb29b8a7a87d7b373dc174dac0398227ef16b48027b31bfa78852f65d20bd88816688fa8e2ad7476ff55371b7
-  data.tar.gz: 1c796472b8a9cbe85c1442d6662e36d9ed4809c38c3619e80637577865cbcd5244ae5c75f3fe3c02fef49621f49341ee13870c2045ad41f7fb8b0905b3bbf443
+  metadata.gz: b2138442d6609232fa226ec002f5143a404ab3c023252eeec71dbc6e58e9695f2bd848577a90362b42e3dbeebbb92b7c578e6d5c694812f00a4ef67edee2bc2b
+  data.tar.gz: 958813a38ecd31dad8d8c6dd588dfa1af9b907d9504346d693769d953cbe6edcf8b02fefa98759b4d2a9ec10efaa8760ddfafee223ff7dbea57d89690c030d78

data/lib/raml/parser/resource.rb

@@ -11,7 +11,7 @@ module Raml
       extend Forwardable
       include Raml::Parser::Util
 
-      METHODS = %w[get put post delete]
+      HTTP_METHODS = %w[get put post delete]
 
       attr_accessor :parent_node, :resource, :trait_names, :attributes
       def_delegators :@parent, :traits, :resource_types
@@ -37,8 +37,8 @@ module Raml
             case key
             when /^\//
               resource.resources << Raml::Parser::Resource.new(self).parse(resource, key, value)
-            when *METHODS
-              resource.methods << Raml::Parser::Method.new(self).parse(key, value)
+            when *HTTP_METHODS
+              resource.http_methods << Raml::Parser::Method.new(self).parse(key, value)
             when 'is'
               @trait_names = value
             else

data/lib/raml/parser/root.rb

@@ -9,7 +9,7 @@ module Raml
     class Root
       include Raml::Parser::Util
 
-      BASIC_ATTRIBUTES = %w[title base_uri version base_uri_parameters media_type]
+      BASIC_ATTRIBUTES = %w[title base_uri version base_uri_parameters media_type secured_by security_schemes]
 
       attr_accessor :root, :traits, :resource_types, :attributes
 

data/lib/raml/resource.rb

@@ -1,12 +1,12 @@
 module Raml
   class Resource
-    attr_accessor :parent, :methods, :uri_partial, :resources
+    attr_accessor :parent, :http_methods, :uri_partial, :resources
 
     def initialize(parent, uri_partial)
-      @parent      = parent
-      @uri_partial = uri_partial
-      @methods     = []
-      @resources   = []
+      @parent       = parent
+      @uri_partial  = uri_partial
+      @http_methods = []
+      @resources    = []
     end
 
     def path

data/lib/raml/root.rb

@@ -1,7 +1,7 @@
 module Raml
   class Root
     attr_accessor :title, :base_uri, :version, :resources, :documentation,
-                  :base_uri_parameters, :media_type
+                  :base_uri_parameters, :media_type, :security_schemes, :secured_by
 
     def initialize
       @resources = []

data/lib/raml/version.rb

@@ -1,3 +1,3 @@
 module Raml
-  VERSION = '0.0.6'
+  VERSION = '1.0.0'
 end

data/spec/fixtures/all-the-things.raml

@@ -12,6 +12,16 @@ documentation:
   - title: RAML Baml
     content: |
       - Project: [source code](https://github.com/jpb/raml-rb)
+securedBy: [ authenticationHeader ]
+securitySchemes:
+  - authenticationHeader:
+    describedBy:
+      headers:
+        Authorization:
+          type: string
+        responses:
+          401:
+            description: Authentication required
 traits:
   - paged:
       queryParameters:

data/spec/fixtures/basic.raml

@@ -8,6 +8,16 @@ baseUriParameters:
     type: String
 version: v1
 mediaType: application/json
+securedBy: [ authenticationHeader ]
+securitySchemes:
+  - authenticationHeader:
+    describedBy:
+      headers:
+        Authorization:
+          type: string
+        responses:
+          401:
+            description: Authentication required
 traits:
   - paged:
       queryParameters:

data/spec/lib/raml/parser/root_spec.rb

@@ -15,24 +15,25 @@ describe Raml::Parser::Root do
       should == {"environment" => { "description"=>"The deployed environment", "type"=>"String" }}
     end
     its(:media_type) { should == "application/json" }
+    its(:secured_by) { should == [ "authenticationHeader" ] }
     its('resources.count') { should == 1 }
-    its('resources.first.methods.count') { should == 2 }
-    its('resources.first.methods.first.responses.count') { should == 0 }
-    its('resources.first.methods.first.query_parameters.count') { should == 2 }
+    its('resources.first.http_methods.count') { should == 2 }
+    its('resources.first.http_methods.first.responses.count') { should == 0 }
+    its('resources.first.http_methods.first.query_parameters.count') { should == 2 }
     its('documentation.count') { should == 0 }
-    its('resources.first.resources.first.methods.first.responses.first.bodies.first.example') do
+    its('resources.first.resources.first.http_methods.first.responses.first.bodies.first.example') do
       should include '{"artist":"Pink Floyd", "title":"Wish You Were Here"}'
     end
 
     context 'trait-inherited attributes' do
-      subject { Raml::Parser::Root.new.parse(raml).resources.first.methods.first.query_parameters.first }
+      subject { Raml::Parser::Root.new.parse(raml).resources.first.http_methods.first.query_parameters.first }
       its(:name) { should == 'pages' }
       its(:description) { should == 'The number of pages to return' }
       its(:type) { should == 'number' }
     end
 
     context 'non trait-inherited attributes' do
-      subject { Raml::Parser::Root.new.parse(raml).resources.first.methods.first.query_parameters.last }
+      subject { Raml::Parser::Root.new.parse(raml).resources.first.http_methods.first.query_parameters.last }
       its(:name) { should == 'genre' }
       its(:description) { should == 'filter the songs by genre' }
       its(:type) { should == nil }

data/spec/lib/raml/resource_spec.rb

@@ -7,7 +7,7 @@ describe Raml::Resource do
     subject { Raml::Resource.new(parent, '/cats') }
     its(:parent) { should == parent }
     its(:uri_partial) { should == '/cats' }
-    its(:methods) { should == [] }
+    its(:http_methods) { should == [] }
   end
 
   describe '#uri' do

data/spec/lib/raml/root_spec.rb

@@ -40,6 +40,20 @@ describe Raml::Root do
     it { is_expected.to eq('') }
   end
 
+  describe '#security_schemes' do
+    let(:root) { Raml::Root.new }
+    before { root.security_schemes = 'foo' }
+    subject { root.security_schemes }
+    it { is_expected.to eq('foo') }
+  end
+
+  describe '#secured_by' do
+    let(:root) { Raml::Root.new }
+    before { root.secured_by = [ 'oauth_2_0' ] }
+    subject { root.secured_by }
+    it { is_expected.to eq([ 'oauth_2_0' ]) }
+  end
+
   describe '#media_type' do
     let(:root) { Raml::Root.new }
     before { root.media_type = 'application/json' }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: raml-rb
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 1.0.0
 platform: ruby
 authors:
 - James Brennan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-22 00:00:00.000000000 Z
+date: 2016-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler