apipie-rails 0.5.18 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 827ccd7271b49556c90c5bf516ac782ecf7fa38fa380bada85c6ec5c3ac7f5e3
-  data.tar.gz: e989cb29115cc40c0e1033b4800caef2cc9bccac43a6bffd43f0bb974bc68a5f
+  metadata.gz: 94b525fc29d73244428ef1e25397219f80e703701497ad82c507e9fe0c321300
+  data.tar.gz: 7ba3ffeceb46eb8115d1733820e87bef5a1c1be64bc19a5225c20eae430a476c
 SHA512:
-  metadata.gz: e1fae727ae94f9083a1b02984f660ff189e30aa5eee2d9792f3d233cce46472bff8a19b077c3863be167f8738016d96c421b50dbfe3c29604397eb7aa5fbb13d
-  data.tar.gz: 71df5da3fd578b00518cc2121d2a32a9c664ac681cb52d266412759c25c5a46ef49a5d40e45006ac28f6d1ce8dd1676e0b44589f6b7869e77b2b3d04f4686195
+  metadata.gz: 6eab6988a8d9bebb72a66096e2dbe22f04f83ab5e25070e1cb2b6176c13153b23e3499829af1f378ece9d07abfad18756ce845632ecf9711b6108fab1b8335a4
+  data.tar.gz: 8efcdcbf133414f77cb1cf9c15f34162ad395d42117275b74a68c9b4848723174dc4d79cf1b4c6739fe775324aa94da6d16b38f5fd62b33e0577539483fe8ea4

data/.github/workflows/build.yml

@@ -0,0 +1,50 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: build
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-20.04
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - 2.6
+          - 2.7
+          - '3.0'
+          - 3.1
+        gemfile:
+          - Gemfile.rails42
+          - 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
+          ruby: 2.7
+        - gemfile: Gemfile.rails42
+          ruby: '3.0'
+        - gemfile: Gemfile.rails42
+          ruby: 3.1
+        - gemfile: Gemfile.rails52
+          ruby: 2.7
+        - gemfile: Gemfile.rails52
+          ruby: '3.0'
+        - gemfile: Gemfile.rails52
+          ruby: 3.1
+
+    env:
+      BUNDLE_GEMFILE: ${{ github.workspace }}/gemfiles/${{ matrix.gemfile }}
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - run: bundle exec rspec

data/.gitignore

@@ -12,3 +12,4 @@ Gemfile.local
 .ruby-gemset
 
 .DS_Store
+rel-eng/.ipynb_checkpoints

data/CHANGELOG.md

@@ -1,7 +1,30 @@
  Changelog
 ===========
 
-[v0.5.17](https://github.com/Apipie/apipie-rails/tree/v0.5.18) (2020-05-20)
+## [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)
+* only depends on actionpack and activesupport [#741](https://github.com/Apipie/apipie-rails/pull/741) (Mathieu Jobin)
+* language fix, fallback to default locale [#726](https://github.com/Apipie/apipie-rails/pull/726) (Alex Coomans)
+
+## [v0.5.20](https://github.com/Apipie/apipie-rails/tree/v0.5.20) (2022-03-16)
+[Full Changelog](https://github.com/Apipie/apipie-rails/compare/v0.5.19...v0.5.20)
+* Update rel-eng (Oleh Fedorenko)
+* Deprecate travis, run tests on github actions [#740](https://github.com/Apipie/apipie-rails/pull/740) (Mathieu Jobin)
+* Update validator.rb [#739](https://github.com/Apipie/apipie-rails/pull/739) (Dmytro Budnyk)
+* Fix wrong number of arguments for recorder#process [#725](https://github.com/Apipie/apipie-rails/pull/725) (rob mathews)
+* Change "an" to "a" [#723](https://github.com/Apipie/apipie-rails/pull/723) (Naokimi)
+
+## [v0.5.19](https://github.com/Apipie/apipie-rails/tree/v0.5.19) (2021-07-25)
+[Full Changelog](https://github.com/Apipie/apipie-rails/compare/v0.5.18...v0.5.19)
+* Add rel-eng notebook (Oleh Fedorenko)
+* Correct the word parâmentros for brazilian portuguese [#687](https://github.com/Apipie/apipie-rails/pull/687) (Diego Noronha)
+* Fix depreciated file.exists. [#721](https://github.com/Apipie/apipie-rails/pull/721) (Diane Delallée)
+* Fix typo in changelog [#703](https://github.com/Apipie/apipie-rails/pull/703) (Pavel Rodionov)
+* Add rails 6.1 support in doc generation [#702](https://github.com/Apipie/apipie-rails/pull/702) (andrew-newell)
+
+
+[v0.5.18](https://github.com/Apipie/apipie-rails/tree/v0.5.18) (2020-05-20)
 --------
 
 [Full Changelog](https://github.com/Apipie/apipie-rails/compare/v0.5.17...v0.5.18)

data/Gemfile

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

data/README.rst

@@ -387,20 +387,20 @@ Example:
      end
    end
 
-   api :POST, "/users", "Create an user"
+   api :POST, "/users", "Create a user"
    param_group :user
    def create
      # ...
    end
 
-   api :PUT, "/users/:id", "Update an user"
+   api :PUT, "/users/:id", "Update a user"
    param_group :user
    def update
      # ...
    end
 
    # v2/users_controller.rb
-   api :POST, "/users", "Create an user"
+   api :POST, "/users", "Create a user"
    param_group :user, V1::UsersController
    def create
      # ...
@@ -434,7 +434,7 @@ Example
      end
    end
 
-   api :POST, "/users", "Create an user"
+   api :POST, "/users", "Create a user"
    param_group :user
    def create
      # ...
@@ -446,7 +446,7 @@ Example
      # ...
    end
 
-   api :PUT, "/users/:id", "Update an user"
+   api :PUT, "/users/:id", "Update a user"
    param_group :user
    def update
      # ...

data/apipie-rails.gemspec

@@ -16,7 +16,8 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.require_paths = ["lib"]
 
-  s.add_dependency "rails", ">= 4.1"
+  s.add_dependency "actionpack", ">= 4.1"
+  s.add_dependency "activesupport", ">= 4.1"
   s.add_development_dependency "rspec-rails", "~> 3.0"
   s.add_development_dependency "sqlite3"
   s.add_development_dependency "minitest"

data/app/controllers/apipie/apipies_controller.rb

@@ -100,7 +100,7 @@ module Apipie
       [:resource, :method, :version].each do |par|
         if params[par]
           splitted = params[par].split('.')
-          if splitted.length > 1 && Apipie.configuration.languages.include?(splitted.last)
+          if splitted.length > 1 && (Apipie.configuration.languages.include?(splitted.last) || Apipie.configuration.default_locale == splitted.last)
             lang = splitted.last
             params[par].sub!(".#{lang}", '')
           end

data/config/locales/pt-BR.yml

@@ -16,7 +16,7 @@
     optional: opcional
     nil_allowed: nulo permitido
     param_name: Nome parâmetro
-    params: Parâmentros
+    params: Parâmetros
     examples: Exemplos
     metadata: Metadado
     errors: Erros

data/{Gemfile.rails42 → gemfiles/Gemfile.rails42}

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

data/gemfiles/Gemfile.rails42.lock

@@ -0,0 +1,122 @@
+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

data/gemfiles/Gemfile.rails52

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

data/gemfiles/Gemfile.rails60

@@ -0,0 +1,17 @@
+source "https://rubygems.org"
+
+gemspec path: '..'
+
+gem 'actionpack', '~> 6.0.4'
+gem 'activesupport', '~> 6.0.4'
+gem 'mime-types', '~> 3.0'
+gem 'rails-controller-testing'
+gem 'rspec-rails', '~> 5.0'
+
+# net-smtp not included by default in Ruby 3.1
+# Will be fixed by https://github.com/mikel/mail/pull/1439
+if Gem.ruby_version >= Gem::Version.new("3.1.0")
+  gem 'net-smtp', require: false
+end
+
+gem 'test_engine', path: '../spec/dummy/components/test_engine', group: :test

data/gemfiles/Gemfile.rails61

@@ -0,0 +1,17 @@
+source "https://rubygems.org"
+
+gemspec path: '..'
+
+gem 'actionpack', '~> 6.1.5'
+gem 'activesupport', '~> 6.1.5'
+gem 'mime-types', '~> 3.0'
+gem 'rails-controller-testing'
+gem 'rspec-rails', '~> 5.0'
+
+# net-smtp not included by default in Ruby 3.1
+# Will be fixed by https://github.com/mikel/mail/pull/1439
+if Gem.ruby_version >= Gem::Version.new("3.1.0")
+  gem 'net-smtp', require: false
+end
+
+gem 'test_engine', path: '../spec/dummy/components/test_engine', group: :test

data/lib/apipie/extractor/recorder.rb

@@ -150,8 +150,8 @@ module Apipie
       end
 
       module FunctionalTestRecording
-        def process(*args) # action, parameters = nil, session = nil, flash = nil, http_method = 'GET')
-          ret = super(*args)
+        def process(*, **) # action, parameters = nil, session = nil, flash = nil, http_method = 'GET')
+          ret = super
           if Apipie.configuration.record
             Apipie::Extractor.call_recorder.analyze_functional_test(self)
             Apipie::Extractor.call_finished
@@ -160,6 +160,7 @@ module Apipie
         ensure
           Apipie::Extractor.clean_call_recorder
         end
+        ruby2_keywords :process if respond_to?(:ruby2_keywords, true)
       end
     end
   end

data/lib/apipie/validator.rb

@@ -3,7 +3,7 @@ module Apipie
 
   module Validator
 
-    # to create new validator, inherit from Apipie::Validator::Base
+    # to create new validator, inherit from Apipie::Validator::BaseValidator
     # and implement class method build and instance method validate
     class BaseValidator
 

data/lib/apipie/version.rb

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

data/lib/apipie-rails.rb

@@ -23,7 +23,3 @@ require "apipie/railtie"
 require 'apipie/extractor'
 require "apipie/version"
 require "apipie/swagger_generator"
-
-if Rails.version.start_with?("3.0")
-  warn 'Warning: apipie-rails is not going to support Rails 3.0 anymore in future versions'
-end

data/lib/tasks/apipie.rake

@@ -172,7 +172,12 @@ namespace :apipie do
     layouts_paths = [File.expand_path("../../../app/views/layouts", __FILE__)]
     layouts_paths.unshift("#{Rails.root}/app/views/layouts") if File.directory?("#{Rails.root}/app/views/layouts/apipie")
 
-    @apipie_renderer = ActionView::Base.new(base_paths + layouts_paths)
+    if ActionView::Base.respond_to?(:with_empty_template_cache) && ActionView::Base.respond_to?(:with_view_paths)
+      @apipie_renderer = ActionView::Base.with_empty_template_cache.with_view_paths(base_paths + layouts_paths)
+    else
+      @apipie_renderer = ActionView::Base.new(base_paths + layouts_paths)
+    end
+
     @apipie_renderer.singleton_class.send(:include, ApipieHelper)
     return @apipie_renderer
   end
@@ -210,14 +215,14 @@ namespace :apipie do
   end
 
   def generate_json_page(file_base, doc, lang = nil)
-    FileUtils.mkdir_p(file_base) unless File.exists?(file_base)
+    FileUtils.mkdir_p(file_base) unless File.exist?(file_base)
 
     filename = "schema_apipie#{lang_ext(lang)}.json"
     File.open("#{file_base}/#{filename}", 'w') { |file| file.write(JSON.pretty_generate(doc)) }
   end
 
   def generate_swagger_json_page(file_base, doc, sfx="", lang = nil)
-    FileUtils.mkdir_p(file_base) unless File.exists?(file_base)
+    FileUtils.mkdir_p(file_base) unless File.exist?(file_base)
 
     path = Pathname.new("#{file_base}/schema_swagger#{sfx}#{lang_ext(lang)}.json")
     File.open(path, 'w') { |file| file.write(JSON.pretty_generate(doc)) }
@@ -226,21 +231,21 @@ namespace :apipie do
   end
 
   def generate_one_page(file_base, doc, lang = nil)
-    FileUtils.mkdir_p(File.dirname(file_base)) unless File.exists?(File.dirname(file_base))
+    FileUtils.mkdir_p(File.dirname(file_base)) unless File.exist?(File.dirname(file_base))
 
     render_page("#{file_base}-onepage#{lang_ext(lang)}.html", "static", {:doc => doc[:docs],
       :language => lang, :languages => Apipie.configuration.languages})
   end
 
   def generate_plain_page(file_base, doc, lang = nil)
-    FileUtils.mkdir_p(File.dirname(file_base)) unless File.exists?(File.dirname(file_base))
+    FileUtils.mkdir_p(File.dirname(file_base)) unless File.exist?(File.dirname(file_base))
 
     render_page("#{file_base}-plain#{lang_ext(lang)}.html", "plain", {:doc => doc[:docs],
       :language => lang, :languages => Apipie.configuration.languages}, nil)
   end
 
   def generate_index_page(file_base, doc, include_json = false, show_versions = false, lang = nil)
-    FileUtils.mkdir_p(File.dirname(file_base)) unless File.exists?(File.dirname(file_base))
+    FileUtils.mkdir_p(File.dirname(file_base)) unless File.exist?(File.dirname(file_base))
     versions = show_versions && Apipie.available_versions
     render_page("#{file_base}#{lang_ext(lang)}.html", "index", {:doc => doc[:docs],
       :versions => versions, :language => lang, :languages => Apipie.configuration.languages})
@@ -251,7 +256,7 @@ namespace :apipie do
   def generate_resource_pages(version, file_base, doc, include_json = false, lang = nil)
     doc[:docs][:resources].each do |resource_name, _|
       resource_file_base = File.join(file_base, resource_name.to_s)
-      FileUtils.mkdir_p(File.dirname(resource_file_base)) unless File.exists?(File.dirname(resource_file_base))
+      FileUtils.mkdir_p(File.dirname(resource_file_base)) unless File.exist?(File.dirname(resource_file_base))
 
       doc = Apipie.to_json(version, resource_name, nil, lang)
       doc[:docs][:link_extension] = (lang ? ".#{lang}.html" : ".html")
@@ -265,7 +270,7 @@ namespace :apipie do
     doc[:docs][:resources].each do |resource_name, resource_params|
       resource_params[:methods].each do |method|
         method_file_base = File.join(file_base, resource_name.to_s, method[:name].to_s)
-        FileUtils.mkdir_p(File.dirname(method_file_base)) unless File.exists?(File.dirname(method_file_base))
+        FileUtils.mkdir_p(File.dirname(method_file_base)) unless File.exist?(File.dirname(method_file_base))
 
         doc = Apipie.to_json(version, resource_name, method[:name], lang)
         doc[:docs][:link_extension] = (lang ? ".#{lang}.html" : ".html")
@@ -329,7 +334,7 @@ MESSAGE
   desc "Convert your examples from the old yaml into the new json format"
   task :convert_examples => :environment do
     yaml_examples_file = File.join(Rails.root, Apipie.configuration.doc_path, "apipie_examples.yml")
-    if File.exists?(yaml_examples_file)
+    if File.exist?(yaml_examples_file)
       #if SafeYAML gem is enabled, it will load examples as an array of Hash, instead of hash
       if defined? SafeYAML
         examples = YAML.load_file(yaml_examples_file, :safe=>false)