docs: some review comments

Author: elliottmurray

examples/kafka/src/kafka_consumer.py

@@ -36,12 +36,13 @@ def message_decoder(obj):
     raise CustomError('type unknown')
 
 
-def send_dog_event_foo(foo, payload):
-    # ignoring foo here
-    return send_dog_event(payload)
+def receive_dog_event_foo(foo, payload):
+    # ignoring foo here - a more complicated interface. An example of
+    # not using the pact interface and testing events
+    return receive_dog_event(payload)
 
 
-def send_dog_event(payload):
+def receive_dog_event(payload):
     dog = json.loads(payload, object_hook=message_decoder)
     print(dog)
     return dog
@@ -56,7 +57,7 @@ def start_consumer(kafka_consumer, topic):
             if msg is None:
                 continue
             elif not msg.error():
-                send_dog_event(msg.value())
+                receive_dog_event(msg.value())
 
             elif msg.error().code() == KafkaError._PARTITION_EOF:
                 print('End of partition reached {0}/{1}'

examples/kafka/src/kafka_producer.py

@@ -19,7 +19,7 @@ class Dog():
     def __init__(self):
         i = random.randint(0, len(NAMES)-1)
         j = random.randint(0, len(BREEDS)-1)
-        self.__type__ = 'dog'
+        self.type = 'dog'
         self.name = NAMES[i]
         self.breed = BREEDS[j]
 

examples/kafka/tests/test_consumer.py

@@ -5,7 +5,7 @@
 import json
 
 from pact import MessageConsumer, Provider
-from src.kafka_consumer import send_dog_event, send_dog_event_foo, CustomError
+from src.kafka_consumer import receive_dog_event, receive_dog_event_foo, CustomError
 
 log = logging.getLogger(__name__)
 logging.basicConfig(level=logging.INFO)
@@ -45,7 +45,7 @@ def test_assert_verify_message(pact):
      .with_metadata({
          'Content-Type': 'application/json'
      })
-     .verify(send_dog_event)
+     .verify(receive_dog_event)
      )
 
 
@@ -59,7 +59,7 @@ def test_throw_exception_handler(pact):
             .with_metadata({
                 'Content-Type': 'application/json'
             })
-            .verify(send_dog_event))
+            .verify(receive_dog_event))
 
 
 def test_assert_dog_returned(pact):
@@ -71,7 +71,7 @@ def test_assert_dog_returned(pact):
      .with_metadata({
          'Content-Type': 'application/json'
      })
-     .verify(send_dog_event)
+     .verify(receive_dog_event)
      )
 
     with pact:
@@ -92,6 +92,6 @@ def test_assert_calling_dog(pact):
      )
 
     with pact:
-        dog = send_dog_event_foo({}, str(json.dumps(EXPECTED_DOG)))
+        dog = receive_dog_event_foo({}, str(json.dumps(EXPECTED_DOG)))
         assert dog.name == 'spot'
         assert dog.breed == 'poodle'