swagger_docs_generator 0.2.0 → 0.3.0.pre.18

data/spec/swagger_docs_generator/parser/parameters/param_path_spec.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe SwaggerDocsGenerator::Actions::Path, type: :parser,
+                                              name: :params_path do
+  let(:param_name) { nil }
+  let(:param_description) { nil }
+  let(:param_required) { nil }
+  let(:param_type) { nil }
+  let(:param) do
+    pname = param_name
+    pdescription = param_description
+    prequired = param_required
+    ptype = param_type
+    SwaggerDocsGenerator::Actions::Parameter.new do
+      path do
+        name pname
+        description pdescription
+        required prequired
+        type ptype
+      end
+    end
+  end
+
+  context 'when attribute complete' do
+    let(:param_name) { Faker::Color.color_name }
+    let(:param_description) { Faker::Beer.name }
+    let(:param_required) { Faker::Boolean.boolean }
+    let(:param_type) { Faker::Name.first_name }
+
+    it_behaves_like 'parameters path haves'
+  end
+
+  context 'when attribute is incomplete' do
+    it_behaves_like 'parameters path haves'
+  end
+
+  context 'when name attribute alone' do
+    let(:param_name) { Faker::Color.color_name }
+
+    it_behaves_like 'parameters path haves'
+  end
+
+  context 'when description attribute alone' do
+    let(:param_description) { Faker::Beer.name }
+
+    it_behaves_like 'parameters path haves'
+  end
+
+  context 'when required attribute alone' do
+    let(:param_required) { Faker::Boolean.boolean }
+
+    it_behaves_like 'parameters path haves'
+  end
+
+  context 'when type attribute alone' do
+    let(:param_type) { Faker::Name.first_name }
+
+    it_behaves_like 'parameters path haves'
+  end
+end

data/spec/swagger_docs_generator/parser/parameters/param_query_spec.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe SwaggerDocsGenerator::Actions::Query, type: :parser,
+                                               name: :params_query do
+  let(:param_name) { nil }
+  let(:param_description) { nil }
+  let(:param_required) { nil }
+  let(:param_type) { nil }
+  let(:param) do
+    pname = param_name
+    pdescription = param_description
+    prequired = param_required
+    ptype = param_type
+    SwaggerDocsGenerator::Actions::Parameter.new do
+      query do
+        name pname
+        description pdescription
+        required prequired
+        type ptype
+      end
+    end
+  end
+
+  context 'when attribute complete' do
+    let(:param_name) { Faker::Color.color_name }
+    let(:param_description) { Faker::Beer.name }
+    let(:param_required) { Faker::Boolean.boolean }
+    let(:param_type) { Faker::Name.first_name }
+
+    it_behaves_like 'parameters query haves'
+  end
+
+  context 'when attribute is incomplete' do
+    it_behaves_like 'parameters query haves'
+  end
+
+  context 'when name attribute alone' do
+    let(:param_name) { Faker::Color.color_name }
+
+    it_behaves_like 'parameters query haves'
+  end
+
+  context 'when description attribute alone' do
+    let(:param_description) { Faker::Beer.name }
+
+    it_behaves_like 'parameters query haves'
+  end
+
+  context 'when required attribute alone' do
+    let(:param_required) { Faker::Boolean.boolean }
+
+    it_behaves_like 'parameters query haves'
+  end
+
+  context 'when type attribute alone' do
+    let(:param_type) { Faker::Name.first_name }
+
+    it_behaves_like 'parameters query haves'
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swagger_docs_generator
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0.pre.18
 platform: ruby
 authors:
 - VAILLANT Jeremy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-21 00:00:00.000000000 Z
+date: 2017-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -253,16 +253,22 @@ files:
 - lib/swagger_docs_generator/metadata/controller.rb
 - lib/swagger_docs_generator/metadata/definition.rb
 - lib/swagger_docs_generator/metadata/info.rb
+- lib/swagger_docs_generator/metadata/jsons.rb
 - lib/swagger_docs_generator/metadata/metadata.rb
-- lib/swagger_docs_generator/metadata/path.rb
-- lib/swagger_docs_generator/metadata/tag.rb
 - lib/swagger_docs_generator/methods.rb
+- lib/swagger_docs_generator/models/active_record.rb
+- lib/swagger_docs_generator/models/mongo.rb
 - lib/swagger_docs_generator/parser/action.rb
 - lib/swagger_docs_generator/parser/actions/actions.rb
 - lib/swagger_docs_generator/parser/actions/consumes.rb
 - lib/swagger_docs_generator/parser/actions/deprecated.rb
 - lib/swagger_docs_generator/parser/actions/description.rb
 - lib/swagger_docs_generator/parser/actions/parameters.rb
+- lib/swagger_docs_generator/parser/actions/parameters/body.rb
+- lib/swagger_docs_generator/parser/actions/parameters/form.rb
+- lib/swagger_docs_generator/parser/actions/parameters/header.rb
+- lib/swagger_docs_generator/parser/actions/parameters/path.rb
+- lib/swagger_docs_generator/parser/actions/parameters/query.rb
 - lib/swagger_docs_generator/parser/actions/produces.rb
 - lib/swagger_docs_generator/parser/actions/response.rb
 - lib/swagger_docs_generator/parser/actions/schema.rb
@@ -271,8 +277,6 @@ files:
 - lib/swagger_docs_generator/parser/controller.rb
 - lib/swagger_docs_generator/parser/definition.rb
 - lib/swagger_docs_generator/parser/model.rb
-- lib/swagger_docs_generator/parser/models/active_record.rb
-- lib/swagger_docs_generator/parser/models/mongo.rb
 - lib/swagger_docs_generator/parser/parser.rb
 - lib/swagger_docs_generator/railtie.rb
 - lib/tasks/swagger.rake
@@ -280,6 +284,7 @@ files:
 - spec/support/examples/configuration.rb
 - spec/support/examples/generator.rb
 - spec/support/examples/metadata.rb
+- spec/support/examples/parameters.rb
 - spec/support/schemas/swagger.json
 - spec/swagger_docs_generator/configuration/configuration_customize_spec.rb
 - spec/swagger_docs_generator/configuration/configuration_default_spec.rb
@@ -287,8 +292,12 @@ files:
 - spec/swagger_docs_generator/gem_spec.rb
 - spec/swagger_docs_generator/generator_spec.rb
 - spec/swagger_docs_generator/metadata/configuration_spec.rb
-- spec/swagger_docs_generator/metadata/controller_spec.rb
 - spec/swagger_docs_generator/metadata/info_spec.rb
+- spec/swagger_docs_generator/parser/parameters/param_body_spec.rb
+- spec/swagger_docs_generator/parser/parameters/param_form_spec.rb
+- spec/swagger_docs_generator/parser/parameters/param_header_spec.rb
+- spec/swagger_docs_generator/parser/parameters/param_path_spec.rb
+- spec/swagger_docs_generator/parser/parameters/param_query_spec.rb
 homepage: https://github.com/Dev-Crea/swagger-docs-generator
 licenses:
 - MIT
@@ -304,9 +313,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.5

data/lib/swagger_docs_generator/metadata/path.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-module SwaggerDocsGenerator
-  # # Metadata generated
-  #
-  # Generate metadata for block paths in swagger specification
-  #
-  # @see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#pathsObject
-  class MetadataPath < MetadataController
-    def initialize
-      super
-    end
-
-    # Each controller parsed
-    def construct_swagger_file
-      hash = {}
-      controllers.each do |controller|
-        file = File.join(file_path, "#{controller.controller_name}.json")
-        hash.merge!(JSON.parse(File.read(file))['paths']) if File.exist?(file)
-      end
-      { paths: hash }
-    end
-  end
-end

data/lib/swagger_docs_generator/metadata/tag.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-module SwaggerDocsGenerator
-  # # Metadata generated
-  #
-  # Generate metadata for block tag in swagger specification
-  #
-  # @see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#tagObject
-  class MetadataTag < MetadataController
-    def initialize
-      super
-    end
-
-    # Create tag
-    def construct_swagger_file
-      array = []
-      controllers.each do |controller|
-        file = File.join(file_path, "#{controller.controller_name}.json")
-        array.push(JSON.parse(File.read(file))['tags']) if File.exist?(file)
-      end
-      { tags: array }
-    end
-  end
-end

data/spec/swagger_docs_generator/metadata/controller_spec.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-describe SwaggerDocsGenerator::MetadataController, type: :metadata,
-                                                   broken: true,
-                                                   name: :configuration do
-  let(:metadata) { SwaggerDocsGenerator::MetadataController.new }
-
-  before(:context) do
-    class ApplicationController < ::ApplicationController
-    end
-  end
-
-  it { expect(metadata.send(:class_controller)).to be_kind_of Array }
-  it { expect(metadata.send(:array_controller)).to be_kind_of Array }
-  it { expect(metadata.send(:string_controller)).to be_kind_of String }
-end