apipie-rails 0.3.6 → 0.5.0

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,12 +8,12 @@ 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
 
   it "should pass if required parameter is missing" do
-    expect { get :show, :id => '5' }.not_to raise_error
+    expect { get :show, :params => { :id => '5' } }.not_to raise_error
   end
 
   it "peserved the order of methods being defined in file" do

data/spec/controllers/users_controller_spec.rb

@@ -66,12 +66,12 @@ 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 pass if required parameter is missing" do
-        expect { get :show, :id => 5 }.not_to raise_error
+        expect { get :show, :params => { :id => 5 } }.not_to raise_error
       end
 
     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,86 +132,80 @@ 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
 
           it "should work with Hash validator" do
-            post :create, :user => { :name => "root", :pass => "12345", :membership => "standard" }
+            post :create, params: { :user => { :name => "root", :pass => "12345", :membership => "standard" } }
             assert_response :success
 
             a = Apipie[UsersController, :create]
@@ -225,18 +219,18 @@ describe UsersController do
             hash_params[2].name == :membership
 
             expect {
-              post :create, :user => { :name => "root", :pass => "12345", :membership => "____" }
+              post :create, :params => { :user => { :name => "root", :pass => "12345", :membership => "____" } }
             }.to raise_error(Apipie::ParamInvalid, /membership/)
 
             expect {
-              post :create, :user => { :name => "root" }
+              post :create, :params => { :user => { :name => "root" } }
             }.to raise_error(Apipie::ParamMissing, /pass/)
 
             expect {
-              post :create, :user => "a string is not a hash"
+              post :create, :params => { :user => "a string is not a hash" }
             }.to raise_error(Apipie::ParamInvalid, /user/)
 
-            post :create, :user => { :name => "root", :pass => "pwd" }
+            post :create, :params => { :user => { :name => "root", :pass => "pwd" } }
             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",
@@ -256,12 +251,27 @@ describe UsersController do
 
           it "should allow nil when allow_nil is set to true" do
             post :create,
-                 :user => {
-                   :name => "root",
-                   :pass => "12345",
-                   :membership => "standard",
-                 },
-                 :facts => nil
+                 :params => {
+                   :user => {
+                     :name => "root",
+                     :pass => "12345",
+                     :membership => "standard",
+                   },
+                   :facts => { :test => 'test' }
+                 }
+            assert_response :success
+          end
+
+          it "should allow blank when allow_blank is set to true" do
+            post :create,
+              :params => {
+                :user => {
+                  :name => "root",
+                  :pass => "12345",
+                  :membership => "standard"
+                },
+                :age => ""
+              }
             assert_response :success
           end
 
@@ -270,7 +280,7 @@ describe UsersController do
             context "with valid input" do
               it "should succeed" do
                 put :update,
-                    {
+                    :params => {
                       :id => 5,
                       :user => {
                         :name => "root",
@@ -293,27 +303,27 @@ 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
             it "should work with empty array" do
               put :update,
-                  {
+                  :params => {
                     :id => 5,
                     :user => {
                       :name => "root",
@@ -525,7 +535,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 +545,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 +555,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 +563,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 +582,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,17 +706,20 @@ 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, :params => {: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
-      post :create, {:user => {:name => 'dummy', :pass => 'dummy', :membership => 'standard', :id => 0}}
+      post :create, :params => {:user => {:name => 'dummy', :pass => 'dummy', :membership => 'standard', :id => 0}}
 
       expect(assigns(:api_params).with_indifferent_access).to eq({:user => {:name=>"dummy", :pass=>"dummy", :membership=>"standard"}}.with_indifferent_access)
     end

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/concerns/sample_controller.rb

@@ -4,13 +4,13 @@ module Concerns
 
     api!
     def index
-      render :text => "OK #{params.inspect}"
+      render :plain => "OK #{params.inspect}"
     end
 
     api :GET, '/:resource_id/:id'
     param :id, String
     def show
-      render :text => "OK #{params.inspect}"
+      render :plain => "OK #{params.inspect}"
     end
 
     def_param_group :concern do
@@ -23,19 +23,19 @@ module Concerns
     api :POST, '/:resource_id', "Create a :concern"
     param_group :concern
     def create
-      render :text => "OK #{params.inspect}"
+      render :plain => "OK #{params.inspect}"
     end
 
     api :PUT, '/:resource_id/:id'
     param :id, String
     param_group :concern
     def update
-      render :text => "OK #{params.inspect}"
+      render :plain => "OK #{params.inspect}"
     end
 
     api :GET, '/:resource_id/:custom_subst'
     def custom
-      render :text => "OK #{params.inspect}"
+      render :plain => "OK #{params.inspect}"
     end
   end
 end

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

@@ -192,15 +192,15 @@ class UsersController < ApplicationController
   end
   def show
     unless params[:session] == "secret_hash"
-      render :text => "Not authorized", :status => 401
+      render :plain => "Not authorized", :status => 401
       return
     end
 
     unless params[:id].to_i == 5
-      render :text => "Not Found", :status => 404 and return
+      render :plain => "Not Found", :status => 404 and return
     end
 
-    render :text => "OK"
+    render :plain => "OK"
   end
 
   def_param_group :credentials do
@@ -221,8 +221,9 @@ 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}"
+    render :plain => "OK #{params.inspect}"
   end
 
   api :PUT, "/users/:id", "Update an user"
@@ -231,13 +232,13 @@ class UsersController < ApplicationController
     param :comment, String
   end
   def update
-    render :text => "OK #{params.inspect}"
+    render :plain => "OK #{params.inspect}"
   end
 
   api :POST, "/users/admin", "Create admin user"
   param_group :user, :as => :create
   def admin_create
-    render :text => "OK #{params.inspect}"
+    render :plain => "OK #{params.inspect}"
   end
 
   api :GET, "/users", "List users"
@@ -247,14 +248,14 @@ class UsersController < ApplicationController
   param :oauth, nil,
         :desc => "Hide this global param (eg dont need auth here)"
   def index
-    render :text => "List of users"
+    render :plain => "List of users"
   end
 
   api :GET, '/company_users', 'Get company users'
   api :GET, '/company/:id/users', 'Get users working in given company'
   param :id, Integer, :desc => "Company ID"
   def two_urls
-    render :text => 'List of users'
+    render :plain => 'List of users'
   end
 
   api :GET, '/users/see_another', 'Boring method'
@@ -263,14 +264,14 @@ class UsersController < ApplicationController
   see 'development#users#index', "very interesting method reference"
   desc 'This method is boring, look at users#create.  It is hidden from documentation.'
   def see_another
-    render :text => 'This is very similar to create action'
+    render :plain => 'This is very similar to create action'
   end
 
 
   api :GET, '/users/desc_from_file', 'desc from file'
   document 'users/desc_from_file.md'
   def desc_from_file
-    render :text => 'document from file action'
+    render :plain => 'document from file action'
   end
 
   api! 'Create user'

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

@@ -6,7 +6,7 @@ Apipie.configure do |config|
   # can be overriden in resource_description
   # by default is it 1.0 if not specified anywhere
   # this must be defined before api_base_url and app_info
-  config.default_version = "development"
+  config.default_version = "development".freeze
 
   config.doc_base_url = "/apidoc"
 

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,30 @@ require 'rspec/rails'
 
 require 'apipie-rails'
 
+module Rails4Compatibility
+  module Testing
+    def process(*args)
+      compatible_request(*args) { |*new_args| super(*new_args) }
+    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 +65,6 @@ RSpec.configure do |config|
   #     end
   config.infer_spec_type_from_file_location!
 end
+
+require 'action_controller/test_case.rb'
+ActionController::TestCase::Behavior.send(:prepend, Rails4Compatibility::Testing)