apipie-rails-jq 1.4.3.pre.beta.pre.jq.1

data/spec/lib/apipie/extractor/writer_spec.rb

@@ -0,0 +1,112 @@
+require "spec_helper"
+
+describe Apipie::Extractor::Writer do
+
+  let(:collector) { double "collector" }
+  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) do
+    {
+    "concern_resources#show" =>
+      [{
+        :controller=>ConcernsController,
+        :action=>"show",
+        :verb=>:GET,
+        :path=>"/api/concerns/5",
+        :params=>{},
+        :query=>"session=secret_hash",
+        :request_data=>nil,
+        :response_data=>"OK {\"session\"=>\"secret_hash\", \"id\"=>\"5\", \"controller\"=>\"concerns\", \"action\"=>\"show\"}",
+        :code=>"200"
+      }, {
+        :controller=>ConcernsController,
+        :action=>"show",
+        :verb=>:GET,
+        :path=>"/api/concerns/5",
+        :params=>{},
+        :query=>"",
+        :request_data=>nil,
+        :response_data=>"OK {\"id\"=>\"5\", \"controller\"=>\"concerns\", \"action\"=>\"show\"}",
+        :code=>"200"
+      }]
+    }
+  end
+  let(:loaded_records) do
+    {
+    "concern_resources#show" =>
+      [{
+        "verb"=>:GET,
+        "path"=>"/api/concerns/5",
+        "versions"=>["development"],
+        "query"=>"session=secret_hash",
+        "request_data"=>nil,
+        "response_data"=>"OK {\"session\"=>\"secret_hash\", \"id\"=>\"5\", \"controller\"=>\"concerns\", \"action\"=>\"show\"}",
+        "code"=>"200",
+        "show_in_doc"=>1,
+        "recorded"=>true
+      }, {
+        "verb"=>:GET,
+        "path"=>"/api/concerns/5",
+        "versions"=>["development"],
+        "query"=>"",
+        "request_data"=>nil,
+        "response_data"=>"OK {\"id\"=>\"5\", \"controller\"=>\"concerns\", \"action\"=>\"show\"}",
+        "code"=>"200",
+        "show_in_doc"=>0,
+        "recorded"=>true
+      }]
+    }
+  end
+
+  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 'uses 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 'writes 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 'reads 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
+
+  describe "storing of examples" do
+    before do
+      allow(writer_class).to receive(:examples_file) { test_examples_file }
+      expect(collector).to receive(:records).and_return(records)
+    end
+
+    it "reads and write examples" do
+      writer.write_examples
+      expect(writer.send(:load_recorded_examples)).to eql(loaded_records)
+    end
+
+    after do
+      File.unlink(test_examples_file) if File.exist?(test_examples_file)
+    end
+  end
+end

data/spec/lib/apipie/extractor_spec.rb

@@ -0,0 +1,9 @@
+require "spec_helper"
+
+describe Apipie::Extractor do
+  it 'handles routes without (.:format)' do
+    Apipie::Extractor.apis_from_routes.each_value do |apis|
+      apis.each { |api| expect(api[:path]).not_to be_nil }
+    end
+  end
+end

data/spec/lib/apipie/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 contains 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/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

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+describe Apipie::Generator::Swagger::Context do
+  let(:allow_null) { true }
+  let(:in_schema) { true }
+  let(:http_method) { 'get' }
+  let(:prefix) { nil }
+
+  let(:context_instance) do
+    described_class.new(
+      allow_null: allow_null,
+      http_method: http_method,
+      in_schema: in_schema,
+      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 }
+
+      it { is_expected.not_to be_in_schema }
+    end
+  end
+
+  describe '#allow_null?' do
+    subject { context_instance }
+
+    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
+
+  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,119 @@
+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.skip_default_tags is enabled' do
+      before { Apipie.configuration.generator.swagger.skip_default_tags = true }
+      after { Apipie.configuration.generator.swagger.skip_default_tags = false }
+
+      it { is_expected.to be_empty }
+
+      context 'when tags are available' do
+        let(:tags) { ['Tag 1', 'Tag 2'] }
+
+        it { is_expected.to eq(tags) }
+      end
+    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

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

@@ -0,0 +1,105 @@
+require 'spec_helper'
+
+describe Apipie::Generator::Swagger::MethodDescription::ResponseSchemaService do
+  let(:http_method) { nil }
+  let(:controller_method) { nil }
+  let(:allow_null) { false }
+
+  let(:resource_description) do
+    Apipie::ResourceDescription.new(PetsController, 'pets')
+  end
+
+  let(:method_description) do
+    Apipie::MethodDescription.new(
+      'create',
+      resource_description,
+      ActionController::Base.send(:_apipie_dsl_data_init)
+    )
+  end
+
+  let(:response_description_dsl) do
+    proc do
+      property :a_number, Integer, example: 1
+      property :an_optional_number, Integer, required: false, example: 2
+    end
+  end
+
+  let(:options) { {} }
+
+  let(:response_description) do
+    Apipie::ResponseDescription.new(
+      method_description,
+      204,
+      options,
+      PetsController,
+      response_description_dsl,
+      nil
+    )
+  end
+
+  let(:service) do
+    described_class.new(
+      response_description,
+      allow_null: allow_null,
+      http_method: http_method,
+      controller_method: controller_method
+    )
+  end
+
+  describe '#to_swagger' do
+    let(:swagger_response) { service.to_swagger }
+
+    describe 'properties' do
+      subject(:properties) { swagger_response[:properties] }
+
+      it 'returns correct properties' do
+        expect(properties).to eq(
+          {
+            a_number: {
+              type: 'number', required: true, example: 1
+            },
+            an_optional_number: {
+              type: 'number', example: 2
+            }
+          }
+        )
+      end
+
+      context 'when nulls are allowed' do
+        let(:allow_null) { true }
+
+        it 'returns correct properties' do
+          expect(properties).to eq(
+            {
+              a_number: {
+                type: %w[number null], required: true, example: 1
+              },
+              an_optional_number: {
+                type: %w[number null], example: 2
+              }
+            }
+          )
+        end
+      end
+    end
+
+    context 'when responses_use_refs is set to true' do
+      subject(:response) { swagger_response }
+
+      before { Apipie.configuration.generator.swagger.responses_use_refs = true }
+      after { Apipie.configuration.generator.swagger.responses_use_refs = false }
+
+      context 'when typename is given' do
+        let(:options) { { param_group: :some_param_group } }
+
+        it 'returns the reference' do
+          expect(response).to eq(
+            {
+              '$ref' => '#/definitions/some_param_group'
+            }
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+describe Apipie::Generator::Swagger::MethodDescription::ResponseService do
+  let(:http_method) { nil }
+  let(:language) { :en }
+  let(:dsl_data) { ActionController::Base.send(:_apipie_dsl_data_init) }
+
+  let(:method_description) do
+    Apipie::Generator::Swagger::MethodDescription::Decorator.new(
+      Apipie::MethodDescription.new(
+        'create',
+        Apipie::ResourceDescription.new(ApplicationController, 'pets'),
+        dsl_data
+      )
+    )
+  end
+
+  let(:returns) { [] }
+
+  let(:service) do
+    described_class.new(
+      method_description,
+      http_method: http_method,
+      language: language
+    )
+  end
+
+  describe '#call' do
+    describe 'headers' do
+      subject(:headers) { service.call[status_code][:headers] }
+
+      let(:status_code) { 200 }
+
+      it { is_expected.to be_blank }
+
+      context 'when headers exists' do
+        let(:dsl_data) { super().merge({ returns: returns }) }
+        let(:returns) { { status_code => [{}, nil, returns_dsl, nil] } }
+
+        let(:returns_dsl) do
+          proc do
+            header 'link', String, 'Relative links'
+            header 'Current-Page', Integer, 'The current page'
+          end
+        end
+
+        it 'returns the correct format headers' do
+          expect(headers).to eq({
+                                  'link' => {
+                                    description: 'Relative links',
+                                    type: 'string'
+                                  },
+                                  'Current-Page' => {
+                                    description: 'The current page',
+                                    type: 'integer'
+                                  }
+                                })
+        end
+      end
+    end
+  end
+end

data/spec/lib/apipie/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
+