messagemedia_messages_sdk 1.1.0 → 2.0.0

data/lib/message_media_messages/models/send_messages_request.rb

@@ -1,19 +1,19 @@
-# 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
   # SendMessagesRequest Model.
   class SendMessagesRequest < BaseModel
     # TODO: Write general description for this method
-    # @return [List of Object]
+    # @return [List of Message]
     attr_accessor :messages
 
     # A mapping from model property names to API property names.
     def self.names
-      if @_hash.nil?
-        @_hash = {}
-        @_hash['messages'] = 'messages'
-      end
+      @_hash = {} if @_hash.nil?
+      @_hash['messages'] = 'messages'
       @_hash
     end
 
@@ -26,7 +26,14 @@ module MessageMediaMessages
       return nil unless hash
 
       # Extract variables from the hash.
-      messages = hash['messages']
+      # Parameter is an array, so we need to iterate through it
+      messages = nil
+      unless hash['messages'].nil?
+        messages = []
+        hash['messages'].each do |structure|
+          messages << (Message.from_hash(structure) if structure)
+        end
+      end
 
       # Create object from extracted values.
       SendMessagesRequest.new(messages)

data/lib/message_media_messages/models/send_messages_response.rb

@@ -1,19 +1,19 @@
-# 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
   # SendMessagesResponse Model.
   class SendMessagesResponse < BaseModel
     # TODO: Write general description for this method
-    # @return [List of Object]
+    # @return [List of Message]
     attr_accessor :messages
 
     # A mapping from model property names to API property names.
     def self.names
-      if @_hash.nil?
-        @_hash = {}
-        @_hash['messages'] = 'messages'
-      end
+      @_hash = {} if @_hash.nil?
+      @_hash['messages'] = 'messages'
       @_hash
     end
 
@@ -26,7 +26,14 @@ module MessageMediaMessages
       return nil unless hash
 
       # Extract variables from the hash.
-      messages = hash['messages']
+      # Parameter is an array, so we need to iterate through it
+      messages = nil
+      unless hash['messages'].nil?
+        messages = []
+        hash['messages'].each do |structure|
+          messages << (Message.from_hash(structure) if structure)
+        end
+      end
 
       # Create object from extracted values.
       SendMessagesResponse.new(messages)

data/lib/message_media_messages/models/source_number_type_enum.rb

@@ -0,0 +1,21 @@
+# message_media_messages
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module MessageMediaMessages
+  # Type of source address specified, this can be INTERNATIONAL, ALPHANUMERIC or
+  # SHORTCODE
+  class SourceNumberTypeEnum
+    SOURCE_NUMBER_TYPE_ENUM = [
+      # TODO: Write general description for INTERNATIONAL
+      INTERNATIONAL = 'INTERNATIONAL'.freeze,
+
+      # TODO: Write general description for ALPHANUMERIC
+      ALPHANUMERIC = 'ALPHANUMERIC'.freeze,
+
+      # TODO: Write general description for SHORTCODE
+      SHORTCODE = 'SHORTCODE'.freeze
+    ].freeze
+  end
+end

data/lib/message_media_messages/models/status2_enum.rb

@@ -0,0 +1,32 @@
+# message_media_messages
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module MessageMediaMessages
+  # The status of the message as per the delivery report
+  class Status2Enum
+    STATUS2_ENUM = [
+      # TODO: Write general description for ENROUTE
+      ENROUTE = 'enroute'.freeze,
+
+      # TODO: Write general description for FAILED
+      FAILED = 'failed'.freeze,
+
+      # TODO: Write general description for SUBMITTED
+      SUBMITTED = 'submitted'.freeze,
+
+      # TODO: Write general description for DELIVERED
+      DELIVERED = 'delivered'.freeze,
+
+      # TODO: Write general description for EXPIRED
+      EXPIRED = 'expired'.freeze,
+
+      # TODO: Write general description for REJECTED
+      REJECTED = 'rejected'.freeze,
+
+      # TODO: Write general description for UNDELIVERABLE
+      UNDELIVERABLE = 'undeliverable'.freeze
+    ].freeze
+  end
+end

data/lib/message_media_messages/models/status_enum.rb

@@ -0,0 +1,44 @@
+# message_media_messages
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module MessageMediaMessages
+  # The status of the message
+  class StatusEnum
+    STATUS_ENUM = [
+      # TODO: Write general description for ENROUTE
+      ENROUTE = 'enroute'.freeze,
+
+      # TODO: Write general description for SUBMITTED
+      SUBMITTED = 'submitted'.freeze,
+
+      # TODO: Write general description for DELIVERED
+      DELIVERED = 'delivered'.freeze,
+
+      # TODO: Write general description for EXPIRED
+      EXPIRED = 'expired'.freeze,
+
+      # TODO: Write general description for REJECTED
+      REJECTED = 'rejected'.freeze,
+
+      # TODO: Write general description for UNDELIVERABLE
+      UNDELIVERABLE = 'undeliverable'.freeze,
+
+      # TODO: Write general description for QUEUED
+      QUEUED = 'queued'.freeze,
+
+      # TODO: Write general description for PROCESSED
+      PROCESSED = 'processed'.freeze,
+
+      # TODO: Write general description for CANCELLED
+      CANCELLED = 'cancelled'.freeze,
+
+      # TODO: Write general description for SCHEDULED
+      SCHEDULED = 'scheduled'.freeze,
+
+      # TODO: Write general description for FAILED
+      FAILED = 'failed'.freeze
+    ].freeze
+  end
+end

data/lib/message_media_messages/models/vendor_account_id.rb

@@ -0,0 +1,44 @@
+# message_media_messages
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module MessageMediaMessages
+  # VendorAccountId Model.
+  class VendorAccountId < BaseModel
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :vendor_id
+
+    # The account used to submit the original message.
+    # @return [String]
+    attr_accessor :account_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['vendor_id'] = 'vendor_id'
+      @_hash['account_id'] = 'account_id'
+      @_hash
+    end
+
+    def initialize(vendor_id = nil,
+                   account_id = nil)
+      @vendor_id = vendor_id
+      @account_id = account_id
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      vendor_id = hash['vendor_id']
+      account_id = hash['account_id']
+
+      # Create object from extracted values.
+      VendorAccountId.new(vendor_id,
+                          account_id)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: messagemedia_messages_sdk
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - MessageMedia Developers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-16 00:00:00.000000000 Z
+date: 2019-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logging
@@ -43,9 +43,6 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.1'
-    - - ">="
       - !ruby/object:Gem::Version
         version: 3.1.5
   type: :runtime
@@ -53,9 +50,6 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.1'
-    - - ">="
       - !ruby/object:Gem::Version
         version: 3.1.5
 - !ruby/object:Gem::Dependency
@@ -115,8 +109,8 @@ files:
 - lib/message_media_messages/controllers/messages_controller.rb
 - lib/message_media_messages/controllers/replies_controller.rb
 - lib/message_media_messages/exceptions/api_exception.rb
-- lib/message_media_messages/http/auth/basic_auth.rb
-- lib/message_media_messages/http/auth/hmac_auth.rb
+- lib/message_media_messages/exceptions/send_messages400_response_exception.rb
+- lib/message_media_messages/http/auth/auth_manager.rb
 - lib/message_media_messages/http/faraday_client.rb
 - lib/message_media_messages/http/http_call_back.rb
 - lib/message_media_messages/http/http_client.rb
@@ -130,22 +124,25 @@ files:
 - lib/message_media_messages/models/check_delivery_reports_response.rb
 - lib/message_media_messages/models/check_replies_response.rb
 - lib/message_media_messages/models/confirm_delivery_reports_as_received_request.rb
-- lib/message_media_messages/models/confirm_delivery_reports_as_received_request_11.rb
+- lib/message_media_messages/models/confirm_delivery_reports_as_received_request1.rb
 - lib/message_media_messages/models/confirm_replies_as_received_request.rb
-- lib/message_media_messages/models/confirm_replies_as_received_request_8.rb
+- lib/message_media_messages/models/confirm_replies_as_received_request1.rb
+- lib/message_media_messages/models/delivery_report.rb
+- lib/message_media_messages/models/format1_enum.rb
+- lib/message_media_messages/models/format_enum.rb
+- lib/message_media_messages/models/get_message_status_response.rb
+- lib/message_media_messages/models/message.rb
+- lib/message_media_messages/models/reply.rb
 - lib/message_media_messages/models/send_messages_request.rb
 - lib/message_media_messages/models/send_messages_response.rb
-- test/controllers/controller_test_base.rb
-- test/controllers/test_delivery_reports_controller.rb
-- test/controllers/test_messages_controller.rb
-- test/controllers/test_replies_controller.rb
-- test/http_response_catcher.rb
-- test/test_helper.rb
-homepage: https://developers.messagemedia.com/
+- lib/message_media_messages/models/source_number_type_enum.rb
+- lib/message_media_messages/models/status2_enum.rb
+- lib/message_media_messages/models/status_enum.rb
+- lib/message_media_messages/models/vendor_account_id.rb
+homepage: https://developers.messagemedia.com
 licenses:
 - Apache-2.0
-metadata:
-  source_code_uri: https://github.com/messagemedia/messages-ruby-sdk
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:

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

@@ -1,20 +0,0 @@
-# This file was automatically generated for MessageMedia by APIMATIC v2.0
-# ( https://apimatic.io ).
-
-require 'base64'
-
-module MessageMediaMessages
-  # Utility class for basic authorization.
-  class BasicAuth
-    # Add basic authentication to the request.
-    # @param [HttpRequest] The HttpRequest object to which authentication will
-    # be added.
-    def self.apply(http_request, url=nil, body=nil)
-      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
-  end
-end

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

@@ -1,54 +0,0 @@
-# This file was automatically generated for MessageMedia by APIMATIC v2.0
-# ( https://apimatic.io ).
-
-require 'base64'
-
-module MessageMediaMessages
-  # Utility class for basic authorization.
-  class HmacAuth
-    def self.create_signature(date, content_signature, url, body=nil)
-      request_type = "GET"
-
-      if body != nil
-        request_type = "POST"
-      end
-
-      signing_string = "date: #{date}\n#{content_signature}#{request_type} #{url} HTTP/1.1"
-      hmac = OpenSSL::HMAC.digest(OpenSSL::Digest::Digest.new('sha1'), Configuration.hmac_auth_password.encode("ASCII"), signing_string.encode("ASCII"))
-
-      return Base64.encode64(hmac).chomp
-    end
-
-    # Add basic authentication to the request.
-    # @param [HttpRequest] The HttpRequest object to which authentication will
-    # be added.
-    def self.apply(http_request, url=nil, body=nil)
-      username = Configuration.hmac_auth_user_name
-
-      content_signature = ""
-      content_header = ""
-
-      now = DateTime.now.new_offset(0).to_time.strftime("%a, %d %b %Y %H:%M:%S GMT")
-
-      date_header = now
-
-      if body != nil
-        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 = HmacAuth.create_signature(date_header, content_signature, url, body)
-
-      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
-  end
-end

data/test/controllers/controller_test_base.rb

@@ -1,33 +0,0 @@
-# This file was automatically generated for MessageMedia by APIMATIC v2.0 ( https://apimatic.io ).
-
-require 'json'
-require 'test/unit'
-require 'message_media_messages.rb'
-require 'message_media_messages/configuration.rb'
-require_relative '../test_helper.rb'
-require_relative '../http_response_catcher.rb'
-
-# noinspection RubyClassVariableUsageInspection
-class ControllerTestBase < Test::Unit::TestCase
-  include MessageMediaMessages
-
-  class << self
-    attr_accessor :controller
-  end
-
-  # Called only once for a test class before any test has executed.
-  def self.startup		
-    @@api_client = MessageMediaMessagesClient.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_delivery_reports_controller.rb

@@ -1,164 +0,0 @@
-# This file was automatically generated for MessageMedia by APIMATIC v2.0 ( https://apimatic.io ).
-
-require_relative 'controller_test_base'
-
-# noinspection RubyClassVariableUsageInspection,RubyInstanceMethodNamingConvention
-class DeliveryReportsControllerTests < ControllerTestBase
-  # Called only once for the class before any test has executed
-  def self.startup
-    self.controller = @@api_client.delivery_reports
-  end
-
-  # Check for any delivery reports that have been received.
-  # Delivery reports are a notification of the change in status of a message as it is being processed.
-  # Each request to the check delivery reports endpoint will return any delivery reports received that
-  # have not yet been confirmed using the confirm delivery reports endpoint. A response from the check
-  # delivery reports endpoint will have the following structure:
-  # ```json
-  # {
-  #     "delivery_reports": [
-  #         {
-  #             "callback_url": "https://my.callback.url.com",
-  #             "delivery_report_id": "01e1fa0a-6e27-4945-9cdb-18644b4de043",
-  #             "source_number": "+61491570157",
-  #             "date_received": "2017-05-20T06:30:37.642Z",
-  #             "status": "enroute",
-  #             "delay": 0,
-  #             "submitted_date": "2017-05-20T06:30:37.639Z",
-  #             "original_text": "My first message!",
-  #             "message_id": "d781dcab-d9d8-4fb2-9e03-872f07ae94ba",
-  #             "vendor_account_id": {
-  #                 "vendor_id": "MessageMedia",
-  #                 "account_id": "MyAccount"
-  #             },
-  #             "metadata": {
-  #                 "key1": "value1",
-  #                 "key2": "value2"
-  #             }
-  #         },
-  #         {
-  #             "callback_url": "https://my.callback.url.com",
-  #             "delivery_report_id": "0edf9022-7ccc-43e6-acab-480e93e98c1b",
-  #             "source_number": "+61491570158",
-  #             "date_received": "2017-05-21T01:46:42.579Z",
-  #             "status": "enroute",
-  #             "delay": 0,
-  #             "submitted_date": "2017-05-21T01:46:42.574Z",
-  #             "original_text": "My second message!",
-  #             "message_id": "fbb3b3f5-b702-4d8b-ab44-65b2ee39a281",
-  #             "vendor_account_id": {
-  #                 "vendor_id": "MessageMedia",
-  #                 "account_id": "MyAccount"
-  #             },
-  #             "metadata": {
-  #                 "key1": "value1",
-  #                 "key2": "value2"
-  #             }
-  #         }
-  #     ]
-  # }
-  # ```
-  # Each delivery report will contain details about the message, including any metadata specified
-  # and the new status of the message (as each delivery report indicates a change in status of a
-  # message) and the timestamp at which the status changed. Every delivery report will have a
-  # unique delivery report ID for use with the confirm delivery reports endpoint.
-  # *Note: The source number and destination number properties in a delivery report are the inverse of
-  # those specified in the message that the delivery report relates to. The source number of the
-  # delivery report is the destination number of the original message.*
-  # Subsequent requests to the check delivery reports endpoint will return the same delivery reports
-  # and a maximum of 100 delivery reports will be returned in each request. Applications should use the
-  # confirm delivery reports endpoint in the following pattern so that delivery reports that have been
-  # processed are no longer returned in subsequent check delivery reports requests.
-  # 1. Call check delivery reports endpoint
-  # 2. Process each delivery report
-  # 3. Confirm all processed delivery reports using the confirm delivery reports endpoint
-  # *Note: It is recommended to use the Webhooks feature to receive reply messages rather than
-  # polling the check delivery reports endpoint.*
-  def test_check_delivery_reports_1
-
-    # Perform the API call through the SDK function
-    result = self.class.controller.get_check_delivery_reports
-
-    # Test response code
-    assert_equal(@response_catcher.response.status_code, 200)
-
-    # Test headers
-    expected_headers = {}
-    expected_headers['content-type'] = nil
-
-    assert(TestHelper.match_headers(expected_headers, @response_catcher.response.headers))
-
-    # Test whether the captured response is as we expected
-    assert_not_nil(result)
-    assert_true(@response_catcher.response.raw_body.index('{"delivery_reports":[') >= 0, "Must get our delivery reports")
-  end
-
-  # Make sure our SDK fails when passed an invalid account id
-  def test_check_delivery_reports_with_invalid_account
-    begin
-      # Perform the API call through the SDK function
-      self.class.controller.get_check_delivery_reports('INVALID ACCOUNT')
-    rescue APIException => api_exception
-      assert_equal('HTTP Response Not OK. {"message":"Invalid account \'INVALID ACCOUNT\' in header Account"}' + "\n",
-                   api_exception.message,'Make sure we''ve got our error message')
-      # Test response code
-      assert_equal(@response_catcher.response.status_code, 403)
-    end
-  end
-
-  # Mark a delivery report as confirmed so it is no longer return in check delivery reports requests.
-  # The confirm delivery reports endpoint is intended to be used in conjunction with the check delivery
-  # reports endpoint to allow for robust processing of delivery reports. Once one or more delivery
-  # reports have been processed, they can then be confirmed using the confirm delivery reports endpoint so they
-  # are no longer returned in subsequent check delivery reports requests.
-  # The confirm delivery reports endpoint takes a list of delivery report IDs as follows:
-  # ```json
-  # {
-  #     "delivery_report_ids": [
-  #         "011dcead-6988-4ad6-a1c7-6b6c68ea628d",
-  #         "3487b3fa-6586-4979-a233-2d1b095c7718",
-  #         "ba28e94b-c83d-4759-98e7-ff9c7edb87a1"
-  #     ]
-  # }
-  # ```
-  # Up to 100 delivery reports can be confirmed in a single confirm delivery reports request.
-  def test_confirm_delivery_reports_as_received_1
-    # Parameters for the API call
-    body = ConfirmDeliveryReportsAsReceivedRequest.from_hash(JSON.parse(
-      '{"delivery_report_ids":["011dcead-6988-4ad6-a1c7-6b6c68ea628d","3487b3fa-65'\
-      '86-4979-a233-2d1b095c7718","ba28e94b-c83d-4759-98e7-ff9c7edb87a1"]}'
-      ))
-
-    # Perform the API call through the SDK function
-    self.class.controller.create_confirm_delivery_reports_as_received(body)
-
-    # Test response code
-    assert_equal(@response_catcher.response.status_code, 202)
-
-    # Test headers
-    expected_headers = {}
-    expected_headers['content-type'] = nil
-
-    assert(TestHelper.match_headers(expected_headers, @response_catcher.response.headers))
-  end
-
-  # Make sure our SDK fails when passed an invalid account id
-  def test_confirm_delivery_reports_as_received_with_invalid_account
-    begin
-      # Perform the API call through the SDK function
-      body = ConfirmDeliveryReportsAsReceivedRequest.from_hash(JSON.parse(
-          '{"delivery_report_ids":["011dcead-6988-4ad6-a1c7-6b6c68ea628d","3487b3fa-65'\
-      '86-4979-a233-2d1b095c7718","ba28e94b-c83d-4759-98e7-ff9c7edb87a1"]}'
-      ))
-
-      # Perform the API call through the SDK function
-      self.class.controller.create_confirm_delivery_reports_as_received(body, 'INVALID ACCOUNT')
-    rescue APIException => api_exception
-      assert_equal('HTTP Response Not OK. {"message":"Invalid account \'INVALID ACCOUNT\' in header Account"}' + "\n",
-                   api_exception.message,'Make sure we''ve got our error message')
-      # Test response code
-      assert_equal(@response_catcher.response.status_code, 403)
-    end
-  end
-
-end