swagger_parser 0.0.1

data/lib/swagger_parser/definitions.rb

@@ -0,0 +1,13 @@
+require "swagger_parser/enumerable_object"
+require "swagger_parser/schema"
+
+module SwaggerParser
+  class Definitions < EnumerableObject
+    private
+
+    # @note Implementation for SwaggerParser::EnumerableObject
+    def build_element(value)
+      SwaggerParser::Schema.new(value)
+    end
+  end
+end

data/lib/swagger_parser/enumerable_object.rb

@@ -0,0 +1,30 @@
+require "swagger_parser/source_based_object"
+
+module SwaggerParser
+  class EnumerableObject < SourceBasedObject
+    include Enumerable
+
+    # @note Implementation for Enumerable
+    def each(&block)
+      source.each do |key, value|
+        block.call([key, build_element(value)])
+      end
+    end
+
+    # @param [String]
+    # @return [SwaggerParser::SourceBasedObject, nil]
+    def [](key)
+      value = source[key]
+      build_element(value) if value
+    end
+
+    private
+
+    # @note Override me
+    # @param [Object] value
+    # @return [Class]
+    def build_element(value)
+      raise NotImplementedError
+    end
+  end
+end

data/lib/swagger_parser/errors/base_error.rb

@@ -0,0 +1,6 @@
+module SwaggerParser
+  module Errors
+    class BaseError < StandardError
+    end
+  end
+end

data/lib/swagger_parser/errors/file_parsing_error.rb

@@ -0,0 +1,8 @@
+require "swagger_parser/errors/base_error"
+
+module SwaggerParser
+  module Errors
+    class FileParsingError < BaseError
+    end
+  end
+end

data/lib/swagger_parser/examples.rb

@@ -0,0 +1,12 @@
+require "swagger_parser/enumerable_object"
+
+module SwaggerParser
+  class Examples < EnumerableObject
+    private
+
+    # @note Implementation for SwaggerParser::EnumerableObject
+    def build_element(value)
+      value
+    end
+  end
+end

data/lib/swagger_parser/extendable.rb

@@ -0,0 +1,10 @@
+module SwaggerParser
+  module Extendable
+    # @return [Hash{String => Object}]
+    def extensions
+      source.select do |key, value|
+        key.start_with?("x-")
+      end
+    end
+  end
+end

data/lib/swagger_parser/external_docs_attributable.rb

@@ -0,0 +1,12 @@
+require "swagger_parser/external_documentation"
+
+module SwaggerParser
+  module ExternalDocsAttributable
+    # @return [SwaggerParser::ExternalDocumentation, nil]
+    def external_docs
+      if source["external_docs"]
+        SwaggerParser::ExternalDocumentation.new(source["external_docs"])
+      end
+    end
+  end
+end

data/lib/swagger_parser/external_documentation.rb

@@ -0,0 +1,6 @@
+require "swagger_parser/source_based_object"
+
+module SwaggerParser
+  class ExternalDocumentation < SourceBasedObject
+  end
+end

data/lib/swagger_parser/file_parser.rb

@@ -0,0 +1,58 @@
+require "json"
+require "swagger_parser/errors/file_parsing_error"
+require "swagger_parser/swagger"
+require "yaml"
+
+module SwaggerParser
+  class FileParser
+    YAML_EXTNAMES = %w(.yaml .yml)
+
+    class << self
+      # @param [String] path
+      # @return [SwaggerParser::Swagger]
+      def parse(path)
+        new(path).parse
+      end
+    end
+
+    # @param [String] path
+    def initialize(path)
+      @path = path
+    end
+
+    # @return [SwaggerParser::Swagger]
+    # @raise [SwaggerParser::Errors::FileParsingError]
+    def parse
+      SwaggerParser::Swagger.new(parse_file)
+    end
+
+    private
+
+    # @return [String]
+    def content
+      File.read(path)
+    end
+
+    # @return [Object]
+    # @raise [SwaggerParser::Errors::FileParsingError]
+    def parse_file
+      if yaml?
+        YAML.load(content)
+      else
+        JSON.parse(content)
+      end
+    rescue => exception
+      raise SwaggerParser::Errors::FileParsingError, exception
+    end
+
+    # @return [String]
+    def path
+      @path
+    end
+
+    # @return [false, true]
+    def yaml?
+      YAML_EXTNAMES.include?(File.extname(path))
+    end
+  end
+end

data/lib/swagger_parser/header.rb

@@ -0,0 +1,6 @@
+require "swagger_parser/minimal_json_schema"
+
+module SwaggerParser
+  class Header < MinimalJsonSchema
+  end
+end

data/lib/swagger_parser/headers.rb

@@ -0,0 +1,13 @@
+require "swagger_parser/enumerable_object"
+require "swagger_parser/header"
+
+module SwaggerParser
+  class Headers < EnumerableObject
+    private
+
+    # @note Implementation for SwaggerParser::EnumerableObject
+    def build_element(value)
+      SwaggerParser::Header.new(value)
+    end
+  end
+end

data/lib/swagger_parser/info.rb

@@ -0,0 +1,40 @@
+require "swagger_parser/contact"
+require "swagger_parser/extendable"
+require "swagger_parser/license"
+require "swagger_parser/source_based_object"
+
+module SwaggerParser
+  class Info < SourceBasedObject
+    include SwaggerParser::Extendable
+
+    # @return [Object]
+    def contact
+      SwaggerParser::Contact.new(source["contact"])
+    end
+
+    # @return [Object]
+    def description
+      source["description"]
+    end
+
+    # @return [Object]
+    def license
+      SwaggerParser::License.new(source["license"])
+    end
+
+    # @return [Object]
+    def terms_of_service
+      source["termsOfService"]
+    end
+
+    # @return [Object]
+    def title
+      source["title"]
+    end
+
+    # @return [Object]
+    def version
+      source["version"]
+    end
+  end
+end

data/lib/swagger_parser/items.rb

@@ -0,0 +1,8 @@
+require "swagger_parser/extendable"
+require "swagger_parser/source_based_object"
+
+module SwaggerParser
+  class Items < SourceBasedObject
+    include SwaggerParser::Extendable
+  end
+end

data/lib/swagger_parser/json_schema.rb

@@ -0,0 +1,23 @@
+require "swagger_parser/minimal_json_schema"
+require "swagger_parser/referable"
+
+module SwaggerParser
+  class JsonSchema < MinimalJsonSchema
+    include SwaggerParser::Referable
+
+    # @return [Object]
+    def max_properties
+      source["maxProperties"]
+    end
+
+    # @return [Object]
+    def min_properties
+      source["minProperties"]
+    end
+
+    # @return [Object]
+    def required
+      source["required"]
+    end
+  end
+end

data/lib/swagger_parser/license.rb

@@ -0,0 +1,15 @@
+require "swagger_parser/source_based_object"
+
+module SwaggerParser
+  class License < SourceBasedObject
+    # @return [Object]
+    def name
+      source["name"]
+    end
+
+    # @return [Object]
+    def url
+      source["url"]
+    end
+  end
+end

data/lib/swagger_parser/minimal_json_schema.rb

@@ -0,0 +1,91 @@
+require "swagger_parser/source_based_object"
+
+module SwaggerParser
+  # JSON Schema without $ref and properties for object definition.
+  class MinimalJsonSchema < SourceBasedObject
+    # @return [Object]
+    def default
+      source["default"]
+    end
+
+    # @return [Object]
+    def description
+      source["description"]
+    end
+
+    # @return [Object]
+    def enum
+      source["enum"]
+    end
+
+    # @return [false, true]
+    def exclusive_maximum
+      !!source["exclusiveMaximum"]
+    end
+
+    # @return [false, true]
+    def exclusive_minimum
+      !!source["exclusiveMinimum"]
+    end
+
+    # @return [Object]
+    def format
+      source["format"]
+    end
+
+    # @return [Object]
+    def maximum
+      source["maximum"]
+    end
+
+    # @return [Object]
+    def maxItems
+      source["maxItems"]
+    end
+
+    # @return [Object]
+    def max_length
+      source["maxLength"]
+    end
+
+    # @return [Object]
+    def minimum
+      source["minimum"]
+    end
+
+    # @return [Object]
+    def min_items
+      source["minItems"]
+    end
+
+    # @return [Object]
+    def min_length
+      source["minLength"]
+    end
+
+    # @return [Object]
+    def multiple_of
+      source["multipleOf"]
+    end
+
+    # @return [Object]
+    def pattern
+      source["pattern"]
+    end
+
+    # @return [Object]
+    def title
+      source["title"]
+    end
+
+    # @return [Object]
+    def type
+      source["type"]
+    end
+
+    # @return [false, true]
+    def unique_items
+      !!source["uniqueItems"]
+    end
+  end
+end

data/lib/swagger_parser/operation.rb

@@ -0,0 +1,67 @@
+require "swagger_parser/extendable"
+require "swagger_parser/external_docs_attributable"
+require "swagger_parser/responses"
+require "swagger_parser/security"
+require "swagger_parser/source_based_object"
+
+module SwaggerParser
+  class Operation < SourceBasedObject
+    include SwaggerParser::Extendable
+    include SwaggerParser::ExternalDocsAttributable
+
+    # @return [Object]
+    def consumes
+      source["consumes"] || []
+    end
+
+    # @return [false, true]
+    def deprecated
+      !!source["deprecated"]
+    end
+
+    # @return [Object]
+    def description
+      source["description"]
+    end
+
+    # @return [Object]
+    def operation_id
+      source["operationId"]
+    end
+
+    # @return [SwaggerParser::Parameters]
+    def parameters
+      SwaggerParser::Parameters.new(source["parameters"] || {})
+    end
+
+    # @return [Object]
+    def produces
+      source["produces"]
+    end
+
+    # @return [SwaggerParser::Responses]
+    def responses
+      SwaggerParser::Responses.new(source["responses"] || {})
+    end
+
+    # @return [Object]
+    def schemes
+      source["schemes"]
+    end
+
+    # @return [Object]
+    def security
+      SwaggerParser::Security.new(source["security"] || {})
+    end
+
+    # @return [Object]
+    def summary
+      source["summary"]
+    end
+
+    # @return [Array<String>]
+    def tags
+      source["tags"] || []
+    end
+  end
+end

data/lib/swagger_parser/parameter.rb

@@ -0,0 +1,59 @@
+require "swagger_parser/extendable"
+require "swagger_parser/items"
+require "swagger_parser/json_schema"
+
+module SwaggerParser
+  class Parameter < JsonSchema
+    include SwaggerParser::Extendable
+
+    # @return [Object]
+    def allow_empty_value
+      source["allowEmptyValue"]
+    end
+
+    # @return [Object]
+    def boolean
+      source["boolean"]
+    end
+
+    # @return [Object]
+    def collection_format
+      source["collectionFormat"]
+    end
+
+    # @return [Object]
+    def in
+      source["in"]
+    end
+
+    # @return [Array<SwaggerParser::Items>, nil]
+    def items
+      if source["items"]
+        SwaggerParser::Item.new(source["items"])
+      end
+    end
+
+    # @return [Object]
+    def name
+      source["name"]
+    end
+
+    # @note Override because this "required" is different from JSON Schema's "required"
+    # @return [false, true]
+    def required
+      !!source["required"]
+    end
+
+    # @return [Object]
+    def schema
+      value = source["schema"]
+      SwaggerParser::Schema.new(value) if in_body?
+    end
+
+    private
+
+    def in_body?
+      self.in == "body"
+    end
+  end
+end

data/lib/swagger_parser/parameters.rb

@@ -0,0 +1,13 @@
+require "swagger_parser/enumerable_object"
+require "swagger_parser/parameter"
+
+module SwaggerParser
+  class Parameters < EnumerableObject
+    private
+
+    # @note Implementation for SwaggerParser::EnumerableObject
+    def build_element(value)
+      SwaggerParser::Parameter.new(value)
+    end
+  end
+end

data/lib/swagger_parser/path.rb

@@ -0,0 +1,65 @@
+require "swagger_parser/extendable"
+require "swagger_parser/operation"
+require "swagger_parser/referable"
+require "swagger_parser/source_based_object"
+
+module SwaggerParser
+  class Path < SourceBasedObject
+    include SwaggerParser::Extendable
+    include SwaggerParser::Referable
+
+    # @return [SwaggerParser::Operation, nil]
+    def delete
+      if source["delete"]
+        SwaggerParser::Operation.new(source["delete"])
+      end
+    end
+
+    # @return [SwaggerParser::Operation, nil]
+    def get
+      if source["get"]
+        SwaggerParser::Operation.new(source["get"])
+      end
+    end
+
+    # @return [SwaggerParser::Operation, nil]
+    def head
+      if source["head"]
+        SwaggerParser::Operation.new(source["head"])
+      end
+    end
+
+    # @return [SwaggerParser::Operation, nil]
+    def options
+      if source["options"]
+        SwaggerParser::Operation.new(source["options"])
+      end
+    end
+
+    # @return [Object]
+    def parameters
+      source["parameters"]
+    end
+
+    # @return [SwaggerParser::Operation, nil]
+    def patch
+      if source["patch"]
+        SwaggerParser::Operation.new(source["patch"])
+      end
+    end
+
+    # @return [SwaggerParser::Operation, nil]
+    def post
+      if source["post"]
+        SwaggerParser::Operation.new(source["post"])
+      end
+    end
+
+    # @return [SwaggerParser::Operation, nil]
+    def put
+      if source["put"]
+        SwaggerParser::Operation.new(source["put"])
+      end
+    end
+  end
+end

data/lib/swagger_parser/paths.rb

@@ -0,0 +1,16 @@
+require "swagger_parser/enumerable_object"
+require "swagger_parser/extendable"
+require "swagger_parser/path"
+
+module SwaggerParser
+  class Paths < EnumerableObject
+    include SwaggerParser::Extendable
+
+    private
+
+    # @note Implementation for SwaggerParser::EnumerableObject
+    def build_element(value)
+      SwaggerParser::Path.new(value)
+    end
+  end
+end

data/lib/swagger_parser/referable.rb

@@ -0,0 +1,8 @@
+module SwaggerParser
+  module Referable
+    # @return [Object]
+    def ref
+      source["$ref"]
+    end
+  end
+end

data/lib/swagger_parser/reference.rb

@@ -0,0 +1,8 @@
+require "swagger_parser/referable"
+require "swagger_parser/source_based_object"
+
+module SwaggerParser
+  class Reference < SourceBasedObject
+    include SwaggerParser::Referable
+  end
+end

data/lib/swagger_parser/response.rb

@@ -0,0 +1,31 @@
+require "swagger_parser/examples"
+require "swagger_parser/headers"
+require "swagger_parser/schema"
+require "swagger_parser/source_based_object"
+
+module SwaggerParser
+  class Response < SourceBasedObject
+    # @return [Object]
+    def description
+      source["description"]
+    end
+
+    # @return [SwaggerParser::Examples]
+    def examples
+      SwaggerParser::Examples.new(source["examples"] || {})
+    end
+
+    # @return [SwaggerParser::Headers]
+    # @return [Object]
+    def headers
+      SwaggerParser::Headers.new(source["headers"] || {})
+    end
+
+    # @return [SwaggerParser::Schema, nil]
+    def schema
+      if source["schema"]
+        SwaggerParser::Schema.new(source["schema"])
+      end
+    end
+  end
+end

data/lib/swagger_parser/response_definitions.rb

@@ -0,0 +1,13 @@
+require "swagger_parser/enumerable_object"
+require "swagger_parser/response"
+
+module SwaggerParser
+  class ResponseDefinitions < EnumerableObject
+    private
+
+    # @note Implementation for SwaggerParser::EnumerableObject
+    def build_element(value)
+      SwaggerParser::Response.new(value)
+    end
+  end
+end

data/lib/swagger_parser/responses.rb

@@ -0,0 +1,18 @@
+require "swagger_parser/enumerable_object"
+require "swagger_parser/reference"
+require "swagger_parser/response"
+
+module SwaggerParser
+  class Responses < EnumerableObject
+    private
+
+    # @note Implementation for SwaggerParser::EnumerableObject
+    def build_element(value)
+      if value["$ref"]
+        SwaggerParser::Reference.new(value)
+      else
+        SwaggerParser::Response.new(value)
+      end
+    end
+  end
+end