swagger_docs_generator 0.3.4 → 0.3.5.pre.31

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1d825270a25e0789b5851ef0bfa6e9c2cacdcac8
-  data.tar.gz: 8d679b4c99e83c4af41e1f54ef2a14615100e183
+  metadata.gz: 7aa2fd2dd584ba032e296ee81ca9ca2ee90359d0
+  data.tar.gz: 86a57eabc9caeca89f60ce027ba0a4c73b0b0cde
 SHA512:
-  metadata.gz: c573bf0b9f189113f3de3f2bff8be2e7c6a8fc849ffb7d7621016c9277aefdb1fe7206a3f7fc55c0d77b771d2e4b17e5c498968589b94a288a89b31fb9bad9a1
-  data.tar.gz: 4b07e3ca4a2e0d51e797fcadd89aa1ab28175b601e384ff57285cfdb4d73cece8fad3de15762617ca0a6e2b4f59d392227c69dd2049667a7db76ea7ef7f27891
+  metadata.gz: e9d9365e85dad68166b5e0bae24ca9e82f157789f06efbbec9216221b63f5341b5a6c3b36e51c42e5008faa8d0ff36174053001346fa32d5b67b1ddf6e704b8f
+  data.tar.gz: d3fa4e5e457d1cd54f327bbee5eefed8087e06d02db6225235788e6cf820a85f50e64697828e533a175c03ea33685ad4a6361e4653f728ba94bfc2cf8ed4fd6d

data/lib/swagger_docs_generator/configuration/configuration.rb

@@ -18,7 +18,7 @@ module SwaggerDocsGenerator
   # @see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md
   class Configuration
     # Accessors with default value
-    attr_accessor :swagger, :cleanning, :base_path
+    attr_accessor :swagger, :cleanning, :base_path, :compress
 
     # Accessors without default value
     attr_accessor :schemes, :consumes, :produces, :host, :external_docs,
@@ -29,6 +29,7 @@ module SwaggerDocsGenerator
       @swagger = '2.0'
       @base_path = '/'
       @cleanning = true
+      @compress = false
     end
   end
 

data/lib/swagger_docs_generator/generator.rb

@@ -26,8 +26,11 @@ module SwaggerDocsGenerator
     def generate_swagger_file
       delete_file_before
       File.open(@swagger_file, 'a+') do |file|
-        # file.puts write_in_swagger_file.to_json
-        file.puts JSON.pretty_generate write_in_swagger_file
+        file.write(if SwaggerDocsGenerator.configure.compress
+                     write_in_swagger_file.to_json
+                   else
+                     JSON.pretty_generate write_in_swagger_file
+                   end)
       end
     end
 

data/lib/swagger_docs_generator/info.rb

@@ -5,7 +5,7 @@ module SwaggerDocsGenerator
   # Name to gem
   GEM =           'swagger_docs_generator'
   # Version to gem
-  VERSION =       '0.3.4'
+  VERSION =       '0.3.5'
   # Authors contributed to gem
   AUTHORS =       ['VAILLANT Jeremy'].freeze
   # Email to ahuthors

data/lib/swagger_docs_generator/parser/actions/parameters/header.rb

@@ -7,14 +7,15 @@ module SwaggerDocsGenerator
   module Actions
     # Write parameter type :header
     class Header < Parameter
+      FIELDS = %w[description format default enum].freeze
+
       def to_hash
         {
           in:               :header,
-          name:             @name.nil? ? 'header' : @name,
-          description:      @description.nil? ? '' : @description,
+          name:             @name,
           required:         @required.nil? ? true : @required,
-          type:             @type.nil? ? '' : @type
-        }
+          type:             @type
+        }.merge(no_mandatory_field)
       end
 
       private
@@ -22,6 +23,27 @@ module SwaggerDocsGenerator
       def type(text)
         @type = text
       end
+
+      def default(text)
+        @default = text
+      end
+
+      def enum(array)
+        @enum = array
+      end
+
+      def format(text)
+        @format = text
+      end
+
+      def no_mandatory_field
+        hash = {}
+        FIELDS.each do |parameter|
+          value = instance_variable_get("@#{parameter}")
+          hash.merge!(parameter.to_sym => value) if value.present?
+        end
+        hash
+      end
     end
   end
 end

data/spec/support/examples/parameters.rb

@@ -57,21 +57,6 @@ RSpec.shared_examples 'parameters header haves' do
     let(:result) { param_type }
     include_examples 'parameter equal', :@type
   end
-
-  it do
-    name = param_name.nil? ? 'header' : param_name
-    description = param_description.nil? ? '' : param_description
-    required = param_required.nil? ? true : param_required
-    type = param_type.nil? ? '' : param_type
-
-    expect(param.to_hash).to eql(
-      in: :header,
-      name: name,
-      description: description,
-      required: required,
-      type: type
-    )
-  end
 end
 
 # Test for parameter PATH

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

@@ -8,55 +8,244 @@ describe SwaggerDocsGenerator::Actions::Header, type: :parser,
   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
-      header do
-        name pname
-        description pdescription
-        required prequired
-        type ptype
-      end
-    end
-  end
+  let(:param_default) { nil }
+  let(:param_enum) { nil }
+  let(:param_format) { nil }
 
   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 }
+    let(:param_default) { Faker::Name.first_name }
+    let(:param_format) { Faker::Name.first_name }
+    let(:param_enum) { Faker::Lorem.words(4, true) }
+
+    let(:param) do
+      pname = param_name
+      pdescription = param_description
+      prequired = param_required
+      ptype = param_type
+      pdefault = param_default
+      pformat = param_format
+      penum = param_enum
+      SwaggerDocsGenerator::Actions::Parameter.new do
+        header do
+          name pname
+          description pdescription
+          required prequired
+          type ptype
+          default pdefault
+          format pformat
+          enum penum
+        end
+      end
+    end
 
+    it do
+      expect(param.to_hash).to eql(
+        in: :header,
+        name: param_name,
+        description: param_description,
+        required: param_required,
+        type: param_type,
+        default: param_default,
+        format: param_format,
+        enum: param_enum
+      )
+    end
     it_behaves_like 'parameters header haves'
   end
 
   context 'when attribute is incomplete' do
+    let(:param) do
+      SwaggerDocsGenerator::Actions::Parameter.new do
+        header do
+        end
+      end
+    end
+
+    it do
+      expect(param.to_hash).to eql(
+        in: :header,
+        name: nil,
+        required: true,
+        type: nil
+      )
+    end
+
     it_behaves_like 'parameters header haves'
   end
 
   context 'when name attribute alone' do
     let(:param_name) { Faker::Color.color_name }
 
+    let(:param) do
+      pname = param_name
+      SwaggerDocsGenerator::Actions::Parameter.new do
+        header do
+          name pname
+        end
+      end
+    end
+
+    it do
+      expect(param.to_hash).to eql(
+        in: :header,
+        name: param_name,
+        required: true,
+        type: nil
+      )
+    end
+
     it_behaves_like 'parameters header haves'
   end
 
   context 'when description attribute alone' do
     let(:param_description) { Faker::Beer.name }
 
+    let(:param) do
+      pdescription = param_description
+      SwaggerDocsGenerator::Actions::Parameter.new do
+        header do
+          description pdescription
+        end
+      end
+    end
+
+    it do
+      expect(param.to_hash).to eql(
+        in: :header,
+        name: nil,
+        required: true,
+        type: nil,
+        description: param_description
+      )
+    end
+
     it_behaves_like 'parameters header haves'
   end
 
   context 'when required attribute alone' do
     let(:param_required) { Faker::Boolean.boolean }
 
+    let(:param) do
+      prequired = param_required
+      SwaggerDocsGenerator::Actions::Parameter.new do
+        header do
+          required prequired
+        end
+      end
+    end
+
+    it do
+      expect(param.to_hash).to eql(
+        in: :header,
+        name: nil,
+        required: param_required,
+        type: nil
+      )
+    end
+
     it_behaves_like 'parameters header haves'
   end
 
   context 'when type attribute alone' do
     let(:param_type) { Faker::Name.first_name }
 
+    let(:param) do
+      ptype = param_type
+      SwaggerDocsGenerator::Actions::Parameter.new do
+        header do
+          type ptype
+        end
+      end
+    end
+
+    it do
+      expect(param.to_hash).to eql(
+        in: :header,
+        name: nil,
+        required: true,
+        type: param_type
+      )
+    end
+
+    it_behaves_like 'parameters header haves'
+  end
+
+  context 'when default attribute alone' do
+    let(:param_default) { Faker::Name.first_name }
+
+    let(:param) do
+      pdefault = param_default
+      SwaggerDocsGenerator::Actions::Parameter.new do
+        header do
+          default pdefault
+        end
+      end
+    end
+
+    it do
+      expect(param.to_hash).to eql(
+        in: :header,
+        name: nil,
+        required: true,
+        type: nil,
+        default: param_default
+      )
+    end
+
+    it_behaves_like 'parameters header haves'
+  end
+
+  context 'when format attribute alone' do
+    let(:param_format) { Faker::Name.first_name }
+
+    let(:param) do
+      pformat = param_format
+      SwaggerDocsGenerator::Actions::Parameter.new do
+        header do
+          format pformat
+        end
+      end
+    end
+
+    it do
+      expect(param.to_hash).to eql(
+        in: :header,
+        name: nil,
+        required: true,
+        type: nil,
+        format: param_format
+      )
+    end
+
+    it_behaves_like 'parameters header haves'
+  end
+
+  context 'when default attribute alone' do
+    let(:param_enum) { Faker::Lorem.words(4, true) }
+
+    let(:param) do
+      penum = param_enum
+      SwaggerDocsGenerator::Actions::Parameter.new do
+        header do
+          enum penum
+        end
+      end
+    end
+
+    it do
+      expect(param.to_hash).to eql(
+        in: :header,
+        name: nil,
+        required: true,
+        type: nil,
+        enum: param_enum
+      )
+    end
+
     it_behaves_like 'parameters header haves'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swagger_docs_generator
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.5.pre.31
 platform: ruby
 authors:
 - VAILLANT Jeremy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-10 00:00:00.000000000 Z
+date: 2017-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -325,9 +325,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