messagemedia_messages_sdk 1.1.0 → 2.0.0

data/lib/message_media_messages/controllers/replies_controller.rb

@@ -1,9 +1,10 @@
-# This file was automatically generated for MessageMedia by APIMATIC v2.0
+# message_media_messages
+#
+# This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
 module MessageMediaMessages
   # RepliesController
-  # noinspection RubyResolve,RubyInstanceMethodNamingConvention,RubyStringKeysInHashInspection
   class RepliesController < BaseController
     @instance = RepliesController.new
 
@@ -15,87 +16,6 @@ module MessageMediaMessages
       self.class.instance
     end
 
-    # Mark a reply message as confirmed so it is no longer returned in check
-    # replies requests.
-    # The confirm replies endpoint is intended to be used in conjunction with
-    # the check replies endpoint
-    # to allow for robust processing of reply messages. Once one or more reply
-    # messages have been processed
-    # they can then be confirmed using the confirm replies endpoint so they are
-    # no longer returned in
-    # subsequent check replies requests.
-    # The confirm replies endpoint takes a list of reply IDs as follows:
-    # ```json
-    # {
-    #     "reply_ids": [
-    #         "011dcead-6988-4ad6-a1c7-6b6c68ea628d",
-    #         "3487b3fa-6586-4979-a233-2d1b095c7718",
-    #         "ba28e94b-c83d-4759-98e7-ff9c7edb87a1"
-    #     ]
-    # }
-    # ```
-    # Up to 100 replies can be confirmed in a single confirm replies request.
-    # @param [ConfirmRepliesAsReceivedRequest] 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_replies_as_received(body, account_header_value=nil)
-      begin
-        @logger.info("create_confirm_replies_as_received called.")
-        
-        request_url = '/v1/replies/confirmed'
-        
-        # Prepare query url.
-        @logger.info("Preparing query URL for create_confirm_replies_as_received.")
-        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_replies_as_received.")
-        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_replies_as_received.')
-        request = @http_client.post(
-          query_url,
-          headers: headers,
-          parameters: json_body
-        )
-
-        apply_authentication(request, request_url, json_body)
-
-        context = execute_request(request, name: 'create_confirm_replies_as_received')
-  
-        # Validate response against endpoint and global error codes.
-        @logger.info("Validating response for create_confirm_replies_as_received.")
-        if context.response.status_code == 400
-          raise APIException.new(
-            '',
-            context
-          )
-        end
-        validate_response(context)
-  
-        # Return appropriate response type.
-        @logger.info("Returning response for create_confirm_replies_as_received.")
-        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)
-        raise e
-      end
-    end
-
     # Check for any replies that have been received.
     # Replies are messages that have been sent from a handset in response to a
     # message sent by an
@@ -178,48 +98,84 @@ module MessageMediaMessages
     # *Note: It is recommended to use the Webhooks feature to receive reply
     # messages rather than polling
     # the check replies endpoint.*
-    # @param [Object] account_header_value The account id to pass to the API
     # @return CheckRepliesResponse response from the API call
-    def get_check_replies(account_header_value=nil)
-      begin
-        @logger.info("get_check_replies called.")
-        
-        request_url = '/v1/replies'
-        # Prepare query url.
-        @logger.info("Preparing query URL for get_check_replies.")
-        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_replies.")
-        headers = {
-          'accept' => 'application/json'
-        }
-
-        add_account_header(headers, account_header_value)
-
-        # Prepare and execute HttpRequest.
-        @logger.info('Preparing and executing HttpRequest for get_check_replies.')
-        request = @http_client.get(
-          query_url,
-          headers: headers
-        )
-
-        apply_authentication(request, request_url)
-
-        context = execute_request(request, name: 'get_check_replies')
-        validate_response(context)
-  
-        # Return appropriate response type.
-        @logger.info("Returning response for get_check_replies.")
-        decoded = APIHelper.json_deserialize(context.response.raw_body)
-        CheckRepliesResponse.from_hash(decoded)
+    def check_replies
+      # Prepare query url.
+      _path_url = '/v1/replies'
+      _query_builder = Configuration.base_uri.dup
+      _query_builder << _path_url
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = @http_client.get(
+        _query_url,
+        headers: _headers
+      )
+      AuthManager.apply(_request, _path_url)
+      _context = execute_request(_request)
+      validate_response(_context)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_context.response.raw_body)
+      CheckRepliesResponse.from_hash(decoded)
+    end
 
-      rescue Exception => e
-        @logger.error(e)
-        raise e
-      end
+    # Mark a reply message as confirmed so it is no longer returned in check
+    # replies requests.
+    # The confirm replies endpoint is intended to be used in conjunction with
+    # the check replies endpoint
+    # to allow for robust processing of reply messages. Once one or more reply
+    # messages have been processed
+    # they can then be confirmed using the confirm replies endpoint so they are
+    # no longer returned in
+    # subsequent check replies requests.
+    # The confirm replies endpoint takes a list of reply IDs as follows:
+    # ```json
+    # {
+    #     "reply_ids": [
+    #         "011dcead-6988-4ad6-a1c7-6b6c68ea628d",
+    #         "3487b3fa-6586-4979-a233-2d1b095c7718",
+    #         "ba28e94b-c83d-4759-98e7-ff9c7edb87a1"
+    #     ]
+    # }
+    # ```
+    # Up to 100 replies can be confirmed in a single confirm replies request.
+    # @param [ConfirmRepliesAsReceivedRequest] body Required parameter:
+    # Example:
+    # @return Mixed response from the API call
+    def confirm_replies_as_received(body)
+      # Prepare query url.
+      _path_url = '/v1/replies/confirmed'
+      _query_builder = Configuration.base_uri.dup
+      _query_builder << _path_url
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json',
+        'content-type' => 'application/json; charset=utf-8'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = @http_client.post(
+        _query_url,
+        headers: _headers,
+        parameters: body.to_json
+      )
+      AuthManager.apply(_request, _path_url, body.to_json)
+      _context = execute_request(_request)
+      validate_response(_context)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_context.response.raw_body) unless
+        _context.response.raw_body.nil? ||
+        _context.response.raw_body.to_s.strip.empty?
+      decoded
     end
   end
 end

data/lib/message_media_messages/exceptions/api_exception.rb

@@ -1,4 +1,6 @@
-# This file was automatically generated for MessageMedia by APIMATIC v2.0
+# message_media_messages
+#
+# This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
 module MessageMediaMessages
@@ -7,8 +9,8 @@ module MessageMediaMessages
     attr_reader :context, :response_code
 
     # The constructor.
-    # @param [String] reason The reason for raising an exception.
-    # @param [HttpContext] context The HttpContext of the API call.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpContext] The HttpContext of the API call.
     def initialize(reason, context)
       super(reason)
       @context = context

data/lib/message_media_messages/exceptions/send_messages400_response_exception.rb

@@ -0,0 +1,29 @@
+# message_media_messages
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module MessageMediaMessages
+  # Send messages 400 response class.
+  class SendMessages400ResponseException < APIException
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :message
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpContext] The HttpContext of the API call.
+    def initialize(reason, context)
+      super(reason, context)
+      hash = APIHelper.json_deserialize(@context.response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      @message = hash['message']
+    end
+  end
+end

data/lib/message_media_messages/http/auth/auth_manager.rb

@@ -0,0 +1,90 @@
+# message_media_messages
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'base64'
+
+module MessageMediaMessages
+  # Utility class for basic authorization.
+  class AuthManager
+    # Add authentication to the request.
+    # @param [HttpRequest] The HttpRequest object to which authentication will
+    # be added.
+    # @param [String] The url of the request.
+    # @param [String] The body of the request. None for GET requests.
+    def self.apply(http_request, url, body = nil)
+      if Configuration.hmac_auth_user_name.nil? ||
+         Configuration.hmac_auth_password.nil?
+        AuthManager.apply_basic_auth(http_request)
+      else
+        AuthManager.apply_hmac_auth(http_request, url, body)
+      end
+    end
+
+    # Add basic authentication to the request.
+    # @param [HttpRequest] The HttpRequest object to which authentication will
+    # be added.
+    def self.apply_basic_auth(http_request)
+      username = Configuration.basic_auth_user_name
+      password = Configuration.basic_auth_password
+      value = Base64.strict_encode64("#{username}:#{password}")
+      header_value = "Basic #{value}"
+      http_request.headers['Authorization'] = header_value
+    end
+
+    # Add hmac authentication to the request.
+    # @param [HttpRequest] The HttpRequest object to which authentication will
+    # be added.
+    # @param [String] The url of the request.
+    # @param [String] The body of the request. None for GET requests.
+    def self.apply_hmac_auth(http_request, url, body)
+      username = Configuration.hmac_auth_user_name
+
+      content_signature = ''
+      content_header = ''
+
+      now = Time.now.utc.strftime('%a, %d %b %Y %H:%M:%S GMT')
+
+      date_header = now
+
+      request_type = 'GET'
+
+      unless body.nil?
+        request_type = 'POST'
+
+        md5 = Digest::MD5.new
+        md5.update(body)
+
+        content_hash = md5.hexdigest
+        content_signature = "x-Content-MD5: #{content_hash}\n"
+        content_header = 'x-Content-MD5 '
+        http_request.headers['x-Content-MD5'] = content_hash
+      end
+
+      http_request.headers['date'] = date_header
+
+      hmac_signature = AuthManager.create_signature(date_header,
+                                                    content_signature, url,
+                                                    request_type)
+
+      joined = "username=\"#{username}\", algorithm=\"hmac-sha1\", " \
+               "headers=\"date #{content_header}request-line\", " \
+               "signature=\"#{hmac_signature}\""
+      header_value = "hmac #{joined}"
+      http_request.headers['Authorization'] = header_value
+    end
+
+    def self.create_signature(date, content_signature, url, request_type)
+      signing_string = "date: #{date}\n#{content_signature}#{request_type} " \
+                       "#{url} HTTP/1.1"
+      hmac = OpenSSL::HMAC.digest(OpenSSL::Digest.new('sha1'),
+                                  Configuration.hmac_auth_password.encode(
+                                    Encoding::UTF_8
+                                  ),
+                                  signing_string.encode(Encoding::UTF_8))
+
+      Base64.encode64(hmac).chomp
+    end
+  end
+end

data/lib/message_media_messages/http/faraday_client.rb

@@ -1,5 +1,8 @@
-# This file was automatically generated for MessageMedia by APIMATIC v2.0
+# message_media_messages
+#
+# This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
+
 require 'faraday/http_cache'
 
 module MessageMediaMessages
@@ -30,7 +33,9 @@ module MessageMediaMessages
         http_request.query_url
       ) do |request|
         request.headers = http_request.headers
-        request.body = http_request.parameters
+        unless http_request.parameters.empty?
+          request.body = http_request.parameters
+        end
       end
       convert_response(response)
     end
@@ -42,7 +47,9 @@ module MessageMediaMessages
         http_request.query_url
       ) do |request|
         request.headers = http_request.headers
-        request.body = http_request.parameters
+        unless http_request.parameters.empty?
+          request.body = http_request.parameters
+        end
       end
       convert_response(response)
     end

data/lib/message_media_messages/http/http_call_back.rb

@@ -1,11 +1,13 @@
-# This file was automatically generated for MessageMedia by APIMATIC v2.0
+# message_media_messages
+#
+# This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
 module MessageMediaMessages
   # HttpCallBack allows defining callables for pre and post API calls.
   class HttpCallBack
     # A controller will call this method before making an HTTP Request.
-    # @param [HttpRequest] _http_request The HttpRequest object which the HttpClient
+    # @param [HttpRequest] The HttpRequest object which the HttpClient
     # will execute.
     def on_before_request(_http_request)
       raise NotImplementedError, 'This method needs
@@ -13,7 +15,7 @@ module MessageMediaMessages
     end
 
     # A controller will call this method after making an HTTP Request.
-    # @param [HttpContext] _http_context The HttpContext of the API call.
+    # @param [HttpContext] The HttpContext of the API call.
     def on_after_response(_http_context)
       raise NotImplementedError, 'This method needs
         to be implemented in a child class.'

data/lib/message_media_messages/http/http_client.rb

@@ -1,4 +1,6 @@
-# This file was automatically generated for MessageMedia by APIMATIC v2.0
+# message_media_messages
+#
+# This file was automatically generated by APIMATIC v2.0
 # ( https://apimatic.io ).
 
 module MessageMediaMessages
@@ -8,29 +10,29 @@ module MessageMediaMessages
   # for HTTP Client classes.
   class HttpClient
     # Execute an HttpRequest when the response is expected to be a string.
-    # @param [HttpRequest] _http_request The HttpRequest to be executed.
+    # @param [HttpRequest] The HttpRequest to be executed.
     def execute_as_string(_http_request)
       raise NotImplementedError, 'This method needs
         to be implemented in a child class.'
     end
 
     # Execute an HttpRequest when the response is expected to be binary.
-    # @param [HttpRequest] _http_request The HttpRequest to be executed.
+    # @param [HttpRequest] The HttpRequest to be executed.
     def execute_as_binary(_http_request)
       raise NotImplementedError, 'This method needs
         to be implemented in a child class.'
     end
 
     # Converts the HTTP Response from the client to an HttpResponse object.
-    # @param [Dynamic] _response The response object received from the client.
+    # @param [Dynamic] The response object received from the client.
     def convert_response(_response)
       raise NotImplementedError, 'This method needs
         to be implemented in a child class.'
     end
 
     # Get a GET HttpRequest object.
-    # @param [String] query_url The URL to send the request to.
-    # @param [Hash, Optional] headers The headers for the HTTP Request.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
     def get(query_url,
             headers: {})
       HttpRequest.new(HttpMethodEnum::GET,
@@ -38,10 +40,20 @@ module MessageMediaMessages
                       headers: headers)
     end
 
+    # Get a HEAD HttpRequest object.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    def head(query_url,
+             headers: {})
+      HttpRequest.new(HttpMethodEnum::HEAD,
+                      query_url,
+                      headers: headers)
+    end
+
     # Get a POST HttpRequest object.
-    # @param [String] query_url The URL to send the request to.
-    # @param [Hash, Optional] headers The headers for the HTTP Request.
-    # @param [Hash, Optional] parameters The parameters for the HTTP Request.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    # @param [Hash, Optional] The parameters for the HTTP Request.
     def post(query_url,
              headers: {},
              parameters: {})
@@ -52,9 +64,9 @@ module MessageMediaMessages
     end
 
     # Get a PUT HttpRequest object.
-    # @param [String] query_url The URL to send the request to.
-    # @param [Hash, Optional] headers The headers for the HTTP Request.
-    # @param [Hash, Optional] parameters The parameters for the HTTP Request.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    # @param [Hash, Optional] The parameters for the HTTP Request.
     def put(query_url,
             headers: {},
             parameters: {})
@@ -65,9 +77,9 @@ module MessageMediaMessages
     end
 
     # Get a PATCH HttpRequest object.
-    # @param [String] query_url The URL to send the request to.
-    # @param [Hash, Optional] headers The headers for the HTTP Request.
-    # @param [Hash, Optional] parameters The parameters for the HTTP Request.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    # @param [Hash, Optional] The parameters for the HTTP Request.
     def patch(query_url,
               headers: {},
               parameters: {})
@@ -78,9 +90,8 @@ module MessageMediaMessages
     end
 
     # Get a DELETE HttpRequest object.
-    # @param [String] query_url The URL to send the request to.
-    # @param [Hash, Optional] headers The headers for the HTTP Request.
-    # @param [Hash, Optional] parameters The parameters for the HTTP Request.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
     def delete(query_url,
                headers: {},
                parameters: {})