swaggable 0.6.0 → 0.7.0

data/spec/swaggable/mime_types_collection_spec.rb

@@ -0,0 +1,83 @@
+require_relative '../spec_helper'
+
+RSpec.describe 'Swaggable::MimeTypesCollection' do
+  let(:subject_class) { Swaggable::MimeTypesCollection }
+  let(:subject_instance) { subject_class.new }
+  subject { subject_instance }
+
+  describe '#<<' do
+    it 'adds MimeTypeDefinitions as is' do
+      type = Swaggable::MimeTypeDefinition.new(:json)
+      subject << type
+      expect(subject.last).to be type
+    end
+  end
+
+  describe '#each' do
+    it 'iterates through the list' do
+      subject << :json
+      list = []
+
+      subject.each {|e| list << e.name }
+
+      expect(list).to eq(['application/json'])
+    end
+  end
+
+  describe '#include?' do
+    it 'returns true if present' do
+      entry = Swaggable::MimeTypeDefinition.new(:json)
+      subject << entry
+      expect(subject).to include(entry)
+    end
+  end
+
+  describe '#[]' do
+    it 'returns entries by symbol' do
+      entry = Swaggable::MimeTypeDefinition.new(:json)
+      subject << entry
+      expect(subject[:json]).to be entry
+    end
+
+    it 'returns entries by string' do
+      entry = Swaggable::MimeTypeDefinition.new(:json)
+      subject << entry
+      expect(subject['application/json']).to be entry
+    end
+  end
+
+  describe '#inspect' do
+    it 'is readable' do
+      subject << :json
+      subject << :xml
+      expect(subject.inspect).to eq "#<Swaggable::MimeTypesCollection: application/json, application/xml>"
+    end
+  end
+
+  describe '#==' do
+    it 'matches if the entries match' do
+      subject << :json
+
+      expect(subject).to eq [:json]
+    end
+  end
+
+  describe '#merge!' do
+    it 'joins the lists' do
+      subject << :json
+
+      other = subject_class.new
+      other << :xml
+
+      subject.merge!(other)
+
+      expect(subject).to eq [:json, :xml]
+    end
+
+    it 'joins lists of symbols' do
+      subject << :json
+      subject.merge!([:xml])
+      expect(subject).to eq [:json, :xml]
+    end
+  end
+end

data/spec/swaggable/parameter_definition_spec.rb

@@ -10,6 +10,11 @@ RSpec.describe 'Swaggable::ParameterDefinition' do
     expect(subject.name).to eq  'a name'
   end
 
+  it 'coerces the name to string' do
+    subject.name = :a_name
+    expect(subject.name).to eq  'a_name'
+  end
+
   it 'has a description' do
     subject.description = 'a new desc'
     expect(subject.description).to eq  'a new desc'
@@ -86,4 +91,22 @@ RSpec.describe 'Swaggable::ParameterDefinition' do
 
     expect(subject.schema.attributes[:first_name].type).to be :string
   end
+
+  describe '#==' do
+    it 'equals by name' do
+      subject.name = 'a name'
+      subject.location = :query
+
+      expect(subject).to eq OpenStruct.new(name: 'a name', location: :query)
+    end
+
+    it 'doesn\'t throw error if comparing with any random object' do
+      expect{ subject == double }.not_to raise_error
+    end
+  end
+
+  it 'has a value' do
+    subject.value = 10
+    expect(subject.value).to eq 10
+  end
 end

data/spec/swaggable/query_params_spec.rb

@@ -0,0 +1,37 @@
+require_relative '../spec_helper'
+
+RSpec.describe 'Swaggable::QueryParams' do
+  subject { subject_class.new }
+  let(:subject_class) { Swaggable::QueryParams }
+
+  it 'parses the query string' do
+    subject.string = 'a=1&b=2'
+    expect(subject).to eq('a' => '1', 'b' => '2')
+  end
+
+  it 'can be updated' do
+    subject.string = 'a=1'
+    subject['b'] = 2
+    expect(subject).to eq('a' => '1', 'b' => '2')
+  end
+
+  it 'can initialized with a hash' do
+    subject = subject_class.new a: 1, b: 2
+    expect(subject).to eq('a' => '1', 'b' => '2')
+  end
+
+  it 'works with unicode' do
+    subject.string = "person=\u2713"
+    expect(subject).to eq('person' => "\u2713")
+  end
+
+  it 'works with scaped chars in the string' do
+    subject.string = 'name=john%20smith'
+    expect(subject).to eq('name' => 'john smith')
+  end
+
+  it 'works with scaped chars in the hash' do
+    subject['name'] = 'john smith'
+    expect(subject.string).to eq 'name=john+smith'
+  end
+end

data/spec/swaggable/rack_request_adapter_spec.rb

@@ -0,0 +1,89 @@
+require_relative '../spec_helper'
+
+RSpec.describe Swaggable::RackRequestAdapter do
+  subject { Swaggable::RackRequestAdapter.new env }
+  let(:env) { {} }
+
+  it 'allows accessing the original env hash' do
+    subject = described_class.new('CONTENT_TYPE' => 'application/json')
+    expect(subject['CONTENT_TYPE']).to eq 'application/json'
+  end
+
+  describe '#query_parameters' do
+    it 'parses the query string' do
+      env['QUERY_STRING'] = 'a=1&b=2'
+      expect(subject.query_parameters).to eq('a' => '1', 'b' => '2')
+    end
+
+    it 'can be updated' do
+      env['QUERY_STRING'] = 'a=1'
+      subject.query_parameters['b'] = 2
+      expect(subject.query_parameters).to eq('a' => '1', 'b' => '2')
+    end
+
+    it 'can be assigned' do
+      subject.query_parameters = {a: 1, b: 2}
+      expect(subject.query_parameters).to eq('a' => '1', 'b' => '2')
+    end
+  end
+
+  describe '#path' do
+    it 'returns PATH_INFO' do
+      subject = described_class.new('PATH_INFO' => '/test')
+      expect(subject.path).to eq '/test'
+    end
+  end
+
+  describe '#body' do
+    it 'is the body of the request' do
+      env['rack.input'] = double(:body_stream, read: 'the body')
+      expect(subject.body).to eq 'the body'
+    end
+  end
+
+  describe '#content_type' do
+    it 'is taken from CONTENT_TYPE' do
+      env['CONTENT_TYPE'] = 'application/json'
+      expect(subject.content_type).to eq 'application/json'
+    end
+
+    it 'can be set' do
+      subject.content_type = 'application/json'
+      expect(subject.content_type).to eq 'application/json'
+    end
+  end
+
+  describe '#parsed_body' do
+    it 'can be JSON' do
+      env['rack.input'] = double(:body_stream, read: '{"name":"John"}')
+      env['CONTENT_TYPE'] = 'application/json'
+
+      expect(subject.parsed_body).to eq({'name' => 'John'})
+    end
+  end
+
+  describe '#parameters' do
+    it 'returns query params' do
+      env['QUERY_STRING'] = "name=John"
+      parameter = subject.parameters.first
+
+      expect(subject.parameters.count).to eq 1
+      expect(parameter.location).to eq :query
+      expect(parameter.name).to eq 'name'
+      expect(parameter.value).to eq 'John'
+    end
+
+    it 'returns path params' do
+      env['PATH_INFO'] = "/users/37"
+      endpoint = double('endpoint', :path_parameters_for => { 'user_id' => '37' })
+
+      parameters = subject.parameters(endpoint)
+      parameter = parameters.first
+
+      expect(parameters.count).to eq 1
+      expect(parameter.location).to eq :path
+      expect(parameter.name).to eq 'user_id'
+      expect(parameter.value).to eq '37'
+    end
+  end
+end

data/spec/swaggable/rack_response_adapter_spec.rb

@@ -0,0 +1,46 @@
+require_relative '../spec_helper'
+
+RSpec.describe Swaggable::RackResponseAdapter do
+  let(:subject_class) { Swaggable::RackResponseAdapter }
+  subject { subject_class.new rack_request }
+  let(:rack_request) { [200, {}, []] }
+
+  describe '#content_type' do
+    it 'returns CONTENT_TYPE' do
+      rack_request[1]['Content-Type'] = 'application/xml'
+      expect(subject.content_type).to eq 'application/xml'
+    end
+
+    it 'can be set' do
+      subject.content_type = 'application/xml'
+      expect(subject.content_type).to eq 'application/xml'
+    end
+  end
+
+  describe '#code' do
+    it 'returns the request status code' do
+      rack_request[0] = 418
+      expect(subject.code).to eq 418
+    end
+
+    it 'can be set' do
+      subject.code = 418
+      expect(subject.code).to eq 418
+    end
+  end
+
+  describe '#==' do
+    it 'equals by rack request' do
+      subject_1 = subject_class.new([418, {some: :header}, ['some body']])
+      subject_2 = subject_class.new([418, {some: :header}, ['some body']])
+      subject_3 = subject_class.new([418, {some: :header}, ['different body']])
+
+      expect(subject_1 == subject_2).to be true
+      expect(subject_1 == subject_3).to be false
+    end
+
+    it 'doesn\'t throw error if comparing with any random object' do
+      expect{ subject == double }.not_to raise_error
+    end
+  end
+end

data/spec/swaggable/swagger_2_serializer_spec.rb

@@ -78,7 +78,7 @@ RSpec.describe 'Swaggable::Swagger2Serializer' do
       let(:api) { Swaggable::ApiDefinition.new {|a| a.endpoints << endpoint } }
       let(:endpoint) { Swaggable::EndpointDefinition.new path: path, verb: verb }
       let(:path) { '/a/path' }
-      let(:verb) { 'POST' }
+      let(:verb) { :post }
 
       it 'uses the path as key' do
         expect(output[:paths][path]).not_to be_nil
@@ -121,18 +121,20 @@ RSpec.describe 'Swaggable::Swagger2Serializer' do
       it 'has consumes' do
         endpoint.consumes << 'application/whatever'
         expect(serialized_endpoint[:consumes]).to eq ['application/whatever']
+        expect(serialized_endpoint[:consumes].first).to be_a String
       end
 
       it 'has produces' do
         endpoint.produces << 'application/whatever'
         expect(serialized_endpoint[:produces]).to eq ['application/whatever']
+        expect(serialized_endpoint[:produces].first).to be_a String
       end
 
       it 'works with two endpoints with the same path' do
         api.endpoints << Swaggable::EndpointDefinition.new(path: path, verb: 'get')
 
         expect(output[:paths][path][verb]).not_to be_nil
-        expect(output[:paths][path]['get']).not_to be_nil
+        expect(output[:paths][path][:get]).not_to be_nil
       end
 
       describe 'responses' do

data/spec/swaggable/swagger_2_validator_spec.rb

@@ -7,7 +7,7 @@ RSpec.describe 'Swaggable::Swagger2Validator' do
     subject { Swaggable::Swagger2Validator }
 
     let(:valid_swagger) { JSON.parse File.read('spec/assets/valid-swagger-2.0.json') }
-    let(:invalid_swagger) { valid_swagger.merge("info" => nil) }
+    let(:invalid_swagger) { valid_swagger.merge!("info" => nil) }
 
     it 'returns true for a valid schema' do
       expect(subject.validate! valid_swagger).to be true
@@ -28,7 +28,7 @@ RSpec.describe 'Swaggable::Swagger2Validator' do
     subject { Swaggable::Swagger2Validator }
 
     let(:valid_swagger) { JSON.parse File.read('spec/assets/valid-swagger-2.0.json') }
-    let(:invalid_swagger) { valid_swagger.merge("info" => nil) }
+    let(:invalid_swagger) { valid_swagger.merge!("info" => nil) }
 
     it 'returns empty errors for a valid schema' do
       expect(subject.validate valid_swagger).to be_blank

data/spec/swaggable/validating_rack_app_spec.rb

@@ -0,0 +1,91 @@
+require_relative '../spec_helper'
+
+RSpec.describe 'Swaggable::ValidatingRackApp' do
+  let(:app) { Swaggable::ValidatingRackApp.new app: app_to_validate, definition: definition }
+  let(:response) {  [200, {}, ['my-body']]  }
+  let(:app_to_validate) { -> env { response } }
+  let(:definition) { Swaggable::ApiDefinition.new }
+  let(:request) { Rack::MockRequest.env_for '/', 'REQUEST_METHOD' => 'GET' }
+  let(:validator) { Swaggable::ApiValidator.new }
+  let(:some_errors) { Swaggable::Errors::ValidationsCollection.new }
+
+  before do
+    allow(Swaggable::ApiValidator).
+      to receive(:new).
+      and_return validator
+  end
+
+  def do_request
+    app.call request
+  end
+
+  before do
+    allow(validator).
+      to receive(:errors_for_request).
+      with(no_args).
+      and_return([])
+
+    allow(validator).
+      to receive(:errors_for_response).
+      with(Swaggable::RackResponseAdapter.new response).
+      and_return([])
+  end
+
+  context 'for valid request and response' do
+    it 'raises no exception' do
+      expect{ do_request }.not_to raise_error
+    end
+
+    it 'returns the response' do
+      last_response = do_request
+      expect(last_response).to be response
+    end
+
+    it 'wraps the request into a rack request adapter' do
+      allow(Swaggable::ApiValidator).
+        to receive(:new) {|args| expect(args[:request]).to be_a Swaggable::RackRequestAdapter }.
+        and_return validator
+
+      do_request
+    end
+  end
+
+  context 'for an invalid request' do
+    before do
+      allow(validator).
+        to receive(:errors_for_request).
+        with(no_args).
+        and_return(some_errors)
+
+      allow(some_errors).
+        to receive(:any?).
+        and_return true
+    end
+
+    it 'raises the request errors' do
+      expect{ do_request }.to raise_error some_errors
+    end
+
+    it 'doesn\'t make the request' do
+      expect(app_to_validate).not_to receive(:call)
+      do_request rescue some_errors
+    end
+  end
+
+  context 'for an invalid response' do
+    before do
+      allow(validator).
+        to receive(:errors_for_response).
+        with(Swaggable::RackResponseAdapter.new response).
+        and_return(some_errors)
+
+      allow(some_errors).
+        to receive(:any?).
+        and_return true
+    end
+
+    it 'raises the response errors' do
+      expect{ do_request }.to raise_error some_errors
+    end
+  end
+end

data/swaggable.gemspec

@@ -23,6 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "forwarding_dsl", '~> 1.0', '>= 1.0.3'
   spec.add_runtime_dependency "json-schema", '~> 2.5'
   spec.add_runtime_dependency "mini_object", '~> 0.1', '>= 0.1.7'
+  spec.add_runtime_dependency "addressable", '~> 2.3'
 
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", '~> 10.4'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swaggable
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Manuel Morales
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-30 00:00:00.000000000 Z
+date: 2015-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: forwarding_dsl
@@ -64,6 +64,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.1.7
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -109,37 +123,70 @@ files:
 - assets/swagger-2.0-schema.json
 - lib/swaggable.rb
 - lib/swaggable/api_definition.rb
+- lib/swaggable/api_validator.rb
 - lib/swaggable/attribute_definition.rb
+- lib/swaggable/check_body_schema.rb
+- lib/swaggable/check_expected_parameters.rb
+- lib/swaggable/check_mandatory_parameters.rb
+- lib/swaggable/check_request_content_type.rb
+- lib/swaggable/check_response_code.rb
+- lib/swaggable/check_response_content_type.rb
 - lib/swaggable/definition_base.rb
 - lib/swaggable/endpoint_definition.rb
+- lib/swaggable/endpoint_validator.rb
 - lib/swaggable/enumerable_attributes.rb
+- lib/swaggable/errors.rb
+- lib/swaggable/errors/validations_collection.rb
 - lib/swaggable/grape_adapter.rb
 - lib/swaggable/grape_entity_translator.rb
+- lib/swaggable/mime_type_definition.rb
+- lib/swaggable/mime_types_collection.rb
 - lib/swaggable/parameter_definition.rb
+- lib/swaggable/query_params.rb
 - lib/swaggable/rack_app.rb
 - lib/swaggable/rack_redirect.rb
+- lib/swaggable/rack_request_adapter.rb
+- lib/swaggable/rack_response_adapter.rb
 - lib/swaggable/response_definition.rb
 - lib/swaggable/schema_definition.rb
 - lib/swaggable/swagger_2_serializer.rb
 - lib/swaggable/swagger_2_validator.rb
 - lib/swaggable/tag_definition.rb
+- lib/swaggable/validating_rack_app.rb
 - lib/swaggable/version.rb
 - spec/assets/valid-swagger-2.0.json
+- spec/integration/dsl_spec.rb
+- spec/integration/rack_app_spec.rb
+- spec/integration/validating_rack_app_spec.rb
 - spec/spec_helper.rb
 - spec/swaggable/api_definition_spec.rb
+- spec/swaggable/api_validator_spec.rb
 - spec/swaggable/attribute_definition_spec.rb
+- spec/swaggable/check_body_schema_spec.rb
+- spec/swaggable/check_expected_parameters_spec.rb
+- spec/swaggable/check_mandatory_parameters_spec.rb
+- spec/swaggable/check_request_content_type_spec.rb
+- spec/swaggable/check_response_code_spec.rb
+- spec/swaggable/check_response_content_type_spec.rb
 - spec/swaggable/endpoint_definition_spec.rb
+- spec/swaggable/endpoint_validator_spec.rb
+- spec/swaggable/errors/validations_collection_spec.rb
 - spec/swaggable/grape_adapter_spec.rb
 - spec/swaggable/grape_entity_translator_spec.rb
-- spec/swaggable/integration_spec.rb
+- spec/swaggable/mime_type_definition_spec.rb
+- spec/swaggable/mime_types_collection_spec.rb
 - spec/swaggable/parameter_definition_spec.rb
+- spec/swaggable/query_params_spec.rb
 - spec/swaggable/rack_app_spec.rb
 - spec/swaggable/rack_redirect_spec.rb
+- spec/swaggable/rack_request_adapter_spec.rb
+- spec/swaggable/rack_response_adapter_spec.rb
 - spec/swaggable/response_definition_spec.rb
 - spec/swaggable/schema_definition_spec.rb
 - spec/swaggable/swagger_2_serializer_spec.rb
 - spec/swaggable/swagger_2_validator_spec.rb
 - spec/swaggable/tag_definition_spec.rb
+- spec/swaggable/validating_rack_app_spec.rb
 - spec/swaggable_spec.rb
 - swaggable.gemspec
 homepage: https://github.com/workshare/swaggable
@@ -169,20 +216,37 @@ summary: Allows you to generate Swagger documentation from Grape endpoints and e
   it as a Rack app.
 test_files:
 - spec/assets/valid-swagger-2.0.json
+- spec/integration/dsl_spec.rb
+- spec/integration/rack_app_spec.rb
+- spec/integration/validating_rack_app_spec.rb
 - spec/spec_helper.rb
 - spec/swaggable/api_definition_spec.rb
+- spec/swaggable/api_validator_spec.rb
 - spec/swaggable/attribute_definition_spec.rb
+- spec/swaggable/check_body_schema_spec.rb
+- spec/swaggable/check_expected_parameters_spec.rb
+- spec/swaggable/check_mandatory_parameters_spec.rb
+- spec/swaggable/check_request_content_type_spec.rb
+- spec/swaggable/check_response_code_spec.rb
+- spec/swaggable/check_response_content_type_spec.rb
 - spec/swaggable/endpoint_definition_spec.rb
+- spec/swaggable/endpoint_validator_spec.rb
+- spec/swaggable/errors/validations_collection_spec.rb
 - spec/swaggable/grape_adapter_spec.rb
 - spec/swaggable/grape_entity_translator_spec.rb
-- spec/swaggable/integration_spec.rb
+- spec/swaggable/mime_type_definition_spec.rb
+- spec/swaggable/mime_types_collection_spec.rb
 - spec/swaggable/parameter_definition_spec.rb
+- spec/swaggable/query_params_spec.rb
 - spec/swaggable/rack_app_spec.rb
 - spec/swaggable/rack_redirect_spec.rb
+- spec/swaggable/rack_request_adapter_spec.rb
+- spec/swaggable/rack_response_adapter_spec.rb
 - spec/swaggable/response_definition_spec.rb
 - spec/swaggable/schema_definition_spec.rb
 - spec/swaggable/swagger_2_serializer_spec.rb
 - spec/swaggable/swagger_2_validator_spec.rb
 - spec/swaggable/tag_definition_spec.rb
+- spec/swaggable/validating_rack_app_spec.rb
 - spec/swaggable_spec.rb
 has_rdoc: