swagger-core 0.2.0 → 0.2.1

data/spec/swagger/swagger_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 RSpec.shared_examples 'swagger loading' do
-  it { is_expected.to be_a_kind_of Swagger::APIDeclaration }
+  it { is_expected.to be_a_kind_of Swagger::API }
 
   it 'has a swagger spec version' do
     expect(subject.swagger).to eq(2.0)
@@ -9,6 +9,35 @@ RSpec.shared_examples 'swagger loading' do
 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 }
 
@@ -22,4 +51,24 @@ describe Swagger do
       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-core.gemspec

@@ -28,4 +28,6 @@ Gem::Specification.new do |spec|
   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

@@ -1,225 +1,236 @@
 --- !ruby/object:Gem::Specification
 name: swagger-core
 version: !ruby/object:Gem::Version
-  version: 0.2.0
-  prerelease: 
+  version: 0.2.1
 platform: ruby
 authors:
 - Max Lincoln
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-25 00:00:00.000000000 Z
+date: 2014-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.3'
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: json-schema
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.2'
 - !ruby/object:Gem::Dependency
   name: mime-types
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: ! "    The Swagger gem parses and provides an simple API for\n    [Swagger](http://swagger.io/)
-  documents that define RESTful APIs.\n"
+- !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:
 - max@devopsy.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .gitmodules
-- .rubocop.yml
-- .travis.yml
+- ".gitignore"
+- ".gitmodules"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- ".yardopts"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/swagger.rb
-- lib/swagger/api_declaration.rb
+- lib/swagger/api.rb
 - lib/swagger/attachable.rb
 - lib/swagger/builder.rb
-- lib/swagger/definition_section.rb
-- lib/swagger/loaders.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_declaration.rb
-- lib/swagger/v2/api_operation.rb
+- lib/swagger/v2/api.rb
 - lib/swagger/v2/example.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/tag.rb
 - lib/swagger/version.rb
 - resources/schemas/json_schema/draft-04.json
 - resources/schemas/swagger/v2.0/schema.json
 - spec/fixtures/petstore-full.yaml
 - spec/fixtures/swagger.yaml
 - spec/spec_helper.rb
-- spec/swagger/api_declaration_spec.rb
-- spec/swagger/api_operation_spec.rb
+- spec/swagger/api_spec.rb
+- spec/swagger/builder_spec.rb
 - spec/swagger/info_spec.rb
+- spec/swagger/operation_spec.rb
 - spec/swagger/swagger_spec.rb
 - swagger-core.gemspec
 homepage: https://github.com/maxlinc/swagger-rb
 licenses:
 - Apache-2.0
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -4489768355737568917
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -4489768355737568917
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23.2
+rubygems_version: 2.2.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Swagger parser for Ruby
 test_files:
 - spec/fixtures/petstore-full.yaml
 - spec/fixtures/swagger.yaml
 - spec/spec_helper.rb
-- spec/swagger/api_declaration_spec.rb
-- spec/swagger/api_operation_spec.rb
+- spec/swagger/api_spec.rb
+- spec/swagger/builder_spec.rb
 - spec/swagger/info_spec.rb
+- spec/swagger/operation_spec.rb
 - spec/swagger/swagger_spec.rb
+has_rdoc: 

data/lib/swagger/definition_section.rb

@@ -1,34 +0,0 @@
-module Swagger
-  class DefinitionSection < Hashie::Dash
-    include Hashie::Extensions::Coercion
-    include Hashie::Extensions::IndifferentAccess
-    include Swagger::Attachable
-
-    attr_accessor :parent
-
-    def initialize(hash)
-      super
-      attach_to_children
-    end
-
-    # @api private
-    # @!macro [new] section
-    #   @!attribute [rw] $1
-    #     $3
-    #     @return [$2]
-    def self.section(name, type)
-      property name
-      coerce_key name, type
-    end
-
-    # @api private
-    # @!macro [new] section
-    #   @!attribute [rw] $1
-    #     **Required**. $3
-    #     @return [$2]
-    def self.required_section(name, type)
-      property name, required: true
-      coerce_key name, type
-    end
-  end
-end

data/lib/swagger/loaders.rb

@@ -1,29 +0,0 @@
-autoload :YAML, 'yaml'
-autoload :JSON, 'json'
-
-module Swagger
-  module Loaders
-    def self.loader_for(ext)
-      case ext
-      when '.yaml', '.yml'
-        YAMLLoader
-      when '.json', '.js'
-        JSONLoader
-      else
-        fail ArgumentError, "No registered Loader for #{ext}"
-      end
-    end
-
-    class YAMLLoader
-      def self.load(content)
-        APIDeclaration.build(YAML.load(content))
-      end
-    end
-
-    class JSONLoader
-      def self.load(content)
-        APIDeclaration.build(JSON.parse(content))
-      end
-    end
-  end
-end

data/lib/swagger/v2/api_declaration.rb

@@ -1,81 +0,0 @@
-require 'json-schema'
-require 'swagger/v2/info'
-require 'swagger/v2/path'
-
-module Swagger
-  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 APIDeclaration < Swagger::APIDeclaration
-      required_section :swagger, Float
-      required_section :info, Info
-      required_section :paths, Hash[String => Path]
-      section :host, Swagger::URITemplate
-      section :basePath, Swagger::URITemplate
-      section :schemes, Array[String]
-      section :consumes, Array[String]
-      section :produces, Array[String]
-      section :schemas, Hash
-      section :definitions, Hash
-      section :security, Array
-      # FIXME: Doesn't :parameter exist at this level as well?
-
-      attr_reader :apis
-
-      alias_method :base_path, :basePath
-
-      # def initialize(hash)
-      #   super
-      #   attach_to_apis
-      # end
-
-      def apis
-        # Perhaps not the best way...
-        paths.values.map do | path |
-          path.operations.values
-        end.flatten
-      end
-
-      def uri_template
-        # TODO: Can calculated values be safely memoized?
-        # TODO: Actual URI Template objects or just strings?
-        "#{host}#{basePath}"
-      end
-
-      def fully_validate
-        # FIXME: 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
-
-      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))
-
-        # 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
-
-      # def attach_to_apis
-      #   @apis ||= Set.new
-      #   paths.each do |path, api|
-      #     api.path = path
-      #     api.parent = self
-      #     @apis << api
-      #   end
-      # end
-    end
-  end
-end