committee 2.0.0.pre5 → 2.0.0.pre6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b8ffc44027f6147a34b278d70e7f20117fa9cf93
-  data.tar.gz: 068dec170ff98a7e06e88372f396adcae0b3934a
+  metadata.gz: d9c150399d562ad7e8daafbf27c82044a2e3c639
+  data.tar.gz: f2879d489c219d68a9191c9ce7ce31972107334e
 SHA512:
-  metadata.gz: 457ab6c2e9c8206208d9f4960ffaeba6f82d416a286116ed36cea327ff873cf5bf217493a71cb7edf46991c05a8ae646719af6d1f7471a9d8805637beab6577f
-  data.tar.gz: e8a55c657884295a59ed2559c5e1017c428d037c75df1eb27fa62516c4630b24222722b784b94d2f76fff47abe1332f65e73c4410b9c32d5dfdc4ffd1156ec9f
+  metadata.gz: a019bde4a85727e0bbb676376ece423d4731645bb1a49309f57d178c7bd0eac11049acef972923b7907f2cf3e331c84b968a784fc3d24084a8c9e73db36f0817
+  data.tar.gz: dcb6b47b74931ea684c6e9f92004923e09f72755be7abdfb9381cf1b457286f44b02c6fd3741902901aa2843cadac9b8a984d336d25b931ec3f9b0c92e11a5cc

data/lib/committee/middleware/stub.rb

@@ -19,12 +19,13 @@ module Committee::Middleware
       if link
         headers = { "Content-Type" => "application/json" }
 
-        data = cache(link) do
+        data, schema = cache(link) do
           Committee::ResponseGenerator.new.call(link)
         end
 
         if @call
           request.env["committee.response"] = data
+          request.env["committee.response_schema"] = schema
           call_status, call_headers, call_body = @app.call(request.env)
 
           # a committee.suppress signal initiates a direct pass through
@@ -36,7 +37,7 @@ module Committee::Middleware
           # made, and stub normally
           headers.merge!(call_headers)
 
-          # allow allow the handler to change the data object (if unchanged, it
+          # allow the handler to change the data object (if unchanged, it
           # will be the same one that we set above)
           data = request.env["committee.response"]
         end

data/lib/committee/response_generator.rb

@@ -1,7 +1,8 @@
 module Committee
   class ResponseGenerator
     def call(link)
-      data = generate_properties(link, target_schema(link))
+      schema = target_schema(link)
+      data = generate_properties(link, schema)
 
       # List is a special case; wrap data in an array.
       #
@@ -14,7 +15,7 @@ module Committee
         data = [data]
       end
 
-      data
+      [data, schema]
     end
 
     private
@@ -37,6 +38,7 @@ module Committee
       # special example attribute was included; use its value
       if schema.data && !schema.data["example"].nil?
         schema.data["example"]
+
       elsif !schema.all_of.empty? || !schema.properties.empty?
         data = {}
         schema.all_of.each do |subschema|
@@ -46,12 +48,26 @@ module Committee
           data[key] = generate_properties(link, value)
         end
         data
+
       elsif schema.type.include?("array") && !schema.items.nil?
         [generate_properties(link, schema.items)]
+
+      elsif schema.enum
+        schema.enum.first
+
       elsif schema.type.any? { |t| SCALAR_TYPES.include?(t) }
         SCALAR_TYPES.each do |k, v|
           break(v) if schema.type.include?(k)
         end
+
+      # Generate an empty array for arrays.
+      elsif schema.type == ["array"]
+        []
+
+      # Schema is an object with no properties: just generate an empty object.
+      elsif schema.type == ["object"]
+        {}
+
       else
         raise(%{At "#{link.method} #{link.href}" "#{schema.pointer}": no } +
           %{"example" attribute and "null" } +

data/test/middleware/stub_test.rb

@@ -38,6 +38,15 @@ describe Committee::Middleware::Stub do
     assert_equal "", last_response.body
   end
 
+  it "optionally returns the application's response schema" do
+    @app = new_rack_app(call: true, schema: hyper_schema, suppress: true)
+    get "/apps/heroku-api"
+    assert_equal 429, last_response.status
+    assert_equal "#/definitions/app/links/2/targetSchema",
+      last_response.headers["Committee-Response-Schema"]
+    assert_equal "", last_response.body
+  end
+
   it "takes a prefix" do
     @app = new_rack_app(prefix: "/v1", schema: hyper_schema)
     get "/v1/apps/heroku-api"
@@ -75,7 +84,7 @@ describe Committee::Middleware::Stub do
     get "/apps/heroku-api"
     assert_equal 200, last_response.status
 
-    data = cache[cache.first[0]]
+    data, _schema = cache[cache.first[0]]
     assert_equal ValidApp.keys.sort, data.keys.sort
 
     # replace what we have in the cache
@@ -106,6 +115,12 @@ describe Committee::Middleware::Stub do
           })
         end
 
+        if res = env["committee.response_schema"]
+          headers.merge!({
+            "Committee-Response-Schema" => res.pointer,
+          })
+        end
+
         env["committee.suppress"] = suppress
 
         [429, headers, []]

data/test/response_generator_test.rb

@@ -10,13 +10,18 @@ describe Committee::ResponseGenerator do
     @list_link = @schema.properties["app"].links[3]
   end
 
+  it "returns the schema used to match" do
+    _data, schema = call
+    assert_equal @get_link.target_schema, schema
+  end
+
   it "generates string properties" do
-    data = call
+    data, _schema = call
     assert data["name"].is_a?(String)
   end
 
   it "generates non-string properties" do
-    data = call
+    data, _schema = call
     assert_includes [FalseClass, TrueClass], data["maintenance"].class
   end
 
@@ -25,7 +30,7 @@ describe Committee::ResponseGenerator do
 
     @link.rel = nil
 
-    data = call
+    data, _schema = call
     assert data.is_a?(Array)
   end
 
@@ -35,7 +40,7 @@ describe Committee::ResponseGenerator do
     # forces the link to use `parent`
     @link.target_schema = nil
 
-    data = call
+    data, _schema = call
 
     # We're testing for legacy behavior here: even without a `targetSchema` as
     # long as `rel` is set to `instances` we still wrap the the result in an
@@ -65,18 +70,46 @@ describe Committee::ResponseGenerator do
     assert_equal expected, e.message
   end
 
+  it "generates first enum value for a schema with enum" do
+    link = Committee::Drivers::OpenAPI2::Link.new
+    link.target_schema = JsonSchema::Schema.new
+    link.target_schema.enum = ["foo"]
+    link.target_schema.type = ["string"]
+    data, _schema = Committee::ResponseGenerator.new.call(link)
+    assert_equal("foo", data)
+  end
+
   it "generates basic types" do
     link = Committee::Drivers::OpenAPI2::Link.new
     link.target_schema = JsonSchema::Schema.new
 
     link.target_schema.type = ["integer"]
-    assert_equal 0, Committee::ResponseGenerator.new.call(link)
+    data, _schema = Committee::ResponseGenerator.new.call(link)
+    assert_equal 0, data
 
     link.target_schema.type = ["null"]
-    assert_equal nil, Committee::ResponseGenerator.new.call(link)
+    data, _schema = Committee::ResponseGenerator.new.call(link)
+    assert_equal nil, data
 
     link.target_schema.type = ["string"]
-    assert_equal "", Committee::ResponseGenerator.new.call(link)
+    data, _schema = Committee::ResponseGenerator.new.call(link)
+    assert_equal "", data
+  end
+
+  it "generates an empty array for an array type" do
+    link = Committee::Drivers::OpenAPI2::Link.new
+    link.target_schema = JsonSchema::Schema.new
+    link.target_schema.type = ["array"]
+    data, _schema = Committee::ResponseGenerator.new.call(link)
+    assert_equal([], data)
+  end
+
+  it "generates an empty object for an object with no fields" do
+    link = Committee::Drivers::OpenAPI2::Link.new
+    link.target_schema = JsonSchema::Schema.new
+    link.target_schema.type = ["object"]
+    data, _schema = Committee::ResponseGenerator.new.call(link)
+    assert_equal({}, data)
   end
 
   it "prefers an example to a built-in value" do
@@ -86,7 +119,8 @@ describe Committee::ResponseGenerator do
     link.target_schema.data = { "example" => 123 }
     link.target_schema.type = ["integer"]
 
-    assert_equal 123, Committee::ResponseGenerator.new.call(link)
+    data, _schema = Committee::ResponseGenerator.new.call(link)
+    assert_equal 123, data
   end
 
   it "prefers non-null types to null types" do
@@ -94,7 +128,8 @@ describe Committee::ResponseGenerator do
     link.target_schema = JsonSchema::Schema.new
 
     link.target_schema.type = ["null", "integer"]
-    assert_equal 0, Committee::ResponseGenerator.new.call(link)
+    data, _schema = Committee::ResponseGenerator.new.call(link)
+    assert_equal 0, data
   end
 
   def call

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: committee
 version: !ruby/object:Gem::Version
-  version: 2.0.0.pre5
+  version: 2.0.0.pre6
 platform: ruby
 authors:
 - Brandur
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-16 00:00:00.000000000 Z
+date: 2017-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_schema