oas_parser 0.8.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6649d62852587ebaf1bb67e555ed4993c400679f
-  data.tar.gz: 55c7c61b31e7dec4b4cdd58ea3d63f1f2682b9c3
+  metadata.gz: e6ee6f96dd9a46e992d6467dabafd53b8118cfcd
+  data.tar.gz: c7d08a162beb83df0d38428932d52b8010330f81
 SHA512:
-  metadata.gz: 06ca8cd65d727d3f5bfb01c949c08ea26a7c58767f644846b0e4fc69914e52875c39b6053770400465312498f31ba850d6f3a89b4830385d985131e6cc382a65
-  data.tar.gz: 3e40006c436ba223918ffd49e02929df677b95234a943d23695314663c7d73c01e9c0478884ecbe3077c298c23a3d7b94d8fa1ec7f6c191fe70d0da86c293120
+  metadata.gz: c8323d13fd8614627b845d76bb16b03d113e48643ef9ecd5541f159c8ade591218ac4025286b273de4296723f0435c1857b27496243aa338b9c1bc40b79151fe
+  data.tar.gz: fd05eb37bda9b9e158c0e3f37464de97592440681afe808f88d885f9295ab3775907c0927f90d9d454d518b403f1f36b1153221ec874655dd0bcaf6373fb014d

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    oas_parser (0.8.1)
+    oas_parser (0.9.0)
       activesupport (~> 5.1.2)
       addressable (~> 2.3)
       builder (~> 3.2.3)
@@ -13,7 +13,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.1.4)
+    activesupport (5.1.5)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (~> 0.7)
       minitest (~> 5.1)
@@ -42,7 +42,7 @@ GEM
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
-    i18n (0.9.3)
+    i18n (0.9.5)
       concurrent-ruby (~> 1.0)
     json (2.1.0)
     json_schema (0.15.0)
@@ -63,7 +63,7 @@ GEM
     pry (0.11.3)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
-    public_suffix (3.0.1)
+    public_suffix (3.0.2)
     rake (10.5.0)
     rb-fsevent (0.10.2)
     rb-inotify (0.9.10)

data/README.md

@@ -1,43 +1,62 @@
-# OasParser
+# Open API Definition Parser
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/oas_parser`. To experiment with that code, run `bin/console` for an interactive prompt.
+A Ruby parser for Open API Spec 3.0+ definitions.
 
-TODO: Delete this and the text above, and describe your gem
+### Install
 
-## Installation
+Install the gem:
 
-Add this line to your application's Gemfile:
+```
+$ gem install oas_parser
+```
+
+Or add it to your Gemfile:
 
 ```ruby
 gem 'oas_parser'
 ```
 
-And then execute:
+### Usage
 
-    $ bundle
+Here is a basic example of how you can traverse through an Open API Spec 3 Definition:
 
-Or install it yourself as:
+```ruby
+require 'oas_parser'
 
-    $ gem install oas_parser
+definition = OasParser::Definition.resolve('petstore.yml')
+# => #<OasParser::Definition>
 
-## Usage
+# Get a specific path
+path = definition.path_by_path('/pets')
+# => #<OasParser::Path>
 
-TODO: Write usage instructions here
+# Get all paths.
+definition.paths
+# => [#<OasParser::Path>, ...]
 
-## Development
+# Get a specific endpoint by method
+endpoint = path.endpoint_by_method('get')
+# => #<OasParser::Endpoint>
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+# Get all endpoints
+path.endpoints
+# => [#<OasParser::Endpoint>, ...]
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+# Get endpoint description
+endpoint.description
+# => "Returns all pets from the system that the user has access to"
+```
 
-## Contributing
+Checkout the tests and `lib` directory for more classes and methods.
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/oas_parser. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+### Development
 
-## License
+Run tests:
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+```
+$ rspec
+```
 
-## Code of Conduct
+## Contributing
 
-Everyone interacting in the OasParser project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/oas_parser/blob/master/CODE_OF_CONDUCT.md).
+Contributions are welcome, please follow [GitHub Flow](https://guides.github.com/introduction/flow/index.html)

data/lib/oas_parser/abstract_attribute.rb

@@ -2,6 +2,16 @@ module OasParser
   class AbstractAttribute
     include OasParser::RawAccessor
 
+    def name(format = nil)
+      default = @name || raw['name']
+      return default unless format
+      case format
+      when 'text/xml'
+        has_xml_name? ? xml_name : default
+      else default
+      end
+    end
+
     def enum
       raw['enum'] || (schema ? schema['enum'] : nil)
     end

data/lib/oas_parser/parameter.rb

@@ -1,6 +1,6 @@
 module OasParser
   class Parameter < AbstractAttribute
-    raw_keys :name, :in, :description, :style, :schema,
+    raw_keys :in, :description, :style, :schema,
              :minimum, :maximum, :required
 
     attr_accessor :owner, :raw

data/lib/oas_parser/property.rb

@@ -1,9 +1,10 @@
 module OasParser
   class Property < AbstractAttribute
-    raw_keys :name, :description, :type, :format, :minimum, :maximum,
+    raw_keys :description, :type, :format, :minimum, :maximum,
              :example, :default, :items
 
-    attr_accessor :owner, :name, :schema, :raw
+    attr_accessor :owner, :schema, :raw
+    attr_writer :name
 
     def initialize(owner, schema, name, raw)
       @owner = owner

data/lib/oas_parser/response_parser.rb

@@ -31,6 +31,19 @@ module OasParser
         end
       end
 
+      xml_document.xpath('//__array_attributes').each do |attributes|
+        attributes.children.each do |attribute|
+          next unless attribute.class == Nokogiri::XML::Element
+
+          parameter = {}
+          parameter['example'] = attribute.css('example').text if attribute.css('example')
+          parameter['type'] = attribute.css('type').text if attribute.css('type')
+
+          attribute.parent.parent.parent[attribute.name] = parameter_value(parameter)
+        end
+        attributes.parent.remove
+      end
+
       xml_document.xpath('//__text').each do |attribute|
         value = attribute.children.last.content
         attribute.parent.content = value
@@ -108,14 +121,34 @@ module OasParser
     def parse_array(object)
       raise StandardError.new("Not an array") unless object['type'] == 'array'
 
+      attributes = {}
+
+      if object['properties']
+        if @mode == 'xml'
+          object['properties'].each do |key, value|
+            if is_xml_attribute?(value)
+              attributes[key] = value
+            end
+          end
+        end
+      end
+
       case object['items']['type']
       when 'object'
-        [parse_object(object['items'])]
+        if attributes.any? && @mode == 'xml'
+          [parse_object(object['items']), { '__array_attributes' => attributes }]
+        else
+          [parse_object(object['items'])]
+        end
       else
         if object['items']
           # Handle objects with missing type
           object['items']['type'] = 'object'
-          [parse_object(object['items'])]
+          if @mode == 'xml'
+            [parse_object(object['items']), { '__array_attributes' => attributes }]
+          else
+            [parse_object(object['items'])]
+          end
         else
           raise StandardError.new("parse_array: Don't know how to parse object")
         end

data/lib/oas_parser/version.rb

@@ -1,3 +1,3 @@
 module OasParser
-  VERSION = '0.8.1'.freeze
+  VERSION = '0.9.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oas_parser
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.0
 platform: ruby
 authors:
 - Adam Butler
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-07 00:00:00.000000000 Z
+date: 2018-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable