apipie-rails 0.7.0 → 0.8.2

data/config/locales/ko.yml

@@ -0,0 +1,31 @@
+ko:
+  apipie:
+    resources: 리소스
+    resource: 리소스
+    description: 설명
+    no_docs_found: 문서를 찾을 수 없습니다.
+    no_docs_found_descr: 해당 API에 대한 문서를 찾을 수 없습니다.
+    follow_instructions_html: 해당 컨트롤러의 설명을 %{href}를 따르세요.
+    follow_instructions_href: 자세한 설명
+    oops: 이런!!
+    resource_not_found_html: "%{resource} 리소스를 찾을 수 없습니다."
+    method_not_found_html: "%{resource} 리소스에 대한 %{method} 메소드를 찾을 수 없습니다."
+    goto_homepage_html: "%{href}로 시도해보세요."
+    goto_homepage_href: "%{app_name} API 문서 페이지"
+    required: 필수
+    optional: 옵션
+    nil_allowed: nil 허용
+    param_name: Param 이름
+    params: Params
+    examples: 예시
+    metadata: Metadata
+    errors: 에러
+    error_code: 코드
+    error_description: 설명
+    error_metadata: Metadata
+    supported_formats: 지원 포멧
+    enable_javascript_html: "%{comments_href}를 보기 위해서 JavaScript를 허용해주세요."
+    comments_powered_by_disqus: comments powered by %{disqus}
+    api_documentation: API 문서
+    headers: 헤더
+    header_name: 헤더 이름

data/gemfiles/Gemfile.rails70

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

data/lib/apipie/application.rb

@@ -40,8 +40,10 @@ module Apipie
       flatten_routes = []
 
       route_set.routes.each do |route|
-        # 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
+        # route is_a ActionDispatch::Journey::Route
+        # route.app is_a ActionDispatch::Routing::Mapper::Constraints
+        # route.app.app is_a TestEngine::Engine
+        route_app = route.app.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)))
@@ -456,10 +458,10 @@ module Apipie
     # as this would break loading of the controllers.
     def rails_mark_classes_for_reload
       unless Rails.application.config.cache_classes
-        Rails::VERSION::MAJOR == 4 ? ActionDispatch::Reloader.cleanup! : Rails.application.reloader.reload!
+        Rails.application.reloader.reload!
         init_env
         reload_examples
-        Rails::VERSION::MAJOR == 4 ? ActionDispatch::Reloader.prepare! : Rails.application.reloader.prepare!
+        Rails.application.reloader.prepare!
       end
     end
 

data/lib/apipie/configuration.rb

@@ -5,13 +5,14 @@ module Apipie
       :markup, :disqus_shortname,
       :api_base_url, :doc_base_url, :required_by_default, :layout,
       :default_version, :debug, :version_in_url, :namespaced_resources,
-      :validate, :validate_value, :validate_presence, :validate_key, :authenticate, :doc_path,
+      :validate, :validate_value, :validate_presence, :validate_key, :action_on_non_validated_keys, :authenticate, :doc_path,
       :show_all_examples, :process_params, :update_checksum, :checksum_path,
       :link_extension, :record, :languages, :translate, :locale, :default_locale,
-      :persist_show_in_doc, :authorize,
+      :persist_show_in_doc, :authorize, :ignore_allow_blank_false,
       :swagger_include_warning_tags, :swagger_content_type_input, :swagger_json_input_uses_refs,
       :swagger_suppress_warnings, :swagger_api_host, :swagger_generate_x_computed_id_field,
-      :swagger_allow_additional_properties_in_response, :swagger_responses_use_refs
+      :swagger_allow_additional_properties_in_response, :swagger_responses_use_refs,
+      :swagger_schemes, :swagger_security_definitions, :swagger_global_security
 
     alias_method :validate?, :validate
     alias_method :required_by_default?, :required_by_default
@@ -152,6 +153,7 @@ module Apipie
       @validate_value = true
       @validate_presence = true
       @validate_key = false
+      @action_on_non_validated_keys = :raise
       @required_by_default = false
       @api_base_url = HashWithIndifferentAccess.new
       @doc_base_url = "/apipie"
@@ -159,6 +161,7 @@ module Apipie
       @disqus_shortname = nil
       @default_version = "1.0"
       @debug = false
+      @ignore_allow_blank_false = false
       @version_in_url = true
       @namespaced_resources = false
       @doc_path = "doc"
@@ -181,6 +184,9 @@ module Apipie
       @swagger_generate_x_computed_id_field = false
       @swagger_allow_additional_properties_in_response = false
       @swagger_responses_use_refs = true
+      @swagger_schemes = [:https]
+      @swagger_security_definitions = {}
+      @swagger_global_security = []
     end
   end
 end

data/lib/apipie/dsl_definition.rb

@@ -149,10 +149,10 @@ module Apipie
 
         dsl_data = ResourceDescriptionDsl.eval_dsl(self, &block)
         versions = dsl_data[:api_versions]
+        Apipie.set_controller_versions(self, versions)
         @apipie_resource_descriptions = versions.map do |version|
           Apipie.define_resource_description(self, version, dsl_data)
         end
-        Apipie.set_controller_versions(self, versions)
       end
     end
 
@@ -262,7 +262,9 @@ module Apipie
               if Apipie.configuration.validate_key?
                 params.reject{|k,_| %w[format controller action].include?(k.to_s) }.each_pair do |param, _|
                   # params allowed
-                  raise UnknownParam.new(param) if method_params.select {|_,p| p.name.to_s == param.to_s}.empty?
+                  if method_params.select {|_,p| p.name.to_s == param.to_s}.empty?
+                    self.class._apipie_handle_validate_key_error params, param
+                  end
                 end
               end
 
@@ -290,6 +292,15 @@ module Apipie
         end
       end
 
+      def _apipie_handle_validate_key_error params, param
+        if Apipie.configuration.action_on_non_validated_keys == :raise
+          raise UnknownParam, param
+        elsif Apipie.configuration.action_on_non_validated_keys == :skip
+          params.delete(param)
+          Rails.logger.warn(UnknownParam.new(param).to_s)
+        end
+      end
+
       def _apipie_save_method_params(method, params)
         @method_params ||= {}
         @method_params[method] = params

data/lib/apipie/extractor/recorder.rb

@@ -150,7 +150,7 @@ module Apipie
       end
 
       module FunctionalTestRecording
-        def process(*, **) # action, parameters = nil, session = nil, flash = nil, http_method = 'GET')
+        def process(*) # action, parameters = nil, session = nil, flash = nil, http_method = 'GET')
           ret = super
           if Apipie.configuration.record
             Apipie::Extractor.call_recorder.analyze_functional_test(self)

data/lib/apipie/extractor.rb

@@ -17,14 +17,8 @@ class Apipie::Railtie
     end
     app.middleware.use ::Apipie::Extractor::Recorder::Middleware
 
-    if Gem::Version.new(Rails.version) < Gem::Version.new('5.0.0')
-      ActionController::TestCase::Behavior.instance_eval do
-        prepend Apipie::Extractor::Recorder::FunctionalTestRecording
-      end
-    else
-      ActionController::TestCase.send(:prepend, Apipie::Extractor::Recorder::FunctionalTestRecording)
-      ActionController::TestCase::Behavior.send(:prepend, Apipie::Extractor::Recorder::FunctionalTestRecording)
-    end
+    ActionController::TestCase.send(:prepend, Apipie::Extractor::Recorder::FunctionalTestRecording)
+    ActionController::TestCase::Behavior.send(:prepend, Apipie::Extractor::Recorder::FunctionalTestRecording)
   end
 end
 

data/lib/apipie/param_description.rb

@@ -114,16 +114,20 @@ module Apipie
     end
 
     def validate(value)
-      return true if @allow_nil && value.nil?
-      return true if @allow_blank && value.blank?
+      return true if allow_nil && value.nil?
+      return true if allow_blank && value.blank?
       value = normalized_value(value)
-      if (!@allow_nil && value.nil?) || (!@allow_blank && value.blank?) || !@validator.valid?(value)
-        error = @validator.error
+      if (!allow_nil && value.nil?) || (blank_forbidden? && value.blank?) || !validator.valid?(value)
+        error = validator.error
         error = ParamError.new(error) unless error.is_a? StandardError
         raise error
       end
     end
 
+    def blank_forbidden?
+      !Apipie.configuration.ignore_allow_blank_false && !allow_blank && !validator.ignore_allow_blank?
+    end
+
     def process_value(value)
       value = normalized_value(value)
       if @validator.respond_to?(:process_value)

data/lib/apipie/rspec/response_validation_helper.rb

@@ -161,8 +161,8 @@ ActionController::TestCase::Behavior.instance_eval do
   # instrument the 'process' method in ActionController::TestCase to enable response validation
   module Apipie::ResponseValidationHelpers
     @is_response_validation_on = false
-    def process(*args)
-      result = super(*args)
+    def process(*, **)
+      result = super
       validate_response if @is_response_validation_on
 
       result

data/lib/apipie/swagger_generator.rb

@@ -73,7 +73,10 @@ module Apipie
           consumes: [],
           paths: {},
           definitions: {},
+          schemes: Apipie.configuration.swagger_schemes,
           tags: [],
+          securityDefinitions: Apipie.configuration.swagger_security_definitions,
+          security: Apipie.configuration.swagger_global_security
       }
 
       if Apipie.configuration.swagger_api_host
@@ -475,9 +478,16 @@ module Apipie
       end
 
       if swagger_def[:type] == "array"
-        swagger_def[:items] = {type: "string"}
-        enum = param_desc.options.fetch(:in, [])
+        array_of_validator_opts = param_desc.validator.param_description.options
+        items_type = array_of_validator_opts[:of].to_s || array_of_validator_opts[:array_of].to_s
+        if items_type == "Hash"
+          ref_name = "#{swagger_op_id_for_path(param_desc.method_description.apis.first.http_method, param_desc.method_description.apis.first.path)}_param_#{param_desc.name}"
+          swagger_def[:items] = {"$ref" => gen_referenced_block_from_params_array(ref_name, param_desc.validator.param_description.validator.params_ordered, allow_nulls)}
+        else
+          swagger_def[:items] = {type: "string"}
+        end
 
+        enum = param_desc.options.fetch(:in, [])
         swagger_def[:items][:enum] = enum if enum.any?
       end
 

data/lib/apipie/validator.rb

@@ -80,6 +80,10 @@ module Apipie
         'string'
       end
 
+      def ignore_allow_blank?
+        false
+      end
+
       def merge_with(other_validator)
         return self if self == other_validator
         raise NotImplementedError, "Don't know how to merge #{self.inspect} with #{other_validator.inspect}"
@@ -333,6 +337,7 @@ module Apipie
         @params_ordered ||= _apipie_dsl_data[:params].map do |args|
           options = args.find { |arg| arg.is_a? Hash }
           options[:parent] = self.param_description
+          options[:param_group] = @param_group
           Apipie::ParamDescription.from_dsl_data(param_description.method_description, args)
         end
       end
@@ -477,6 +482,10 @@ module Apipie
         string = %w(true false 1 0).map { |value| format_description_value(value) }.join(', ')
         "Must be one of: #{string}."
       end
+
+      def ignore_allow_blank?
+        true
+      end
     end
 
     class NestedValidator < BaseValidator

data/lib/apipie/version.rb

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

data/spec/controllers/included_param_group_controller_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+
+describe IncludedParamGroupController do
+
+  let(:dsl_data) { ActionController::Base.send(:_apipie_dsl_data_init) }
+
+  it "should not error when there is a param_group that is deeply nested in response description" do
+    subject = Apipie.get_resource_description(IncludedParamGroupController, Apipie.configuration.default_version)
+    expect(subject._methods.keys).to include(:show)
+  end
+
+end

data/spec/controllers/users_controller_spec.rb

@@ -124,6 +124,29 @@ describe UsersController do
           end
         end
 
+        context "key validations are enabled and skip on non-validated keys" do
+          before do
+            Apipie.configuration.validate_value = false
+            Apipie.configuration.validate_presence = true
+            Apipie.configuration.validate_key = true
+            Apipie.configuration.action_on_non_validated_keys = :skip
+          end
+
+          it "should reply to valid request" do
+            expect { get :show, :params => { :id => 5, :session => 'secret_hash' }}.not_to raise_error
+            assert_response :success
+          end
+
+          it "should delete the param and not fail if an extra parameter is passed." do
+            expect { get :show, :params => { :id => 5 , :badparam => 'badfoo', :session => "secret_hash" }}.not_to raise_error
+            expect(controller.params.as_json).to eq({"session"=>"secret_hash", "id"=>"5", "controller"=>"users", "action"=>"show"})
+          end
+
+          after do
+            Apipie.configuration.action_on_non_validated_keys = :raise
+          end
+        end
+
         context "presence and value validations are enabled" do
           before do
             Apipie.configuration.validate_value = true

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

@@ -3,6 +3,6 @@ class ConcernsController < ApplicationController
   resource_description { resource_id 'concern_resources' }
 
   apipie_concern_subst(:concern => 'user', :custom_subst => 'custom', 'string_subst' => 'string')
-  include ::Concerns::SampleController
+  include SampleController
 
 end

data/spec/dummy/app/controllers/{concerns/extending_concern.rb → extending_concern.rb}

@@ -1,4 +1,3 @@
-module Concerns
   module ExtendingConcern
     extend Apipie::DSL::Concern
 
@@ -9,4 +8,3 @@ module Concerns
       meta metadata: 'data'
     end
   end
-end

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

@@ -0,0 +1,19 @@
+class IncludedParamGroupController < ApplicationController
+  include RandomParamGroup
+
+  api :GET, '/included-param-group'
+  returns code:200 do
+    property :top_level, Array, of: Hash do
+      param_group :random_param_group
+    end
+    property :nested, Hash do
+      property :random_array, Array, of: Hash do
+        param_group :random_param_group
+      end
+    end
+  end
+  def show
+  end
+
+end
+

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

@@ -3,7 +3,7 @@ class OverriddenConcernsController < ApplicationController
   resource_description { resource_id 'overridden_concern_resources' }
 
   apipie_concern_subst(:concern => 'user')
-  include ::Concerns::SampleController
+  include SampleController
 
   def_param_group :concern do
     param :concern, String
@@ -11,7 +11,7 @@ class OverriddenConcernsController < ApplicationController
 
   api :PUT, '/:resource_id/:id'
   param :custom_parameter, String, "New parameter added by the overriding method"
-  param_group :concern, ::Concerns::SampleController
+  param_group :concern, SampleController
   def update
     super
   end

data/spec/dummy/app/controllers/{concerns/sample_controller.rb → sample_controller.rb}

@@ -1,4 +1,3 @@
-module Concerns
   module SampleController
     extend Apipie::DSL::Concern
 
@@ -38,4 +37,3 @@ module Concerns
       render :plain => "OK #{params.inspect}"
     end
   end
-end

data/spec/dummy/app/helpers/random_param_group.rb

@@ -0,0 +1,8 @@
+module RandomParamGroup
+  def self.included(klazz)
+    klazz.def_param_group :random_param_group do
+      property :id, Integer
+      property :name, String
+    end
+  end
+end

data/spec/dummy/config/application.rb

@@ -41,7 +41,7 @@ module Dummy
     config.filter_parameters += [:password]
 
     config.to_prepare do
-      ExtendedController.send(:include, Concerns::ExtendingConcern)
+      ExtendedController.send(:include, ExtendingConcern)
     end
   end
 end

data/spec/lib/param_description_spec.rb

@@ -113,6 +113,92 @@ describe Apipie::ParamDescription do
 
   end
 
+  describe 'validate' do
+    context 'when allow_blank is ignored, as it was before 0.7.0' do
+      before do
+        Apipie.configuration.ignore_allow_blank_false = true
+      end
+
+      context 'when the parameter is a boolean' do
+        it "should not throw an exception when passed false" do
+          expect { Apipie::ParamDescription.new(method_desc, :param, :boolean).validate(false) }.to_not raise_error
+        end
+
+        it "should throw an exception when passed an empty value" do
+          expect { Apipie::ParamDescription.new(method_desc, :param, :boolean).validate('') }.to raise_error(Apipie::ParamInvalid)
+        end
+      end
+
+      context 'when the parameter is a string' do
+        context 'when allow_blank is specified as true' do
+          it "should throw an exception when passed an empty value" do
+            expect { Apipie::ParamDescription.new(method_desc, :param, String, allow_blank: true).validate('') }.to_not raise_error
+          end
+        end
+        context 'when allow_blank is specified as false' do
+          it "should throw an exception when passed an empty value" do
+            expect { Apipie::ParamDescription.new(method_desc, :param, String, allow_blank: false).validate('') }.to_not raise_error
+          end
+        end
+        context 'when allow_blank is not specified' do
+          it "should throw an exception when passed an empty value" do
+            expect { Apipie::ParamDescription.new(method_desc, :param, String).validate('') }.to_not raise_error
+          end
+        end
+      end
+
+      after do
+        Apipie.configuration.ignore_allow_blank_false = false
+      end
+    end
+
+    context 'when the parameter is a boolean' do
+      it "should not throw an exception when passed false" do
+        expect { Apipie::ParamDescription.new(method_desc, :param, :boolean).validate(false) }.to_not raise_error
+      end
+
+      it "should still not throw an exception when passed false with explicit allow_blank: false" do
+        expect { Apipie::ParamDescription.new(method_desc, :param, :boolean, allow_blank: false).validate(false) }.to_not raise_error
+      end
+
+      it "should throw an exception when passed an empty value" do
+        expect { Apipie::ParamDescription.new(method_desc, :param, :boolean).validate('') }.to raise_error(Apipie::ParamInvalid)
+      end
+    end
+
+    context "when the parameter is a custom type with ignore_allow_blank? returning true" do
+      it "should not throw an exception when passed a blank but valid value" do
+        expect { Apipie::ParamDescription.new(method_desc, :param, :custom_bool).validate(false) }.to_not raise_error
+      end
+
+      it "should still not throw an exception when passed false with explicit allow_blank: false" do
+        expect { Apipie::ParamDescription.new(method_desc, :param, :custom_bool, allow_blank: false).validate(false) }.to_not raise_error
+      end
+
+      it "should throw an exception when passed an invalid but blank value" do
+        expect { Apipie::ParamDescription.new(method_desc, :param, :custom_bool).validate("") }.to raise_error(Apipie::ParamInvalid)
+      end
+    end
+
+    context 'when the parameter is a string' do
+      context 'when allow_blank is specified as true' do
+        it "should throw an exception when passed an empty value" do
+          expect { Apipie::ParamDescription.new(method_desc, :param, String, allow_blank: true).validate('') }.to_not raise_error
+        end
+      end
+      context 'when allow_blank is specified as false' do
+        it "should throw an exception when passed an empty value" do
+          expect { Apipie::ParamDescription.new(method_desc, :param, String, allow_blank: false).validate('') }.to raise_error(Apipie::ParamInvalid)
+        end
+      end
+      context 'when allow_blank is not specified' do
+        it "should throw an exception when passed an empty value" do
+          expect { Apipie::ParamDescription.new(method_desc, :param, String).validate('') }.to raise_error(Apipie::ParamInvalid)
+        end
+      end
+    end
+  end
+
   describe "concern substitution" do
 
     let(:concern_dsl_data) { dsl_data.merge(:from_concern => true) }

data/spec/spec_helper.rb

@@ -1,6 +1,10 @@
 require 'rubygems'
 require 'bundler/setup'
 
+require 'simplecov'
+SimpleCov.minimum_coverage 89
+SimpleCov.start
+
 ENV["RAILS_ENV"] ||= 'test'
 APIPIE_ROOT = File.expand_path('../..', __FILE__)
 require File.expand_path("../dummy/config/environment", __FILE__)
@@ -10,37 +14,6 @@ require 'rspec/rails'
 require 'apipie-rails'
 require 'test_engine'
 
-module Rails4Compatibility
-  module Testing
-    def process(*args)
-      compatible_request(*args) do |*new_args|
-        if Gem.ruby_version < Gem::Version.new('3.0.0')
-          super(*new_args)
-        else
-          super(new_args[0], **new_args[1])
-        end
-      end
-    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
-
-
 #
 # Matcher to validate the properties (name, type and options) of a single field in the
 # internal representation of a swagger schema
@@ -114,4 +87,3 @@ RSpec.configure do |config|
 end
 
 require 'action_controller/test_case.rb'
-ActionController::TestCase::Behavior.send(:prepend, Rails4Compatibility::Testing)

data/spec/support/custom_bool_validator.rb

@@ -0,0 +1,17 @@
+class CustomBoolValidator < Apipie::Validator::BaseValidator
+  def validate(value)
+    value.in?([true, false])
+  end
+
+  def self.build(param_description, argument, options, block)
+    new(param_description) if argument == :custom_bool
+  end
+
+  def description
+    "Must be a boolean."
+  end
+
+  def ignore_allow_blank?
+    true
+  end
+end