Resolve "Release v0.1"

Closes #10 (closed), #7 (closed)

features/adapter_auth.feature

+Feature: Does the adapter authenticate?
+  When an adapter instance is created it authenticates and receives a token
+
+  Scenario: A token is granted with valid config
+    Given valid config
+    When the adapter instance is created
+    When the auth method is called
+    Then the adapter credentials are populated
+
+  Scenario: Auth fails with invalid config
+    Given invalid config
+    When the adapter instance is created
+    Then the adapter auth fails
\ No newline at end of file

features/adapter_broadcast.feature

+Feature: Can the adapter broadcast messages?
+  The adapter publish method works as expected
+
+  Scenario: A message can be published successfully
+    Given valid config
+    When the adapter instance is created
+    When the auth method is called
+    When a mock notify API response is configured to return success
+    When the broadcast method is called
+    Then a successful response is returned with status 200
+
+  Scenario: A failed publish returns a 403
+    Given valid config
+    When the adapter instance is created
+    When the auth method is called
+    When a mock notify API response is configured to return a 403 error
+    When the broadcast method is called
+    Then an error response is returned with status 403
+
+  Scenario: On 403 the message is retried once with new credentials 
+    Given valid config 
+    When the adapter instance is created 
+    When the auth method is called 
+    When a mock notify API response is configured to return a 403 error
+    When the broadcast method is called 
+    Then an error response is returned with status 403 
+    Then the credentials are deleted
+    Then the broadcast method was called with is_retry on
+    Then the total number of calls to "broadcast" was 2
+    Then the total number of "GET" requests to "/token" was 2
+    
+  Scenario: On a retried 403 the message is not retried again
+    Given valid config 
+    When the adapter instance is created 
+    When the auth method is called 
+    When a mock notify API response is configured to return a 403 error 
+    When the broadcast method is called with is_retry on
+    Then an error response is returned with status 403
+    Then the credentials are deleted 
+    Then the total number of calls to "broadcast" was 1
+    
+  Scenario: On 503 the message is retried once with the same credentials 
+    Given valid config 
+    When the adapter instance is created 
+    When the auth method is called 
+    When a mock notify API response is configured to return a 503 error 
+    When the broadcast method is called 
+    Then an error response is returned with status 503 
+    Then the credentials are not deleted
+    Then the broadcast method was called with is_retry on
+    Then the total number of calls to "broadcast" was 2
+    Then the total number of "GET" requests to "/token" was 1
+    
+  Scenario: On a retried 503 the message is not retried again
+    Given valid config 
+    When the adapter instance is created 
+    When the auth method is called 
+    When a mock notify API response is configured to return a 503 error 
+    When the broadcast method is called with is_retry on
+    Then an error response is returned with status 503
+    Then the credentials are not deleted 
+    Then the total number of calls to "broadcast" was 1

features/adapter_get-authorization-header.feature

+Feature: Can the adapter create an authorization header?
+  The adapter getAuthorizationHeader method works as expected
+
+  Scenario: getAuthorizationHeader returns a bearer token
+    Given valid config
+    When the adapter instance is created
+    When the auth method is called
+    When the getAuthorizationHeader method is called
+    Then a headers object is returned containing a bearer token authorization header
+
+  Scenario: getAuthorizationHeader implicitly calls auth if required
+    Given valid config
+    When the adapter instance is created
+    When the getAuthorizationHeader method is called
+    Then a headers object is returned containing a bearer token authorization header
+
+  Scenario: getAuthorizationHeader implicitly calls auth if required
+    Given invalid config
+    When the adapter instance is created
+    When the getAuthorizationHeader method is called
+    Then an error response is returned with status 403
\ No newline at end of file

features/adapter_poll.feature

+# When the queue contains x messages 
+# only mocks the API response 
+# Testing how the API behaves with a full queue are defined in the API 
+
+Feature: Can the adapter receive messages?
+  The adapter poll method works as expected
+
+  Scenario: No messages are received successfully if the queue is empty
+    Given valid config
+    When the adapter instance is created
+    When the auth method is called
+    When a mock receive API response is configured to return 0 messages
+    When the poll method is called
+    Then a successful response is returned with 0 messages  
+
+  Scenario: 2 messages are received successfully if the queue contains 2 messages
+    Given valid config
+    When the adapter instance is created
+    When the auth method is called
+    When a mock receive API response is configured to return 2 messages 
+    When the poll method is called
+    Then a successful response is returned with 2 messages
+    Then the protocol "validate" method is called 2 times
+    Then the protocol "decode" method is called 2 times
+
+  Scenario: 10 messages are received successfully if the queue contains 10 messages
+    Given valid config
+    When the adapter instance is created
+    When the auth method is called
+    When a mock receive API response is configured to return 10 messages 
+    When the poll method is called
+    Then a successful response is returned with 10 messages
+    Then the protocol "validate" method is called 10 times
+    Then the protocol "decode" method is called 10 times
+
+  Scenario: An invalid token returns a forbidden response 
+    Given valid config 
+    When the adapter instance is created 
+    When the auth method is called 
+    When a mock receive API response is configured to return a 403 error
+    When the poll method is called 
+    Then an error response is returned with status 403
+
+  Scenario: On 403 the message is retried once with new credentials 
+    Given valid config 
+    When the adapter instance is created 
+    When the auth method is called 
+    When a mock receive API response is configured to return a 403 error 
+    When the poll method is called 
+    Then an error response is returned with status 403 
+    Then the credentials are deleted
+    Then the poll method was called with is_retry on
+    Then the total number of calls to "poll" was 2
+    Then the total number of "GET" requests to "/token" was 2
+    
+  Scenario: On a retried 403 the message is not retried again
+    Given valid config 
+    When the adapter instance is created 
+    When the auth method is called 
+    When a mock receive API response is configured to return a 403 error 
+    When the poll method is called with is_retry on
+    Then an error response is returned with status 403
+    Then the credentials are deleted 
+    Then the total number of calls to "poll" was 1
+  
+  Scenario: On 503 the message is retried once with the same credentials 
+    Given valid config 
+    When the adapter instance is created 
+    When the auth method is called 
+    When a mock receive API response is configured to return a 503 error 
+    When the poll method is called 
+    Then an error response is returned with status 503 
+    Then the credentials are not deleted
+    Then the poll method was called with is_retry on
+    Then the total number of calls to "poll" was 2
+    Then the total number of "GET" requests to "/token" was 1
+  
+  Scenario: On a retried 503 the message is not retried again
+    Given valid config 
+    When the adapter instance is created 
+    When the auth method is called 
+    When a mock receive API response is configured to return a 503 error 
+    When the poll method is called with is_retry on
+    Then an error response is returned with status 503
+    Then the credentials are not deleted 
+    Then the total number of calls to "poll" was 1
+  
\ No newline at end of file

features/adapter_publish.feature

+Feature: Can the adapter publish messages?
+  The adapter publish method works as expected
+
+  Scenario: A message can be published successfully
+    Given valid config
+    When the adapter instance is created
+    When the auth method is called
+    When a mock send API response is configured to return success
+    When the publish method is called
+    Then a successful response is returned with status 200
+
+  Scenario: A failed publish returns a 403
+    Given valid config
+    When the adapter instance is created
+    When the auth method is called
+    When a mock send API response is configured to return a 403 error
+    When the publish method is called
+    Then an error response is returned with status 403
+
+  Scenario: On 403 the message is retried once with new credentials 
+    Given valid config 
+    When the adapter instance is created 
+    When the auth method is called 
+    When a mock send API response is configured to return a 403 error 
+    When the publish method is called 
+    Then an error response is returned with status 403 
+    Then the credentials are deleted
+    Then the publish method was called with is_retry on
+    Then the total number of calls to "publish" was 2
+    Then the total number of "GET" requests to "/token" was 2
+    
+  Scenario: On a retried 403 the message is not retried again
+    Given valid config 
+    When the adapter instance is created 
+    When the auth method is called 
+    When a mock send API response is configured to return a 403 error 
+    When the publish method is called with is_retry on
+    Then an error response is returned with status 403
+    Then the credentials are deleted 
+    Then the total number of calls to "publish" was 1
+  
+  Scenario: On 503 the message is retried once with the same credentials 
+    Given valid config 
+    When the adapter instance is created 
+    When the auth method is called 
+    When a mock send API response is configured to return a 503 error 
+    When the publish method is called 
+    Then an error response is returned with status 503 
+    Then the credentials are not deleted
+    Then the publish method was called with is_retry on
+    Then the total number of calls to "publish" was 2
+    Then the total number of "GET" requests to "/token" was 1
+    
+  Scenario: On a retried 503 the message is not retried again
+    Given valid config 
+    When the adapter instance is created 
+    When the auth method is called 
+    When a mock send API response is configured to return a 503 error 
+    When the publish method is called with is_retry on
+    Then an error response is returned with status 503
+    Then the credentials are not deleted 
+    Then the total number of calls to "publish" was 1
+  
\ No newline at end of file

features/adapter_token-valid.feature

+# tokenValid returns true if there is a token and the expiry is in the future
+# tokenValid returns false if the token expiry is in the past 
+# or if there is no token 
+# In the case where invalid credentials are supplied 
+# the auth will fail so there will be no token available 
+
+Feature: Is the token valid?
+  The adapter tokenValid method works as expected
+
+  Scenario: If adapter has not authed then the tokenValid returns false
+    Given valid config
+    When the adapter instance is created
+    Then tokenValid returns false  
+
+  Scenario: If credentials.expiry is in the future then the token is valid
+    Given valid config
+    When the adapter instance is created
+    When the auth method is called
+    When the token expiry is in the future
+    Then tokenValid returns true  
+
+  Scenario: If credentials.expiry is in the past then the token is invalid
+    Given valid config
+    When the adapter instance is created
+    When the auth method is called
+    When the token expiry is in the past
+    Then tokenValid returns false 

features/adapter_validate.feature

+Feature: Can the adapter validate messages?
+  The adapter validate method works as expected
+
+  Scenario: A valid message is successfully validated against the protocol schema
+    Given valid config
+    Given a valid message
+    When the adapter instance is created
+    When the validate method is called
+    Then the message is validated successfully  
+  
+  Scenario: An invalid message fails to validate against the protocol schema
+    Given valid config
+    Given an invalid message
+    When the adapter instance is created
+    When the validate method is called
+    Then the message fails to validate  
\ No newline at end of file

features/protocol_decode.feature

+# Decode and encode are provided as stubs which are intended to be overridden 
+# These can be used to translate the message or to invoke other functions 
+# to take action based on the type and content of messages
+
+Feature: Decode stubs passthru message unchanged
+  The protocol decode method works as expected
+
+  Scenario: Decode passes the message through unaltered
+    Given a valid message
+    When the protocol.decode method is called
+    Then the message is returned unaltered

features/protocol_encode.feature

+# Decode and encode are provided as stubs which are intended to be overridden 
+# These can be used to translate the message or to invoke other functions 
+# to take action based on the type and content of messages
+
+Feature: Encode stubs passthru message unchanged
+  The protocol encode method works as expected
+
+  Scenario: Encode passes the message through unaltered
+    Given a valid message
+    When the protocol.encode method is called
+    Then the message is returned unaltered
\ No newline at end of file

features/protocol_get-type.feature

+Feature: Can the protocol determine message type
+  The protocol getType method works as expected
+
+  Scenario: A valid message is successfully typed
+    Given a valid message
+    When protocol getType is called
+    Then getType returns message.payload.message_type if present
+
+  Scenario: An invalid message returns type:null
+    Given an invalid message
+    When protocol getType is called
+    Then getType returns null if message.payload.message_type is not present

features/protocol_validate.feature

+Feature: Can the protocol validate messages?
+  The adapter validate method works as expected
+
+  Scenario: A valid message is successfully validated against the protocol schema
+    Given a valid message
+    When the protocol.validate method is called
+    Then the message is validated successfully  
+  
+  Scenario: An invalid message fails to validate against the protocol schema
+    Given an invalid message
+    When the protocol.validate method is called
+    Then the message fails to validate
\ No newline at end of file