swagger-docs 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 979bda39f8d785e5d599ae56058247e02b9c8335
-  data.tar.gz: d2e4e3cc8356e686e72376012249ca2ee1c00375
+  metadata.gz: c9fdc3f4f644a149fff976af8f32e4a084749d95
+  data.tar.gz: ec345458634e9e25fee45ace966b271d1d8bd273
 SHA512:
-  metadata.gz: f409fe0f7a4b448fbfe63c276c1ecb8faf5d9242e3f06d4864950c1df97a497542dc153c8a1b4b8c630d7d499e4040dae7ae58a45f89e6f0a7febea327a0062b
-  data.tar.gz: 7b6ec4109fea5d965160218f77a89b3630bc89987660556c703bb9cb2419c82263c87d076d2cb1d57a424515ae4f7d334cf88d59ebe7c68e5efd72e9ff1122d1
+  metadata.gz: 45bb296a5aa61b7b7ecae8eb1706da6483bb7febe4b189f36490203e39732ffc2e0f54271298aec7d1a0d0615eeedc808fa599ce5ff7bab1ba8ed2afb92911c6
+  data.tar.gz: 566577465f61ef479399c9ef270f5762905e4b9f173ce2d11d1111a3162ace73621b78b6b39fc489dca7793e7bbb47e301bafb65cf823a3b346d4302f8fe8ded

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.2.1
+
+- Add support for Authorizations (OAuth 2.0) - Thanks to @RKushnir #97
+
 ## 0.2.0
 
 - Additional logging for generation failures (suggested in #81)

data/README.md

@@ -10,6 +10,11 @@ Generates swagger-ui json files for rails apps with APIs. You add the swagger DS
 [gemnasium]: https://gemnasium.com/richhollis/swagger-docs
 [coveralls]: https://coveralls.io/r/richhollis/swagger-docs
 
+## Swagger Version Specification Support
+
+This project supports elements of the v1.2 swagger specification. It *does not* support the v2 specification. If you are looking for support for the newer specification the please see the [swagger-blocks](https://github.com/fotinakis/swagger-blocks/) project. I don't currently have any plans to add support for v2.0 at this time.
+
+## Example usage
 
 Here is an extract of the DSL from a user controller API class:
 

data/lib/swagger/docs/api_declaration_file.rb

@@ -52,6 +52,10 @@ module Swagger
         normalize_model_properties @models
       end
 
+      def authorizations
+        metadata.authorizations
+      end
+
       private
 
       def build_resource_root_hash
@@ -61,7 +65,8 @@ module Swagger
           "basePath" => base_path,
           "resourcePath" => resource_path,
           "apis" => apis,
-          "resourceFilePath" => resource_file_path
+          "resourceFilePath" => resource_file_path,
+          "authorizations"   => authorizations
         }
       end
 

data/lib/swagger/docs/api_declaration_file_metadata.rb

@@ -3,7 +3,7 @@ module Swagger
     class ApiDeclarationFileMetadata
       DEFAULT_SWAGGER_VERSION = "1.2"
 
-      attr_reader :api_version, :path, :base_path, :controller_base_path, :swagger_version, :camelize_model_properties
+      attr_reader :api_version, :path, :base_path, :controller_base_path, :swagger_version, :camelize_model_properties, :authorizations
 
       def initialize(api_version, path, base_path, controller_base_path, options={})
         @api_version = api_version
@@ -12,6 +12,7 @@ module Swagger
         @controller_base_path = controller_base_path
         @swagger_version = options.fetch(:swagger_version, DEFAULT_SWAGGER_VERSION)
         @camelize_model_properties = options.fetch(:camelize_model_properties, true)
+        @authorizations = options.fetch(:authorizations, {})
       end
     end
   end

data/lib/swagger/docs/generator.rb

@@ -61,7 +61,13 @@ module Swagger
         end
 
         def generate_doc(api_version, settings, config)
-          root = { "apiVersion" => api_version, "swaggerVersion" => "1.2", "basePath" => settings[:base_path], :apis => [] }
+          root = { 
+            "apiVersion" => api_version, 
+            "swaggerVersion" => "1.2", 
+            "basePath" => settings[:base_path], 
+            :apis => [],
+            :authorizations => settings[:authorizations]
+          }
           results = {:processed => [], :skipped => []}
           resources = []
 
@@ -159,10 +165,13 @@ module Swagger
         end
 
         def generate_resource(path, apis, models, settings, root, config)
-          metadata = ApiDeclarationFileMetadata.new(root["apiVersion"], path, root["basePath"],
-                                                   settings[:controller_base_path],
-                                                   camelize_model_properties: config.fetch(:camelize_model_properties, true),
-                                                   swagger_version: root["swaggerVersion"])
+          metadata = ApiDeclarationFileMetadata.new(
+            root["apiVersion"], path, root["basePath"],
+            settings[:controller_base_path],
+            camelize_model_properties: config.fetch(:camelize_model_properties, true),
+            swagger_version: root["swaggerVersion"],
+            authorizations: root[:authorizations]
+          )
           declaration = ApiDeclarationFile.new(metadata, apis, models)
           declaration.generate_resource
         end
@@ -210,10 +219,12 @@ module Swagger
           controller_base_path = trim_leading_slash(config[:controller_base_path] || "")
           base_path += "/#{controller_base_path}" unless controller_base_path.empty?
           api_file_path = config[:api_file_path]
+          authorizations = config[:authorizations]
           settings = {
             base_path: base_path,
             controller_base_path: controller_base_path,
-            api_file_path: api_file_path
+            api_file_path: api_file_path,
+            authorizations: authorizations
           }.freeze
         end
 

data/lib/swagger/docs/version.rb

@@ -1,5 +1,5 @@
 module Swagger
   module Docs
-    VERSION = "0.2.0"
+    VERSION = "0.2.1"
   end
 end

data/spec/lib/swagger/docs/api_declaration_file_metadata_spec.rb

@@ -5,51 +5,44 @@ describe Swagger::Docs::ApiDeclarationFileMetadata do
   describe "#initialize" do
     it "sets the api_version property" do
       metadata = described_class.new("1.0", "path", "basePath", "controllerBasePath")
-
       expect(metadata.api_version).to eq("1.0")
     end
-
     it "sets the path property" do
       metadata = described_class.new("1.0", "path", "basePath", "controllerBasePath")
-
       expect(metadata.path).to eq("path")
     end
-
     it "sets the base_path property" do
       metadata = described_class.new("1.0", "path", "basePath", "controllerBasePath")
-
       expect(metadata.base_path).to eq("basePath")
     end
-
     it "sets the controller_base_path property" do
       metadata = described_class.new("1.0", "path", "basePath", "controllerBasePath")
-
       expect(metadata.controller_base_path).to eq("controllerBasePath")
     end
-
     it "defaults the swagger_version property to DEFAULT_SWAGGER_VERSION" do
       metadata = described_class.new("1.0", "path", "basePath", "controllerBasePath")
-
       expect(metadata.swagger_version).to eq(described_class::DEFAULT_SWAGGER_VERSION)
     end
-
     it "allows the swagger_version property to be_overriden" do
       metadata = described_class.new("1.0", "path", "basePath", "controllerBasePath", swagger_version: "2.0")
-
       expect(metadata.swagger_version).to eq("2.0")
     end
-
-
     it "defaults the camelize_model_properties property to true" do
       metadata = described_class.new("1.0", "path", "basePath", "controllerBasePath")
-
       expect(metadata.camelize_model_properties).to eq(true)
     end
-
     it "allows the camelize_model_properties property to be overidden" do
       metadata = described_class.new("1.0", "path", "basePath", "controllerBasePath", camelize_model_properties: false)
-
       expect(metadata.camelize_model_properties).to eq(false)
     end
+    it "defaults the authorizations property to empty hash" do
+     metadata = described_class.new("1.0", "path", "basePath", "controllerBasePath")
+     expect(metadata.authorizations).to eq({})
+    end
+    it "allows the authorizations property to be overidden" do
+     authorizations = {foo: 'bar'}
+     metadata = described_class.new("1.0", "path", "basePath", "controllerBasePath", authorizations: authorizations)
+     expect(metadata.authorizations).to eq(authorizations)
+    end
   end
 end

data/spec/lib/swagger/docs/api_declaration_file_spec.rb

@@ -63,7 +63,8 @@ describe Swagger::Docs::ApiDeclarationFile do
         "apis"=> declaration.apis,
         "resourcePath"=> declaration.resource_path,
         :models=> declaration.models,
-        "resourceFilePath" => declaration.resource_file_path
+        "resourceFilePath" => declaration.resource_file_path,
+        "authorizations" => {}
       }
       expect(declaration.generate_resource).to eq(expected_response)
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: swagger-docs
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Rich Hollis