ruby-swagger 0.0.3 → 0.1.0

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

@@ -2,8 +2,7 @@ require 'ruby-swagger/data/url'
 require 'ruby-swagger/object'
 
 module Swagger::Data
-  class License < Swagger::Object #https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#license-object
-
+  class License < Swagger::Object # https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#license-object
     DEFAULT_NAME = 'Apache 2.0'
     DEFAULT_URL = 'http://www.apache.org/licenses/LICENSE-2.0.html'
 
@@ -21,7 +20,7 @@ module Swagger::Data
     end
 
     def name=(new_name)
-      raise (ArgumentError.new("Swagger::Data::License - license name is invalid ")) if new_name.nil? || new_name.empty?
+      raise ArgumentError.new('Swagger::Data::License - license name is invalid ') if new_name.nil? || new_name.empty?
       @name = new_name
     end
 
@@ -44,8 +43,7 @@ module Swagger::Data
     private
 
     def validate_url!
-      raise (ArgumentError.new("Swagger::Data::License - contact url is invalid")) unless @url.valid?
+      raise ArgumentError.new('Swagger::Data::License - contact url is invalid') unless @url.valid?
     end
-
   end
-end
+end

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

@@ -1,6 +1,5 @@
 module Swagger::Data
   class Mime
-
     @@types = [
       'text/plain',
       'text/plain; charset=utf-8',
@@ -28,6 +27,5 @@ module Swagger::Data
     def self.valid?(type)
       @@types.include?(type)
     end
-
   end
 end

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

@@ -4,8 +4,7 @@ require 'ruby-swagger/data/responses'
 require 'ruby-swagger/data/security_requirement'
 
 module Swagger::Data
-  class Operation < Swagger::Object #https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#operationObject
-
+  class Operation < Swagger::Object # https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#operationObject
     attr_swagger :tags, :summary, :description, :externalDocs, :operationId,
                  :consumes, :produces, :parameters, :responses,
                  :schemes, :deprecated, :security
@@ -23,7 +22,7 @@ module Swagger::Data
         newDoc = Swagger::Data::ExternalDocumentation.parse(newDoc)
       end
 
-      @externalDocs=newDoc
+      @externalDocs = newDoc
     end
 
     def responses=(newResp)
@@ -66,17 +65,16 @@ module Swagger::Data
       if new_parameter.is_a?(Hash)
 
         new_parameter = if new_parameter['$ref']
-                            #it's a reference object
-                            Swagger::Data::Reference.parse(new_parameter)
+                          # it's a reference object
+                          Swagger::Data::Reference.parse(new_parameter)
                         else
-                            #it's a parameter object
-                            Swagger::Data::Parameter.parse(new_parameter)
+                          # it's a parameter object
+                          Swagger::Data::Parameter.parse(new_parameter)
                         end
 
       end
 
       @parameters.push(new_parameter)
     end
-
   end
-end
+end

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

@@ -5,7 +5,6 @@ require 'ruby-swagger/grape/param'
 
 module Swagger::Data
   class Parameter < Swagger::Object # https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#parameter-object
-
     attr_swagger :name, :in, :description, :required, :schema,
                  :type, :format, :allowEmptyValue, :items,
                  :collectionFormat, :default, :maximum,
@@ -46,7 +45,7 @@ module Swagger::Data
     end
 
     def items=(new_items)
-      raise ArgumentError.new("Swagger::Data::Parameter#items= items is nil") if new_items.nil? && @type == 'array'
+      raise ArgumentError.new('Swagger::Data::Parameter#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
@@ -60,8 +59,8 @@ module Swagger::Data
       grape_type = Swagger::Grape::Param.new(grape_parameter.last).to_swagger
 
       parameter = Swagger::Data::Parameter.new
-      parameter.name= grape_parameter.first
-      parameter.in= 'formData'
+      parameter.name = grape_parameter.first
+      parameter.in = 'formData'
       parameter.description = grape_type['description']
       parameter.required = grape_type['required']
       parameter.default = grape_type['default']
@@ -79,10 +78,5 @@ module Swagger::Data
       puts "error processing parameter #{grape_parameter} [#{e}]"
       raise e
     end
-
-    private
-
-
-
   end
-end
+end

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

@@ -3,7 +3,6 @@ require 'ruby-swagger/data/parameter'
 
 module Swagger::Data
   class Parameters < Swagger::Object # https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#parametersDefinitionsObject
-
     def initialize
       @parameters = {}
     end
@@ -21,10 +20,10 @@ module Swagger::Data
     end
 
     def add_param(pname, pvalue)
-      raise ArgumentError.new("Swagger::Data::Parameters#add_param - parameter name is nil") unless pname
-      raise ArgumentError.new("Swagger::Data::Parameters#add_param - parameter value is nil") unless pvalue
+      raise ArgumentError.new('Swagger::Data::Parameters#add_param - parameter name is nil') unless pname
+      raise ArgumentError.new('Swagger::Data::Parameters#add_param - parameter value is nil') unless pvalue
 
-      if !pvalue.is_a?(Swagger::Data::Parameter)
+      unless pvalue.is_a?(Swagger::Data::Parameter)
         pvalue = Swagger::Data::Parameter.parse(pvalue)
       end
 
@@ -48,6 +47,5 @@ module Swagger::Data
 
       swagger_params
     end
-
   end
-end
+end

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

@@ -4,16 +4,15 @@ require 'ruby-swagger/data/parameter'
 require 'ruby-swagger/data/reference'
 
 module Swagger::Data
-  class Path < Swagger::Object #https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#path-item-object
-
-    attr_swagger :get, :put, :post, :delete, :options, :head, :patch, :parameters #and $ref
+  class Path < Swagger::Object # https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#path-item-object
+    attr_swagger :get, :put, :post, :delete, :options, :head, :patch, :parameters # and $ref
     @ref = nil
 
     def self.parse(path)
-      raise (ArgumentError.new("Swagger::Data::Path - path is nil")) unless path
+      raise ArgumentError.new('Swagger::Data::Path - path is nil') unless path
 
       res = Swagger::Data::Path.new.bulk_set(path)
-      res.ref= path['$ref'] if path['$ref']
+      res.ref = path['$ref'] if path['$ref']
       res
     end
 
@@ -39,7 +38,7 @@ module Swagger::Data
       unless new_post.is_a?(Swagger::Data::Operation)
         new_post = Swagger::Data::Operation.parse(new_post)
       end
-      @post= new_post
+      @post = new_post
     end
 
     def delete=(new_delete)
@@ -47,7 +46,7 @@ module Swagger::Data
       unless new_delete.is_a?(Swagger::Data::Operation)
         new_delete = Swagger::Data::Operation.parse(new_delete)
       end
-      @delete= new_delete
+      @delete = new_delete
     end
 
     def options=(new_options)
@@ -55,7 +54,7 @@ module Swagger::Data
       unless new_options.is_a?(Swagger::Data::Operation)
         new_options = Swagger::Data::Operation.parse(new_options)
       end
-      @options= new_options
+      @options = new_options
     end
 
     def head=(new_head)
@@ -64,7 +63,7 @@ module Swagger::Data
         new_head = Swagger::Data::Operation.parse(new_head)
       end
 
-      @head= new_head
+      @head = new_head
     end
 
     def patch=(new_patch)
@@ -72,39 +71,36 @@ module Swagger::Data
       unless new_patch.is_a?(Swagger::Data::Operation)
         new_patch = Swagger::Data::Operation.parse(new_patch)
       end
-      @patch= new_patch
+      @patch = new_patch
     end
 
     def parameters=(new_parameters)
       return nil unless new_parameters
-      raise (ArgumentError.new("Swagger::Data::Path#parameters= - parameters is not an array")) unless new_parameters.is_a?(Array)
+      raise ArgumentError.new('Swagger::Data::Path#parameters= - parameters is not an array') unless new_parameters.is_a?(Array)
 
       @parameters = []
 
       new_parameters.each do |parameter|
         new_param = if parameter['$ref']
-                      #it's a reference object
+                      # it's a reference object
                       Swagger::Data::Reference.parse(parameter)
                     else
-                      #it's a parameter object
+                      # it's a parameter object
                       Swagger::Data::Parameter.parse(parameter)
                     end
 
         @parameters.push(new_param)
       end
-
     end
 
     def ref=(new_ref)
       return nil unless new_ref
-      raise (ArgumentError.new("Swagger::Data::Path#ref= - $ref is not a string")) unless new_ref.is_a?(String)
+      raise ArgumentError.new('Swagger::Data::Path#ref= - $ref is not a string') unless new_ref.is_a?(String)
 
       @ref = new_ref
     end
 
-    def ref
-      @ref
-    end
+    attr_reader :ref
 
     def as_swagger
       res = super

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

@@ -2,15 +2,14 @@ require 'ruby-swagger/object'
 require 'ruby-swagger/data/path'
 
 module Swagger::Data
-  class Paths < Swagger::Object #https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#pathsObject
-
+  class Paths < Swagger::Object # https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#pathsObject
     def initialize
       @paths = {}
     end
 
     def self.parse(paths)
-      raise (ArgumentError.new("Swagger::Data::Paths#parse - paths object is nil")) unless paths
-      raise (ArgumentError.new("Swagger::Data::Paths#parse - paths object is not an hash")) unless paths.is_a?(Hash)
+      raise ArgumentError.new('Swagger::Data::Paths#parse - paths object is nil') unless paths
+      raise ArgumentError.new('Swagger::Data::Paths#parse - paths object is not an hash') unless paths.is_a?(Hash)
 
       pts = Swagger::Data::Paths.new
 
@@ -22,8 +21,8 @@ module Swagger::Data
     end
 
     def add_path(path, path_obj)
-      raise ArgumentError.new("Swagger::Data::Paths#parse - path is nil") if path.nil? || path.empty?
-      raise ArgumentError.new("Swagger::Data::Paths#parse - path object is nil") if path_obj.nil?
+      raise ArgumentError.new('Swagger::Data::Paths#parse - path is nil') if path.nil? || path.empty?
+      raise ArgumentError.new('Swagger::Data::Paths#parse - path object is nil') if path_obj.nil?
 
       unless path_obj.is_a?(Swagger::Data::Path)
         path_obj = Swagger::Data::Path.parse(path_obj)
@@ -45,6 +44,5 @@ module Swagger::Data
 
       swag_obj
     end
-
   end
 end

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

@@ -1,8 +1,7 @@
 require 'ruby-swagger/object'
 
 module Swagger::Data
-  class Reference < Swagger::Object #https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#referenceObject
-
+  class Reference < Swagger::Object # https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#referenceObject
     @ref = nil
 
     def self.parse(reference)
@@ -14,17 +13,14 @@ module Swagger::Data
     end
 
     def ref=(new_ref)
-      raise (ArgumentError.new("Swagger::Data::Reference#ref= $ref is nil")) unless new_ref
+      raise ArgumentError.new('Swagger::Data::Reference#ref= $ref is nil') unless new_ref
       @ref = new_ref
     end
 
-    def ref
-      @ref
-    end
+    attr_reader :ref
 
     def as_swagger
       @ref.nil? ? {} : { '$ref' => @ref }
     end
-
   end
-end
+end

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

@@ -5,7 +5,6 @@ require 'ruby-swagger/data/example'
 
 module Swagger::Data
   class Response < Swagger::Object # https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#responseObject
-
     attr_swagger :description, :schema, :headers, :examples
 
     def self.parse(response)
@@ -20,6 +19,5 @@ module Swagger::Data
 
       r
     end
-
   end
-end
+end

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

@@ -4,7 +4,6 @@ require 'ruby-swagger/data/response'
 
 module Swagger::Data
   class Responses < Swagger::Object # https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#responsesObject
-
     def initialize
       @responses = {}
     end
@@ -45,6 +44,5 @@ module Swagger::Data
 
       res
     end
-
   end
-end
+end

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

@@ -4,8 +4,7 @@ require 'ruby-swagger/data/xml_object'
 require 'ruby-swagger/data/external_documentation'
 
 module Swagger::Data
-  class Schema < Swagger::Object #https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#schemaObject
-
+  class Schema < Swagger::Object # https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#schemaObject
     attr_swagger :discriminator, :readOnly, :xml, :externalDocs, :example,
                  :format, :title, :description, :default,
                  :multipleOf, :maximum, :exclusiveMaximum, :minimum,
@@ -20,7 +19,7 @@ module Swagger::Data
       return nil if schema.nil?
 
       sc = Swagger::Data::Schema.new.bulk_set(schema)
-      sc.ref= schema['$ref']
+      sc.ref = schema['$ref']
       sc
     end
 
@@ -33,7 +32,7 @@ module Swagger::Data
     def externalDocs=(new_doc)
       return nil unless new_doc
 
-      if !new_doc.is_a?(Swagger::Data::ExternalDocumentation)
+      unless new_doc.is_a?(Swagger::Data::ExternalDocumentation)
         new_doc = Swagger::Data::ExternalDocumentation.parse(new_doc)
       end
 
@@ -43,7 +42,7 @@ module Swagger::Data
     def xml=(new_xml)
       return nil unless new_xml
 
-      if !new_xml.is_a?(Swagger::Data::XMLObject)
+      unless new_xml.is_a?(Swagger::Data::XMLObject)
         new_xml = Swagger::Data::XMLObject.parse(new_xml)
       end
 
@@ -51,11 +50,11 @@ module Swagger::Data
     end
 
     def []=(attrib, value)
-      self.send("#{attrib}=", value)
+      send("#{attrib}=", value)
     end
 
     def [](attrib)
-      self.send("#{attrib}")
+      send("#{attrib}")
     end
 
     def as_swagger
@@ -63,6 +62,5 @@ module Swagger::Data
       res['$ref'] = @ref if @ref
       res
     end
-
   end
-end
+end

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

@@ -1,8 +1,7 @@
 require 'ruby-swagger/object'
 
 module Swagger::Data
-  class Scopes < Swagger::Object #https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#scopesObject
-
+  class Scopes < Swagger::Object # https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#scopesObject
     def initialize
       @scopes = {}
     end
@@ -20,8 +19,8 @@ module Swagger::Data
     end
 
     def add_scope(scope_name, scope_value)
-      raise ArgumentError.new("Swagger::Data::Scopes#add_scope - scope_name is nil") unless scope_name
-      raise ArgumentError.new("Swagger::Data::Scopes#add_scope - scope_value is nil") unless scope_value
+      raise ArgumentError.new('Swagger::Data::Scopes#add_scope - scope_name is nil') unless scope_name
+      raise ArgumentError.new('Swagger::Data::Scopes#add_scope - scope_value is nil') unless scope_value
 
       @scopes[scope_name] = scope_value
     end
@@ -39,6 +38,5 @@ module Swagger::Data
 
       swagger_scopes
     end
-
   end
-end
+end

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

@@ -2,8 +2,7 @@ require 'ruby-swagger/object'
 require 'ruby-swagger/data/security_scheme'
 
 module Swagger::Data
-  class SecurityDefinitions < Swagger::Object #https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#securityDefinitionsObject
-    
+  class SecurityDefinitions < Swagger::Object # https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#securityDefinitionsObject
     def initialize
       @security = {}
     end
@@ -21,10 +20,10 @@ module Swagger::Data
     end
 
     def add_param(pname, pvalue)
-      raise ArgumentError.new("Swagger::Data::SecurityDefinitions#add_param - parameter name is nil") unless pname
-      raise ArgumentError.new("Swagger::Data::SecurityDefinitions#add_param - parameter value is nil") unless pvalue
+      raise ArgumentError.new('Swagger::Data::SecurityDefinitions#add_param - parameter name is nil') unless pname
+      raise ArgumentError.new('Swagger::Data::SecurityDefinitions#add_param - parameter value is nil') unless pvalue
 
-      if !pvalue.is_a?(Swagger::Data::SecurityScheme)
+      unless pvalue.is_a?(Swagger::Data::SecurityScheme)
         pvalue = Swagger::Data::SecurityScheme.parse(pvalue)
       end
 
@@ -44,6 +43,5 @@ module Swagger::Data
 
       swagger_params
     end
-
   end
-end
+end