service_contract 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6a646e023469ec20b53cb514deae92a002cf199c
-  data.tar.gz: a2857a80a1a09a83b76c856bd64242a7c2ec9b7a
+  metadata.gz: 958fc813b28a607f6fb71c40dee6afd54e04b57c
+  data.tar.gz: 21f8bd6925f79b150546c34c1ccc1244f69616e9
 SHA512:
-  metadata.gz: 9893b954b5ea20337a5dd899c6314d230875971957715b4e3316d6839bcd0e067b32abdc5785335122ea90bd3b4024b1566c95e116f8238000a9da70929ced73
-  data.tar.gz: b71053b15c67699ebf64a0b36c78aab4eee1632092a6b3ce4847f09d85623dc2fd6dd19ec34f649ce805162e09244428da5f684ddd3d033a211fb0feb3281f72
+  metadata.gz: bc126bb04f0f3511eb3d921afc8a2aead84764fe5732266a63fdcf487cc400ddc17ebc9266ef58c9797c0f9484c74f7fe144efbd13bf56a8b31128f431d9a7da
+  data.tar.gz: c912a0cf26a8a25a12b9bb43bd24b2e72f4feab3ef8a8f86b60952f49d78b97ffdd1f37e4bc5331cccac819253b7b5134c60f6308534549e17588da9147a1aeb

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 0.5.0
+
+* add map types
+* refactor some internals for testing types
+
+## 0.4.1
+
+* Fix slim template for the link to show documentation
+
 ## 0.4.0
 
 * add enum types

data/lib/service_contract/abstract_type.rb

@@ -1,7 +1,7 @@
 module ServiceContract
   AbstractType = Struct.new(:definition) do
     def name
-      raise :not_implemented
+      raise NotImplementedError, "need to implement `name`"
     end
 
     def subtype
@@ -12,6 +12,10 @@ module ServiceContract
       []
     end
 
+    def valid_type?(value)
+      valid_ruby_types.any?{|type| value.is_a?(type) }
+    end
+
     def valid_value?(value)
       if valid_values.empty?
         true

data/lib/service_contract/assertions.rb

@@ -10,7 +10,7 @@ module ServiceContract
       return true if data.nil? && allow_nil
 
       # basic type checking
-      assert type.valid_ruby_types.any?{|type| data.is_a?(type) }, "expected #{type.name} to be one of #{type.valid_ruby_types}"
+      assert type.valid_type?(data), "expected `#{data}` (#{type.name}) to be one of #{type.valid_ruby_types}"
       assert type.valid_value?(data), "#{data} is not an allowed value of type: #{type.name}"
 
       # check subtype

data/lib/service_contract/avro/type.rb

@@ -16,6 +16,34 @@ module ServiceContract
       end
     end
 
+    class MapType < AbstractType
+      def name
+        "Map(#{subtype.name})"
+      end
+
+      def subtype
+        MapValue.new(Type.build(definition.values))
+      end
+
+      def valid_ruby_types
+        [Hash]
+      end
+    end
+
+    class MapValue < AbstractType
+      def name
+        definition.name
+      end
+      def valid_type?(value)
+        value.is_a?(Array) &&
+          value.length == 2 &&
+          definition.valid_type?(value[1])
+      end
+      def valid_ruby_types
+        definition.valid_ruby_types
+      end
+    end
+
     class ArrayType < AbstractType
       def name
         "Array(#{subtype.name})"
@@ -134,6 +162,8 @@ module ServiceContract
             BooleanType.new
           when "null"
             NullType.new
+          when "map"
+            MapType.new(definition)
           else
             raise "unknown type: #{type}"
           end

data/lib/service_contract/version.rb

@@ -1,3 +1,3 @@
 module ServiceContract
-  VERSION = "0.4.1"
+  VERSION = "0.5.0"
 end

data/test/assertions_test.rb

@@ -65,17 +65,10 @@ class AssertionsTest < Minitest::Test
     protocol = service.protocol("search_param")
     endpoint = protocol.endpoint("index")
 
-    # test can be nil
-    failure_data = nil
-    begin
-      assert_endpoint_response([{customer_id: nil, bogus_param: 1}], endpoint)
-    rescue Minitest::Assertion => failure
-      failure_data = failure
-    end
-
-    assert !failure_data.nil?
-    assert failure_data.to_s.include?("not described in contract: bogus_param")
-
+    bad_data = [
+      {customer_id: nil, bogus_param: 1}
+    ]
+    assert_bad_value(bad_data, endpoint, message: "not described in contract: bogus_param")
   end
 
   def test_enum_values
@@ -92,10 +85,49 @@ class AssertionsTest < Minitest::Test
 
     assert_endpoint_response(data, endpoint)
 
-    # test can be nil
     bad_data = [
       {token: "sometoken", provider: "bad provider"}
     ]
+    assert_bad_value(bad_data, endpoint)
+  end
+
+  def test_map_values
+    service = SampleService.find(2)
+    assert service, "expect to find a service by version"
+
+    protocol = service.protocol("logging")
+    endpoint = protocol.endpoint("index")
+
+    data = [
+      {
+        data: {
+          foo: 1,
+          bar: 2,
+        },
+        data2: {
+          qwer: nil,
+          asdf: 1,
+          zxcv: [2,3]
+        }
+      }
+    ]
+
+    assert_endpoint_response(data, endpoint)
+
+    bad_data = [
+      {
+        data: {
+          foo: "asdf"
+        },
+        data2: {}
+      }
+    ]
+    assert_bad_value(bad_data, endpoint, message: "to be one of")
+  end
+
+  private
+
+  def assert_bad_value(bad_data, endpoint, message: "is not an allowed value")
     failure_data = nil
     begin
       assert_endpoint_response(bad_data, endpoint)
@@ -104,7 +136,7 @@ class AssertionsTest < Minitest::Test
     end
 
     assert !failure_data.nil?
-    assert failure_data.to_s.include?("is not an allowed value"), failure_data
+    assert failure_data.to_s.include?(message), failure_data
   end
 
 end

data/test/sample/2/compiled/logging.avpr

@@ -0,0 +1,33 @@
+{
+  "protocol" : "Logging",
+  "namespace" : "Gnomon",
+  "types" : [ {
+    "type" : "record",
+    "name" : "LogEntry",
+    "fields" : [ {
+      "name" : "data",
+      "type" : {
+        "type" : "map",
+        "values" : "int"
+      }
+    }, {
+      "name" : "data2",
+      "type" : {
+        "type" : "map",
+        "values" : [ "null", "int", {
+          "type" : "array",
+          "items" : "int"
+        } ]
+      }
+    } ]
+  } ],
+  "messages" : {
+    "index" : {
+      "request" : [ ],
+      "response" : {
+        "type" : "array",
+        "items" : "LogEntry"
+      }
+    }
+  }
+}

data/test/sample/2/source/logging.avdl

@@ -0,0 +1,13 @@
+@namespace("Gnomon")
+
+protocol Logging {
+
+  record LogEntry {
+    map<int> data;
+
+    map<union{null, int, array<int>}> data2;
+  }
+
+  array<LogEntry> index();
+
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: service_contract
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Jeff Ching
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-08 00:00:00.000000000 Z
+date: 2016-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: avro
@@ -126,8 +126,10 @@ files:
 - test/sample/1/source/city_state.avdl
 - test/sample/1/source/location.avdl
 - test/sample/1/source/sales_region.avdl
+- test/sample/2/compiled/logging.avpr
 - test/sample/2/compiled/search_param.avpr
 - test/sample/2/compiled/social_login.avpr
+- test/sample/2/source/logging.avdl
 - test/sample/2/source/search_param.avdl
 - test/sample/2/source/social_login.avdl
 - test/service_test.rb
@@ -165,8 +167,10 @@ test_files:
 - test/sample/1/source/city_state.avdl
 - test/sample/1/source/location.avdl
 - test/sample/1/source/sales_region.avdl
+- test/sample/2/compiled/logging.avpr
 - test/sample/2/compiled/search_param.avpr
 - test/sample/2/compiled/social_login.avpr
+- test/sample/2/source/logging.avdl
 - test/sample/2/source/search_param.avdl
 - test/sample/2/source/social_login.avdl
 - test/service_test.rb