apipie-rails 0.3.7 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 17995f18251d02f81382e0d01c72f257f708849c
-  data.tar.gz: 5c7c04c928e4ec7639d589e4fb878e5ae60b8522
+  metadata.gz: 3557cb98f666126a55faa4fe95a955403adcaedf
+  data.tar.gz: 6fd75fb4ebd5e4b0652b81c77c0df65f6d96a41b
 SHA512:
-  metadata.gz: f3f894d9d39a183ae146c9f9b8be3d9d402b8631cb7243294d01acbc0b5f84e1b2e7f39fd5170d1e7c989daa7493a2e9ded3653907ea4cd69e4285b7211e5bc2
-  data.tar.gz: ce051627c13ca9435698f1e3d553d3aa22d30f77408b007ff127b1f6d64c495f90d30fa042bef3b25c527afa6f89d45baae6bc812931229daa3d5b6393cc5268
+  metadata.gz: 1f9c181cc455758e9411f0631f3e5a5d67953ce8eb6209ad079862ce2e4ab3c1550cd5deb05fae1541d8e48d6d4f27753c994876484d185551f3049583a2ec47
+  data.tar.gz: 77b58f2a00111e3dab471de451c9ddcf9ec82622dde6b3ba14d3e23f2138ec571157521092fdebc0a76c73ae22350a3c2d7693147d65b248285e5f608734398f

data/.travis.yml

@@ -5,8 +5,17 @@ rvm:
   - 2.0.0
   - 2.1.7
   - 2.2.3
+  - 2.3.3
 gemfile:
-  - Gemfile.rails32
   - Gemfile.rails40
   - Gemfile.rails41
   - Gemfile.rails42
+  - Gemfile.rails50 # Min ruby 2.2.2
+matrix:
+  exclude:
+    - rvm: 1.9.3
+      gemfile: Gemfile.rails50
+    - rvm: 2.0.0
+      gemfile: Gemfile.rails50
+    - rvm: 2.1.7
+      gemfile: Gemfile.rails50

data/CHANGELOG.md

@@ -2,6 +2,23 @@
  Changelog
 ===========
 
+v0.4.0
+------
+
+- Rails 5 compatibility [\#527](https://github.com/Apipie/apipie-rails/pull/527) ([iNecas](https://github.com/iNecas)) [\#420](https://github.com/Apipie/apipie-rails/pull/420) ([buren](https://github.com/buren)) [\#473](https://github.com/Apipie/apipie-rails/pull/473)([domcleal](https://github.com/domcleal))
+  - **This release is no longer compatible with Rails 3.x**
+- Include delete request parmeters in generated documentation [\#524](https://github.com/Apipie/apipie-rails/pull/524) ([johnnaegle](https://github.com/johnnaegle))
+- Allow a blank, not just nil, base\_url. [\#521](https://github.com/Apipie/apipie-rails/pull/521) ([johnnaegle](https://github.com/johnnaegle))
+- Adds allow\_blank option [\#508](https://github.com/Apipie/apipie-rails/pull/508) ([MrLeebo](https://github.com/MrLeebo))
+- Boolean Validator uses \<code\> instead of ' [\#502](https://github.com/Apipie/apipie-rails/pull/502) ([berfarah](https://github.com/berfarah))
+- Fix type validator message [\#501](https://github.com/Apipie/apipie-rails/pull/501) ([cindygu-itglue](https://github.com/cindygu-itglue))
+- Add IT locale [\#496](https://github.com/Apipie/apipie-rails/pull/496) ([alepore](https://github.com/alepore))
+- Fix small typo on dsl\_definition data init [\#494](https://github.com/Apipie/apipie-rails/pull/494) ([begault](https://github.com/begault))
+- Localize app info message [\#491](https://github.com/Apipie/apipie-rails/pull/491) ([belousovAV](https://github.com/belousovAV))
+- Fix travis build [\#489](https://github.com/Apipie/apipie-rails/pull/489) ([mtparet](https://github.com/mtparet))
+- Handle blank data when parsing a example's response [\#453](https://github.com/Apipie/apipie-rails/pull/453) ([stbenjam](https://github.com/stbenjam))
+- Allow layouts to be overridable. Fixes a regression introduced in \#425. [\#447](https://github.com/Apipie/apipie-rails/pull/447) ([nilsojes](https://github.com/nilsojes))
+
 v0.3.7
 ------
 

data/Gemfile

@@ -2,6 +2,6 @@ source "https://rubygems.org"
 
 gemspec
 
-# load local gemfile
-local_gemfile = File.join(File.dirname(__FILE__), 'Gemfile.local')
-self.instance_eval(Bundler.read_file(local_gemfile)) if File.exist?(local_gemfile)
+gem 'rails', '~> 5.0'
+gem 'mime-types', '~> 2.99.3'
+gem 'rails-controller-testing'

data/Gemfile.rails40

@@ -3,4 +3,5 @@ source "https://rubygems.org"
 gemspec
 
 gem 'rails', '~> 4.0.0'
-gem 'mime-types', '~> 2.99.3'
+gem 'mime-types', '~> 2.99.3'
+gem 'json', '~> 1.8'

data/Gemfile.rails41

@@ -3,4 +3,4 @@ source "https://rubygems.org"
 gemspec
 
 gem 'rails', '~> 4.1.0'
-gem 'mime-types', '~> 2.99.3'
+gem 'mime-types', '~> 2.99.3'

data/Gemfile.rails42

@@ -3,4 +3,9 @@ source "https://rubygems.org"
 gemspec
 
 gem 'rails', '~> 4.2.5'
-gem 'mime-types', '~> 2.99.3'
+gem 'mime-types', '~> 2.99.3'
+
+if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.1.0')
+  gem 'nokogiri', '~> 1.6.8'
+  gem 'rdoc', '~> 4.2.2'
+end

data/Gemfile.rails50

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem 'rails', '~> 5.0'
+gem 'mime-types', '~> 2.99.3'
+gem 'rails-controller-testing'

data/README.rst

@@ -2,9 +2,9 @@
  API Documentation Tool
 ========================
 
-.. image:: https://travis-ci.org/Apipie/apipie-rails.png?branch=master
+.. image:: https://travis-ci.org/Apipie/apipie-rails.svg?branch=master
     :target: https://travis-ci.org/Apipie/apipie-rails
-.. image:: https://codeclimate.com/github/Apipie/apipie-rails.png
+.. image:: https://codeclimate.com/github/Apipie/apipie-rails.svg
     :target: https://codeclimate.com/github/Apipie/apipie-rails
 .. image:: https://badges.gitter.im/Apipie/apipie-rails.svg
    :alt: Join the chat at https://gitter.im/Apipie/apipie-rails
@@ -288,6 +288,9 @@ required
 allow_nil
   Setting this to true means that ``nil`` can be passed.
 
+allow_blank
+  Like ``allow_nil``, but for blank values. ``false``, ``""``, ``' '``, ``nil``, ``[]``, and ``{}`` are all blank.
+
 as
   Used by the processing functionality to change the name of a key params.
 
@@ -528,7 +531,7 @@ default_version
 validate
   Parameters validation is turned off when set to false. When set to
   ``:explicitly``, you must invoke parameter validation yourself by calling
-  controller method ``apipie_validations`` (typically in a before_filter).
+  controller method ``apipie_validations`` (typically in a before_action).
   When set to ``:implicitly`` (or just true), your controller's action
   methods are wrapped with generated methods which call ``apipie_validations``,
   and then call the action method. (``:implicitly`` by default)
@@ -726,17 +729,17 @@ is raised and can be rescued and processed. It contains a description
 of the parameter value expectations. Validations can be turned off
 in the configuration file.
 
-Parameter validation normally happens after before_filters, just before
+Parameter validation normally happens after before_actions, just before
 your controller method is invoked. If you prefer to control when parameter
 validation occurs, set the configuration parameter ``validate`` to ``:explicitly``.
 You must then call the ``apipie_validations`` method yourself, e.g.:
 
 .. code:: ruby
 
-   before_filter: :apipie_validations
+   before_action: :apipie_validations
 
-This is useful if you have before_filters which use parameter values: just add them
-after the ``apipie_validations`` before_filter.
+This is useful if you have before_actions which use parameter values: just add them
+after the ``apipie_validations`` before_action.
 
 TypeValidator
 -------------
@@ -1068,11 +1071,8 @@ When your project use I18n, localization related configuration could appear as f
     config.default_locale = 'en'
     config.locale = lambda { |loc| loc ? I18n.locale = loc : I18n.locale }
     config.translate = lambda do |str, loc|
-      old_loc = I18n.locale
-      I18n.locale = loc
-      trans = I18n.t(str)
-      I18n.locale = old_loc
-      trans
+      return '' if str.blank?
+      I18n.t str, locale: loc, scope: 'doc'
     end
    end
 

data/apipie-rails.gemspec

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

data/app/controllers/apipie/apipies_controller.rb

@@ -5,8 +5,8 @@ module Apipie
 
     layout Apipie.configuration.layout
 
-    around_filter :set_script_name
-    before_filter :authenticate
+    around_action :set_script_name
+    before_action :authenticate
 
     def authenticate
       if Apipie.configuration.authenticate

data/config/locales/it.yml

@@ -0,0 +1,31 @@
+it:
+  apipie:
+    resources: Risorse
+    resource: Risorsa
+    description: Descrizione
+    no_docs_found: Nessuna documentazione trovata
+    no_docs_found_descr: Non abbiamo trovato nessuna documentazione per la tua API.
+    follow_instructions_html: Leggi su %{href} come descrivere i tuoi controller.
+    follow_instructions_href: ulteriori istruzioni
+    oops: Ops!!
+    resource_not_found_html: Risorsa %{resource} non trovata.
+    method_not_found_html: Metodo %{method} non trovato per la risorsa %{resource}.
+    goto_homepage_html: Prova ad andare su %{href}
+    goto_homepage_href: "%{app_name} Homepage della documentazione API"
+    required: richiesto
+    optional: opzionale
+    nil_allowed: consentito nil
+    param_name: Nome parametro
+    params: Parametri
+    examples: Esempi
+    metadata: Metadata
+    errors: Errori
+    error_code: Codice
+    error_description: Descrizione
+    error_metadata: Metadata
+    supported_formats: Formati supportati
+    enable_javascript_html: Abilita i JavaScript per vedere %{comments_href}.
+    comments_powered_by_disqus: commenti forniti da %{disqus}
+    api_documentation: Documentazione API
+    headers: Header
+    header_name: Nome Header

data/lib/apipie/apipie_module.rb

@@ -31,14 +31,16 @@ module Apipie
   end
 
   # get application description for given or default version
-  def self.app_info(version = nil)
-    if app_info_version_valid? version
-      Apipie.markup_to_html(self.configuration.app_info[version])
+  def self.app_info(version = nil, lang = nil)
+    info = if app_info_version_valid? version
+      translate(self.configuration.app_info[version], lang)
     elsif app_info_version_valid? Apipie.configuration.default_version
-      Apipie.markup_to_html(self.configuration.app_info[Apipie.configuration.default_version])
+      translate(self.configuration.app_info[Apipie.configuration.default_version], lang)
     else
       "Another API description"
     end
+
+    Apipie.markup_to_html info
   end
 
   def self.api_base_url(version = nil)

data/lib/apipie/application.rb

@@ -54,14 +54,9 @@ module Apipie
     # the app might be nested when using contraints, namespaces etc.
     # this method does in depth search for the route controller
     def route_app_controller(app, route, visited_apps = [])
-      visited_apps << app
-      if app.respond_to?(:controller)
-        return app.controller(route.defaults)
-      elsif app.respond_to?(:app) && !visited_apps.include?(app.app)
-        return route_app_controller(app.app, route, visited_apps)
+      if route.defaults[:controller]
+        (route.defaults[:controller].camelize + "Controller").constantize
       end
-    rescue ActionController::RoutingError
-      # some errors in the routes will not stop us here: just ignoring
     end
 
     def routes_for_action(controller, method, args)
@@ -278,7 +273,7 @@ module Apipie
       {
         :docs => {
           :name => Apipie.configuration.app_name,
-          :info => translate(Apipie.app_info(version), lang),
+          :info => Apipie.app_info(version, lang),
           :copyright => Apipie.configuration.copyright,
           :doc_url => Apipie.full_url(url_args),
           :api_url => Apipie.api_base_url(version),
@@ -392,7 +387,7 @@ module Apipie
     def version_prefix(klass)
       version = controller_versions(klass).first
       base_url = get_base_url(version)
-      return "/" if base_url.nil?
+      return "/" if base_url.blank?
       base_url[1..-1] + "/"
     end
 

data/lib/apipie/dsl_definition.rb

@@ -26,7 +26,7 @@ module Apipie
          :errors            => [],
          :params            => [],
          :headers           => [],
-         :resouce_id        => nil,
+         :resource_id        => nil,
          :short_description => nil,
          :description       => nil,
          :examples          => [],

data/lib/apipie/extractor.rb

@@ -9,7 +9,7 @@ require 'apipie/extractor/collector'
 class Apipie::Railtie
   initializer 'apipie.extractor' do |app|
     ActiveSupport.on_load :action_controller do
-      before_filter do |controller|
+      before_action do |controller|
         if Apipie.configuration.record
           Apipie::Extractor.call_recorder.analyse_controller(controller)
         end

data/lib/apipie/extractor/recorder.rb

@@ -38,7 +38,7 @@ module Apipie
         @verb = request.request_method.to_sym
         @path = request.path
         @params = request.request_parameters
-        if [:POST, :PUT, :PATCH].include?(@verb)
+        if [:POST, :PUT, :PATCH, :DELETE].include?(@verb)
           @request_data = @params
         else
           @query = request.query_string

data/lib/apipie/param_description.rb

@@ -8,7 +8,7 @@ module Apipie
   # validator - Validator::BaseValidator subclass
   class ParamDescription
 
-    attr_reader :method_description, :name, :desc, :allow_nil, :validator, :options, :metadata, :show, :as, :validations
+    attr_reader :method_description, :name, :desc, :allow_nil, :allow_blank, :validator, :options, :metadata, :show, :as, :validations
     attr_accessor :parent, :required
 
     def self.from_dsl_data(method_description, args)
@@ -56,6 +56,7 @@ module Apipie
       end
 
       @allow_nil = @options[:allow_nil] || false
+      @allow_blank = @options[:allow_blank] || false
 
       action_awareness
 
@@ -71,8 +72,20 @@ module Apipie
       method_description.from_concern? || @from_concern
     end
 
+    def normalized_value(value)
+      if value.is_a?(ActionController::Parameters) && !value.is_a?(Hash)
+        value.to_unsafe_hash
+      elsif value.is_a? Array
+        value.map { |v| normalized_value (v) }
+      else
+        value
+      end
+    end
+
     def validate(value)
       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)
         error = @validator.error
         error = ParamError.new(error) unless error.is_a? StandardError
@@ -81,6 +94,7 @@ module Apipie
     end
 
     def process_value(value)
+      value = normalized_value(value)
       if @validator.respond_to?(:process_value)
         @validator.process_value(value)
       else
@@ -111,6 +125,7 @@ module Apipie
                :description => preformat_text(Apipie.app.translate(@options[:desc], lang)),
                :required => required,
                :allow_nil => allow_nil,
+               :allow_blank => allow_blank,
                :validator => validator.to_s,
                :expected_type => validator.expected_type,
                :metadata => metadata,

data/lib/apipie/validator.rb

@@ -96,7 +96,7 @@ module Apipie
       end
 
       def description
-        "Must be #{@type}"
+        "Must be a #{@type}"
       end
 
       def expected_type
@@ -413,7 +413,8 @@ module Apipie
       end
 
       def description
-        "Must be 'true' or 'false' or '1' or '0'"
+        string = %w(true false 1 0).map { |value| "<code>#{value}</code>" }.join(', ')
+        "Must be one of: #{string}"
       end
     end
 
@@ -464,4 +465,3 @@ module Apipie
 
   end
 end
-

data/lib/apipie/version.rb

@@ -1,3 +1,3 @@
 module Apipie
-  VERSION = '0.3.7'
+  VERSION = '0.4.0'
 end

data/spec/controllers/apipies_controller_spec.rb

@@ -12,37 +12,37 @@ describe Apipie::ApipiesController do
     end
 
     it "succeeds on version details" do
-      get :index, :version => "2.0"
+      get :index, :params => { :version => "2.0" }
 
       assert_response :success
     end
 
     it "returns not_found on wrong version" do
-      get :index, :version => "wrong_version"
+      get :index, :params => { :version => "wrong_version" }
 
       assert_response :not_found
     end
 
     it "succeeds on resource details" do
-      get :index, :version => "2.0", :resource => "architectures"
+      get :index, :params => { :version => "2.0", :resource => "architectures" }
 
       assert_response :success
     end
 
     it "returns not_found on wrong resource" do
-      get :index, :version => "2.0", :resource => "wrong_resource"
+      get :index, :params => { :version => "2.0", :resource => "wrong_resource" }
 
       assert_response :not_found
     end
 
     it "succeeds on method details" do
-      get :index, :version => "2.0", :resource => "architectures", :method => "index"
+      get :index, :params => { :version => "2.0", :resource => "architectures", :method => "index" }
 
       assert_response :success
     end
 
     it "returns not_found on wrong method" do
-      get :index, :version => "2.0", :resource => "architectures", :method => "wrong_method"
+      get :index, :params => { :version => "2.0", :resource => "architectures", :method => "wrong_method" }
 
       assert_response :not_found
     end
@@ -215,17 +215,17 @@ describe Apipie::ApipiesController do
     it "uses the file in cache dir instead of generating the content on runtime" do
       get :index
       expect(response.body).to eq("apidoc.html cache v1")
-      get :index, :version => 'v1'
+      get :index, :params => { :version => 'v1' }
       expect(response.body).to eq("apidoc.html cache v1")
-      get :index, :version => 'v2'
+      get :index, :params => { :version => 'v2' }
       expect(response.body).to eq("apidoc.html cache v2")
-      get :index, :version => 'v1', :format => "html"
+      get :index, :params => { :version => 'v1', :format => "html" }
       expect(response.body).to eq("apidoc.html cache v1")
-      get :index, :version => 'v1', :format => "json"
+      get :index, :params => { :version => 'v1', :format => "json" }
       expect(response.body).to eq("apidoc.json cache")
-      get :index, :version => 'v1', :format => "html", :resource => "resource"
+      get :index, :params => { :version => 'v1', :format => "html", :resource => "resource" }
       expect(response.body).to eq("resource.html cache")
-      get :index, :version => 'v1', :format => "html", :resource => "resource", :method => "method"
+      get :index, :params => { :version => 'v1', :format => "html", :resource => "resource", :method => "method" }
       expect(response.body).to eq("method.html cache")
     end
 

data/spec/controllers/concerns_controller_spec.rb

@@ -8,7 +8,7 @@ describe ConcernsController do
   end
 
   it "should reply to valid request" do
-    get :show, :id => '5', :session => "secret_hash"
+    get :show, :params => { :id => '5' }, :session => { :user_id => "secret_hash" }
     assert_response :success
   end
 

data/spec/controllers/users_controller_spec.rb

@@ -66,7 +66,7 @@ describe UsersController do
       end
 
       it "should reply to valid request" do
-        get :show, :id => '5', :session => "secret_hash"
+        get :show, :params => { :id => '5', :session => "secret_hash" }
         assert_response :success
       end
 
@@ -92,17 +92,17 @@ describe UsersController do
           end
 
           it "should reply to valid request" do
-            expect { get :show, :id => 5, :session => "secret_hash" }.not_to raise_error
+            expect { get :show, :params => { :id => 5, :session => "secret_hash" }}.not_to raise_error
             assert_response :success
           end
 
           it "should fail if required parameter is missing" do
-            expect { get :show, :id => 5 }.to raise_error(Apipie::ParamMissing, /session_parameter_is_required/)
+            expect { get :show, :params => { :id => 5 }}.to raise_error(Apipie::ParamMissing, /session_parameter_is_required/)
           end
 
           it "should pass if required parameter has wrong type" do
-            expect { get :show, :id => 5, :session => "secret_hash" }.not_to raise_error
-            expect { get :show, :id => "ten", :session => "secret_hash" }.not_to raise_error
+            expect { get :show, :params => { :id => 5 , :session => "secret_hash" }}.not_to raise_error
+            expect { get :show, :params => { :id => "ten" , :session => "secret_hash" }}.not_to raise_error
           end
 
         end
@@ -115,12 +115,12 @@ describe UsersController do
           end
 
           it "should reply to valid request" do
-            expect { get :show, :id => 5, :session => "secret_hash" }.not_to raise_error
+            expect { get :show, :params => { :id => 5, :session => 'secret_hash' }}.not_to raise_error
             assert_response :success
           end
 
           it "should fail if extra parameter is passed in" do
-            expect { get :show, :id => 5, :session => "secret_hash", :badparam => 'badfoo' }.to raise_error(Apipie::UnknownParam, /\bbadparam\b/)
+            expect { get :show, :params => { :id => 5 , :badparam => 'badfoo', :session => "secret_hash" }}.to raise_error(Apipie::UnknownParam, /\bbadparam\b/)
           end
         end
 
@@ -132,81 +132,75 @@ describe UsersController do
           end
 
           it "should reply to valid request" do
-            get :show, :id => '5', :session => "secret_hash"
+            get :show, :params => { :id => '5', :session => "secret_hash" }
             assert_response :success
           end
 
           it "should work with nil value for a required hash param" do
             expect {
-              get :show, :id => '5', :session => "secret_hash", :hash_param => {:dummy_hash => nil}
+              get :show, :params => { :id => '5', :session => "secret_hash", :hash_param => {:dummy_hash => nil} }
             }.to raise_error(Apipie::ParamInvalid, /dummy_hash/)
             assert_response :success
           end
 
           it "should fail if required parameter is missing" do
-            expect { get :show, :id => 5 }.to raise_error(Apipie::ParamMissing, /session_parameter_is_required/)
+            expect { get :show, :params => { :id => 5 }}.to raise_error(Apipie::ParamMissing, /session_parameter_is_required/)
           end
 
           it "should work with custom Type validator" do
             expect {
               get :show,
-                  :id => "not a number",
-                  :session => "secret_hash"
+                  :params => { :id => "not a number", :session => "secret_hash" }
             }.to raise_error(Apipie::ParamError, /id/) # old-style error rather than ParamInvalid
           end
 
           it "should work with Regexp validator" do
-            get :show,
-                :id => 5,
-                :session => "secret_hash",
-                :regexp_param => "24 years"
+            get :show, :params => { :id => 5, :session => "secret_hash", :regexp_param => "24 years" }
             assert_response :success
 
             expect {
-              get :show,
-                  :id => 5,
-                  :session => "secret_hash",
-                  :regexp_param => "ten years"
+              get :show, :params => { :id => 5,
+                                      :session => "secret_hash",
+                                      :regexp_param => "ten years" }
             }.to raise_error(Apipie::ParamInvalid, /regexp_param/)
           end
 
           it "should work with Array validator" do
-            get :show, :id => 5, :session => "secret_hash", :array_param => "one"
-            assert_response :success
-            get :show, :id => 5, :session => "secret_hash", :array_param => "two"
+            get :show, :params => { :id => 5, :session => "secret_hash", :array_param => "one" }
             assert_response :success
-            get :show, :id => 5, :session => "secret_hash", :array_param => '1'
+            get :show, :params => { :id => 5, :session => "secret_hash", :array_param => "two" }
             assert_response :success
-            get :show, :id => 5, :session => "secret_hash", :boolean_param => false
+            get :show, :params => { :id => 5, :session => "secret_hash", :array_param => '1' }
             assert_response :success
 
             expect {
-              get :show,
-                  :id => 5,
-                  :session => "secret_hash",
-                  :array_param => "blabla"
+              get :show, :params => { :id => 5,
+                                      :session => "secret_hash",
+                                      :array_param => "blabla" }
             }.to raise_error(Apipie::ParamInvalid, /array_param/)
 
             expect {
-              get :show,
-                  :id => 5,
-                  :session => "secret_hash",
-                  :array_param => 3
+              get :show, :params => {
+                :id => 5,
+                :session => "secret_hash",
+                :array_param => 3 }
             }.to raise_error(Apipie::ParamInvalid, /array_param/)
           end
 
           it "should work with Proc validator" do
             expect {
               get :show,
-                  :id => 5,
-                  :session => "secret_hash",
-                  :proc_param => "asdgsag"
+                  :params => {
+                    :id => 5,
+                    :session => "secret_hash",
+                    :proc_param => "asdgsag" }
             }.to raise_error(Apipie::ParamInvalid, /proc_param/)
 
             get :show,
-                :id => 5,
-                :session => "secret_hash",
-                :proc_param => "param value"
+                :params => {
+                  :id => 5,
+                  :session => "secret_hash",
+                  :proc_param => "param value"}
             assert_response :success
           end
 
@@ -244,10 +238,11 @@ describe UsersController do
             params = Apipie[UsersController, :create].to_json[:params]
             expect(params).to include(:name => "facts",
                                   :full_name => "facts",
-                                  :validator => "Must be Hash",
+                                  :validator => "Must be a Hash",
                                   :description => "\n<p>Additional optional facts about the user</p>\n",
                                   :required => false,
                                   :allow_nil => true,
+                                  :allow_blank => false,
                                   :metadata => nil,
                                   :show => true,
                                   :expected_type => "hash",
@@ -261,7 +256,18 @@ describe UsersController do
                    :pass => "12345",
                    :membership => "standard",
                  },
-                 :facts => nil
+                 :facts => { :test => 'test' }
+            assert_response :success
+          end
+
+          it "should allow blank when allow_blank is set to true" do
+            post :create,
+              :user => {
+                :name => "root",
+                :pass => "12345",
+                :membership => "standard"
+              },
+              :age => ""
             assert_response :success
           end
 
@@ -293,21 +299,21 @@ describe UsersController do
               it "should raise an error" do
                 expect{
                   put :update,
-                    {
-                      :id => 5,
-                      :user => {
-                        :name => "root",
-                        :pass => "12345"
-                      },
-                      :comments => [
-                        {
-                          :comment => 'comment1'
+                      :params => {
+                        :id => 5,
+                        :user => {
+                          :name => "root",
+                          :pass => "12345"
                         },
-                        {
-                          :comment => {:bad_input => 5}
-                        }
-                      ]
-                    }
+                        :comments => [
+                          {
+                            :comment => {:bad_input => 4}
+                          },
+                          {
+                            :comment => {:bad_input => 5}
+                          }
+                        ]
+                      }
                 }.to raise_error(Apipie::ParamInvalid)
               end
             end
@@ -525,7 +531,8 @@ describe UsersController do
         :params => [{:full_name=>"oauth",
                      :required=>false,
                      :allow_nil => false,
-                     :validator=>"Must be String",
+                     :allow_blank => false,
+                     :validator=>"Must be a String",
                      :description=>"\n<p>Authorization</p>\n",
                      :name=>"oauth",
                      :show=>true,
@@ -534,6 +541,7 @@ describe UsersController do
                      :description=>"\n<p>Deprecated parameter not documented</p>\n",
                      :expected_type=>"hash",
                      :allow_nil=>false,
+                     :allow_blank => false,
                      :name=>"legacy_param",
                      :required=>false,
                      :full_name=>"legacy_param",
@@ -543,6 +551,7 @@ describe UsersController do
                         :description=>"\n<p>Param description for all methods</p>\n",
                         :expected_type=>"hash",
                         :allow_nil=>false,
+                       :allow_blank => false,
                         :name=>"resource_param",
                         :required=>false,
                         :full_name=>"resource_param",
@@ -550,14 +559,16 @@ describe UsersController do
                         :params=>
                         [{:required=>true,
                           :allow_nil => false,
-                          :validator=>"Must be String",
+                          :allow_blank => false,
+                          :validator=>"Must be a String",
                           :description=>"\n<p>Username for login</p>\n",
                           :name=>"ausername", :full_name=>"resource_param[ausername]",
                           :show=>true,
                           :expected_type=>"string"},
                          {:required=>true,
                           :allow_nil => false,
-                          :validator=>"Must be String",
+                          :allow_blank => false,   
+                          :validator=>"Must be a String",
                           :description=>"\n<p>Password for login</p>\n",
                           :name=>"apassword", :full_name=>"resource_param[apassword]",
                           :show=>true,
@@ -567,6 +578,7 @@ describe UsersController do
                     },
                     {:required=>false, :validator=>"Parameter has to be Integer.",
                      :allow_nil => false,
+                     :allow_blank => false,
                      :description=>"\n<p>Company ID</p>\n",
                      :name=>"id", :full_name=>"id",
                      :show=>true,
@@ -690,13 +702,16 @@ EOS2
 
   describe "Parameter processing / extraction" do
     before do
+      Apipie.configuration.validate = true
       Apipie.configuration.process_params = true
+      controllers_dirname = File.expand_path('../dummy/app/controllers', File.dirname(__FILE__))
+      Dir.glob("#{controllers_dirname}/**/*") { |file| load(file) if File.file?(file) }
     end
 
     it "process correctly the parameters" do
-      post :create, {:user => {:name => 'dummy', :pass => 'dummy', :membership => 'standard'}, :facts => nil}
+      post :create, :user => {:name => 'dummy', :pass => 'dummy', :membership => 'standard' }, :facts => {:test => 'test'}
 
-      expect(assigns(:api_params).with_indifferent_access).to eq({:user => {:name=>"dummy", :pass=>"dummy", :membership=>"standard"}, :facts => nil}.with_indifferent_access)
+      expect(assigns(:api_params).with_indifferent_access).to eq({:user => {:name=>"dummy", :pass=>"dummy", :membership=>"standard"}, :facts => {:test => 'test'}}.with_indifferent_access)
     end
 
     it "ignore not described parameters" do

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

@@ -1,5 +1,5 @@
 class ApplicationController < ActionController::Base
-  before_filter :run_validations
+  before_action :run_validations
   
   resource_description do
     param :oauth, String, :desc => "Authorization", :required => false

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

@@ -221,6 +221,7 @@ class UsersController < ApplicationController
     param :permalink, String
   end
   param :facts, Hash, :desc => "Additional optional facts about the user", :allow_nil => true
+  param :age, :number, :desc => "Age is just a number", :allow_blank => true
   def create
     render :text => "OK #{params.inspect}"
   end

data/spec/dummy/config/environments/development.rb

@@ -21,5 +21,8 @@ Dummy::Application.configure do
 
   # Only use best-standards-support built into browsers
   config.action_dispatch.best_standards_support = :builtin
+
+  # Do not eager load code on boot. (Rails 5)
+  config.eager_load = false
 end
 

data/spec/dummy/config/environments/production.rb

@@ -46,4 +46,7 @@ Dummy::Application.configure do
 
   # Send deprecation notices to registered listeners
   config.active_support.deprecation = :notify
+
+  # Eager load code on boot (Rails 5)
+  config.eager_load = true
 end

data/spec/dummy/config/environments/test.rb

@@ -32,4 +32,7 @@ Dummy::Application.configure do
 
   # Print deprecation notices to the stderr
   config.active_support.deprecation = :stderr
+
+  # Do not eager load code on boot. (Rails 5)
+  config.eager_load = false
 end

data/spec/dummy/config/routes.rb

@@ -10,7 +10,7 @@ Dummy::Application.routes.draw do
       end
       resources :concerns, :only => [:index, :show]
       namespace :files do
-        get '/*file_path', to: :download, format: false
+        get '/*file_path', format: false, :action => 'download'
       end
       resources :twitter_example do
         collection do

data/spec/spec_helper.rb

@@ -9,6 +9,34 @@ require 'rspec/rails'
 
 require 'apipie-rails'
 
+module Rails4Compatibility
+  module Testing
+    def process_with_rails4_compat(*args)
+      compatible_request(*args) { |*new_args| process_without_rails4_compat(*new_args) }
+    end
+
+    def self.included(base)
+      base.alias_method_chain :process, :rails4_compat
+    end
+
+    def compatible_request(method, action, hash = {})
+      if hash.is_a?(Hash)
+        if Gem::Version.new(Rails.version) < Gem::Version.new('5.0.0')
+          hash = hash.dup
+          hash.merge!(hash.delete(:params) || {})
+        elsif hash.key?(:params)
+          hash = { :params => hash }
+        end
+      end
+      if hash.empty?
+        yield method, action
+      else
+        yield method, action, hash
+      end
+    end
+  end
+end
+
 # Requires supporting ruby files with custom matchers and macros, etc,
 # in spec/support/ and its subdirectories.
 Dir[File.expand_path("../support/**/*.rb", __FILE__)].each {|f| require f}
@@ -41,3 +69,7 @@ RSpec.configure do |config|
   #     end
   config.infer_spec_type_from_file_location!
 end
+
+require 'action_controller/test_case.rb'
+# TODO: replace with prepend once we deprecate ruby 2.0.0
+ActionController::TestCase::Behavior.send(:include, Rails4Compatibility::Testing)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apipie-rails
 version: !ruby/object:Gem::Version
-  version: 0.3.7
+  version: 0.4.0
 platform: ruby
 authors:
 - Pavel Pokorny
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-13 00:00:00.000000000 Z
+date: 2017-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.20
-  type: :development
+        version: '4.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.20
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -151,10 +151,10 @@ files:
 - APACHE-LICENSE-2.0
 - CHANGELOG.md
 - Gemfile
-- Gemfile.rails32
 - Gemfile.rails40
 - Gemfile.rails41
 - Gemfile.rails42
+- Gemfile.rails50
 - MIT-LICENSE
 - NOTICE
 - README.rst
@@ -191,6 +191,7 @@ files:
 - config/locales/de.yml
 - config/locales/en.yml
 - config/locales/es.yml
+- config/locales/it.yml
 - config/locales/pl.yml
 - config/locales/pt-BR.yml
 - config/locales/ru.yml

data/Gemfile.rails32

@@ -1,6 +0,0 @@
-source "https://rubygems.org"
-
-gemspec
-
-gem 'rails', '~> 3.2.0'
-gem 'test-unit', '~> 3.0'