apipie-rails 0.3.6 → 0.5.17

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

@@ -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,19 @@ 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/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 +291,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/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', __FILE__)
+
+# 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

@@ -8,6 +8,7 @@ require "action_mailer/railtie"
 
 Bundler.require
 require "apipie-rails"
+require "test_engine"
 
 module Dummy
   class Application < Rails::Application
@@ -41,5 +42,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, Concerns::ExtendingConcern)
+    end
   end
 end

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

@@ -21,5 +21,8 @@ Dummy::Application.configure do
 
   # 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

@@ -46,4 +46,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

@@ -32,4 +32,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"
 

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
@@ -10,8 +12,13 @@ Dummy::Application.routes.draw do
       end
       resources :concerns, :only => [:index, :show]
       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 +28,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/lib/extractor/writer_spec.rb

@@ -57,10 +57,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 overriden in configuration' do
+    around(:each) do |example|
+      standard_path = Apipie.configuration.doc_path
+      Apipie.configuration.doc_path = '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, '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
 

data/spec/lib/file_handler_spec.rb

@@ -0,0 +1,18 @@
+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
+  end
+end

data/spec/lib/method_description_spec.rb

@@ -36,6 +36,13 @@ describe Apipie::MethodDescription do
       method = Apipie::MethodDescription.new(:a, @resource, dsl_data)
       expect(method.method_apis_to_json.first[:deprecated]).to eq(true)
     end
+
+    it "should return the deprecated flag if resource is deprecated" do
+      @resource.instance_variable_set("@_deprecated", true)
+      dsl_data[:api_args] = [[:GET, "/foo/bar", "description", {}]]
+      method = Apipie::MethodDescription.new(:a, @resource, dsl_data)
+      expect(method.method_apis_to_json.first[:deprecated]).to eq(true)
+    end
   end
 
   describe "params descriptions" do
@@ -61,4 +68,31 @@ describe Apipie::MethodDescription do
 
   end
 
+  describe "response-only properties" do
+    before(:each) do
+      @resource = Apipie::ResourceDescription.new(ApplicationController, "dummy")
+      dsl_data[:params] = [[:a, String, nil, {:only_in => :request}, nil],
+                           [:b, String, nil, {:only_in => :response}, nil],
+                           [:c, String, nil, {}, nil]]
+      @method = Apipie::MethodDescription.new(:a, @resource, dsl_data)
+      @resource.add_method_description @method
+    end
+
+    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'])
+    end
+  end
+
+
+  describe "'returns' properties" do
+    it "should raise an error if both :param_group and :array_of are specified in 'returns'" 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)
+    end
+  end
+
+
 end