apipie-rails 0.5.19 → 1.3.0

data/spec/lib/rake_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe 'rake tasks' do
   include_context "rake"
 
-  let(:doc_path)  { "user_specified_doc_path" }
+  let(:doc_path)  { 'tmp/user_specified_doc_path' }
 
   before do
     Apipie.configuration.doc_path = doc_path
@@ -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
@@ -49,9 +49,7 @@ describe 'rake tasks' do
   end
 
   describe 'apipie:cache' do
-    let(:cache_output) do
-      File.join(::Rails.root, 'public', 'apipie-cache')
-    end
+    let(:cache_output) { Apipie.configuration.cache_dir }
 
     let(:apidoc_html) do
       File.read("#{cache_output}.html")

data/spec/lib/swagger/openapi_2_0_schema.json

@@ -996,7 +996,14 @@
           "$ref": "http://json-schema.org/draft-04/schema#/definitions/positiveIntegerDefault0"
         },
         "required": {
-          "$ref": "http://json-schema.org/draft-04/schema#/definitions/stringArray"
+          "anyOf": [
+            {
+              "$ref": "http://json-schema.org/draft-04/schema#/definitions/stringArray"
+            },
+            {
+              "type": "boolean"
+            }
+          ]
         },
         "enum": {
           "$ref": "http://json-schema.org/draft-04/schema#/properties/enum"

data/spec/lib/swagger/rake_swagger_spec.rb

@@ -1,18 +1,18 @@
 require 'spec_helper'
 require "json-schema"
 
-require File.expand_path("../../../dummy/app/controllers/twitter_example_controller.rb", __FILE__)
-require File.expand_path("../../../dummy/app/controllers/users_controller.rb", __FILE__)
-require File.expand_path("../../../dummy/app/controllers/pets_controller.rb", __FILE__)
+require File.expand_path('../../dummy/app/controllers/twitter_example_controller.rb', __dir__)
+require File.expand_path('../../dummy/app/controllers/users_controller.rb', __dir__)
+require File.expand_path('../../dummy/app/controllers/pets_controller.rb', __dir__)
 
 describe 'rake tasks' do
   include_context "rake"
 
-  let(:doc_path)  { "user_specified_doc_path" }
+  let(:doc_path)  { 'tmp/user_specified_doc_path' }
 
   before do
     Apipie.configuration.doc_path = doc_path
-    Apipie.configuration.swagger_suppress_warnings = true
+    Apipie.configuration.generator.swagger.suppress_warnings = true
     allow(Apipie).to receive(:reload_documentation)
     subject.invoke(*task_args)
   end
@@ -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
 
 
@@ -51,6 +51,17 @@ describe 'rake tasks' do
       expect(param[field]).to eq(value)
     end
 
+    def expect_array_param_def(http_method, path, param_name, value)
+      params = apidoc_swagger["paths"][path][http_method]["parameters"]
+      param = params.select { |p| p if p["name"] == param_name }[0]
+
+      expect(param['type']).to eq('array')
+      expect(param['items']).to eq(
+        'type' => 'string',
+        'enum' => value
+      )
+    end
+
     def expect_tags_def(http_method, path, value)
       params = apidoc_swagger["paths"][path][http_method]["tags"]
       expect(params).to eq(value)
@@ -71,6 +82,10 @@ describe 'rake tasks' do
       expect(param[field]).to eq(value)
     end
 
+    def expect_response_params_def(http_method, path, response_code, param_name, field, value)
+      param = apidoc_swagger["paths"][path][http_method]["responses"][response_code.to_s]["schema"]["properties"][param_name]
+      expect(param[field]).to eq(value)
+    end
 
     describe 'apipie:static_swagger_json[development,json,_tmp]' do
       it "generates static swagger files for the default version of apipie docs" do
@@ -91,9 +106,10 @@ describe 'rake tasks' do
 
         expect_param_def("get", "/users/by_department", "department", "in", "query")
         expect_param_def("get", "/users/by_department", "department", "enum",
-                         ["finance", "operations", "sales", "marketing", "HR"])
+                         %w[finance operations sales marketing HR])
 
         expect_tags_def("get", "/twitter_example/{id}/followers", %w[twitter_example following index search])
+        expect_response_params_def("get", "/pets/{id}/as_properties", 200, "pet_name", "example", "mypet")
       end
 
       it "generates a valid swagger file" do
@@ -117,7 +133,11 @@ describe 'rake tasks' do
         expect_param_def("put", "/users/{id}", "oauth", "in", "formData")
         expect_param_def("get", "/users/by_department", "department", "in", "query")
         expect_param_def("get", "/users/by_department", "department", "enum",
-                         ["finance", "operations", "sales", "marketing", "HR"])
+                         %w[finance operations sales marketing HR])
+
+        expect_param_def("get", "/users/in_departments", "departments", "in", "query")
+        expect_array_param_def("get", "/users/in_departments", "departments",
+                         %w[finance operations sales marketing HR])
 
         expect_tags_def("get", "/twitter_example/{id}/followers", %w[twitter_example following index search])
 
@@ -131,7 +151,7 @@ describe 'rake tasks' do
 
     describe 'apipie:did_swagger_change[development,form_data,_tmp]' do
       it "keeps a reference file" do
-        expect(Pathname(ref_output).children.count).to eq(2)  # one file for each language
+        expect(Pathname(ref_output).children.count).to eq(2) # one file for each language
       end
     end
   end

data/spec/lib/swagger/swagger_dsl_spec.rb

@@ -6,7 +6,7 @@ describe "Swagger Responses" do
   let(:desc) { Apipie.get_resource_description(controller_class, Apipie.configuration.default_version) }
 
   let(:swagger) {
-    Apipie.configuration.swagger_suppress_warnings = true
+    Apipie.configuration.generator.swagger.suppress_warnings = true
     Apipie.to_swagger_json(Apipie.configuration.default_version, controller_class.to_s.underscore.sub("_controller", ""))
   }
 
@@ -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
@@ -141,7 +141,7 @@ describe "Swagger Responses" do
 
         a_schema = resolve_refs(schema[:items])
         expect(a_schema).to have_field(:pet_name, 'string', {:description => 'Name of pet', :required => false})
-        expect(a_schema).to have_field(:animal_type, 'string', {:description => 'Type of pet', :enum => ['dog','cat','iguana','kangaroo']})
+        expect(a_schema).to have_field(:animal_type, 'string', {:description => 'Type of pet', :enum => %w[dog cat iguana kangaroo]})
       end
 
 
@@ -210,7 +210,7 @@ describe "Swagger Responses" do
 
         schema = response[:schema]
         expect(schema).to have_field(:pet_name, 'string', {:description => 'Name of pet', :required => false})
-        expect(schema).to have_field(:animal_type, 'string', {:description => 'Type of pet', :enum => ['dog','cat','iguana','kangaroo']})
+        expect(schema).to have_field(:animal_type, 'string', {:description => 'Type of pet', :enum => %w[dog cat iguana kangaroo]})
       end
 
       it 'should have the 404 response description overridden' do
@@ -247,7 +247,7 @@ describe "Swagger Responses" do
 
         schema = response[:schema]
         expect(schema).to have_field(:pet_name, 'string', {:description => 'Name of pet', :required => false})
-        expect(schema).to have_field(:animal_type, 'string', {:description => 'Type of pet', :enum => ['dog','cat','iguana','kangaroo']})
+        expect(schema).to have_field(:animal_type, 'string', {:description => 'Type of pet', :enum => %w[dog cat iguana kangaroo]})
       end
     end
 
@@ -282,7 +282,7 @@ describe "Swagger Responses" do
         schema = response[:schema]
         expect(schema).to have_field(:pet_id, 'number', {:description => 'id of pet'})
         expect(schema).to have_field(:pet_name, 'string', {:description => 'Name of pet', :required => false})
-        expect(schema).to have_field(:animal_type, 'string', {:description => 'Type of pet', :enum => ['dog','cat','iguana','kangaroo']})
+        expect(schema).to have_field(:animal_type, 'string', {:description => 'Type of pet', :enum => %w[dog cat iguana kangaroo]})
         expect(schema).not_to have_field(:partial_match_allowed, 'boolean', {:required => false})
       end
 
@@ -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,12 +427,13 @@ 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)
 
         schema = response[:schema]
         expect(schema).to have_field(:int_array, 'array', {items: {type: 'number'}})
-        expect(schema).to have_field(:enum_array, 'array', {items: {type: 'string', enum: ['v1','v2','v3']}})
+        expect(schema).to have_field(:enum_array, 'array', {items: {type: 'string', enum: %w[v1 v2 v3]}})
       end
 
 
@@ -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')
@@ -546,7 +551,7 @@ describe "Swagger Responses" do
 
         a_schema = schema[:items]
         expect(a_schema).to have_field(:pet_name, 'string', {:description => 'Name of pet', :required => false})
-        expect(a_schema).to have_field(:animal_type, 'string', {:description => 'Type of pet', :enum => ['dog','cat','iguana','kangaroo']})
+        expect(a_schema).to have_field(:animal_type, 'string', {:description => 'Type of pet', :enum => %w[dog cat iguana kangaroo]})
       end
     end
 
@@ -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/lib/validators/array_validator_spec.rb

@@ -30,7 +30,7 @@ module Apipie::Validator
         let(:type) { String }
 
         it "accepts array of specified type" do
-          expect(validator.validate(['string1', 'string2'])).to eq(true)
+          expect(validator.validate(%w[string1 string2])).to eq(true)
         end
 
         it "accepts empty array" do

data/spec/spec_helper.rb

@@ -1,40 +1,19 @@
 require 'rubygems'
 require 'bundler/setup'
 
+require 'simplecov'
+SimpleCov.minimum_coverage 91
+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'
 
-module Rails4Compatibility
-  module Testing
-    def process(*args)
-      compatible_request(*args) { |*new_args| super(*new_args) }
-    end
-
-    def compatible_request(method, action, hash = {})
-      if hash.is_a?(Hash)
-        if Gem::Version.new(Rails.version) < Gem::Version.new('5.0.0')
-          hash = hash.dup
-          hash.merge!(hash.delete(:params) || {})
-        elsif hash.key?(:params)
-          hash = { :params => hash }
-        end
-      end
-      if hash.empty?
-        yield method, action
-      else
-        yield method, action, hash
-      end
-    end
-  end
-end
-
-
 #
 # Matcher to validate the properties (name, type and options) of a single field in the
 # internal representation of a swagger schema
@@ -45,7 +24,7 @@ end
 #
 # 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
@@ -76,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", __FILE__)].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
@@ -107,5 +86,4 @@ RSpec.configure do |config|
   config.infer_spec_type_from_file_location!
 end
 
-require 'action_controller/test_case.rb'
-ActionController::TestCase::Behavior.send(:prepend, Rails4Compatibility::Testing)
+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

data/spec/{controllers → test_engine}/memes_controller_spec.rb

@@ -4,7 +4,7 @@ describe TestEngine::MemesController do
 
   describe "#index" do
     it "should have the full mounted path of engine" do
-      Apipie.routes_for_action(TestEngine::MemesController, :index, {}).first[:path].should eq("/test/memes")
+      expect(Apipie.routes_for_action(TestEngine::MemesController, :index, {}).first[:path]).to eq("/test/memes")
     end
   end
 end