apipie-rails 0.5.13 → 0.5.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7a003368791253c56f130f6ff692225f71d51736
-  data.tar.gz: b0d9ea7bba052e5afbb460c6c2c2650609afdad3
+SHA256:
+  metadata.gz: '018d734565f6849bf6c073c6774b2a99082bd6b88f15221999ae80b40c0efacc'
+  data.tar.gz: 00711a809dbdab171df9f447a3a6e7a8613cc89fa3ec7d632a036b5e2970c83d
 SHA512:
-  metadata.gz: 003c59006f91cab87c478740a851d06926fc4ee029420d054ede2d619245929f13af84ed53704a1708263b4e825ac37eb8e429f8927e7ca6e30ea05397ab6846
-  data.tar.gz: 8d3648f85b07e59313ae749397ed4ce965aed7dadd9d801f55dc1cefc296cb641e1740ba7be0141321b8347a844ea385655b58e1f75766605b536609b0c690d1
+  metadata.gz: 239806146c1a87920924fcb3ea63d8401edb21aa69b13a1f1305cdd4c2404c05f000cda9684fbdddd785b4124c0dde5540c6eaf78371e3e30172a96af6c54ac5
+  data.tar.gz: 1a58f612309c9c58c646805dabb64543257e26aa77e0132e8fc7b7d23fbe270008d449e39b00f4e89cc20b4920a044e428721df88c7427d6f114c7a3ee3b2423

data/CHANGELOG.md

@@ -1,6 +1,15 @@
  Changelog
 ===========
 
+v0.5.14
+-------
+- HTML escape validator values [\#645](https://github.com/Apipie/apipie-rails/pull/645) ([ekohl](https://github.com/ekohl))
+- Support for adding new params via `update\_api` [\#642](https://github.com/Apipie/apipie-rails/pull/642) ([iNecas](https://github.com/iNecas))
+- Allow the "null" JSON string to be used as a parameter in Apipie spec examples \(`show\_in\_doc`\) [\#641](https://github.com/Apipie/apipie-rails/pull/641) ([enrique-guillen](https://github.com/enrique-guillen))
+- Fix examples recording for specific cases  [\#640](https://github.com/Apipie/apipie-rails/pull/640) ([Marri](https://github.com/Marri))
+- Add description section to response [\#639](https://github.com/Apipie/apipie-rails/pull/639) ([X1ting](https://github.com/X1ting))
+
+
 v0.5.13
 -------
 -  Fix swagger generation if a controller's parent doesn't define a resource_description [\#637](https://github.com/Apipie/apipie-rails/pull/637) ([enrique-guillen](https://github.com/enrique-guillen))

data/Gemfile

@@ -1 +1 @@
-Gemfile.rails50
+./Gemfile.rails50

data/app/views/apipie/apipies/_method_detail.erb

@@ -40,6 +40,10 @@
   <%= heading(t('apipie.returns'), h_level) %>
   <% method[:returns].each do |item| %>
     <%= heading("#{t('apipie.code')}: #{item[:code]}", h_level + 1) %>
+    <% if item[:description] %>
+      <%= heading("#{t('apipie.description')}:", h_level + 2) %>
+      <p><%= item[:description] %></p>
+    <% end %>
     <table class='table'>
       <thead>
         <tr>

data/lib/apipie/dsl_definition.rb

@@ -498,7 +498,7 @@ module Apipie
           params_ordered = dsl_data[:params].map do |args|
             Apipie::ParamDescription.from_dsl_data(method_description, args)
           end
-          ParamDescription.unify(method_description.params_ordered_self + params_ordered)
+          ParamDescription.merge(method_description.params_ordered_self, params_ordered)
         end
       end
 

data/lib/apipie/extractor.rb

@@ -23,6 +23,7 @@ class Apipie::Railtie
       end
     else
       ActionController::TestCase.send(:prepend, Apipie::Extractor::Recorder::FunctionalTestRecording)
+      ActionController::TestCase::Behavior.send(:prepend, Apipie::Extractor::Recorder::FunctionalTestRecording)
     end
   end
 end

data/lib/apipie/extractor/recorder.rb

@@ -13,12 +13,13 @@ module Apipie
         @query = env["QUERY_STRING"] unless env["QUERY_STRING"].blank?
         @params = Rack::Utils.parse_nested_query(@query)
         @params.merge!(env["action_dispatch.request.request_parameters"] || {})
-        if data = parse_data(env["rack.input"].read)
+        rack_input = env["rack.input"]
+        if data = parse_data(rack_input.read)
           @request_data = data
-          env["rack.input"].rewind
         elsif form_hash = env["rack.request.form_hash"]
           @request_data = reformat_multipart_data(form_hash)
         end
+        rack_input.rewind
       end
 
       def analyse_controller(controller)

data/lib/apipie/param_description.rb

@@ -197,6 +197,14 @@ module Apipie
       end.sort_by { |param| ordering.index(param.name) }
     end
 
+    def self.merge(target_params, source_params)
+      params_to_merge, params_to_add = source_params.partition do |source_param|
+        target_params.any? { |target_param| source_param.name == target_param.name }
+      end
+      unify(target_params + params_to_merge)
+      target_params.concat(params_to_add)
+    end
+
     # action awareness is being inherited from ancestors (in terms of
     # nested params)
     def action_aware?

data/lib/apipie/validator.rb

@@ -57,6 +57,10 @@ module Apipie
         "TODO: validator description"
       end
 
+      def format_description_value(value)
+        "<code>#{CGI::escapeHTML(value.to_s)}</code>"
+      end
+
       def error
         ParamInvalid.new(param_name, @error_value, description)
       end
@@ -148,7 +152,7 @@ module Apipie
       end
 
       def description
-        "Must match regular expression <code>/#{@regexp.source}/</code>."
+        "Must match regular expression #{format_description_value("/#{@regexp.source}/")}."
       end
     end
 
@@ -172,7 +176,7 @@ module Apipie
       end
 
       def description
-        string = @array.map { |value| "<code>#{value}</code>" }.join(', ')
+        string = @array.map { |value| format_description_value(value) }.join(', ')
         "Must be one of: #{string}."
       end
     end
@@ -272,7 +276,8 @@ module Apipie
       end
 
       def description
-        "Must be one of: #{@array.join(', ')}."
+        string = @array.map { |value| format_description_value(value) }.join(', ')
+        "Must be one of: #{string}."
       end
     end
 
@@ -467,8 +472,8 @@ module Apipie
       end
 
       def description
-        string = %w(true false 1 0).map { |value| "<code>#{value}</code>" }.join(', ')
-        "Must be one of: #{string}"
+        string = %w(true false 1 0).map { |value| format_description_value(value) }.join(', ')
+        "Must be one of: #{string}."
       end
     end
 

data/lib/apipie/version.rb

@@ -1,3 +1,3 @@
 module Apipie
-  VERSION = '0.5.13'
+  VERSION = '0.5.14'
 end

data/spec/controllers/extended_controller_spec.rb

@@ -3,6 +3,7 @@ require "spec_helper"
 describe ExtendedController do
 
   it 'should include params from both original controller and extending concern' do
+    expect(Apipie["extended#create"].params.keys).to eq [:oauth, :user, :admin]
     user_param = Apipie["extended#create"].params[:user]
     expect(user_param.validator.params_ordered.map(&:name)).to eq [:name, :password, :from_concern]
   end

data/spec/dummy/app/controllers/extended_controller.rb

@@ -7,4 +7,8 @@ class ExtendedController < ApplicationController
   end
   def create
   end
+
+  apipie_update_params([:create]) do
+    param :admin, :boolean
+  end
 end

data/spec/lib/swagger/swagger_dsl_spec.rb

@@ -73,18 +73,28 @@ describe "Swagger Responses" do
     end
 
     def deep_match?(actual, expected, breadcrumb=[])
-      num = 0
-      for pdesc in expected do
-        if pdesc.is_a? Symbol
-          return false unless fields_match?(actual.params_ordered[num], pdesc, breadcrumb)
-        elsif pdesc.is_a? Hash
-          return false unless fields_match?(actual.params_ordered[num], pdesc.keys[0], breadcrumb)
-          return false unless deep_match?(actual.params_ordered[num].validator, pdesc.values[0], breadcrumb + [pdesc.keys[0]])
+      pending_params = actual.params_ordered.dup
+      expected.each do |expected_param|
+        expected_param_name = expected_param.is_a?(Hash) ? expected_param.keys.first : expected_param
+        actual_param = pending_params.find { |param| param.name.to_s == expected_param_name.to_s }
+        unless actual_param
+          @fail_message = "Couldn't find #{expected_param_name.inspect} among #{pending_params.map(&:name)} in #{breadcrumb.join('.')}"
+          return false
+        else
+          pending_params.delete_if { |p| p.object_id ==  actual_param.object_id }
         end
-        num+=1
+
+        return false unless fields_match?(actual_param, expected_param_name, breadcrumb)
+        if expected_param.is_a? Hash
+          return false unless deep_match?(actual_param.validator, expected_param.values[0], breadcrumb + [expected_param.keys.first])
+        end
+      end
+
+      unless pending_params.empty?
+        @fail_message = "Unexpected properties #{pending_params.map(&:name)} in #{breadcrumb.join('.')}"
+        return false
       end
-      @fail_message = "expected property count#{breadcrumb == [] ? '' : ' of ' + (breadcrumb).join('.')} (#{actual.params_ordered.count}) to be #{num}"
-      actual.params_ordered.count == num
+      true
     end
 
     def fields_match?(param, expected_name, breadcrumb)

data/spec/lib/validator_spec.rb

@@ -50,6 +50,23 @@ describe Apipie::Validator do
     end
   end
 
+  describe 'BooleanValidator' do
+    it "should validate by object class" do
+      validator = Apipie::Validator::BooleanValidator.new(params_desc)
+      expect(validator.validate("1")).to be_truthy
+      expect(validator.validate(1)).to be_truthy
+      expect(validator.validate(true)).to be_truthy
+      expect(validator.validate(0)).to be_truthy
+      expect(validator.validate(false)).to be_truthy
+      expect(validator.validate({ 1 => 1 })).to be_falsey
+    end
+
+    it "should have a valid description" do
+      validator = Apipie::Validator::BooleanValidator.new(params_desc)
+      expect(validator.description).to eq('Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.')
+    end
+  end
+
   describe 'ArrayClassValidator' do
     it "should validate by object class" do
       validator = Apipie::Validator::ArrayClassValidator.new(params_desc, [Fixnum, String])
@@ -57,5 +74,40 @@ describe Apipie::Validator do
       expect(validator.validate(1)).to be_truthy
       expect(validator.validate({ 1 => 1 })).to be_falsey
     end
+
+    it "should have a valid description" do
+      validator = Apipie::Validator::ArrayClassValidator.new(params_desc, [Float, String])
+      expect(validator.description).to eq('Must be one of: <code>Float</code>, <code>String</code>.')
+    end
+  end
+
+  describe 'RegexpValidator' do
+    it "should validate by object class" do
+      validator = Apipie::Validator::RegexpValidator.new(params_desc, /^valid( extra)*$/)
+      expect(validator.validate("valid")).to be_truthy
+      expect(validator.validate("valid extra")).to be_truthy
+      expect(validator.validate("valid extra extra")).to be_truthy
+      expect(validator.validate("invalid")).to be_falsey
+    end
+
+    it "should have a valid description" do
+      validator = Apipie::Validator::RegexpValidator.new(params_desc, /^valid( extra)*$/)
+      expect(validator.description).to eq('Must match regular expression <code>/^valid( extra)*$/</code>.')
+    end
+  end
+
+  describe 'EnumValidator' do
+    it "should validate by object class" do
+      validator = Apipie::Validator::EnumValidator.new(params_desc, ['first', 'second & third'])
+      expect(validator.validate("first")).to be_truthy
+      expect(validator.validate("second & third")).to be_truthy
+      expect(validator.validate(1)).to be_falsey
+      expect(validator.validate({ 1 => 1 })).to be_falsey
+    end
+
+    it "should have a valid description" do
+      validator = Apipie::Validator::EnumValidator.new(params_desc, ['first', 'second & third'])
+      expect(validator.description).to eq('Must be one of: <code>first</code>, <code>second &amp; third</code>.')
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apipie-rails
 version: !ruby/object:Gem::Version
-  version: 0.5.13
+  version: 0.5.14
 platform: ruby
 authors:
 - Pavel Pokorny
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-19 00:00:00.000000000 Z
+date: 2018-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -331,7 +331,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Rails REST API documentation tool