swaggable 0.4.0 → 0.5.1

data/spec/swaggable/parameter_definition_spec.rb

@@ -31,6 +31,14 @@ RSpec.describe 'Swaggable::ParameterDefinition' do
     expect(yielded).to be true
   end
 
+  it 'yields itself on initialize' do
+    subject = subject_class.new do
+      name 'Some name'
+    end
+
+    expect(subject.name).to eq 'Some name'
+  end
+
   describe '#location' do
     it 'can be set to :body, :header, :path, :query, :form' do
       [:body, :header, :path, :query, :form, nil].each do |location|
@@ -40,7 +48,7 @@ RSpec.describe 'Swaggable::ParameterDefinition' do
     end
 
     it 'cannot be something other than that' do
-      expect { subject.location = :xyz }.to raise_exception
+      expect { subject.location = :xyz }.to raise_exception(ArgumentError)
     end
   end
 
@@ -53,7 +61,7 @@ RSpec.describe 'Swaggable::ParameterDefinition' do
     end
 
     it 'cannot be something other than that' do
-      expect { subject.type = :xyz }.to raise_exception
+      expect { subject.type = :xyz }.to raise_exception(ArgumentError)
     end
   end
 
@@ -61,4 +69,21 @@ RSpec.describe 'Swaggable::ParameterDefinition' do
     parameter = subject_class.new location: :path
     expect(parameter.location).to eq :path
   end
+
+  it 'has schema definition' do
+    subject.location :body
+
+    subject.schema do
+      name :user
+
+      attributes do
+        add_new do
+          name :first_name
+          type :string
+        end
+      end
+    end
+
+    expect(subject.schema.attributes[:first_name].type).to be :string
+  end
 end

data/spec/swaggable/rack_app_spec.rb

@@ -45,5 +45,15 @@ RSpec.describe 'Swaggable::RackApp' do
       subject.validate!
     end
   end
+
+  describe 'validate' do
+    it 'validates against the serializer' do
+      expect(serializer).
+        to receive(:validate).
+        with api_definition
+
+      subject.validate
+    end
+  end
 end
 

data/spec/swaggable/schema_definition_spec.rb

@@ -0,0 +1,51 @@
+require_relative '../spec_helper'
+
+RSpec.describe 'Swaggable::SchemaDefinition' do
+  subject { subject_instance }
+  let(:subject_instance) { subject_class.new }
+  let(:subject_class) { Swaggable::SchemaDefinition }
+
+  it 'has a name' do
+    subject.name 'My Schema'
+    expect(subject.name).to eq 'My Schema'
+  end
+
+  it 'has attributes' do
+    subject.attributes.add_new do
+      name :my_attr
+      type :string
+    end
+
+    expect(subject.attributes[:my_attr].type).to be :string
+  end
+
+  it 'can be empty' do
+    expect(subject).to be_empty
+
+    subject.attributes.add_new do
+      name :first_name
+      type :string
+    end
+
+    expect(subject).not_to be_empty
+  end
+
+  it 'accepts attributes on initialize' do
+    schema = subject_class.new name: 'New name'
+    expect(schema.name).to eq 'New name'
+  end
+
+  it 'equals by name' do
+    schema_1 = subject_class.new name: 'schema 1'
+    schema_1_again = subject_class.new name: 'schema 1'
+    schema_2 = subject_class.new name: 'schema 2'
+
+    expect(schema_1).to eq schema_1_again
+    expect([schema_1, schema_1_again].uniq.length).to eq 1
+    expect(schema_1).not_to eq schema_2
+  end
+
+  it 'doesn\'t throw error if comparing with any random object' do
+    expect{ subject == double }.not_to raise_error
+  end
+end

data/spec/swaggable/swagger_2_serializer_spec.rb

@@ -187,10 +187,130 @@ RSpec.describe 'Swaggable::Swagger2Serializer' do
           expect(serialized_parameter[:type]).to eq :string
         end
 
-        it 'has type string if nil' do
+        it 'has type string if nil and not body' do
           parameter.type = nil
           expect(serialized_parameter[:type]).to eq 'string'
         end
+
+        it 'has no type string if body param' do
+          parameter.type = nil
+          parameter.location = :body
+          expect(serialized_parameter.has_key? :type).to be false
+        end
+
+        describe 'schema' do
+          def serialized_schema_parameter
+            serialized_schema[:properties][:some_parameter]
+          end
+
+          def serialized_schema
+            output[:definitions][:some_schema]
+          end
+
+          it 'is not present if empty' do
+            expect(parameter.schema).to be_empty
+            expect(serialized_parameter.has_key?(:schema)).to be false
+          end
+
+          it 'has a $ref if present' do
+            parameter.schema.name :some_schema
+            parameter.schema.attributes do
+              add_new do
+                name :some_parameter
+                type :long
+              end
+            end
+
+            parameter_schema = serialized_endpoint[:parameters].first[:schema]
+            expect(parameter_schema).to eq({:"$ref" => '#/definitions/some_schema'})
+          end
+
+          it 'has type object' do
+            parameter.schema.name :some_schema
+            parameter.schema.attributes do
+              add_new do
+                name :some_parameter
+                type :long
+              end
+            end
+
+            expect(serialized_schema[:type]).to eq 'object'
+          end
+
+          it 'has parameter type' do
+            parameter.schema.name :some_schema
+            parameter.schema.attributes do
+              add_new do
+                name :some_parameter
+                type :long
+              end
+            end
+
+            expect(serialized_schema_parameter[:type]).to eq :integer
+          end
+
+          it 'has parameter format' do
+            parameter.schema.name :some_schema
+            parameter.schema.attributes do
+              add_new do
+                name :some_parameter
+                type :long
+              end
+            end
+
+            expect(serialized_schema_parameter[:format]).to eq :int64
+          end
+
+          it 'has no format if nil' do
+            parameter.schema.name :some_schema
+            parameter.schema.attributes do
+              add_new do
+                name :some_parameter
+                type :string
+              end
+            end
+
+            expect(serialized_schema_parameter.has_key?(:format)).to be false
+          end
+
+          it 'has parameter required field' do
+            parameter.schema.name :some_schema
+            parameter.schema.attributes do
+              add_new do
+                name :some_parameter
+                type :long
+                required true
+              end
+            end
+
+            expect(serialized_schema[:required]).to eq [:some_parameter]
+          end
+
+          it 'has parameter description' do
+            parameter.schema.name :some_schema
+            parameter.schema.attributes do
+              add_new do
+                name :some_parameter
+                type :long
+                this.description 'a long param'
+              end
+            end
+
+            expect(serialized_schema_parameter[:description]).to eq 'a long param'
+          end
+
+          it 'has no parameter description if no decription is given' do
+            parameter.schema.name :some_schema
+            parameter.schema.attributes do
+              add_new do
+                name :some_parameter
+                type :long
+              end
+            end
+
+            expect(serialized_schema_parameter.has_key?(:description)).to be false
+          end
+        end
       end
     end
   end
@@ -205,4 +325,15 @@ RSpec.describe 'Swaggable::Swagger2Serializer' do
       subject.validate! api
     end
   end
+
+  describe '#validate' do
+    it 'validates against Swagger2Validator' do
+      expect(Swaggable::Swagger2Validator).
+        to receive(:validate).
+        with(subject.serialize api).
+        and_return(true)
+
+      subject.validate api
+    end
+  end
 end

data/spec/swaggable/swagger_2_validator_spec.rb

@@ -23,4 +23,19 @@ RSpec.describe 'Swaggable::Swagger2Validator' do
       expect(exception.message).to match(/info/)
     end
   end
+
+  describe '.validate' 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) }
+
+    it 'returns empty errors for a valid schema' do
+      expect(subject.validate valid_swagger).to be_blank
+    end
+
+    it 'returns errors for invalid schema' do
+      expect(subject.validate invalid_swagger).not_to be_blank
+    end
+  end
 end

data/swaggable.gemspec

@@ -20,10 +20,10 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "forwarding_dsl", '~> 1.0'
+  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'
+  spec.add_runtime_dependency "mini_object", '~> 0.1', '>= 0.1.7'
 
-  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", '~> 10.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swaggable
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Manuel Morales
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-30 00:00:00.000000000 Z
+date: 2015-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: forwarding_dsl
@@ -17,6 +17,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -24,6 +27,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
 - !ruby/object:Gem::Dependency
   name: json-schema
   requirement: !ruby/object:Gem::Requirement
@@ -45,6 +51,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -52,20 +61,23 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.7
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -88,6 +100,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -96,11 +109,16 @@ files:
 - assets/swagger-2.0-schema.json
 - lib/swaggable.rb
 - lib/swaggable/api_definition.rb
+- lib/swaggable/attribute_definition.rb
+- lib/swaggable/definition_base.rb
 - lib/swaggable/endpoint_definition.rb
+- lib/swaggable/enumerable_attributes.rb
 - lib/swaggable/grape_adapter.rb
+- lib/swaggable/grape_entity_translator.rb
 - lib/swaggable/parameter_definition.rb
 - lib/swaggable/rack_app.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
@@ -108,12 +126,15 @@ files:
 - spec/assets/valid-swagger-2.0.json
 - spec/spec_helper.rb
 - spec/swaggable/api_definition_spec.rb
+- spec/swaggable/attribute_definition_spec.rb
 - spec/swaggable/endpoint_definition_spec.rb
 - spec/swaggable/grape_adapter_spec.rb
+- spec/swaggable/grape_entity_translator_spec.rb
 - spec/swaggable/integration_spec.rb
 - spec/swaggable/parameter_definition_spec.rb
 - spec/swaggable/rack_app_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
@@ -148,12 +169,15 @@ test_files:
 - spec/assets/valid-swagger-2.0.json
 - spec/spec_helper.rb
 - spec/swaggable/api_definition_spec.rb
+- spec/swaggable/attribute_definition_spec.rb
 - spec/swaggable/endpoint_definition_spec.rb
 - spec/swaggable/grape_adapter_spec.rb
+- spec/swaggable/grape_entity_translator_spec.rb
 - spec/swaggable/integration_spec.rb
 - spec/swaggable/parameter_definition_spec.rb
 - spec/swaggable/rack_app_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