apipie-rails 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94b525fc29d73244428ef1e25397219f80e703701497ad82c507e9fe0c321300
-  data.tar.gz: 7ba3ffeceb46eb8115d1733820e87bef5a1c1be64bc19a5225c20eae430a476c
+  metadata.gz: 29292cefe596185a3becf01f657a1c8826ea2aa5601e5549926672d1ebaf9309
+  data.tar.gz: 8c1419363f237e7cb8beb61940af1303bdef53a8830e0347f9afbca29d99e32f
 SHA512:
-  metadata.gz: 6eab6988a8d9bebb72a66096e2dbe22f04f83ab5e25070e1cb2b6176c13153b23e3499829af1f378ece9d07abfad18756ce845632ecf9711b6108fab1b8335a4
-  data.tar.gz: 8efcdcbf133414f77cb1cf9c15f34162ad395d42117275b74a68c9b4848723174dc4d79cf1b4c6739fe775324aa94da6d16b38f5fd62b33e0577539483fe8ea4
+  metadata.gz: 87f52d7d548463ec69639b85c7cb9b322b29f711fdd38800365f13bc8963a8a461f840ac8f36300e18236212b088298d90d482a0537d58b857eecbd2b479bdc5
+  data.tar.gz: 895cb9c91976d485ab1442f42895114e15c102cccc8d3b853ea6242de360f7756c5337faa086e4df7b5536079285ab83d259ce21b292c0da7fe766decdaddb32

data/.github/workflows/build.yml

@@ -21,16 +21,23 @@ jobs:
           - '3.0'
           - 3.1
         gemfile:
-          - Gemfile.rails42
+          - Gemfile.rails50
+          - Gemfile.rails51
           - Gemfile.rails52 # Min ruby 2.2.2
           - Gemfile.rails60 # Min ruby 2.5.0
           - Gemfile.rails61 # Min ruby 2.5.0
         exclude:
-        - gemfile: Gemfile.rails42
+        - gemfile: Gemfile.rails50
           ruby: 2.7
-        - gemfile: Gemfile.rails42
+        - gemfile: Gemfile.rails50
           ruby: '3.0'
-        - gemfile: Gemfile.rails42
+        - gemfile: Gemfile.rails50
+          ruby: 3.1
+        - gemfile: Gemfile.rails51
+          ruby: 2.7
+        - gemfile: Gemfile.rails51
+          ruby: '3.0'
+        - gemfile: Gemfile.rails51
           ruby: 3.1
         - gemfile: Gemfile.rails52
           ruby: 2.7

data/CHANGELOG.md

@@ -1,6 +1,13 @@
  Changelog
 ===========
 
+## [v0.7.0](https://github.com/Apipie/apipie-rails/tree/v0.7.0) (2022-03-30)
+[Full Changelog](https://github.com/Apipie/apipie-rails/compare/v0.6.0...v0.7.0)
+* ArgumentError (invalid byte sequence in UTF-8) [#746](https://github.com/Apipie/apipie-rails/pull/746) (David Milanese)
+* Fix allow_blank does not work [#733](https://github.com/Apipie/apipie-rails/pull/733) (CHEN Song)
+* Fix schema generation for param descriptions using the array validator in option [#732](https://github.com/Apipie/apipie-rails/pull/732) (Frank Hock)
+* Remove support for Rails 4 and Ruby <= 2.5 [#747](https://github.com/Apipie/apipie-rails/pull/747) (Mathieu Jobin)
+
 ## [v0.6.0](https://github.com/Apipie/apipie-rails/tree/v0.6.0) (2022-03-29)
 [Full Changelog](https://github.com/Apipie/apipie-rails/compare/v0.5.20...v0.6.0)
 * Ruby 3.0 fixes [#716](https://github.com/Apipie/apipie-rails/pull/716) (hank-spokeo)

data/Gemfile

@@ -1 +1 @@
-Gemfile.rails61
+./Gemfile.rails61

data/apipie-rails.gemspec

@@ -10,14 +10,14 @@ Gem::Specification.new do |s|
   s.homepage    = "http://github.com/Apipie/apipie-rails"
   s.summary     = %q{Rails REST API documentation tool}
   s.description = %q{Rails REST API documentation tool}
-  s.required_ruby_version = '>= 2.0.0'
+  s.required_ruby_version = '>= 2.6.0'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.require_paths = ["lib"]
 
-  s.add_dependency "actionpack", ">= 4.1"
-  s.add_dependency "activesupport", ">= 4.1"
+  s.add_dependency "actionpack", ">= 5.0"
+  s.add_dependency "activesupport", ">= 5.0"
   s.add_development_dependency "rspec-rails", "~> 3.0"
   s.add_development_dependency "sqlite3"
   s.add_development_dependency "minitest"

data/gemfiles/Gemfile.rails50

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+gemspec path: '..'
+
+gem 'actionpack', '~> 5.0.0'
+gem 'activesupport', '~> 5.0.0'
+gem 'mime-types', '~> 2.99.3'
+gem 'rails-controller-testing'
+
+gem 'test_engine', path: '../spec/dummy/components/test_engine', group: :test

data/gemfiles/Gemfile.rails51

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+gemspec path: '..'
+
+gem 'actionpack', '~> 5.1.0'
+gem 'activesupport', '~> 5.1.0'
+gem 'mime-types', '~> 2.99.3'
+gem 'rails-controller-testing'
+
+gem 'test_engine', path: '../spec/dummy/components/test_engine', group: :test

data/lib/apipie/param_description.rb

@@ -117,7 +117,7 @@ module Apipie
       return true if @allow_nil && value.nil?
       return true if @allow_blank && value.blank?
       value = normalized_value(value)
-      if (!@allow_nil && value.nil?) || !@validator.valid?(value)
+      if (!@allow_nil && value.nil?) || (!@allow_blank && value.blank?) || !@validator.valid?(value)
         error = @validator.error
         error = ParamError.new(error) unless error.is_a? StandardError
         raise error

data/lib/apipie/static_dispatcher.rb

@@ -9,7 +9,9 @@ module Apipie
 
     def match?(path)
       # Replace all null bytes
-      path = ::Rack::Utils.unescape(path || '').gsub(/\x0/, '')
+      path = ::Rack::Utils.unescape(path || '')
+                          .encode(Encoding::UTF_8, invalid: :replace, replace: '')
+                          .gsub(/\x0/, '')
 
       full_path = path.empty? ? @root : File.join(@root, path)
       paths = "#{full_path}#{ext}"

data/lib/apipie/swagger_generator.rb

@@ -476,6 +476,9 @@ module Apipie
 
       if swagger_def[:type] == "array"
         swagger_def[:items] = {type: "string"}
+        enum = param_desc.options.fetch(:in, [])
+
+        swagger_def[:items][:enum] = enum if enum.any?
       end
 
       if swagger_def[:type] == "enum"
@@ -504,7 +507,8 @@ module Apipie
       end
 
       if !in_schema
-        swagger_def[:in] = param_desc.options.fetch(:in, @default_value_for_param_in)
+        # the "name" and "in" keys can only be set on root parameters (non-nested)
+        swagger_def[:in] = @default_value_for_param_in if name.present?
         swagger_def[:required] = param_desc.required if param_desc.required
       end
 

data/lib/apipie/version.rb

@@ -1,3 +1,3 @@
 module Apipie
-  VERSION = "0.6.0"
+  VERSION = "0.7.0"
 end

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

@@ -274,6 +274,12 @@ class UsersController < ApplicationController
     render :plain => 'nothing to see here'
   end
 
+  api :GET, '/users/in_departments', 'show users from specific departments'
+  param :departments, Array, in: ["finance", "operations", "sales", "marketing", "HR"], default_value: ['sales']
+  def get_in_departments
+    render :plain => 'nothing to see here'
+  end
+
   api :GET, '/users/desc_from_file', 'desc from file'
   document 'users/desc_from_file.md'
   def desc_from_file

data/spec/lib/file_handler_spec.rb

@@ -14,5 +14,12 @@ describe Apipie::FileHandler do
       it { expect(file_handler.match? path).to be_falsy }
       it { expect { file_handler.match? path }.to_not raise_error }
     end
+
+    context 'when the path contans an invalid byte sequence in UTF-8' do
+      let(:path) { "%B6" }
+
+      it { expect(file_handler.match? path).to be_falsy }
+      it { expect { file_handler.match? path }.to_not raise_error }
+    end
   end
 end

data/spec/lib/swagger/rake_swagger_spec.rb

@@ -51,6 +51,17 @@ describe 'rake tasks' do
       expect(param[field]).to eq(value)
     end
 
+    def expect_array_param_def(http_method, path, param_name, value)
+      params = apidoc_swagger["paths"][path][http_method]["parameters"]
+      param = params.select { |p| p if p["name"] == param_name }[0]
+
+      expect(param['type']).to eq('array')
+      expect(param['items']).to eq(
+        'type' => 'string',
+        'enum' => value
+      )
+    end
+
     def expect_tags_def(http_method, path, value)
       params = apidoc_swagger["paths"][path][http_method]["tags"]
       expect(params).to eq(value)
@@ -119,6 +130,10 @@ describe 'rake tasks' do
         expect_param_def("get", "/users/by_department", "department", "enum",
                          ["finance", "operations", "sales", "marketing", "HR"])
 
+        expect_param_def("get", "/users/in_departments", "departments", "in", "query")
+        expect_array_param_def("get", "/users/in_departments", "departments",
+                         ["finance", "operations", "sales", "marketing", "HR"])
+
         expect_tags_def("get", "/twitter_example/{id}/followers", %w[twitter_example following index search])
 
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apipie-rails
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Pavel Pokorny
@@ -17,28 +17,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -211,8 +211,8 @@ files:
 - config/locales/tr.yml
 - config/locales/zh-CN.yml
 - config/locales/zh-TW.yml
-- gemfiles/Gemfile.rails42
-- gemfiles/Gemfile.rails42.lock
+- gemfiles/Gemfile.rails50
+- gemfiles/Gemfile.rails51
 - gemfiles/Gemfile.rails52
 - gemfiles/Gemfile.rails60
 - gemfiles/Gemfile.rails61
@@ -350,14 +350,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.0.9
 signing_key: 
 specification_version: 4
 summary: Rails REST API documentation tool

data/gemfiles/Gemfile.rails42

@@ -1,15 +0,0 @@
-source "https://rubygems.org"
-
-gemspec path: '..'
-
-gem 'actionpack', '~> 4.2.5'
-gem 'activesupport', '~> 4.2.5'
-gem 'mime-types', '~> 2.99.3'
-gem 'sqlite3', '~> 1.3.6'
-
-if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.1.0')
-  gem 'nokogiri', '~> 1.6.8'
-  gem 'rdoc', '~> 4.2.2'
-end
-
-gem 'test_engine', path: '../spec/dummy/components/test_engine', group: :test

data/gemfiles/Gemfile.rails42.lock

@@ -1,122 +0,0 @@
-PATH
-  remote: ../spec/dummy/components/test_engine
-  specs:
-    test_engine (0.0.1)
-
-PATH
-  remote: ..
-  specs:
-    apipie-rails (0.5.20)
-      actionpack (>= 4.1)
-      activesupport (>= 4.1)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    RedCloth (4.3.2)
-    actionpack (4.2.11.3)
-      actionview (= 4.2.11.3)
-      activesupport (= 4.2.11.3)
-      rack (~> 1.6)
-      rack-test (~> 0.6.2)
-      rails-dom-testing (~> 1.0, >= 1.0.5)
-      rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (4.2.11.3)
-      activesupport (= 4.2.11.3)
-      builder (~> 3.1)
-      erubis (~> 2.7.0)
-      rails-dom-testing (~> 1.0, >= 1.0.5)
-      rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    activesupport (4.2.11.3)
-      i18n (~> 0.7)
-      minitest (~> 5.1)
-      thread_safe (~> 0.3, >= 0.3.4)
-      tzinfo (~> 1.1)
-    addressable (2.8.0)
-      public_suffix (>= 2.0.2, < 5.0)
-    builder (3.2.4)
-    concurrent-ruby (1.1.10)
-    crass (1.0.6)
-    diff-lcs (1.5.0)
-    erubis (2.7.0)
-    i18n (0.9.5)
-      concurrent-ruby (~> 1.0)
-    json-schema (2.8.1)
-      addressable (>= 2.4)
-    loofah (2.15.0)
-      crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
-    maruku (0.7.3)
-    mime-types (2.99.3)
-    mini_portile2 (2.8.0)
-    minitest (5.15.0)
-    nokogiri (1.13.3)
-      mini_portile2 (~> 2.8.0)
-      racc (~> 1.4)
-    psych (4.0.3)
-      stringio
-    public_suffix (4.0.6)
-    racc (1.6.0)
-    rack (1.6.13)
-    rack-test (0.6.3)
-      rack (>= 1.0)
-    rails-deprecated_sanitizer (1.0.4)
-      activesupport (>= 4.2.0.alpha)
-    rails-dom-testing (1.0.9)
-      activesupport (>= 4.2.0, < 5.0)
-      nokogiri (~> 1.6)
-      rails-deprecated_sanitizer (>= 1.0.1)
-    rails-html-sanitizer (1.4.2)
-      loofah (~> 2.3)
-    railties (4.2.11.3)
-      actionpack (= 4.2.11.3)
-      activesupport (= 4.2.11.3)
-      rake (>= 0.8.7)
-      thor (>= 0.18.1, < 2.0)
-    rake (13.0.6)
-    rdoc (6.4.0)
-      psych (>= 4.0.0)
-    rspec-core (3.9.3)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.4)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-rails (3.9.1)
-      actionpack (>= 3.0)
-      activesupport (>= 3.0)
-      railties (>= 3.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.4)
-    sqlite3 (1.3.13)
-    stringio (3.0.1)
-    thor (1.2.1)
-    thread_safe (0.3.6)
-    tzinfo (1.2.9)
-      thread_safe (~> 0.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  RedCloth
-  actionpack (~> 4.2.5)
-  activesupport (~> 4.2.5)
-  apipie-rails!
-  json-schema (~> 2.8)
-  maruku
-  mime-types (~> 2.99.3)
-  minitest
-  rake
-  rdoc
-  rspec-rails (~> 3.0)
-  sqlite3 (~> 1.3.6)
-  test_engine!
-
-BUNDLED WITH
-   1.17.3