messagemedia_signingkeys_sdk 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e2e2b65cb2866ec5345a5827016239f9dc2b8c5f
-  data.tar.gz: ac401ed597aa9a0fe11be1976916c25e2abfb82b
+  metadata.gz: dfc906c821d60856d2d5a3b326abc0832e8a7282
+  data.tar.gz: fe9bffe36d126e9e3bdf26c440be4c4cc830795a
 SHA512:
-  metadata.gz: fd47694f3d6c43aebdd9890d6025e79ede2b2e401630b36fcf960b55dfaf6727d755ac7770b8dede6853683fac3f827455cdb0efcbf97ed9b9750c53267db961
-  data.tar.gz: 90cc6efc17d9344874ca2821915de6f87707fea9278f3487bba6398ebfd5d7dabb0188154929c9b26ea6bb184fedc014fa0720aaa018fc02883e6dd0c275a48f
+  metadata.gz: 9f5f5513bbbf453bf100b3a18757c431abff54a3abdf1d1cf97a83a20943ead0c2a46c51324ab6722b65a2eed91b0f67320378b7201ab0e2d58cba5aa907fd8d
+  data.tar.gz: 15dd1b8494fefbf1c0464b97d5d40ca04275c9d8e1cecce65e432b62bd7dee4b81b3bddc52f46eccdc84cd9e822a59bf8b84921552144eaecf6d6e8409dd12f2

data/README.md

@@ -1,6 +1,6 @@
 # MessageMedia Signature Key Management Ruby SDK
-[![Build Status](https://travis-ci.org/messagemedia/signing-keys-nodejs-sdk.svg?branch=master)](https://travis-ci.org/messagemedia/signing-keys-nodejs-sdk)
-[![npm version](https://badge.fury.io/js/messagemedia-signingkeys-sdk.svg)](https://badge.fury.io/js/messagemedia-signingkeys-sdk)
+[![Build Status](https://travis-ci.org/messagemedia/signing-keys-ruby-sdk.svg?branch=master)](https://travis-ci.org/messagemedia/signing-keys-ruby-sdk)
+[![Gem Version](https://badge.fury.io/rb/messagemedia_signingkeys_sdk.svg)](https://badge.fury.io/rb/messagemedia_signingkeys_sdk)
 
 The MessageMedia Signature Key API provides a number of endpoints for managing key used to sign each unique request to ensure security and the requests can't (easily) be spoofed. This is similar to using HMAC in your outbound messaging (rather than HTTP Basic).
 
@@ -26,16 +26,13 @@ client = MessageMediaSigningKeys::MessageMediaSigningKeysClient.new(
 
 signatureKeyManagement_controller = client.signature_key_management
 
-content_type = 'Content-Type'
-accept = 'Accept'
-body_value = '{
-  "digest": "SHA224",
-  "cipher": "RSA"
-}';
-
+body_value = "{   
+                \"digest\": \"SHA224\",   
+                \"cipher\": \"RSA\"
+}";
 body = JSON.parse(body_value);
 
-result = signatureKeyManagement_controller.create_signature_key(content_type, accept, body)
+result = signatureKeyManagement_controller.create_signature_key(body)
 pp result
 
 ```
@@ -58,10 +55,8 @@ client = MessageMediaSigningKeys::MessageMediaSigningKeysClient.new(
 signatureKeyManagement_controller = client.signature_key_management
 
 key_id = 'key_id'
-content_type = 'Content-Type'
-accept = 'Accept'
 
-result = signatureKeyManagement_controller.get_signature_key_detail(key_id, content_type, accept)
+result = signatureKeyManagement_controller.get_signature_key_detail(key_id)
 pp result
 
 ```
@@ -82,12 +77,7 @@ client = MessageMediaSigningKeys::MessageMediaSigningKeysClient.new(
 
 signatureKeyManagement_controller = client.signature_key_management
 
-content_type = 'Content-Type'
-accept = 'Accept'
-page = 'page'
-page_size = 'page_size'
-
-result = signatureKeyManagement_controller.get_signature_key_list(content_type, accept, page, page_size)
+result = signatureKeyManagement_controller.get_signature_key_list()
 pp result
 
 ```
@@ -109,10 +99,8 @@ client = MessageMediaSigningKeys::MessageMediaSigningKeysClient.new(
 signatureKeyManagement_controller = client.signature_key_management
 
 key_id = 'key_id'
-content_type = 'Content-Type'
-accept = 'Accept'
 
-signatureKeyManagement_controller.delete_signature_key(key_id, content_type, accept)
+signatureKeyManagement_controller.delete_signature_key(key_id)
 
 ```
 
@@ -133,11 +121,11 @@ client = MessageMediaSigningKeys::MessageMediaSigningKeysClient.new(
 
 signatureKeyManagement_controller = client.signature_key_management
 
-content_type = 'Content-Type'
-accept = 'Accept'
-body = EnableSignatureKeyRequest.new
+body = EnableSignatureKeyRequest.new({
+    "key_id": "7ca628a8-08b0-4e42-aeb8-960b37049c31"
+})
 
-result = signatureKeyManagement_controller.update_enable_signature_key(content_type, accept, body)
+result = signatureKeyManagement_controller.update_enable_signature_key(body)
 pp result
 
 ```
@@ -158,10 +146,7 @@ client = MessageMediaSigningKeys::MessageMediaSigningKeysClient.new(
 
 signatureKeyManagement_controller = client.signature_key_management
 
-content_type = 'Content-Type'
-accept = 'Accept'
-
-result = signatureKeyManagement_controller.get_enabled_signature_key(content_type, accept)
+result = signatureKeyManagement_controller.get_enabled_signature_key()
 pp result
 
 ```
@@ -181,10 +166,7 @@ client = MessageMediaSigningKeys::MessageMediaSigningKeysClient.new(
 
 signatureKeyManagement_controller = client.signature_key_management
 
-content_type = 'Content-Type'
-accept = 'Accept'
-
-signatureKeyManagement_controller.delete_disable_the_current_enabled_signature_key(content_type, accept)
+signatureKeyManagement_controller.delete_disable_the_current_enabled_signature_key()
 
 ```
 

data/lib/message_media_signing_keys.rb

@@ -30,15 +30,25 @@ require_relative 'message_media_signing_keys/models/get_signature_key_list' \
                  '_response.rb'
 require_relative 'message_media_signing_keys/models/get_signature_key_detail' \
                  '_response.rb'
-require_relative 'message_media_signing_keys/models/create_signature_key' \
+require_relative 'message_media_signing_keys/models/enable_signature_key' \
                  '_request.rb'
 require_relative 'message_media_signing_keys/models/create_signature_key' \
                  '_response.rb'
-require_relative 'message_media_signing_keys/models/enable_signature_key' \
+require_relative 'message_media_signing_keys/models/create_signature_key' \
                  '_request.rb'
 
 # Exceptions
 require_relative 'message_media_signing_keys/exceptions/api_exception.rb'
+require_relative 'message_media_signing_keys/exceptions/disable_the_current' \
+                 '_enabled_signature_key403_response_exception.rb'
+require_relative 'message_media_signing_keys/exceptions/get_enabled_signature' \
+                 '_key403_response_exception.rb'
+require_relative 'message_media_signing_keys/exceptions/enable_signature' \
+                 '_key403_response_exception.rb'
+require_relative 'message_media_signing_keys/exceptions/enable_signature' \
+                 '_key400_response_exception.rb'
+require_relative 'message_media_signing_keys/exceptions/get_signature_key' \
+                 '_list403_response_exception.rb'
 require_relative 'message_media_signing_keys/exceptions/get_signature_key' \
                  '_list400_response_exception.rb'
 require_relative 'message_media_signing_keys/exceptions/delete_signature' \
@@ -51,16 +61,6 @@ require_relative 'message_media_signing_keys/exceptions/create_signature' \
                  '_key403_response_exception.rb'
 require_relative 'message_media_signing_keys/exceptions/create_signature' \
                  '_key400_response_exception.rb'
-require_relative 'message_media_signing_keys/exceptions/disable_the_current' \
-                 '_enabled_signature_key403_response_exception.rb'
-require_relative 'message_media_signing_keys/exceptions/get_enabled_signature' \
-                 '_key403_response_exception.rb'
-require_relative 'message_media_signing_keys/exceptions/enable_signature' \
-                 '_key403_response_exception.rb'
-require_relative 'message_media_signing_keys/exceptions/enable_signature' \
-                 '_key400_response_exception.rb'
-require_relative 'message_media_signing_keys/exceptions/get_signature_key' \
-                 '_list403_response_exception.rb'
 
 require_relative 'message_media_signing_keys/configuration.rb'
 

data/lib/message_media_signing_keys/controllers/base_controller.rb

@@ -11,7 +11,7 @@ module MessageMediaSigningKeys
       @http_call_back = http_call_back
 
       @global_headers = {
-        'user-agent' => 'messagemedia-signingkeys-sdk-1.0.0'
+        'user-agent' => 'messagemedia-signingkeys-sdk-1.1.0'
       }
       @logger = Logging.logger[self]
       @logger.info("Instantiated controller class.")

data/lib/message_media_signing_keys/controllers/signature_key_management_controller.rb

@@ -21,11 +21,8 @@ module MessageMediaSigningKeys
     # is returned.
     # If there is no key or no enabled key, the 204 status code is also
     # returned.
-    # @param [String] content_type Required parameter: Example:
-    # @param [String] accept Required parameter: Example:
     # @return void response from the API call
-    def delete_disable_the_current_enabled_signature_key(content_type,
-                                                         accept)
+    def delete_disable_the_current_enabled_signature_key
       begin
         @logger.info("delete_disable_the_current_enabled_signature_key called.")
         # Prepare query url.
@@ -34,18 +31,10 @@ module MessageMediaSigningKeys
         _query_builder << '/v1/iam/signature_keys/enabled'
         _query_url = APIHelper.clean_url _query_builder
   
-        # Prepare headers.
-        @logger.info("Preparing headers for delete_disable_the_current_enabled_signature_key.")
-        _headers = {
-          'Content-Type' => content_type,
-          'Accept' => accept
-        }
-  
         # Prepare and execute HttpRequest.
         @logger.info('Preparing and executing HttpRequest for delete_disable_the_current_enabled_signature_key.')
         _request = @http_client.delete(
-          _query_url,
-          headers: _headers
+          _query_url
         )
         BasicAuth.apply(_request)
         _context = execute_request(_request, name: 'delete_disable_the_current_enabled_signature_key')
@@ -57,56 +46,59 @@ module MessageMediaSigningKeys
       end
     end
 
-    # Delete a signature key using the key_id returned in the ```create
-    # signature key``` endpoint.
-    # A successful request for the ```delete signature key``` endpoint will
-    # return an empty response body.
-    # *Note: If an invalid or non-existent key_id parameter is specified in the
-    # request, then an HTTP 404 Not Found response will be returned*
-    # @param [String] key_id Required parameter: Example:
-    # @param [String] content_type Required parameter: Example:
-    # @param [String] accept Required parameter: Example:
-    # @return void response from the API call
-    def delete_signature_key(key_id,
-                             content_type,
-                             accept)
+    # Retrieve the currently enabled signature key.
+    # A successful request for the ```get enabled signature key``` endpoint will
+    # return a response body as follows:
+    # ```json
+    # {
+    #     "key_id": "7ca628a8-08b0-4e42-aeb8-960b37049c31",
+    #     "cipher": "RSA",
+    #     "digest": "SHA224",
+    #     "created": "2018-01-18T10:16:12.364Z",
+    #     "enabled": true
+    # }
+    # ```
+    # *Note: If there is no enabled signature key, then an HTTP 404 Not Found
+    # response will be returned*
+    # @return GetEnabledSignatureKeyResponse response from the API call
+    def get_enabled_signature_key
       begin
-        @logger.info("delete_signature_key called.")
+        @logger.info("get_enabled_signature_key called.")
         # Prepare query url.
-        @logger.info("Preparing query URL for delete_signature_key.")
+        @logger.info("Preparing query URL for get_enabled_signature_key.")
         _query_builder = Configuration.base_uri.dup
-        _query_builder << '/v1/iam/signature_keys/{key_id}'
-        _query_builder = APIHelper.append_url_with_template_parameters(
-          _query_builder,
-          'key_id' => key_id
-        )
+        _query_builder << '/v1/iam/signature_keys/enabled'
         _query_url = APIHelper.clean_url _query_builder
   
         # Prepare headers.
-        @logger.info("Preparing headers for delete_signature_key.")
+        @logger.info("Preparing headers for get_enabled_signature_key.")
         _headers = {
-          'Content-Type' => content_type,
-          'Accept' => accept
+          'accept' => 'application/json'
         }
   
         # Prepare and execute HttpRequest.
-        @logger.info('Preparing and executing HttpRequest for delete_signature_key.')
-        _request = @http_client.delete(
+        @logger.info('Preparing and executing HttpRequest for get_enabled_signature_key.')
+        _request = @http_client.get(
           _query_url,
           headers: _headers
         )
         BasicAuth.apply(_request)
-        _context = execute_request(_request, name: 'delete_signature_key')
+        _context = execute_request(_request, name: 'get_enabled_signature_key')
   
         # Validate response against endpoint and global error codes.
-        @logger.info("Validating response for delete_signature_key.")
+        @logger.info("Validating response for get_enabled_signature_key.")
         if _context.response.status_code == 404
-          raise DeleteSignatureKey403ResponseException.new(
+          raise GetEnabledSignatureKey403ResponseException.new(
             'Unexpected error in API call. See HTTP response body for details.',
             _context
           )
         end
         validate_response(_context)
+  
+        # Return appropriate response type.
+        @logger.info("Returning response for get_enabled_signature_key.")
+        decoded = APIHelper.json_deserialize(_context.response.raw_body)
+        GetEnabledSignatureKeyResponse.from_hash(decoded)
 
       rescue Exception => e
         @logger.error(e)
@@ -114,65 +106,67 @@ module MessageMediaSigningKeys
       end
     end
 
-    # Retrieve the current detail of a signature key using the key_id returned
-    # in the ```create signature key``` endpoint.
-    # A successful request for the ```get signature key detail``` endpoint will
-    # return a response body as follows:
+    # Enable a signature key using the key_id returned in the ```create
+    # signature key``` endpoint.
+    # There is only one signature key is enabled at the one moment in time. So
+    # if you enable the new signature key, the old one will be disabled.
+    # The most basic body has the following structure:
+    # ```json
+    # {
+    #     "key_id": "7ca628a8-08b0-4e42-aeb8-960b37049c31"
+    # }
+    # ```
+    # The response body of a successful PATCH request to ```enable signature
+    # key``` endpoint will contain the ```enabled``` properties with the value
+    # is true as follows:
     # ```json
     # {
     #     "key_id": "7ca628a8-08b0-4e42-aeb8-960b37049c31",
     #     "cipher": "RSA",
     #     "digest": "SHA224",
     #     "created": "2018-01-18T10:16:12.364Z",
-    #     "enabled": false
+    #     "enabled": true
     # }
     # ```
     # *Note: If an invalid or non-existent key_id parameter is specified in the
     # request, then an HTTP 404 Not Found response will be returned*
-    # @param [String] key_id Required parameter: Example:
-    # @param [String] content_type Required parameter: Example:
-    # @param [String] accept Required parameter: Example:
-    # @return GETSignatureKeyDetailResponse response from the API call
-    def get_signature_key_detail(key_id,
-                                 content_type,
-                                 accept)
+    # @param [EnableSignatureKeyRequest] body Required parameter: Example:
+    # @return EnableSignatureKeyResponse response from the API call
+    def update_enable_signature_key(body)
       begin
-        @logger.info("get_signature_key_detail called.")
+        @logger.info("update_enable_signature_key called.")
         # Prepare query url.
-        @logger.info("Preparing query URL for get_signature_key_detail.")
+        @logger.info("Preparing query URL for update_enable_signature_key.")
         _query_builder = Configuration.base_uri.dup
-        _query_builder << '/v1/iam/signature_keys/{key_id}'
-        _query_builder = APIHelper.append_url_with_template_parameters(
-          _query_builder,
-          'key_id' => key_id
-        )
+        _query_builder << '/v1/iam/signature_keys/enabled'
         _query_url = APIHelper.clean_url _query_builder
   
         # Prepare headers.
-        @logger.info("Preparing headers for get_signature_key_detail.")
+        @logger.info("Preparing headers for update_enable_signature_key.")
         _headers = {
-          'Content-Type' => content_type,
-          'Accept' => accept
+          'accept' => 'application/json',
+          'content-type' => 'application/json; charset=utf-8'
         }
   
         # Prepare and execute HttpRequest.
-        @logger.info('Preparing and executing HttpRequest for get_signature_key_detail.')
-        _request = @http_client.get(
+        @logger.info('Preparing and executing HttpRequest for update_enable_signature_key.')
+        _request = @http_client.patch(
           _query_url,
-          headers: _headers
+          headers: _headers,
+          parameters: body.to_json
         )
         BasicAuth.apply(_request)
-        _context = execute_request(_request, name: 'get_signature_key_detail')
+        _context = execute_request(_request, name: 'update_enable_signature_key')
   
         # Validate response against endpoint and global error codes.
-        @logger.info("Validating response for get_signature_key_detail.")
+        @logger.info("Validating response for update_enable_signature_key.")
         if _context.response.status_code == 400
-          raise GETSignatureKeyDetail400ResponseException.new(
+          raise EnableSignatureKey400ResponseException.new(
             'Unexpected error in API call. See HTTP response body for details.',
             _context
           )
         elsif _context.response.status_code == 404
-          raise GETSignatureKeyDetail403ResponseException.new(
+          raise EnableSignatureKey403ResponseException.new(
             'Unexpected error in API call. See HTTP response body for details.',
             _context
           )
@@ -180,9 +174,9 @@ module MessageMediaSigningKeys
         validate_response(_context)
   
         # Return appropriate response type.
-        @logger.info("Returning response for get_signature_key_detail.")
+        @logger.info("Returning response for update_enable_signature_key.")
         decoded = APIHelper.json_deserialize(_context.response.raw_body)
-        GETSignatureKeyDetailResponse.from_hash(decoded)
+        EnableSignatureKeyResponse.from_hash(decoded)
 
       rescue Exception => e
         @logger.error(e)
@@ -190,84 +184,49 @@ module MessageMediaSigningKeys
       end
     end
 
-    # This will create a key pair:
-    # - The ```private key``` stored in MessageMedia is used to create the
-    # signature.
-    # - The ```public key``` is returned and stored at your side to verify the
-    # signature in callbacks.
-    # You need to enable your signature key after creating.
-    # The most basic body has the following structure:
-    # ```json
-    # {
-    #     "digest": "SHA224",
-    #     "cipher": "RSA"
-    # }
-    # ```
-    # - ```digest``` is used to hash the message. The valid values for digest
-    # type are: SHA224, SHA256, SHA512
-    # - ```cipher``` is used to encrypt the hashed message. The valid value for
-    # cipher type is: RSA
-    # A successful request for the ```create signature key``` endpoint will
+    # Retrieve the paginated list of signature keys.
+    # A successful request for the ```get signature key list``` endpoint will
     # return a response body as follows:
     # ```json
-    # {
+    # [
+    #   {
     #     "key_id": "7ca628a8-08b0-4e42-aeb8-960b37049c31",
-    #     "public_key":
-    # "MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCTIxtRyT5CuOD74r7UCT+AKzWNxvaAP9myj
-    # AqR7+vBnJKEvoPnmbKTnm6uLlxutnMbjKrnCCWnQ9vtBVnnd+ElhwLDPADfMcJoOqwi7mTcxuc
-    # ckeEbBsfsgYRfdacxgSZL8hVD1hLViQr3xwjEIkJcx1w3x8npvwMuTY0uW8+PjwIDAQAB",
     #     "cipher": "RSA",
     #     "digest": "SHA224",
     #     "created": "2018-01-18T10:16:12.364Z",
     #     "enabled": false
-    # }
+    #   }
+    # ]
     # ```
-    # The response body of a successful POST request to the ```create signature
-    # key``` endpoint will contain six properties:
-    # - ```key_id``` will be a 36 character UUID which can be used to enable,
-    # delete or get the details.
-    # - ```public_key``` is used to decrypt the signature.
-    # - ```cipher``` same as cipher in request body.
-    # - ```digest``` same as digest in request body.
-    # - ```created``` is the created date.
-    # - ```enabled``` is false for the new signature key. You can use the
-    # ```enable signature key``` endpoint to set this field to true.
-    # @param [String] content_type Required parameter: Example:
-    # @param [String] accept Required parameter: Example:
-    # @param [CreateSignatureKeyRequest] body Required parameter: Example:
-    # @return CreateSignatureKeyResponse response from the API call
-    def create_signature_key(content_type,
-                             accept,
-                             body)
+    # @return List of GetSignatureKeyListResponse response from the API call
+    def get_signature_key_list
       begin
-        @logger.info("create_signature_key called.")
+        @logger.info("get_signature_key_list called.")
         # Prepare query url.
-        @logger.info("Preparing query URL for create_signature_key.")
+        @logger.info("Preparing query URL for get_signature_key_list.")
         _query_builder = Configuration.base_uri.dup
         _query_builder << '/v1/iam/signature_keys'
         _query_url = APIHelper.clean_url _query_builder
   
         # Prepare headers.
-        @logger.info("Preparing headers for create_signature_key.")
+        @logger.info("Preparing headers for get_signature_key_list.")
         _headers = {
-          'Content-Type' => content_type,
-          'Accept' => accept
+          'accept' => 'application/json'
         }
   
         # Prepare and execute HttpRequest.
-        @logger.info('Preparing and executing HttpRequest for create_signature_key.')
-        _request = @http_client.post(
+        @logger.info('Preparing and executing HttpRequest for get_signature_key_list.')
+        _request = @http_client.get(
           _query_url,
-          headers: _headers,
-          parameters: body.to_json
+          headers: _headers
         )
         BasicAuth.apply(_request)
-        _context = execute_request(_request, name: 'create_signature_key')
+        _context = execute_request(_request, name: 'get_signature_key_list')
   
         # Validate response against endpoint and global error codes.
-        @logger.info("Validating response for create_signature_key.")
+        @logger.info("Validating response for get_signature_key_list.")
         if _context.response.status_code == 400
-          raise CreateSignatureKey400ResponseException.new(
+          raise GetSignatureKeyList400ResponseException.new(
             'Unexpected error in API call. See HTTP response body for details.',
             _context
           )
@@ -275,9 +234,9 @@ module MessageMediaSigningKeys
         validate_response(_context)
   
         # Return appropriate response type.
-        @logger.info("Returning response for create_signature_key.")
+        @logger.info("Returning response for get_signature_key_list.")
         decoded = APIHelper.json_deserialize(_context.response.raw_body)
-        CreateSignatureKeyResponse.from_hash(decoded)
+        decoded.map { |element| GetSignatureKeyListResponse.from_hash(element) }
 
       rescue Exception => e
         @logger.error(e)
@@ -285,63 +244,44 @@ module MessageMediaSigningKeys
       end
     end
 
-    # Retrieve the currently enabled signature key.
-    # A successful request for the ```get enabled signature key``` endpoint will
-    # return a response body as follows:
-    # ```json
-    # {
-    #     "key_id": "7ca628a8-08b0-4e42-aeb8-960b37049c31",
-    #     "cipher": "RSA",
-    #     "digest": "SHA224",
-    #     "created": "2018-01-18T10:16:12.364Z",
-    #     "enabled": true
-    # }
-    # ```
-    # *Note: If there is no enabled signature key, then an HTTP 404 Not Found
-    # response will be returned*
-    # @param [String] content_type Required parameter: Example:
-    # @param [String] accept Required parameter: Example:
-    # @return GetEnabledSignatureKeyResponse response from the API call
-    def get_enabled_signature_key(content_type,
-                                  accept)
+    # Delete a signature key using the key_id returned in the ```create
+    # signature key``` endpoint.
+    # A successful request for the ```delete signature key``` endpoint will
+    # return an empty response body.
+    # *Note: If an invalid or non-existent key_id parameter is specified in the
+    # request, then an HTTP 404 Not Found response will be returned*
+    # @param [String] key_id Required parameter: Example:
+    # @return void response from the API call
+    def delete_signature_key(key_id)
       begin
-        @logger.info("get_enabled_signature_key called.")
+        @logger.info("delete_signature_key called.")
         # Prepare query url.
-        @logger.info("Preparing query URL for get_enabled_signature_key.")
+        @logger.info("Preparing query URL for delete_signature_key.")
         _query_builder = Configuration.base_uri.dup
-        _query_builder << '/v1/iam/signature_keys/enabled'
+        _query_builder << '/v1/iam/signature_keys/{key_id}'
+        _query_builder = APIHelper.append_url_with_template_parameters(
+          _query_builder,
+          'key_id' => key_id
+        )
         _query_url = APIHelper.clean_url _query_builder
   
-        # Prepare headers.
-        @logger.info("Preparing headers for get_enabled_signature_key.")
-        _headers = {
-          'Content-Type' => content_type,
-          'Accept' => accept
-        }
-  
         # Prepare and execute HttpRequest.
-        @logger.info('Preparing and executing HttpRequest for get_enabled_signature_key.')
-        _request = @http_client.get(
-          _query_url,
-          headers: _headers
+        @logger.info('Preparing and executing HttpRequest for delete_signature_key.')
+        _request = @http_client.delete(
+          _query_url
         )
         BasicAuth.apply(_request)
-        _context = execute_request(_request, name: 'get_enabled_signature_key')
+        _context = execute_request(_request, name: 'delete_signature_key')
   
         # Validate response against endpoint and global error codes.
-        @logger.info("Validating response for get_enabled_signature_key.")
+        @logger.info("Validating response for delete_signature_key.")
         if _context.response.status_code == 404
-          raise GetEnabledSignatureKey403ResponseException.new(
+          raise DeleteSignatureKey403ResponseException.new(
             'Unexpected error in API call. See HTTP response body for details.',
             _context
           )
         end
         validate_response(_context)
-  
-        # Return appropriate response type.
-        @logger.info("Returning response for get_enabled_signature_key.")
-        decoded = APIHelper.json_deserialize(_context.response.raw_body)
-        GetEnabledSignatureKeyResponse.from_hash(decoded)
 
       rescue Exception => e
         @logger.error(e)
@@ -349,71 +289,60 @@ module MessageMediaSigningKeys
       end
     end
 
-    # Enable a signature key using the key_id returned in the ```create
-    # signature key``` endpoint.
-    # There is only one signature key is enabled at the one moment in time. So
-    # if you enable the new signature key, the old one will be disabled.
-    # The most basic body has the following structure:
-    # ```json
-    # {
-    #     "key_id": "7ca628a8-08b0-4e42-aeb8-960b37049c31"
-    # }
-    # ```
-    # The response body of a successful PATCH request to ```enable signature
-    # key``` endpoint will contain the ```enabled``` properties with the value
-    # is true as follows:
+    # Retrieve the current detail of a signature key using the key_id returned
+    # in the ```create signature key``` endpoint.
+    # A successful request for the ```get signature key detail``` endpoint will
+    # return a response body as follows:
     # ```json
     # {
     #     "key_id": "7ca628a8-08b0-4e42-aeb8-960b37049c31",
     #     "cipher": "RSA",
     #     "digest": "SHA224",
     #     "created": "2018-01-18T10:16:12.364Z",
-    #     "enabled": true
+    #     "enabled": false
     # }
     # ```
     # *Note: If an invalid or non-existent key_id parameter is specified in the
     # request, then an HTTP 404 Not Found response will be returned*
-    # @param [String] content_type Required parameter: Example:
-    # @param [String] accept Required parameter: Example:
-    # @param [EnableSignatureKeyRequest] body Required parameter: Example:
-    # @return EnableSignatureKeyResponse response from the API call
-    def update_enable_signature_key(content_type,
-                                    accept,
-                                    body)
+    # @param [String] key_id Required parameter: Example:
+    # @return GetSignatureKeyDetailResponse response from the API call
+    def get_signature_key_detail(key_id)
       begin
-        @logger.info("update_enable_signature_key called.")
+        @logger.info("get_signature_key_detail called.")
         # Prepare query url.
-        @logger.info("Preparing query URL for update_enable_signature_key.")
+        @logger.info("Preparing query URL for get_signature_key_detail.")
         _query_builder = Configuration.base_uri.dup
-        _query_builder << '/v1/iam/signature_keys/enabled'
+        _query_builder << '/v1/iam/signature_keys/{key_id}'
+        _query_builder = APIHelper.append_url_with_template_parameters(
+          _query_builder,
+          'key_id' => key_id
+        )
         _query_url = APIHelper.clean_url _query_builder
   
         # Prepare headers.
-        @logger.info("Preparing headers for update_enable_signature_key.")
+        @logger.info("Preparing headers for get_signature_key_detail.")
         _headers = {
-          'Content-Type' => content_type,
-          'Accept' => accept
+          'accept' => 'application/json'
         }
   
         # Prepare and execute HttpRequest.
-        @logger.info('Preparing and executing HttpRequest for update_enable_signature_key.')
-        _request = @http_client.patch(
+        @logger.info('Preparing and executing HttpRequest for get_signature_key_detail.')
+        _request = @http_client.get(
           _query_url,
-          headers: _headers,
-          parameters: body.to_json
+          headers: _headers
         )
         BasicAuth.apply(_request)
-        _context = execute_request(_request, name: 'update_enable_signature_key')
+        _context = execute_request(_request, name: 'get_signature_key_detail')
   
         # Validate response against endpoint and global error codes.
-        @logger.info("Validating response for update_enable_signature_key.")
+        @logger.info("Validating response for get_signature_key_detail.")
         if _context.response.status_code == 400
-          raise EnableSignatureKey400ResponseException.new(
+          raise GetSignatureKeyDetail400ResponseException.new(
             'Unexpected error in API call. See HTTP response body for details.',
             _context
           )
         elsif _context.response.status_code == 404
-          raise EnableSignatureKey403ResponseException.new(
+          raise GetSignatureKeyDetail403ResponseException.new(
             'Unexpected error in API call. See HTTP response body for details.',
             _context
           )
@@ -421,9 +350,9 @@ module MessageMediaSigningKeys
         validate_response(_context)
   
         # Return appropriate response type.
-        @logger.info("Returning response for update_enable_signature_key.")
+        @logger.info("Returning response for get_signature_key_detail.")
         decoded = APIHelper.json_deserialize(_context.response.raw_body)
-        EnableSignatureKeyResponse.from_hash(decoded)
+        GetSignatureKeyDetailResponse.from_hash(decoded)
 
       rescue Exception => e
         @logger.error(e)
@@ -431,62 +360,80 @@ module MessageMediaSigningKeys
       end
     end
 
-    # Retrieve the paginated list of signature keys.
-    # A successful request for the ```get signature key list``` endpoint will
+    # This will create a key pair:
+    # - The ```private key``` stored in MessageMedia is used to create the
+    # signature.
+    # - The ```public key``` is returned and stored at your side to verify the
+    # signature in callbacks.
+    # You need to enable your signature key after creating.
+    # The most basic body has the following structure:
+    # ```json
+    # {
+    #     "digest": "SHA224",
+    #     "cipher": "RSA"
+    # }
+    # ```
+    # - ```digest``` is used to hash the message. The valid values for digest
+    # type are: SHA224, SHA256, SHA512
+    # - ```cipher``` is used to encrypt the hashed message. The valid value for
+    # cipher type is: RSA
+    # A successful request for the ```create signature key``` endpoint will
     # return a response body as follows:
     # ```json
-    # [
-    #   {
+    # {
     #     "key_id": "7ca628a8-08b0-4e42-aeb8-960b37049c31",
+    #     "public_key":
+    # "MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCTIxtRyT5CuOD74r7UCT+AKzWNxvaAP9myj
+    # AqR7+vBnJKEvoPnmbKTnm6uLlxutnMbjKrnCCWnQ9vtBVnnd+ElhwLDPADfMcJoOqwi7mTcxuc
+    # ckeEbBsfsgYRfdacxgSZL8hVD1hLViQr3xwjEIkJcx1w3x8npvwMuTY0uW8+PjwIDAQAB",
     #     "cipher": "RSA",
     #     "digest": "SHA224",
     #     "created": "2018-01-18T10:16:12.364Z",
     #     "enabled": false
-    #   }
-    # ]
+    # }
     # ```
-    # @param [String] content_type Required parameter: Example:
-    # @param [String] accept Required parameter: Example:
-    # @param [String] page Optional parameter: Example:
-    # @param [String] page_size Optional parameter: Example:
-    # @return List of GETSignatureKeyListResponse response from the API call
-    def get_signature_key_list(content_type,
-                               accept,
-                               page = nil,
-                               page_size = nil)
+    # The response body of a successful POST request to the ```create signature
+    # key``` endpoint will contain six properties:
+    # - ```key_id``` will be a 36 character UUID which can be used to enable,
+    # delete or get the details.
+    # - ```public_key``` is used to decrypt the signature.
+    # - ```cipher``` same as cipher in request body.
+    # - ```digest``` same as digest in request body.
+    # - ```created``` is the created date.
+    # - ```enabled``` is false for the new signature key. You can use the
+    # ```enable signature key``` endpoint to set this field to true.
+    # @param [CreateSignatureKeyRequest] body Required parameter: Example:
+    # @return CreateSignatureKeyResponse response from the API call
+    def create_signature_key(body)
       begin
-        @logger.info("get_signature_key_list called.")
+        @logger.info("create_signature_key called.")
         # Prepare query url.
-        @logger.info("Preparing query URL for get_signature_key_list.")
+        @logger.info("Preparing query URL for create_signature_key.")
         _query_builder = Configuration.base_uri.dup
-        _query_builder << '/v1/iam/signature_keys?page={page}&page_size={page_size}'
-        _query_builder = APIHelper.append_url_with_template_parameters(
-          _query_builder,
-          'page' => page,
-          'page_size' => page_size
-        )
+        _query_builder << '/v1/iam/signature_keys'
         _query_url = APIHelper.clean_url _query_builder
   
         # Prepare headers.
-        @logger.info("Preparing headers for get_signature_key_list.")
+        @logger.info("Preparing headers for create_signature_key.")
         _headers = {
-          'Content-Type' => content_type,
-          'Accept' => accept
+          'accept' => 'application/json',
+          'content-type' => 'application/json; charset=utf-8'
         }
   
         # Prepare and execute HttpRequest.
-        @logger.info('Preparing and executing HttpRequest for get_signature_key_list.')
-        _request = @http_client.get(
+        @logger.info('Preparing and executing HttpRequest for create_signature_key.')
+        _request = @http_client.post(
           _query_url,
-          headers: _headers
+          headers: _headers,
+          parameters: body.to_json
         )
         BasicAuth.apply(_request)
-        _context = execute_request(_request, name: 'get_signature_key_list')
+        _context = execute_request(_request, name: 'create_signature_key')
   
         # Validate response against endpoint and global error codes.
-        @logger.info("Validating response for get_signature_key_list.")
+        @logger.info("Validating response for create_signature_key.")
         if _context.response.status_code == 400
-          raise GETSignatureKeyList400ResponseException.new(
+          raise CreateSignatureKey400ResponseException.new(
             'Unexpected error in API call. See HTTP response body for details.',
             _context
           )
@@ -494,9 +441,9 @@ module MessageMediaSigningKeys
         validate_response(_context)
   
         # Return appropriate response type.
-        @logger.info("Returning response for get_signature_key_list.")
+        @logger.info("Returning response for create_signature_key.")
         decoded = APIHelper.json_deserialize(_context.response.raw_body)
-        decoded.map { |element| GETSignatureKeyListResponse.from_hash(element) }
+        CreateSignatureKeyResponse.from_hash(decoded)
 
       rescue Exception => e
         @logger.error(e)

data/lib/message_media_signing_keys/exceptions/get_signature_key_detail400_response_exception.rb

@@ -2,8 +2,8 @@
 # ( https://apimatic.io ).
 
 module MessageMediaSigningKeys
-  # GET signature key detail 400 response class.
-  class GETSignatureKeyDetail400ResponseException < APIException
+  # Get signature key detail 400 response class.
+  class GetSignatureKeyDetail400ResponseException < APIException
     # TODO: Write general description for this method
     # @return [String]
     attr_accessor :message

data/lib/message_media_signing_keys/exceptions/get_signature_key_detail403_response_exception.rb

@@ -2,8 +2,8 @@
 # ( https://apimatic.io ).
 
 module MessageMediaSigningKeys
-  # GET signature key detail 403 response class.
-  class GETSignatureKeyDetail403ResponseException < APIException
+  # Get signature key detail 403 response class.
+  class GetSignatureKeyDetail403ResponseException < APIException
     # TODO: Write general description for this method
     # @return [String]
     attr_accessor :message

data/lib/message_media_signing_keys/exceptions/get_signature_key_list400_response_exception.rb

@@ -2,8 +2,8 @@
 # ( https://apimatic.io ).
 
 module MessageMediaSigningKeys
-  # GET signature key list 400 response class.
-  class GETSignatureKeyList400ResponseException < APIException
+  # Get signature key list 400 response class.
+  class GetSignatureKeyList400ResponseException < APIException
     # TODO: Write general description for this method
     # @return [String]
     attr_accessor :message

data/lib/message_media_signing_keys/exceptions/get_signature_key_list403_response_exception.rb

@@ -2,8 +2,8 @@
 # ( https://apimatic.io ).
 
 module MessageMediaSigningKeys
-  # GET signature key list 403 response class.
-  class GETSignatureKeyList403ResponseException < APIException
+  # Get signature key list 403 response class.
+  class GetSignatureKeyList403ResponseException < APIException
     # TODO: Write general description for this method
     # @return [String]
     attr_accessor :message

data/lib/message_media_signing_keys/models/get_signature_key_detail_response.rb

@@ -2,8 +2,8 @@
 # ( https://apimatic.io ).
 
 module MessageMediaSigningKeys
-  # GETSignatureKeyDetailResponse Model.
-  class GETSignatureKeyDetailResponse < BaseModel
+  # GetSignatureKeyDetailResponse Model.
+  class GetSignatureKeyDetailResponse < BaseModel
     # TODO: Write general description for this method
     # @return [String]
     attr_accessor :key_id
@@ -59,7 +59,7 @@ module MessageMediaSigningKeys
       enabled = hash['enabled']
 
       # Create object from extracted values.
-      GETSignatureKeyDetailResponse.new(key_id,
+      GetSignatureKeyDetailResponse.new(key_id,
                                         cipher,
                                         digest,
                                         created,

data/lib/message_media_signing_keys/models/get_signature_key_list_response.rb

@@ -2,8 +2,8 @@
 # ( https://apimatic.io ).
 
 module MessageMediaSigningKeys
-  # GETSignatureKeyListResponse Model.
-  class GETSignatureKeyListResponse < BaseModel
+  # GetSignatureKeyListResponse Model.
+  class GetSignatureKeyListResponse < BaseModel
     # TODO: Write general description for this method
     # @return [String]
     attr_accessor :key_id
@@ -59,7 +59,7 @@ module MessageMediaSigningKeys
       enabled = hash['enabled']
 
       # Create object from extracted values.
-      GETSignatureKeyListResponse.new(key_id,
+      GetSignatureKeyListResponse.new(key_id,
                                       cipher,
                                       digest,
                                       created,

data/test/controllers/controller_test_base.rb

@@ -0,0 +1,31 @@
+# This file was automatically generated for MessageMedia by APIMATIC v2.0 ( https://apimatic.io ).
+
+require 'json'
+require 'test/unit'
+require 'message_media_signing_keys.rb'
+require_relative '../test_helper.rb'
+require_relative '../http_response_catcher.rb'
+
+class ControllerTestBase < Test::Unit::TestCase
+  include MessageMediaSigningKeys
+
+  class << self
+    attr_accessor :controller
+  end
+
+  # Called only once for a test class before any test has executed.
+  def self.startup
+    @@api_client = MessageMediaSigningKeysClient.new
+    @@request_timeout = 30
+    @@assert_precision = 0.01
+
+    Configuration.basic_auth_user_name = ENV['MessageMediaApiTestsKey']
+    Configuration.basic_auth_password = ENV['MessageMediaApiTestsSecret']
+  end
+
+  # Called once before every test case.
+  def setup
+    @response_catcher = HttpResponseCatcher.new
+    self.class.controller.http_call_back = @response_catcher
+  end
+end

data/test/controllers/test_signature_key_management_controller.rb

@@ -0,0 +1,35 @@
+# This file was automatically generated for MessageMedia by APIMATIC v2.0 ( https://apimatic.io ).
+
+require_relative 'controller_test_base'
+
+class SignatureKeyManagementControllerTests < ControllerTestBase
+  # Called only once for the class before any test has executed
+  def self.startup
+    self.controller = @@api_client.signature_key_management
+  end
+
+  # Todo: Add description for test test_create_signature_key_test
+  def test_create_signature_key_test()
+    # Parameters for the API call
+    body = CreateSignatureKeyRequest.from_hash(JSON.parse('{"digest":"SHA224","cipher":"RSA"}'))
+
+    # Perform the API call through the SDK function
+    result = self.class.controller.create_signature_key(body)
+
+    # Test response code
+    assert_equal(@response_catcher.response.status_code, 201)
+
+    # Test whether the captured response is as we expected
+    assert_not_nil(result)
+    expected_body = JSON.parse(
+      '{"key_id":"7ca628a8-08b0-4e42-aeb8-960b37049c31","public_key":"MIGfMA0GCSq'\
+      'GSIb3DQEBAQUAA4GNADCBiQKBgQCTIxtRyT5CuOD74r7UCT+AKzWNxvaAP9myjAqR7+vBnJKEvo'\
+      'PnmbKTnm6uLlxutnMbjKrnCCWnQ9vtBVnnd+ElhwLDPADfMcJoOqwi7mTcxucckeEbBsfsgYRfd'\
+      'acxgSZL8hVD1hLViQr3xwjEIkJcx1w3x8npvwMuTY0uW8+PjwIDAQAB","cipher":"RSA","di'\
+      'gest":"SHA224","created":"2018-01-18T10:16:12.364Z","enabled":false}'
+      )
+    received_body = JSON.parse(@response_catcher.response.raw_body)
+    assert(TestHelper.match_body(expected_body, received_body))
+  end
+
+end

data/test/http_response_catcher.rb

@@ -0,0 +1,16 @@
+# This file was automatically generated for MessageMedia by APIMATIC v2.0 ( https://apimatic.io ).
+
+class HttpResponseCatcher < MessageMediaSigningKeys::HttpCallBack
+  attr_accessor :response
+
+  def on_before_request(request)
+  end
+
+  # Catching the response
+  def on_after_response(context)
+    @response = context.response
+  end
+end
+
+
+

data/test/test_helper.rb

@@ -0,0 +1,91 @@
+# This file was automatically generated for MessageMedia by APIMATIC v2.0 ( https://apimatic.io ).
+
+require 'tempfile'
+require 'open-uri'
+
+class TestHelper
+
+  @cache = Hash.new
+
+  # Class method to compare the received headers with the expected headers.
+  # @param [Hash] A hash of expected headers (keys in lower case).
+  # @param [Hash] A hash of received headers.
+  # @param [Boolean, optional] A flag which determines if we allow extra headers.
+  def self.match_headers(expected_headers,
+                         received_headers,
+                         allow_extra: true)
+    return false if ((received_headers.length < expected_headers.length) ||
+                    ((allow_extra == false) && (received_headers.length > expected_headers.length)))
+
+    received_headers = Hash[received_headers.map{|k, v| [k.to_s.downcase, v]}]
+    expected_headers.each do |e_key, e_value|
+      return false unless received_headers.key?(e_key)
+      return false if ((e_value != nil) &&
+                       (e_value != received_headers[e_key]))
+    end
+
+    return true
+  end
+
+  # Class method to compare the received body with the expected body.
+  # @param [Dynamic] The expected body.
+  # @param [Dynamic] The received body.
+  # @param [Boolean, optional] A flag which determines if we check values in dictionaries.
+  # @param [Boolean, optional] A flag which determines if we check the order of array elements.
+  # @param [Boolean, optional] A flag which determines if we check the count of array elements.
+  def self.match_body(expected_body,
+                      received_body,
+                      check_values: false,
+                      check_order: false,
+                      check_count: false)
+    if expected_body.instance_of? Hash
+      return false unless received_body.instance_of? Hash
+      for key in expected_body.keys           
+        return false unless received_body.keys.include? key
+        if check_values or expected_body[key].instance_of? Hash
+          return false unless TestHelper.match_body(expected_body[key], 
+                                                    received_body[key], 
+                                                    check_values: check_values, 
+                                                    check_order: check_order, 
+                                                    check_count: check_count)
+        end
+      end
+    elsif expected_body.instance_of? Array
+      return False unless received_body.instance_of? Array
+      if check_count == true && (expected_body.length != received_body.length)
+        return false
+      else
+        previous_matches = Array.new
+        expected_body.each.with_index do |expected_element, i|
+          matches = (received_body.map.with_index do |received_element, j|
+                      j if TestHelper.match_body(expected_element, 
+                                                 received_element, 
+                                                 check_values: check_values, 
+                                                 check_order: check_order, 
+                                                 check_count: check_count)
+                    end).compact
+          return false if matches.length == 0
+          if check_order == true
+            return false if (i != 0 && matches.map{|x| previous_matches.map{|y| y > x}.all?}.all?)
+            previous_matches = matches
+          end
+        end
+      end
+    elsif expected_body != received_body
+      return false
+    end
+    return true
+  end  
+  
+  # Class method which takes a URL, downloads the file (if not already downloaded 
+  # for this test session) and returns the path of the file.
+  # @param [String] The URL of the required file.
+  def self.get_file(url)
+    unless @cache.keys.include? url  
+      @cache[url] = Tempfile.new('APIMatic')
+      @cache[url].binmode
+      @cache[url].write(open(url, {ssl_ca_cert: Certifi.where}).read)
+    end
+    return @cache[url].path
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: messagemedia_signingkeys_sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - MessageMedia Developers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-27 00:00:00.000000000 Z
+date: 2018-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logging
@@ -92,9 +92,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.2.2
-description: The MessageMedia Signature Key API provides a number of endpoints for
-  managing key used to sign each unique request to ensure security and the requests
-  can't (easily) be spoofed. This is similar to using HMAC in your outbound messaging
+description: The MessageMedia Signature Key API provides a number of endpoints  for
+  managing key used to sign each unique request to ensure security  and the requests
+  can't (easily) be spoofed. This is similar to using  HMAC in your outbound messaging
   (rather than HTTP Basic).
 email: developers@messagemedia.com
 executables: []
@@ -137,6 +137,10 @@ files:
 - lib/message_media_signing_keys/models/get_enabled_signature_key_response.rb
 - lib/message_media_signing_keys/models/get_signature_key_detail_response.rb
 - lib/message_media_signing_keys/models/get_signature_key_list_response.rb
+- test/controllers/controller_test_base.rb
+- test/controllers/test_signature_key_management_controller.rb
+- test/http_response_catcher.rb
+- test/test_helper.rb
 homepage: https://developers.messagemedia.com
 licenses:
 - Apache-2.0
@@ -160,5 +164,5 @@ rubyforge_project:
 rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
-summary: MessageMedia Signature Key Management SDK
+summary: MessageMedia Signature Key Management API
 test_files: []