oas_parser 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b721f4ef0bb08e47e1dc472ec13d86c5fff894c1
+  data.tar.gz: 59925a5cf1a381b9a5b5e8841e1e505ef60b6546
+SHA512:
+  metadata.gz: bbe143f53fffd4e9f945343217c5900fe8380d7b5fd5301a9554a755dfae14bfc722485d6daea0d2f3cab60f458409facf990a07091856af424a841806adf153
+  data.tar.gz: be8a889667e5c79c9f7f836423af1d930131c3f140066f2bb5e3e9a3e584a08f0ecc5c1bac0f3e1727e869cb5636199b8ab8cf2ab9d74b3d07ecd0c08e2c69ad

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.16.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at adam@lab.io. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in oas_parser.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,89 @@
+PATH
+  remote: .
+  specs:
+    oas_parser (0.1.0)
+      addressable (~> 2.3)
+      deep_merge (~> 1.2.1)
+      guard-rspec (~> 4.7.3)
+      json_schema (~> 0.15.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    coderay (1.1.2)
+    deep_merge (1.2.1)
+    diff-lcs (1.3)
+    docile (1.1.5)
+    ffi (1.9.18)
+    formatador (0.2.5)
+    guard (2.14.1)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (~> 1.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    json (2.1.0)
+    json_schema (0.15.0)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    lumberjack (1.0.12)
+    method_source (0.9.0)
+    nenv (0.3.0)
+    notiffany (0.1.1)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    public_suffix (3.0.1)
+    rake (10.5.0)
+    rb-fsevent (0.10.2)
+    rb-inotify (0.9.10)
+      ffi (>= 0.5.0, < 2)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+    ruby_dep (1.5.0)
+    shellany (0.0.1)
+    simplecov (0.15.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    thor (0.20.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  oas_parser!
+  pry (~> 0.11.3)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  simplecov (~> 0.15.1)
+
+BUNDLED WITH
+   1.16.0

data/Guardfile

@@ -0,0 +1,70 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Rails files
+  rails = dsl.rails(view_extensions: %w(erb haml slim))
+  dsl.watch_spec_files_for(rails.app_files)
+  dsl.watch_spec_files_for(rails.views)
+
+  watch(rails.controllers) do |m|
+    [
+      rspec.spec.call("routing/#{m[1]}_routing"),
+      rspec.spec.call("controllers/#{m[1]}_controller"),
+      rspec.spec.call("acceptance/#{m[1]}")
+    ]
+  end
+
+  # Rails config changes
+  watch(rails.spec_helper)     { rspec.spec_dir }
+  watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+  watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+
+  # Capybara features specs
+  watch(rails.view_dirs)     { |m| rspec.spec.call("features/#{m[1]}") }
+  watch(rails.layouts)       { |m| rspec.spec.call("features/#{m[1]}") }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Adam Butler
+
+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,43 @@
+# OasParser
+
+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.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'oas_parser'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install oas_parser
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+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.
+
+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).
+
+## Contributing
+
+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.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+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).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "oas_parser"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/oas_parser.rb

@@ -0,0 +1,19 @@
+require 'json'
+require 'uri'
+require 'yaml'
+
+require 'addressable/uri'
+require 'json_schema'
+require 'deep_merge'
+
+require_relative 'oas_parser/raw_accessor.rb'
+
+Dir["#{File.dirname(__FILE__)}/oas_parser/**/*.rb"].each do |file|
+  require file
+end
+
+File.expand_path('path', File.dirname(__FILE__))
+
+module OasParser
+  # Your code goes here...
+end

data/lib/oas_parser/callback.rb

@@ -0,0 +1,20 @@
+module OasParser
+  class Callback < Payload
+    include OasParser::RawAccessor
+    raw_keys :description, :content
+
+    attr_accessor :endpoint, :name, :raw
+
+    def initialize(endpoint, name, raw)
+      @endpoint = endpoint
+      @name = name
+      @raw = raw
+    end
+
+    def paths
+      raw.map do |path, definition|
+        OasParser::Path.new(self, path, definition)
+      end
+    end
+  end
+end

data/lib/oas_parser/definition.rb

@@ -0,0 +1,37 @@
+module OasParser
+  class Definition
+    include OasParser::RawAccessor
+    raw_keys :info, :servers, :components, :openapi
+
+    attr_accessor :raw
+
+    def self.resolve(path)
+      raw = Parser.resolve(path)
+      Definition.new(raw)
+    end
+
+    def initialize(raw)
+      @raw = raw
+    end
+
+    def paths
+      raw['paths'].map do |path, definition|
+        OasParser::Path.new(self, path, definition)
+      end
+    end
+
+    def path_by_path(path)
+      definition = raw['paths'][path]
+      raise StandardError.new('So such path exists') unless definition
+      OasParser::Path.new(self, path, definition)
+    end
+
+    def security
+      raw['security'] || []
+    end
+
+    def endpoints
+      paths.flat_map(&:endpoints)
+    end
+  end
+end

data/lib/oas_parser/endpoint.rb

@@ -0,0 +1,99 @@
+module OasParser
+  class Endpoint
+    include OasParser::RawAccessor
+    raw_keys :summary, :description, :operationId, :tags, :required
+
+    attr_accessor :path, :method, :raw
+
+    def initialize(path, method, raw)
+      @path = path
+      @method = method
+      @raw = raw
+    end
+
+    def definition
+      path.definition
+    end
+
+    def parameters
+      local_parameters + path.parameters
+    end
+
+    def path_parameters
+      parameters.select { |parameter| parameter.in == 'path' }
+    end
+
+    def query_parameters
+      parameters.select { |parameter| parameter.in == 'query' }
+    end
+
+    def parameter_by_name(name)
+      parameters.each do |parameter|
+        return parameter if parameter.name == name
+      end
+
+      raise StandardError.new('So such parameter exists')
+    end
+
+    def request_body
+      return false unless raw['requestBody']
+      OasParser::RequestBody.new(self, raw['requestBody'])
+    end
+
+    def responses
+      raw['responses'].map do |code, definition|
+        OasParser::Response.new(self, code, definition)
+      end
+    end
+
+    def response_by_code(code)
+      definition = raw['responses'][code]
+      raise StandardError.new('So such response exists') unless definition
+      OasParser::Response.new(self, code, definition)
+    end
+
+    def security
+      raw['security'] || []
+    end
+
+    def callbacks
+      return [] unless raw['callbacks']
+      raw['callbacks'].map do |name, definition|
+        OasParser::Callback.new(self, name, definition)
+      end
+    end
+
+    def callback_by_name(name)
+      definition = raw['callbacks'][name]
+      raise StandardError.new('So such callback exists') unless definition
+      OasParser::Callback.new(self, name, definition)
+    end
+
+    def jwt?
+      return false unless security
+
+      security_schemes.each do |security_schema|
+        return true if security_schema['bearerFormat'] == 'JWT'
+      end
+
+      false
+    end
+
+    def security_schemes
+      security_schemes = (security.flat_map(&:keys) + definition.security.flat_map(&:keys)).uniq
+
+      security_schemes.map do |security_scheme_name|
+        definition.components['securitySchemes'][security_scheme_name]
+      end
+    end
+
+    private
+
+    def local_parameters
+      return [] unless raw['parameters']
+      raw['parameters'].map do |definition|
+        OasParser::Parameter.new(self, definition)
+      end
+    end
+  end
+end

data/lib/oas_parser/parameter.rb

@@ -0,0 +1,46 @@
+module OasParser
+  class Parameter
+    include OasParser::RawAccessor
+    raw_keys :name, :in, :description, :style, :enum, :schema,
+             :minimum, :maximum, :example, :default, :required
+
+    attr_accessor :owner, :raw
+
+    def initialize(owner, raw)
+      @owner = owner
+      @raw = raw
+    end
+
+    def type
+      raw['type'] || schema['type']
+    end
+
+    def array?
+      type == 'array'
+    end
+
+    def object?
+      type == 'object'
+    end
+
+    def collection?
+      array? || object?
+    end
+
+    def items
+      schema['items']
+    end
+
+    def properties
+      return convert_property_schema_to_properties(raw['properties']) if object?
+      return convert_property_schema_to_properties(items) if array?
+      nil
+    end
+
+    def convert_property_schema_to_properties(schema)
+      schema.map do |name, definition|
+        OasParser::Property.new(self, raw, name, definition)
+      end
+    end
+  end
+end

data/lib/oas_parser/parser.rb

@@ -0,0 +1,61 @@
+module OasParser
+  class Parser
+    def self.resolve(path)
+      content = YAML.load_file(path)
+      Parser.new(path, content).resolve
+    end
+
+    def initialize(path, content)
+      @path = path
+      @content = content
+    end
+
+    def resolve
+      deeply_expand_refs(@content)
+    end
+
+    private
+
+    def deeply_expand_refs(fragment)
+      fragment = expand_refs(fragment)
+
+      if fragment.is_a?(Hash)
+        fragment.reduce({}) do |hash, (k, v)|
+          hash.merge(k => deeply_expand_refs(v))
+        end
+      elsif fragment.is_a?(Array)
+        fragment.map { |e| deeply_expand_refs(e) }
+      else
+        fragment
+      end
+    end
+
+    def expand_refs(fragment)
+      if fragment.is_a?(Hash) && fragment.has_key?("$ref")
+        ref = fragment["$ref"]
+
+        if ref =~ /\Afile:/
+          expand_file(ref)
+        else
+          expand_pointer(ref)
+        end
+      else
+        fragment
+      end
+    end
+
+    def expand_file(ref)
+      relative_path = ref.split(":").last
+      absolute_path = File.expand_path(File.join("..", relative_path), @path)
+
+      Parser.resolve(absolute_path)
+    end
+
+    def expand_pointer(ref)
+      pointer = OasParser::Pointer.new(ref)
+      fragment = pointer.resolve(@content)
+
+      expand_refs(fragment)
+    end
+  end
+end

data/lib/oas_parser/path.rb

@@ -0,0 +1,45 @@
+module OasParser
+  class Path
+    attr_accessor :owner, :path, :raw
+
+    def initialize(owner, path, raw)
+      @owner = owner
+      @path = path
+      @raw = raw
+    end
+
+    def endpoints
+      a = raw.map do |method, definition|
+        next unless %w[get head post put patch delete trace options].include? method
+        OasParser::Endpoint.new(self, method, definition)
+      end
+
+      a.compact
+    end
+
+    def endpoint_by_method(method)
+      definition = raw[method]
+      raise StandardError.new('So such endpoint exists') unless definition
+      OasParser::Endpoint.new(self, method, definition)
+    end
+
+    def parameter_keys
+      path.scan(/{(.+?)}/).flatten
+    end
+
+    def parameters
+      return [] unless raw['parameters']
+      raw['parameters'].map do |definition|
+        OasParser::Parameter.new(self, definition)
+      end
+    end
+
+    def definition
+      owner if owner.class == OasParser::Definition
+    end
+
+    def callback
+      owner if owner.class == OasParser::Callback
+    end
+  end
+end

data/lib/oas_parser/payload.rb

@@ -0,0 +1,21 @@
+module OasParser
+  class Payload
+    def formats
+      return [] unless content
+      content.keys
+    end
+
+    def schema(format)
+      content[format]['schema']
+    end
+
+    def split_schemas(format)
+      content[format]['schema']['oneOf']
+    end
+
+    def exhibits_one_of_multiple_schemas?(format)
+      return false unless content
+      schema(format).keys.include?('oneOf')
+    end
+  end
+end

data/lib/oas_parser/pointer.rb

@@ -0,0 +1,45 @@
+module OasParser
+  class Pointer
+    def initialize(raw_pointer)
+      @raw_pointer = raw_pointer
+    end
+
+    def resolve(document)
+      return document if escaped_pointer == ""
+
+      tokens.reduce(document) do |nested_doc, token|
+        nested_doc.fetch(token)
+      end
+    end
+
+    private
+
+    def escaped_pointer
+      if @raw_pointer.start_with?("#")
+        Addressable::URI.unencode(@raw_pointer[1..-1])
+      else
+        @raw_pointer
+      end
+    end
+
+    def parse_token(token)
+      if token =~ /\A\d+\z/
+        token.to_i
+      else
+        token.gsub("~0", "~").gsub("~1", "/")
+      end
+    end
+
+    def tokens
+      tokens = escaped_pointer[1..-1].split("/")
+
+      if @raw_pointer.end_with?("/")
+        tokens << ""
+      end
+
+      tokens.map do |token|
+        parse_token(token)
+      end
+    end
+  end
+end

data/lib/oas_parser/property.rb

@@ -0,0 +1,46 @@
+module OasParser
+  class Property
+    include OasParser::RawAccessor
+    raw_keys :name, :description, :type, :enum, :minimum, :maximum,
+             :example, :default, :items
+
+    attr_accessor :owner, :name, :schema, :raw
+
+    def initialize(owner, schema, name, raw)
+      @owner = owner
+      @name = name
+      @schema = schema
+      @raw = raw
+    end
+
+    def required
+      return false unless schema['required']
+      schema['required'].include? name
+    end
+
+    def array?
+      type == 'array'
+    end
+
+    def object?
+      type == 'object'
+    end
+
+    def collection?
+      array? || object?
+    end
+
+    def properties
+      return convert_property_schema_to_properties(raw['properties']) if object?
+      return convert_property_schema_to_properties(items) if array?
+      nil
+    end
+
+    def convert_property_schema_to_properties(schema)
+      schema = schema['properties'] if schema['properties']
+      schema.map do |name, definition|
+        OasParser::Property.new(self, raw, name, definition)
+      end
+    end
+  end
+end

data/lib/oas_parser/raw_accessor.rb

@@ -0,0 +1,26 @@
+module OasParser
+  module RawAccessor
+    def self.included(klass)
+      klass.extend ClassMethods
+    end
+
+    def method_missing(method_name, *args, &block)
+      super unless self.class.get_raw_keys.include? method_name
+      raw[method_name.to_s]
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      self.class.get_raw_keys.include?(method_name) || super
+    end
+
+    module ClassMethods
+      def raw_keys(*args)
+        @raw_keys = args
+      end
+
+      def get_raw_keys
+        @raw_keys || []
+      end
+    end
+  end
+end

data/lib/oas_parser/request_body.rb

@@ -0,0 +1,27 @@
+module OasParser
+  class RequestBody < Payload
+    include OasParser::RawAccessor
+    raw_keys :description, :required, :content
+
+    attr_accessor :endpoint, :raw
+
+    def initialize(endpoint, raw)
+      @endpoint = endpoint
+      @raw = raw
+    end
+
+    def properties_for_format(format)
+      schema(format)['properties'].map do |name, definition|
+        OasParser::Property.new(self, schema(format), name, definition)
+      end
+    end
+
+    def split_properties_for_format(format)
+      split_schemas(format).map do |schema|
+        schema['properties'].map do |name, definition|
+          OasParser::Property.new(self, schema(format), name, definition)
+        end
+      end
+    end
+  end
+end

data/lib/oas_parser/response.rb

@@ -0,0 +1,18 @@
+module OasParser
+  class Response < Payload
+    include OasParser::RawAccessor
+    raw_keys :description, :content
+
+    attr_accessor :endpoint, :code, :raw
+
+    def initialize(endpoint, code, raw)
+      @endpoint = endpoint
+      @code = code
+      @raw = raw
+    end
+
+    def success?
+      code.match?(/^2\d\d$/)
+    end
+  end
+end

data/lib/oas_parser/response_parser.rb

@@ -0,0 +1,103 @@
+module OasParser
+  class ResponseParser
+    attr_accessor :raw
+
+    def initialize(raw)
+      @raw = raw
+    end
+
+    def parse
+      route(@raw)
+    end
+
+    private
+
+    def route(root_object)
+      case root_object['type']
+      when 'object'
+        parse_object(root_object)
+      when 'array' then parse_array(root_object)
+      when nil
+        return nil if root_object['additionalProperties'] == false
+        return nil if root_object['properties'] == {}
+
+        if treat_as_object?(root_object)
+          # Handle objects with missing type
+          return parse_object(root_object.merge({ 'type' => 'object' }))
+        end
+
+        raise StandardError.new("Unhandled object #{root_object} with missing type")
+      else
+        raise StandardError.new("Don't know how to parse #{root_object['type']}")
+      end
+    end
+
+    def parse_object(object)
+      raise StandardError.new("Not a hash") unless object.class == Hash
+      raise StandardError.new("Not an object") unless treat_as_object?(object)
+
+      if object['allOf']
+        merged_object = { 'type' => 'object' }
+        object['allOf'].each { |o| merged_object.deep_merge!(o) }
+        return parameter_value(merged_object)
+      elsif object['properties']
+        o = {}
+        object['properties'].each do |key, value|
+          o[key] = parameter_value(value)
+        end
+
+        return o
+      end
+
+      {}
+    end
+
+    def parse_array(object)
+      raise StandardError.new("Not an array") unless object['type'] == 'array'
+
+      case object['items']['type']
+      when 'object'
+        [parse_object(object['items'])]
+      else
+        if object['items']
+          # Handle objects with missing type
+          object['items']['type'] = 'object'
+          [parse_object(object['items'])]
+        else
+          raise StandardError.new("parse_array: Don't know how to parse object")
+        end
+      end
+    end
+
+    def parameter_value(parameter)
+      return parameter['example'] if parameter['example']
+      case (parameter['schema'] ? parameter['schema']['type'] : parameter['type'])
+      when 'integer' then return 1
+      when 'number' then return 1.0
+      when 'string' then return 'abc123'
+      when 'boolean' then return false
+      when 'object' then return parse_object(parameter)
+      when 'array' then return parse_array(parameter)
+      else
+        if treat_as_object?(parameter)
+          return parse_object(parameter)
+        end
+
+        if parameter['type']
+          raise StandardError.new("Can not resolve parameter type of #{parameter['type']}")
+        else
+          raise StandardError.new("Parameter #{parameter} is missing type.")
+        end
+      end
+    end
+
+
+    def treat_as_object?(object)
+      return true if object['type'] == 'object'
+      return true if object['allOf']
+      return true if object['oneOf']
+      return true if object['properties']
+      false
+    end
+  end
+end

data/lib/oas_parser/version.rb

@@ -0,0 +1,3 @@
+module OasParser
+  VERSION = "0.1.0"
+end

data/oas_parser.gemspec

@@ -0,0 +1,33 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "oas_parser/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "oas_parser"
+  spec.version       = OasParser::VERSION
+  spec.authors       = ["Adam Butler"]
+  spec.email         = ["adam@lab.io"]
+
+  spec.summary       = %q{A parser for Open API specifications}
+  spec.homepage      = "https://github.com/Nexmo/oas_parser"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "addressable", "~> 2.3"
+  spec.add_dependency "json_schema", "~> 0.15.0"
+  spec.add_dependency "guard-rspec", "~> 4.7.3"
+  spec.add_dependency "deep_merge", "~> 1.2.1"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", "~> 0.11.3"
+  spec.add_development_dependency "simplecov", "~> 0.15.1"
+end

metadata

@@ -0,0 +1,198 @@
+--- !ruby/object:Gem::Specification
+name: oas_parser
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Adam Butler
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: json_schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.0
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.7.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.7.3
+- !ruby/object:Gem::Dependency
+  name: deep_merge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.1
+description: 
+email:
+- adam@lab.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/oas_parser.rb
+- lib/oas_parser/callback.rb
+- lib/oas_parser/definition.rb
+- lib/oas_parser/endpoint.rb
+- lib/oas_parser/parameter.rb
+- lib/oas_parser/parser.rb
+- lib/oas_parser/path.rb
+- lib/oas_parser/payload.rb
+- lib/oas_parser/pointer.rb
+- lib/oas_parser/property.rb
+- lib/oas_parser/raw_accessor.rb
+- lib/oas_parser/request_body.rb
+- lib/oas_parser/response.rb
+- lib/oas_parser/response_parser.rb
+- lib/oas_parser/version.rb
+- oas_parser.gemspec
+homepage: https://github.com/Nexmo/oas_parser
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: A parser for Open API specifications
+test_files: []