swagger-core 0.2.0

data/spec/fixtures/petstore-full.yaml

@@ -0,0 +1,134 @@
+swagger: 2.0
+info:
+  version: 1.0.0
+  title: Swagger Petstore
+  description: |
+    A sample API that uses a petstore as an example to demonstrate
+    features in the swagger-2.0 specification
+  termsOfService: http://helloreverb.com/terms/ # Note: require TOS to be URL again?
+  contact:
+    name: Wordnik API Team
+    url: http://madskristensen.net
+    email: foo@example.com
+  license:
+    name: MIT
+    url: http://choosealicense.com/licenses/mit/
+host: petstore.swagger.wordnik.com
+basePath: /api
+schemes:
+  - http
+  - https
+  - ws
+  - wss
+consumes:
+  - application/json
+  - application/xml
+produces:
+  - application/vnd.max+json
+  - application/xml
+paths:
+  /pets:
+    parameters:
+      - name: foo
+        in: query
+        description: foos to bar by
+        required: false
+        type: array
+        format: csv
+        items:
+          type: string
+        collectionFormat: something # what other formats exist?
+    get:
+      tags:
+        - Things
+        - That
+        - Do
+        - Stuff
+      summary: Gets pets
+      description: |-
+        Returns all pets from the system that the user has access to
+        Nam sed condimentum est. Maecenas tempor sagittis sapien, nec rhoncus sem sagittis sit amet. Aenean at gravida augue, ac iaculis sem. Curabitur odio lorem, ornare eget elementum nec, cursus id lectus. Duis mi turpis, pulvinar ac eros ac, tincidunt varius justo. In hac habitasse platea dictumst. Integer at adipiscing ante, a sagittis ligula. Aenean pharetra tempor ante molestie imperdiet. Vivamus id aliquam diam. Cras quis velit non tortor eleifend sagittis. Praesent at enim pharetra urna volutpat venenatis eget eget mauris. In eleifend fermentum facilisis. Praesent enim enim, gravida ac sodales sed, placerat id erat. Suspendisse lacus dolor, consectetur non augue vel, vehicula interdum libero. Morbi euismod sagittis libero sed lacinia.
+
+        Sed tempus felis lobortis leo pulvinar rutrum. Nam mattis velit nisl, eu condimentum ligula luctus nec. Phasellus semper velit eget aliquet faucibus. In a mattis elit. Phasellus vel urna viverra, condimentum lorem id, rhoncus nibh. Ut pellentesque posuere elementum. Sed a varius odio. Morbi rhoncus ligula libero, vel eleifend nunc tristique vitae. Fusce et sem dui. Aenean nec scelerisque tortor. Fusce malesuada accumsan magna vel tempus. Quisque mollis felis eu dolor tristique, sit amet auctor felis gravida. Sed libero lorem, molestie sed nisl in, accumsan tempor nisi. Fusce sollicitudin massa ut lacinia mattis. Sed vel eleifend lorem. Pellentesque vitae felis pretium, pulvinar elit eu, euismod sapien.
+      operationId: Get Pets
+      produces:
+        - application/json
+      parameters:
+        - name: tags
+          in: query
+          description: tags to filter by
+          required: false
+          type: array
+          format: csv
+          items:
+            type: string
+          collectionFormat: something
+        - name: limit
+          in: query
+          description: maximum number of results to return
+          required: false
+          type: integer
+          format: int32
+          collectionFormat: something
+      responses:
+        200:
+          description: pet response
+          schema:
+            type: array
+            items:
+              Pet:
+                $ref: '#/models/Pet'
+          headers:
+            - is-dog:
+              type: boolean
+            - is-cat:
+              type: boolean
+          examples:
+            application/json:
+              id: 9
+              category:
+                name: domestic
+              name: monster
+              tags:
+                - name: for sale
+              status: alive
+        default:
+          description: pet response (default)
+          schema:
+            type: array
+            items:
+              Pet:
+                $ref: '#/models/Pet'
+          headers:
+            - is-dog:
+              type: boolean
+            - is-cat:
+              type: boolean
+          examples:
+            application/json:
+              id: 9
+              category:
+                name: domestic
+              name: monster
+              tags:
+                - name: for sale
+              status: alive
+      schemes:
+        - http
+        - https
+definitions:
+  Pet:
+    required:
+      - id
+      - name
+    properties:
+      id:
+        type: integer
+        format: int64
+      name:
+        type: string
+      tag:
+        type: string
+security: #
+  - No clear
+  - Definition here

data/spec/fixtures/swagger.yaml

@@ -0,0 +1,100 @@
+swagger: 2.0
+info:
+  version: 1.0.0
+  title: Swagger Petstore
+  license:
+    name: MIT
+host: petstore.swagger.wordnik.com
+basePath: /v1
+schemes:
+  - http
+consumes:
+  - application/json
+produces:
+  - application/json
+paths:
+  /pets:
+    get:
+      summary: List all pets
+      operationId: listPets
+      tags:
+        - pets
+      parameters:
+        - name: limit
+          in: query
+          description: How many items to return at one time (max 100)
+          required: false
+          type: integer
+          format: int32
+      responses:
+        200:
+          description: An paged array of pets
+          headers:
+            - x-next:
+              type: string
+              description: A link to the next page of responses
+          schema:
+            $ref: Pets
+        default:
+          description: unexpected error
+          schema:
+            $ref: Error
+    post:
+      summary: Create a pet
+      operationId: createPets
+      tags:
+        - pets
+      responses:
+        201:
+          description: Null response
+        default:
+          description: unexpected error
+          schema:
+            $ref: Error
+  /pets/{petId}:
+    get:
+      summary: Info for a specific pet
+      operationId: showPetById
+      tags:
+        - pets
+      parameters:
+        - name: petId
+          in: path
+          description: The id of the pet to retrieve
+          type: string
+      responses:
+        200:
+          description: Expected response to a valid request
+          schema:
+            $ref: Pets
+        default:
+          description: unexpected error
+          schema:
+            $ref: Error
+definitions:
+  Pet:
+    required:
+      - id
+      - name
+    properties:
+      id:
+        type: integer
+        format: int64
+      name:
+        type: string
+      tag:
+        type: string
+  Pets:
+    type: array
+    items:
+      $ref: Pet
+  Error:
+    required:
+      - code
+      - message
+    properties:
+      code:
+        type: integer
+        format: int32
+      message:
+        type: string

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+# require 'webmock' # This will disable HTTP connections
+require 'swagger'

data/spec/swagger/api_declaration_spec.rb

@@ -0,0 +1,88 @@
+require 'spec_helper'
+
+module Swagger
+  module V2
+    describe APIDeclaration do
+      let(:swagger_file) { 'spec/fixtures/petstore-full.yaml' }
+      let(:swagger) { Swagger.load swagger_file }
+      let(:expected_host) { 'petstore.swagger.wordnik.com' }
+      let(:expected_basePath) { '/api' }
+
+      context 'extras' do
+        # These are utility methods, not part of the Swagger specification
+        describe '#validate' do
+          it 'returns true if the Swagger definition complies with the Swagger schema' do
+            expect(swagger.validate).to eq(true)
+          end
+
+          it 'raises an exception if the Swagger definition does not comply with the Swagger schema' do
+            swagger.swagger = 2.1
+            expect { swagger.validate }.to raise_error(Swagger::InvalidDefinition)
+          end
+        end
+
+        describe '#fully_validate' do
+          it 'returns true if the Swagger definition complies with the Swagger schema' do
+            expect(swagger.fully_validate).to eq(true)
+          end
+
+          it 'raises an exception if the Swagger definition does not comply with the Swagger schema' do
+            swagger.swagger = 2.1
+            expect { swagger.fully_validate }.to raise_error(Swagger::InvalidDefinition)
+          end
+        end
+
+        describe '#uri_template', extension: true do
+          it 'is combines the host and basePath into a single template' do
+            # expect(swagger.uri_template).to eq(Addressable::Template.new("#{expected_host}#{expected_basePath}"))
+            expect(swagger.uri_template).to eq("#{expected_host}#{expected_basePath}")
+          end
+        end
+      end
+
+      context 'Sample petstore API' do
+        describe '#swagger' do
+          subject { swagger.swagger }
+          it { is_expected.to eq(2.0) }
+        end
+
+        describe '#info' do
+          subject { swagger.info }
+          it { is_expected.to be_a_kind_of Swagger::V2::Info }
+          # See info_spec for more
+        end
+
+        describe '#host' do
+          subject { swagger.host }
+          pending { is_expected.to be_a_kind_of Addressable::Template }
+          it { is_expected.to eq(expected_host) }
+        end
+
+        describe '#basePath' do
+          subject { swagger.basePath }
+          pending { is_expected.to be_a_kind_of Addressable::Template }
+          it { is_expected.to eq(expected_basePath) }
+        end
+
+        describe '#schemes' do
+          subject { swagger.schemes }
+          it { is_expected.to eq(%w(http https ws wss)) }
+        end
+
+        describe '#consumes' do
+          subject { swagger.consumes }
+          it { is_expected.to eq(%w(application/json application/xml)) }
+        end
+
+        describe '#produces' do
+          subject { swagger.produces }
+          it { is_expected.to eq(%w(application/vnd.max+json application/xml)) }
+        end
+
+        skip '#paths'
+        skip '#definitions'
+        skip '#security'
+      end
+    end
+  end
+end

data/spec/swagger/api_operation_spec.rb

@@ -0,0 +1,91 @@
+require 'spec_helper'
+
+module Swagger
+  module V2
+    describe APIOperation do
+      context 'Sample petstore API' do
+        let(:swagger_file) { 'spec/fixtures/petstore-full.yaml' }
+        let(:swagger) { Swagger.load swagger_file }
+        subject { swagger.paths['/pets'].get }
+
+        context 'calculated fields' do # not defined directly in the swagger spec
+          describe '#parent' do
+            subject { swagger.paths['/pets'].get.parent }
+            it { is_expected.to eq(swagger.paths['/pets']) }
+          end
+
+          describe '#uri_template' do
+            it 'is calculated from the host, basePath, and path' do
+              expect(subject.uri_template).to eq('petstore.swagger.wordnik.com/api/pets')
+            end
+          end
+        end
+
+        describe '#tags' do
+          subject { swagger.paths['/pets'].get.tags }
+          it { is_expected.to eq(%w(Things That Do Stuff)) }
+        end
+
+        describe '#summary' do
+          subject { swagger.paths['/pets'].get.summary }
+          it { is_expected.to eq('Gets pets') }
+        end
+
+        # rubocop:disable Metrics/LineLength
+        describe '#description' do
+          subject { swagger.paths['/pets'].get.description }
+          it do
+            expected = <<-'EOS'.gsub(/^[ \t]+/, '').strip
+            Returns all pets from the system that the user has access to
+            Nam sed condimentum est. Maecenas tempor sagittis sapien, nec rhoncus sem sagittis sit amet. Aenean at gravida augue, ac iaculis sem. Curabitur odio lorem, ornare eget elementum nec, cursus id lectus. Duis mi turpis, pulvinar ac eros ac, tincidunt varius justo. In hac habitasse platea dictumst. Integer at adipiscing ante, a sagittis ligula. Aenean pharetra tempor ante molestie imperdiet. Vivamus id aliquam diam. Cras quis velit non tortor eleifend sagittis. Praesent at enim pharetra urna volutpat venenatis eget eget mauris. In eleifend fermentum facilisis. Praesent enim enim, gravida ac sodales sed, placerat id erat. Suspendisse lacus dolor, consectetur non augue vel, vehicula interdum libero. Morbi euismod sagittis libero sed lacinia.
+
+            Sed tempus felis lobortis leo pulvinar rutrum. Nam mattis velit nisl, eu condimentum ligula luctus nec. Phasellus semper velit eget aliquet faucibus. In a mattis elit. Phasellus vel urna viverra, condimentum lorem id, rhoncus nibh. Ut pellentesque posuere elementum. Sed a varius odio. Morbi rhoncus ligula libero, vel eleifend nunc tristique vitae. Fusce et sem dui. Aenean nec scelerisque tortor. Fusce malesuada accumsan magna vel tempus. Quisque mollis felis eu dolor tristique, sit amet auctor felis gravida. Sed libero lorem, molestie sed nisl in, accumsan tempor nisi. Fusce sollicitudin massa ut lacinia mattis. Sed vel eleifend lorem. Pellentesque vitae felis pretium, pulvinar elit eu, euismod sapien.
+            EOS
+            is_expected.to eq(expected)
+          end
+        end
+        # rubocop:enable Metrics/LineLength
+
+        describe '#operationId' do
+          subject { swagger.paths['/pets'].get.operationId }
+          it { is_expected.to eq('Get Pets') }
+        end
+
+        # TODO: Implement alias #operation_id
+
+        describe '#produces' do
+          subject { swagger.paths['/pets'].get.produces }
+          it { is_expected.to eq(%w(application/json)) }
+        end
+
+        skip '#consumes' # swagger spec update needed
+        describe '#parameters' do
+          subject { swagger.paths['/pets'].get.parameters }
+          it { is_expected.to be_an(Array) }
+          it 'contains Parameter objects' do
+            expect(subject.size).to eq(2)
+            subject.each do |parameter|
+              expect(parameter).to be_a_kind_of(Parameter)
+            end
+          end
+        end
+        skip '#resources' # complex type
+
+        describe '#schemes' do
+          subject { swagger.paths['/pets'].get.schemes }
+          it { is_expected.to eq(%w(http https)) }
+        end
+
+        describe '#default_response' do
+          subject { swagger.paths['/pets'].get.default_response }
+          it 'is selects the response labeled default' do
+            # Turns out a lot of examples are using "default" more like unknown error (i.e. else)
+            # rather than the default successful response.
+            # expect(subject.description).to eq('pet response (default)')
+            expect(subject.description).to eq('pet response')
+          end
+        end
+      end
+    end
+  end
+end

data/spec/swagger/info_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper'
+
+module Swagger
+  module V2
+    describe Info do
+      context 'Sample petstore API' do
+        let(:swagger_file) { 'spec/fixtures/petstore-full.yaml' }
+        let(:swagger) { Swagger.load swagger_file }
+        subject { swagger.info }
+
+        describe '#version' do
+          subject { swagger.info.version }
+          it { is_expected.to eq('1.0.0') }
+        end
+
+        describe '#title' do
+          subject { swagger.info.title }
+          it { is_expected.to eq('Swagger Petstore') }
+        end
+
+        describe '#description' do
+          subject { swagger.info.description }
+          let(:expected) do
+            [
+              'A sample API that uses a petstore as an example to demonstrate',
+              "features in the swagger-2.0 specification\n"
+            ].join("\n")
+          end
+          it { is_expected.to eq(expected) }
+        end
+
+        describe '#termsOfService' do
+          subject { swagger.info.termsOfService }
+          it { is_expected.to eq('http://helloreverb.com/terms/') }
+          pending "Spec isn't clear if this should be URL, plaintext, or Markdown"
+        end
+
+        describe '#contact' do
+          subject { swagger.info.contact }
+
+          describe '#name' do
+            subject { swagger.info.contact.name }
+            it { is_expected.to eq('Wordnik API Team') }
+          end
+
+          describe '#url' do
+            subject { swagger.info.contact.url }
+            pending { is_expected.to be_a_kind_of(Addressable::URI) }
+            it { is_expected.to eq('http://madskristensen.net') }
+          end
+
+          describe '#email' do
+            subject { swagger.info.contact.email }
+            pending 'Is there a more appropriate class for email?'
+            it { is_expected.to eq('foo@example.com') }
+          end
+        end
+
+        describe '#license' do
+          subject { swagger.info.license }
+
+          describe '#name' do
+            subject { swagger.info.license.name }
+            it { is_expected.to eq('MIT') }
+          end
+
+          describe '#url' do
+            subject { swagger.info.license.url }
+            pending { is_expected.to be_a_kind_of(Addressable::URI) }
+            it { is_expected.to eq('http://choosealicense.com/licenses/mit/') }
+          end
+        end
+      end
+    end
+  end
+end