apipie-rails 0.9.2 → 0.9.4

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
 
@@ -60,7 +60,7 @@ module Apipie
           return 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

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:"

data/lib/apipie/swagger_generator.rb

@@ -33,7 +33,7 @@ module Apipie
     end
 
 
-    def generate_from_resources(version, resources, method_name, lang, clear_warnings=false)
+    def generate_from_resources(version, resources, method_name, lang, clear_warnings = false)
       init_swagger_vars(version, lang, clear_warnings)
 
       @only_method = method_name
@@ -48,7 +48,7 @@ module Apipie
     # Initialization
     #--------------------------------------------------------------------------
 
-    def init_swagger_vars(version, lang, clear_warnings=false)
+    def init_swagger_vars(version, lang, clear_warnings = false)
 
       # docs = {
       #     :name => Apipie.configuration.app_name,
@@ -284,7 +284,7 @@ module Apipie
 
     def swagger_path(str)
       str = str.gsub(/:(\w+)/, '{\1}')
-      str = str.gsub(/\/$/, '')
+      str = str.gsub(%r{/$}, '')
 
       if str[0] != '/'
         warn_added_missing_slash(str)
@@ -339,7 +339,7 @@ module Apipie
       response_schema(adapter, allow_nulls)
     end
 
-    def response_schema(response, allow_nulls=false)
+    def response_schema(response, allow_nulls = false)
       begin
         # no need to warn about "missing default value for optional param" when processing response definitions
         prev_value = @disable_default_value_warning
@@ -445,7 +445,7 @@ module Apipie
       "#/definitions/#{name}"
     end
 
-    def gen_referenced_block_from_params_array(name, params_array, allow_nulls=false)
+    def gen_referenced_block_from_params_array(name, params_array, allow_nulls = false)
       return ref_to(:name) if @definitions.key(:name)
 
       schema_obj = Apipie::Generator::Swagger::ParamDescription::Composite.new(
@@ -531,7 +531,7 @@ module Apipie
     end
 
 
-    def add_params_from_hash(swagger_params_array, param_defs, prefix=nil, default_value_for_in=nil)
+    def add_params_from_hash(swagger_params_array, param_defs, prefix = nil, default_value_for_in = nil)
       param_defs.each do |name, desc|
         if !prefix.nil?
           name = "#{prefix}[#{name}]"

data/lib/apipie/validator.rb

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+
 module Apipie
 
   module Validator
@@ -189,7 +190,7 @@ module Apipie
 
     # arguments value must be an array
     class ArrayValidator < Apipie::Validator::BaseValidator
-      def initialize(param_description, argument, options={})
+      def initialize(param_description, argument, options = {})
         super(param_description)
         @type = argument
         @items_type = options[:of]
@@ -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
@@ -496,7 +495,7 @@ module Apipie
 
       def initialize(param_description, argument, param_group)
         super(param_description)
-        @validator = Apipie::Validator:: HashValidator.new(param_description, argument, param_group)
+        @validator = Apipie::Validator::HashValidator.new(param_description, argument, param_group)
         @type = argument
       end
 

data/lib/apipie/version.rb

@@ -1,3 +1,3 @@
 module Apipie
-  VERSION = "0.9.2"
+  VERSION = "0.9.4"
 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
@@ -19,7 +20,7 @@ namespace :apipie do
   task :static, [:version] => :environment do |t, args|
     with_loaded_documentation do
       args.with_defaults(:version => Apipie.configuration.default_version)
-      out = ENV["OUT"] || File.join(::Rails.root, Apipie.configuration.doc_path, 'apidoc')
+      out = ENV["OUT"] || File.join(Rails.root, Apipie.configuration.doc_path, 'apidoc')
       subdir = File.basename(out)
       copy_jscss(out)
       Apipie.configuration.version_in_url = false
@@ -43,7 +44,7 @@ namespace :apipie do
   task :static_json, [:version] => :environment do |t, args|
     with_loaded_documentation do
       args.with_defaults(:version => Apipie.configuration.default_version)
-      out = ENV["OUT"] || File.join(::Rails.root, Apipie.configuration.doc_path, 'apidoc')
+      out = ENV["OUT"] || File.join(Rails.root, Apipie.configuration.doc_path, 'apidoc')
       ([nil] + Apipie.configuration.languages).each do |lang|
         doc = Apipie.to_json(args[:version], nil, nil, lang)
         generate_json_page(out, doc, lang)
@@ -54,7 +55,7 @@ namespace :apipie do
   desc "Generate static swagger json"
   task :static_swagger_json, [:version, :swagger_content_type_input, :filename_suffix] => :environment do |t, args|
     with_loaded_documentation do
-      out = ENV["OUT"] || File.join(::Rails.root, Apipie.configuration.doc_path, 'apidoc')
+      out = ENV["OUT"] || File.join(Rails.root, Apipie.configuration.doc_path, 'apidoc')
       generate_swagger_using_args(args, out)
     end
   end
@@ -67,7 +68,7 @@ namespace :apipie do
   desc "Did swagger output change since the last execution of this task?"
   task :did_swagger_change, [:version, :swagger_content_type_input, :filename_suffix] => :environment do |t, args|
     with_loaded_documentation do
-      out = ENV["OUT_REF"] || File.join(::Rails.root, Apipie.configuration.doc_path, 'apidoc_ref')
+      out = ENV["OUT_REF"] || File.join(Rails.root, Apipie.configuration.doc_path, 'apidoc_ref')
       paths = generate_swagger_using_args(args, out)
       paths.each {|path|
         existing_files_in_dir = Pathname(out).children(true)
@@ -122,17 +123,17 @@ namespace :apipie do
   # Default output dir ('public/apipie_cache') can be changed with OUT=/some/dir
   desc "Generate cache to avoid production dependencies on markup languages"
   task :cache => :environment do
-    puts "#{Time.now} | Started"
+    puts "#{Time.zone.now} | Started"
     cache_part = ENV['cache_part']
     generate_index = (cache_part == 'resources' ? false : true)
     generate_resources = (cache_part == 'index' ? false : true)
     with_loaded_documentation do
-      puts "#{Time.now} | Documents loaded..."
+      puts "#{Time.zone.now} | Documents loaded..."
       ([nil] + Apipie.configuration.languages).each do |lang|
         I18n.locale = lang || Apipie.configuration.default_locale
-        puts "#{Time.now} | Processing docs for #{lang}"
+        puts "#{Time.zone.now} | Processing docs for #{lang}"
         cache_dir = ENV["OUT"] || Apipie.configuration.cache_dir
-        subdir = Apipie.configuration.doc_base_url.sub(/\A\//,"")
+        subdir = Apipie.configuration.doc_base_url.sub(%r{\A/},"")
         subdir_levels = subdir.split('/').length
         subdir_traversal_prefix = '../' * subdir_levels
         file_base = File.join(cache_dir, Apipie.configuration.doc_base_url)
@@ -158,7 +159,7 @@ namespace :apipie do
         end
       end
     end
-    puts "#{Time.now} | Finished"
+    puts "#{Time.zone.now} | Finished"
   end
 
   # Attempt to use the Rails application views, otherwise default to built in views
@@ -220,7 +221,7 @@ namespace :apipie do
     File.open("#{file_base}/#{filename}", 'w') { |file| file.write(JSON.pretty_generate(doc)) }
   end
 
-  def generate_swagger_json_page(file_base, doc, sfx="", lang = nil)
+  def generate_swagger_json_page(file_base, doc, sfx = "", lang = nil)
     FileUtils.mkdir_p(file_base) unless File.exist?(file_base)
 
     path = Pathname.new("#{file_base}/schema_swagger#{sfx}#{lang_ext(lang)}.json")

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/dummy/config.ru

@@ -1,4 +1,4 @@
 # This file is used by Rack-based servers to start the application.
 
-require ::File.expand_path('config/environment',  __dir__)
+require File.expand_path('config/environment',  __dir__)
 run Dummy::Application

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
@@ -209,6 +209,7 @@ describe Apipie::ApipiesController do
       get :index
       expect(test).to eq(true)
     end
+
     it "remove all resources" do
       Apipie.configuration.authorize = Proc.new do |&args|
         false
@@ -216,6 +217,7 @@ describe Apipie::ApipiesController do
       get :index
       expect(assigns(:doc)[:resources]).to eq({})
     end
+
     it "remove all methods" do
       Apipie.configuration.authorize = Proc.new do |controller, method, doc|
         !method
@@ -225,6 +227,7 @@ describe Apipie::ApipiesController do
       expect(assigns(:doc)[:resources]["twitter_example"][:methods]).to eq([])
       expect(assigns(:doc)[:resources]["users"][:methods]).to eq([])
     end
+
     it "remove specific method" do
       Apipie.configuration.authorize = nil
       get :index
@@ -241,6 +244,7 @@ describe Apipie::ApipiesController do
       expect(assigns(:doc)[:resources]["users"][:methods].size).to eq(users_methods - 1)
       expect(assigns(:doc)[:resources]["twitter_example"][:methods].size).to eq(twitter_example_methods)
     end
+
     it "does not allow access to swagger when authorization is set" do
       get :index, :params => { :format => "json", :type => "swagger"}
 

data/spec/lib/apipie/application_spec.rb

@@ -0,0 +1,53 @@
+require "spec_helper"
+
+describe Apipie::Application do
+
+  describe "api_controllers_paths" do
+    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}.
+        not_to raise_error
+    end
+
+
+  end
+
+  describe '.get_resource_name' do
+    subject(:get_resource_name) do
+      Apipie.get_resource_name(Api::V2::Nested::ArchitecturesController)
+    end
+
+    let(:base_url) { '/some-api' }
+
+    before { allow(Apipie.app).to receive(:get_base_url).and_return(base_url) }
+
+    context "with namespaced_resources enabled" do
+      before { Apipie.configuration.namespaced_resources = true }
+      after { Apipie.configuration.namespaced_resources = false }
+
+      it "returns the namespaces" do
+        is_expected.to eq('api-v2-nested-architectures')
+      end
+
+      context "with an undefined base url" do
+        let(:base_url) { nil }
+
+        it "should not raise an error" do
+          expect { get_resource_name }.not_to raise_error
+        end
+      end
+    end
+
+    context "with namespaced_resources disabled" do
+      before { Apipie.configuration.namespaced_resources = false }
+
+      it "returns the controller name" do
+        is_expected.to eq('architectures')
+      end
+    end
+  end
+end

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/{generator → apipie/generator}/swagger/context_spec.rb

@@ -16,6 +16,7 @@ describe Apipie::Generator::Swagger::Context do
 
   describe '#in_schema?' do
     it { is_expected.to be_in_schema }
+
     context 'when in_schema is false' do
       let(:in_schema) { false }
 

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/no_documented_method_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe Apipie::NoDocumentedMethod do
+  let(:error) { described_class.new(controller_name, method_name) }
+  let(:controller_name) { 'UserController' }
+  let(:method_name) { 'index' }
+
+  describe '#to_s' do
+    subject { error.to_s }
+
+    let(:error_message) do
+      "There is no documented method #{controller_name}##{method_name}"
+    end
+
+    it { is_expected.to eq(error_message) }
+  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

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

@@ -188,7 +188,9 @@ describe Apipie::ParamDescription do
       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)
+          expect do
+            Apipie::ParamDescription.new(method_desc, :param, String, allow_blank: false).validate('')
+          end.to raise_error(Apipie::ParamInvalid)
         end
       end
       context 'when allow_blank is not specified' do
@@ -428,4 +430,82 @@ describe Apipie::ParamDescription do
     end
   end
 
+  describe '#deprecated?' do
+    subject do
+      Apipie::ParamDescription.new(method_desc, :param, Integer, options)
+    end
+
+    let(:options) { {} }
+
+    it { is_expected.not_to be_deprecated }
+
+    context 'when deprecated option is passed' do
+      context 'and is true' do
+        let(:options) { { deprecated: true } }
+
+        it { is_expected.to be_deprecated }
+      end
+
+      context 'and is false' do
+        let(:options) { { deprecated: false } }
+
+        it { is_expected.not_to be_deprecated }
+      end
+
+      context 'and is a string' do
+        let(:options) { { deprecated: 'Some description' } }
+
+        it { is_expected.to be_deprecated }
+      end
+
+      context 'and deprecation options are given' do
+        let(:options) do
+          { deprecated: { in: '2.3', info: 'Something', sunset: '3.0' } }
+        end
+
+        it { is_expected.to be_deprecated }
+      end
+    end
+  end
+
+  describe '#deprecation' do
+    subject { param_description.deprecation }
+
+    let(:options) { {} }
+
+    let(:param_description) do
+      Apipie::ParamDescription.new(method_desc, :param, Integer, options)
+    end
+
+    it { is_expected.to be_blank }
+
+    context 'when deprecated option is passed' do
+      context 'and is true' do
+        let(:options) { { deprecated: true } }
+
+        it { is_expected.to be_blank }
+      end
+
+      context 'and is false' do
+        let(:options) { { deprecated: false } }
+
+        it { is_expected.to be_blank }
+      end
+
+      context 'and is a string' do
+        let(:options) { { deprecated: 'Some description' } }
+
+        it { is_expected.to be_an_instance_of(Apipie::ParamDescription::Deprecation) }
+      end
+
+      context 'and deprecation options are given' do
+        let(:options) do
+          { deprecated: { in: '2.3', info: 'Something', sunset: '3.0' } }
+        end
+
+        it { is_expected.to be_an_instance_of(Apipie::ParamDescription::Deprecation) }
+      end
+    end
+  end
+
 end