apipie-rails 0.9.2 → 0.9.3

data/CHANGELOG.md

@@ -4,10 +4,19 @@
 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.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/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/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)
@@ -388,11 +386,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

@@ -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]
@@ -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/extractor/recorder.rb

@@ -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

@@ -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/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/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

@@ -17,7 +17,7 @@ module Apipie
       :_path, :_name, :_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, resource_name, dsl_data = nil, version = nil)
 
       @_methods = ActiveSupport::OrderedHash.new
       @_params_args = []

data/lib/apipie/validator.rb

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+
 module Apipie
 
   module Validator
@@ -344,14 +345,12 @@ module Apipie
 
       def validate(value)
         return false if !value.is_a? Hash
-        if @hash_params
-          @hash_params.each do |k, p|
-            if Apipie.configuration.validate_presence?
-              raise ParamMissing.new(p) if p.required && !value.key?(k)
-            end
-            if Apipie.configuration.validate_value?
-              p.validate(value[k]) if value.key?(k)
-            end
+        @hash_params&.each do |k, p|
+          if Apipie.configuration.validate_presence?
+            raise ParamMissing.new(p) if p.required && !value.key?(k)
+          end
+          if Apipie.configuration.validate_value?
+            p.validate(value[k]) if value.key?(k)
           end
         end
         return true

data/lib/apipie/version.rb

@@ -1,3 +1,3 @@
 module Apipie
-  VERSION = "0.9.2"
+  VERSION = "0.9.3"
 end

data/lib/apipie-rails.rb

@@ -12,6 +12,7 @@ require "apipie/configuration"
 require "apipie/method_description"
 require "apipie/resource_description"
 require "apipie/param_description"
+require "apipie/param_description/deprecation"
 require "apipie/method_description/api"
 require "apipie/method_description/apis_service"
 require "apipie/errors"

data/lib/tasks/apipie.rake

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+
 require 'fileutils'
 
 namespace :apipie do

data/spec/controllers/users_controller_spec.rb

@@ -269,6 +269,7 @@ describe UsersController do
                                   :allow_blank => false,
                                   :metadata => nil,
                                   :show => true,
+                                  :deprecated => false,
                                   :expected_type => "hash",
                                   :validations => [])
           end
@@ -585,6 +586,7 @@ describe UsersController do
                      :description=>"\n<p>Authorization</p>\n",
                      :name=>"oauth",
                      :show=>true,
+                     :deprecated=>false,
                      :expected_type=>"string"},
                     {:validator=>"Must be a Hash",
                      :description=>"\n<p>Deprecated parameter not documented</p>\n",
@@ -595,15 +597,17 @@ describe UsersController do
                      :required=>false,
                      :full_name=>"legacy_param",
                      :show=>false,
+                     :deprecated=>false,
                      :params=>
                       [{:validator=>"Must be a Hash",
                         :description=>"\n<p>Param description for all methods</p>\n",
                         :expected_type=>"hash",
                         :allow_nil=>false,
-                       :allow_blank => false,
+                        :allow_blank => false,
                         :name=>"resource_param",
                         :required=>false,
                         :full_name=>"resource_param",
+                        :deprecated=>false,
                         :show=>true,
                         :params=>
                         [{:required=>true,
@@ -613,6 +617,7 @@ describe UsersController do
                           :description=>"\n<p>Username for login</p>\n",
                           :name=>"ausername", :full_name=>"resource_param[ausername]",
                           :show=>true,
+                          :deprecated=>false,
                           :expected_type=>"string"},
                          {:required=>true,
                           :allow_nil => false,
@@ -621,6 +626,7 @@ describe UsersController do
                           :description=>"\n<p>Password for login</p>\n",
                           :name=>"apassword", :full_name=>"resource_param[apassword]",
                           :show=>true,
+                          :deprecated=>false,
                           :expected_type=>"string"}
                         ]}
                       ]
@@ -631,6 +637,7 @@ describe UsersController do
                      :description=>"\n<p>Company ID</p>\n",
                      :name=>"id", :full_name=>"id",
                      :show=>true,
+                     :deprecated=>false,
                      :expected_type=>"numeric"},
        ],
         :name => 'two_urls',

data/spec/{controllers → lib/apipie}/apipies_controller_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 require 'fileutils'
 require "json-schema"
 
-describe Apipie::ApipiesController do
+describe Apipie::ApipiesController, type: :controller do
 
   describe "GET index" do
 
@@ -159,7 +159,7 @@ describe Apipie::ApipiesController do
   describe "GET index as swagger" do
 
     let(:swagger_schema) do
-      File.read(File.join(File.dirname(__FILE__),"../lib/swagger/openapi_2_0_schema.json"))
+      File.read("#{Rails.root.parent}/lib/swagger/openapi_2_0_schema.json")
     end
 
     it "outputs swagger when format is json and type is swagger" do

data/spec/lib/{application_spec.rb → apipie/application_spec.rb}

@@ -3,7 +3,10 @@ require "spec_helper"
 describe Apipie::Application do
 
   describe "api_controllers_paths" do
-    before { Apipie.configuration.api_controllers_matcher = [File.join(Rails.root, "app", "controllers", "**","*.rb"), File.join(Rails.root, "lib", "**","*.rb")] }
+    before do
+      Apipie.configuration.api_controllers_matcher = [File.join(Rails.root, "app", "controllers", "**","*.rb"),
+                                                      File.join(Rails.root, "lib", "**","*.rb")]
+    end
 
     it "should support receiving array as parameter" do
       expect { Apipie.api_controllers_paths}.
@@ -19,11 +22,11 @@ describe Apipie::Application do
     context "with namespaced_resources enabled" do
       before { Apipie.configuration.namespaced_resources = true }
       context "with a defined base url" do
-        
+
         it "should not overwrite the parent resource" do
           is_expected.not_to eq(Apipie.get_resource_name(Api::V2::ArchitecturesController))
         end
-        
+
       end
 
       context "with an undefined base url" do

data/spec/lib/apipie/configuration_spec.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'Apipie::Configuration' do
+  let(:configuration) { Apipie::Configuration.new }
+
+  describe '#api_action_matcher=' do
+    subject(:setter) { configuration.api_action_matcher = matcher }
+
+    let(:matcher) { proc { |_| :some_action } }
+
+    it { is_expected.to eq(matcher) }
+
+    context 'when matcher does not implement .call method' do
+      let(:matcher) { 'I do not implement .call' }
+
+      it 'raises and exception' do
+        expect { setter }.to raise_error('Must implement .call method')
+      end
+    end
+  end
+end

data/spec/lib/apipie/extractor/recorder_spec.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'Apipie::Extractor::Recorder' do
+  let(:recorder) { Apipie::Extractor::Recorder.new }
+
+  describe '#analyse_controller' do
+    subject do
+      recorder.analyse_controller(controller)
+      recorder.record[:action]
+    end
+
+    let(:action) { :show }
+
+    let(:request) do
+      request = ActionDispatch::Request.new({})
+      request.request_parameters = { action: action }
+      request
+    end
+
+    let(:controller) do
+      controller = ActionController::Metal.new
+      controller.set_request!(request)
+      controller
+    end
+
+    it { is_expected.to eq(action) }
+
+    context 'when a api_action_matcher is configured' do
+      let(:matcher_action) { "#{action}_from_new_matcher" }
+
+      before do
+        Apipie.configuration.api_action_matcher = proc { |_| matcher_action }
+      end
+
+      it { is_expected.to eq(matcher_action) }
+    end
+  end
+end

data/spec/lib/{method_description_spec.rb → apipie/method_description_spec.rb}

@@ -58,12 +58,12 @@ describe Apipie::MethodDescription do
 
     it "should be ordered" do
       expect(@method.params.keys).to eq([:a, :b, :c])
-      expect(@method.to_json[:params].map{|h| h[:name]}).to eq(['a', 'b', 'c'])
+      expect(@method.to_json[:params].map { |h| h[:name] }).to eq(['a', 'b', 'c'])
     end
 
     it "should be still ordered" do
       expect(@method.params.keys).to eq([:a, :b, :c])
-      expect(@method.to_json[:params].map{|h| h[:name]}).to eq(['a', 'b', 'c'])
+      expect(@method.to_json[:params].map { |h| h[:name] }).to eq(['a', 'b', 'c'])
     end
 
   end
@@ -80,7 +80,7 @@ describe Apipie::MethodDescription do
 
     it "should ignore response-only parameters" do
       expect(@method.params.keys).to eq([:a, :c])
-      expect(@method.to_json[:params].map{|h| h[:name]}).to eq(['a', 'c'])
+      expect(@method.to_json[:params].map { |h| h[:name] }).to eq(['a', 'c'])
     end
   end
 
@@ -90,7 +90,7 @@ describe Apipie::MethodDescription do
       @resource = Apipie::ResourceDescription.new(ApplicationController, "dummy")
       dsl_data[:returns] = { 200 => [{:param_group => 'pet', :array_of => 'pet'}, nil, nil] }
 
-      expect {Apipie::MethodDescription.new(:a, @resource, dsl_data)}.to raise_error(Apipie::ReturnsMultipleDefinitionError)
+      expect { Apipie::MethodDescription.new(:a, @resource, dsl_data) }.to raise_error(Apipie::ReturnsMultipleDefinitionError)
     end
   end
 

data/spec/lib/apipie/param_description/deprecation_spec.rb

@@ -0,0 +1,31 @@
+require "spec_helper"
+
+describe Apipie::ParamDescription::Deprecation do
+  let(:info) { nil }
+  let(:deprecated_in) { nil }
+  let(:sunset_at) { nil }
+
+  let(:deprecation) do
+    described_class.new(
+      info: info,
+      deprecated_in: deprecated_in,
+      sunset_at: sunset_at
+    )
+  end
+
+  describe '#to_json' do
+    subject { deprecation.to_json }
+
+    it { is_expected.to eq({ info: nil, deprecated_in: nil, sunset_at: nil }) }
+
+    context 'when attributes are given' do
+      let(:info) { 'info' }
+      let(:deprecated_in) { '2.3' }
+      let(:sunset_at) { '3.0' }
+
+      it 'returns the correct attributes' do
+        expect(subject).to eq({ info: info, deprecated_in: deprecated_in, sunset_at: sunset_at })
+      end
+    end
+  end
+end