Merge pull request #200 from ypresto/symbol-as-string

Treat Symbol as string in params parsing

Author: dblock

.rubocop_todo.yml

@@ -1,42 +1,42 @@
 # This configuration was generated by `rubocop --auto-gen-config`
-# on 2014-11-29 13:48:01 -0500 using RuboCop version 0.27.0.
+# on 2015-02-02 02:04:29 +0900 using RuboCop version 0.27.0.
 # 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.
 
 # Offense count: 8
 Metrics/AbcSize:
-  Max: 327
+  Max: 324
 
 # Offense count: 1
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
-  Max: 397
+  Max: 399
 
 # Offense count: 5
 Metrics/CyclomaticComplexity:
   Max: 93
 
-# Offense count: 195
+# Offense count: 220
 # Configuration parameters: AllowURI, URISchemes.
 Metrics/LineLength:
   Max: 254
 
 # Offense count: 13
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
-  Max: 359
+  Max: 360
 
 # Offense count: 4
 Metrics/PerceivedComplexity:
-  Max: 96
+  Max: 94
 
-# Offense count: 7
+# Offense count: 8
 Style/ClassVars:
   Enabled: false
 
-# Offense count: 69
+# Offense count: 70
 Style/Documentation:
   Enabled: false
 

CHANGELOG.md

@@ -1,6 +1,7 @@
 ### Next Release
 
 * [#196](https://github.com/tim-vandecasteele/grape-swagger/pull/196): If `:type` is omitted, see if it's available in `:using` - [@jhollinger](https://github.com/jhollinger).
+* [#200](https://github.com/tim-vandecasteele/grape-swagger/pull/200): Treat `type: Symbol` as string form parameter - [@ypresto](https://github.com/ypresto).
 * Your contribution here.
 
 ### 0.9.0 (December 19, 2014)

lib/grape-swagger.rb

@@ -88,6 +88,8 @@ def parse_params(params, path, method)
                                   'dateTime'
                                 when 'Numeric'
                                   'double'
+                                when 'Symbol'
+                                  'string'
                                 else
                                   @@documentation_class.parse_entity_name(raw_data_type)
                                 end

spec/form_params_spec.rb

@@ -30,6 +30,15 @@ def app
         {}
       end
 
+      params do
+        requires :id, type: Integer, desc: 'id of item'
+        requires :name, type: String, desc: 'name of item'
+        optional :conditions, type: Symbol, desc: 'conditions of item', values: [:one, :two]
+      end
+      post '/items/:id' do
+        {}
+      end
+
       add_swagger_documentation
     end
   end
@@ -46,5 +55,11 @@ def app
     expect(subject['apis'][1]['path']).to start_with '/items/{id}'
     expect(subject['apis'][1]['operations'][0]['method']).to eq 'PUT'
     expect(subject['apis'][1]['operations'][1]['method']).to eq 'PATCH'
+    expect(subject['apis'][1]['operations'][2]['method']).to eq 'POST'
+  end
+
+  it 'treats Symbol parameter as form param' do
+    expect(subject['apis'][1]['operations'][2]['parameters'][2]['paramType']).to eq 'form'
+    expect(subject['apis'][1]['operations'][2]['parameters'][2]['type']).to eq 'string'
   end
 end

spec/grape-swagger_helper_spec.rb

@@ -62,6 +62,25 @@ class HelperTestAPI < Grape::API
 
     end
 
+    it 'parses symbol param as string' do
+      params = {
+        animal: { type: 'Symbol', desc: 'An animal you like', required: true, values: [:cat, :dog] }
+      }
+      path = '/coolness'
+      method = 'POST'
+      expect(subject.parse_params(params, path, method)).to eq [
+        {
+          paramType: 'form',
+          name: :animal,
+          description: 'An animal you like',
+          type: 'string',
+          required: true,
+          allowMultiple: false,
+          enum: [:cat, :dog]
+        }
+      ]
+    end
+
     context 'custom type' do
       before :all do
         class CustomType