ruby-swagger 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 17e016df8b39892b97f231d68684a6c1bd6545dd
-  data.tar.gz: a65a22a35c28f1f25a5bcc6227fc0f3d930060f4
+  metadata.gz: 1d1aefb55567ede55aa051c96e6d6c9e3c8041fa
+  data.tar.gz: 7c2b67857e4d9a58347f4abadf180f1832f42c32
 SHA512:
-  metadata.gz: 0acb37a9c4a5ab744bc928f793b05e526a3e37313e76b324fc44904f6f19452d96591d93c200c976a45c7ec2177d40a9c8fd484838384a881d00bbdefb3f1548
-  data.tar.gz: 3436927c4dff0917e1fcd56ffcec044a10064462c87586afc39da42b840693312bb68f5e86a4d824a78e1204c91bb9d1462637e9db316bbe146cc5e1e5891309
+  metadata.gz: e0afd868df01ae477ca6510e1157b95d2ff5c6e9f4e0bb7215b59184802b7d23b44e2bcb3c7b83a9567098da2868d061f2efa5d1078ee7e32e6cb40b7d00ea38
+  data.tar.gz: 953b8463f9866be1b997072c45972693c9895149e76c0e517607da7ff318cac77bda98d564f1a8f46adf47ba57bca94b6933e3c0a23449b19497de14fb07c20e

data/lib/ruby-swagger.rb

@@ -1,7 +1,3 @@
 require 'ruby-swagger/data/document'
-
 require 'ruby-swagger/railtie' if defined?(Rails)
-
-if defined?(Grape)
-  require 'ruby-swagger/grape/grape'
-end
+require 'ruby-swagger/grape/grape' if defined?(Grape)

data/lib/ruby-swagger/data/contact.rb

@@ -4,8 +4,7 @@ require 'ruby-swagger/data/url'
 require 'ruby-swagger/object'
 
 module Swagger::Data
-  class Contact < Swagger::Object #https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#contactObject
-
+  class Contact < Swagger::Object # https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#contactObject
     DEFAULT_NAME = 'John Doe'
     DEFAULT_EMAIL = 'john.doe@example.com'
     DEFAULT_URL = 'https://google.com/?q=john%20doe'
@@ -20,16 +19,13 @@ module Swagger::Data
 
     def self.parse(contact)
       return nil unless contact
-
       c = Swagger::Data::Contact.new.bulk_set(contact)
       c.validate_url!
-
       c
     end
 
     def url=(url)
       return nil unless url
-
       @url = Swagger::Data::Url.new(url)
     end
 
@@ -42,8 +38,7 @@ module Swagger::Data
     end
 
     def validate_url!
-      raise (ArgumentError.new("Swagger::Data::Contact - contact url is invalid")) if @url && !@url.valid?
+      raise ArgumentError.new('Swagger::Data::Contact - contact url is invalid') if @url && !@url.valid?
     end
-
   end
-end
+end

data/lib/ruby-swagger/data/definitions.rb

@@ -2,8 +2,7 @@ require 'ruby-swagger/object'
 require 'ruby-swagger/data/schema'
 
 module Swagger::Data
-  class Definitions < Swagger::Object #https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#definitionsObject
-
+  class Definitions < Swagger::Object # https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#definitionsObject
     def initialize
       @definitions = {}
     end
@@ -21,10 +20,10 @@ module Swagger::Data
     end
 
     def add_definition(definition_name, definition_value)
-      raise ArgumentError.new("Swagger::Data::Definitions#add_definition - definition_name is nil") unless definition_name
-      raise ArgumentError.new("Swagger::Data::Definitions#add_definition - definition_value is nil") unless definition_value
+      raise ArgumentError.new('Swagger::Data::Definitions#add_definition - definition_name is nil') unless definition_name
+      raise ArgumentError.new('Swagger::Data::Definitions#add_definition - definition_value is nil') unless definition_value
 
-      if !definition_value.is_a?(Swagger::Data::Schema)
+      unless definition_value.is_a?(Swagger::Data::Schema)
         definition_value = Swagger::Data::Schema.parse(definition_value)
       end
 
@@ -44,6 +43,5 @@ module Swagger::Data
 
       swagger_defs
     end
-
   end
-end
+end

data/lib/ruby-swagger/data/document.rb

@@ -12,9 +12,8 @@ require 'ruby-swagger/data/tag'
 require 'ruby-swagger/data/external_documentation'
 
 module Swagger::Data
-  class Document < Swagger::Object  #https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#swagger-object
-
-    SPEC_VERSION = '2.0'  #https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#fixed-fields
+  class Document < Swagger::Object # https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#swagger-object
+    SPEC_VERSION = '2.0' # https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#fixed-fields
     DEFAULT_HOST = 'localhost:80'
 
     attr_swagger :swagger, :info, :host, :basePath, :schemes, :consumes,
@@ -31,18 +30,18 @@ module Swagger::Data
     # parse an hash document into a set of Swagger objects
     #   document is a hash
     def self.parse(document)
-      raise (ArgumentError.new("Swagger::Document#parse - document object is nil")) unless document
+      raise ArgumentError.new('Swagger::Document#parse - document object is nil') unless document
 
       Swagger::Data::Document.new.bulk_set(document)
     end
 
     def swagger=(new_swagger)
-      raise (ArgumentError.new("Swagger::Document#swagger= - the document is not a swagger #{SPEC_VERSION} version")) unless "2.0" == new_swagger
+      raise ArgumentError.new("Swagger::Document#swagger= - the document is not a swagger #{SPEC_VERSION} version") unless '2.0' == new_swagger
       @swagger = new_swagger
     end
 
     def info=(new_info)
-      raise (ArgumentError.new("Swagger::Document#info= - info object is nil")) unless new_info
+      raise ArgumentError.new('Swagger::Document#info= - info object is nil') unless new_info
 
       new_info = Swagger::Data::Info.parse(new_info) unless new_info.is_a?(Swagger::Data::Info)
 
@@ -52,8 +51,8 @@ module Swagger::Data
     def basePath=(new_path)
       new_path = new_path.nil? ? '/' : new_path
 
-      if !(new_path =~ /^\/.+$/)
-        new_path = "/#{new_path}" #new path must start with a /
+      unless new_path =~ /^\/.+$/
+        new_path = "/#{new_path}" # new path must start with a /
       end
 
       @basePath ||= new_path
@@ -63,7 +62,7 @@ module Swagger::Data
       return nil unless new_schemes
 
       new_schemes.each do |scheme|
-        raise (ArgumentError.new("Swagger::Data::Document#schemes= - unrecognized scheme #{scheme}")) unless %w(http https ws wss).include?(scheme)
+        raise ArgumentError.new("Swagger::Data::Document#schemes= - unrecognized scheme #{scheme}") unless %w(http https ws wss).include?(scheme)
       end
 
       @schemes = new_schemes
@@ -73,7 +72,7 @@ module Swagger::Data
       return nil unless new_produces
 
       new_produces.each do |produce|
-        raise (ArgumentError.new("Swagger::Data::Document#produces= - unrecognized produce type #{produce}")) unless Swagger::Data::Mime.valid?(produce)
+        raise ArgumentError.new("Swagger::Data::Document#produces= - unrecognized produce type #{produce}") unless Swagger::Data::Mime.valid?(produce)
       end
 
       @produces = new_produces
@@ -83,16 +82,16 @@ module Swagger::Data
       return nil unless new_consumes
 
       new_consumes.each do |consume|
-        raise (ArgumentError.new("Swagger::Data::Document#consumes= - unrecognized consume type #{consume}]")) unless Swagger::Data::Mime.valid?(consume)
+        raise ArgumentError.new("Swagger::Data::Document#consumes= - unrecognized consume type #{consume}]") unless Swagger::Data::Mime.valid?(consume)
       end
 
-      @consumes= new_consumes
+      @consumes = new_consumes
     end
 
     def paths=(new_paths)
-      raise ArgumentError.new("Swagger::Data::Document#paths= - paths is nil") unless paths
+      raise ArgumentError.new('Swagger::Data::Document#paths= - paths is nil') unless paths
 
-      new_paths = Swagger::Data::Paths.parse(new_paths) if(!new_paths.is_a?(Swagger::Data::Paths))
+      new_paths = Swagger::Data::Paths.parse(new_paths) unless new_paths.is_a?(Swagger::Data::Paths)
 
       @paths = new_paths
     end
@@ -100,7 +99,7 @@ module Swagger::Data
     def definitions=(new_definitions)
       return nil unless new_definitions
 
-      if (!new_definitions.is_a?(Swagger::Data::Definitions))
+      unless new_definitions.is_a?(Swagger::Data::Definitions)
         new_definitions = Swagger::Data::Definitions.parse(new_definitions)
       end
 
@@ -110,7 +109,7 @@ module Swagger::Data
     def parameters=(new_parameters)
       return nil unless new_parameters
 
-      if (!new_parameters.is_a?(Swagger::Data::Parameters))
+      unless new_parameters.is_a?(Swagger::Data::Parameters)
         new_parameters = Swagger::Data::Parameters.parse(new_parameters)
       end
 
@@ -120,7 +119,7 @@ module Swagger::Data
     def responses=(new_responses)
       return nil unless new_responses
 
-      if (!new_responses.is_a?(Swagger::Data::Responses))
+      unless new_responses.is_a?(Swagger::Data::Responses)
         new_responses = Swagger::Data::Responses.parse(new_responses)
       end
 
@@ -130,17 +129,17 @@ module Swagger::Data
     def securityDefinitions=(newSecurityDef)
       return nil unless newSecurityDef
 
-      if (!newSecurityDef.is_a?(Swagger::Data::SecurityDefinitions))
+      unless newSecurityDef.is_a?(Swagger::Data::SecurityDefinitions)
         newSecurityDef = Swagger::Data::SecurityDefinitions.parse(newSecurityDef)
       end
 
-      @securityDefinitions= newSecurityDef
+      @securityDefinitions = newSecurityDef
     end
 
     def security=(new_security)
       return nil unless new_security
 
-      if (!new_security.is_a?(Swagger::Data::SecurityRequirement))
+      unless new_security.is_a?(Swagger::Data::SecurityRequirement)
         new_security = Swagger::Data::SecurityRequirement.parse(new_security)
       end
 
@@ -160,7 +159,7 @@ module Swagger::Data
     def add_tag(new_tag)
       return nil unless new_tag
 
-      if (!new_tag.is_a?(Swagger::Data::Tag))
+      unless new_tag.is_a?(Swagger::Data::Tag)
         new_tag = Swagger::Data::Tag.parse(new_tag)
       end
 
@@ -170,12 +169,11 @@ module Swagger::Data
     def externalDocs=(new_externalDocs)
       return nil unless new_externalDocs
 
-      if (!new_externalDocs.is_a?(Swagger::Data::ExternalDocumentation))
+      unless new_externalDocs.is_a?(Swagger::Data::ExternalDocumentation)
         new_externalDocs = Swagger::Data::ExternalDocumentation.parse(new_externalDocs)
       end
 
       @externalDocs = new_externalDocs
     end
-
   end
-end
+end

data/lib/ruby-swagger/data/example.rb

@@ -1,8 +1,7 @@
 require 'ruby-swagger/object'
 
 module Swagger::Data
-  class Example < Swagger::Object #https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#exampleObject
-
+  class Example < Swagger::Object # https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#exampleObject
     attr_accessor :examples
 
     def initialize
@@ -15,7 +14,7 @@ module Swagger::Data
       ex_obj = Swagger::Data::Example.new
 
       examples = {}
-      new_examples.each {|example_mime, example| examples[example_mime] = example }
+      new_examples.each { |example_mime, example| examples[example_mime] = example }
       ex_obj.examples = examples
 
       ex_obj
@@ -24,6 +23,5 @@ module Swagger::Data
     def as_swagger
       @examples
     end
-
   end
-end
+end

data/lib/ruby-swagger/data/external_documentation.rb

@@ -1,12 +1,11 @@
 require 'ruby-swagger/object'
 
 module Swagger::Data
-  class ExternalDocumentation < Swagger::Object #https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#externalDocumentationObject
-
+  class ExternalDocumentation < Swagger::Object # https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#externalDocumentationObject
     attr_swagger :url, :description
 
     def initialize
-      @url = "http://localhost"
+      @url = 'http://localhost'
     end
 
     def self.parse(external)
@@ -16,9 +15,8 @@ module Swagger::Data
     end
 
     def url=(new_url)
-      raise (ArgumentError.new("Swagger::Data::ExternalDocumentation#url - url is nil")) unless new_url
+      raise ArgumentError.new('Swagger::Data::ExternalDocumentation#url - url is nil') unless new_url
       @url = new_url
     end
-
   end
-end
+end

data/lib/ruby-swagger/data/header.rb

@@ -3,7 +3,6 @@ require 'ruby-swagger/data/items'
 
 module Swagger::Data
   class Header < Swagger::Object # https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#header-object
-
     attr_swagger :description, :type, :format, :items,
                  :collectionFormat, :default, :maximum,
                  :exclusiveMaximum, :minimum, :exclusiveMinimum,
@@ -22,13 +21,12 @@ module Swagger::Data
     end
 
     def items=(new_items)
-      raise ArgumentError.new("Swagger::Data::Header#items= items is nil") if new_items.nil? && @type == 'array'
+      raise ArgumentError.new('Swagger::Data::Header#items= items is nil') if new_items.nil? && @type == 'array'
       if !new_items.nil? && !new_items.is_a?(Swagger::Data::Items)
         new_items = Swagger::Data::Items.parse(new_items)
       end
 
       @items = new_items
     end
-
   end
-end
+end

data/lib/ruby-swagger/data/headers.rb

@@ -3,7 +3,6 @@ require 'ruby-swagger/data/header'
 
 module Swagger::Data
   class Headers < Swagger::Object # https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#headersObject
-
     def initialize
       @headers = {}
     end
@@ -13,16 +12,16 @@ module Swagger::Data
 
       h = Swagger::Data::Headers.new
 
-      headers.each {|header_key, header_value| h.add_header(header_key, header_value) }
+      headers.each { |header_key, header_value| h.add_header(header_key, header_value) }
 
       h
     end
 
     def add_header(header_key, header_value)
-      raise ArgumentError.new("Swagger::Data::Headers#add_header - parameter name is nil") unless header_key
-      raise ArgumentError.new("Swagger::Data::Headers#add_header - parameter value is nil") unless header_value
+      raise ArgumentError.new('Swagger::Data::Headers#add_header - parameter name is nil') unless header_key
+      raise ArgumentError.new('Swagger::Data::Headers#add_header - parameter value is nil') unless header_value
 
-      if !header_value.is_a?(Swagger::Data::Header)
+      unless header_value.is_a?(Swagger::Data::Header)
         header_value = Swagger::Data::Header.parse(header_value)
       end
 
@@ -42,7 +41,5 @@ module Swagger::Data
 
       res
     end
-
-
   end
-end
+end

data/lib/ruby-swagger/data/info.rb

@@ -3,8 +3,7 @@ require 'ruby-swagger/data/contact'
 require 'ruby-swagger/data/license'
 
 module Swagger::Data
-  class Info < Swagger::Object  #https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#info-object
-
+  class Info < Swagger::Object # https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#info-object
     DEFAULT_TITLE = 'My uber-duper API'
     DEFAULT_DESCRIPTION = 'My uber-duper API description'
     DEFAULT_VERSION = '0.1'
@@ -18,20 +17,20 @@ module Swagger::Data
     end
 
     def self.parse(info)
-      raise (ArgumentError.new("Swagger::Data::Info#parse - info object is nil")) unless info
+      raise ArgumentError.new('Swagger::Data::Info#parse - info object is nil') unless info
 
       Swagger::Data::Info.new.bulk_set(info)
     end
 
     def title=(new_title)
-      raise (ArgumentError.new("Swagger::Data::Info#title= - title is invalid")) if new_title.nil? || new_title.empty?
+      raise ArgumentError.new('Swagger::Data::Info#title= - title is invalid') if new_title.nil? || new_title.empty?
       @title = new_title
     end
 
     def contact=(new_contact)
       return nil unless new_contact
 
-      if(!new_contact.is_a?(Swagger::Data::Contact))
+      unless new_contact.is_a?(Swagger::Data::Contact)
         new_contact = Swagger::Data::Contact.parse(new_contact)
       end
 
@@ -41,7 +40,7 @@ module Swagger::Data
     def license=(new_license)
       return nil unless new_license
 
-      if(!new_license.is_a?(Swagger::Data::License))
+      unless new_license.is_a?(Swagger::Data::License)
         new_license = Swagger::Data::License.parse(new_license)
       end
 
@@ -51,6 +50,5 @@ module Swagger::Data
     def valid?
       @license.valid? && @contact.valid?
     end
-
   end
-end
+end

data/lib/ruby-swagger/data/items.rb

@@ -2,14 +2,13 @@ require 'ruby-swagger/object'
 
 module Swagger::Data
   class Items < Swagger::Object # https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#itemsObject
-
     attr_swagger :type, :format, :items, :collectionFormat, :default,
                  :maximum, :exclusiveMaximum, :minimum, :exclusiveMinimum,
                  :maxLength, :minLength, :pattern, :maxItems,
                  :minItems, :uniqueItems, :enum, :multipleOf
 
     def initialize
-      @type = "string"  #we default to an array of strings
+      @type = 'string' # we default to an array of strings
     end
 
     def self.parse(items)
@@ -19,14 +18,14 @@ module Swagger::Data
     end
 
     def type=(new_type)
-      raise ArgumentError.new("Swagger::Data::Items#type= - type is nil") unless new_type
+      raise ArgumentError.new('Swagger::Data::Items#type= - type is nil') unless new_type
       raise ArgumentError.new("Swagger::Data::Items#type= - type #{new_type} is invalid") unless %w(string number integer boolean array).include?(new_type)
 
       @type = new_type
     end
 
     def items=(new_items)
-      raise ArgumentError.new("Swagger::Data::Items#items= - is nil") if new_items.nil? && @type == 'array'
+      raise ArgumentError.new('Swagger::Data::Items#items= - is nil') if new_items.nil? && @type == 'array'
 
       if !new_items.nil? && !new_items.is_a?(Swagger::Data::Items)
         new_items = Swagger::Data::Items.parse(new_items)
@@ -40,6 +39,5 @@ module Swagger::Data
       raise ArgumentError.new("Swagger::Data::Items#collectionFormat= - collectionFormat #{new_collection_format} is invalid") unless %w(csv ssv tsv pipes).include?(new_collection_format)
       @collectionFormat = new_collection_format
     end
-
   end
-end
+end