apipie-rails 0.3.6 → 0.9.1

data/spec/lib/validator_spec.rb

@@ -42,14 +42,72 @@ describe Apipie::Validator do
 
     end
 
+    describe 'NumberValidator' do
+      it 'should expect a Numeric type' do
+        validator = Apipie::Validator::BaseValidator.find(params_desc, :number, nil, nil)
+        expect(validator.expected_type).to eq('numeric')
+      end
+    end
+  end
+
+  describe 'BooleanValidator' do
+    it "should validate by object class" do
+      validator = Apipie::Validator::BooleanValidator.new(params_desc)
+      expect(validator.validate("1")).to be_truthy
+      expect(validator.validate(1)).to be_truthy
+      expect(validator.validate(true)).to be_truthy
+      expect(validator.validate(0)).to be_truthy
+      expect(validator.validate(false)).to be_truthy
+      expect(validator.validate({ 1 => 1 })).to be_falsey
+    end
+
+    it "should have a valid description" do
+      validator = Apipie::Validator::BooleanValidator.new(params_desc)
+      expect(validator.description).to eq('Must be one of: <code>true</code>, <code>false</code>, <code>1</code>, <code>0</code>.')
+    end
   end
 
   describe 'ArrayClassValidator' do
     it "should validate by object class" do
-      validator = Apipie::Validator::ArrayClassValidator.new(params_desc, [Fixnum, String])
+      validator = Apipie::Validator::ArrayClassValidator.new(params_desc, [Integer, String])
       expect(validator.validate("1")).to be_truthy
       expect(validator.validate(1)).to be_truthy
       expect(validator.validate({ 1 => 1 })).to be_falsey
     end
+
+    it "should have a valid description" do
+      validator = Apipie::Validator::ArrayClassValidator.new(params_desc, [Float, String])
+      expect(validator.description).to eq('Must be one of: <code>Float</code>, <code>String</code>.')
+    end
+  end
+
+  describe 'RegexpValidator' do
+    it "should validate by object class" do
+      validator = Apipie::Validator::RegexpValidator.new(params_desc, /^valid( extra)*$/)
+      expect(validator.validate("valid")).to be_truthy
+      expect(validator.validate("valid extra")).to be_truthy
+      expect(validator.validate("valid extra extra")).to be_truthy
+      expect(validator.validate("invalid")).to be_falsey
+    end
+
+    it "should have a valid description" do
+      validator = Apipie::Validator::RegexpValidator.new(params_desc, /^valid( extra)*$/)
+      expect(validator.description).to eq('Must match regular expression <code>/^valid( extra)*$/</code>.')
+    end
+  end
+
+  describe 'EnumValidator' do
+    it "should validate by object class" do
+      validator = Apipie::Validator::EnumValidator.new(params_desc, ['first', 'second & third'])
+      expect(validator.validate("first")).to be_truthy
+      expect(validator.validate("second & third")).to be_truthy
+      expect(validator.validate(1)).to be_falsey
+      expect(validator.validate({ 1 => 1 })).to be_falsey
+    end
+
+    it "should have a valid description" do
+      validator = Apipie::Validator::EnumValidator.new(params_desc, ['first', 'second & third'])
+      expect(validator.description).to eq('Must be one of: <code>first</code>, <code>second &amp; third</code>.')
+    end
   end
 end

data/spec/lib/validators/array_validator_spec.rb

@@ -24,18 +24,38 @@ module Apipie::Validator
     end
 
     context "with a constraint on items type" do
-      let(:validator) { ArrayValidator.new(param_desc, Array, :of => String) }
+      let(:validator) { ArrayValidator.new(param_desc, Array, :of => type) }
 
-      it "accepts array of specified type" do
-        expect(validator.validate(['string1', 'string2'])).to eq(true)
-      end
+      context "String" do
+        let(:type) { String }
 
-      it "accepts empty array" do
-        expect(validator.validate([])).to eq(true)
+        it "accepts array of specified type" do
+          expect(validator.validate(['string1', 'string2'])).to eq(true)
+        end
+
+        it "accepts empty array" do
+          expect(validator.validate([])).to eq(true)
+        end
+
+        it "does not accepts array with other types" do
+          expect(validator.validate(['string1', true])).to eq(false)
+        end
       end
 
-      it "does not accepts array with other types" do
-        expect(validator.validate(['string1', true])).to eq(false)
+      context ":number" do
+        let(:type) { :decimal }
+
+        it "accepts array of specified type" do
+          expect(validator.validate([12, '14'])).to eq(true)
+        end
+
+        it "accepts empty array" do
+          expect(validator.validate([])).to eq(true)
+        end
+
+        it "does not accepts array with other types" do
+          expect(validator.validate([12, 'potato'])).to eq(false)
+        end
       end
     end
 

data/spec/spec_helper.rb

@@ -1,17 +1,61 @@
 require 'rubygems'
 require 'bundler/setup'
 
+require 'simplecov'
+SimpleCov.minimum_coverage 89
+SimpleCov.start
+
 ENV["RAILS_ENV"] ||= 'test'
-APIPIE_ROOT = File.expand_path('../..', __FILE__)
-require File.expand_path("../dummy/config/environment", __FILE__)
+APIPIE_ROOT = File.expand_path('..', __dir__)
+require File.expand_path('dummy/config/environment', __dir__)
 
 require 'rspec/rails'
 
 require 'apipie-rails'
+require 'test_engine'
+
+#
+# Matcher to validate the properties (name, type and options) of a single field in the
+# internal representation of a swagger schema
+#
+# For example, code such as:
+#       schema = swagger[:paths][<path>][<method>][:responses][<code>][:schema]
+#       expect(schema).to have_field(:pet_name, 'string', {:required => false})
+#
+# will verify that the selected response schema includes a required string field called 'pet_name'
+#
+RSpec::Matchers.define :have_field do |name, type, opts={}|
+  def fail(msg)
+    @fail_message = msg
+    false
+  end
+
+  @fail_message = ""
+
+  failure_message do |actual|
+    @fail_message
+  end
+
+  match do |unresolved|
+    actual = resolve_refs(unresolved)
+    return fail("expected schema to have type 'object' (got '#{actual[:type]}')") if (actual[:type]) != 'object'
+    return fail("expected schema to include param named '#{name}' (got #{actual[:properties].keys})") if (prop = actual[:properties][name]).nil?
+    return fail("expected param '#{name}' to have type '#{type}' (got '#{prop[:type]}')") if prop[:type] != type
+    return fail("expected param '#{name}' to have description '#{opts[:description]}' (got '#{prop[:description]}')") if opts[:description] && prop[:description] != opts[:description]
+    return fail("expected param '#{name}' to have enum '#{opts[:enum]}' (got #{prop[:enum]})") if opts[:enum] && prop[:enum] != opts[:enum]
+    return fail("expected param '#{name}' to have items '#{opts[:items]}' (got #{prop[:items]})") if opts[:items] && prop[:items] != opts[:items]
+    if !opts.include?(:required) || opts[:required] == true
+      return fail("expected param '#{name}' to be required") unless actual[:required].include?(name)
+    else
+      return fail("expected param '#{name}' to be optional") if actual[:required].include?(name)
+    end
+    true
+  end
+end
 
 # Requires supporting ruby files with custom matchers and macros, etc,
 # in spec/support/ and its subdirectories.
-Dir[File.expand_path("../support/**/*.rb", __FILE__)].each {|f| require f}
+Dir[File.expand_path('support/**/*.rb', __dir__)].each {|f| require f}
 
 RSpec.configure do |config|
 
@@ -41,3 +85,5 @@ RSpec.configure do |config|
   #     end
   config.infer_spec_type_from_file_location!
 end
+
+require 'action_controller/test_case'

data/spec/support/custom_bool_validator.rb

@@ -0,0 +1,17 @@
+class CustomBoolValidator < Apipie::Validator::BaseValidator
+  def validate(value)
+    value.in?([true, false])
+  end
+
+  def self.build(param_description, argument, options, block)
+    new(param_description) if argument == :custom_bool
+  end
+
+  def description
+    "Must be a boolean."
+  end
+
+  def ignore_allow_blank?
+    true
+  end
+end

metadata

@@ -1,60 +1,60 @@
 --- !ruby/object:Gem::Specification
 name: apipie-rails
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.9.1
 platform: ruby
 authors:
 - Pavel Pokorny
 - Ivan Necas
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-02-18 00:00:00.000000000 Z
+date: 2023-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.20
-  type: :development
+        version: '5.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.20
+        version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: json
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: rspec-rails
+  name: maruku
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: RedCloth
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -68,21 +68,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: json-schema
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.8'
 - !ruby/object:Gem::Dependency
-  name: maruku
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -96,7 +110,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: RedCloth
+  name: rubocop_challenger
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -110,7 +124,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -124,7 +138,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rdoc
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -145,18 +159,17 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/build.yml"
+- ".github/workflows/rubocop-challenger.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - APACHE-LICENSE-2.0
 - CHANGELOG.md
-- Gemfile
-- Gemfile.rails32
-- Gemfile.rails40
-- Gemfile.rails41
-- Gemfile.rails42
 - MIT-LICENSE
 - NOTICE
+- PROPOSAL_FOR_RESPONSE_DESCRIPTIONS.md
 - README.rst
 - Rakefile
 - apipie-rails.gemspec
@@ -191,19 +204,29 @@ files:
 - config/locales/de.yml
 - config/locales/en.yml
 - config/locales/es.yml
+- config/locales/fr.yml
+- config/locales/it.yml
+- config/locales/ja.yml
+- config/locales/ko.yml
 - config/locales/pl.yml
 - config/locales/pt-BR.yml
 - config/locales/ru.yml
 - config/locales/tr.yml
 - config/locales/zh-CN.yml
 - config/locales/zh-TW.yml
+- gemfiles/Gemfile.rails50
+- gemfiles/Gemfile.rails51
+- gemfiles/Gemfile.rails52
+- gemfiles/Gemfile.rails60
+- gemfiles/Gemfile.rails61
+- gemfiles/Gemfile.rails70
 - images/screenshot-1.png
 - images/screenshot-2.png
 - lib/apipie-rails.rb
 - lib/apipie/apipie_module.rb
 - lib/apipie/application.rb
-- lib/apipie/client/generator.rb
 - lib/apipie/configuration.rb
+- lib/apipie/core_ext/route.rb
 - lib/apipie/dsl_definition.rb
 - lib/apipie/error_description.rb
 - lib/apipie/errors.rb
@@ -211,17 +234,30 @@ files:
 - lib/apipie/extractor/collector.rb
 - lib/apipie/extractor/recorder.rb
 - lib/apipie/extractor/writer.rb
+- lib/apipie/generator/generator.rb
+- lib/apipie/generator/swagger/swagger.rb
+- lib/apipie/generator/swagger/type.rb
+- lib/apipie/generator/swagger/type_extractor.rb
+- lib/apipie/generator/swagger/warning.rb
+- lib/apipie/generator/swagger/warning_writer.rb
 - lib/apipie/helpers.rb
 - lib/apipie/markup.rb
 - lib/apipie/method_description.rb
+- lib/apipie/method_description/api.rb
+- lib/apipie/method_description/apis_service.rb
 - lib/apipie/middleware/checksum_in_headers.rb
 - lib/apipie/param_description.rb
 - lib/apipie/railtie.rb
 - lib/apipie/resource_description.rb
+- lib/apipie/response_description.rb
+- lib/apipie/response_description_adapter.rb
 - lib/apipie/routes_formatter.rb
 - lib/apipie/routing.rb
+- lib/apipie/rspec/response_validation_helper.rb
 - lib/apipie/see_description.rb
 - lib/apipie/static_dispatcher.rb
+- lib/apipie/swagger_generator.rb
+- lib/apipie/tag_list_description.rb
 - lib/apipie/validator.rb
 - lib/apipie/version.rb
 - lib/generators/apipie/install/README
@@ -229,6 +265,7 @@ files:
 - lib/generators/apipie/install/templates/initializer.rb.erb
 - lib/generators/apipie/views_generator.rb
 - lib/tasks/apipie.rake
+- rel-eng/gem_release.ipynb
 - rel-eng/packages/.readme
 - rel-eng/packages/rubygem-apipie-rails
 - rel-eng/tito.props
@@ -237,6 +274,9 @@ files:
 - 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/users_controller_spec.rb
 - spec/dummy/Rakefile
 - spec/dummy/app/controllers/api/base_controller.rb
@@ -247,13 +287,29 @@ files:
 - spec/dummy/app/controllers/api/v2/nested/architectures_controller.rb
 - spec/dummy/app/controllers/api/v2/nested/resources_controller.rb
 - spec/dummy/app/controllers/application_controller.rb
-- spec/dummy/app/controllers/concerns/sample_controller.rb
 - spec/dummy/app/controllers/concerns_controller.rb
+- spec/dummy/app/controllers/extended_controller.rb
+- spec/dummy/app/controllers/extending_concern.rb
 - spec/dummy/app/controllers/files_controller.rb
+- spec/dummy/app/controllers/included_param_group_controller.rb
 - spec/dummy/app/controllers/overridden_concerns_controller.rb
+- spec/dummy/app/controllers/pets_controller.rb
+- spec/dummy/app/controllers/pets_using_auto_views_controller.rb
+- spec/dummy/app/controllers/pets_using_self_describing_classes_controller.rb
+- spec/dummy/app/controllers/sample_controller.rb
+- spec/dummy/app/controllers/tagged_cats_controller.rb
+- spec/dummy/app/controllers/tagged_dogs_controller.rb
 - spec/dummy/app/controllers/twitter_example_controller.rb
 - spec/dummy/app/controllers/users_controller.rb
+- spec/dummy/app/helpers/random_param_group.rb
 - spec/dummy/app/views/layouts/application.html.erb
+- spec/dummy/components/test_engine/Gemfile
+- spec/dummy/components/test_engine/app/controllers/test_engine/application_controller.rb
+- spec/dummy/components/test_engine/app/controllers/test_engine/memes_controller.rb
+- spec/dummy/components/test_engine/config/routes.rb
+- spec/dummy/components/test_engine/db/.gitkeep
+- spec/dummy/components/test_engine/lib/test_engine.rb
+- spec/dummy/components/test_engine/test_engine.gemspec
 - spec/dummy/config.ru
 - spec/dummy/config/application.rb
 - spec/dummy/config/boot.rb
@@ -283,19 +339,29 @@ files:
 - 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/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/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
 homepage: http://github.com/Apipie/apipie-rails
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -303,76 +369,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.0
-signing_key: 
+rubygems_version: 3.3.26
+signing_key:
 specification_version: 4
 summary: Rails REST API documentation tool
-test_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/users_controller_spec.rb
-- spec/dummy/Rakefile
-- spec/dummy/app/controllers/api/base_controller.rb
-- spec/dummy/app/controllers/api/v1/architectures_controller.rb
-- spec/dummy/app/controllers/api/v1/base_controller.rb
-- spec/dummy/app/controllers/api/v2/architectures_controller.rb
-- spec/dummy/app/controllers/api/v2/base_controller.rb
-- spec/dummy/app/controllers/api/v2/nested/architectures_controller.rb
-- spec/dummy/app/controllers/api/v2/nested/resources_controller.rb
-- spec/dummy/app/controllers/application_controller.rb
-- spec/dummy/app/controllers/concerns/sample_controller.rb
-- spec/dummy/app/controllers/concerns_controller.rb
-- spec/dummy/app/controllers/files_controller.rb
-- spec/dummy/app/controllers/overridden_concerns_controller.rb
-- spec/dummy/app/controllers/twitter_example_controller.rb
-- spec/dummy/app/controllers/users_controller.rb
-- spec/dummy/app/views/layouts/application.html.erb
-- spec/dummy/config.ru
-- spec/dummy/config/application.rb
-- spec/dummy/config/boot.rb
-- spec/dummy/config/database.yml
-- spec/dummy/config/environment.rb
-- spec/dummy/config/environments/development.rb
-- spec/dummy/config/environments/production.rb
-- spec/dummy/config/environments/test.rb
-- spec/dummy/config/initializers/apipie.rb
-- spec/dummy/config/initializers/backtrace_silencers.rb
-- spec/dummy/config/initializers/inflections.rb
-- spec/dummy/config/initializers/mime_types.rb
-- spec/dummy/config/initializers/secret_token.rb
-- spec/dummy/config/initializers/session_store.rb
-- spec/dummy/config/locales/en.yml
-- spec/dummy/config/routes.rb
-- spec/dummy/db/.gitkeep
-- spec/dummy/doc/apipie_examples.json
-- spec/dummy/doc/users/desc_from_file.md
-- spec/dummy/public/404.html
-- spec/dummy/public/422.html
-- spec/dummy/public/500.html
-- 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/method_description_spec.rb
-- spec/lib/param_description_spec.rb
-- spec/lib/param_group_spec.rb
-- spec/lib/rake_spec.rb
-- spec/lib/resource_description_spec.rb
-- spec/lib/validator_spec.rb
-- spec/lib/validators/array_validator_spec.rb
-- spec/spec_helper.rb
-- spec/support/rake.rb
+test_files: []

data/.travis.yml

@@ -1,12 +0,0 @@
-language: ruby
-sudo: false
-rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.7
-  - 2.2.3
-gemfile:
-  - Gemfile.rails32
-  - Gemfile.rails40
-  - Gemfile.rails41
-  - Gemfile.rails42

data/Gemfile

@@ -1,7 +0,0 @@
-source "https://rubygems.org"
-
-gemspec
-
-# load local gemfile
-local_gemfile = File.join(File.dirname(__FILE__), 'Gemfile.local')
-self.instance_eval(Bundler.read_file(local_gemfile)) if File.exist?(local_gemfile)

data/Gemfile.rails32

@@ -1,6 +0,0 @@
-source "https://rubygems.org"
-
-gemspec
-
-gem 'rails', '~> 3.2.0'
-gem 'test-unit', '~> 3.0'

data/Gemfile.rails40

@@ -1,5 +0,0 @@
-source "https://rubygems.org"
-
-gemspec
-
-gem 'rails', '~> 4.0.0'

data/Gemfile.rails41

@@ -1,5 +0,0 @@
-source "https://rubygems.org"
-
-gemspec
-
-gem 'rails', '~> 4.1.0'

data/Gemfile.rails42

@@ -1,5 +0,0 @@
-source "https://rubygems.org"
-
-gemspec
-
-gem 'rails', '~> 4.2.5.1'