apipie-rails 0.5.15 → 0.5.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a05f50c6c4364f6e0c0ad119a9061f4daef9e2f5
-  data.tar.gz: 05ea27245215efd3d2e2d685fa5e82b9de0e17b8
+SHA256:
+  metadata.gz: 444b1aeccaa322d75d64131d2539ae5ecb9ceb3ea984e02c9cfd17a2c80d1190
+  data.tar.gz: ddbcdfaee3494a2f35f343a361c9e07b72541b5a75e5e537c0776f8b6c9669e9
 SHA512:
-  metadata.gz: 07198e0935b6f4c8ea51616153b29578213614de9a783a602d9edf9ebde2223652ddb1482a55a48a0bdb6582423fe4ff6c807412c4bb0529736b5c0d4f3453b4
-  data.tar.gz: a4cb3227c448f0f444e6c28972b8d1d6788f011ab3c9bdea8accbf9b41ec614393edff8aafd8c1a521f3a18f05e3eaee767da65cf0f49a2fedfac99f4e046a3a
+  metadata.gz: 18f5f97fc24bab7aa9c554cd3be305e9bf5eb5266466a79c4484fb0c7f6e4b80912d5ddb224a8ed1dd8d8002c376cd7e30a359ab4f0855d60d404352dc74acb0
+  data.tar.gz: 1c66c6990ab997d21e727900a4a36648b76aa08357491007821c4a5f1b46b25f8e48fbb9cdeccfd26f20b1ea268c32c6698f73b040226036b0f5f72fc9447060

data/.gitignore

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

data/.travis.yml

@@ -1,27 +1,41 @@
 language: ruby
 sudo: false
+before_install: >-
+  if ruby -v | grep 'ruby 2.2'; then
+    gem install bundler -v '~> 1.17'
+  fi
 rvm:
-  - 2.1.7
-  - 2.2.3
-  - 2.3.3
-  - 2.4.3
-  - 2.5.0
+  - 2.2.10
+  - 2.3.8
+  - 2.4.5
+  - 2.5.3
+  - 2.6.5
+  - 2.7.0
 gemfile:
-  - Gemfile.rails41
   - Gemfile.rails42
-  - Gemfile.rails50 # Min ruby 2.2.2
   - Gemfile.rails51 # Min ruby 2.2.2
+  - Gemfile.rails60 # Min ruby 2.5.0
+  - Gemfile.rails61 # Min ruby 2.5.0
+
 matrix:
   exclude:
-    - rvm: 2.0.0
-      gemfile: Gemfile.rails50
-    - rvm: 2.0.0
+    - rvm: 2.5.3
+      gemfile: Gemfile.rails42
+    - rvm: 2.6.5
+      gemfile: Gemfile.rails42
+    - rvm: 2.7.0
+      gemfile: Gemfile.rails42
+    - rvm: 2.7.0
       gemfile: Gemfile.rails51
-    - rvm: 2.1.7
-      gemfile: Gemfile.rails50
-    - rvm: 2.1.7
-      gemfile: Gemfile.rails51
-    - rvm: 2.4.3
-      gemfile: Gemfile.rails41
-    - rvm: 2.5.0
-      gemfile: Gemfile.rails41
+    - rvm: 2.2.10
+      gemfile: Gemfile.rails60
+    - rvm: 2.3.8
+      gemfile: Gemfile.rails60
+    - rvm: 2.4.5
+      gemfile: Gemfile.rails60
+    - rvm: 2.2.10
+      gemfile: Gemfile.rails61
+    - rvm: 2.3.8
+      gemfile: Gemfile.rails61
+    - rvm: 2.4.5
+      gemfile: Gemfile.rails61

data/CHANGELOG.md

@@ -1,5 +1,34 @@
  Changelog
 ===========
+## [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)
+
+- Optional rdoc dependency with lazyload [\#683](https://github.com/Apipie/apipie-rails/pull/683) ([vkrizan](https://github.com/vkrizan))
+
+[v0.5.17](https://github.com/Apipie/apipie-rails/tree/v0.5.17) (2020-01-20)
+--------
+
+[Full Changelog](https://github.com/Apipie/apipie-rails/compare/v0.5.16...v0.5.17)
+
+- Allows update metadata for methods [\#667](https://github.com/Apipie/apipie-rails/pull/667) ([speckins](https://github.com/speckins))
+
+[v0.5.16](https://github.com/Apipie/apipie-rails/tree/v0.5.16) (2019-05-22)
+--------
+
+[Full Changelog](https://github.com/Apipie/apipie-rails/compare/v0.5.15...v0.5.16)
+
+- Load file directly instead of using Rails constant [\#665](https://github.com/Apipie/apipie-rails/pull/665) ([speckins](https://github.com/speckins))
 
 [v0.5.15](https://github.com/Apipie/apipie-rails/tree/v0.5.15) (2019-01-03)
 --------
@@ -201,7 +230,7 @@ v0.3.2
 v0.3.1
 ------
 
-* Support for ``api!`` keyword in concerns 
+* Support for ``api!`` keyword in concerns
   [#322](https://github.com/Apipie/apipie-rails/pull/322) [@iNecas][]
 * More explicit ordering of the static dispatcher middleware
   [#315](https://github.com/Apipie/apipie-rails/pull/315) [@iNecas][]

data/Gemfile

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

data/Gemfile.rails41

@@ -4,3 +4,4 @@ gemspec
 
 gem 'rails', '~> 4.1.0'
 gem 'mime-types', '~> 2.99.3'
+gem 'test_engine', path: 'spec/dummy/components/test_engine', group: :test

data/Gemfile.rails42

@@ -4,8 +4,11 @@ gemspec
 
 gem 'rails', '~> 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/Gemfile.rails50

@@ -6,3 +6,4 @@ gem 'rails', '~> 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/Gemfile.rails51

@@ -5,3 +5,5 @@ gemspec
 gem 'rails', '~> 5.1.0.rc1'
 gem 'mime-types', '~> 2.99.3'
 gem 'rails-controller-testing'
+
+gem 'test_engine', path: 'spec/dummy/components/test_engine', group: :test

data/Gemfile.rails60

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

data/Gemfile.rails61

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

data/README.rst

@@ -45,7 +45,7 @@ Now you can start documenting your resources and actions (see
 .. code:: ruby
 
    api :GET, '/users/:id'
-   param :id, :number
+   param :id, :number, desc: 'id of the requested user'
    def show
      # ...
    end
@@ -1237,10 +1237,15 @@ override parameters described on the resource level.
      #...
    end
 
-ArrayValidator
---------------
+NumberValidator
+---------------
 
-Check if the parameter is an array
+Check if the parameter is a positive integer number or zero
+
+.. code:: ruby
+
+  param :product_id, :number, :desc => "Identifier of the product", :required => true
+  param :quantity, :number, :desc => "Number of products to order", :required => true
 
 DecimalValidator
 --------------
@@ -1252,6 +1257,10 @@ Check if the parameter is a decimal number
   param :latitude, :decimal, :desc => "Geographic latitude", :required => true
   param :longitude, :decimal, :desc => "Geographic longitude", :required => true
 
+ArrayValidator
+--------------
+
+Check if the parameter is an array
 
 Additional options
 ~~~~~~~~~~~~~~~~~

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/lib/apipie-rails.rb

@@ -2,6 +2,8 @@ require 'i18n'
 require 'json'
 require 'active_support/hash_with_indifferent_access'
 
+require 'apipie/core_ext/route.rb'
+
 require "apipie/routing"
 require "apipie/markup"
 require "apipie/apipie_module"

data/lib/apipie/application.rb

@@ -29,7 +29,7 @@ module Apipie
       @controller_to_resource_id[controller] = resource_id
     end
 
-    def rails_routes(route_set = nil)
+    def rails_routes(route_set = nil, base_url = "")
       if route_set.nil? && @rails_routes
         return @rails_routes
       end
@@ -40,10 +40,13 @@ module Apipie
       flatten_routes = []
 
       route_set.routes.each do |route|
-        if route.app.respond_to?(:routes) && route.app.routes.is_a?(ActionDispatch::Routing::RouteSet)
-          # recursively go though the moutned engines
-          flatten_routes.concat(rails_routes(route.app.routes))
+        # This is a hack to workaround a bug in apipie with Rails 4.2.5.1 or newer. See https://github.com/Apipie/apipie-rails/issues/415
+        route_app = Rails::VERSION::STRING.to_f >= 4.2 ? route.app.app : route.app
+        if route_app.respond_to?(:routes) && route_app.routes.is_a?(ActionDispatch::Routing::RouteSet)
+          # recursively go though the mounted engines
+          flatten_routes.concat(rails_routes(route_app.routes, File.join(base_url, route.path.spec.to_s)))
         else
+          route.base_url = base_url
           flatten_routes << route
         end
       end
@@ -434,8 +437,7 @@ module Apipie
     end
 
     def load_controller_from_file(controller_file)
-      controller_class_name = controller_file.gsub(/\A.*\/app\/controllers\//,"").gsub(/\.\w*\Z/,"").camelize
-      controller_class_name.constantize
+      require_dependency controller_file
     end
 
     def ignored?(controller, method = nil)

data/lib/apipie/core_ext/route.rb

@@ -0,0 +1,9 @@
+module Apipie
+  module BaseUrlExtension
+    attr_accessor :base_url
+  end
+end
+
+class ActionDispatch::Journey::Route
+  include Apipie::BaseUrlExtension
+end

data/lib/apipie/dsl_definition.rb

@@ -488,19 +488,33 @@ module Apipie
       #         param_names.each { |p| param p, String }
       #       end
       #      end
-      def apipie_update_params(methods, *args, &block)
+      def _apipie_update_params(method_desc, dsl_data)
+        params_ordered = dsl_data[:params].map do |args|
+          Apipie::ParamDescription.from_dsl_data(method_desc, args)
+        end
+        ParamDescription.merge(method_desc.params_ordered_self, params_ordered)
+      end
+
+      def _apipie_update_meta(method_desc, dsl_data)
+        return unless dsl_data[:meta] && dsl_data[:meta].is_a?(Hash)
+
+        method_desc.metadata ||= {}
+        method_desc.metadata.merge!(dsl_data[:meta])
+      end
+
+      def apipie_update_methods(methods, *args, &block)
         methods.each do |method|
-          method_description = Apipie.get_method_description(self, method)
-          unless method_description
+          method_desc = Apipie.get_method_description(self, method)
+          unless method_desc
             raise "Could not find method description for #{self}##{method}. Was the method defined?"
           end
           dsl_data = _apipie_eval_dsl(*args, &block)
-          params_ordered = dsl_data[:params].map do |args|
-            Apipie::ParamDescription.from_dsl_data(method_description, args)
-          end
-          ParamDescription.merge(method_description.params_ordered_self, params_ordered)
+          _apipie_update_params(method_desc, dsl_data)
+          _apipie_update_meta(method_desc, dsl_data)
         end
       end
+      # backwards compatibility
+      alias_method :apipie_update_params, :apipie_update_methods
 
       def _apipie_concern_subst
         @_apipie_concern_subst ||= {:controller_path => self.controller_path,
@@ -550,7 +564,7 @@ module Apipie
           controller._apipie_define_validators(description)
         end
         _apipie_concern_update_api_blocks.each do |(methods, block)|
-          controller.apipie_update_params(methods, &block)
+          controller.apipie_update_methods(methods, &block)
         end
       end
 

data/lib/apipie/markup.rb

@@ -4,20 +4,23 @@ module Apipie
 
     class RDoc
 
-      def initialize
-        require 'rdoc'
-        require 'rdoc/markup/to_html'
-        if Gem::Version.new(::RDoc::VERSION) < Gem::Version.new('4.0.0')
-          @rdoc ||= ::RDoc::Markup::ToHtml.new()
-        else
-          @rdoc ||= ::RDoc::Markup::ToHtml.new(::RDoc::Options.new)
-        end
-      end
-
       def to_html(text)
-        @rdoc.convert(text)
+        rdoc.convert(text)
       end
 
+      private
+
+      def rdoc
+        @rdoc ||= begin
+          require 'rdoc'
+          require 'rdoc/markup/to_html'
+          if Gem::Version.new(::RDoc::VERSION) < Gem::Version.new('4.0.0')
+            ::RDoc::Markup::ToHtml.new()
+          else
+            ::RDoc::Markup::ToHtml.new(::RDoc::Options.new)
+          end
+        end
+      end
     end
 
     class Markdown

data/lib/apipie/method_description.rb

@@ -17,7 +17,8 @@ module Apipie
 
     end
 
-    attr_reader :full_description, :method, :resource, :apis, :examples, :see, :formats, :metadata, :headers, :show
+    attr_reader :full_description, :method, :resource, :apis, :examples, :see, :formats, :headers, :show
+    attr_accessor :metadata
 
     def initialize(method, resource, dsl_data)
       @method = method.to_s

data/lib/apipie/routes_formatter.rb

@@ -16,7 +16,7 @@ module Apipie
     end
 
     def format_path(rails_route)
-      rails_route.path.spec.to_s.gsub('(.:format)', '')
+      File.join(rails_route.base_url, rails_route.path.spec.to_s.gsub('(.:format)', ''))
     end
 
     def format_verb(rails_route)

data/lib/apipie/swagger_generator.rb

@@ -651,14 +651,15 @@ module Apipie
 
     def add_headers_from_hash(swagger_params_array, headers)
       swagger_headers = headers.map do |header|
-        {
+        header_hash = {
           name: header[:name],
           in: 'header',
           required: header[:options][:required],
           description: header[:description],
           type:  header[:options][:type] || 'string'
         }
-
+        header_hash[:default] = header[:options][:default] if header[:options][:default]
+        header_hash
       end
       swagger_params_array.push(*swagger_headers)
     end

data/lib/apipie/validator.rb

@@ -129,6 +129,8 @@ module Apipie
           'array'
         elsif @type.ancestors.include? Numeric
           'numeric'
+        elsif @type.ancestors.include? File
+          'file'
         else
           'string'
         end

data/lib/apipie/version.rb

@@ -1,3 +1,3 @@
 module Apipie
-  VERSION = '0.5.15'
+  VERSION = "0.5.19"
 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)

data/rel-eng/gem_release.ipynb

@@ -0,0 +1,366 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Release of apipie-rails gem\n",
+    "\n",
+    "### Requirements\n",
+    "- push access to https://github.com/Apipie/apipie-rails\n",
+    "- push access to rubygems.org for apipie-rails\n",
+    "- sudo yum install python-slugify asciidoc\n",
+    "- ensure neither the `git push` or `gem push` don't require interractive auth. If you can't use api key or ssh key to auth skip these steps and run them form the shell manually \n",
+    "\n",
+    "### Release process\n",
+    "- Follow the steps with `<Shift>+<Enter>` or `<Ctrl>+<Enter>,<Down>`\n",
+    "- If anything fails, fix it and re-run the step if applicable\n",
+    "\n",
+    "### Release settings"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "%cd .."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Update the following notebook settings"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "NEW_VERSION = '0.5.19'\n",
+    "LAST_VERSION = '0.5.18'\n",
+    "GIT_REMOTE_UPSTREAM = 'origin'\n",
+    "WORK_BRANCH = 'master'\n"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Ensure the repo is up to date"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "! git checkout {WORK_BRANCH}"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "! git fetch {GIT_REMOTE_UPSTREAM}"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "! git rebase {GIT_REMOTE_UPSTREAM}/{WORK_BRANCH}"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Run tests localy"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "! bundle update"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "scrolled": true
+   },
+   "outputs": [],
+   "source": [
+    "! bundle exec rake"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Update release related stuff"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "! sed -i 's/VERSION = .*/VERSION = \"{NEW_VERSION}\"/' lib/apipie/version.rb"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Parse git changelog\n",
+    "from IPython.display import Markdown as md\n",
+    "from subprocess import check_output\n",
+    "from shlex import split\n",
+    "import re\n",
+    "\n",
+    "def format_log_entry(entry):\n",
+    "    author = re.search(r'author:(.*)', entry).group(1)\n",
+    "    entry = re.sub(r'author:(.*)', '', entry)\n",
+    "    entry = re.sub(r'([fF]ixes|[rR]efs)[^-]*-\\s*(.*)', r'\\2', entry)\n",
+    "    entry = '* ' + entry.capitalize()\n",
+    "    entry = re.sub(r'\\(#([0-9]+)\\)', r'[#\\1](https://github.com/Apipie/apipie-rails/pull/\\1)', entry)\n",
+    "    entry = entry + f'({author})'\n",
+    "    return entry\n",
+    "\n",
+    "def skip(entry):\n",
+    "    if re.match(r'Merge pull', entry) or \\\n",
+    "      re.match(r'^i18n', entry) or \\\n",
+    "      re.match(r'^Bump to version', entry):\n",
+    "        return True\n",
+    "    else:\n",
+    "        return False \n",
+    "git_log_cmd = 'git log --pretty=format:\"%%s author:%%an\" v%s..HEAD' % LAST_VERSION\n",
+    "log = check_output(split(git_log_cmd)).decode('utf8').split('\\n')\n",
+    "change_log = [format_log_entry(e) for e in log if not skip(e)]\n",
+    "md('\\n'.join(change_log))\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Write release notes\n",
+    "from datetime import datetime\n",
+    "import fileinput\n",
+    "import sys\n",
+    "\n",
+    "fh = fileinput.input('CHANGELOG.md', inplace=True)  \n",
+    "for line in fh:  \n",
+    "    print(line.rstrip())\n",
+    "    if re.match(r'========', line):\n",
+    "        print('## [v%s](https://github.com/Apipie/apipie-rails/tree/v%s) (%s)' % (NEW_VERSION, NEW_VERSION, datetime.today().strftime('%Y-%m-%d')))\n",
+    "        print('[Full Changelog](https://github.com/Apipie/apipie-rails/compare/v%s...v%s)' % (LAST_VERSION, NEW_VERSION))\n",
+    "        for entry in change_log:\n",
+    "            print(entry)\n",
+    "        print('')\n",
+    "fh.close()  "
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Manual step: Update deps in the gemspec if neccessary"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Check what is going to be commited"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "scrolled": false
+   },
+   "outputs": [],
+   "source": [
+    "! git add -u\n",
+    "! git status"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "scrolled": true
+   },
+   "outputs": [],
+   "source": [
+    "! git diff --cached"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Commit changes"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "scrolled": true
+   },
+   "outputs": [],
+   "source": [
+    "! git commit -m \"Bump to {NEW_VERSION}\""
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Tag new version"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "! git tag v{NEW_VERSION}"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Build the gem"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "! rake build"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "! gem push pkg/apipie-rails-{NEW_VERSION}.gem"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### PUSH the changes upstream If everything is correct"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "! git push {GIT_REMOTE_UPSTREAM} {WORK_BRANCH}"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "! git push --tags {GIT_REMOTE_UPSTREAM} {WORK_BRANCH}"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Now the new release is in upstream repo"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Some manual steps follow to improve the UX\n",
+    "\n",
+    "#### New relase on GitHub\n",
+    "\n",
+    "Copy the following changelog lines to the description in form on link below\n",
+    "The release title is the new version."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "print('\\n')\n",
+    "print('\\n'.join(change_log))\n",
+    "print('\\n\\nhttps://github.com/Apipie/apipie-rails/releases/new?tag=%s' % NEW_VERSION)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Congratulations\n",
+    "\n",
+    "Release is public now."
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.6.8"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

data/spec/controllers/extended_controller_spec.rb

@@ -7,5 +7,8 @@ describe ExtendedController do
     user_param = Apipie["extended#create"].params[:user]
     expect(user_param.validator.params_ordered.map(&:name)).to eq [:name, :password, :from_concern]
   end
-end
 
+  it 'should include updated metadata' do
+    expect(Apipie['extended#create'].metadata).to eq metadata: 'data'
+  end
+end

data/spec/controllers/memes_controller_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe TestEngine::MemesController do
+
+  describe "#index" do
+    it "should have the full mounted path of engine" do
+      Apipie.routes_for_action(TestEngine::MemesController, :index, {}).first[:path].should eq("/test/memes")
+    end
+  end
+end

data/spec/controllers/users_controller_spec.rb

@@ -488,12 +488,24 @@ describe UsersController do
           }
         end
 
+        let(:expected_header_with_default) do
+          {
+            name: :HeaderNameWithDefaultValue,
+            description: 'Header with default value',
+            options: {
+              required: true,
+              default: 'default value'
+            }
+          }
+        end
+
         it 'contains all headers description in method doc' do
           headers = Apipie.get_method_description(UsersController, :action_with_headers).headers
           expect(headers).to be_an(Array)
 
           compare_hashes headers[0], expected_required_header
           compare_hashes headers[1], expected_optional_header
+          compare_hashes headers[2], expected_header_with_default
         end
       end
 

data/spec/dummy/app/controllers/concerns/extending_concern.rb

@@ -6,6 +6,7 @@ module Concerns
       param :user, Hash do
         param :from_concern, String, :desc => 'param from concern', :allow_nil => false
       end
+      meta metadata: 'data'
     end
   end
 end

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

@@ -292,6 +292,7 @@ class UsersController < ApplicationController
   api :GET, '/users/action_with_headers'
   header :RequredHeaderName, 'Required header description', required: true
   header :OptionalHeaderName, 'Optional header description', required: false, type: 'string'
+  header :HeaderNameWithDefaultValue, 'Header with default value', required: true, default: 'default value'
   def action_with_headers
   end
 end

data/spec/dummy/components/test_engine/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Declare your gem's dependencies in test_engine.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec

data/spec/dummy/components/test_engine/app/controllers/test_engine/application_controller.rb

@@ -0,0 +1,4 @@
+module TestEngine
+  class ApplicationController < ActionController::Base
+  end
+end

data/spec/dummy/components/test_engine/app/controllers/test_engine/memes_controller.rb

@@ -0,0 +1,37 @@
+module TestEngine
+  class MemesController < TestEngine::ApplicationController
+    api! 'Returns a list of all good memes on Twitter'
+    param :api_token, String, required: true, desc: 'Your Twitter API token'
+    def index
+      render json: []
+    end
+
+    api! 'Shows info about a particular meme on Twitter'
+    param :id, :number, required: true, desc: 'ID of the meme'
+    def show
+      render json: {id: params[:id]}
+    end
+
+    api! 'Create a new meme on Twitter'
+    param :api_token, String, required: true, desc: 'Your Twitter API token'
+    param :name, String, required: true, desc: 'Name of your meme'
+    param :src_url, String, required: true, desc: 'URL for your meme'
+    def create
+      render json: {name: params[:name], src_url: params[:src_url]}, status: :created
+    end
+
+    api! 'Update a meme on Twitter'
+    param :api_token, String, required: true, desc: 'Your Twitter API token'
+    param :name, String, required: false, desc: 'Name of your meme'
+    param :src_url, String, required: false, desc: 'URL for your meme'
+    def update
+      render json: {name: params[:name], src_url: params[:src_url]}
+    end
+
+    api! 'Delete a meme on Twitter'
+    param :id, :number, required: true, desc: 'ID of the meme'
+    def destroy
+      head :ok
+    end
+  end
+end

data/spec/dummy/components/test_engine/config/routes.rb

@@ -0,0 +1,3 @@
+TestEngine::Engine.routes.draw do
+  resources :memes, only: [:index, :show, :create, :update, :destroy]
+end

data/spec/dummy/components/test_engine/lib/test_engine.rb

@@ -0,0 +1,7 @@
+require 'apipie-rails'
+
+module TestEngine
+  class Engine < ::Rails::Engine
+    isolate_namespace TestEngine
+  end
+end

data/spec/dummy/components/test_engine/test_engine.gemspec

@@ -0,0 +1,11 @@
+$:.push File.expand_path('../lib', __FILE__)
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name        = 'test_engine'
+  s.version     = '0.0.1'
+  s.summary     = 'Test Engine'
+  s.authors     = 'Test Author'
+
+  s.files = Dir['{app,config,db,lib}/**/*']
+end

data/spec/dummy/config/application.rb

@@ -8,6 +8,7 @@ require "action_mailer/railtie"
 
 Bundler.require
 require "apipie-rails"
+require "test_engine"
 
 module Dummy
   class Application < Rails::Application

data/spec/dummy/config/routes.rb

@@ -1,5 +1,7 @@
 Dummy::Application.routes.draw do
 
+  mount TestEngine::Engine => '/test'
+
   scope ENV['RAILS_RELATIVE_URL_ROOT'] || '/' do
 
     scope '/api' do

data/spec/spec_helper.rb

@@ -8,6 +8,7 @@ require File.expand_path("../dummy/config/environment", __FILE__)
 require 'rspec/rails'
 
 require 'apipie-rails'
+require 'test_engine'
 
 module Rails4Compatibility
   module Testing

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apipie-rails
 version: !ruby/object:Gem::Version
-  version: 0.5.15
+  version: 0.5.19
 platform: ruby
 authors:
 - Pavel Pokorny
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-03 00:00:00.000000000 Z
+date: 2021-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -155,6 +155,8 @@ files:
 - Gemfile.rails42
 - Gemfile.rails50
 - Gemfile.rails51
+- Gemfile.rails60
+- Gemfile.rails61
 - MIT-LICENSE
 - NOTICE
 - PROPOSAL_FOR_RESPONSE_DESCRIPTIONS.md
@@ -207,6 +209,7 @@ files:
 - lib/apipie/apipie_module.rb
 - lib/apipie/application.rb
 - lib/apipie/configuration.rb
+- lib/apipie/core_ext/route.rb
 - lib/apipie/dsl_definition.rb
 - lib/apipie/error_description.rb
 - lib/apipie/errors.rb
@@ -237,6 +240,7 @@ files:
 - lib/generators/apipie/install/templates/initializer.rb.erb
 - lib/generators/apipie/views_generator.rb
 - lib/tasks/apipie.rake
+- rel-eng/gem_release.ipynb
 - rel-eng/packages/.readme
 - rel-eng/packages/rubygem-apipie-rails
 - rel-eng/tito.props
@@ -246,6 +250,7 @@ files:
 - spec/controllers/apipies_controller_spec.rb
 - spec/controllers/concerns_controller_spec.rb
 - spec/controllers/extended_controller_spec.rb
+- spec/controllers/memes_controller_spec.rb
 - spec/controllers/users_controller_spec.rb
 - spec/dummy/Rakefile
 - spec/dummy/app/controllers/api/base_controller.rb
@@ -270,6 +275,13 @@ files:
 - spec/dummy/app/controllers/twitter_example_controller.rb
 - spec/dummy/app/controllers/users_controller.rb
 - spec/dummy/app/views/layouts/application.html.erb
+- spec/dummy/components/test_engine/Gemfile
+- spec/dummy/components/test_engine/app/controllers/test_engine/application_controller.rb
+- spec/dummy/components/test_engine/app/controllers/test_engine/memes_controller.rb
+- spec/dummy/components/test_engine/config/routes.rb
+- spec/dummy/components/test_engine/db/.gitkeep
+- spec/dummy/components/test_engine/lib/test_engine.rb
+- spec/dummy/components/test_engine/test_engine.gemspec
 - spec/dummy/config.ru
 - spec/dummy/config/application.rb
 - spec/dummy/config/boot.rb
@@ -331,8 +343,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Rails REST API documentation tool
@@ -343,6 +354,7 @@ test_files:
 - spec/controllers/apipies_controller_spec.rb
 - spec/controllers/concerns_controller_spec.rb
 - spec/controllers/extended_controller_spec.rb
+- spec/controllers/memes_controller_spec.rb
 - spec/controllers/users_controller_spec.rb
 - spec/dummy/Rakefile
 - spec/dummy/app/controllers/api/base_controller.rb
@@ -367,6 +379,13 @@ test_files:
 - spec/dummy/app/controllers/twitter_example_controller.rb
 - spec/dummy/app/controllers/users_controller.rb
 - spec/dummy/app/views/layouts/application.html.erb
+- spec/dummy/components/test_engine/Gemfile
+- spec/dummy/components/test_engine/app/controllers/test_engine/application_controller.rb
+- spec/dummy/components/test_engine/app/controllers/test_engine/memes_controller.rb
+- spec/dummy/components/test_engine/config/routes.rb
+- spec/dummy/components/test_engine/db/.gitkeep
+- spec/dummy/components/test_engine/lib/test_engine.rb
+- spec/dummy/components/test_engine/test_engine.gemspec
 - spec/dummy/config.ru
 - spec/dummy/config/application.rb
 - spec/dummy/config/boot.rb