service_contract 0.0.10 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8533a9479365f0e1fe622726619e7d269df19251
-  data.tar.gz: 152c90e5d6a2ce67720ba9de55998225801d2feb
+  metadata.gz: 8cb40a77b33371d743328e30c58742c07a57d77c
+  data.tar.gz: b9bc84d00c6147ef1c3ecfec18ad7753cf17ec89
 SHA512:
-  metadata.gz: b13fb54905469260e43b5bc26c2840ca2ddfc32e35a3a240b884070aec49ba27ecafb6ba5b8ae667a8cee83593b6b0a4ebfb4d6fe50eda0f5472afc3f76f382c
-  data.tar.gz: 9aa632cd295c6a161544150cb0a5d83568fdf3d6dbf0bd1e09ca77bba52d763c33e3928fed2a2f63d53652497f44f736d327247ede0aec0ec05b7ffb1f5b4335
+  metadata.gz: b18b92ce0dcd4eefa1dac486dc51e98bfa4b6353717fb0175b0781b297c0f94694f85942071b49b40d9ea04069c3a9ae6b08b5e6daf3cf9fe7b6fc46f55b6863
+  data.tar.gz: 8f02a7a4235704d826932c5cb5b3d1c9b7f9f2ae9ce1a43f277af081b3d19a6020984202ffe6e922eb57b5eae24db855452c4a7958138d25cee09324814f462b

data/.gitignore

@@ -13,3 +13,4 @@
 *.a
 mkmf.log
 *.gem
+.idea

data/lib/service_contract/avro/endpoint.rb

@@ -54,6 +54,8 @@ module ServiceContract
 
       # seems kinda hacky
       def member?
+        return false if parameters.empty?
+
         first_param_type = parameters.first.type
         first_param_type.complex? && first_param_type.name == protocol.main_type
       end

data/lib/service_contract/avro/protocol.rb

@@ -21,6 +21,11 @@ module ServiceContract
         File.join(service.path, resource_name)
       end
 
+      def main_type
+        # convert protocol name to a class like name.  i.e. "city_state" => "CityState"
+        name.split("_").map{|o| o.capitalize}.join
+      end
+
       protected
 
       def resource_name

data/lib/service_contract/avro/type.rb

@@ -16,7 +16,9 @@ module ServiceContract
       end
 
       def to_s
-        name
+        return name unless union?
+ 
+        union_types.map(&:name).join(", ")
       end
 
       def subtype
@@ -36,6 +38,10 @@ module ServiceContract
         type_string == "record"
       end
 
+      def union?
+        type_string == "union"
+      end
+
       def valid_ruby_types
         case type_string
         when "array"
@@ -48,6 +54,10 @@ module ServiceContract
           [Float]
         when "boolean"
           [TrueClass, FalseClass]
+        when "null"
+          [NilClass]
+        when "union"
+          union_types.map(&:valid_ruby_types).flatten
         else # a complex type
           [Hash]
         end
@@ -55,6 +65,10 @@ module ServiceContract
 
       protected
 
+      def union_types
+        definition.schemas.map{|schema| Type.build(schema)}
+      end
+
       def type_string
         type = definition.type
         type = type.type_sym.to_s if type.respond_to?(:type_sym)

data/lib/service_contract/version.rb

@@ -1,3 +1,3 @@
 module ServiceContract
-  VERSION = "0.0.10"
+  VERSION = "0.1.0"
 end

data/test/assertions_test.rb

@@ -8,7 +8,7 @@ class AssertionsTest < Minitest::Test
     assert service, "expect to find a service by version"
     assert_equal "1", service.version
 
-    assert_equal 2, service.protocols.length
+    assert_equal 3, service.protocols.length
     protocol = service.protocol("location")
     endpoint = protocol.endpoint("index")
 
@@ -41,4 +41,21 @@ class AssertionsTest < Minitest::Test
     assert_endpoint_response(data, endpoint)
   end
 
+  def test_union_data_matching
+    service = SampleService.find(2)
+    assert service, "expect to find a service by version"
+
+    protocol = service.protocol("search_param")
+    endpoint = protocol.endpoint("index")
+
+    # test can be nil
+    assert_endpoint_response([{customer_id: nil}], endpoint)
+
+    # should be able to be an integer
+    assert_endpoint_response([{customer_id: 4}], endpoint)
+
+    # should be able to be an array of ints
+    assert_endpoint_response([{customer_id: [1,2,3]}], endpoint)
+  end
+
 end

data/test/sample/1/compiled/city_state.avpr

@@ -0,0 +1,68 @@
+{
+  "protocol" : "CityState",
+  "namespace" : "Gnomon",
+  "types" : [ {
+    "type" : "record",
+    "name" : "Timestamp",
+    "fields" : [ {
+      "name" : "timestamp",
+      "type" : "int"
+    } ]
+  }, {
+    "type" : "record",
+    "name" : "CityState",
+    "doc" : "This main class for this protocol",
+    "fields" : [ {
+      "name" : "id",
+      "type" : "int",
+      "doc" : "foo"
+    }, {
+      "name" : "city_id",
+      "type" : "int"
+    }, {
+      "name" : "state_id",
+      "type" : "int"
+    } ]
+  }, {
+    "type" : "record",
+    "name" : "FetchOption",
+    "fields" : [ {
+      "name" : "page",
+      "type" : "int",
+      "default" : 0
+    }, {
+      "name" : "per_page",
+      "type" : "int",
+      "default" : 30
+    } ]
+  } ],
+  "messages" : {
+    "bogus" : {
+      "doc" : "bogus method for testing no parameters",
+      "request" : [ ],
+      "response" : "null"
+    },
+    "non_member_method" : {
+      "doc" : "method that uses non \"main_type\" as the first parameter is considered non-member",
+      "request" : [ {
+        "name" : "options",
+        "type" : "FetchOption"
+      } ],
+      "response" : {
+        "type" : "array",
+        "items" : "CityState"
+      }
+    },
+    "member_method" : {
+      "doc" : "method that uses \"main_type\" as the first parameter is considered member",
+      "request" : [ {
+        "name" : "params",
+        "type" : "CityState"
+      } ],
+      "response" : {
+        "type" : "array",
+        "items" : "CityState"
+      }
+    }
+  }
+}

data/test/sample/1/source/city_state.avdl

@@ -0,0 +1,30 @@
+@namespace("Gnomon")
+
+protocol CityState {
+
+  record Timestamp {
+    int timestamp;
+  }
+
+  /** This main class for this protocol */
+  record CityState {
+    /** foo */
+    int id;
+    int city_id;
+    int state_id;
+  }
+
+  record FetchOption {
+    int page = 0;
+    int per_page = 30;
+  }
+
+  /** bogus method for testing no parameters */
+  void bogus();
+
+  /** method that uses non "main_type" as the first parameter is considered non-member */
+  array<CityState> non_member_method(FetchOption options);
+
+  /** method that uses "main_type" as the first parameter is considered member */
+  array<CityState> member_method(CityState params);
+}

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

@@ -0,0 +1,25 @@
+{
+  "protocol" : "SearchParam",
+  "namespace" : "Gnomon",
+  "types" : [ {
+    "type" : "record",
+    "name" : "SearchParam",
+    "fields" : [ {
+      "name" : "customer_id",
+      "type" : [ "null", "int", {
+        "type" : "array",
+        "items" : "int"
+      } ],
+      "doc" : "Required search params"
+    } ]
+  } ],
+  "messages" : {
+    "index" : {
+      "request" : [ ],
+      "response" : {
+        "type" : "array",
+        "items" : "SearchParam"
+      }
+    }
+  }
+}

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

@@ -0,0 +1,12 @@
+@namespace("Gnomon")
+
+protocol SearchParam {
+
+  record SearchParam {
+    /** Required search params */
+    union {null, int, array<int>} customer_id;
+  }
+
+  array<SearchParam> index();
+  
+}

data/test/service_test.rb

@@ -3,7 +3,7 @@ require 'test_helper'
 class ServiceTest < Minitest::Test
 
   def test_all
-    assert_equal(1, SampleService.all.length)
+    assert_equal(2, SampleService.all.length)
   end
 
   def test_find
@@ -11,11 +11,66 @@ class ServiceTest < Minitest::Test
     assert service, "expect to find a service by version"
     assert_equal "1", service.version
 
-    assert_equal 2, service.protocols.length
+    assert_equal 3, service.protocols.length
     protocol = service.protocol("location")
 
     assert_equal "location", protocol.name
     assert_equal 3, protocol.endpoints.length
   end
 
+  def test_null_params
+    # the member? method would error if the endpoint method had no parameters.  This test verifies the fix.
+    service = SampleService.find(1)
+    protocol = service.protocol("city_state")
+
+    # find the endpoint with no parameters.
+    empty_param_endpoints = protocol.endpoints.select{|e| e.parameters.empty?}
+    assert !empty_param_endpoints.empty?
+
+    empty_param_endpoints.each do |endpoint|
+      assert_equal(false, endpoint.send("member?"))
+    end
+  end
+
+  # The member? method determines if an endpoint is a "member" by looking at its first parameter.  If that parameter
+  # is equal to the 'main_type' then it is a member, otherwise it is not a member.  Main_type is nothing more than the
+  # classname of the protocol.
+  def test_member_endpoint
+    service = SampleService.find(1)
+    protocol = service.protocol("city_state")
+
+    # only one endpoint is a member method, "member_method"
+    member_names = protocol.endpoints.select{|e| e.send("member?")}.map(&:name)
+    assert_equal(1, member_names.length)
+    assert_equal('member_method', member_names.first)
+  end
+
+  def test_non_member_endpoint
+    service = SampleService.find(1)
+    protocol = service.protocol("city_state")
+
+    # two endpoints are non member method, "bogus" and "non_member_method"
+    non_member_names = protocol.endpoints.select{|e| !e.send("member?")}.map(&:name)
+    assert_equal(2, non_member_names.length)
+    assert non_member_names.include?('non_member_method')
+    assert non_member_names.include?('bogus')
+  end
+
+  def test_union_types
+    service = SampleService.find(2)
+    protocol = service.protocol('search_param')
+
+    type = protocol.type('SearchParam')
+    assert(type, 'expected to find a SearchParam type')
+
+    field = type.fields.detect{|field| field.name == 'customer_id'}
+    assert(field, 'expected to find a customer_id field')
+
+    field_type = field.type
+
+    assert_equal('union', field_type.name)
+    assert_equal('null, int, Array(int)', field_type.to_s)
+    assert_equal([NilClass, Fixnum, Array], field_type.valid_ruby_types)
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: service_contract
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.1.0
 platform: ruby
 authors:
 - Jeff Ching
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-16 00:00:00.000000000 Z
+date: 2014-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: avro
@@ -120,10 +120,14 @@ files:
 - src/avro-tools-1.7.7.jar
 - test/assertions_test.rb
 - test/mock_test.rb
+- test/sample/1/compiled/city_state.avpr
 - test/sample/1/compiled/location.avpr
 - test/sample/1/compiled/sales_region.avpr
+- test/sample/1/source/city_state.avdl
 - test/sample/1/source/location.avdl
 - test/sample/1/source/sales_region.avdl
+- test/sample/2/compiled/search_param.avpr
+- test/sample/2/source/search_param.avdl
 - test/service_test.rb
 - test/test_helper.rb
 homepage: ''
@@ -153,10 +157,14 @@ summary: Abstract the definition of a service's interface contract
 test_files:
 - test/assertions_test.rb
 - test/mock_test.rb
+- test/sample/1/compiled/city_state.avpr
 - test/sample/1/compiled/location.avpr
 - test/sample/1/compiled/sales_region.avpr
+- test/sample/1/source/city_state.avdl
 - test/sample/1/source/location.avdl
 - test/sample/1/source/sales_region.avdl
+- test/sample/2/compiled/search_param.avpr
+- test/sample/2/source/search_param.avdl
 - test/service_test.rb
 - test/test_helper.rb
 has_rdoc: