ruby-swagger 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1d1aefb55567ede55aa051c96e6d6c9e3c8041fa
-  data.tar.gz: 7c2b67857e4d9a58347f4abadf180f1832f42c32
+  metadata.gz: 5ccc71e0ff84b67c4ac47b030628c2066702eb09
+  data.tar.gz: 3e41cd67f7e59e2edfc529946eddee2e9704c95b
 SHA512:
-  metadata.gz: e0afd868df01ae477ca6510e1157b95d2ff5c6e9f4e0bb7215b59184802b7d23b44e2bcb3c7b83a9567098da2868d061f2efa5d1078ee7e32e6cb40b7d00ea38
-  data.tar.gz: 953b8463f9866be1b997072c45972693c9895149e76c0e517607da7ff318cac77bda98d564f1a8f46adf47ba57bca94b6933e3c0a23449b19497de14fb07c20e
+  metadata.gz: fccc7b0f0152cd5bd34e06747b91cc6a632d03a18056415a2f826fe8b9384a75acc38ac49dc14658d13e7e17a25c6fbc8bd42e1b90c5f2fc01c7b36272cabfd8
+  data.tar.gz: 7e6f89f399ba6f59749da1fcbc0f33cb046a4137d6c6f61109d4b5632e24d89402279f257328d6fd24feace23f965b37948bfd62048fcdb942edfcab9a5eada2

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

@@ -3,9 +3,9 @@ module Swagger::Data
     @@types = [
       'text/plain',
       'text/plain; charset=utf-8',
-      'application/octet-stream',
       'application/json',
       'application/hal+json',
+      'application/problem+json',
       'application/postscript',
       'application/pdf',
       'application/postscript',

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

@@ -16,6 +16,10 @@ module Swagger::Data
       res
     end
 
+    def all_methods
+      [@get, @put, @post, @delete, @options, @head, @patch].compact
+    end
+
     def get=(new_get)
       return nil unless new_get
       unless new_get.is_a?(Swagger::Data::Operation)
@@ -25,7 +29,7 @@ module Swagger::Data
       @get = new_get
     end
 
-    def self.put=(new_put)
+    def put=(new_put)
       return nil unless new_put
       unless new_put.is_a?(Swagger::Data::Operation)
         new_put = Swagger::Data::Operation.parse(new_put)

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

@@ -31,6 +31,10 @@ module Swagger::Data
       @paths[path] = path_obj
     end
 
+    def all_paths
+      @paths.values
+    end
+
     def [](path)
       @paths[path]
     end

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

@@ -239,12 +239,18 @@ module Swagger::Grape
     end
 
     # Can potentionelly be used for per-param documentation, for now used for example values
-    def documented_paramter(schema, name, parameter)
+    def documented_paramter(schema, target, parameter)
       return if parameter.nil? || parameter[:documentation].nil?
-
       unless parameter[:documentation][:example].nil?
         schema['example'] ||= {}
-        schema['example'][name] = parameter[:documentation][:example]
+        if target.is_a? Array
+          nesting = target[0]
+          target = target[1]
+          schema['example'][nesting] ||= {}
+          schema['example'][nesting][target] = parameter[:documentation][:example]
+        else
+          schema['example'][target] = parameter[:documentation][:example]
+        end
       end
     end
 
@@ -259,12 +265,12 @@ module Swagger::Grape
       path = param_name.scan(/[0-9a-zA-Z_]+/)
       append_to = find_elem_in_schema(schema, path.dup)
       converted_param = Swagger::Grape::Param.new(parameter)
+
       append_to['properties'][path.last] = converted_param.to_swagger
 
       remember_type(converted_param.type_definition) if converted_param.has_type_definition?
-
       required_parameter(append_to, path.last, parameter)
-      documented_paramter(append_to, path.last, parameter)
+      documented_paramter(schema, path, parameter)
     end
 
     def find_elem_in_schema(root, schema_path)

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

@@ -8,11 +8,10 @@ module Swagger::Grape
 
     def initialize(type)
       @type = type.to_s || 'String'
-      @swagger_type = {}
     end
 
     def to_swagger(with_definition = true)
-      translate(@type, with_definition)
+      translate(with_definition)
     end
 
     def sub_types
@@ -21,47 +20,94 @@ module Swagger::Grape
 
     private
 
-    def translate(type, with_definition)
-      case type.downcase
-      when 'string'
-        @swagger_type['type'] = 'string'
-      when 'integer'
-        @swagger_type['type'] = 'integer'
-      when 'array'
-        @swagger_type['type'] = 'array'
-        @swagger_type['items'] = { 'type' => 'string' }
-      when 'hash'
-        @swagger_type['type'] = 'object'
-        @swagger_type['properties'] = {}
-      when 'boolean'
-        @swagger_type['type'] = 'boolean'
-      when 'virtus::attribute::boolean'
-        @swagger_type['type'] = 'boolean'
-      when 'symbol'
-        @swagger_type['type'] = 'string'
-      when 'float'
-        @swagger_type['type'] = 'number'
-        @swagger_type['format'] = 'float'
-      when 'rack::multipart::uploadedfile'
-        @swagger_type['type'] = 'string'
-        STDERR.puts 'Warning - I have no idea how to handle the type file. Right now I will consider this a string, but we should probably handle it...'
-      when 'date'
-        @swagger_type['type'] = 'string'
-        @swagger_type['format'] = 'date'
-      when 'datetime'
-        @swagger_type['type'] = 'string'
-        @swagger_type['format'] = 'date-time'
-      else
+    def translate(with_definition)
+      swagger_type = {}
+
+      # basic type
+      if basic_type?
+        swagger_type = basic_type_schemes[@type.downcase]
 
+      # grape shorthand array eg. `Array[Integer]`
+      elsif short_hand_array?
+        swagger_type = shorthand_array_scheme
+
+      # representer or entity object
+      else
         if with_definition
-          # I can just reference the name of the object here
-          @swagger_type['type'] = 'object'
-          @swagger_type['$ref'] = "#/definitions/#{type}"
+          # I can just reference the name of the representer here
+          swagger_type = {
+            'type' => 'object',
+            '$ref' => "#/definitions/#{@type}"
+          }
+
+        # grape-entity object
         else
-          @swagger_type = Swagger::Grape::Entity.new(type).to_swagger
+          swagger_type = Swagger::Grape::Entity.new(@type).to_swagger
         end
       end
-      @swagger_type
+      swagger_type
+    end
+
+    def short_hand_array?
+      !(@type.downcase =~ /\[[a-zA-Z]+\]/).nil?
+    end
+
+    def basic_type?
+      basic_type_schemes.key? @type.downcase
+    end
+
+    def shorthand_array_scheme
+      match = @type.downcase.match(/\[(.*?)\]/)
+      @swagger_type = {
+        'type' => 'array',
+        'items' => {
+          'type' => match[1]
+        }
+      }
+    end
+
+    def basic_type_schemes
+      {
+        'string' => {
+          'type' => 'string'
+        },
+        'integer' => {
+          'type' => 'integer'
+        },
+        'array' => {
+          'type' => 'array',
+          'items' => { 'type' => 'string' }
+        },
+        'hash' => {
+          'type' => 'object',
+          'properties' => {}
+        },
+        'boolean' => {
+          'type' => 'boolean'
+        },
+        'virtus::attribute::boolean' => {
+          'type' => 'boolean'
+        },
+        'symbol' => {
+          'type' => 'string'
+        },
+        'float' => {
+          'type' => 'number',
+          'format' => 'float'
+        },
+        'rack::multipart::uploadedfile' => {
+          'type' => 'string' # 'Warning - I have no idea how to handle the type file. Right now I will consider this a string, but we should probably handle it...'
+        },
+        'date' => {
+          'type' => 'string',
+          'format' => 'date'
+        },
+        'datetime' => {
+          'type' => 'string',
+          'format' => 'date-time'
+        }
+
+      }.freeze
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-swagger
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Luca Bonmassar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-24 00:00:00.000000000 Z
+date: 2016-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable