apipie-rails 0.9.1 → 0.9.2

data/lib/apipie/version.rb

@@ -1,3 +1,3 @@
 module Apipie
-  VERSION = "0.9.1"
+  VERSION = "0.9.2"
 end

data/lib/apipie-rails.rb

@@ -27,7 +27,16 @@ require "apipie/version"
 require "apipie/swagger_generator"
 require "apipie/generator/generator"
 require "apipie/generator/swagger/swagger"
+require "apipie/generator/swagger/operation_id"
 require "apipie/generator/swagger/warning"
 require "apipie/generator/swagger/warning_writer"
 require "apipie/generator/swagger/type"
 require "apipie/generator/swagger/type_extractor"
+require "apipie/generator/swagger/context"
+require "apipie/generator/swagger/param_description"
+require "apipie/generator/swagger/param_description/builder"
+require "apipie/generator/swagger/param_description/composite"
+require "apipie/generator/swagger/param_description/description"
+require "apipie/generator/swagger/param_description/in"
+require "apipie/generator/swagger/param_description/name"
+require "apipie/generator/swagger/param_description/type"

data/lib/tasks/apipie.rake

@@ -150,12 +150,11 @@ namespace :apipie do
           doc[:docs][:link_extension] = (lang ? ".#{lang}.html" : ".html")
 
           generate_index_page(file_base_version, doc, true, true, lang) if generate_index
-          if generate_resources
-            Apipie.url_prefix = "../#{subdir_traversal_prefix}#{subdir}"
-            generate_resource_pages(version, file_base_version, doc, true, lang)
-            Apipie.url_prefix = "../../#{subdir_traversal_prefix}#{subdir}"
-            generate_method_pages(version, file_base_version, doc, true, lang)
-          end
+          next unless generate_resources
+          Apipie.url_prefix = "../#{subdir_traversal_prefix}#{subdir}"
+          generate_resource_pages(version, file_base_version, doc, true, lang)
+          Apipie.url_prefix = "../../#{subdir_traversal_prefix}#{subdir}"
+          generate_method_pages(version, file_base_version, doc, true, lang)
         end
       end
     end

data/spec/controllers/users_controller_spec.rb

@@ -5,9 +5,10 @@ def compare_hashes(h1, h2)
     expect(h1).to eq(h2)
   else
     h1.each do |key, val|
-      if val.is_a? Hash
+      case val
+      when Hash
         compare_hashes val, h2[key]
-      elsif val.is_a? Array
+      when Array
         val.each_with_index do |v, i|
           compare_hashes val[i], h2[key][i]
         end

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

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe Apipie::Generator::Swagger::Context do
+  let(:allow_null) { true }
+  let(:in_schema) { true }
+  let(:http_method) { 'get' }
+
+  subject do
+    described_class.new(
+      allow_null: allow_null,
+      http_method: http_method,
+      in_schema: in_schema,
+      controller_method: 'show'
+    )
+  end
+
+  describe '#in_schema?' do
+    it { is_expected.to be_in_schema }
+    context 'when in_schema is false' do
+      let(:in_schema) { false }
+
+      it { is_expected.not_to be_in_schema }
+    end
+  end
+
+  describe '#allow_null?' do
+    it { is_expected.to be_allow_null }
+
+    context 'when allow_null is false' do
+      let(:allow_null) { false }
+
+      it { is_expected.not_to be_allow_null }
+    end
+  end
+end

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

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+describe Apipie::Generator::Swagger::OperationId do
+  let(:path) { '/api' }
+  let(:http_method) { :GET }
+  let(:param) {}
+
+  let(:operation_id) do
+    described_class.new(path: path, http_method: http_method, param: param)
+  end
+
+  describe '#to_s' do
+    subject { operation_id.to_s}
+
+    it { is_expected.to eq('get_api') }
+
+    context 'when path has variable' do
+      let(:path) { '/api/users/:id' }
+
+      it { is_expected.to eq("#{http_method.downcase}_api_users_id") }
+    end
+
+    context 'when param is given' do
+      let(:param) { 'show' }
+
+      it { is_expected.to eq("#{http_method.downcase}_api_param_show") }
+    end
+  end
+
+  describe '.from' do
+    subject { described_class.from(describable).to_s }
+
+    context 'when an Apipie::MethodDescription::Api is given' do
+      let(:describable) do
+        Apipie::MethodDescription::Api.
+          new(http_method, path, '', { from_routes: '' })
+      end
+
+      it { is_expected.to eq("#{http_method.downcase}_api") }
+    end
+
+    context 'when an Apipie::MethodDescription is given' do
+      let(:dsl_data) do
+        ActionController::Base.
+          send(:_apipie_dsl_data_init).
+          merge({
+            api_args: [[http_method, path, "description", { :deprecated => true }]]
+          })
+      end
+
+      let(:resource_desc) do
+        Apipie::ResourceDescription.new(UsersController, "users")
+      end
+
+      let(:describable) do
+        Apipie::MethodDescription.new(:show, resource_desc, dsl_data)
+      end
+
+      it { is_expected.to eq("#{http_method.downcase}_api") }
+    end
+  end
+end
+

data/spec/lib/generator/swagger/param_description/builder_spec.rb

@@ -0,0 +1,163 @@
+require 'spec_helper'
+
+describe Apipie::Generator::Swagger::ParamDescription::Builder do
+  let(:validator) { String }
+  let(:validator_options) { {} }
+  let(:path) { '/api' }
+  let(:http_method) { :GET }
+  let(:in_schema) { true }
+  let(:builder) do
+    described_class.new(
+      param_description,
+      in_schema: in_schema,
+      controller_method: 'show'
+    )
+  end
+  let(:generated_block) { builder.to_swagger }
+  let(:base_param_description_options) { {} }
+
+  let(:param_description_options) do
+    base_param_description_options.merge(validator_options)
+  end
+
+  let(:base_dsl_data) do
+    {
+      :api => false,
+      :api_args => [],
+      :api_from_routes => nil,
+      :errors => [],
+      :tag_list => [],
+      :returns => {},
+      :params => [],
+      :headers => [],
+      :resource_id => nil,
+      :short_description => nil,
+      :description => nil,
+      :examples => [],
+      :see => [],
+      :formats => nil,
+      :api_versions => [],
+      :meta => nil,
+      :show => true,
+      :deprecated => false
+    }
+  end
+
+  let(:dsl_data) do
+    base_dsl_data.merge({
+      api_args: [
+        [
+          http_method,
+          path,
+          'description',
+          { deprecated: true }
+        ]
+      ]
+    })
+  end
+
+  let(:resource_desc) do
+    Apipie::ResourceDescription.new(UsersController, 'dummy')
+  end
+
+  let(:method_desc) do
+    Apipie::MethodDescription.new(:show, resource_desc, dsl_data)
+  end
+
+  let(:param_description) do
+    Apipie::ParamDescription.new(
+      method_desc,
+      :param,
+      validator,
+      param_description_options
+    )
+  end
+
+  describe 'required' do
+    subject { generated_block[:required] }
+
+    it { is_expected.to be_blank }
+
+    context 'when in_schema is false' do
+      let(:in_schema) { false }
+
+      it { is_expected.to be_blank }
+
+      context 'and is required' do
+        let(:base_param_description_options) { { required: true } }
+
+        it { is_expected.to eq(true) }
+      end
+    end
+  end
+
+  describe 'warning' do
+    before { Singleton.__init__(Apipie::Generator::Swagger::WarningWriter) }
+
+    subject { generated_block }
+
+    context 'when is not required' do
+      let(:base_param_description_options) { { required: false } }
+
+      context 'and no default is given' do
+        before { param_description_options.delete(:default) }
+
+        it 'outputs an option without default warning' do
+          expect { subject }.to output(/is optional but default value is not specified/).to_stderr
+        end
+      end
+    end
+  end
+
+  describe '.with_type' do
+    subject { generated_block[:type] }
+
+    it { is_expected.to be_blank }
+
+    context 'when type is assigned' do
+      before { builder.with_type(with_null: false ) }
+
+      it { is_expected.to be_present }
+    end
+  end
+
+  describe '.with_description' do
+    subject { generated_block[:description] }
+
+    it { is_expected.to be_blank }
+
+    context 'when description is assigned' do
+      let(:param_description_options) { { desc: 'some-description' } }
+
+      before { builder.with_description(language: 'en') }
+
+      it { is_expected.to be_present }
+    end
+  end
+
+  describe '.with_name' do
+    subject { generated_block[:name] }
+
+    it { is_expected.to be_blank }
+
+    context 'when name is assigned' do
+      before { builder.with_name }
+
+      it { is_expected.to be_present }
+    end
+  end
+
+  describe '.with_in' do
+    subject { generated_block[:in] }
+
+    it { is_expected.to be_blank }
+
+    context 'when in is assigned' do
+      let(:in_schema) { false }
+
+      before { builder.with_in(http_method: 'get') }
+
+      it { is_expected.to be_present }
+    end
+  end
+end

data/spec/lib/generator/swagger/param_description/composite_spec.rb

@@ -0,0 +1,95 @@
+require 'spec_helper'
+
+describe Apipie::Generator::Swagger::ParamDescription::Composite do
+  let(:param_descriptions) {}
+
+  let(:dsl_data) { ActionController::Base.send(:_apipie_dsl_data_init) }
+
+  let(:resource_desc) do
+    Apipie::ResourceDescription.new(UsersController, "users")
+  end
+
+  let(:context) do
+    Apipie::Generator::Swagger::Context.new(
+      allow_null: true,
+      http_method: 'get',
+      controller_method: 'show'
+    )
+  end
+
+  let(:method_description) do
+    Apipie::MethodDescription.new(:create, resource_desc, dsl_data)
+  end
+
+  let(:composite) { described_class.new(param_descriptions, context) }
+
+  let(:swagger) { composite.to_swagger }
+
+  let(:params_description_one) do
+    Apipie::ParamDescription.new(method_description, :some_param, String)
+  end
+
+  let(:params_description_two) do
+    Apipie::ParamDescription.new(method_description, :some_other_param, String)
+  end
+
+  let(:param_descriptions) { [params_description_one, params_description_two] }
+
+  context 'when no param descriptions are given' do
+    let(:param_descriptions) { [] }
+
+    subject { swagger }
+
+    it { is_expected.to be_blank }
+  end
+
+  describe 'additionalProperties' do
+    subject { swagger[:additionalProperties] }
+
+    it { is_expected.to be_falsey }
+
+    context 'when additional properties in response allowed' do
+      before do
+        Apipie.configuration.swagger_allow_additional_properties_in_response = true
+      end
+
+      it { is_expected.to be_blank }
+    end
+  end
+
+  xdescribe 'nested additionalProperties' do
+    context 'when param description has nested params' do
+      let(:validator) do
+
+      end
+
+      let(:params_description_one) do
+        Apipie::ParamDescription.new(
+          method_description,
+          :some_param,
+          validator,
+          { required: true }
+        )
+      end
+    end
+  end
+
+  describe 'required' do
+    subject { swagger[:required] }
+
+    it { is_expected.to be_blank }
+
+    context 'when param description is required' do
+      let(:params_description_one) do
+        Apipie::ParamDescription.new(
+          method_description,
+          :some_param,
+          String,
+          { required: true }
+        )
+      end
+
+      it { is_expected.to be_truthy }
+    end
+  end
+end

data/spec/lib/generator/swagger/param_description/description_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+
+describe Apipie::Generator::Swagger::ParamDescription::Description do
+  let(:param_description_options) { {} }
+  let(:http_method) { :GET }
+  let(:path) { '/api' }
+  let(:validator) { String }
+  let(:language) {}
+
+  let(:base_dsl_data) do
+    {
+      :api => false,
+      :api_args => [],
+      :api_from_routes => nil,
+      :errors => [],
+      :tag_list => [],
+      :returns => {},
+      :params => [],
+      :headers => [],
+      :resource_id => nil,
+      :short_description => nil,
+      :description => nil,
+      :examples => [],
+      :see => [],
+      :formats => nil,
+      :api_versions => [],
+      :meta => nil,
+      :show => true,
+      :deprecated => false
+    }
+  end
+
+  let(:dsl_data) do
+    base_dsl_data.merge({
+      api_args: [
+        [
+          http_method,
+          path,
+          'description',
+          { deprecated: true }
+        ]
+      ]
+    })
+  end
+
+  let(:resource_desc) do
+    Apipie::ResourceDescription.new(UsersController, 'dummy')
+  end
+
+  let(:method_desc) do
+    Apipie::MethodDescription.new(:show, resource_desc, dsl_data)
+  end
+
+  let(:param_description) do
+    Apipie::ParamDescription.new(
+      method_desc,
+      :param,
+      validator,
+      param_description_options
+    )
+  end
+
+  let(:description_definition) do
+    described_class.new(param_description, language: language).to_hash
+  end
+
+  describe 'description' do
+    subject { description_definition[:description] }
+
+    it { is_expected.to be_blank }
+
+    context 'when desc is given to options' do
+      let(:desc) { 'Some description' }
+      let(:param_description_options) { { desc: desc } }
+
+      it { is_expected.to eq(desc) }
+    end
+  end
+end

data/spec/lib/generator/swagger/param_description/in_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+
+describe Apipie::Generator::Swagger::ParamDescription::In do
+  let(:validator_options) { {} }
+  let(:param_description_options) { {}.merge(validator_options) }
+  let(:with_null) { false }
+  let(:http_method) { :GET }
+  let(:path) { '/api' }
+  let(:validator) { String }
+  let(:default_in_value) { 'kati' }
+  let(:in_schema) { true }
+
+  let(:base_dsl_data) do
+    {
+      :api => false,
+      :api_args => [],
+      :api_from_routes => nil,
+      :errors => [],
+      :tag_list => [],
+      :returns => {},
+      :params => [],
+      :headers => [],
+      :resource_id => nil,
+      :short_description => nil,
+      :description => nil,
+      :examples => [],
+      :see => [],
+      :formats => nil,
+      :api_versions => [],
+      :meta => nil,
+      :show => true,
+      :deprecated => false
+    }
+  end
+
+  let(:dsl_data) do
+    base_dsl_data.merge({
+      api_args: [
+        [
+          http_method,
+          path,
+          'description',
+          { deprecated: true }
+        ]
+      ]
+    })
+  end
+
+  let(:resource_desc) do
+    Apipie::ResourceDescription.new(UsersController, 'dummy')
+  end
+
+  let(:method_desc) do
+    Apipie::MethodDescription.new(:show, resource_desc, dsl_data)
+  end
+
+  let(:param_description) do
+    Apipie::ParamDescription.new(
+      method_desc,
+      :param,
+      validator,
+      param_description_options
+    )
+  end
+
+  let(:in_definition) do
+    described_class.new(
+      param_description,
+      default_in_value: default_in_value,
+      http_method: http_method,
+      in_schema: in_schema
+    ).to_hash
+  end
+
+  describe 'in' do
+    subject { in_definition[:in] }
+
+    it { is_expected.to be_blank }
+
+    context 'when in_schema is false' do
+      let(:in_schema) { false }
+
+      it { is_expected.to eq(default_in_value) }
+    end
+  end
+end

data/spec/lib/generator/swagger/param_description/name_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+
+describe Apipie::Generator::Swagger::ParamDescription::Name do
+  let(:validator_options) { {} }
+  let(:param_description_options) { {}.merge(validator_options) }
+  let(:with_null) { false }
+  let(:http_method) { :GET }
+  let(:path) { '/api' }
+  let(:validator) { String }
+  let(:prefixed_by) {}
+
+  let(:base_dsl_data) do
+    {
+      :api => false,
+      :api_args => [],
+      :api_from_routes => nil,
+      :errors => [],
+      :tag_list => [],
+      :returns => {},
+      :params => [],
+      :headers => [],
+      :resource_id => nil,
+      :short_description => nil,
+      :description => nil,
+      :examples => [],
+      :see => [],
+      :formats => nil,
+      :api_versions => [],
+      :meta => nil,
+      :show => true,
+      :deprecated => false
+    }
+  end
+
+  let(:dsl_data) do
+    base_dsl_data.merge({
+      api_args: [
+        [
+          http_method,
+          path,
+          'description',
+          { deprecated: true }
+        ]
+      ]
+    })
+  end
+
+  let(:resource_desc) do
+    Apipie::ResourceDescription.new(UsersController, 'dummy')
+  end
+
+  let(:method_desc) do
+    Apipie::MethodDescription.new(:show, resource_desc, dsl_data)
+  end
+
+  let(:param_description) do
+    Apipie::ParamDescription.new(
+      method_desc,
+      :param,
+      validator,
+      param_description_options
+    )
+  end
+
+  let(:name_definition) do
+    described_class.new(
+      param_description,
+      prefixed_by: prefixed_by
+    ).to_hash
+  end
+
+  subject { name_definition[:name] }
+
+  it { is_expected.to eq(param_description.name) }
+
+  context 'when prefixed by is given' do
+    let(:prefixed_by) { 'some-prefix' }
+
+    it { is_expected.to eq("#{prefixed_by}[#{param_description.name}]") }
+  end
+end