ruby-swagger 0.0.3 → 0.1.0

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

@@ -1,8 +1,7 @@
 require 'ruby-swagger/object'
 
 module Swagger::Data
-  class SecurityRequirement < Swagger::Object #https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#securityRequirementObject
-
+  class SecurityRequirement < Swagger::Object # https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#securityRequirementObject
     def initialize
       @requirements = {}
     end
@@ -11,14 +10,14 @@ module Swagger::Data
       return nil unless security
 
       s = Swagger::Data::SecurityRequirement.new
-      security.each {|key, reqs| s.add_requirement(key, reqs)}
+      security.each { |key, reqs| s.add_requirement(key, reqs) }
       s
     end
 
     def add_requirement(key, requirements)
-      raise (ArgumentError.new("Swagger::Data::SecurityRequirement#add_requirement - key is nil")) unless key
-      raise (ArgumentError.new("Swagger::Data::SecurityRequirement#add_requirement - requirements is nil")) unless requirements
-      raise (ArgumentError.new("Swagger::Data::SecurityRequirement#add_requirement - requirements is not an array")) unless requirements.is_a?(Array)
+      raise ArgumentError.new('Swagger::Data::SecurityRequirement#add_requirement - key is nil') unless key
+      raise ArgumentError.new('Swagger::Data::SecurityRequirement#add_requirement - requirements is nil') unless requirements
+      raise ArgumentError.new('Swagger::Data::SecurityRequirement#add_requirement - requirements is not an array') unless requirements.is_a?(Array)
 
       @requirements[key] = requirements
     end
@@ -30,6 +29,5 @@ module Swagger::Data
     def as_swagger
       @requirements
     end
-
   end
-end
+end

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

@@ -2,8 +2,7 @@ require 'ruby-swagger/object'
 require 'ruby-swagger/data/scopes'
 
 module Swagger::Data
-  class SecurityScheme < Swagger::Object #https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#securitySchemeObject
-
+  class SecurityScheme < Swagger::Object # https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#securitySchemeObject
     attr_swagger :type, :description, :name, :in, :flow, :authorizationUrl, :tokenUrl, :scopes
 
     def self.parse(security)
@@ -13,21 +12,21 @@ module Swagger::Data
     end
 
     def type=(new_type)
-      raise ArgumentError.new("Security::Data::SecurityScheme#type= - type is nil") unless new_type
+      raise ArgumentError.new('Security::Data::SecurityScheme#type= - type is nil') unless new_type
       raise ArgumentError.new("Security::Data::SecurityScheme#type= - unrecognized type #{new_type}") unless %w(basic apiKey oauth2).include?(new_type)
 
       @type = new_type
     end
 
     def name=(new_name)
-      raise ArgumentError.new("Security::Data::SecurityScheme#name= - name is nil") if @type == 'apiKey' && !new_name
+      raise ArgumentError.new('Security::Data::SecurityScheme#name= - name is nil') if @type == 'apiKey' && !new_name
 
       @name = new_name
     end
 
     def in=(new_in)
       if @type == 'apiKey'
-        raise ArgumentError.new("Security::Data::SecurityScheme#in= - in is nil") if !new_in
+        raise ArgumentError.new('Security::Data::SecurityScheme#in= - in is nil') unless new_in
         raise ArgumentError.new("Security::Data::SecurityScheme#in= - unrecognized in #{new_in}") unless %w(query header).include?(new_in)
       end
 
@@ -36,7 +35,7 @@ module Swagger::Data
 
     def flow=(new_flow)
       if @type == 'oauth2'
-        raise ArgumentError.new("Security::Data::SecurityScheme#flow= - flow is nil")  if !new_flow
+        raise ArgumentError.new('Security::Data::SecurityScheme#flow= - flow is nil') unless new_flow
         raise ArgumentError.new("Security::Data::SecurityScheme#flow= - unrecognized flow #{new_flow}") unless %w(implicit password application accessCode).include?(new_flow)
       end
 
@@ -44,24 +43,23 @@ module Swagger::Data
     end
 
     def authorizationUrl=(new_authorizationUrl)
-      raise ArgumentError.new("Security::Data::SecurityScheme#authorizationUrl= - authorizationUrl is nil") if @type == 'oauth2' && (@flow == 'implicit' || @flow == 'accessCode') && !new_authorizationUrl
+      raise ArgumentError.new('Security::Data::SecurityScheme#authorizationUrl= - authorizationUrl is nil') if @type == 'oauth2' && (@flow == 'implicit' || @flow == 'accessCode') && !new_authorizationUrl
 
       @authorizationUrl = new_authorizationUrl
     end
 
     def tokenUrl=(new_tokenUrl)
-      raise ArgumentError.new("Security::Data::SecurityScheme#tokenUrl= - tokenUrl is nil") if @type == 'oauth2' && (@flow == 'password' || @flow == 'application' || @flow == 'accessCode') && !new_tokenUrl
+      raise ArgumentError.new('Security::Data::SecurityScheme#tokenUrl= - tokenUrl is nil') if @type == 'oauth2' && (@flow == 'password' || @flow == 'application' || @flow == 'accessCode') && !new_tokenUrl
 
       @tokenUrl = new_tokenUrl
     end
 
     def scopes=(new_scopes)
-      raise ArgumentError.new("Security::Data::SecurityScheme#scopes= - scopes is nil") if @type == 'oauth2' && !new_scopes
+      raise ArgumentError.new('Security::Data::SecurityScheme#scopes= - scopes is nil') if @type == 'oauth2' && !new_scopes
 
-      new_scopes = Swagger::Data::Scopes.parse(new_scopes) if(!new_scopes.is_a?(Swagger::Data::Scopes))
+      new_scopes = Swagger::Data::Scopes.parse(new_scopes) unless new_scopes.is_a?(Swagger::Data::Scopes)
 
       @scopes = new_scopes
     end
-
   end
-end
+end

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

@@ -2,8 +2,7 @@ require 'ruby-swagger/object'
 require 'ruby-swagger/data/external_documentation'
 
 module Swagger::Data
-  class Tag < Swagger::Object #https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#tag-object
-
+  class Tag < Swagger::Object # https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#tag-object
     attr_swagger :name, :description, :externalDocs
 
     def self.parse(xml_object)
@@ -17,8 +16,7 @@ module Swagger::Data
 
       newDoc = Swagger::Data::ExternalDocumentation.parse(newDoc) unless newDoc.is_a?(Swagger::Data::ExternalDocumentation)
 
-      @externalDocs=newDoc
+      @externalDocs = newDoc
     end
-
   end
-end
+end

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

@@ -2,7 +2,6 @@ require 'addressable/uri'
 
 module Swagger::Data
   class Url
-
     SCHEMES = %w(http https)
 
     attr_reader :url
@@ -21,6 +20,5 @@ module Swagger::Data
     def to_swagger
       url
     end
-
   end
-end
+end

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

@@ -1,8 +1,7 @@
 require 'ruby-swagger/object'
 
 module Swagger::Data
-  class XMLObject < Swagger::Object #https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#xmlObject
-
+  class XMLObject < Swagger::Object # https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#xmlObject
     attr_swagger :name, :namespace, :prefix, :attribute, :wrapped
 
     def self.parse(xml_object)
@@ -10,6 +9,5 @@ module Swagger::Data
 
       Swagger::Data::XMLObject.new.bulk_set(xml_object)
     end
-
   end
-end
+end

data/lib/ruby-swagger/grape/entity.rb

@@ -0,0 +1,41 @@
+module Swagger::Grape
+  class Entity
+    def initialize(type)
+      raise ArgumentError.new("Expecting a Grape::Entity - Can't translate this!") unless Object.const_get(type) < Grape::Entity
+
+      @type = type
+      @swagger_type = { 'type' => 'object', 'properties' => {} }
+    end
+
+    def to_swagger
+      root_exposures.each do |exposure|
+        @swagger_type['properties'].merge!(Swagger::Grape::EntityExposure.new(exposure).to_swagger)
+      end
+      @swagger_type
+    end
+
+    def sub_types
+      collection = []
+      root_exposures.each do |exposure|
+        exposure = Swagger::Grape::EntityExposure.new(exposure)
+        collection << exposure.sub_type if exposure.sub_type
+
+        exposure.nested_exposures.each do |nested_exposure|
+          nested_exposure = Swagger::Grape::EntityExposure.new(nested_exposure)
+          collection << nested_exposure.sub_type if nested_exposure.sub_type
+        end if exposure.nested?
+      end
+      collection.uniq
+    end
+
+    private
+
+    def root_exposures
+      entity_class.root_exposures
+    end
+
+    def entity_class
+      Object.const_get(@type)
+    end
+  end
+end

data/lib/ruby-swagger/grape/entity_exposure.rb

@@ -0,0 +1,96 @@
+module Swagger::Grape
+  class EntityExposure
+    def initialize(exposure)
+      raise ArgumentError.new("Expecting a Grape::Entity::Exposure - Can't translate #{exposure}!") unless exposure.is_a? Grape::Entity::Exposure::Base
+
+      @exposure = exposure
+      @swagger_type = { attribute => {} }
+    end
+
+    def to_swagger
+      translate
+    end
+
+    def sub_type
+      options[:using] if representer?
+    end
+
+    def nested?
+      options[:nesting] || false
+    end
+
+    def array?
+      type == 'array'
+    end
+
+    def representer?
+      @exposure.is_a? Grape::Entity::Exposure::RepresentExposure
+    end
+
+    def type?
+      type.present?
+    end
+
+    def nested_exposures
+      nested? ? @exposure.nested_exposures : nil
+    end
+
+    def type
+      documentation[:type].to_s.downcase if documentation[:type].present?
+    end
+
+    def attribute
+      options[:as].present? ? options[:as].to_s : @exposure.attribute.to_s
+    end
+
+    def options
+      @exposure.send(:options)
+    rescue
+      {}
+    end
+
+    def documentation
+      @exposure.documentation || {}
+    rescue
+      {}
+    end
+
+    def description
+      @exposure.documentation[:desc] if @exposure.documentation[:desc].present?
+    end
+
+    private
+
+    def translate
+      nested? ? translate_nesting_exposure : translate_exposure
+    end
+
+    def to_swagger_type(property)
+      @swagger_type[attribute].merge!(property)
+      @swagger_type
+    end
+
+    def translate_nesting_exposure
+      to_swagger_type(Swagger::Grape::EntityNestingExposure.new(@exposure).to_swagger)
+    end
+
+    def translate_exposure
+      to_swagger_type(Type.new(type).to_swagger(true)) if type?
+
+      if representer?
+        # it's either an object or an array of object
+        using = Type.new(options[:using].to_s).to_swagger(true)
+
+        if array?
+          to_swagger_type('items' => using)
+        else
+          to_swagger_type(using)
+        end
+      end
+
+      @swagger_type[attribute]['description'] = documentation[:desc] if documentation[:desc].present?
+      @swagger_type[attribute]['type'] ||= 'string' # no type defined, assuming it's a string
+      @swagger_type
+    end
+  end
+end

data/lib/ruby-swagger/grape/entity_nesting_exposure.rb

@@ -0,0 +1,38 @@
+module Swagger::Grape
+  class EntityNestingExposure < EntityExposure
+    def initialize(exposure)
+      raise ArgumentError.new("Expecting a NestingExposure - Can't translate #{exposure}!") unless exposure.is_a? Grape::Entity::Exposure::NestingExposure
+
+      @exposure = exposure
+      @properties = {}
+    end
+
+    def to_swagger
+      nested_exposures.each do |exposure|
+        @properties.merge!(Swagger::Grape::EntityExposure.new(exposure).to_swagger)
+      end
+
+      array? ? array_schema : object_schema
+    end
+
+    private
+
+    def object_schema
+      {
+        'type' => 'object',
+        'properties' => @properties
+      }
+    end
+
+    def array_schema
+      {
+        'type' => 'array',
+        'description' => description,
+        'items' => {
+          'type' => 'object',
+          'properties' => @properties
+        }
+      }
+    end
+  end
+end

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

@@ -1,2 +1,2 @@
 require 'ruby-swagger/grape/grape_presenter'
-require 'ruby-swagger/grape/grape_config'
+require 'ruby-swagger/grape/grape_config'

data/lib/ruby-swagger/grape/grape_config.rb

@@ -6,7 +6,6 @@ module Grape
       extend ActiveSupport::Concern
 
       module ClassMethods
-
         def api_desc(description, options = {}, &block)
           default_api_options!(options)
           block.call if block_given?
@@ -62,27 +61,25 @@ module Grape
         def tags(new_tags)
           raise ArgumentError.new("Grape::tags - unrecognized value #{new_tags} - tags can only be an array of strings or a string") unless new_tags.is_a?(Array) || new_tags.is_a?(String)
 
-          if new_tags.is_a?(String)
-            new_tags = [new_tags]
-          end
+          new_tags = [new_tags] if new_tags.is_a?(String)
 
-          @api_options[:tags]= new_tags
+          @api_options[:tags] = new_tags
         end
 
         def response(new_result, options = {})
           raise ArgumentError.new("Grape::response - response can't be nil") unless new_result
 
-          response_obj = {entity: new_result}
+          response_obj = { entity: new_result }
           response_obj[:root] = options[:root] || options['root']
           response_obj[:headers] = options[:headers] || options['headers']
           response_obj[:isArray] = options[:isArray] || options['isArray']
 
-          @api_options[:response]= response_obj
+          @api_options[:response] = response_obj
         end
 
         def errors(errors_value)
           raise ArgumentError.new("Grape::errors - unrecognized value #{errors_value} - errors root must be a hash of errors") unless errors_value.is_a?(Hash)
-          @api_options[:errors]= errors_value
+          @api_options[:errors] = errors_value
         end
 
         @@headers = {}
@@ -137,20 +134,20 @@ module Grape
 
         def default_api_options!(options)
           @api_options = {
-              headers: @@headers,
-              deprecated: @@deprecated,
-              hidden: @@hidden,
-              scopes: @@scopes,
-              tags: @@tags,
-              response: {
-                  entity: @@response_entity,
-                  root: @@response_root,
-                  headers: @@response_headers,
-                  isArray: false
-              },
-              errors: @@errors,
-              api_name: nil,
-              detail: ''
+            headers: @@headers,
+            deprecated: @@deprecated,
+            hidden: @@hidden,
+            scopes: @@scopes,
+            tags: @@tags,
+            response: {
+              entity: @@response_entity,
+              root: @@response_root,
+              headers: @@response_headers,
+              isArray: false
+            },
+            errors: @@errors,
+            api_name: nil,
+            detail: ''
           }.merge(options)
           @description = ''
         end

data/lib/ruby-swagger/grape/grape_presenter.rb

@@ -4,14 +4,13 @@ module Grape
   module DSL
     module InsideRoute
       def api_present(*args)
-
         args_list = args || []
         options = {}
 
         # Initialize the options hash - either by assigning to the current options for the method or with a new one
         if args_list.count == 2
 
-          if args_list.last.kind_of?(Hash)
+          if args_list.last.is_a?(Hash)
             options = args_list.last
           else
             raise ArgumentError.new "The expected second argument for api_present is a Hash, but I got a #{args_list.last.class}"
@@ -19,7 +18,7 @@ module Grape
 
         elsif args_list.count == 1
 
-          #Initialize the option list
+          # Initialize the option list
           args_list << options
 
         elsif args_list.count > 2 || args_list.count == 0
@@ -27,21 +26,19 @@ module Grape
         end
 
         # Setting the grape :with
-        if route.route_response.present? && route.route_response[:entity].present? &&!options[:with].present? && route.route_response[:entity].kind_of?(Class)
+        if route.route_response.present? && route.route_response[:entity].present? && !options[:with].present? && route.route_response[:entity].is_a?(Class)
           options[:with] = route.route_response[:entity]
         end
 
         # Setting the grape :root
-        if route.route_response.present? && route.route_response[:root].present? && !options[:root].present? && route.route_response[:root].kind_of?(String)
+        if route.route_response.present? && route.route_response[:root].present? && !options[:root].present? && route.route_response[:root].is_a?(String)
           options[:root] = route.route_response[:root]
         end
 
         # Setting the :current_user extension
-        if defined?(current_user)
-          options[:current_user] = current_user
-        end
+        options[:current_user] = current_user if defined?(current_user)
 
-        present *args_list
+        present(*args_list)
       end
     end
   end