apipie-rails 0.5.7 → 0.5.8

data/spec/spec_helper.rb

@@ -33,6 +33,100 @@ module Rails4Compatibility
   end
 end
 
+
+#
+# Matcher to validate the hierarchy of fields described in an internal 'returns' object (without checking their type)
+#
+# For example, code such as:
+#           returns_obj = Apipie.get_resource_description(...)._methods.returns.detect{|e| e.code=200})
+#           expect(returns_obj).to match_param_structure([:pet_name, :animal_type, :pet_measurements => [:weight, :height]])
+#
+# will verify that the payload structure described for the response of return code 200 is:
+#           {
+#             "pet_name": <any>,
+#             "animal_type": <any>,
+#             "pet_measurements": {
+#                 "weight": <any>,
+#                 "height": <any>
+#             }
+#           }
+#
+#
+RSpec::Matchers.define :match_field_structure do |expected|
+  @last_message = nil
+
+  match do |actual|
+    deep_match?(actual, expected)
+  end
+
+  def deep_match?(actual, expected, breadcrumb=[])
+    num = 0
+    expected.each do |pdesc|
+      if pdesc.is_a? Symbol
+        return false unless matching_param(actual.params_ordered, pdesc, breadcrumb)
+      elsif pdesc.is_a? Hash
+        param = matching_param(actual.params_ordered, pdesc.keys[0], breadcrumb)
+        return false unless param
+        return false unless deep_match?(param.validator, pdesc.values[0], breadcrumb + [pdesc.keys[0]])
+      end
+      num+=1
+    end
+    @fail_message = "expected property count#{breadcrumb == [] ? '' : ' of ' + (breadcrumb).join('.')} (#{actual.params_ordered.count}) to be #{num}"
+    actual.params_ordered.count == num
+  end
+
+  def matching_param(params, expected_name, breadcrumb)
+    param = params.find { |p| p.name.to_s == expected_name.to_s }
+    unless param
+      @fail_message = "expected [#{ params.map(&:name).join(', ') }] to include #{(breadcrumb + [expected_name]).join('.')}"
+    end
+    param
+  end
+
+  failure_message do |actual|
+    @fail_message
+  end
+end
+
+
+
+#
+# Matcher to validate the properties (name, type and options) of a single field in the
+# internal representation of a swagger schema
+#
+# For example, code such as:
+#       schema = swagger[:paths][<path>][<method>][:responses][<code>][:schema]
+#       expect(schema).to have_field(:pet_name, 'string', {:required => false})
+#
+# will verify that the selected response schema includes a required string field called 'pet_name'
+#
+RSpec::Matchers.define :have_field do |name, type, opts={}|
+  def fail(msg)
+    @fail_message = msg
+    false
+  end
+
+  @fail_message = ""
+
+  failure_message do |actual|
+    @fail_message
+  end
+
+  match do |actual|
+    return fail("expected schema to have type 'object' (got '#{actual[:type]}')") if (actual[:type]) != 'object'
+    return fail("expected schema to include param named '#{name}' (got #{actual[:properties].keys})") if (prop = actual[:properties][name]).nil?
+    return fail("expected param '#{name}' to have type '#{type}' (got '#{prop[:type]}')") if prop[:type] != type
+    return fail("expected param '#{name}' to have description '#{opts[:description]}' (got '#{prop[:description]}')") if opts[:description] && prop[:description] != opts[:description]
+    return fail("expected param '#{name}' to have enum '#{opts[:enum]}' (got #{prop[:enum]})") if opts[:enum] && prop[:enum] != opts[:enum]
+    if !opts.include?(:required) || opts[:required] == true
+      return fail("expected param '#{name}' to be required") unless actual[:required].include?(name)
+    else
+      return fail("expected param '#{name}' to be optional") if actual[:required].include?(name)
+    end
+    true
+  end
+end
+
 # Requires supporting ruby files with custom matchers and macros, etc,
 # in spec/support/ and its subdirectories.
 Dir[File.expand_path("../support/**/*.rb", __FILE__)].each {|f| require f}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apipie-rails
 version: !ruby/object:Gem::Version
-  version: 0.5.7
+  version: 0.5.8
 platform: ruby
 authors:
 - Pavel Pokorny
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-27 00:00:00.000000000 Z
+date: 2018-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -157,6 +157,7 @@ files:
 - Gemfile.rails51
 - MIT-LICENSE
 - NOTICE
+- PROPOSAL_FOR_RESPONSE_DESCRIPTIONS.md
 - README.rst
 - Rakefile
 - apipie-rails.gemspec
@@ -220,6 +221,8 @@ files:
 - lib/apipie/param_description.rb
 - lib/apipie/railtie.rb
 - lib/apipie/resource_description.rb
+- lib/apipie/response_description.rb
+- lib/apipie/response_description_adapter.rb
 - lib/apipie/routes_formatter.rb
 - lib/apipie/routing.rb
 - lib/apipie/see_description.rb
@@ -257,6 +260,9 @@ files:
 - spec/dummy/app/controllers/extended_controller.rb
 - spec/dummy/app/controllers/files_controller.rb
 - spec/dummy/app/controllers/overridden_concerns_controller.rb
+- spec/dummy/app/controllers/pets_controller.rb
+- spec/dummy/app/controllers/pets_using_auto_views_controller.rb
+- spec/dummy/app/controllers/pets_using_self_describing_classes_controller.rb
 - spec/dummy/app/controllers/twitter_example_controller.rb
 - spec/dummy/app/controllers/users_controller.rb
 - spec/dummy/app/views/layouts/application.html.erb
@@ -296,6 +302,7 @@ files:
 - spec/lib/resource_description_spec.rb
 - spec/lib/swagger/openapi_2_0_schema.json
 - spec/lib/swagger/rake_swagger_spec.rb
+- spec/lib/swagger/swagger_dsl_spec.rb
 - spec/lib/validator_spec.rb
 - spec/lib/validators/array_validator_spec.rb
 - spec/spec_helper.rb
@@ -346,6 +353,9 @@ test_files:
 - spec/dummy/app/controllers/extended_controller.rb
 - spec/dummy/app/controllers/files_controller.rb
 - spec/dummy/app/controllers/overridden_concerns_controller.rb
+- spec/dummy/app/controllers/pets_controller.rb
+- spec/dummy/app/controllers/pets_using_auto_views_controller.rb
+- spec/dummy/app/controllers/pets_using_self_describing_classes_controller.rb
 - spec/dummy/app/controllers/twitter_example_controller.rb
 - spec/dummy/app/controllers/users_controller.rb
 - spec/dummy/app/views/layouts/application.html.erb
@@ -385,6 +395,7 @@ test_files:
 - spec/lib/resource_description_spec.rb
 - spec/lib/swagger/openapi_2_0_schema.json
 - spec/lib/swagger/rake_swagger_spec.rb
+- spec/lib/swagger/swagger_dsl_spec.rb
 - spec/lib/validator_spec.rb
 - spec/lib/validators/array_validator_spec.rb
 - spec/spec_helper.rb