swagger-core 0.2.0

data/.gitignore

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

data/.gitmodules

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

data/.rubocop.yml

@@ -0,0 +1,21 @@
+# 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:
+  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/Gemfile

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

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,31 @@
+# Swagger
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'swagger'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install swagger
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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,8 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task default: [:spec, :rubocop]

data/lib/swagger.rb

@@ -0,0 +1,30 @@
+require 'swagger/version'
+require 'addressable/uri'
+require 'addressable/template'
+require 'hashie'
+
+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
+
+  def self.load(file, loader = nil)
+    ext = File.extname file
+    loader ||= Swagger::Loaders.loader_for ext
+    loader.load File.read(file)
+  end
+end
+
+require 'swagger/attachable'
+require 'swagger/definition_section'
+require 'swagger/schema'
+require 'swagger/uri'
+require 'swagger/uri_template'
+require 'swagger/loaders'
+require 'swagger/mime_type'
+require 'swagger/api_declaration'
+require 'swagger/builder'

data/lib/swagger/api_declaration.rb

@@ -0,0 +1,25 @@
+module Swagger
+  class APIDeclaration < DefinitionSection
+    def self.build(hash)
+      version = hash['swaggerVersion'] || hash['swagger']
+      major, _minor = version.to_s.split('.')
+      case major
+      when '2'
+        Swagger::V2::APIDeclaration.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_declaration'

data/lib/swagger/attachable.rb

@@ -0,0 +1,31 @@
+module Swagger
+  module Attachable
+    # @api private
+    def attach_parent(parent)
+      @parent = parent
+      attach_to_children
+    end
+
+    # @api private
+    def attach_to_children # rubocop:disable Metrics/MethodLength
+      each_value do |v|
+        if v.respond_to? :attach_parent
+          v.attach_parent self
+        elsif v.respond_to? :each_value
+          v.each_value do |sv|
+            sv.attach_parent self if sv.respond_to? :attach_parent
+          end
+        elsif v.respond_to? :each
+          v.each do |sv|
+            sv.attach_parent self if sv.respond_to? :attach_parent
+          end
+        end
+      end
+    end
+
+    def root
+      return self if parent.nil?
+      parent.root
+    end
+  end
+end

data/lib/swagger/builder.rb

@@ -0,0 +1,87 @@
+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
+    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
+
+    def self.included(dash) # rubocop:disable Metrics/MethodLength
+      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
+
+  class Builder < Swagger::V2::APIDeclaration
+    include Swagger::Bash
+  end
+end

data/lib/swagger/definition_section.rb

@@ -0,0 +1,34 @@
+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

@@ -0,0 +1,29 @@
+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/mime_type.rb

@@ -0,0 +1,25 @@
+require 'mime/types'
+
+module Swagger
+  class MimeType < String
+    extend Forwardable
+    def_delegators :@mime_type, :media_type, :sub_type
+
+    MIME_TYPE_FORMAT = /(\w+)\/(\w+\.)?([\w\.]+)(\+\w+)?\s*(;.*)?/
+
+    def initialize(mime_type_name)
+      @mime_type_name = mime_type_name.to_s
+      @mime_type = MIME::Types[@mime_type_name].first || base_type(@mime_type_name)
+      fail ArgumentError, "Unknown mime type or suffix: #{mime_type_name}" if @mime_type.nil?
+      super @mime_type_name
+    end
+
+    private
+
+    def base_type(mime_type_name)
+      media_type, _sub_type, _tree, suffix, _parameters = MIME_TYPE_FORMAT.match mime_type_name
+      return MIME::Types["#{media_type}/#{suffix}"].first if media_type && suffix
+      nil
+    end
+  end
+end

data/lib/swagger/notes.md

@@ -0,0 +1,35 @@
+Classes added to Swagger-Core (Java) for 2.0:
+- [] modules/swagger-core/src/main/java/com/wordnik/swagger/converter/ModelConverters.java
+- []  modules/swagger-core/src/main/java/com/wordnik/swagger/models/Contact.java
+- []  modules/swagger-core/src/main/java/com/wordnik/swagger/models/Info.java
+- []  modules/swagger-core/src/main/java/com/wordnik/swagger/models/License.java
+- []  modules/swagger-core/src/main/java/com/wordnik/swagger/models/Model.java
+- []  modules/swagger-core/src/main/java/com/wordnik/swagger/models/ModelFactory.java
+- []  modules/swagger-core/src/main/java/com/wordnik/swagger/models/Operation.java
+- []  modules/swagger-core/src/main/java/com/wordnik/swagger/models/Path.java
+- []  modules/swagger-core/src/main/java/com/wordnik/swagger/models/RefModel.java
+- []  modules/swagger-core/src/main/java/com/wordnik/swagger/models/Response.java
+- []  modules/swagger-core/src/main/java/com/wordnik/swagger/models/Scheme.java
+- []  modules/swagger-core/src/main/java/com/wordnik/swagger/models/Security.java
+- []  modules/swagger-core/src/main/java/com/wordnik/swagger/models/Swagger.java
+- []  modules/swagger-core/src/main/java/com/wordnik/swagger/models/parameters/AbstractParameter.java
+- []  modules/swagger-core/src/main/java/com/wordnik/swagger/models/parameters/BodyParameter.java
+- []  modules/swagger-core/src/main/java/com/wordnik/swagger/models/parameters/CookieParameter.java
+- []  modules/swagger-core/src/main/java/com/wordnik/swagger/models/parameters/HeaderParameter.java
+- []  modules/swagger-core/src/main/java/com/wordnik/swagger/models/parameters/Parameter.java
+- []  modules/swagger-core/src/main/java/com/wordnik/swagger/models/parameters/PathParameter.java
+- []  modules/swagger-core/src/main/java/com/wordnik/swagger/models/parameters/QueryParameter.java
+- []  modules/swagger-core/src/main/java/com/wordnik/swagger/models/properties/AbstractProperty.java
+- []  modules/swagger-core/src/main/java/com/wordnik/swagger/models/properties/ArrayProperty.java
+- []  modules/swagger-core/src/main/java/com/wordnik/swagger/models/properties/BooleanProperty.java
+- []  modules/swagger-core/src/main/java/com/wordnik/swagger/models/properties/DateProperty.java
+- []  modules/swagger-core/src/main/java/com/wordnik/swagger/models/properties/DateTimeProperty.java
+- []  modules/swagger-core/src/main/java/com/wordnik/swagger/models/properties/DoubleProperty.java
+- []  modules/swagger-core/src/main/java/com/wordnik/swagger/models/properties/IntegerProperty.java
+- []  modules/swagger-core/src/main/java/com/wordnik/swagger/models/properties/LongProperty.java
+- []  modules/swagger-core/src/main/java/com/wordnik/swagger/models/properties/MapProperty.java
+- []  modules/swagger-core/src/main/java/com/wordnik/swagger/models/properties/Property.java
+- []  modules/swagger-core/src/main/java/com/wordnik/swagger/models/properties/RefProperty.java
+- []  modules/swagger-core/src/main/java/com/wordnik/swagger/models/properties/StringProperty.java
+- []  modules/swagger-core/src/main/java/com/wordnik/swagger/models/properties/Xml.java
+- []  modules/swagger-core/src/main/java/com/wordnik/swagger/util/Json.java

data/lib/swagger/schema.rb

@@ -0,0 +1,59 @@
+module Swagger
+  class Schema < Hashie::Mash
+    include Attachable
+    include Hashie::Extensions::MergeInitializer
+    include Hashie::Extensions::DeepFind
+    attr_accessor :parent
+
+    def initialize(hash, default = nil)
+      super
+      attach_to_children
+    end
+
+    def parse
+      schema = clone
+      if schema.key?('$ref')
+        key = schema.delete('$ref')
+        model = root.definitions[key]
+        schema.merge!(model)
+      end
+
+      count = 0
+      until schema.refs_resolved?
+        fail 'Could not resolve non-remote $refs 5 cycles - circular references?' if count >= 5
+        schema.resolve_refs
+        count += 1
+      end
+
+      schema.to_hash
+    end
+
+    protected
+
+    def refs
+      deep_find_all('$ref')
+    end
+
+    def resolve_refs
+      items_and_props = [deep_select('items'), deep_select('properties')].flatten.compact
+      items_and_props.each do | item |
+        key = item.delete('$ref')
+        next if remote_ref? key
+        model = root.definitions[key]
+        item.merge!(model)
+      end
+    end
+
+    def refs_resolved?
+      return true if refs.nil?
+
+      refs.all? do |ref|
+        remote_ref?(ref)
+      end
+    end
+
+    def remote_ref?(ref)
+      ref.match(%r{\A\w+\://})
+    end
+  end
+end