apipie-rails 0.9.2 → 0.9.4

data/CHANGELOG.md

@@ -4,10 +4,25 @@
 Also deleted the `Gemfile` that was now a broken symlink.
 please use `export BUNDLE_GEMFILE='gemfiles/Gemfile.rails61'; bundle exec rspec` to run the test suite
 
+## [v0.9.4](https://github.com/Apipie/apipie-rails/tree/v0.9.4) (2023-04-11)
+[Full Changelog](https://github.com/Apipie/apipie-rails/compare/v0.9.3...v0.9.4)
+* [Fix] Separate nested resource name [#855](https://github.com/Apipie/apipie-rails/pull/855)[#455](https://github.com/Apipie/apipie-rails/issues/455) (Panos Dalitsouris)
+* [Rubocop] Disable a few Rubocop Rules, run Rubocop with ruby 3.2 [#851](https://github.com/Apipie/apipie-rails/pull/851)[#853](https://github.com/Apipie/apipie-rails/pull/853)[#840](https://github.com/Apipie/apipie-rails/pull/840)[#841](https://github.com/Apipie/apipie-rails/pull/841) (Panos Dalitsouris)
+* [Rubocop] More Rubocop Auto corrections [#858](https://github.com/Apipie/apipie-rails/pull/858)[#849](https://github.com/Apipie/apipie-rails/pull/849)[#850](https://github.com/Apipie/apipie-rails/pull/850)[#844](https://github.com/Apipie/apipie-rails/pull/844)[#846](https://github.com/Apipie/apipie-rails/pull/846)[#834](https://github.com/Apipie/apipie-rails/pull/834)[#847](https://github.com/Apipie/apipie-rails/pull/847) (Rubocop Challenger)
+
+## [v0.9.3](https://github.com/Apipie/apipie-rails/tree/v0.9.3) (2023-03-08)
+[Full Changelog](https://github.com/Apipie/apipie-rails/compare/v0.9.2...v0.9.3)
+* [Feature] Allow Apipie::ParamDescription to be marked as deprecated [#819](https://github.com/Apipie/apipie-rails/pull/819)[#811](https://github.com/Apipie/apipie-rails/pull/811) (Panos Dalitsouris)
+* [Fix] Make html markup thread safe ([#822](https://github.com/Apipie/apipie-rails/issues/822)) (Adam Růžička)
+* [Feature] Allow action matcher strategy to be configured [#821](https://github.com/Apipie/apipie-rails/pull/821) (Panos Dalitsouris)
+* [CI] Run Rubocop when opening PR [#826](https://github.com/Apipie/apipie-rails/pull/826) (Panos Dalitsouris)
+* [CI] Green rubocop - Fix after rubocop challenger upgrade [#829](https://github.com/Apipie/apipie-rails/pull/829) (Mathieu Jobin)
+* [Rubocop] More Rubocop Auto corrections [#818](https://github.com/Apipie/apipie-rails/pull/818)[#825](https://github.com/Apipie/apipie-rails/pull/825)[#827](https://github.com/Apipie/apipie-rails/pull/827)[#837](https://github.com/Apipie/apipie-rails/pull/837)[#839](https://github.com/Apipie/apipie-rails/pull/839) (Rubocop Challenger)
+
 ## [v0.9.2](https://github.com/Apipie/apipie-rails/tree/v0.9.2) (2023-02-07)
 [Full Changelog](https://github.com/Apipie/apipie-rails/compare/v0.9.1...v0.9.2)
 * [Rubocop] More Rubocop Auto corrections [#795](https://github.com/Apipie/apipie-rails/pull/795)[#781](https://github.com/Apipie/apipie-rails/pull/781)[#791](https://github.com/Apipie/apipie-rails/pull/791)[#788](https://github.com/Apipie/apipie-rails/pull/788) (Rubocop Challenger)
-* [Fix] Can't include translation in full description ([#446](https://github.com/Apipie/apipie-rails/issues/446)) [#808](https://github.com/Apipie/apipie-rails/pull/808)( Peter Nagy)
+* [Fix] Can't include translation in full description ([#446](https://github.com/Apipie/apipie-rails/issues/446)) [#808](https://github.com/Apipie/apipie-rails/pull/808) (Peter Nagy)
 * [Refactor] Move swagger param description creation [#810](https://github.com/Apipie/apipie-rails/pull/810) (Panos Dalitsouris)
 * [Rubocop] Redo rubocop TODOs, set HashSyntax config to most used style [#814](https://github.com/Apipie/apipie-rails/pull/814) (Mathieu Jobin)
 * [Fix] Swagger missing i18n [#815](https://github.com/Apipie/apipie-rails/pull/815) (@jirubio)

data/README.rst

@@ -355,6 +355,22 @@ Example:
      #...
    end
 
+deprecated
+  Indicates if the parameter is marked as deprecated.
+
+Example
+~~~~~~~~
+
+.. code:: ruby
+
+   param :pet_name, String, desc: "Name of pet", deprecated: true
+   param :pet_name, String, desc: "Name of pet", deprecated: 'Some deprecation info'
+   param :pet_name, String, desc: "Name of pet", deprecated: { in: "2.3", info: "Something", sunset: "3.0" }
+   def create
+     #...
+   end
+
+
 DRY with param_group
 --------------------
 
@@ -982,6 +998,9 @@ reload_controllers
 api_controllers_matcher
   For reloading to work properly you need to specify where your API controllers are. Can be an array if multiple paths are needed
 
+api_action_matcher
+  Determines the strategy to identity the correct controller action. Needs to be a class that implements a `.call(controller)` method
+
 api_routes
   Set if your application uses a custom API router, different from the Rails
   default
@@ -1063,6 +1082,7 @@ Example:
      config.markup = Apipie::Markup::Markdown.new
      config.reload_controllers = Rails.env.development?
      config.api_controllers_matcher = File.join(Rails.root, "app", "controllers", "**","*.rb")
+     config.api_action_matcher = proc { |controller| controller.params[:action] }
      config.api_routes = Rails.application.routes
      config.app_info["1.0"] = "
        This is where you can inform user about your application and API

data/apipie-rails.gemspec

@@ -1,4 +1,5 @@
 # -*- encoding: utf-8 -*-
+
 $:.push File.expand_path('lib', __dir__)
 require "apipie/version"
 
@@ -28,6 +29,9 @@ Gem::Specification.new do |s|
   s.add_development_dependency "rspec-rails", "~> 3.0"
   s.add_development_dependency "rake"
   s.add_development_dependency 'rubocop_challenger'
+  s.add_development_dependency 'rubocop-rails'
+  s.add_development_dependency 'rubocop-rspec'
+  s.add_development_dependency 'rubocop-performance'
   s.add_development_dependency "simplecov"
   s.add_development_dependency "sqlite3"
 end

data/app/controllers/apipie/apipies_controller.rb

@@ -155,7 +155,7 @@ module Apipie
     def render_from_cache
       path = Apipie.configuration.doc_base_url.dup
       # some params can contain dot, but only one in row
-      if [:resource, :method, :format, :version].any? { |p| params[p].to_s.gsub(".", "") =~ /\W/ || params[p].to_s =~ /\.\./ }
+      if [:resource, :method, :format, :version].any? { |p| params[p].to_s.gsub(".", "") =~ /\W/ || params[p].to_s.include?('..') }
         head :bad_request and return
       end
 
@@ -171,7 +171,7 @@ module Apipie
       # we sanitize the params before so in ideal case, this condition
       # will be never satisfied. It's here for cases somebody adds new
       # param into the path later and forgets about sanitation.
-      if path =~ /\.\./
+      if path.include?('..')
         head :bad_request and return
       end
 

data/app/helpers/apipie_helper.rb

@@ -1,7 +1,7 @@
 module ApipieHelper
   include ActionView::Helpers::TagHelper
 
-  def heading(title, level=1)
+  def heading(title, level = 1)
     content_tag("h#{level}") do
       title
     end

data/app/views/apipie/apipies/_deprecation.html.erb

@@ -0,0 +1,16 @@
+<% if deprecation.present? %>
+  <strong><%= t('apipie.deprecation_details') %></strong>
+  <ul>
+    <% if deprecation[:deprecated_in].present? %>
+      <li><%= t('apipie.deprecation.attributes.deprecated_in') %>: <%= deprecation[:deprecated_in] %></li>
+    <% end %>
+
+    <% if deprecation[:sunset_at].present? %>
+      <li><%= t('apipie.deprecation.attributes.sunset_at') %>: <%= deprecation[:sunset_at] %></li>
+    <% end %>
+
+    <% if deprecation[:info].present? %>
+      <li><%= t('apipie.deprecation.attributes.info') %>: <%= deprecation[:info] %></li>
+    <% end %>
+  </ul>
+<% end %>

data/app/views/apipie/apipies/_params.html.erb

@@ -7,7 +7,11 @@
   <% end %>
   <tr style='background-color:rgb(<%= "#{col},#{col},#{col}" %>);'>
     <td>
-      <strong><%= param[:full_name] %> </strong><br>
+      <strong><%= param[:full_name] %></strong>
+      <% if param[:deprecated].present? %>
+        <code><%= t('apipie.deprecated').upcase %></code>
+      <% end %>
+      <br>
       <small>
         <%= param[:required] ? t('apipie.required') : t('apipie.optional') %>
         <%= param[:allow_nil] ? ', '+t('apipie.nil_allowed') : '' %>
@@ -29,6 +33,8 @@
         </ul>
       <%- end %>
 
+      <%= render partial: 'deprecation', locals: { deprecation: param[:deprecation] } %>
+
       <% unless param[:metadata].blank? %>
         <br>
         Metadata:

data/config/locales/en.yml

@@ -30,3 +30,10 @@ en:
     headers: Headers
     header_name: Header name
     code: Code
+    deprecated: Deprecated
+    deprecation_details: Deprecation details
+    deprecation:
+      attributes:
+        deprecated_in: Deprecated in
+        sunset_at: Sunset at
+        info: Info

data/lib/apipie/apipie_module.rb

@@ -13,7 +13,7 @@ module Apipie
     app.to_json(version, resource_name, method_name, lang)
   end
 
-  def self.to_swagger_json(version = nil, resource_name = nil, method_name = nil, lang = nil, clear_warnings=true)
+  def self.to_swagger_json(version = nil, resource_name = nil, method_name = nil, lang = nil, clear_warnings = true)
     version ||= Apipie.configuration.default_version
     app.to_swagger_json(version, resource_name, method_name, lang, clear_warnings)
   end
@@ -24,7 +24,7 @@ module Apipie
     app.json_schema_for_method_response(version, controller_name, method_name, return_code, allow_nulls)
   end
 
-  def self.json_schema_for_self_describing_class(cls, allow_nulls=true)
+  def self.json_schema_for_self_describing_class(cls, allow_nulls = true)
     app.json_schema_for_self_describing_class(cls, allow_nulls)
   end
 

data/lib/apipie/application.rb

@@ -181,9 +181,7 @@ module Apipie
       else
         raise ArgumentError.new("Resource #{resource_name} does not exists.")
       end
-      unless resource_description.nil?
-        resource_description.method_description(method_name.to_sym)
-      end
+      resource_description&.method_description(method_name.to_sym)
     end
     alias [] get_method_description
 
@@ -242,7 +240,7 @@ module Apipie
 
     # initialize variables for gathering dsl data
     def init_env
-      @resource_descriptions = HashWithIndifferentAccess.new { |h, version| h[version] = {} }
+      @resource_descriptions = ActiveSupport::HashWithIndifferentAccess.new { |h, version| h[version] = {} }
       @controller_to_resource_id = {}
       @param_groups = {}
       @swagger_generator = Apipie::SwaggerGenerator.new(self)
@@ -270,7 +268,7 @@ module Apipie
       @swagger_generator.json_schema_for_self_describing_class(cls, allow_nulls)
     end
 
-    def to_swagger_json(version, resource_name, method_name, lang, clear_warnings=false)
+    def to_swagger_json(version, resource_name, method_name, lang, clear_warnings = false)
       return unless valid_search_args?(version, resource_name, method_name)
 
       # if resource_name is blank, take just resources which have some methods because
@@ -377,8 +375,18 @@ module Apipie
         @controller_to_resource_id[klass]
       elsif Apipie.configuration.namespaced_resources? && klass.respond_to?(:controller_path)
         return nil if klass == ActionController::Base
+
+        version_prefix = version_prefix(klass)
         path = klass.controller_path
-        path.gsub(version_prefix(klass), "").gsub("/", "-")
+
+        path =
+          if version_prefix == '/'
+            path
+          else
+            path.gsub(version_prefix, '')
+          end
+
+        path.gsub('/', '-')
       elsif klass.respond_to?(:controller_name)
         return nil if klass == ActionController::Base
         klass.controller_name
@@ -388,11 +396,11 @@ module Apipie
     end
 
     def locale
-      Apipie.configuration.locale.call(nil) if Apipie.configuration.locale
+      Apipie.configuration.locale&.call(nil)
     end
 
     def locale=(locale)
-      Apipie.configuration.locale.call(locale) if Apipie.configuration.locale
+      Apipie.configuration.locale&.call(locale)
     end
 
     def translate(str, locale)

data/lib/apipie/configuration.rb

@@ -27,6 +27,16 @@ module Apipie
     #   "#{Rails.root}/app/controllers/api/*.rb"
     attr_accessor :api_controllers_matcher
 
+    # An object that responds to a `.call(controller)` method responsible for
+    # matching the correct controller action
+    attr_reader :api_action_matcher
+
+    def api_action_matcher=(callable)
+      raise 'Must implement .call method' unless callable.respond_to?(:call)
+
+      @api_action_matcher = callable
+    end
+
     # set to true if you want to reload the controllers at each refresh of the
     # documentation. It requires +:api_controllers_matcher+ to be set to work
     # properly.
@@ -147,7 +157,7 @@ module Apipie
     def initialize
       @markup = Apipie::Markup::RDoc.new
       @app_name = "Another API"
-      @app_info = HashWithIndifferentAccess.new
+      @app_info = ActiveSupport::HashWithIndifferentAccess.new
       @copyright = nil
       @validate = :implicitly
       @validate_value = true
@@ -155,7 +165,8 @@ module Apipie
       @validate_key = false
       @action_on_non_validated_keys = :raise
       @required_by_default = false
-      @api_base_url = HashWithIndifferentAccess.new
+      @api_base_url = ActiveSupport::HashWithIndifferentAccess.new
+      @api_action_matcher = proc { |controller| controller.params[:action] }
       @doc_base_url = "/apipie"
       @layout = "apipie/apipie"
       @disqus_shortname = nil

data/lib/apipie/dsl_definition.rb

@@ -96,7 +96,7 @@ module Apipie
       #   # load paths from routes and don't provide description
       #   api
       #
-      def api(method, path, desc = nil, options={}) #:doc:
+      def api(method, path, desc = nil, options = {}) #:doc:
         return unless Apipie.active_dsl?
         _apipie_dsl_data[:api] = true
         _apipie_dsl_data[:api_args] << [method, path, desc, options]
@@ -105,7 +105,7 @@ module Apipie
       #   # load paths from routes
       #   api! "short description",
       #
-      def api!(desc = nil, options={}) #:doc:
+      def api!(desc = nil, options = {}) #:doc:
         return unless Apipie.active_dsl?
         _apipie_dsl_data[:api] = true
         _apipie_dsl_data[:api_from_routes] = { :desc => desc, :options =>options }
@@ -145,7 +145,7 @@ module Apipie
       # EOS
       def resource_description(options = {}, &block) #:doc:
         return unless Apipie.active_dsl?
-        raise ArgumentError, "Block expected" unless block_given?
+        raise ArgumentError, "Block expected" unless block
 
         dsl_data = ResourceDescriptionDsl.eval_dsl(self, &block)
         versions = dsl_data[:api_versions]
@@ -218,7 +218,7 @@ module Apipie
       #     puts "hello world"
       #   end
       #
-      def error(code_or_options, desc=nil, options={}) #:doc:
+      def error(code_or_options, desc = nil, options = {}) #:doc:
         return unless Apipie.active_dsl?
         _apipie_dsl_data[:errors] << [code_or_options, desc, options]
       end
@@ -403,7 +403,7 @@ module Apipie
       #     render json: {user: {name: "Alfred"}}
       #   end
       #
-      def returns(pgroup_or_options, desc_or_options=nil, options={}, &block) #:doc:
+      def returns(pgroup_or_options, desc_or_options = nil, options = {}, &block) #:doc:
         return unless Apipie.active_dsl?
 
 
@@ -508,7 +508,7 @@ module Apipie
       end
 
       def _apipie_update_meta(method_desc, dsl_data)
-        return unless dsl_data[:meta] && dsl_data[:meta].is_a?(Hash)
+        return unless dsl_data[:meta].is_a?(Hash)
 
         method_desc.metadata ||= {}
         method_desc.metadata.merge!(dsl_data[:meta])

data/lib/apipie/error_description.rb

@@ -10,7 +10,7 @@ module Apipie
                                    options)
     end
 
-    def initialize(code_or_options, desc=nil, options={})
+    def initialize(code_or_options, desc = nil, options = {})
       if code_or_options.is_a? Hash
         code_or_options.symbolize_keys!
         @code = code_or_options[:code]

data/lib/apipie/errors.rb

@@ -60,27 +60,13 @@ module Apipie
 
   class ResponseDoesNotMatchSwaggerSchema < Error
     def initialize(controller_name, method_name, response_code, error_messages, schema, returned_object)
-      @controller_name = controller_name
-      @method_name = method_name
-      @response_code = response_code
-      @error_messages = error_messages
-      @schema = schema
-      @returned_object = returned_object
-    end
-
-    def to_s
-      "Response does not match swagger schema (#{@controller_name}##{@method_name} #{@response_code}): #{@error_messages}\nSchema: #{JSON(@schema)}\nReturned object: #{@returned_object}"
+      super("Response does not match swagger schema (#{controller_name}##{method_name} #{response_code}): #{error_messages}\nSchema: #{JSON(schema)}\nReturned object: #{returned_object}")
     end
   end
 
   class NoDocumentedMethod < Error
     def initialize(controller_name, method_name)
-      @method_name = method_name
-      @controller_name = controller_name
-    end
-
-    def to_s
-      "There is no documented method #{@controller_name}##{@method_name}"
+      super("There is no documented method #{controller_name}##{method_name}")
     end
   end
 end

data/lib/apipie/extractor/collector.rb

@@ -96,7 +96,7 @@ module Apipie
       end
 
       def add_routes_info(desc)
-        api_prefix = Apipie.api_base_url.sub(/\/$/,"")
+        api_prefix = Apipie.api_base_url.sub(%r{/$},"")
         desc[:api] = Apipie::Extractor.apis_from_routes[[desc[:controller].name, desc[:action]]]
         if desc[:api]
           desc[:params].each do |name, param|

data/lib/apipie/extractor/recorder.rb

@@ -9,7 +9,7 @@ module Apipie
 
       def analyse_env(env)
         @verb = env["REQUEST_METHOD"].to_sym
-        @path = env["PATH_INFO"].sub(/^\/*/,"/")
+        @path = env["PATH_INFO"].sub(%r{^/*},"/")
         @query = env["QUERY_STRING"] unless env["QUERY_STRING"].blank?
         @params = Rack::Utils.parse_nested_query(@query)
         @params.merge!(env["action_dispatch.request.request_parameters"] || {})
@@ -24,7 +24,7 @@ module Apipie
 
       def analyse_controller(controller)
         @controller = controller.class
-        @action = controller.params[:action]
+        @action = Apipie.configuration.api_action_matcher.call(controller)
       end
 
       def analyse_response(response)

data/lib/apipie/extractor.rb

@@ -81,7 +81,7 @@ module Apipie
       def apis_from_routes
         return @apis_from_routes if @apis_from_routes
 
-        @api_prefix = Apipie.api_base_url.sub(/\/$/,"")
+        @api_prefix = Apipie.api_base_url.sub(%r{/$},"")
         populate_api_routes
         update_api_descriptions
 
@@ -157,7 +157,7 @@ module Apipie
           method_key = "#{Apipie.get_resource_name(controller.safe_constantize || next)}##{action}"
           old_apis = apis_from_docs[method_key] || []
           new_apis.each do |new_api|
-            new_api[:path].sub!(/\(\.:format\)$/,"") if new_api[:path]
+            new_api[:path]&.sub!(/\(\.:format\)$/,"")
             old_api = old_apis.find do |api|
               api[:path] == "#{@api_prefix}#{new_api[:path]}"
             end

data/lib/apipie/generator/swagger/operation_id.rb

@@ -37,7 +37,7 @@ class Apipie::Generator::Swagger::OperationId
   #
   # @return [String]
   def path
-    @path.gsub(/\//, '_').gsub(/:(\w+)/, '\1').gsub(/_$/, '')
+    @path.gsub(%r{/}, '_').gsub(/:(\w+)/, '\1').gsub(/_$/, '')
   end
 
   # Converts an http method like `GET` to `get` Using lowercase http method,

data/lib/apipie/helpers.rb

@@ -25,10 +25,10 @@ module Apipie
         @url_prefix << request_script_name
         @url_prefix << Apipie.configuration.doc_base_url
       end
-      path = path.sub(/^\//,"")
+      path = path.sub(%r{^/},"")
       ret = "#{@url_prefix}/#{path}"
-      ret.insert(0,"/") unless ret =~ /\A[.\/]/
-      ret.sub!(/\/*\Z/,"")
+      ret.insert(0,"/") unless ret =~ %r{\A[./]}
+      ret.sub!(%r{/*\Z},"")
       ret
     end
 

data/lib/apipie/markup.rb

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

data/lib/apipie/method_description.rb

@@ -159,7 +159,7 @@ module Apipie
       @formats || @resource._formats
     end
 
-    def to_json(lang=nil)
+    def to_json(lang = nil)
       {
         :doc_url => doc_url,
         :name => @method,

data/lib/apipie/param_description/deprecation.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Apipie
+  class ParamDescription
+    # Data transfer object, used when param description is deprecated
+    class Deprecation
+      attr_reader :info, :deprecated_in, :sunset_at
+
+      def initialize(info: nil, deprecated_in: nil, sunset_at: nil)
+        @info = info
+        @deprecated_in = deprecated_in
+        @sunset_at = sunset_at
+      end
+
+      def to_json(*_args)
+        {
+          info: @info,
+          deprecated_in: @deprecated_in,
+          sunset_at: @sunset_at
+        }
+      end
+    end
+  end
+end

data/lib/apipie/param_description.rb

@@ -97,6 +97,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?
@@ -155,17 +156,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
@@ -279,6 +288,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

@@ -14,27 +14,25 @@ module Apipie
   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)
 
       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]
+      @_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] || ""
@@ -61,6 +59,11 @@ module Apipie
       @_api_base_url || @_parent.try(:_api_base_url) || Apipie.api_base_url(_version)
     end
 
+    def name
+      @name ||= @_resource_name.presence || @_id.split('-').map(&:capitalize).join('::')
+    end
+    alias _name name
+
     def add_method_description(method_description)
       Apipie.debug "@resource_descriptions[#{self._version}][#{self._name}]._methods[#{method_description.method}] = #{method_description}"
       @_methods[method_description.method.to_sym] = method_description
@@ -108,7 +111,7 @@ 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.markup_to_html(Apipie.app.translate(@_full_description, lang)),
         :version => _version,

data/lib/apipie/response_description.rb

@@ -118,7 +118,7 @@ module Apipie
     end
     alias allow_additional_properties additional_properties
 
-    def to_json(lang=nil)
+    def to_json(lang = nil)
       {
           :code => code,
           :description => Apipie.app.translate(description, lang),