swagger-blocks 1.1.2 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a6055711e3ea9c391a362d51dab6494f1fb4c8e8
-  data.tar.gz: 03248ded0ff0ba04e55345a94ec0ce82d3e4134b
+  metadata.gz: 31a1a447a188f72eeed1b9d53af76f64c8d32bf3
+  data.tar.gz: 48b4620a81451150fb45fa44ad9eeb89230798c7
 SHA512:
-  metadata.gz: 344b4923bf905546cd1242854220f0da1b4cafc0510286e14c1fecb33fac05d7056218a0cede84afd989a2a277d9b7537d5d06964ba14ee3b9b2b9ff793f0537
-  data.tar.gz: e81f1506e5286e47168e83e65e5c2e130c108fc66805c383da4266c891c8dd13de5b9bbea01099c7da7d1273d9173716f7cfa87c16b6bcc4c8d86da15a0294df
+  metadata.gz: 57ab194b9a26461679e347dd4ca1fe8b5501c7fca48c6e2b61c017fc27ef560e4d9f17b97585e274ffe29b70f44d6830bb4dc44f31bc33643626b2f0279c5fc9
+  data.tar.gz: ad364023be29b25475e9c72947afe9b2274be31c10bcafc2481f7a0132ae4a5b684d2cd7e23e0e6fbefe30871cd8e68fa4fb6cba837aecd0ef16014a9a6b03c4

data/README.md

@@ -11,7 +11,7 @@ It helps you write API docs in the [Swagger](https://helloreverb.com/developers/
 
 * Supports **live updating** by design. Change code, refresh your API docs.
 * **Works with all Ruby web frameworks** including Rails, Sinatra, etc.
-* **100% support** for all features of the [Swagger 1.2](https://github.com/wordnik/swagger-spec/blob/master/versions/1.2.md) and [Swagger 2.0](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md) specs.
+* **100% support** for all features of the [Swagger 2.0](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md) and [Swagger 1.2](https://github.com/wordnik/swagger-spec/blob/master/versions/1.2.md) specs.
 * Flexible—you can use Swagger::Blocks anywhere, split up blocks to fit your style preferences, etc. Since it's pure Ruby and serves definitions dynamically, you can easily use initializers/config objects to change values or even **show different APIs based on environment**.
 * 1:1 naming with the Swagger spec—block names and nesting should match almost exactly with the swagger spec, with rare exceptions to make things more convenient.
 
@@ -240,7 +240,7 @@ class ApidocsController < ActionController::Base
         key :name, 'MIT'
       end
     end
-    tags do
+    tag do
       key :name, 'pet'
       key :description, 'Pets operations'
       externalDocs do
@@ -278,7 +278,7 @@ That is the only line necessary to build the full [root Swagger object](https://
 
 Now, simply point Swagger UI at `/apidocs` and everything should Just Work™. If you change any of the Swagger block definitions, you can simply refresh Swagger UI to see the changes.
 
-#### Security handling
+### Security handling
 
 To support Swagger's definitions for API key auth or OAuth2, use `security_definition` in your `swagger_root`:
 
@@ -323,6 +323,14 @@ You can then apply [security requirement objects](https://github.com/swagger-api
   end
 ```
 
+#### Nested complex objects
+
+The `key` block simply takes the value you give and puts it directly into the final JSON object. So, if you need to set more complex objects, you can just do:
+
+```ruby
+  key :foo, {some_complex: {nested_object: true}}
+```
+
 #### Writing JSON to a file
 
 If you are not serving the JSON directly and need to write it to a file for some reason, you can easily use `build_root_json` for that as well:
@@ -348,8 +356,12 @@ See the [swagger_v2_blocks_spec.rb](https://github.com/fotinakis/swagger-blocks/
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
 
+Throw a ★ on it! :)
+
 ## Release notes
 
+* v1.1.3: Rename tags directive to tag for consistency.
+* v1.1.2: Bugfix for security definition support.
 * v1.1.1: Bugfix for tags node support.
 * v1.1: Support for Swagger 2.0 spec.
 * v1.0.1: Make backwards-compatible with Ruby 1.9.3.

data/lib/swagger/blocks/version.rb

@@ -1,5 +1,5 @@
 module Swagger
   module Blocks
-    VERSION = '1.1.2'
+    VERSION = '1.1.3'
   end
 end

data/lib/swagger/blocks.rb

@@ -337,12 +337,16 @@ module Swagger
         self.data[:security] << Swagger::Blocks::SecurityRequirementNode.call(version: version, &block)
       end
 
-      def tags(&block)
+      def tag(&block)
         raise NotSupportedError unless is_swagger_2_0?
 
         self.data[:tags] ||= []
         self.data[:tags] << Swagger::Blocks::TagNode.call(version: version, &block)
       end
+
+      # Use 'tag' instead.
+      # @deprecated
+      alias_method :tags, :tag
     end
 
     # v1.2: http://goo.gl/PvwUXj#512-resource-object

data/spec/lib/swagger_v2_api_declaration.json

@@ -219,8 +219,11 @@
         "name": {
           "type": "string"
         },
-        "tag": {
-          "type": "string"
+        "colors": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
         }
       }
     },
@@ -237,6 +240,9 @@
             "id": {
               "type": "integer",
               "format": "int64"
+            },
+            "name": {
+              "type": "string"
             }
           }
         }
@@ -258,4 +264,4 @@
       }
     }
   }
-}
+}

data/spec/lib/swagger_v2_blocks_spec.rb

@@ -42,7 +42,7 @@ class PetControllerV2
         key 'read:pets', 'read your pets'
       end
     end
-    tags do
+    tag do
       key :name, 'pet'
       key :description, 'Pets operations'
       externalDocs do
@@ -201,8 +201,11 @@ class PetV2
     property :name do
       key :type, :string
     end
-    property :tag do
-      key :type, :string
+    property :colors do
+      key :type, :array
+      items do
+        key :type, :string
+      end
     end
   end
 
@@ -217,6 +220,9 @@ class PetV2
           key :type, :integer
           key :format, :int64
         end
+	property :name do
+	  key :type, :string
+	end
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swagger-blocks
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.1.3
 platform: ruby
 authors:
 - Mike Fotinakis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-24 00:00:00.000000000 Z
+date: 2015-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler