apipie-rails 0.3.6 → 0.9.1

data/spec/dummy/app/controllers/users_controller.rb

@@ -4,7 +4,7 @@ class UsersController < ApplicationController
     short 'Site members'
     path '/users'
     formats ['json']
-    param :id, Fixnum, :desc => "User ID", :required => false
+    param :id, Integer, :desc => "User ID", :required => false
     param :legacy_param, Hash, :desc => 'Deprecated parameter not documented', :show => false, :required => false do
       param :resource_param, Hash, :desc => 'Param description for all methods' do
         param :ausername, String, :desc => "Username for login", :required => true
@@ -192,15 +192,15 @@ class UsersController < ApplicationController
   end
   def show
     unless params[:session] == "secret_hash"
-      render :text => "Not authorized", :status => 401
+      render :plain => "Not authorized", :status => 401
       return
     end
 
     unless params[:id].to_i == 5
-      render :text => "Not Found", :status => 404 and return
+      render :plain => "Not Found", :status => 404 and return
     end
 
-    render :text => "OK"
+    render :plain => "OK"
   end
 
   def_param_group :credentials do
@@ -221,8 +221,10 @@ class UsersController < ApplicationController
     param :permalink, String
   end
   param :facts, Hash, :desc => "Additional optional facts about the user", :allow_nil => true
+  param :age, :number, :desc => "Age is just a number", :allow_blank => true
+  error :unprocessable_entity, 'Unprocessable Entity'
   def create
-    render :text => "OK #{params.inspect}"
+    render :plain => "OK #{params.inspect}"
   end
 
   api :PUT, "/users/:id", "Update an user"
@@ -231,13 +233,13 @@ class UsersController < ApplicationController
     param :comment, String
   end
   def update
-    render :text => "OK #{params.inspect}"
+    render :plain => "OK #{params.inspect}"
   end
 
   api :POST, "/users/admin", "Create admin user"
   param_group :user, :as => :create
   def admin_create
-    render :text => "OK #{params.inspect}"
+    render :plain => "OK #{params.inspect}"
   end
 
   api :GET, "/users", "List users"
@@ -247,14 +249,14 @@ class UsersController < ApplicationController
   param :oauth, nil,
         :desc => "Hide this global param (eg dont need auth here)"
   def index
-    render :text => "List of users"
+    render :plain => "List of users"
   end
 
   api :GET, '/company_users', 'Get company users'
   api :GET, '/company/:id/users', 'Get users working in given company'
   param :id, Integer, :desc => "Company ID"
   def two_urls
-    render :text => 'List of users'
+    render :plain => 'List of users'
   end
 
   api :GET, '/users/see_another', 'Boring method'
@@ -263,14 +265,25 @@ class UsersController < ApplicationController
   see 'development#users#index', "very interesting method reference"
   desc 'This method is boring, look at users#create.  It is hidden from documentation.'
   def see_another
-    render :text => 'This is very similar to create action'
+    render :plain => 'This is very similar to create action'
   end
 
+  api :GET, '/users/by_department', 'show users from a specific department'
+  param :department, ["finance", "operations", "sales", "marketing", "HR"], required: false, default_value: "sales"
+  def get_by_department
+    render :plain => 'nothing to see here'
+  end
+
+  api :GET, '/users/in_departments', 'show users from specific departments'
+  param :departments, Array, in: ["finance", "operations", "sales", "marketing", "HR"], default_value: ['sales']
+  def get_in_departments
+    render :plain => 'nothing to see here'
+  end
 
   api :GET, '/users/desc_from_file', 'desc from file'
   document 'users/desc_from_file.md'
   def desc_from_file
-    render :text => 'document from file action'
+    render :plain => 'document from file action'
   end
 
   api! 'Create user'
@@ -284,7 +297,8 @@ class UsersController < ApplicationController
 
   api :GET, '/users/action_with_headers'
   header :RequredHeaderName, 'Required header description', required: true
-  header :OptionalHeaderName, 'Optional header description', required: false
+  header :OptionalHeaderName, 'Optional header description', required: false, type: 'string'
+  header :HeaderNameWithDefaultValue, 'Header with default value', required: true, default: 'default value'
   def action_with_headers
   end
 end

data/spec/dummy/app/helpers/random_param_group.rb

@@ -0,0 +1,8 @@
+module RandomParamGroup
+  def self.included(klazz)
+    klazz.def_param_group :random_param_group do
+      property :id, Integer
+      property :name, String
+    end
+  end
+end

data/spec/dummy/components/test_engine/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Declare your gem's dependencies in test_engine.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec

data/spec/dummy/components/test_engine/app/controllers/test_engine/application_controller.rb

@@ -0,0 +1,4 @@
+module TestEngine
+  class ApplicationController < ActionController::Base
+  end
+end

data/spec/dummy/components/test_engine/app/controllers/test_engine/memes_controller.rb

@@ -0,0 +1,37 @@
+module TestEngine
+  class MemesController < TestEngine::ApplicationController
+    api! 'Returns a list of all good memes on Twitter'
+    param :api_token, String, required: true, desc: 'Your Twitter API token'
+    def index
+      render json: []
+    end
+
+    api! 'Shows info about a particular meme on Twitter'
+    param :id, :number, required: true, desc: 'ID of the meme'
+    def show
+      render json: {id: params[:id]}
+    end
+
+    api! 'Create a new meme on Twitter'
+    param :api_token, String, required: true, desc: 'Your Twitter API token'
+    param :name, String, required: true, desc: 'Name of your meme'
+    param :src_url, String, required: true, desc: 'URL for your meme'
+    def create
+      render json: {name: params[:name], src_url: params[:src_url]}, status: :created
+    end
+
+    api! 'Update a meme on Twitter'
+    param :api_token, String, required: true, desc: 'Your Twitter API token'
+    param :name, String, required: false, desc: 'Name of your meme'
+    param :src_url, String, required: false, desc: 'URL for your meme'
+    def update
+      render json: {name: params[:name], src_url: params[:src_url]}
+    end
+
+    api! 'Delete a meme on Twitter'
+    param :id, :number, required: true, desc: 'ID of the meme'
+    def destroy
+      head :ok
+    end
+  end
+end

data/spec/dummy/components/test_engine/config/routes.rb

@@ -0,0 +1,3 @@
+TestEngine::Engine.routes.draw do
+  resources :memes, only: [:index, :show, :create, :update, :destroy]
+end

data/spec/dummy/components/test_engine/lib/test_engine.rb

@@ -0,0 +1,7 @@
+require 'apipie-rails'
+
+module TestEngine
+  class Engine < ::Rails::Engine
+    isolate_namespace TestEngine
+  end
+end

data/spec/dummy/components/test_engine/test_engine.gemspec

@@ -0,0 +1,11 @@
+$:.push File.expand_path('lib', __dir__)
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name        = 'test_engine'
+  s.version     = '0.0.1'
+  s.summary     = 'Test Engine'
+  s.authors     = 'Test Author'
+
+  s.files = Dir['{app,config,db,lib}/**/*']
+end

data/spec/dummy/config/application.rb

@@ -1,13 +1,11 @@
-require File.expand_path('../boot', __FILE__)
+require File.expand_path('boot', __dir__)
 
-require "active_model/railtie"
-require "active_record/railtie"
 require "action_controller/railtie"
 require "action_view/railtie"
-require "action_mailer/railtie"
 
 Bundler.require
 require "apipie-rails"
+require "test_engine"
 
 module Dummy
   class Application < Rails::Application
@@ -41,5 +39,9 @@ module Dummy
 
     # Configure sensitive parameters which will be filtered from the log file.
     config.filter_parameters += [:password]
+
+    config.to_prepare do
+      ExtendedController.send(:include, ExtendingConcern)
+    end
   end
 end

data/spec/dummy/config/boot.rb

@@ -1,5 +1,5 @@
 require 'rubygems'
-gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+gemfile = File.expand_path('../../../Gemfile', __dir__)
 
 if File.exist?(gemfile)
   ENV['BUNDLE_GEMFILE'] = gemfile
@@ -7,4 +7,4 @@ if File.exist?(gemfile)
   Bundler.setup
 end
 
-$:.unshift File.expand_path('../../../../lib', __FILE__)
+$:.unshift File.expand_path('../../../lib', __dir__)

data/spec/dummy/config/environment.rb

@@ -2,7 +2,7 @@
 # ENV['RAILS_RELATIVE_URL_ROOT'] = '/relative/path'
 
 # Load the rails application
-require File.expand_path('../application', __FILE__)
+require File.expand_path('application', __dir__)
 
 # Initialize the rails application
 Dummy::Application.initialize!

data/spec/dummy/config/environments/development.rb

@@ -13,13 +13,13 @@ Dummy::Application.configure do
   config.consider_all_requests_local       = true
   config.action_controller.perform_caching = false
 
-  # Don't care if the mailer can't send
-  config.action_mailer.raise_delivery_errors = false
-
   # Print deprecation notices to the Rails logger
   config.active_support.deprecation = :log
 
   # Only use best-standards-support built into browsers
   config.action_dispatch.best_standards_support = :builtin
+
+  # Do not eager load code on boot. (Rails 5)
+  config.eager_load = false
 end
 

data/spec/dummy/config/environments/production.rb

@@ -34,9 +34,6 @@ Dummy::Application.configure do
   # Enable serving of images, stylesheets, and javascripts from an asset server
   # config.action_controller.asset_host = "http://assets.example.com"
 
-  # Disable delivery errors, bad email addresses will be ignored
-  # config.action_mailer.raise_delivery_errors = false
-
   # Enable threaded mode
   # config.threadsafe!
 
@@ -46,4 +43,7 @@ Dummy::Application.configure do
 
   # Send deprecation notices to registered listeners
   config.active_support.deprecation = :notify
+
+  # Eager load code on boot (Rails 5)
+  config.eager_load = true
 end

data/spec/dummy/config/environments/test.rb

@@ -20,11 +20,6 @@ Dummy::Application.configure do
   # Disable request forgery protection in test environment
   config.action_controller.allow_forgery_protection    = false
 
-  # Tell Action Mailer not to deliver emails to the real world.
-  # The :test delivery method accumulates sent emails in the
-  # ActionMailer::Base.deliveries array.
-  config.action_mailer.delivery_method = :test
-
   # Use SQL instead of Active Record's schema dumper when creating the test database.
   # This is necessary if your schema can't be completely dumped by the schema dumper,
   # like if you have constraints or database-specific column types
@@ -32,4 +27,7 @@ Dummy::Application.configure do
 
   # Print deprecation notices to the stderr
   config.active_support.deprecation = :stderr
+
+  # Do not eager load code on boot. (Rails 5)
+  config.eager_load = false
 end

data/spec/dummy/config/initializers/apipie.rb

@@ -1,12 +1,14 @@
 Apipie.configure do |config|
   config.app_name = "Test app"
   config.copyright = "© 2012 Pavel Pokorny"
+  config.languages = ['en']
+  config.default_locale = 'en'
 
   # set default API version
   # can be overriden in resource_description
   # by default is it 1.0 if not specified anywhere
   # this must be defined before api_base_url and app_info
-  config.default_version = "development"
+  config.default_version = "development".freeze
 
   config.doc_base_url = "/apidoc"
 
@@ -21,7 +23,7 @@ Apipie.configure do |config|
   #     rake apipie:cache
   #
   config.use_cache = Rails.env.production?
-  # config.cache_dir = File.join(Rails.root, "public", "apipie-cache") # optional
+  config.cache_dir = File.join(Rails.root, "tmp", "apipie-cache") # optional
 
   # set to enable/disable reloading controllers (and the documentation with it),
   # by default enabled in development
@@ -87,7 +89,7 @@ class Apipie::Validator::IntegerValidator < Apipie::Validator::BaseValidator
   end
 
   def self.build(param_description, argument, options, block)
-    if argument == Integer || argument == Fixnum
+    if argument == Integer
       self.new(param_description, argument)
     end
   end

data/spec/dummy/config/routes.rb

@@ -1,5 +1,7 @@
 Dummy::Application.routes.draw do
 
+  mount TestEngine::Engine => '/test'
+
   scope ENV['RAILS_RELATIVE_URL_ROOT'] || '/' do
 
     scope '/api' do
@@ -9,9 +11,15 @@ Dummy::Application.routes.draw do
         end
       end
       resources :concerns, :only => [:index, :show]
+      get '/:resource_id/:custom_subst' => 'concerns#custom'
       namespace :files do
-        get '/*file_path', to: :download, format: false
+        get '/*file_path', format: false, :action => 'download'
       end
+
+      # This is not directly used in the specs.
+      # It is only there to tests apipies tolerance regarding
+      # missing controllers.
+      resources :dangeling_stuff
       resources :twitter_example do
         collection do
           get :lookup
@@ -21,6 +29,22 @@ Dummy::Application.routes.draw do
           get :contributors
         end
       end
+
+      get "/pets/return_and_validate_expected_response" => "pets#return_and_validate_expected_response"
+      get "/pets/return_and_validate_expected_array_response" => "pets#return_and_validate_expected_array_response"
+      get "/pets/return_and_validate_type_mismatch" => "pets#return_and_validate_type_mismatch"
+      get "/pets/return_and_validate_missing_field" => "pets#return_and_validate_missing_field"
+      get "/pets/return_and_validate_extra_property" => "pets#return_and_validate_extra_property"
+      get "/pets/return_and_validate_allowed_extra_property" => "pets#return_and_validate_allowed_extra_property"
+      get "/pets/sub_object_invalid_extra_property" => "pets#sub_object_invalid_extra_property"
+      get "/pets/sub_object_allowed_extra_property" => "pets#sub_object_allowed_extra_property"
+      get "/pets/return_and_validate_unexpected_array_response" => "pets#return_and_validate_unexpected_array_response"
+      get "/pets/return_and_validate_expected_response_with_null" => "pets#return_and_validate_expected_response_with_null"
+      get "/pets/return_and_validate_expected_response_with_null_object" => "pets#return_and_validate_expected_response_with_null_object"
+
+      get "/pets/returns_response_with_valid_array" => "pets#returns_response_with_valid_array"
+      get "/pets/returns_response_with_invalid_array" => "pets#returns_response_with_invalid_array"
+      get "/pets/undocumented_method" => "pets#undocumented_method"
     end
 
     apipie

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',  __FILE__)
+require ::File.expand_path('config/environment',  __dir__)
 run Dummy::Application

data/spec/dummy/script/rails

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 # This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
 
-APP_PATH = File.expand_path('../../config/application',  __FILE__)
-require File.expand_path('../../config/boot',  __FILE__)
+APP_PATH = File.expand_path('../config/application',  __dir__)
+require File.expand_path('../config/boot',  __dir__)
 require 'rails/commands'

data/spec/lib/application_spec.rb

@@ -27,7 +27,7 @@ describe Apipie::Application do
       end
 
       context "with an undefined base url" do
-        before {allow(Apipie.app).to receive(:get_base_url) { nil }}
+        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) }.

data/spec/lib/extractor/writer_spec.rb

@@ -6,7 +6,8 @@ describe Apipie::Extractor::Writer do
   let(:writer_class) { Apipie::Extractor::Writer }
   let(:writer) { writer_class.new(collector) }
   let(:test_examples_file) { File.join(Rails.root, "doc", "apipie_examples_test.json") }
-  let(:records) { {
+  let(:records) {
+    {
     "concern_resources#show" =>
       [{
         :controller=>ConcernsController,
@@ -31,7 +32,8 @@ describe Apipie::Extractor::Writer do
       }]
     }
   }
-  let(:loaded_records) { {
+  let(:loaded_records) {
+    {
     "concern_resources#show" =>
       [{
         "verb"=>:GET,
@@ -57,10 +59,38 @@ describe Apipie::Extractor::Writer do
     }
   }
 
-  describe "with doc_path overriden in configuration" do
-    it "should use the doc_path specified in configuration" do
-      Apipie.configuration.doc_path = "user_specified_doc_path"
-      expect(writer_class.examples_file).to eql(File.join(Rails.root, "user_specified_doc_path", "apipie_examples.json"))
+  context 'with doc_path overridden in configuration' do
+    around(:each) do |example|
+      standard_path = Apipie.configuration.doc_path
+      Apipie.configuration.doc_path = 'tmp/user_specified_doc_path'
+      example.run
+      Apipie.configuration.doc_path = standard_path
+    end
+
+    it 'should use the doc_path specified in configuration' do
+      expect(writer_class.examples_file).to eql(File.join(Rails.root, 'tmp', 'user_specified_doc_path', 'apipie_examples.json'))
+    end
+  end
+
+  context 'when compressing examples' do
+    around(:each) do |example|
+      Apipie.configuration.compress_examples = true
+      example.run
+      FileUtils.rm(writer_class.examples_file) if File.exist?(writer_class.examples_file)
+      Apipie.configuration.compress_examples = nil
+    end
+
+    it 'should write to a compressed file' do
+      expect(writer_class.examples_file).to match(/\.gz$/)
+      writer_class.write_recorded_examples(records)
+      expect(File.exist?(writer_class.examples_file))
+    end
+
+    it 'should read from a compressed file' do
+      writer_class.write_recorded_examples(records)
+      expected_string = writer_class.send(:serialize_examples, records)
+      expect(writer_class.load_recorded_examples)
+        .to eql(writer_class.send(:deserialize_examples, expected_string))
     end
   end
 
@@ -76,7 +106,7 @@ describe Apipie::Extractor::Writer do
     end
 
     after do
-      File.unlink(test_examples_file) if File.exists?(test_examples_file)
+      File.unlink(test_examples_file) if File.exist?(test_examples_file)
     end
   end
 end

data/spec/lib/file_handler_spec.rb

@@ -0,0 +1,25 @@
+require "spec_helper"
+
+describe Apipie::FileHandler do
+
+  describe "match?" do
+    let(:file_handler) { Apipie::FileHandler.new File.dirname(__FILE__) }
+
+    it { expect(file_handler.match? 'file_handler_spec.rb').to be_truthy }
+    it { expect(file_handler.match? 'foo.bar').to be_falsy }
+
+    context 'path contains null bytes' do
+      let(:path) { "foo%00.bar" }
+
+      it { expect(file_handler.match? path).to be_falsy }
+      it { expect { file_handler.match? path }.to_not raise_error }
+    end
+
+    context 'when the path contans an invalid byte sequence in UTF-8' do
+      let(:path) { "%B6" }
+
+      it { expect(file_handler.match? path).to be_falsy }
+      it { expect { file_handler.match? path }.to_not raise_error }
+    end
+  end
+end

data/spec/lib/generator/swagger/type_extractor_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+describe Apipie::Generator::Swagger::TypeExtractor do
+  let(:validator) {}
+  let(:extractor) { described_class.new(validator) }
+
+  describe '#extarct_with_warnings' do
+    let(:warnings) { {} }
+
+    before { Apipie.configuration.swagger_suppress_warnings = false }
+
+    subject { extractor.extract_with_warnings(warnings) }
+
+    it { is_expected.to eq(Apipie::Generator::Swagger::TypeExtractor::TYPES[:string]) }
+
+    context "when enum validator is used" do
+      let(:enum_values) { ["Name"] }
+
+      context "of type Apipie::Validator::EnumValidator" do
+        let(:validator) { Apipie::Validator::EnumValidator.new(nil, enum_values) }
+
+        it { is_expected.to eq("enum") }
+      end
+
+      context "that responds to is_enum?" do
+        let(:validator) do
+          Apipie::ResponseDescriptionAdapter::PropDesc::Validator.new('some-type', enum_values)
+        end
+
+        it 'returns an enum type' do
+          expect(subject).to eq(Apipie::Generator::Swagger::TypeExtractor::TYPES[:enum])
+        end
+
+        context 'and has `true`, `false` as values' do
+          let(:param_description_name) { :visible }
+          let(:enum_values) { [true, false] }
+
+          it 'returns a boolean type' do
+            expect(subject).to eq(Apipie::Generator::Swagger::TypeExtractor::TYPES[:boolean])
+          end
+
+          context 'and a boolean warning is passed' do
+            let(:boolean_warning) do
+              Apipie::Generator::Swagger::Warning.for_code(
+                Apipie::Generator::Swagger::Warning::INFERRING_BOOLEAN_CODE,
+                'SampleController#action',
+                { parameter: 'some-param' }
+              )
+            end
+
+            let(:warnings) { { boolean: boolean_warning } }
+
+            it 'outputs the warning' do
+              expect { subject }.to output(boolean_warning.warning_message).to_stderr
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/generator/swagger/warning_spec.rb

@@ -0,0 +1,51 @@
+require "spec_helper"
+
+describe Apipie::Generator::Swagger::Warning do
+  let(:code) { Apipie::Generator::Swagger::Warning::MISSING_METHOD_SUMMARY_CODE }
+  let(:method_id) { 'Examples#index' }
+  let(:info_message) { 'Something went wrong' }
+
+  let(:warning) { described_class.new(code, info_message, method_id) }
+
+  describe '#id' do
+    subject { warning.id }
+
+    it { is_expected.to eq("#{method_id}#{code}#{info_message}") }
+  end
+
+  describe '#warning_message' do
+    subject { warning.warning_message }
+
+    it { is_expected.to eq("WARNING (#{code}): [#{method_id}] -- #{info_message}") }
+  end
+
+  describe '#warn' do
+    subject { warning.warn }
+
+    it 'outputs the warning' do
+      expect { subject }.to output(warning.warning_message).to_stderr
+    end
+  end
+
+  describe '#warn_through_writer' do
+    subject { warning.warn }
+
+    it 'outputs the warning' do
+      expect { subject }.to output(warning.warning_message).to_stderr
+    end
+  end
+
+  describe '.for_code' do
+    subject { described_class.for_code(code, method_id) }
+
+    it { is_expected.to be_an_instance_of(described_class)}
+
+    context 'when code is invalid' do
+      let(:code) { 12345 }
+
+      it 'raises an argument error' do
+        expect { subject }.to raise_error(ArgumentError)
+      end
+    end
+  end
+end