swagger-parser 0.2.5

data/spec/swagger/builder_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+module Swagger
+  describe Builder do
+    subject(:builder) { described_class.builder }
+    describe 'setting fields' do
+      it 'raises an error if the field does not exist' do
+        expect { builder.xxx = 'foo' }.to raise_error(NoMethodError)
+      end
+
+      it 'raises if the value cannot be coerced to match the field' do
+        expect { builder.info = 'foo' }.to raise_error(Hashie::CoercionError)
+      end
+
+      it 'sets the field' do
+        expect { builder.swagger = 2.0 }.to change { builder.swagger }.from(nil).to('2.0')
+      end
+
+      it 'allows complex types to be set via a block' do
+        builder.info do |info|
+          info.title = 'Sample Swagger API'
+          info.version = '1.0'
+        end
+
+        expect(builder.info).to be_an_kind_of(Swagger::Bash)
+        expect(builder.info.title).to eq('Sample Swagger API')
+      end
+    end
+
+    describe '#build' do
+      it 'raises an error if a required field is omitted' do
+        expect { builder.build }.to raise_error(ArgumentError, /property '\w+' is required/)
+      end
+
+      it 'returns the built Swagger API object if all required fields are present' do
+        builder.swagger = 2.0
+        builder.info do |info|
+          info.title = 'Sample Swagger API'
+          info.version = '1.0'
+        end
+        builder.paths = {
+          '/foo' => {}
+        }
+        builder.paths['/foo'].get do |get|
+          get.description = 'Testing...'
+          get.tags = %w(foo bar)
+        end
+        expect(builder.build).to be_an_instance_of(Swagger::V2::API)
+      end
+    end
+  end
+end

data/spec/swagger/custom_properties_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+module Swagger
+  module V2
+    describe API do
+      let(:swagger_file) { 'spec/fixtures/custom-properties.yaml' }
+      let(:swagger) { Swagger.load swagger_file }
+
+      context 'custom properties' do
+        describe 'getting a custom property' do
+          it 'should allow me to get a custom x- prefixed property' do
+            operation = swagger.paths['/pets'].get
+
+            expect(operation['x-my-custom-param']).to eq('whatever the hell I want!')
+          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

data/spec/swagger/operation_spec.rb

@@ -0,0 +1,99 @@
+require 'spec_helper'
+
+module Swagger
+  module V2
+    describe Operation 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
+
+        describe '#signature' do
+          subject { swagger.paths['/pets'].get }
+          it 'is a signature similar to what would appear in logs or HTTP dumps' do
+            # FIXME: It's a bit weird to have host but not scheme... but Swagger allows multiple schemes
+            expect(subject.signature).to eq('GET petstore.swagger.wordnik.com/api/pets')
+          end
+        end
+      end
+    end
+  end
+end

data/spec/swagger/swagger_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+
+RSpec.shared_examples 'swagger loading' do
+  it { is_expected.to be_a_kind_of Swagger::API }
+
+  it 'has a swagger spec version' do
+    expect(subject.swagger).to eq('2.0')
+  end
+end
+
+describe Swagger do
+  describe '#build' do
+    let(:content) { File.read(swagger_file) }
+
+    context 'json' do
+      let(:swagger_file) { 'swagger_spec/examples/v2.0/json/petstore.json' }
+      let(:opts) do
+        { format: :json }
+      end
+      subject(:swagger) { Swagger.build(content, opts) }
+      include_examples 'swagger loading'
+    end
+
+    context 'yaml' do
+      let(:swagger_file) { 'swagger_spec/examples/v2.0/yaml/petstore.yaml' }
+      let(:opts) do
+        { format: :yaml }
+      end
+      subject(:swagger) { Swagger.build(content, opts) }
+      include_examples 'swagger loading'
+    end
+
+    context 'already parsed' do
+      let(:swagger_file) { 'swagger_spec/examples/v2.0/yaml/petstore.yaml' }
+      let(:content) { YAML.load(File.read(swagger_file)) }
+      subject(:swagger) { Swagger.build(content) }
+      include_examples 'swagger loading'
+    end
+  end
+
+  describe '#load' do
+    subject(:swagger) { Swagger.load swagger_file }
+
+    context 'json' do
+      let(:swagger_file) { 'swagger_spec/examples/v2.0/json/petstore.json' }
+      include_examples 'swagger loading'
+    end
+
+    context 'yaml' do
+      let(:swagger_file) { 'swagger_spec/examples/v2.0/yaml/petstore.yaml' }
+      include_examples 'swagger loading'
+    end
+  end
+
+  describe '#builder' do
+    context 'default version' do
+      subject(:builder) { described_class.builder }
+      it { is_expected.to be_a_kind_of(Swagger::Bash) }
+      it { is_expected.to be_a_kind_of(Swagger::V2::API) }
+    end
+
+    context 'version 2' do
+      subject(:builder) { described_class.builder(version: '2.0') }
+      it { is_expected.to be_a_kind_of(Swagger::Bash) }
+      it { is_expected.to be_a_kind_of(Swagger::V2::API) }
+    end
+
+    context 'version 1' do
+      subject(:builder) { described_class.builder(version: '1.2') }
+      pending { is_expected.to be_a_kind_of(Swagger::Bash) }
+      pending { is_expected.to be_a_kind_of(Swagger::V2::API) }
+    end
+  end
+end

data/swagger-parser.gemspec

@@ -0,0 +1,32 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'swagger/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'swagger-parser'
+  spec.version       = Swagger::VERSION
+  spec.authors       = ['Alex Johnson']
+  spec.summary       = 'Swagger parser for Ruby'
+  spec.description   = <<-eos
+    The Swagger gem parses and provides an simple API for
+    [Swagger](http://swagger.io/) documents that define RESTful APIs.
+  eos
+  spec.homepage      = 'https://github.com/alexpjohnson/swagger-parser'
+  spec.license       = 'Apache-2.0'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'addressable', '~> 2.3'
+  spec.add_dependency 'hashie', '~> 3.0', '< 3.4.0'
+  spec.add_dependency 'json-schema', '~> 2.2'
+  spec.add_dependency 'mime-types', '~> 2.0'
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rake-notes'
+  spec.add_development_dependency 'inch'
+end

metadata

@@ -0,0 +1,250 @@
+--- !ruby/object:Gem::Specification
+name: swagger-parser
+version: !ruby/object:Gem::Version
+  version: 0.2.5
+platform: ruby
+authors:
+- Alex Johnson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+- !ruby/object:Gem::Dependency
+  name: json-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake-notes
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: inch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |2
+      The Swagger gem parses and provides an simple API for
+      [Swagger](http://swagger.io/) documents that define RESTful APIs.
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".gitmodules"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- ".yardopts"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/swagger.rb
+- lib/swagger/api.rb
+- lib/swagger/attachable.rb
+- lib/swagger/boolean.rb
+- lib/swagger/builder.rb
+- lib/swagger/mime_type.rb
+- lib/swagger/notes.md
+- lib/swagger/parsers.rb
+- lib/swagger/schema.rb
+- lib/swagger/swagger_object.rb
+- lib/swagger/uri.rb
+- lib/swagger/uri_template.rb
+- lib/swagger/v2/api.rb
+- lib/swagger/v2/deterministic_json_schema.rb
+- lib/swagger/v2/example.rb
+- lib/swagger/v2/header.rb
+- lib/swagger/v2/info.rb
+- lib/swagger/v2/operation.rb
+- lib/swagger/v2/parameter.rb
+- lib/swagger/v2/path.rb
+- lib/swagger/v2/response.rb
+- lib/swagger/v2/security_requirement.rb
+- lib/swagger/v2/security_scheme.rb
+- lib/swagger/v2/tag.rb
+- lib/swagger/version.rb
+- resources/schemas/json_schema/draft-04.json
+- resources/schemas/swagger/v2.0/schema.json
+- spec/fixtures/custom-properties.yaml
+- spec/fixtures/petstore-full.yaml
+- spec/fixtures/swagger.yaml
+- spec/spec_helper.rb
+- spec/swagger/api_spec.rb
+- spec/swagger/builder_spec.rb
+- spec/swagger/custom_properties_spec.rb
+- spec/swagger/info_spec.rb
+- spec/swagger/operation_spec.rb
+- spec/swagger/swagger_spec.rb
+- swagger-parser.gemspec
+homepage: https://github.com/alexpjohnson/swagger-parser
+licenses:
+- Apache-2.0
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Swagger parser for Ruby
+test_files:
+- spec/fixtures/custom-properties.yaml
+- spec/fixtures/petstore-full.yaml
+- spec/fixtures/swagger.yaml
+- spec/spec_helper.rb
+- spec/swagger/api_spec.rb
+- spec/swagger/builder_spec.rb
+- spec/swagger/custom_properties_spec.rb
+- spec/swagger/info_spec.rb
+- spec/swagger/operation_spec.rb
+- spec/swagger/swagger_spec.rb
+has_rdoc: