swagger-parser 0.2.5

data/lib/swagger/mime_type.rb

@@ -0,0 +1,46 @@
+require 'mime/types'
+
+module Swagger
+  # Class representing Media Types (commonly known as MIME Types).
+  # @see http://en.wikipedia.org/wiki/Internet_media_type
+  class MimeType < String
+    extend Forwardable
+    def_delegators :@mime_type, :media_type, :sub_type
+
+    MIME_TYPE_FORMAT = /(\w+)\/(\w+\.)?([\w\.]+)(\+\w+)?\s*(;.*)?/
+
+    COMMON_ALIASES = {
+      txt:    'text/plain',
+      text:   'text/plain',
+      json:   'application/json',
+      xml:    'application/xml',
+      binary: 'application/octet-stream'
+    }
+
+    def initialize(mime_type_name)
+      @mime_type_name = mime_type_name.to_s
+      @mime_type = MIME::Types[@mime_type_name].first || base_type(@mime_type_name)
+      #fail ArgumentError, "Unknown mime type or suffix: #{mime_type_name}" if @mime_type.nil?
+      @mime_type ||= MIME::Types["text/plain"].first
+      super @mime_type_name
+    end
+
+    def self.parser_for(mime_type)
+      mime_type = COMMON_ALIASES[mime_type] if COMMON_ALIASES.key? mime_type
+      case mime_type
+      when 'application/json'
+        return JSON
+      else
+        fail NotImplementedError, "Parser support for #{mime_type} is not implemented"
+      end
+    end
+
+    private
+
+    def base_type(mime_type_name)
+      media_type, _sub_type, _tree, suffix, _parameters = MIME_TYPE_FORMAT.match mime_type_name
+      return MIME::Types["#{media_type}/#{suffix}"].first if media_type && suffix
+      nil
+    end
+  end
+end

data/lib/swagger/notes.md

@@ -0,0 +1,35 @@
+Classes added to Swagger-Core (Java) for 2.0:
+- [] modules/swagger-core/src/main/java/com/wordnik/swagger/converter/ModelConverters.java
+- []  modules/swagger-core/src/main/java/com/wordnik/swagger/models/Contact.java
+- []  modules/swagger-core/src/main/java/com/wordnik/swagger/models/Info.java
+- []  modules/swagger-core/src/main/java/com/wordnik/swagger/models/License.java
+- []  modules/swagger-core/src/main/java/com/wordnik/swagger/models/Model.java
+- []  modules/swagger-core/src/main/java/com/wordnik/swagger/models/ModelFactory.java
+- []  modules/swagger-core/src/main/java/com/wordnik/swagger/models/Operation.java
+- []  modules/swagger-core/src/main/java/com/wordnik/swagger/models/Path.java
+- []  modules/swagger-core/src/main/java/com/wordnik/swagger/models/RefModel.java
+- []  modules/swagger-core/src/main/java/com/wordnik/swagger/models/Response.java
+- []  modules/swagger-core/src/main/java/com/wordnik/swagger/models/Scheme.java
+- []  modules/swagger-core/src/main/java/com/wordnik/swagger/models/Security.java
+- []  modules/swagger-core/src/main/java/com/wordnik/swagger/models/Swagger.java
+- []  modules/swagger-core/src/main/java/com/wordnik/swagger/models/parameters/AbstractParameter.java
+- []  modules/swagger-core/src/main/java/com/wordnik/swagger/models/parameters/BodyParameter.java
+- []  modules/swagger-core/src/main/java/com/wordnik/swagger/models/parameters/CookieParameter.java
+- []  modules/swagger-core/src/main/java/com/wordnik/swagger/models/parameters/HeaderParameter.java
+- []  modules/swagger-core/src/main/java/com/wordnik/swagger/models/parameters/Parameter.java
+- []  modules/swagger-core/src/main/java/com/wordnik/swagger/models/parameters/PathParameter.java
+- []  modules/swagger-core/src/main/java/com/wordnik/swagger/models/parameters/QueryParameter.java
+- []  modules/swagger-core/src/main/java/com/wordnik/swagger/models/properties/AbstractProperty.java
+- []  modules/swagger-core/src/main/java/com/wordnik/swagger/models/properties/ArrayProperty.java
+- []  modules/swagger-core/src/main/java/com/wordnik/swagger/models/properties/BooleanProperty.java
+- []  modules/swagger-core/src/main/java/com/wordnik/swagger/models/properties/DateProperty.java
+- []  modules/swagger-core/src/main/java/com/wordnik/swagger/models/properties/DateTimeProperty.java
+- []  modules/swagger-core/src/main/java/com/wordnik/swagger/models/properties/DoubleProperty.java
+- []  modules/swagger-core/src/main/java/com/wordnik/swagger/models/properties/IntegerProperty.java
+- []  modules/swagger-core/src/main/java/com/wordnik/swagger/models/properties/LongProperty.java
+- []  modules/swagger-core/src/main/java/com/wordnik/swagger/models/properties/MapProperty.java
+- []  modules/swagger-core/src/main/java/com/wordnik/swagger/models/properties/Property.java
+- []  modules/swagger-core/src/main/java/com/wordnik/swagger/models/properties/RefProperty.java
+- []  modules/swagger-core/src/main/java/com/wordnik/swagger/models/properties/StringProperty.java
+- []  modules/swagger-core/src/main/java/com/wordnik/swagger/models/properties/Xml.java
+- []  modules/swagger-core/src/main/java/com/wordnik/swagger/util/Json.java

data/lib/swagger/parsers.rb

@@ -0,0 +1,36 @@
+autoload :YAML, 'yaml'
+autoload :JSON, 'json'
+
+module Swagger
+  # Provides classes for loading Swagger from YAML or JSON.
+  module Parsers
+    def self.parser_for(format)
+      case format
+      when '.yaml', '.yml', :yaml
+        YAMLParser
+      when '.json', '.js', :json
+        JSONParser
+      end
+    end
+
+    # Parses YAML content
+    class YAMLParser
+      # Parses a YAML document
+      # @param content [String] The YAML content to parse
+      # @return [Hash] the parsed content
+      def self.parse(content)
+        YAML.load(content)
+      end
+    end
+
+    # Parses JSON content
+    class JSONParser
+      # Parses a JSON document
+      # @param content [String] The JSON content to parse
+      # @return [Hash] the parsed content
+      def self.parse(content)
+        JSON.parse(content)
+      end
+    end
+  end
+end

data/lib/swagger/schema.rb

@@ -0,0 +1,63 @@
+module Swagger
+  # Represents a Swagger Schema Object, a more deterministic subset of JSON Schema.
+  # @see https://github.com/wordnik/swagger-spec/blob/master/versions/2.0.md#schema-object- Schema Object
+  # @see http://json-schema.org/ JSON Schema
+  class Schema < Hashie::Mash
+    include Attachable
+    include Hashie::Extensions::MergeInitializer
+    include Hashie::Extensions::DeepFind
+    attr_accessor :parent
+
+    def initialize(hash, default = nil)
+      super
+      attach_to_children
+    end
+
+    def parse
+      schema = clone
+      if schema.key?('$ref')
+        key = schema.delete('$ref').split('/').last
+        model = root.definitions[key]
+        schema.merge!(model)
+      end
+
+      count = 0
+      until schema.refs_resolved?
+        fail 'Could not resolve non-remote $refs 5 cycles - circular references?' if count >= 5
+        schema.resolve_refs
+        count += 1
+      end
+
+      schema.to_hash
+    end
+
+    protected
+
+    def refs
+      deep_find_all('$ref')
+    end
+
+    def resolve_refs
+      children.each do |child|
+        child.resolve_refs if child.is_a?(Swagger::Schema)
+      end
+      key = self.delete('$ref')
+      return if key.nil? || remote_ref?(key)
+      key = key.split('/').last
+      model = root.definitions[key]
+      self.merge!(model)
+    end
+
+    def refs_resolved?
+      return true if refs.nil?
+
+      refs.all? do |ref|
+        remote_ref?(ref)
+      end
+    end
+
+    def remote_ref?(ref)
+      ref.match(%r{\A\w+\://})
+    end
+  end
+end

data/lib/swagger/swagger_object.rb

@@ -0,0 +1,49 @@
+module Swagger
+  # A class that represents an Object defined in the Swagger specification.
+  # Provides methods for defining fields in the object.
+  class SwaggerObject < Hashie::Dash
+    include Hashie::Extensions::Coercion
+    include Hashie::Extensions::IndifferentAccess
+    include Swagger::Attachable
+
+    CUSTOM_PROPERTY_PREFIX = /^x\-/
+
+    # Swagger allows any properties starting with `x-`
+    def self.property?(name)
+      super(name) || name.to_s =~ CUSTOM_PROPERTY_PREFIX
+    end
+
+    attr_accessor :parent
+
+    # @api private
+    # Initializes a Swagger object, using Hashie::Dash,
+    # and attaches to children objects so navigation via +parent+
+    # and +root+ is possible.
+    def initialize(hash)
+      super
+      attach_to_children
+    end
+
+    # @api private
+    # @!macro [attach] field
+    #   @!attribute [rw] $1
+    #     Swagger field $1. $3
+    #     @return [$2]
+    # Defines a Swagger field on a class.
+    def self.field(name, type, opts = {})
+      property name, opts
+      coerce_key name, type
+    end
+
+    # @api private
+    # @!macro [attach] required_field
+    #   @!attribute [rw] $1
+    #     **Required** Swagger field $1. $3
+    #     @return [$2]
+    # Defines a required Swagger field on a class.
+    def self.required_field(name, type, opts = {})
+      opts[:required] = true
+      field(name, type, opts)
+    end
+  end
+end

data/lib/swagger/uri.rb

@@ -0,0 +1,11 @@
+module Swagger
+  # Class representing a URI. Backed by Addressable::URI.
+  # @see http://en.wikipedia.org/wiki/Uniform_resource_identifier
+  class URI < String
+    attr_reader :uri
+    def initialize(string)
+      @uri = Addressable::URI.heuristic_parse string
+      super
+    end
+  end
+end

data/lib/swagger/uri_template.rb

@@ -0,0 +1,11 @@
+module Swagger
+  # Class representing a URI Template. Backed by Addressable::Template.
+  # @see http://tools.ietf.org/html/rfc6570
+  class URITemplate < String
+    attr_reader :uri_template
+    def initialize(string)
+      @uri_template = Addressable::Template.new(string)
+      super
+    end
+  end
+end

data/lib/swagger/v2/api.rb

@@ -0,0 +1,90 @@
+require 'swagger/swagger_object'
+require 'swagger/v2/deterministic_json_schema'
+require 'swagger/v2/info'
+require 'swagger/v2/path'
+require 'swagger/v2/tag'
+require 'swagger/v2/security_scheme'
+require 'swagger/v2/security_requirement'
+require 'json-schema'
+
+module Swagger
+  # Module containing classes that handle version 2 of the Swagger specification.
+  # @see https://github.com/wordnik/swagger-spec/blob/master/versions/2.0.md Swagger Specification 2.0
+  module V2
+    SWAGGER_SCHEMA = File.expand_path 'schemas/swagger/v2.0/schema.json', Swagger::RESOURCES_DIR
+    JSON_SCHEMA = File.expand_path 'schemas/json_schema/draft-04.json', Swagger::RESOURCES_DIR
+
+    # Class representing the top level "Swagger Object"
+    # @see https://github.com/wordnik/swagger-spec/blob/master/versions/2.0.md#swagger-object- Swagger Object
+    class API < Swagger::API
+      # @group Swagger Fields
+      required_field :swagger, String
+      required_field :info, Info
+      field :host, Swagger::URITemplate
+      field :basePath, Swagger::URITemplate
+      field :schemes, Array[String]
+      field :consumes, Array[String]
+      field :produces, Array[String]
+      required_field :paths, Hash[String => Path]
+      field :definitions, Hash[String => Schema]
+      field :parameters, Hash[String => Parameter]
+      field :responses, Hash[String => Response]
+      field :securityDefinitions, Hash[String => SecurityScheme]
+      field :security, Array[SecurityRequirement]
+      field :tags, Array[Object] # FIXME: This is actually an array of Tag objects
+      field :externalDocs, Object # TODO: ExternalDocs class
+      # @endgroup
+
+      alias_method :base_path, :basePath
+
+      # All operations under all paths
+      # @return [Array<Operation>]
+      def operations
+        # Perhaps not the best way...
+        paths.values.map do |path|
+          path.operations.values
+        end.flatten
+      end
+
+      # A complete (including host) URI Template for the basePath.
+      # @return [Swagger::URITemplate]
+      def uri_template
+        Swagger::URITemplate.new("#{host}#{basePath}")
+      end
+
+      # Validates this object against the Swagger specification and returns all detected errors.
+      # Slower than {#validate}.
+      # @return [true] if the object fully complies with the Swagger specification.
+      # @raise [Swagger::InvalidDefinition] if any errors are found.
+      def fully_validate
+        # NOTE: fully_validate is ideal, but very slow with the current schema/validator
+        errors = JSON::Validator.fully_validate(swagger_schema, to_json)
+        fail Swagger::InvalidDefinition, errors unless errors.empty?
+        true
+      end
+
+      # Validates this object against the Swagger specification and returns the first detected error.
+      # Faster than {#fully_validate}.
+      # @return [true] if the object fully complies with the Swagger specification.
+      # @raise [Swagger::InvalidDefinition] if an error is found.
+      def validate
+        JSON::Validator.validate!(swagger_schema, to_json)
+      rescue JSON::Schema::ValidationError => e
+        raise Swagger::InvalidDefinition, e.message
+      end
+
+      private
+
+      def swagger_schema
+        @swagger_schema ||= JSON.parse(File.read(SWAGGER_SCHEMA))
+
+        # FIXME: Swagger should be able to parse offline. Blocked by json-schema.
+        # Offline workaround
+        # @swagger_schema = JSON.parse(File.read(SWAGGER_SCHEMA)
+        #   .gsub('http://json-schema.org/draft-04/schema', "file://#{SWAGGER_SCHEMA}"))
+        # @swagger_schema['$schema'] = 'http://json-schema.org/draft-04/schema#'
+        # @swagger_schema
+      end
+    end
+  end
+end

data/lib/swagger/v2/deterministic_json_schema.rb

@@ -0,0 +1,130 @@
+module Swagger
+  module V2
+    # A Swagger Schema Object, which is subset of JSON-Schema that's constrainted to be more deterministic.
+    # @see https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#schema-object- Schema Object
+    # @see http://json-schema.org/ JSON-Schema
+    module DeterministicJSONSchema
+      # FIXME: yard group doesn't seem to work below
+
+      # @!group Deterministic JSON Schema
+      # @!attribute [rw] $ref
+      #     JSON-Schema field $ref.
+      #     @return String
+      # @!attribute [rw] format
+      #     JSON-Schema field format.
+      #     @return String
+      # @!attribute [rw] title
+      #     JSON-Schema field title.
+      #     @return String
+      # @!attribute [rw] description
+      #     JSON-Schema field description.
+      #     @return String
+      # @!attribute [rw] default
+      #     JSON-Schema field default.
+      #     @return Object
+      # @!attribute [rw] multipleOf
+      #     JSON-Schema field multipleOf.
+      #     @return Object
+      # @!attribute [rw] maximum
+      #     JSON-Schema field maximum.
+      #     @return Numeric
+      # @!attribute [rw] exclusiveMaximum
+      #     JSON-Schema field exclusiveMaximum.
+      #     @return boolean
+      # @!attribute [rw] minimum
+      #     JSON-Schema field minimum.
+      #     @return Numeric
+      # @!attribute [rw] exclusiveMinimum
+      #     JSON-Schema field exclusiveMinimum.
+      #     @return boolean
+      # @!attribute [rw] minLength
+      #     JSON-Schema field minLength.
+      #     @return Integer
+      # @!attribute [rw] maxLength
+      #     JSON-Schema field maxLength.
+      #     @return Integer
+      # @!attribute [rw] pattern
+      #     JSON-Schema field pattern.
+      #     @return Regexp
+      # @!attribute [rw] minItems
+      #     JSON-Schema field minItems.
+      #     @return Integer
+      # @!attribute [rw] maxItems
+      #     JSON-Schema field maxItems.
+      #     @return Integer
+      # @!attribute [rw] uniqueItems
+      #     JSON-Schema field uniqueItems.
+      #     @return boolean
+      # @!attribute [rw] maxProperties
+      #     JSON-Schema field maxProperties.
+      #     @return Integer
+      # @!attribute [rw] minProperties
+      #     JSON-Schema field minProperties.
+      #     @return Integer
+      # @!attribute [rw] required
+      #     JSON-Schema field required.
+      #     @return boolean
+      # @!attribute [rw] enum
+      #     JSON-Schema field enum.
+      #     @return Array[Object]
+      # @!attribute [rw] type
+      #     JSON-Schema field type.
+      #     @return Object
+      # @!endgroup
+
+      # @!group Swagger specific extensions
+      # @!attribute [rw] discriminator
+      #     Swagger Schema field discriminator.
+      #     @return String
+      # @!attribute [rw] readOnly
+      #     Swagger Schema field readOnly.
+      #     @return boolean
+      # @!attribute [rw] xml
+      #     Swagger Schema field xml.
+      #     @return Object
+      # @!attribute [rw] externalDocs
+      #     Swagger Schema field externalDocs.
+      #     @return ExternalDocumentation
+      # @!attribute [rw] example
+      #     Swagger Schema field example.
+      #     @return Object
+      # @!endgroup
+
+      def self.included(base) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+        # Subset of standard JSON schema
+        base.field :$ref, String
+        base.field :format, String
+        base.field :title, String
+        base.field :description, String
+        base.field :default, Object
+        base.field :multipleOf, Numeric
+        base.field :maximum, Numeric
+        base.field :exclusiveMaximum, Swagger::Boolean
+        base.send(:alias_method, :exclusiveMaximum?, :exclusiveMaximum)
+        base.field :minimum, Numeric
+        base.field :exclusiveMinimum, Swagger::Boolean
+        base.send(:alias_method, :exclusiveMinimum?, :exclusiveMinimum)
+        base.field :maxLength, Integer
+        base.field :minLength, Integer
+        base.field :pattern, String
+        base.field :maxItems, Integer
+        base.field :minItems, Integer
+        base.field :uniqueItems, Swagger::Boolean
+        base.send(:alias_method, :uniqueItems?, :uniqueItems)
+        base.field :maxProperties, Integer
+        base.field :minProperties, Integer
+        base.field :required, Swagger::Boolean
+        base.send(:alias_method, :required?, :required)
+        base.field :enum, Array[Object]
+        base.field :type, Object
+
+        # Swagger extensions to JSON schema :\
+        base.field :discriminator, String
+        base.field :readOnly, Swagger::Boolean
+        base.field :xml, Object # TODO: Swagger XML object / XML support
+        base.field :externalDocs, Object # TODO: ExternalDocumentation class
+        base.field :example, Object
+      end
+    end
+  end
+end