openapi3_parser 0.1.0

data/lib/openapi3_parser/nodes/responses.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "openapi3_parser/node/map"
+
+module Openapi3Parser
+  module Nodes
+    class Responses
+      include Node::Map
+
+      def default
+        node_data["default"]
+      end
+    end
+  end
+end

data/lib/openapi3_parser/nodes/schema.rb

@@ -0,0 +1,159 @@
+# frozen_string_literal: true
+
+require "openapi3_parser/node/object"
+
+module Openapi3Parser
+  module Nodes
+    # rubocop:disable ClassLength
+    class Schema
+      include Node::Object
+
+      def title
+        node_data["title"]
+      end
+
+      def multiple_of
+        node_data["multipleOf"]
+      end
+
+      def maximum
+        node_data["maximum"]
+      end
+
+      def exclusive_maximum?
+        node_data["exclusiveMaximum"]
+      end
+
+      def minimum
+        node_data["minimum"]
+      end
+
+      def exclusive_minimum?
+        node_data["exclusiveMinimum"]
+      end
+
+      def max_length
+        node_data["maxLength"]
+      end
+
+      def min_length
+        node_data["minLength"]
+      end
+
+      def pattern
+        node_data["pattern"]
+      end
+
+      def max_items
+        node_data["maxItems"]
+      end
+
+      def min_items
+        node_data["minItems"]
+      end
+
+      def unique_items?
+        node_data["uniqueItems"]
+      end
+
+      def max_properties
+        node_data["maxProperties"]
+      end
+
+      def min_properties
+        node_data["minProperties"]
+      end
+
+      def required
+        node_data["required"]
+      end
+
+      def enum
+        node_data["enum"]
+      end
+
+      def type
+        node_data["type"]
+      end
+
+      def all_of
+        node_data["allOf"]
+      end
+
+      def one_of
+        node_data["oneOf"]
+      end
+
+      def any_of
+        node_data["anyOf"]
+      end
+
+      def not
+        node_data["not"]
+      end
+
+      def items
+        node_data["items"]
+      end
+
+      def properties
+        node_data["properties"]
+      end
+
+      def additional_properties?
+        node_data["additionalProperties"] != false
+      end
+
+      def additional_properties_schema
+        properties = node_data["additionalProperties"]
+        return if [true, false].include?(properties)
+        properties
+      end
+
+      def description
+        node_data["description"]
+      end
+
+      def format
+        node_data["format"]
+      end
+
+      def default
+        node_data["default"]
+      end
+
+      def nullable?
+        node_data["nullable"]
+      end
+
+      def disciminator
+        node_data["discriminator"]
+      end
+
+      def read_only?
+        node_data["readOnly"]
+      end
+
+      def write_only?
+        node_data["writeOnly"]
+      end
+
+      def xml
+        node_data["xml"]
+      end
+
+      def external_docs
+        node_data["externalDocs"]
+      end
+
+      def example
+        node_data["example"]
+      end
+
+      def deprecated?
+        node_data["deprecated"]
+      end
+    end
+    # rubocop:enable ClassLength
+  end
+end

data/lib/openapi3_parser/nodes/security_requirement.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "openapi3_parser/node/map"
+
+module Openapi3Parser
+  module Nodes
+    class SecurityRequirement
+      include Node::Map
+    end
+  end
+end

data/lib/openapi3_parser/nodes/security_scheme.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require "openapi3_parser/node/object"
+require "openapi3_parser/nodes/oauth_flows"
+
+module Openapi3Parser
+  module Nodes
+    class SecurityScheme
+      include Node::Object
+
+      def type
+        node_data["type"]
+      end
+
+      def description
+        node_data["description"]
+      end
+
+      def name
+        node_data["name"]
+      end
+
+      def in
+        node_data["in"]
+      end
+
+      def scheme
+        node_data["scheme"]
+      end
+
+      def bearer_format
+        node_data["bearerFormat"]
+      end
+
+      def flows
+        node_data["flows"]
+      end
+
+      def open_id_connect_url
+        node_data["openIdConnectUrl"]
+      end
+    end
+  end
+end

data/lib/openapi3_parser/nodes/server.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "openapi3_parser/node/object"
+
+module Openapi3Parser
+  module Nodes
+    class Server
+      include Node::Object
+
+      # @TODO there's scope for an interpolated_url method which can use the
+      # values from variables
+      def url
+        node_data["url"]
+      end
+
+      def description
+        node_data["description"]
+      end
+
+      def variables
+        node_data["variables"]
+      end
+    end
+  end
+end

data/lib/openapi3_parser/nodes/server_variable.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "openapi3_parser/node/object"
+
+module Openapi3Parser
+  module Nodes
+    class ServerVariable
+      include Node::Object
+
+      def enum
+        node_data["enum"]
+      end
+
+      def default
+        node_data["default"]
+      end
+
+      def description
+        node_data["description"]
+      end
+    end
+  end
+end

data/lib/openapi3_parser/nodes/tag.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "openapi3_parser/node/object"
+
+module Openapi3Parser
+  module Nodes
+    class Tag
+      include Node::Object
+
+      def name
+        node_data["name"]
+      end
+
+      def description
+        node_data["description"]
+      end
+
+      def external_docs
+        node_data["externalDocs"]
+      end
+    end
+  end
+end

data/lib/openapi3_parser/nodes/xml.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "openapi3_parser/node/object"
+
+module Openapi3Parser
+  module Nodes
+    class Xml
+      include Node::Object
+
+      def name
+        node_data["name"]
+      end
+
+      def namespace
+        node_data["namespace"]
+      end
+
+      def prefix
+        node_data["prefix"]
+      end
+
+      def attribute
+        node_data["attribute"]
+      end
+
+      def wrapped
+        node_data["wrapped"]
+      end
+    end
+  end
+end

data/lib/openapi3_parser/validation/error.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Openapi3Parser
+  module Validation
+    class Error
+      attr_reader :namespace, :message
+
+      def initialize(namespace, message)
+        @namespace = namespace
+        @message = message
+      end
+    end
+  end
+end

data/lib/openapi3_parser/validation/error_collection.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Openapi3Parser
+  module Validation
+    class ErrorCollection
+      def initialize(*errors)
+        reset
+        append(*errors)
+      end
+
+      def append(*errors)
+        errors.each { |e| @errors << e }
+      end
+
+      def reset
+        @errors = []
+      end
+
+      def merge(error_collection)
+        append(*error_collection.to_a)
+      end
+
+      def empty?
+        errors.empty?
+      end
+
+      def to_a
+        errors.dup
+      end
+
+      private
+
+      attr_reader :errors
+    end
+  end
+end

data/lib/openapi3_parser/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Openapi3Parser
+  VERSION = "0.1.0"
+end

data/openapi3_parser.gemspec

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "openapi3_parser/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "openapi3_parser"
+  spec.version       = Openapi3Parser::VERSION
+  spec.authors       = ["Kevin Dew"]
+  spec.email         = ["kevindew@me.com"]
+
+  spec.summary       = "An OpenAPI V3 parser for Ruby"
+  spec.description   = "An OpenAPI V3 parser for Ruby"
+  spec.homepage      = "https://github.com/kevindew/openapi_parser"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^spec/})
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "byebug", "~> 9.1"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.6"
+  spec.add_development_dependency "rubocop", "~> 0.51"
+end

metadata

@@ -0,0 +1,208 @@
+--- !ruby/object:Gem::Specification
+name: openapi3_parser
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kevin Dew
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.1'
+- !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.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.51'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.51'
+description: An OpenAPI V3 parser for Ruby
+email:
+- kevindew@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENCE
+- README.md
+- Rakefile
+- TODO.md
+- lib/openapi3_parser.rb
+- lib/openapi3_parser/context.rb
+- lib/openapi3_parser/document.rb
+- lib/openapi3_parser/error.rb
+- lib/openapi3_parser/fields/map.rb
+- lib/openapi3_parser/node.rb
+- lib/openapi3_parser/node/map.rb
+- lib/openapi3_parser/node/object.rb
+- lib/openapi3_parser/node_factories/array.rb
+- lib/openapi3_parser/node_factories/callback.rb
+- lib/openapi3_parser/node_factories/components.rb
+- lib/openapi3_parser/node_factories/contact.rb
+- lib/openapi3_parser/node_factories/discriminator.rb
+- lib/openapi3_parser/node_factories/encoding.rb
+- lib/openapi3_parser/node_factories/example.rb
+- lib/openapi3_parser/node_factories/external_documentation.rb
+- lib/openapi3_parser/node_factories/header.rb
+- lib/openapi3_parser/node_factories/info.rb
+- lib/openapi3_parser/node_factories/license.rb
+- lib/openapi3_parser/node_factories/link.rb
+- lib/openapi3_parser/node_factories/map.rb
+- lib/openapi3_parser/node_factories/media_type.rb
+- lib/openapi3_parser/node_factories/oauth_flow.rb
+- lib/openapi3_parser/node_factories/oauth_flows.rb
+- lib/openapi3_parser/node_factories/openapi.rb
+- lib/openapi3_parser/node_factories/operation.rb
+- lib/openapi3_parser/node_factories/parameter.rb
+- lib/openapi3_parser/node_factories/parameter/parameter_like.rb
+- lib/openapi3_parser/node_factories/path_item.rb
+- lib/openapi3_parser/node_factories/paths.rb
+- lib/openapi3_parser/node_factories/reference.rb
+- lib/openapi3_parser/node_factories/request_body.rb
+- lib/openapi3_parser/node_factories/response.rb
+- lib/openapi3_parser/node_factories/responses.rb
+- lib/openapi3_parser/node_factories/schema.rb
+- lib/openapi3_parser/node_factories/security_requirement.rb
+- lib/openapi3_parser/node_factories/security_scheme.rb
+- lib/openapi3_parser/node_factories/server.rb
+- lib/openapi3_parser/node_factories/server_variable.rb
+- lib/openapi3_parser/node_factories/tag.rb
+- lib/openapi3_parser/node_factories/xml.rb
+- lib/openapi3_parser/node_factory.rb
+- lib/openapi3_parser/node_factory/field_config.rb
+- lib/openapi3_parser/node_factory/map.rb
+- lib/openapi3_parser/node_factory/object.rb
+- lib/openapi3_parser/node_factory/object/node_builder.rb
+- lib/openapi3_parser/node_factory/object/validator.rb
+- lib/openapi3_parser/node_factory/optional_reference.rb
+- lib/openapi3_parser/nodes/array.rb
+- lib/openapi3_parser/nodes/callback.rb
+- lib/openapi3_parser/nodes/components.rb
+- lib/openapi3_parser/nodes/contact.rb
+- lib/openapi3_parser/nodes/discriminator.rb
+- lib/openapi3_parser/nodes/encoding.rb
+- lib/openapi3_parser/nodes/example.rb
+- lib/openapi3_parser/nodes/external_documentation.rb
+- lib/openapi3_parser/nodes/header.rb
+- lib/openapi3_parser/nodes/info.rb
+- lib/openapi3_parser/nodes/license.rb
+- lib/openapi3_parser/nodes/link.rb
+- lib/openapi3_parser/nodes/map.rb
+- lib/openapi3_parser/nodes/media_type.rb
+- lib/openapi3_parser/nodes/oauth_flow.rb
+- lib/openapi3_parser/nodes/oauth_flows.rb
+- lib/openapi3_parser/nodes/openapi.rb
+- lib/openapi3_parser/nodes/operation.rb
+- lib/openapi3_parser/nodes/parameter.rb
+- lib/openapi3_parser/nodes/parameter/parameter_like.rb
+- lib/openapi3_parser/nodes/path_item.rb
+- lib/openapi3_parser/nodes/paths.rb
+- lib/openapi3_parser/nodes/request_body.rb
+- lib/openapi3_parser/nodes/response.rb
+- lib/openapi3_parser/nodes/responses.rb
+- lib/openapi3_parser/nodes/schema.rb
+- lib/openapi3_parser/nodes/security_requirement.rb
+- lib/openapi3_parser/nodes/security_scheme.rb
+- lib/openapi3_parser/nodes/server.rb
+- lib/openapi3_parser/nodes/server_variable.rb
+- lib/openapi3_parser/nodes/tag.rb
+- lib/openapi3_parser/nodes/xml.rb
+- lib/openapi3_parser/validation/error.rb
+- lib/openapi3_parser/validation/error_collection.rb
+- lib/openapi3_parser/version.rb
+- openapi3_parser.gemspec
+homepage: https://github.com/kevindew/openapi_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.5.1
+signing_key: 
+specification_version: 4
+summary: An OpenAPI V3 parser for Ruby
+test_files: []