messagemedia_messages_sdk 1.0.0 → 1.1.0

data/lib/message_media_messages.rb

@@ -18,6 +18,7 @@ require_relative 'message_media_messages/http/http_response.rb'
 require_relative 'message_media_messages/http/http_context.rb'
 require_relative 'message_media_messages/http/faraday_client.rb'
 require_relative 'message_media_messages/http/auth/basic_auth.rb'
+require_relative 'message_media_messages/http/auth/hmac_auth.rb'
 
 # Models
 require_relative 'message_media_messages/models/base_model.rb'
@@ -45,6 +46,5 @@ require_relative 'message_media_messages/configuration.rb'
 # Controllers
 require_relative 'message_media_messages/controllers/base_controller.rb'
 require_relative 'message_media_messages/controllers/messages_controller.rb'
-require_relative 'message_media_messages/controllers' \
-                 '/delivery_reports_controller.rb'
+require_relative 'message_media_messages/controllers/delivery_reports_controller.rb'
 require_relative 'message_media_messages/controllers/replies_controller.rb'

data/lib/message_media_messages/api_helper.rb

@@ -3,6 +3,7 @@
 
 module MessageMediaMessages
   # API utility class
+  # noinspection RubyClassMethodNamingConvention
   class APIHelper
     # Serializes an array parameter (creates key value pairs).
     # @param [String] The name of the parameter.
@@ -41,8 +42,6 @@ module MessageMediaMessages
 
       # Iterate and append parameters.
       parameters.each do |key, value|
-        replace_value = ''
-
         if value.nil?
           replace_value = ''
         elsif value.instance_of? Array

data/lib/message_media_messages/configuration.rb

@@ -10,7 +10,7 @@ module MessageMediaMessages
   # are configured in this class.
   class Configuration
     # The base Uri for API calls
-    @base_uri = 'https://api.messagemedia.com'
+    @base_uri = 'http://api.messagemedia.com'
 
     # The username to use with basic authentication
     @basic_auth_user_name = 'TODO: Replace'
@@ -18,12 +18,20 @@ module MessageMediaMessages
     # The password to use with basic authentication
     @basic_auth_password = 'TODO: Replace'
 
+    # The username to use with HMAC authentication
+    @hmac_auth_user_name = nil
+
+    # The password to use with HMAC authentication
+    @hmac_auth_password = nil
+
     # The attribute accessors for public properties.
     class << self
       attr_accessor :array_serialization
       attr_accessor :base_uri
       attr_accessor :basic_auth_user_name
       attr_accessor :basic_auth_password
+      attr_accessor :hmac_auth_user_name
+      attr_accessor :hmac_auth_password
     end
   end
 end

data/lib/message_media_messages/controllers/base_controller.rb

@@ -1,6 +1,8 @@
 # This file was automatically generated for MessageMedia by APIMATIC v2.0
 # ( https://apimatic.io ).
 
+require 'message_media_messages/configuration.rb'
+
 module MessageMediaMessages
   # Base controller.
   class BaseController
@@ -13,6 +15,7 @@ module MessageMediaMessages
       @global_headers = {
         'user-agent' => 'messagemedia-messages-ruby-sdk-1.0.0'
       }
+
       @logger = Logging.logger[self]
       @logger.info("Instantiated controller class.")
     end
@@ -25,6 +28,14 @@ module MessageMediaMessages
       end
     end
 
+    def apply_authentication(request, url, body=nil)
+      if Configuration.hmac_auth_user_name == nil or Configuration.hmac_auth_password == nil
+        BasicAuth.apply(request)
+      else
+        HmacAuth.apply(request, url, body)
+      end
+    end
+
     def execute_request(request, binary: false, name: nil)
       @logger.info("Calling the on_before_request method of http_call_back for #{name}.") if @http_call_back
       @http_call_back.on_before_request(request) if @http_call_back
@@ -49,8 +60,14 @@ module MessageMediaMessages
       context
     end
 
+    def add_account_header(headers, account_header_value)
+      if headers != nil && account_header_value != nil
+        headers["account"] = account_header_value
+      end
+    end
+
     def validate_response(context)
-      raise APIException.new 'HTTP Response Not OK', context unless
+      raise APIException.new 'HTTP Response Not OK. ' + context.response.raw_body, context unless
         context.response.status_code.between?(200, 208) # [200,208] = HTTP OK
     end
   end

data/lib/message_media_messages/controllers/delivery_reports_controller.rb

@@ -3,6 +3,7 @@
 
 module MessageMediaMessages
   # DeliveryReportsController
+  # noinspection RubyResolve,RubyInstanceMethodNamingConvention,RubyStringKeysInHashInspection
   class DeliveryReportsController < BaseController
     @instance = DeliveryReportsController.new
 
@@ -94,35 +95,42 @@ module MessageMediaMessages
     # *Note: It is recommended to use the Webhooks feature to receive reply
     # messages rather than
     # polling the check delivery reports endpoint.*
+    # @param [Object] account_header_value The account id to pass to the API
     # @return CheckDeliveryReportsResponse response from the API call
-    def get_check_delivery_reports
+    def get_check_delivery_reports(account_header_value=nil)
       begin
         @logger.info("get_check_delivery_reports called.")
+
+        request_url = '/v1/delivery_reports'
         # Prepare query url.
         @logger.info("Preparing query URL for get_check_delivery_reports.")
-        _query_builder = Configuration.base_uri.dup
-        _query_builder << '/v1/delivery_reports'
-        _query_url = APIHelper.clean_url _query_builder
+        query_builder = Configuration.base_uri.dup
+        query_builder << request_url
+        query_url = APIHelper.clean_url query_builder
   
         # Prepare headers.
         @logger.info("Preparing headers for get_check_delivery_reports.")
-        _headers = {
+        headers = {
           'accept' => 'application/json'
         }
-  
+
+        add_account_header(headers, account_header_value)
+
         # Prepare and execute HttpRequest.
         @logger.info('Preparing and executing HttpRequest for get_check_delivery_reports.')
-        _request = @http_client.get(
-          _query_url,
-          headers: _headers
+        request = @http_client.get(
+          query_url,
+          headers: headers
         )
-        BasicAuth.apply(_request)
-        _context = execute_request(_request, name: 'get_check_delivery_reports')
-        validate_response(_context)
+
+        apply_authentication(request, request_url)
+
+        context = execute_request(request, name: 'get_check_delivery_reports')
+        validate_response(context)
   
         # Return appropriate response type.
         @logger.info("Returning response for get_check_delivery_reports.")
-        decoded = APIHelper.json_deserialize(_context.response.raw_body)
+        decoded = APIHelper.json_deserialize(context.response.raw_body)
         CheckDeliveryReportsResponse.from_hash(decoded)
 
       rescue Exception => e
@@ -155,49 +163,59 @@ module MessageMediaMessages
     # reports request.
     # @param [ConfirmDeliveryReportsAsReceivedRequest] body Required parameter:
     # Example:
+    # @param [Object] account_header_value The account id to pass to the API
     # @return Mixed response from the API call
-    def create_confirm_delivery_reports_as_received(body)
+    def create_confirm_delivery_reports_as_received(body, account_header_value=nil)
       begin
         @logger.info("create_confirm_delivery_reports_as_received called.")
+
+        request_url = '/v1/delivery_reports/confirmed'
+
         # Prepare query url.
         @logger.info("Preparing query URL for create_confirm_delivery_reports_as_received.")
-        _query_builder = Configuration.base_uri.dup
-        _query_builder << '/v1/delivery_reports/confirmed'
-        _query_url = APIHelper.clean_url _query_builder
+        query_builder = Configuration.base_uri.dup
+        query_builder << request_url
+        query_url = APIHelper.clean_url query_builder
   
         # Prepare headers.
         @logger.info("Preparing headers for create_confirm_delivery_reports_as_received.")
-        _headers = {
+        headers = {
           'accept' => 'application/json',
           'content-type' => 'application/json; charset=utf-8'
         }
-  
+
+        add_account_header(headers, account_header_value)
+
+        json_body = body.to_json
+
         # Prepare and execute HttpRequest.
         @logger.info('Preparing and executing HttpRequest for create_confirm_delivery_reports_as_received.')
-        _request = @http_client.post(
-          _query_url,
-          headers: _headers,
-          parameters: body.to_json
+        request = @http_client.post(
+          query_url,
+          headers: headers,
+          parameters: json_body
         )
-        BasicAuth.apply(_request)
-        _context = execute_request(_request, name: 'create_confirm_delivery_reports_as_received')
+
+        apply_authentication(request, request_url, json_body)
+
+        context = execute_request(request, name: 'create_confirm_delivery_reports_as_received')
   
         # Validate response against endpoint and global error codes.
         @logger.info("Validating response for create_confirm_delivery_reports_as_received.")
-        if _context.response.status_code == 400
+        if context.response.status_code == 400
           raise APIException.new(
             '',
-            _context
+            context
           )
         end
-        validate_response(_context)
+
+        validate_response(context)
   
         # Return appropriate response type.
         @logger.info("Returning response for create_confirm_delivery_reports_as_received.")
-        decoded = APIHelper.json_deserialize(_context.response.raw_body) unless
-          _context.response.raw_body.nil? ||
-          _context.response.raw_body.to_s.strip.empty?
-        decoded
+        return APIHelper.json_deserialize(context.response.raw_body) unless
+          context.response.raw_body.nil? ||
+          context.response.raw_body.to_s.strip.empty?
 
       rescue Exception => e
         @logger.error(e)

data/lib/message_media_messages/controllers/messages_controller.rb

@@ -3,6 +3,7 @@
 
 module MessageMediaMessages
   # MessagesController
+  # noinspection RubyResolve,RubyInstanceMethodNamingConvention,RubyStringKeysInHashInspection
   class MessagesController < BaseController
     @instance = MessagesController.new
 
@@ -36,58 +37,67 @@ module MessageMediaMessages
     # returned*
     # @param [String] message_id Required parameter: Example:
     # @param [CancelScheduledMessageRequest] body Required parameter: Example:
+    # @param [Object] account_header_value The account id to pass to the API
     # @return Mixed response from the API call
-    def update_cancel_scheduled_message(message_id,
-                                        body)
+    def update_cancel_scheduled_message(message_id, body, account_header_value=nil)
       begin
         @logger.info("update_cancel_scheduled_message called.")
+
+        request_url = '/v1/messages/{messageId}'
+        request_url = APIHelper.append_url_with_template_parameters(
+            request_url,
+            'messageId' => message_id
+        )
+
         # Prepare query url.
         @logger.info("Preparing query URL for update_cancel_scheduled_message.")
-        _query_builder = Configuration.base_uri.dup
-        _query_builder << '/v1/messages/{messageId}'
-        _query_builder = APIHelper.append_url_with_template_parameters(
-          _query_builder,
-          'messageId' => message_id
-        )
-        _query_url = APIHelper.clean_url _query_builder
-  
+        query_builder = Configuration.base_uri.dup
+        query_builder << request_url
+        query_url = APIHelper.clean_url query_builder
+
         # Prepare headers.
         @logger.info("Preparing headers for update_cancel_scheduled_message.")
-        _headers = {
+        headers = {
           'accept' => 'application/json',
           'content-type' => 'application/json; charset=utf-8'
         }
-  
+
+        add_account_header(headers, account_header_value)
+
+        json_body = body.to_json
+
         # Prepare and execute HttpRequest.
         @logger.info('Preparing and executing HttpRequest for update_cancel_scheduled_message.')
-        _request = @http_client.put(
-          _query_url,
-          headers: _headers,
-          parameters: body.to_json
+        request = @http_client.put(
+          query_url,
+          headers: headers,
+          parameters: json_body
         )
-        BasicAuth.apply(_request)
-        _context = execute_request(_request, name: 'update_cancel_scheduled_message')
-  
+
+        apply_authentication(request, request_url, json_body)
+
+        context = execute_request(request, name: 'update_cancel_scheduled_message')
+
         # Validate response against endpoint and global error codes.
         @logger.info("Validating response for update_cancel_scheduled_message.")
-        if _context.response.status_code == 400
+        if context.response.status_code == 400
           raise APIException.new(
             '',
-            _context
+            context
           )
-        elsif _context.response.status_code == 404
+        elsif context.response.status_code == 404
           raise APIException.new(
             '',
-            _context
+            context
           )
         end
-        validate_response(_context)
-  
+        validate_response(context)
+
         # Return appropriate response type.
         @logger.info("Returning response for update_cancel_scheduled_message.")
-        decoded = APIHelper.json_deserialize(_context.response.raw_body) unless
-          _context.response.raw_body.nil? ||
-          _context.response.raw_body.to_s.strip.empty?
+        decoded = APIHelper.json_deserialize(context.response.raw_body) unless
+          context.response.raw_body.nil? ||
+          context.response.raw_body.to_s.strip.empty?
         decoded
 
       rescue Exception => e
@@ -127,50 +137,58 @@ module MessageMediaMessages
     # the request, then
     # a HTTP 404 Not Found response will be returned*
     # @param [String] message_id Required parameter: Example:
+    # @param [Object] account_header_value The account id to pass to the API
     # @return Mixed response from the API call
-    def get_message_status(message_id)
+    def get_message_status(message_id, account_header_value=nil)
       begin
         @logger.info("get_message_status called.")
+
+        request_url = '/v1/messages/{messageId}'
+        request_url = APIHelper.append_url_with_template_parameters(
+            request_url,
+            'messageId' => message_id
+        )
+
         # Prepare query url.
         @logger.info("Preparing query URL for get_message_status.")
-        _query_builder = Configuration.base_uri.dup
-        _query_builder << '/v1/messages/{messageId}'
-        _query_builder = APIHelper.append_url_with_template_parameters(
-          _query_builder,
-          'messageId' => message_id
-        )
-        _query_url = APIHelper.clean_url _query_builder
+        query_builder = Configuration.base_uri.dup
+        query_builder << request_url
+        query_url = APIHelper.clean_url query_builder
   
         # Prepare headers.
         @logger.info("Preparing headers for get_message_status.")
-        _headers = {
+        headers = {
           'accept' => 'application/json'
         }
-  
+
+        add_account_header(headers, account_header_value)
+
         # Prepare and execute HttpRequest.
         @logger.info('Preparing and executing HttpRequest for get_message_status.')
-        _request = @http_client.get(
-          _query_url,
-          headers: _headers
+        request = @http_client.get(
+          query_url,
+          headers: headers
         )
-        BasicAuth.apply(_request)
-        _context = execute_request(_request, name: 'get_message_status')
+
+        apply_authentication(request, request_url)
+
+        context = execute_request(request, name: 'get_message_status')
   
         # Validate response against endpoint and global error codes.
         @logger.info("Validating response for get_message_status.")
-        if _context.response.status_code == 404
+        if context.response.status_code == 404
           raise APIException.new(
             '',
-            _context
+            context
           )
         end
-        validate_response(_context)
+        validate_response(context)
   
         # Return appropriate response type.
         @logger.info("Returning response for get_message_status.")
-        decoded = APIHelper.json_deserialize(_context.response.raw_body) unless
-          _context.response.raw_body.nil? ||
-          _context.response.raw_body.to_s.strip.empty?
+        decoded = APIHelper.json_deserialize(context.response.raw_body) unless
+          context.response.raw_body.nil? ||
+          context.response.raw_body.to_s.strip.empty?
         decoded
 
       rescue Exception => e
@@ -285,46 +303,55 @@ module MessageMediaMessages
     # valid for the request to be successful.
     # If any messages in the request are invalid, no messages will be sent.*
     # @param [SendMessagesRequest] body Required parameter: Example:
+    # @param [Object] account_header_value The account id to pass to the API
     # @return SendMessagesResponse response from the API call
-    def create_send_messages(body)
+    def create_send_messages(body, account_header_value=nil)
       begin
         @logger.info("create_send_messages called.")
+
+        request_url = '/v1/messages'
         # Prepare query url.
         @logger.info("Preparing query URL for create_send_messages.")
-        _query_builder = Configuration.base_uri.dup
-        _query_builder << '/v1/messages'
-        _query_url = APIHelper.clean_url _query_builder
+        query_builder = Configuration.base_uri.dup
+        query_builder << request_url
+        query_url = APIHelper.clean_url query_builder
   
         # Prepare headers.
         @logger.info("Preparing headers for create_send_messages.")
-        _headers = {
+        headers = {
           'accept' => 'application/json',
           'content-type' => 'application/json; charset=utf-8'
         }
-  
+
+        add_account_header(headers, account_header_value)
+
+        json_body = body.to_json
+
         # Prepare and execute HttpRequest.
         @logger.info('Preparing and executing HttpRequest for create_send_messages.')
-        _request = @http_client.post(
-          _query_url,
-          headers: _headers,
-          parameters: body.to_json
+        request = @http_client.post(
+          query_url,
+          headers: headers,
+          parameters: json_body
         )
-        BasicAuth.apply(_request)
-        _context = execute_request(_request, name: 'create_send_messages')
+
+        apply_authentication(request, request_url, json_body)
+
+        context = execute_request(request, name: 'create_send_messages')
   
         # Validate response against endpoint and global error codes.
         @logger.info("Validating response for create_send_messages.")
-        if _context.response.status_code == 400
+        if context.response.status_code == 400
           raise APIException.new(
             '',
-            _context
+            context
           )
         end
-        validate_response(_context)
+        validate_response(context)
   
         # Return appropriate response type.
         @logger.info("Returning response for create_send_messages.")
-        decoded = APIHelper.json_deserialize(_context.response.raw_body)
+        decoded = APIHelper.json_deserialize(context.response.raw_body)
         SendMessagesResponse.from_hash(decoded)
 
       rescue Exception => e
@@ -333,4 +360,4 @@ module MessageMediaMessages
       end
     end
   end
-end
+end