apipie-rails 0.9.3 → 1.0.0

data/lib/tasks/apipie.rake

@@ -20,7 +20,7 @@ namespace :apipie do
   task :static, [:version] => :environment do |t, args|
     with_loaded_documentation do
       args.with_defaults(:version => Apipie.configuration.default_version)
-      out = ENV["OUT"] || File.join(::Rails.root, Apipie.configuration.doc_path, 'apidoc')
+      out = ENV["OUT"] || File.join(Rails.root, Apipie.configuration.doc_path, 'apidoc')
       subdir = File.basename(out)
       copy_jscss(out)
       Apipie.configuration.version_in_url = false
@@ -44,7 +44,7 @@ namespace :apipie do
   task :static_json, [:version] => :environment do |t, args|
     with_loaded_documentation do
       args.with_defaults(:version => Apipie.configuration.default_version)
-      out = ENV["OUT"] || File.join(::Rails.root, Apipie.configuration.doc_path, 'apidoc')
+      out = ENV["OUT"] || File.join(Rails.root, Apipie.configuration.doc_path, 'apidoc')
       ([nil] + Apipie.configuration.languages).each do |lang|
         doc = Apipie.to_json(args[:version], nil, nil, lang)
         generate_json_page(out, doc, lang)
@@ -55,7 +55,7 @@ namespace :apipie do
   desc "Generate static swagger json"
   task :static_swagger_json, [:version, :swagger_content_type_input, :filename_suffix] => :environment do |t, args|
     with_loaded_documentation do
-      out = ENV["OUT"] || File.join(::Rails.root, Apipie.configuration.doc_path, 'apidoc')
+      out = ENV["OUT"] || File.join(Rails.root, Apipie.configuration.doc_path, 'apidoc')
       generate_swagger_using_args(args, out)
     end
   end
@@ -68,7 +68,7 @@ namespace :apipie do
   desc "Did swagger output change since the last execution of this task?"
   task :did_swagger_change, [:version, :swagger_content_type_input, :filename_suffix] => :environment do |t, args|
     with_loaded_documentation do
-      out = ENV["OUT_REF"] || File.join(::Rails.root, Apipie.configuration.doc_path, 'apidoc_ref')
+      out = ENV["OUT_REF"] || File.join(Rails.root, Apipie.configuration.doc_path, 'apidoc_ref')
       paths = generate_swagger_using_args(args, out)
       paths.each {|path|
         existing_files_in_dir = Pathname(out).children(true)
@@ -123,17 +123,17 @@ namespace :apipie do
   # Default output dir ('public/apipie_cache') can be changed with OUT=/some/dir
   desc "Generate cache to avoid production dependencies on markup languages"
   task :cache => :environment do
-    puts "#{Time.now} | Started"
+    puts "#{Time.zone.now} | Started"
     cache_part = ENV['cache_part']
     generate_index = (cache_part == 'resources' ? false : true)
     generate_resources = (cache_part == 'index' ? false : true)
     with_loaded_documentation do
-      puts "#{Time.now} | Documents loaded..."
+      puts "#{Time.zone.now} | Documents loaded..."
       ([nil] + Apipie.configuration.languages).each do |lang|
         I18n.locale = lang || Apipie.configuration.default_locale
-        puts "#{Time.now} | Processing docs for #{lang}"
+        puts "#{Time.zone.now} | Processing docs for #{lang}"
         cache_dir = ENV["OUT"] || Apipie.configuration.cache_dir
-        subdir = Apipie.configuration.doc_base_url.sub(/\A\//,"")
+        subdir = Apipie.configuration.doc_base_url.sub(%r{\A/},"")
         subdir_levels = subdir.split('/').length
         subdir_traversal_prefix = '../' * subdir_levels
         file_base = File.join(cache_dir, Apipie.configuration.doc_base_url)
@@ -159,7 +159,7 @@ namespace :apipie do
         end
       end
     end
-    puts "#{Time.now} | Finished"
+    puts "#{Time.zone.now} | Finished"
   end
 
   # Attempt to use the Rails application views, otherwise default to built in views
@@ -195,10 +195,15 @@ namespace :apipie do
   end
 
   def generate_swagger_using_args(args, out)
-    args.with_defaults(:version => Apipie.configuration.default_version,
-                       :swagger_content_type_input => Apipie.configuration.swagger_content_type_input || :form_data,
-                       :filename_suffix => nil)
-    Apipie.configuration.swagger_content_type_input = args[:swagger_content_type_input].to_sym
+    args.with_defaults(
+      version: Apipie.configuration.default_version,
+      swagger_content_type_input: Apipie.configuration.generator.swagger.content_type_input,
+      filename_suffix: nil
+    )
+
+    Apipie.configuration.generator.swagger.content_type_input =
+      args[:swagger_content_type_input].to_sym
+
     count = 0
 
     sfx = args[:filename_suffix] || "_#{args[:swagger_content_type_input]}"
@@ -221,7 +226,7 @@ namespace :apipie do
     File.open("#{file_base}/#{filename}", 'w') { |file| file.write(JSON.pretty_generate(doc)) }
   end
 
-  def generate_swagger_json_page(file_base, doc, sfx="", lang = nil)
+  def generate_swagger_json_page(file_base, doc, sfx = "", lang = nil)
     FileUtils.mkdir_p(file_base) unless File.exist?(file_base)
 
     path = Pathname.new("#{file_base}/schema_swagger#{sfx}#{lang_ext(lang)}.json")
@@ -254,11 +259,11 @@ namespace :apipie do
   end
 
   def generate_resource_pages(version, file_base, doc, include_json = false, lang = nil)
-    doc[:docs][:resources].each do |resource_name, _|
-      resource_file_base = File.join(file_base, resource_name.to_s)
+    doc[:docs][:resources].each do |resource_id, _|
+      resource_file_base = File.join(file_base, resource_id.to_s)
       FileUtils.mkdir_p(File.dirname(resource_file_base)) unless File.exist?(File.dirname(resource_file_base))
 
-      doc = Apipie.to_json(version, resource_name, nil, lang)
+      doc = Apipie.to_json(version, resource_id, nil, lang)
       doc[:docs][:link_extension] = (lang ? ".#{lang}.html" : ".html")
       render_page("#{resource_file_base}#{lang_ext(lang)}.html", "resource", {:doc => doc[:docs],
         :resource => doc[:docs][:resources].first, :language => lang, :languages => Apipie.configuration.languages})
@@ -267,12 +272,12 @@ namespace :apipie do
   end
 
   def generate_method_pages(version, file_base, doc, include_json = false, lang = nil)
-    doc[:docs][:resources].each do |resource_name, resource_params|
+    doc[:docs][:resources].each do |resource_id, resource_params|
       resource_params[:methods].each do |method|
-        method_file_base = File.join(file_base, resource_name.to_s, method[:name].to_s)
+        method_file_base = File.join(file_base, resource_id.to_s, method[:name].to_s)
         FileUtils.mkdir_p(File.dirname(method_file_base)) unless File.exist?(File.dirname(method_file_base))
 
-        doc = Apipie.to_json(version, resource_name, method[:name], lang)
+        doc = Apipie.to_json(version, resource_id, method[:name], lang)
         doc[:docs][:link_extension] = (lang ? ".#{lang}.html" : ".html")
         render_page("#{method_file_base}#{lang_ext(lang)}.html", "method", {:doc => doc[:docs],
                                                            :resource => doc[:docs][:resources].first,

data/spec/controllers/api/v2/nested/resources_controller_spec.rb

@@ -1,8 +1,8 @@
 require 'spec_helper'
 
 describe Api::V2::Nested::ResourcesController do
-  describe "resource id" do
-    subject { Apipie.get_resource_name(Api::V2::Nested::ResourcesController) }
+  describe '.get_resource_id' do
+    subject { Apipie.get_resource_id(Api::V2::Nested::ResourcesController) }
 
     it "should have resource_id set" do
       expect(subject).to eq("resource")

data/spec/controllers/pets_controller_spec.rb

@@ -5,10 +5,6 @@ require 'apipie/rspec/response_validation_helper'
 require "json-schema"
 
 RSpec.describe PetsController, :type => :controller do
-  before :each do
-    Apipie.configuration.swagger_allow_additional_properties_in_response = false
-  end
-
   it "does not raise error when rendered output matches the described response" do
     response = get :return_and_validate_expected_response, format: :json
     expect(response).to match_declared_responses
@@ -39,7 +35,7 @@ RSpec.describe PetsController, :type => :controller do
     expect(response).not_to match_declared_responses
   end
 
-  it "raises error when a response has an extra property and 'swagger_allow_additional_properties_in_response' is false" do
+  it "raises error when a response has an extra property and 'swagger.allow_additional_properties_in_response' is false" do
     response = get :return_and_validate_extra_property, format: :json
     expect(response).not_to match_declared_responses
   end
@@ -50,26 +46,28 @@ RSpec.describe PetsController, :type => :controller do
     expect(response).not_to match_declared_responses
   end
 
-  it "does not raise error when a response has an extra property and 'swagger_allow_additional_properties_in_response' is true" do
-    Apipie.configuration.swagger_allow_additional_properties_in_response = true
-    response = get :return_and_validate_extra_property, format: :json
-    expect(response).to match_declared_responses
+  context "when allow_additional_properties_in_response is true'" do
+    before do
+      Apipie.configuration.generator.swagger.allow_additional_properties_in_response = true
+    end
+
+    it "does not raise error when a response has an extra property" do
+      response = get :return_and_validate_extra_property, format: :json
+      expect(response).to match_declared_responses
+    end
   end
 
   it "does not raise error when a response has an extra field and 'additional_properties' is specified in the response" do
-    Apipie.configuration.swagger_allow_additional_properties_in_response = false
     response = get :return_and_validate_allowed_extra_property, format: :json
     expect(response).to match_declared_responses
   end
 
   it "raises error when a response sub-object has an extra field and 'additional_properties' is not specified on it, but specified on the top level of the response" do
-    Apipie.configuration.swagger_allow_additional_properties_in_response = false
     response = get :sub_object_invalid_extra_property, format: :json
     expect(response).not_to match_declared_responses
   end
 
   it "does not raise error when a response sub-object has an extra field and 'additional_properties' is specified on it" do
-    Apipie.configuration.swagger_allow_additional_properties_in_response = false
     response = get :sub_object_allowed_extra_property, format: :json
     expect(response).to match_declared_responses
   end
@@ -86,7 +84,6 @@ RSpec.describe PetsController, :type => :controller do
 
   end
 
-
   describe "with array field" do
     it "no error for valid response" do
       response = get :returns_response_with_valid_array, format: :json
@@ -98,7 +95,4 @@ RSpec.describe PetsController, :type => :controller do
       expect(response).not_to match_declared_responses
     end
   end
-
-
-
 end

data/spec/controllers/users_controller_spec.rb

@@ -412,7 +412,7 @@ describe UsersController do
       expect(b.resource._id).to eq('users')
 
       expect(b.apis.count).to eq(1)
-      expect(b.formats).to eq(['json', 'jsonp'])
+      expect(b.formats).to eq(%w[json jsonp])
       api = b.apis.first
       expect(api.short_description).to eq("Show user profile")
       expect(api.path).to eq("/users/:id")
@@ -708,7 +708,7 @@ EOS2
       param = a.params[:array_param]
       expect(param.desc).to eq("\n<p>array validator</p>\n")
       expect(param.validator.class).to be(Apipie::Validator::EnumValidator)
-      expect(param.validator.instance_variable_get("@array")).to eq(["100", "one", "two", "1", "2"])
+      expect(param.validator.instance_variable_get("@array")).to eq(%w[100 one two 1 2])
 
       param = a.params[:proc_param]
       expect(param.desc).to eq("\n<p>proc validator</p>\n")

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

@@ -24,7 +24,7 @@ class PetsController < ApplicationController
   api :GET, "/pets/:id/as_properties", "Get a pet record"
   returns :code => 200 do
     property :pet_name, String, :desc => "Name of pet", :required => false
-    property :animal_type, ['dog','cat','iguana','kangaroo'], :desc => "Type of pet"   # required by default, because this is a 'property'
+    property :animal_type, %w[dog cat iguana kangaroo], :desc => "Type of pet"   # required by default, because this is a 'property'
   end
   returns :code => 404 do
     property :another_error_message, String, :desc => "Overriding the response description from the Pets resource"
@@ -40,7 +40,7 @@ class PetsController < ApplicationController
   #-----------------------------------------------------------
   def_param_group :pet do
     property :pet_name, String, :desc => "Name of pet", :required => false
-    property :animal_type, ['dog','cat','iguana','kangaroo'], :desc => "Type of pet"   # required by default, because this is a 'property'
+    property :animal_type, %w[dog cat iguana kangaroo], :desc => "Type of pet"   # required by default, because this is a 'property'
   end
 
   api :GET, "/pets/:id/as_param_group_of_properties", "Get a pet record"
@@ -70,7 +70,7 @@ class PetsController < ApplicationController
     param :pet_id, Integer, :desc => "id of pet", :required => true
     param :pet_name, String, :desc => "Name of pet", :required => false, :only_in => :response
     param :partial_match_allowed, [true, false], :desc => "Partial match allowed?", :required => false, :only_in => :request
-    property :animal_type, ['dog','cat','iguana','kangaroo'], :desc => "Type of pet"   # this is implicitly :only_in => :response
+    property :animal_type, %w[dog cat iguana kangaroo], :desc => "Type of pet"   # this is implicitly :only_in => :response
   end
 
   api :GET, "/pets/pet_by_id", "Get a pet record with the pet id in the body of the request"
@@ -142,7 +142,7 @@ class PetsController < ApplicationController
   end
   returns :code => 204 do
     property :int_array, :array_of => Integer
-    property :enum_array, :array_of => ['v1','v2','v3']
+    property :enum_array, :array_of => %w[v1 v2 v3]
   end
   returns :code => :unprocessable_entity, :desc => "Fleas were discovered on the pet" do
     param_group :pet

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

@@ -14,7 +14,7 @@ class Pet
   def self.describe_own_properties
     [
         Apipie::prop(:pet_name, 'string', {:description => 'Name of pet', :required => false}),
-        Apipie::prop(:animal_type, 'string', {:description => 'Type of pet', :values => ["dog", "cat", "iguana", "kangaroo"]}),
+        Apipie::prop(:animal_type, 'string', {:description => 'Type of pet', :values => %w[dog cat iguana kangaroo]}),
         Apipie::additional_properties(false)
     ]
   end
@@ -27,7 +27,7 @@ class PetWithMeasurements
   def self.describe_own_properties
     [
         Apipie::prop(:pet_name, 'string', {:description => 'Name of pet', :required => false}),
-        Apipie::prop('animal_type', 'string', {:description => 'Type of pet', :values => ["dog", "cat", "iguana", "kangaroo"]}),
+        Apipie::prop('animal_type', 'string', {:description => 'Type of pet', :values => %w[dog cat iguana kangaroo]}),
         Apipie::prop(:pet_measurements, 'object', {}, [
             Apipie::prop(:weight, 'number', {:description => "Weight in pounds" }),
             Apipie::prop(:height, 'number', {:description => "Height in inches" }),

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

@@ -31,7 +31,7 @@ class TwitterExampleController < ApplicationController
   
   api :GET, '/twitter_example/profile_image/:screen_name', 'Access the profile image in various sizes for the user with the indicated screen_name.'
   param :screen_name, String, :required => true, :desc => 'The screen name of the user for whom to return results for. Helpful for disambiguating when a valid screen name is also a user ID.'
-  param :size, ['bigger','normal','mini','original'], :desc => <<-EOS
+  param :size, %w[bigger normal mini original], :desc => <<-EOS
     Specifies the size of image to fetch. Not specifying a size will give the default, normal size of 48px by 48px. Valid options include:
 
     * bigger - 73px by 73px
@@ -166,7 +166,7 @@ class TwitterExampleController < ApplicationController
   param :user_id, Integer, :desc => 'The ID of the user for whom to return results for. Helpful for disambiguating when a valid user ID is also a valid screen name.'
   param :screen_name, String, :desc => 'The screen name of the user for whom to return results for. Helpful for disambiguating when a valid screen name is also a user ID.'
   param :include_entities, String
-  param :skip_status, ['t','true','1'],
+  param :skip_status, %w[t true 1],
     :description => 'When set to either true, t or 1 statuses will not be included in the returned user objects.'
 
   description "Look at examples."

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

@@ -170,14 +170,14 @@ class UsersController < ApplicationController
   eos
   api :GET, "/users/:id", "Show user profile"
   show false
-  formats ['json', 'jsonp']
+  formats %w[json jsonp]
   error 401, "Unauthorized"
   error :code => 404, :description => "Not Found"
   param :id, Integer, :desc => "user id", :required => true
   param :session, String, :desc => "user is logged in", :required => true, :missing_message => lambda { "session_parameter_is_required" }
   param :regexp_param, /^[0-9]* years/, :desc => "regexp param"
   param :regexp2, /\b[A-Z0-9._%+-=]+@[A-Z0-9.-]+.[A-Z]{2,}\b/i, :desc => "email regexp"
-  param :array_param, ["100", "one", "two", "1", "2"], :desc => "array validator"
+  param :array_param, %w[100 one two 1 2], :desc => "array validator"
   param :boolean_param, [true, false], :desc => "array validator with boolean"
   param :proc_param, lambda { |val|
     val == "param value" ? true : "The only good value is 'param value'."
@@ -211,7 +211,7 @@ class UsersController < ApplicationController
   def_param_group :user do
     param :user, Hash, :desc => "User info", :required => true, :action_aware => true do
       param_group :credentials
-      param :membership, ["standard","premium"], :desc => "User membership", :allow_nil => false
+      param :membership, %w[standard premium], :desc => "User membership", :allow_nil => false
     end
   end
 
@@ -269,13 +269,13 @@ class UsersController < ApplicationController
   end
 
   api :GET, '/users/by_department', 'show users from a specific department'
-  param :department, ["finance", "operations", "sales", "marketing", "HR"], required: false, default_value: "sales"
+  param :department, %w[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']
+  param :departments, Array, in: %w[finance operations sales marketing HR], default_value: ['sales']
   def get_in_departments
     render :plain => 'nothing to see here'
   end

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

data/spec/lib/apipie/apipies_controller_spec.rb

@@ -209,6 +209,7 @@ describe Apipie::ApipiesController, type: :controller do
       get :index
       expect(test).to eq(true)
     end
+
     it "remove all resources" do
       Apipie.configuration.authorize = Proc.new do |&args|
         false
@@ -216,6 +217,7 @@ describe Apipie::ApipiesController, type: :controller do
       get :index
       expect(assigns(:doc)[:resources]).to eq({})
     end
+
     it "remove all methods" do
       Apipie.configuration.authorize = Proc.new do |controller, method, doc|
         !method
@@ -225,6 +227,7 @@ describe Apipie::ApipiesController, type: :controller do
       expect(assigns(:doc)[:resources]["twitter_example"][:methods]).to eq([])
       expect(assigns(:doc)[:resources]["users"][:methods]).to eq([])
     end
+
     it "remove specific method" do
       Apipie.configuration.authorize = nil
       get :index
@@ -241,6 +244,7 @@ describe Apipie::ApipiesController, type: :controller do
       expect(assigns(:doc)[:resources]["users"][:methods].size).to eq(users_methods - 1)
       expect(assigns(:doc)[:resources]["twitter_example"][:methods].size).to eq(twitter_example_methods)
     end
+
     it "does not allow access to swagger when authorization is set" do
       get :index, :params => { :format => "json", :type => "swagger"}
 

data/spec/lib/apipie/application_spec.rb

@@ -16,37 +16,47 @@ describe Apipie::Application do
 
   end
 
-  describe "get_resource_name" do
-    subject {Apipie.get_resource_name(Api::V2::Nested::ArchitecturesController)}
+  shared_examples 'resource id' do
+    let(:resource_class) { Api::V2::Nested::ArchitecturesController }
+    let(:base_url) { '/some-api' }
+
+    before { allow(described_class).to receive(:get_base_url).and_return(base_url) }
 
     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
+      after { Apipie.configuration.namespaced_resources = false }
 
+      it "returns the namespaces" do
+        is_expected.to eq('api-v2-nested-architectures')
       end
 
       context "with an undefined base url" do
-        before {allow(Apipie.app).to receive(:get_base_url).and_return(nil)}
+        let(:base_url) { nil }
 
         it "should not raise an error" do
-          expect { Apipie.get_resource_name(Api::V2::ArchitecturesController) }.
-            not_to raise_error
+          expect { method_call }.not_to raise_error
         end
       end
-
-      after { Apipie.configuration.namespaced_resources = false }
     end
 
-    context "with namespaced_resources enabled" do
+    context "with namespaced_resources disabled" 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))
+      it "returns the controller name" do
+        is_expected.to eq('architectures')
       end
     end
   end
+
+  describe '.get_resource_id' do
+    subject(:method_call) { Apipie.get_resource_id(resource_class) }
+
+    it_behaves_like 'resource id'
+  end
+
+  describe '.get_resource_name' do
+    subject(:method_call) { Apipie.get_resource_name(resource_class) }
+
+    it_behaves_like 'resource id'
+  end
 end

data/spec/lib/apipie/configuration_spec.rb

@@ -20,4 +20,19 @@ describe 'Apipie::Configuration' do
       end
     end
   end
+
+  describe 'generator configuration' do
+    let(:generator_config) { configuration.generator }
+
+    describe '#swagger' do
+      subject(:setter) { generator_config.swagger.include_warning_tags = true }
+
+      it 'assigns the correct value' do
+        expect { setter }
+          .to change(configuration.generator.swagger, :include_warning_tags?)
+          .from(false)
+          .to(true)
+      end
+    end
+  end
 end

data/spec/lib/apipie/generator/swagger/config_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Apipie::Generator::Swagger::Config do
+  let(:config) { described_class.clone.instance }
+
+  before { Singleton.__init__(described_class) }
+
+  describe 'deprecation warnings' do
+    context 'when a deprecated method is call' do
+      subject(:deprecated_method_call) { config.swagger_include_warning_tags? }
+
+      it 'returns a deprecations warning' do
+        expect { deprecated_method_call }
+          .to output(/DEPRECATION WARNING: config.swagger_include_warning_tags is deprecated/)
+          .to_stderr
+      end
+    end
+  end
+end

data/spec/lib/apipie/generator/swagger/context_spec.rb

@@ -4,18 +4,23 @@ describe Apipie::Generator::Swagger::Context do
   let(:allow_null) { true }
   let(:in_schema) { true }
   let(:http_method) { 'get' }
+  let(:prefix) { nil }
 
-  subject do
+  let(:context_instance) do
     described_class.new(
       allow_null: allow_null,
       http_method: http_method,
       in_schema: in_schema,
-      controller_method: 'show'
+      controller_method: 'show',
+      prefix: prefix
     )
   end
 
   describe '#in_schema?' do
+    subject { context_instance }
+
     it { is_expected.to be_in_schema }
+
     context 'when in_schema is false' do
       let(:in_schema) { false }
 
@@ -24,6 +29,8 @@ describe Apipie::Generator::Swagger::Context do
   end
 
   describe '#allow_null?' do
+    subject { context_instance }
+
     it { is_expected.to be_allow_null }
 
     context 'when allow_null is false' do
@@ -32,4 +39,18 @@ describe Apipie::Generator::Swagger::Context do
       it { is_expected.not_to be_allow_null }
     end
   end
+
+  describe '#add_to_prefix!' do
+    before { context_instance.add_to_prefix!('some-prefix') }
+
+    subject { context_instance.prefix }
+
+    it { is_expected.to eq('some-prefix') }
+
+    context 'when context has already a prefix' do
+      let(:prefix) { 'existing-prefix' }
+
+      it { is_expected.to eq('existing-prefix[some-prefix]') }
+    end
+  end
 end

data/spec/lib/apipie/generator/swagger/method_description/api_schema_service_spec.rb

@@ -0,0 +1,106 @@
+require 'spec_helper'
+
+describe Apipie::Generator::Swagger::MethodDescription::ApiSchemaService do
+  let(:path) { '/api' }
+  let(:http_method) { 'get' }
+  let(:resource_id) { 'users' }
+  let(:method_description_description) { nil }
+  let(:tags) { [] }
+
+  let(:dsl_data) do
+    ActionController::Base
+      .send(:_apipie_dsl_data_init)
+      .merge(
+        {
+          description: method_description_description,
+          api_args: [[http_method, path, 'Some api description', { deprecated: true }]],
+          tag_list: tags
+        }
+      )
+  end
+
+  let(:resource_desc) do
+    Apipie::ResourceDescription.new(UsersController, resource_id)
+  end
+
+  let(:method_description) do
+    Apipie::Generator::Swagger::MethodDescription::Decorator.new(
+      Apipie::MethodDescription.new(:show, resource_desc, dsl_data)
+    )
+  end
+
+  let(:service) { described_class.new(method_description) }
+
+  describe '#call' do
+    subject(:schema) { service.call }
+
+    it 'returns the path' do
+      expect(schema).to include(path)
+    end
+
+    it 'returns the http method' do
+      expect(schema[path]).to include(http_method)
+    end
+
+    it 'returns the correct attributes' do
+      expect(schema[path][http_method].keys).to include(
+        :tags,
+        :consumes,
+        :operationId,
+        :parameters,
+        :responses
+      )
+    end
+  end
+
+  describe 'tags' do
+    subject { service.call[path][http_method][:tags] }
+
+    it { is_expected.to eq([resource_id]) }
+
+    context 'when tags are available' do
+      let(:tags) { ['Tag 1', 'Tag 2'] }
+
+      it { is_expected.to include(*tags) }
+    end
+
+    context 'when Apipie.configuration.generator.swagger.include_warning_tags is enabled' do
+      before { Apipie.configuration.generator.swagger.include_warning_tags = true }
+
+      context 'when warnings are issued' do
+        before do
+          Apipie::Generator::Swagger::Warning.for_code(
+            Apipie::Generator::Swagger::Warning::MISSING_METHOD_SUMMARY_CODE,
+            'some_method'
+          ).warn_through_writer
+        end
+
+        it { is_expected.to include('warnings issued') }
+      end
+    end
+  end
+
+  describe 'consumes' do
+    subject { service.call[path]['get'][:consumes] }
+
+    it { is_expected.to eq(['application/x-www-form-urlencoded', 'multipart/form-data']) }
+
+    context 'when content type input is json' do
+      before { Apipie.configuration.generator.swagger.content_type_input = :json }
+
+      it { is_expected.to eq(['application/json']) }
+    end
+  end
+
+  describe 'description' do
+    subject { service.call[path]['get'][:description] }
+
+    it { is_expected.to be_blank }
+
+    context 'when description for method description exists' do
+      let(:method_description_description) { 'Some description' }
+
+      it { is_expected.to eq(method_description_description) }
+    end
+  end
+end