swagger-parser 0.2.5

data/lib/swagger/v2/example.rb

@@ -0,0 +1,32 @@
+module Swagger
+  module V2
+    # A class to represent example objects in the Swagger schema.
+    # Usually used to represent example request or responses.
+    # Provides access to both the raw example or a parsed representation.
+    class Example
+      extend Forwardable
+      def_delegator :@raw, :to_s, :inspect
+
+      # The example as it appears in the Swagger document.
+      # @return Object the example
+      attr_reader :raw
+
+      def initialize(sample)
+        @raw = sample
+      end
+
+      # The example after it has been parsed to match the +media_type+.
+      # @param media_type [String] the target media_type
+      # @return [Object] an object according to the +media_type+
+      def parse(media_type = 'application/json')
+        return @raw unless @raw.is_a? String
+        parser = Swagger::MimeType.parser_for(media_type)
+        parser.parse(@raw)
+      end
+
+      def inspect
+        @raw.inspect
+      end
+    end
+  end
+end

data/lib/swagger/v2/header.rb

@@ -0,0 +1,22 @@
+require 'swagger/swagger_object'
+
+module Swagger
+  module V2
+    # Class representing a Swagger "Header Object".
+    # @see https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#headerObject Header Object
+    class Header < SwaggerObject
+      # @!group Fixed Fields
+      field :description, String
+      field :required, Swagger::Boolean
+      alias_method :required?, :required
+      field :type, String
+      field :format, String
+      field :items, Hash # TODO: Items Object
+      field :collectionFormat, String
+      field :default, Object
+      # @!endgroup
+
+      include DeterministicJSONSchema
+    end
+  end
+end

data/lib/swagger/v2/info.rb

@@ -0,0 +1,33 @@
+require 'swagger/swagger_object'
+
+module Swagger
+  module V2
+    # Class representing a Swagger "Info Object".
+    # @see https://github.com/wordnik/swagger-spec/blob/master/versions/2.0.md#infoObject Info Object
+    class Info < SwaggerObject
+      # Class representing a Swagger "Contact Object".
+      # @see https://github.com/wordnik/swagger-spec/blob/master/versions/2.0.md#contactObject Contact Object
+      class Contact < SwaggerObject
+        # @group Swagger Fields
+        field :name, String
+        field :url, Swagger::URI
+        field :email, String
+        # @endgroup
+      end
+
+      # Class representing a Swagger "License Object".
+      # @see https://github.com/wordnik/swagger-spec/blob/master/versions/2.0.md#licenseObject License Object
+      class License < SwaggerObject
+        required_field :name, String
+        field :url, Swagger::URI
+      end
+
+      required_field :title, String
+      field :description, String
+      field :termsOfService, String
+      field :contact, Contact
+      field :license, License
+      required_field :version, String
+    end
+  end
+end

data/lib/swagger/v2/operation.rb

@@ -0,0 +1,66 @@
+require 'swagger/swagger_object'
+require 'swagger/v2/parameter'
+require 'swagger/v2/response'
+require 'swagger/v2/security_requirement'
+
+module Swagger
+  module V2
+    # Class representing a Swagger "Operation Object".
+    # @see https://github.com/wordnik/swagger-spec/blob/master/versions/2.0.md#operationObject Operation Object
+    class Operation < SwaggerObject
+      extend Forwardable
+      def_delegators :parent, :uri_template, :path, :host
+
+      field :summary, String
+      field :description, String
+      field :operationId, String
+      alias_method :operation_id, :operationId
+      field :produces, Array[String] # TODO: Need a lookup that merges w/ API-level field
+      field :consumes, Array[String] # TODO: Need a lookup that merges w/ API-level field
+      field :tags, Array[String] # TODO: This is an array of tag names, need to handle resolution name -> Tag object
+      field :parameters, Array[Parameter] # TODO: Can't decide if default: [] is useful or troublesome
+      field :responses, Hash[String => Response]
+      field :schemes, Array[String] # TODO: Need a lookup that merges w/ API-level field
+      field :security, Array[SecurityRequirement] # TODO: Need a lookup that merges w/ API-level field
+      field :externalDocs, Object # TODO: ExternalDocumentation class
+      field :deprecated, Swagger::Boolean
+
+      def api_title
+        root.info.title
+      end
+
+      def full_name
+        "#{api_title} - #{summary}"
+      end
+
+      # The HTTP verb for the operation.
+      def verb
+        parent.operations.key self
+      end
+
+      def signature
+        "#{verb.to_s.upcase} #{parent.uri_template}"
+      end
+
+      def default_response
+        return nil if responses.nil? || responses.values.nil?
+
+        # FIXME: Swagger isn't very clear on "normal response codes"
+        # In the examples, default is actually an error
+        responses['200'] || responses['201'] || responses['default'] || responses.values.first
+      end
+
+      # Iterates over each parameter defined directly on the operation, excluding parameters
+      # defined at the API level.
+      def each_parameter
+        return if parameters.nil?
+        parameters.each do |parameter|
+          yield parameter
+        end
+      end
+
+      # Iterates over all parameters defined on this operation or at the API level
+      # TODO: Implement all_parameters
+    end
+  end
+end

data/lib/swagger/v2/parameter.rb

@@ -0,0 +1,35 @@
+require 'swagger/swagger_object'
+
+module Swagger
+  module V2
+    # Class representing a Swagger "Parameter Object".
+    # @see https://github.com/wordnik/swagger-spec/blob/master/versions/2.0.md#parameterObject Parameter Object
+    class Parameter < SwaggerObject
+      # @!group Fixed Fields
+      #required_field :name, String
+      # required_field :in, String
+      field :name, String
+      field :in, String
+      field :description, String
+      field :required, Swagger::Boolean
+      alias_method :required?, :required
+      # @!endgroup
+
+      # @!group Body Fields
+      field :schema, Schema
+      # @!endgroup
+
+      # @!group Non-Body Fields
+      field :type, String
+      field :format, String
+      field :items, Hash # TODO: Items Object
+      field :collectionFormat, String
+      field :default, Object
+      field :allowEmptyValue, Swagger::Boolean
+      alias_method :allowEmptyValue?, :allowEmptyValue
+      # @!endgroup
+
+      include DeterministicJSONSchema
+    end
+  end
+end

data/lib/swagger/v2/path.rb

@@ -0,0 +1,47 @@
+require 'swagger/swagger_object'
+require 'swagger/v2/operation'
+
+module Swagger
+  module V2
+    # Class representing a Swagger "Path Item Object".
+    # @see https://github.com/wordnik/swagger-spec/blob/master/versions/2.0.md#pathItemObject Path Item Object
+    class Path < SwaggerObject
+      extend Forwardable
+      def_delegator :parent, :host
+
+      VERBS = [:get, :put, :post, :delete, :options, :head, :patch]
+      VERBS.each do |verb|
+        field verb, Operation
+      end
+      field :parameters, Array[Parameter]
+
+      def initialize(hash)
+        hash[:parameters] ||= []
+        super
+      end
+
+      def operations
+        VERBS.each_with_object({}) do |v, h|
+          operation = send v
+          h[v] = operation if operation
+        end
+      end
+
+      def uri_template
+        "#{parent.host}#{parent.base_path}#{path}"
+      end
+
+      def path
+        parent.paths.key self
+      end
+
+      # Iterates over each Path level parameter.
+      def each_parameter
+        return if parameters.nil?
+        parameters.each do |parameter|
+          yield parameter
+        end
+      end
+    end
+  end
+end

data/lib/swagger/v2/response.rb

@@ -0,0 +1,26 @@
+require 'swagger/swagger_object'
+require 'swagger/v2/example'
+require 'swagger/v2/header'
+
+module Swagger
+  module V2
+    # Class representing a Swagger "Response Object".
+    # @see https://github.com/wordnik/swagger-spec/blob/master/versions/2.0.md#responseObject Response Object
+    class Response < SwaggerObject
+      field :description, String
+      field :schema, Swagger::Schema
+      field :headers, Hash[String => Header] # TODO: Headers
+      field :examples, Hash[Swagger::MimeType => Example]
+
+      def status_code
+        # FIXME: swagger-spec needs a defined way to define codes
+        code = parent.responses.key self
+        code = '200' if code == 'default'
+        code.to_i
+      rescue
+        # TODO: Warning?
+        200
+      end
+    end
+  end
+end

data/lib/swagger/v2/security_requirement.rb

@@ -0,0 +1,12 @@
+require 'swagger/swagger_object'
+
+module Swagger
+  module V2
+    # Class representing a Swagger "Security Requirement Object".
+    # @see https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#securityRequirementObject
+    #   Security Requirement Object
+    class SecurityRequirement < Hashie::Mash
+      # TODO: Need proper constraints, but coercion is tricky
+    end
+  end
+end

data/lib/swagger/v2/security_scheme.rb

@@ -0,0 +1,25 @@
+require 'swagger/swagger_object'
+
+module Swagger
+  module V2
+    # Class representing a Swagger "Security Scheme Object".
+    # @see https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#securitySchemeObject
+    #   Security Scheme Object
+    class SecurityScheme < SwaggerObject
+      # FIXME: Swagger documentation about what's required doesn't seem accurate - OSAuth2 centric?
+
+      # According to docs, all except description are required. Schema and samples don't match.
+
+      # @!group Fixed Fields
+      field :type, String
+      field :description, String
+      field :name, String
+      field :in, String
+      field :flow, String
+      field :authorizationUrl, String
+      field :tokenUrl, String
+      field :scopes, Hash
+      # @!endgroup
+    end
+  end
+end

data/lib/swagger/v2/tag.rb

@@ -0,0 +1,11 @@
+module Swagger
+  module V2
+    # Class representing a Swagger "Tag Object".
+    # @see https://github.com/wordnik/swagger-spec/blob/master/versions/2.0.md#tagObject Tag Object
+    class Tag < SwaggerObject
+      required_field :name, String
+      field :description, String
+      # TODO: Documentable
+    end
+  end
+end

data/lib/swagger/version.rb

@@ -0,0 +1,3 @@
+module Swagger
+  VERSION = '0.2.5'
+end

data/resources/schemas/json_schema/draft-04.json

@@ -0,0 +1,150 @@
+{
+    "id": "http://json-schema.org/draft-04/schema#",
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "description": "Core schema meta-schema",
+    "definitions": {
+        "schemaArray": {
+            "type": "array",
+            "minItems": 1,
+            "items": { "$ref": "#" }
+        },
+        "positiveInteger": {
+            "type": "integer",
+            "minimum": 0
+        },
+        "positiveIntegerDefault0": {
+            "allOf": [ { "$ref": "#/definitions/positiveInteger" }, { "default": 0 } ]
+        },
+        "simpleTypes": {
+            "enum": [ "array", "boolean", "integer", "null", "number", "object", "string" ]
+        },
+        "stringArray": {
+            "type": "array",
+            "items": { "type": "string" },
+            "minItems": 1,
+            "uniqueItems": true
+        }
+    },
+    "type": "object",
+    "properties": {
+        "id": {
+            "type": "string",
+            "format": "uri"
+        },
+        "$schema": {
+            "type": "string",
+            "format": "uri"
+        },
+        "title": {
+            "type": "string"
+        },
+        "description": {
+            "type": "string"
+        },
+        "default": {},
+        "multipleOf": {
+            "type": "number",
+            "minimum": 0,
+            "exclusiveMinimum": true
+        },
+        "maximum": {
+            "type": "number"
+        },
+        "exclusiveMaximum": {
+            "type": "boolean",
+            "default": false
+        },
+        "minimum": {
+            "type": "number"
+        },
+        "exclusiveMinimum": {
+            "type": "boolean",
+            "default": false
+        },
+        "maxLength": { "$ref": "#/definitions/positiveInteger" },
+        "minLength": { "$ref": "#/definitions/positiveIntegerDefault0" },
+        "pattern": {
+            "type": "string",
+            "format": "regex"
+        },
+        "additionalItems": {
+            "anyOf": [
+                { "type": "boolean" },
+                { "$ref": "#" }
+            ],
+            "default": {}
+        },
+        "items": {
+            "anyOf": [
+                { "$ref": "#" },
+                { "$ref": "#/definitions/schemaArray" }
+            ],
+            "default": {}
+        },
+        "maxItems": { "$ref": "#/definitions/positiveInteger" },
+        "minItems": { "$ref": "#/definitions/positiveIntegerDefault0" },
+        "uniqueItems": {
+            "type": "boolean",
+            "default": false
+        },
+        "maxProperties": { "$ref": "#/definitions/positiveInteger" },
+        "minProperties": { "$ref": "#/definitions/positiveIntegerDefault0" },
+        "required": { "$ref": "#/definitions/stringArray" },
+        "additionalProperties": {
+            "anyOf": [
+                { "type": "boolean" },
+                { "$ref": "#" }
+            ],
+            "default": {}
+        },
+        "definitions": {
+            "type": "object",
+            "additionalProperties": { "$ref": "#" },
+            "default": {}
+        },
+        "properties": {
+            "type": "object",
+            "additionalProperties": { "$ref": "#" },
+            "default": {}
+        },
+        "patternProperties": {
+            "type": "object",
+            "additionalProperties": { "$ref": "#" },
+            "default": {}
+        },
+        "dependencies": {
+            "type": "object",
+            "additionalProperties": {
+                "anyOf": [
+                    { "$ref": "#" },
+                    { "$ref": "#/definitions/stringArray" }
+                ]
+            }
+        },
+        "enum": {
+            "type": "array",
+            "minItems": 1,
+            "uniqueItems": true
+        },
+        "type": {
+            "anyOf": [
+                { "$ref": "#/definitions/simpleTypes" },
+                {
+                    "type": "array",
+                    "items": { "$ref": "#/definitions/simpleTypes" },
+                    "minItems": 1,
+                    "uniqueItems": true
+                }
+            ]
+        },
+        "allOf": { "$ref": "#/definitions/schemaArray" },
+        "anyOf": { "$ref": "#/definitions/schemaArray" },
+        "oneOf": { "$ref": "#/definitions/schemaArray" },
+        "not": { "$ref": "#" }
+    },
+    "dependencies": {
+        "exclusiveMaximum": [ "maximum" ],
+        "exclusiveMinimum": [ "minimum" ]
+    },
+    "default": {}
+}