apipie-rails 0.9.2 → 0.9.4

data/spec/lib/apipie/resource_description_spec.rb

@@ -0,0 +1,91 @@
+require "spec_helper"
+
+describe Apipie::ResourceDescription do
+  let(:resource_description) do
+    Apipie::ResourceDescription.new(controller, id, dsl_data)
+  end
+
+  let(:controller) { ApplicationController }
+  let(:id) { 'dummy' }
+  let(:dsl_data) { ActionController::Base.send(:_apipie_dsl_data_init) }
+
+  describe '#_methods' do
+    subject(:methods) { resource_description._methods }
+
+    context 'when has method descriptions' do
+      before do
+        resource_description.add_method_description(
+          Apipie::MethodDescription.new(:a, resource_description, dsl_data)
+        )
+        resource_description.add_method_description(
+          Apipie::MethodDescription.new(:b, resource_description, dsl_data)
+        )
+        resource_description.add_method_description(
+          Apipie::MethodDescription.new(:c, resource_description, dsl_data)
+        )
+      end
+
+      it 'should be ordered' do
+        expect(methods.keys).to eq([:a, :b, :c])
+      end
+    end
+  end
+
+  describe '#to_json' do
+    let(:json_data) { resource_description.to_json }
+
+    describe 'metadata' do
+      subject { json_data[:metadata] }
+
+      it { is_expected.to be_nil }
+
+      context 'when meta data are provided' do
+        let(:meta) { { length: 32, weight: '830g' } }
+        let(:dsl_data) { super().update({ meta: meta }) }
+
+        it { is_expected.to eq(meta) }
+      end
+    end
+
+    describe 'methods' do
+      subject(:methods_as_json) { json_data[:methods] }
+
+      context 'when has method descriptions' do
+        before do
+          resource_description.add_method_description(
+            Apipie::MethodDescription.new(:a, resource_description, dsl_data)
+          )
+          resource_description.add_method_description(
+            Apipie::MethodDescription.new(:b, resource_description, dsl_data)
+          )
+          resource_description.add_method_description(
+            Apipie::MethodDescription.new(:c, resource_description, dsl_data)
+          )
+        end
+
+        it 'should be ordered' do
+          expect(methods_as_json.map { |h| h[:name] }).to eq(['a', 'b', 'c'])
+        end
+      end
+    end
+  end
+
+  describe 'name' do
+    subject { resource_description.name }
+
+    it { is_expected.to eq('Dummy') }
+
+    context 'when given id contains dashes' do
+      let(:id) { 'some-nested-resource' }
+
+      it { is_expected.to eq('Some::Nested::Resource') }
+    end
+
+    context 'when resource_name is given' do
+      let(:resource_name) { 'Some-Resource' }
+      let(:dsl_data) { super().merge!(resource_name: 'Some-Resource') }
+
+      it { is_expected.to eq(resource_name) }
+    end
+  end
+end

data/spec/lib/apipie/response_does_not_match_swagger_schema_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe Apipie::ResponseDoesNotMatchSwaggerSchema do
+  let(:error) do
+    described_class.new(
+      controller_name,
+      method_name,
+      response_code,
+      error_messages,
+      schema,
+      returned_object
+    )
+  end
+
+  let(:controller_name) { 'UserController' }
+  let(:method_name) { 'index' }
+  let(:response_code) { 200 }
+  let(:error_messages) { [] }
+  let(:schema) { {} }
+  let(:returned_object) { {} }
+
+  describe '#to_s' do
+    subject { error.to_s }
+
+    let(:error_message) do
+      <<~HEREDOC.chomp
+        Response does not match swagger schema (#{controller_name}##{method_name} #{response_code}): #{error_messages}
+        Schema: #{JSON(schema)}
+        Returned object: #{returned_object}
+      HEREDOC
+    end
+
+    it { is_expected.to eq(error_message) }
+  end
+end

data/spec/lib/rake_spec.rb

@@ -18,7 +18,7 @@ describe 'rake tasks' do
     end
 
     let(:doc_output) do
-      File.join(::Rails.root, doc_path, 'apidoc')
+      File.join(Rails.root, doc_path, 'apidoc')
     end
 
     after do

data/spec/lib/swagger/rake_swagger_spec.rb

@@ -37,11 +37,11 @@ describe 'rake tasks' do
     end
 
     let(:doc_output) do
-      File.join(::Rails.root, doc_path, 'apidoc')
+      File.join(Rails.root, doc_path, 'apidoc')
     end
 
     let(:ref_output) do
-      File.join(::Rails.root, doc_path, 'apidoc_ref')
+      File.join(Rails.root, doc_path, 'apidoc_ref')
     end
 
 

data/spec/lib/swagger/swagger_dsl_spec.rb

@@ -24,20 +24,20 @@ describe "Swagger Responses" do
     schema
   end
 
-  def swagger_response_for(path, code=200, method='get')
+  def swagger_response_for(path, code = 200, method = 'get')
     response = swagger[:paths][path][method][:responses][code]
     response[:schema] = resolve_refs(response[:schema])
     response
   end
 
-  def swagger_params_for(path, method='get')
+  def swagger_params_for(path, method = 'get')
     swagger[:paths][path][method][:parameters]
   end
 
-  def swagger_param_by_name(param_name, path, method='get')
+  def swagger_param_by_name(param_name, path, method = 'get')
     params = swagger_params_for(path, method)
     matching = params.select{|p| p[:name] == param_name }
-    raise "multiple params named [#{param_name}] in swagger definition for [#{method } #{path}]" if matching.length > 1
+    raise "multiple params named [#{param_name}] in swagger definition for [#{method} #{path}]" if matching.length > 1
 
     nil if matching.length == 0
 
@@ -72,7 +72,7 @@ describe "Swagger Responses" do
       deep_match?(actual, expected)
     end
 
-    def deep_match?(actual, expected, breadcrumb=[])
+    def deep_match?(actual, expected, breadcrumb = [])
       pending_params = actual.params_ordered.dup
       expected.each do |expected_param|
         expected_param_name = expected_param.is_a?(Hash) ? expected_param.keys.first : expected_param
@@ -338,6 +338,7 @@ describe "Swagger Responses" do
 
         expect(returns_obj).to match_field_structure([:pet_name, :animal_type])
       end
+
       it 'should have the 201 response described in the swagger' do
         response = swagger_response_for('/pets/{id}/extra_info', 201)
         expect(response[:description]).to eq("Found a pet")
@@ -359,6 +360,7 @@ describe "Swagger Responses" do
                                                       {:pet_measurements => [:weight, :height, :num_legs]}
                                                      ])
       end
+
       it 'should have the 202 response described in the swagger' do
         response = swagger_response_for('/pets/{id}/extra_info', 202)
         expect(response[:description]).to eq('Accepted')
@@ -388,6 +390,7 @@ describe "Swagger Responses" do
                                                       {:additional_histories => [:did_visit_vet, :avg_meals_per_day]}
                                                      ])
       end
+
       it 'should have the 203 response described in the swagger' do
         response = swagger_response_for('/pets/{id}/extra_info', 203)
         expect(response[:description]).to eq('Non-Authoritative Information')
@@ -424,6 +427,7 @@ describe "Swagger Responses" do
 
         expect(returns_obj).to match_field_structure([:int_array, :enum_array])
       end
+
       it 'should have the 204 response described in the swagger' do
         response = swagger_response_for('/pets/{id}/extra_info', 204)
 
@@ -444,6 +448,7 @@ describe "Swagger Responses" do
                                                       :num_fleas
                                                      ])
       end
+
       it 'should have the 422 response described in the swagger' do
         response = swagger_response_for('/pets/{id}/extra_info', 422)
         expect(response[:description]).to eq('Fleas were discovered on the pet')
@@ -568,6 +573,7 @@ describe "Swagger Responses" do
                                                       {:pet_measurements => [:weight, :height, :num_legs]}
                                                      ])
       end
+
       it 'should have the 200 response described in the swagger' do
         response = swagger_response_for('/pets_with_measurements_described_as_class/{id}', 200)
         expect(response[:description]).to eq('measurements of the pet')

data/spec/spec_helper.rb

@@ -24,7 +24,7 @@ require 'test_engine'
 #
 # will verify that the selected response schema includes a required string field called 'pet_name'
 #
-RSpec::Matchers.define :have_field do |name, type, opts={}|
+RSpec::Matchers.define :have_field do |name, type, opts = {}|
   def fail(msg)
     @fail_message = msg
     false
@@ -55,14 +55,14 @@ end
 
 # Requires supporting ruby files with custom matchers and macros, etc,
 # in spec/support/ and its subdirectories.
-Dir[File.expand_path('support/**/*.rb', __dir__)].each {|f| require f}
+Dir[File.expand_path('support/**/*.rb', __dir__)].sort.each {|f| require f}
 
 RSpec.configure do |config|
 
   config.mock_with :rspec
 
   # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
-  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+  config.fixture_path = "#{Rails.root}/spec/fixtures"
 
   # If you're not using ActiveRecord, or you'd prefer not to run each of your
   # examples within a transaction, remove the following line or assign false

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apipie-rails
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.9.4
 platform: ruby
 authors:
 - Pavel Pokorny
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-07 00:00:00.000000000 Z
+date: 2023-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -123,6 +123,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -161,6 +203,7 @@ extra_rdoc_files: []
 files:
 - ".github/workflows/build.yml"
 - ".github/workflows/rubocop-challenger.yml"
+- ".github/workflows/rubocop.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -184,6 +227,7 @@ files:
 - app/public/apipie/stylesheets/bundled/bootstrap-responsive.min.css
 - app/public/apipie/stylesheets/bundled/bootstrap.min.css
 - app/public/apipie/stylesheets/bundled/prettify.css
+- app/views/apipie/apipies/_deprecation.html.erb
 - app/views/apipie/apipies/_disqus.html.erb
 - app/views/apipie/apipies/_errors.html.erb
 - app/views/apipie/apipies/_headers.html.erb
@@ -256,6 +300,7 @@ files:
 - lib/apipie/method_description/apis_service.rb
 - lib/apipie/middleware/checksum_in_headers.rb
 - lib/apipie/param_description.rb
+- lib/apipie/param_description/deprecation.rb
 - lib/apipie/railtie.rb
 - lib/apipie/resource_description.rb
 - lib/apipie/response_description.rb
@@ -281,11 +326,10 @@ files:
 - spec/controllers/api/v1/architectures_controller_spec.rb
 - spec/controllers/api/v2/architectures_controller_spec.rb
 - spec/controllers/api/v2/nested/resources_controller_spec.rb
-- spec/controllers/apipies_controller_spec.rb
 - spec/controllers/concerns_controller_spec.rb
 - spec/controllers/extended_controller_spec.rb
 - spec/controllers/included_param_group_controller_spec.rb
-- spec/controllers/memes_controller_spec.rb
+- spec/controllers/pets_controller_spec.rb
 - spec/controllers/users_controller_spec.rb
 - spec/dummy/Rakefile
 - spec/dummy/app/controllers/api/base_controller.rb
@@ -344,38 +388,44 @@ files:
 - spec/dummy/public/favicon.ico
 - spec/dummy/public/stylesheets/.gitkeep
 - spec/dummy/script/rails
-- spec/lib/application_spec.rb
-- spec/lib/extractor/extractor_spec.rb
-- spec/lib/extractor/middleware_spec.rb
-- spec/lib/extractor/writer_spec.rb
-- spec/lib/file_handler_spec.rb
-- spec/lib/generator/swagger/context_spec.rb
-- spec/lib/generator/swagger/operation_id_spec.rb
-- spec/lib/generator/swagger/param_description/builder_spec.rb
-- spec/lib/generator/swagger/param_description/composite_spec.rb
-- spec/lib/generator/swagger/param_description/description_spec.rb
-- spec/lib/generator/swagger/param_description/in_spec.rb
-- spec/lib/generator/swagger/param_description/name_spec.rb
-- spec/lib/generator/swagger/param_description/type_spec.rb
-- spec/lib/generator/swagger/param_description_spec.rb
-- spec/lib/generator/swagger/type_extractor_spec.rb
-- spec/lib/generator/swagger/warning_spec.rb
-- spec/lib/generator/swagger/warning_writer_spec.rb
-- spec/lib/method_description/apis_service_spec.rb
-- spec/lib/method_description_spec.rb
-- spec/lib/param_description_spec.rb
-- spec/lib/param_group_spec.rb
+- spec/lib/apipie/apipies_controller_spec.rb
+- spec/lib/apipie/application_spec.rb
+- spec/lib/apipie/configuration_spec.rb
+- spec/lib/apipie/extractor/recorder/middleware_spec.rb
+- spec/lib/apipie/extractor/recorder_spec.rb
+- spec/lib/apipie/extractor/writer_spec.rb
+- spec/lib/apipie/extractor_spec.rb
+- spec/lib/apipie/file_handler_spec.rb
+- spec/lib/apipie/generator/swagger/context_spec.rb
+- spec/lib/apipie/generator/swagger/operation_id_spec.rb
+- spec/lib/apipie/generator/swagger/param_description/builder_spec.rb
+- spec/lib/apipie/generator/swagger/param_description/composite_spec.rb
+- spec/lib/apipie/generator/swagger/param_description/description_spec.rb
+- spec/lib/apipie/generator/swagger/param_description/in_spec.rb
+- spec/lib/apipie/generator/swagger/param_description/name_spec.rb
+- spec/lib/apipie/generator/swagger/param_description/type_spec.rb
+- spec/lib/apipie/generator/swagger/param_description_spec.rb
+- spec/lib/apipie/generator/swagger/type_extractor_spec.rb
+- spec/lib/apipie/generator/swagger/warning_spec.rb
+- spec/lib/apipie/generator/swagger/warning_writer_spec.rb
+- spec/lib/apipie/method_description/apis_service_spec.rb
+- spec/lib/apipie/method_description_spec.rb
+- spec/lib/apipie/no_documented_method_spec.rb
+- spec/lib/apipie/param_description/deprecation_spec.rb
+- spec/lib/apipie/param_description_spec.rb
+- spec/lib/apipie/param_group_spec.rb
+- spec/lib/apipie/resource_description_spec.rb
+- spec/lib/apipie/response_does_not_match_swagger_schema_spec.rb
+- spec/lib/apipie/validator_spec.rb
 - spec/lib/rake_spec.rb
-- spec/lib/resource_description_spec.rb
 - spec/lib/swagger/openapi_2_0_schema.json
 - spec/lib/swagger/rake_swagger_spec.rb
-- spec/lib/swagger/response_validation_spec.rb
 - spec/lib/swagger/swagger_dsl_spec.rb
-- spec/lib/validator_spec.rb
 - spec/lib/validators/array_validator_spec.rb
 - spec/spec_helper.rb
 - spec/support/custom_bool_validator.rb
 - spec/support/rake.rb
+- spec/test_engine/memes_controller_spec.rb
 homepage: http://github.com/Apipie/apipie-rails
 licenses: []
 metadata: {}
@@ -394,7 +444,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Rails REST API documentation tool

data/spec/lib/application_spec.rb

@@ -1,49 +0,0 @@
-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")] }
-
-    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 {Apipie.get_resource_name(Api::V2::Nested::ArchitecturesController)}
-
-    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
-        before {allow(Apipie.app).to receive(:get_base_url).and_return(nil)}
-
-        it "should not raise an error" do
-          expect { Apipie.get_resource_name(Api::V2::ArchitecturesController) }.
-            not_to raise_error
-        end
-      end
-
-      after { Apipie.configuration.namespaced_resources = false }
-    end
-
-    context "with namespaced_resources enabled" do
-      before { Apipie.configuration.namespaced_resources = false }
-
-      it "should overwrite the the parent" do
-        is_expected.to eq(Apipie.get_resource_name(Api::V2::ArchitecturesController))
-      end
-    end
-  end
-end

data/spec/lib/resource_description_spec.rb

@@ -1,48 +0,0 @@
-require "spec_helper"
-
-describe Apipie::ResourceDescription do
-
-  let(:dsl_data) { ActionController::Base.send(:_apipie_dsl_data_init) }
-
-  describe "metadata" do
-
-    it "should return nil when no metadata is provided" do
-      resource = Apipie::ResourceDescription.new(ApplicationController, "dummy", dsl_data)
-      expect(resource.to_json[:metadata]).to eq(nil)
-    end
-
-    it "should return the metadata" do
-      meta = {
-        :lenght => 32,
-        :weight => '830g'
-      }
-      resource = Apipie::ResourceDescription.new(ApplicationController, "dummy", dsl_data.update(:meta => meta))
-      expect(resource.to_json[:metadata]).to eq(meta)
-    end
-
-  end
-
-  describe "methods descriptions" do
-
-    before(:each) do
-      @resource = Apipie::ResourceDescription.new(ApplicationController, "dummy")
-      a = Apipie::MethodDescription.new(:a, @resource, dsl_data)
-      b = Apipie::MethodDescription.new(:b, @resource, dsl_data)
-      c = Apipie::MethodDescription.new(:c, @resource, dsl_data)
-      @resource.add_method_description(a)
-      @resource.add_method_description(b)
-      @resource.add_method_description(c)
-    end
-
-    it "should be ordered" do
-      expect(@resource._methods.keys).to eq([:a, :b, :c])
-      expect(@resource.to_json[:methods].map{|h| h[:name]}).to eq(['a', 'b', 'c'])
-    end
-
-    it "should be still ordered" do
-      expect(@resource._methods.keys).to eq([:a, :b, :c])
-      expect(@resource.to_json[:methods].map{|h| h[:name]}).to eq(['a', 'b', 'c'])
-    end
-
-  end
-end