swagger-parser 0.2.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 740d876af96ebfcc2ccbf08644e6d7ea1935911a
+  data.tar.gz: 4a01f87d82ac5fca6fdc3390450e2a03a6fddc6b
+SHA512:
+  metadata.gz: 51f6dc4a18985c3cef69c51b79eb37f8519a6cba754bb9e2b0568523adace5deec94c98d870a1058336131b13ea1f0dbdede5d647457feaba2818196314dfda0
+  data.tar.gz: ec70831ccdb90fbaeb49ced11a4a80862b19371d0d87676de2835e38f79c9b2b5512ad582b4ddbe04a439d0cfc9a9d6bfb029728f412b7c1ddabbb05394ff4a4

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.swp

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "swagger_spec"]
+	path = swagger_spec
+	url = https://github.com/wordnik/swagger-spec

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rubocop.yml

@@ -0,0 +1,23 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2014-08-05 12:05:37 -0400 using RuboCop version 0.24.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Not yet...
+Style/Documentation:
+  # See https://github.com/bbatsov/rubocop/issues/947
+  # Use inch instead
+  Enabled: false
+Style/Encoding:
+  EnforcedStyle: when_needed
+
+Metrics/LineLength:
+  Max: 120
+Metrics/MethodLength:
+  Max: 15
+
+AllCops:
+  Exclude:
+    - 'swagger_spec/**/*'

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.1.0
+  - 2.0.0
+  - 1.9.3
+  - jruby

data/.yardopts

@@ -0,0 +1,4 @@
+--no-private
+lib/swagger/definition_section.rb
+lib/swagger.rb
+lib/**/*.rb

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in swagger.gemspec
+gemspec
+gem 'pry'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Max Lincoln
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,114 @@
+# Swagger
+
+This is a fork of (swagger-rb)[https://github.com/swagger-rb/swagger-rb]. I've renamed the repo and pushed it to ruby-gems because it seems like the other repo is no longer maintained.
+
+Swagger is a Ruby library for parsing, building, and traversing (Swagger)[http://swagger.io/] API definitions.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'swagger-parser'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install swagger-parser
+
+## Features
+
+- Structural and semantic validation of Swagger objects
+- Convenient traversal APIs: use hierarchical or flat traversals
+- Handles derived or combined properties, like joining root, path, and operation level property definitions
+- A Swagger::Builder to help create valid Swagger documents from other data
+
+## Usage
+
+### Parsing
+
+If you're loading a Swagger document from a file, you can use `#load`. The Swagger version will be detected from the file content.
+
+```ruby
+api = Swagger.load('swagger.yaml')
+```
+
+If you already have the Swagger content loaded as a Hash you can call build, or you can call
+build and tell Swagger the content is a JSON or YAML string it needs to parse.
+
+```ruby
+api = Swagger.build(hash)
+# or
+api = Swagger.build(json, format: :json)
+# or
+api = Swagger.build(yaml, format: :yaml)
+```
+
+### Traversing
+
+The parsing methods above all return an API object. The object has a hierarchical object that mirrors the Swagger specification. You can traverse it hierarchically, for example:
+
+```ruby
+api.paths['/pets'].get
+# {"tags"=>["Pet Operations"],
+# "summary"=>"finds pets in the system",
+# "responses"=>
+  {"200"=>{"description"=>"pet response", "schema"=>{"type"=>"array", "items"=>{"$ref"=>"#/definitions/Pet"}}, "headers"=>[{"x-expires"=>{"type"=>"string"}}]},
+   "default"=>{"description"=>"unexpected error", "schema"=>{"$ref"=>"#/definitions/Error"}}}}
+```
+
+There are also methods available to provide flatter APIs or convenient derived properties. For example:
+
+```ruby
+api.operations.each do | operation |
+  puts operation.signature
+end
+# GET petstore.swagger.wordnik.com/api/pets
+# POST petstore.swagger.wordnik.com/api/pets
+# GET petstore.swagger.wordnik.com/api/pets/{id}
+# DELETE petstore.swagger.wordnik.com/api/pets/{id}
+```
+
+See the RDoc documentation for more details.
+
+### Building
+
+If you want to build a Swagger document from another structure, you can use the builder. It will validate the structure and data types as you build the Swagger document, but it won't enforce constraints about required Swagger fields until you call `Swagger::Builder#build`.
+
+```ruby
+builder = Swagger.builder
+# or builder = Swagger.builder(version: '2.0')
+
+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
+
+api = builder.build
+```
+
+## TODO
+
+* Support Swagger 1.2 - right now only Swagger 2.0 is supported
+* Better handling of $ref
+* Handle combined parameters, respones, etc
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/swagger/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+require 'rake/notes/rake_task'
+require 'inch/rake'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+Inch::Rake::Suggest.new
+
+task default: [:spec, :rubocop, :notes]

data/lib/swagger.rb

@@ -0,0 +1,56 @@
+require 'addressable/uri'
+require 'addressable/template'
+require 'forwardable'
+require 'hashie'
+require 'swagger/version'
+require 'swagger/boolean'
+
+# Provides loading and building capabilities for Swagger.
+# @see http://swagger.io Swagger
+module Swagger
+  RESOURCES_DIR = File.expand_path '../../resources/', __FILE__
+  class InvalidDefinition < StandardError
+    def initialize(errors)
+      @errors = errors
+      super("The Swagger definition is invalid. The following errors were detected: #{errors.inspect}")
+    end
+  end
+  # Instantiates a Swagger::API from the content.
+  # @param [Hash] opts the build options
+  # @option opts [String] :version the target Swagger specification version
+  # @returns [API]
+  def self.build(content, opts = {})
+    parser ||= Swagger::Parsers.parser_for(opts[:format])
+    content = parser.parse(content) unless parser.nil?
+    Swagger::API.build_api(content)
+  end
+
+  # Load a Swagger document from a file.
+  # @param [Hash] opts the load options
+  # @option opts [String] :format the format (yaml or json). Detected by file extension if omitted.
+  # @returns [API] a Swagger API object
+  def self.load(file, opts = {})
+    ext = File.extname file
+    opts[:format] = ext
+    content = File.read(file)
+    build(content, opts)
+  end
+
+  # Creates a Swagger::Builder that can be used to create a Swagger document.
+  # @param [Hash] opts the build options
+  # @option opts [String] :version the target Swagger specification version
+  # @returns Swagger::Builder
+  def self.builder(opts = {})
+    Swagger::Builder.builder(opts)
+  end
+end
+
+require 'swagger/attachable'
+require 'swagger/swagger_object'
+require 'swagger/schema'
+require 'swagger/uri'
+require 'swagger/uri_template'
+require 'swagger/parsers'
+require 'swagger/mime_type'
+require 'swagger/api'
+require 'swagger/builder'

data/lib/swagger/api.rb

@@ -0,0 +1,26 @@
+module Swagger
+  # A common interface for building or loading Swagger documents of any version. See subclasses.
+  class API < SwaggerObject
+    def self.build_api(hash)
+      version = hash['swaggerVersion'] || hash['swagger']
+      major, _minor = version.to_s.split('.')
+      case major
+      when '2'
+        Swagger::V2::API.new hash
+      else
+        fail ArgumentError, "Swagger version #{version} is not currently supported"
+      end
+    end
+
+    def initialize(hash)
+      @vendor_extensions = {}
+      hash.each do |k, v|
+        @vendor_extensions[k] = v if k.to_s.start_with? 'x-'
+      end
+      # HACK: There's got to be a better way, but Dash wasn't working well with strings
+      super(Hashie::Mash.new(hash).to_hash(symbolize_keys: true))
+    end
+  end
+end
+
+require 'swagger/v2/api'

data/lib/swagger/attachable.rb

@@ -0,0 +1,39 @@
+module Swagger
+  # A module that attaches parent objects to their children so you can navigate back
+  # up the hierarchy.
+  module Attachable
+    # The top-level object in the hierarchy.
+    attr_accessor :children
+    def root
+      return self if parent.nil?
+      parent.root
+    end
+
+    # @api private
+    def attach_parent(parent)
+      @parent = parent
+      attach_to_children
+    end
+
+    # @api private
+    def attach_to_children
+      @children ||= []
+      each_value do |v| # rubocop:disable Style/Next
+        if v.respond_to? :attach_parent
+          v.attach_parent self
+          self.children << v
+        end
+        if v.respond_to? :each_value
+          v.each_value do |sv|
+            sv.attach_parent self if sv.respond_to? :attach_parent
+          end
+        end
+        if v.respond_to? :each
+          v.each do |sv|
+            sv.attach_parent self if sv.respond_to? :attach_parent
+          end
+        end
+      end
+    end
+  end
+end

data/lib/swagger/boolean.rb

@@ -0,0 +1,13 @@
+module Swagger
+  class Boolean
+    TRUE_REGEXP = /(y|Y|yes|Yes|YES|true|True|TRUE|on|On|ON)/
+    FALSE_REGEXP = /(n|N|no|No|NO|false|False|FALSE|off|Off|OFF)/
+
+    def self.coerce(obj)
+      val = obj.to_s.downcase
+      return true if val.match(TRUE_REGEXP)
+      return false if val.match(FALSE_REGEXP)
+      fail ArgumentError, "#{obj} cannot be coerced to a boolean"
+    end
+  end
+end

data/lib/swagger/builder.rb

@@ -0,0 +1,109 @@
+module Swagger
+  # A Bash is a 'builder' Hash that can be used to be a
+  # Dash ('defined' or 'discrete' Hash). It provides a
+  # build method that turns it into a Dash. It enforces
+  # the same rules as a Dash except for 'required' properties,
+  # which are not enforced until converting to a Dash via `build`.
+  module Bash
+    # @api private
+    module ClassMethods
+      def self.extend_object(dash)
+        fail TypeError, 'Bash only works on Dash' unless dash <= Hashie::Dash
+        dash.instance_variable_get('@required_properties').clear
+        dash.coerce_value Hashie::Dash, Swagger::Bash, strict: false
+      end
+
+      def required?(_name)
+        false
+      end
+    end
+
+    # @api private
+    def self.included(dash) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+      fail TypeError, 'Bash only works on Dash' unless dash <= Hashie::Dash
+      dash.extend ClassMethods
+      dash.instance_variable_get('@required_properties').clear
+
+      # Very hacky... copy instance_variables for coercions
+      base_dash = dash.superclass
+      [:@properties, :@defaults].each do |property|
+        dash.instance_variable_set(property, base_dash.instance_variable_get(property))
+      end
+
+      [:@key_coercions, :@value_coercions].each do |property|
+        coercions = base_dash.instance_variable_get(property)
+        coercions.each_pair do |key, into|
+          infect_class coercions, key, into
+        end if coercions
+        dash.instance_variable_set(property, coercions)
+      end
+
+      def [](key, &_block)
+        super(key) do |v|
+          if block_given?
+            v ||= send(:[]=, key, {})
+            yield v
+            v
+          end
+        end
+      end
+    end
+
+    def build
+      self.class.superclass.new(to_hash)
+    end
+
+    private
+
+    def self.infect_class(coercions, key, into)
+      if into.is_a? Hash
+        into.each_pair do |sub_key, sub_into|
+          coercions[key][sub_key] = infect sub_into
+        end
+      elsif into.is_a? Array
+        coercions[key] = into.map do |sub_into|
+          infect sub_into
+        end
+      else
+        coercions[key] = infect into
+      end
+    end
+
+    def self.infect(klass)
+      return klass unless klass <= Hashie::Dash
+
+      klass.const_set('Bash',
+                      Class.new(klass).tap do |bash_klass|
+                        # include is public in Ruby 2.1+, hack to support older
+                        bash_klass.send(:include, Bash)
+                      end
+      ) unless klass.const_defined? 'Bash'
+
+      klass.const_get('Bash')
+    end
+  end
+
+  # An object for building a Swagger document. Coerces and validates data types
+  # as create the document, but does not enforce required fields until you call
+  # #{Bash#build}.
+  module Builder
+    def self.builder(opts = {})
+      version = opts[:version] || '2.0'
+      target_class = target_api_class(version)
+      klass = Swagger::Bash.infect(target_class)
+      klass.new({})
+    end
+
+    private
+
+    def self.target_api_class(version)
+      major, _minor = version.to_s.split('.')
+      case major
+      when '2'
+        Swagger::V2::API
+      else
+        fail ArgumentError, "Swagger version #{version} is not currently supported"
+      end
+    end
+  end
+end