apipie-rails 0.5.19 → 1.3.0

data/lib/apipie/param_description.rb

@@ -12,9 +12,9 @@ module Apipie
     attr_reader :additional_properties, :is_array
     attr_accessor :parent, :required
 
-    alias_method :response_only?, :response_only
-    alias_method :request_only?, :request_only
-    alias_method :is_array?, :is_array
+    alias response_only? response_only
+    alias request_only? request_only
+    alias is_array? is_array
 
     def self.from_dsl_data(method_description, args)
       param_name, validator, desc_or_options, options, block = args
@@ -57,6 +57,10 @@ module Apipie
         @from_concern = @options[:param_group][:from_concern]
       end
 
+      if validator.is_a?(Hash)
+        @options.merge!(validator.select{|k,v| k != :array_of })
+      end
+
       @method_description = method_description
       @name = concern_subst(name)
       @as = options[:as] || @name
@@ -71,7 +75,7 @@ module Apipie
       @request_only = (@options[:only_in] == :request)
       raise ArgumentError.new("'#{@options[:only_in]}' is not a valid value for :only_in") if (!@response_only && !@request_only) && @options[:only_in].present?
 
-      @show = if @options.has_key? :show
+      @show = if @options.key? :show
         @options[:show]
       else
         true
@@ -85,9 +89,7 @@ module Apipie
       if validator
         if (validator != Hash) && (validator.is_a? Hash) && (validator[:array_of])
           @is_array = true
-          rest_of_options = validator
           validator = validator[:array_of]
-          options.merge!(rest_of_options.select{|k,v| k != :array_of })
           raise "an ':array_of =>' validator is allowed exclusively on response-only fields" unless @response_only
         end
         @validator = Validator::BaseValidator.find(self, validator, @options, block)
@@ -97,6 +99,7 @@ module Apipie
       @validations = Array(options[:validations]).map {|v| concern_subst(Apipie.markup_to_html(v)) }
 
       @additional_properties = @options[:additional_properties]
+      @deprecated = @options[:deprecated] || false
     end
 
     def from_concern?
@@ -114,16 +117,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?) || !@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)
@@ -151,17 +158,25 @@ module Apipie
     end
 
     def to_json(lang = nil)
-      hash = { :name => name.to_s,
-               :full_name => full_name,
-               :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,
-               :show => show,
-               :validations => validations }
+      hash = {
+        name: name.to_s,
+        full_name: full_name,
+        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,
+        show: show,
+        validations: validations,
+        deprecated: deprecated?
+      }
+
+      if deprecation.present?
+        hash[:deprecation] = deprecation.to_json
+      end
+
       if sub_params = validator.params_ordered
         hash[:params] = sub_params.map { |p| p.to_json(lang)}
       end
@@ -208,7 +223,7 @@ module Apipie
     # action awareness is being inherited from ancestors (in terms of
     # nested params)
     def action_aware?
-      if @options.has_key?(:action_aware)
+      if @options.key?(:action_aware)
         return @options[:action_aware]
       elsif @parent
         @parent.action_aware?
@@ -233,7 +248,7 @@ module Apipie
     # crate/update actions.
     def action_awareness
       if action_aware?
-        if !@options.has_key?(:allow_nil)
+        if !@options.key?(:allow_nil)
           if @required
             @allow_nil = false
           else
@@ -264,7 +279,7 @@ module Apipie
     end
 
     def is_required?
-      if @options.has_key?(:required)
+      if @options.key?(:required)
         if (@options[:required] == true) || (@options[:required] == false)
           @options[:required]
         else
@@ -275,6 +290,24 @@ module Apipie
       end
     end
 
+    def deprecated?
+      @deprecated.present?
+    end
+
+    def deprecation
+      return if @deprecated.blank? || @deprecated == true
+
+      case @deprecated
+      when Hash
+        Apipie::ParamDescription::Deprecation.new(
+          info: @deprecated[:info],
+          deprecated_in: @deprecated[:in],
+          sunset_at: @deprecated[:sunset]
+        )
+      when String
+        Apipie::ParamDescription::Deprecation.new(info: @deprecated)
+      end
+    end
   end
 
 end

data/lib/apipie/resource_description.rb

@@ -7,35 +7,35 @@ module Apipie
   # path - relative path (/api/articles)
   # methods - array of keys to Apipie.method_descriptions (array of Apipie::MethodDescription)
   # name - human readable alias of resource (Articles)
-  # id - resouce name
+  # id - resource name
   # formats - acceptable request/response format types
   # headers - array of headers
   # deprecated - boolean indicating if resource is deprecated
   class ResourceDescription
 
     attr_reader :controller, :_short_description, :_full_description, :_methods, :_id,
-      :_path, :_name, :_params_args, :_returns_args, :_tag_list_arg, :_errors_args,
+      :_path, :_params_args, :_returns_args, :_tag_list_arg, :_errors_args,
       :_formats, :_parent, :_metadata, :_headers, :_deprecated
 
-    def initialize(controller, resource_name, dsl_data = nil, version = nil, &block)
-
+    def initialize(controller, id, dsl_data = nil, version = nil)
       @_methods = ActiveSupport::OrderedHash.new
       @_params_args = []
       @_errors_args = []
       @_returns_args = []
 
       @controller = controller
-      @_id = resource_name
+      @_id = id
       @_version = version || Apipie.configuration.default_version
-      @_name = @_id.humanize
-      @_parent = Apipie.get_resource_description(controller.superclass, version)
+      @_parent = Apipie.value_from_parents(controller.superclass, version) do |parent, ver|
+        Apipie.get_resource_description(parent, ver)
+      end
 
       update_from_dsl_data(dsl_data) if dsl_data
     end
 
     def update_from_dsl_data(dsl_data)
-      @_name = dsl_data[:resource_name] if dsl_data[:resource_name]
-      @_full_description = Apipie.markup_to_html(dsl_data[:description])
+      @_resource_name = dsl_data[:resource_name] if dsl_data[:resource_name]
+      @_full_description = dsl_data[:description]
       @_short_description = dsl_data[:short_description]
       @_path = dsl_data[:path] || ""
       @_formats = dsl_data[:formats]
@@ -61,8 +61,22 @@ module Apipie
       @_api_base_url || @_parent.try(:_api_base_url) || Apipie.api_base_url(_version)
     end
 
+    def name
+      @name ||= case resource_name
+                when Proc
+          resource_name.call(controller)
+                when Symbol
+          controller.public_send(resource_name)
+                when String
+          resource_name
+        else
+          default_name
+        end
+    end
+    alias _name name
+
     def add_method_description(method_description)
-      Apipie.debug "@resource_descriptions[#{self._version}][#{self._name}]._methods[#{method_description.method}] = #{method_description}"
+      Apipie.debug "@resource_descriptions[#{self._version}][#{self._id}]._methods[#{method_description.method}] = #{method_description}"
       @_methods[method_description.method.to_sym] = method_description
     end
 
@@ -71,7 +85,7 @@ module Apipie
     end
 
     def remove_method_description(method_name)
-      if @_methods.has_key?(method_name)
+      if @_methods.key?(method_name)
         @_methods.delete(method_name)
       end
     end
@@ -87,7 +101,9 @@ module Apipie
       Apipie.full_url crumbs.join('/')
     end
 
-    def api_url; "#{Apipie.api_base_url(_version)}#{@_path}"; end
+    def api_url
+      "#{Apipie.api_base_url(_version)}#{@_path}"
+    end
 
     def valid_method_name?(method_name)
       @_methods.keys.map(&:to_s).include?(method_name.to_s)
@@ -108,9 +124,9 @@ module Apipie
         :doc_url => doc_url,
         :id => _id,
         :api_url => api_url,
-        :name => @_name,
+        :name => name,
         :short_description => Apipie.app.translate(@_short_description, lang),
-        :full_description => Apipie.app.translate(@_full_description, lang),
+        :full_description => Apipie.markup_to_html(Apipie.app.translate(@_full_description, lang)),
         :version => _version,
         :formats => @_formats,
         :metadata => @_metadata,
@@ -120,5 +136,17 @@ module Apipie
       }
     end
 
+    protected
+
+    def resource_name
+      @_resource_name.presence || @_parent&.resource_name
+    end
+
+    private
+
+    def default_name
+      @_id.split('-').map(&:capitalize).join('::')
+    end
+
   end
 end

data/lib/apipie/response_description.rb

@@ -116,12 +116,12 @@ module Apipie
     def additional_properties
       !!@response_object.additional_properties
     end
-    alias :allow_additional_properties :additional_properties
+    alias allow_additional_properties additional_properties
 
-    def to_json(lang=nil)
+    def to_json(lang = nil)
       {
           :code => code,
-          :description => description,
+          :description => Apipie.app.translate(description, lang),
           :is_array => is_array?,
           :returns_object => params_ordered.map{ |param| param.to_json(lang).tap{|h| h.delete(:validations) }}.flatten,
           :additional_properties => additional_properties,

data/lib/apipie/response_description_adapter.rb

@@ -1,6 +1,6 @@
 module Apipie
 
-  def self.prop(name, expected_type, options={}, sub_properties=[])
+  def self.prop(name, expected_type, options = {}, sub_properties = [])
     Apipie::ResponseDescriptionAdapter::PropDesc.new(name, expected_type, options, sub_properties)
   end
 
@@ -57,10 +57,10 @@ module Apipie
         attr_reader :expected_type
 
         def [](key)
-          return self.send(key) if self.respond_to?(key.to_s)
+          self.send(key) if self.respond_to?(key.to_s)
         end
 
-        def initialize(expected_type, enum_values=nil, sub_properties=nil)
+        def initialize(expected_type, enum_values = nil, sub_properties = nil)
           @expected_type = expected_type
           @enum_values = enum_values
           @is_enum = !!enum_values
@@ -84,7 +84,7 @@ module Apipie
       #======================================================================
 
 
-      def initialize(name, expected_type, options={}, sub_properties=[])
+      def initialize(name, expected_type, options = {}, sub_properties = [])
         @name = name
         @required = true
         @required = false if options[:required] == false
@@ -102,14 +102,15 @@ module Apipie
       end
 
       def [](key)
-        return self.send(key) if self.respond_to?(key.to_s)
+        self.send(key) if self.respond_to?(key.to_s)
       end
 
       def add_sub_property(prop_desc)
         raise "Only properties with expected_type 'object' can have sub-properties" unless @expected_type == 'object'
-        if prop_desc.is_a? PropDesc
+        case prop_desc
+        when PropDesc
           @sub_properties << prop_desc
-        elsif prop_desc.is_a? Modifier
+        when Modifier
           prop_desc.apply(self)
         else
           raise "Unrecognized prop_desc type (#{prop_desc.class})"
@@ -130,7 +131,7 @@ module Apipie
       attr_reader :name, :required, :expected_type, :options, :description
       attr_accessor :additional_properties
 
-      alias_method :desc, :description
+      alias desc description
 
       def is_array?
         @is_array
@@ -170,9 +171,10 @@ module Apipie
     end
 
     def add(prop_desc)
-      if prop_desc.is_a? PropDesc
+      case prop_desc
+      when PropDesc
         @property_descs << prop_desc
-      elsif prop_desc.is_a? Modifier
+      when Modifier
         prop_desc.apply(self)
       else
         raise "Unrecognized prop_desc type (#{prop_desc.class})"

data/lib/apipie/routing.rb

@@ -4,7 +4,7 @@ module Apipie
       def apipie(options = {})
         namespace "apipie", :path => Apipie.configuration.doc_base_url do
           get 'apipie_checksum', :to => "apipies#apipie_checksum", :format => "json"
-          constraints(:version => /[^\/]+/, :resource => /[^\/]+/, :method => /[^\/]+/) do
+          constraints(:version => %r{[^/]+}, :resource => %r{[^/]+}, :method => %r{[^/]+}) do
             get(options.reverse_merge("(:version)/(:resource)/(:method)" => "apipies#index", :as => :apipie))
           end
         end

data/lib/apipie/rspec/response_validation_helper.rb

@@ -112,7 +112,7 @@ class ActionController::Base
 end
 
 module Apipie
-  def self.print_validation_errors(validation_errors, schema, response, error_object=nil)
+  def self.print_validation_errors(validation_errors, schema, response, error_object = nil)
     Rails.logger.warn(validation_errors.to_s)
     if Rails.env.test?
       puts "schema validation errors:"
@@ -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/static_dispatcher.rb

@@ -4,12 +4,20 @@ module Apipie
     def initialize(root)
       @root          = root.chomp('/')
       @compiled_root = /^#{Regexp.escape(root)}/
-      @file_server   = ::Rack::File.new(@root)
+      @file_server   = if defined?(::Rack::Files)
+                         ::Rack::Files.new(@root)
+                       else
+                         # Deprecated in Rack 3.0, kept
+                         # for backward compatibility
+                         ::Rack::File.new(@root)
+                       end
     end
 
     def match?(path)
       # Replace all null bytes
-      path = ::Rack::Utils.unescape(path || '').gsub(/\x0/, '')
+      path = ::Rack::Utils.unescape(path || '')
+                          .encode(Encoding::UTF_8, invalid: :replace, replace: '')
+                          .gsub("\x0", '')
 
       full_path = path.empty? ? @root : File.join(@root, path)
       paths = "#{full_path}#{ext}"