swagger_yard 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b6d7e8bd82bb1384166a7b05b762bbfb31ae9940
-  data.tar.gz: b4094c3b0020e510234ff13632a7be76728bd625
+  metadata.gz: bcc44f83fbfc033ffcb705294bfabe66ad77931f
+  data.tar.gz: 7a4246e624c0064d13d20cb69ab9596554e4c882
 SHA512:
-  metadata.gz: 01b6da87aaa978797af17e081421136c01441d22048666beb8aa6baadc15698110e443b0a263dac0f85c4b45f18e12f5d168bdd35a988aa54cd3799e0d8b9ac2
-  data.tar.gz: 9a8c5b69c3fbf57c17f44398f052ff994d1a640e3f7c0fcb2c54dc9ccfc4347ce1f80b5043f239244c1866ac421269294d367148ec81f0c9d5c0e54a4e66c940
+  metadata.gz: f976b31cefafbe77dcb69adc49319c903d559ed754770e1afff3c1a9a16a0e6568d260504024aad8878364fff90f25580aee38216518b42d6630b5a93d615678
+  data.tar.gz: a8f8ca363f696d796be24398b4d18da83abcb1cfcfd1e9da6eab9018f2caea4d4577402d077d7aff563de2974066bd04605f52a32312a499bb89fe3caf56a81c

data/MIT-LICENSE

@@ -1,4 +1,5 @@
-Copyright 2013 Chris Trinh
+Copyright (c) 2016 LivingSocial
+Copyright (c) 2013 Chris Trinh
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,4 +1,4 @@
-# SwaggerYard [![Build Status](https://travis-ci.org/tpitale/swagger_yard.svg?branch=master)](https://travis-ci.org/tpitale/swagger_yard) #
+# SwaggerYard [![Build Status](https://travis-ci.org/livingsocial/swagger_yard.svg?branch=master)](https://travis-ci.org/tpitale/swagger_yard) #
 
 SwaggerYard is a gem to convert extended YARD syntax comments into the swagger spec compliant json format.
 
@@ -155,12 +155,12 @@ end
 
 We suggest using something like [swagger-ui_rails](https://github.com/3scale/swagger-ui_rails/tree/dev-2.1.3) for your UI needs inside of Rails.
 
-To generate JSON from your code on request, checkout the [swagger_yard-rails](https://github.com/tpitale/swagger_yard-rails) project. This provides an engine to parse and render the json required for use by swagger-ui_rails.
+To generate JSON from your code on request, checkout the [swagger_yard-rails](https://github.com/livingsocial/swagger_yard-rails) project. This provides an engine to parse and render the json required for use by swagger-ui_rails.
 
 ## More Information ##
 
 * [swagger-ui_rails](https://github.com/3scale/swagger-ui_rails/tree/dev-2.1.3)
-* [swagger_yard-rails](https://github.com/tpitale/swagger_yard-rails)
+* [swagger_yard-rails](https://github.com/livingsocial/swagger_yard-rails)
 * [Swagger-spec version 2.0](https://github.com/wordnik/swagger-spec/blob/master/versions/2.0.md)
 * [Yard](https://github.com/lsegal/yard)
 
@@ -203,4 +203,4 @@ end
 In [swagger_yard-rails][], this hook is used to set a function that inspects the
 Rails routing tables to reverse look up and compute paths.
 
-[swagger_yard-rails]: https://github.com/tpitale/swagger-yard_rails
+[swagger_yard-rails]: https://github.com/livingsocial/swagger_yard-rails

data/lib/swagger_yard/model.rb

@@ -24,7 +24,7 @@ module SwaggerYard
       tags.each do |tag|
         case tag.tag_name
         when "model"
-          @id = tag.text
+          @id = tag.text.gsub(/[^[:alnum:]_]+/, '_')
         when "property"
           @properties << Property.from_tag(tag)
         end

data/lib/swagger_yard/operation.rb

@@ -83,7 +83,7 @@ module SwaggerYard
       @http_method = tag.types.first
 
       parse_path_params(tag.text).each do |name|
-        @parameters << Parameter.from_path_param(name)
+        add_or_update_parameter Parameter.from_path_param(name)
       end
     end
 
@@ -93,7 +93,18 @@ module SwaggerYard
     # Example: [Array]     status(required, body)  Filter by status. (e.g. status[]=1&status[]=2&status[]=3)
     # Example: [Integer]   media[media_type_id]                          ID of the desired media type.
     def add_parameter(tag)
-      @parameters << Parameter.from_yard_tag(tag, self)
+      add_or_update_parameter Parameter.from_yard_tag(tag, self)
+    end
+
+    def add_or_update_parameter(parameter)
+      if existing = @parameters.detect {|param| param.name == parameter.name }
+        existing.description    = parameter.description unless parameter.from_path?
+        existing.param_type     = parameter.param_type if parameter.from_path?
+        existing.required     ||= parameter.required
+        existing.allow_multiple = parameter.allow_multiple
+      else
+        @parameters << parameter
+      end
     end
 
     ##

data/lib/swagger_yard/parameter.rb

@@ -1,7 +1,6 @@
 module SwaggerYard
   class Parameter
-    attr_accessor :name, :description
-    attr_reader :param_type, :required, :allow_multiple
+    attr_accessor :name, :description, :param_type, :required, :allow_multiple
 
     def self.from_yard_tag(tag, operation)
       description = tag.text
@@ -28,7 +27,8 @@ module SwaggerYard
       new(name, Type.new("string"), "Scope response to #{name}", {
         required: true,
         allow_multiple: false,
-        param_type: "path"
+        param_type: "path",
+        from_path: true
       })
     end
 
@@ -38,6 +38,11 @@ module SwaggerYard
       @required = options[:required] || false
       @param_type = options[:param_type] || 'query'
       @allow_multiple = options[:allow_multiple] || false
+      @from_path      = options[:from_path] || false
+    end
+
+    def from_path?
+      @from_path
     end
 
     def to_h

data/lib/swagger_yard/version.rb

@@ -1,3 +1,3 @@
 module SwaggerYard
-  VERSION = "0.3.1"
+  VERSION = "0.3.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swagger_yard
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - chtrinh (Chris Trinh)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-16 00:00:00.000000000 Z
+date: 2016-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard