messagemedia_messages_sdk 1.0.0

data/test/controllers/test_replies_controller.rb

@@ -0,0 +1,132 @@
+# This file was automatically generated for MessageMedia by APIMATIC v2.0 ( https://apimatic.io ).
+
+require_relative 'controller_test_base'
+
+class RepliesControllerTests < ControllerTestBase
+  # Called only once for the class before any test has executed
+  def self.startup
+    self.controller = @@api_client.replies
+  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.
+  def test_confirm_replies_as_received_1()
+    # Parameters for the API call
+    body = ConfirmRepliesAsReceivedRequest.from_hash(JSON.parse(
+      '{"reply_ids":["011dcead-6988-4ad6-a1c7-6b6c68ea628d","3487b3fa-6586-4979-a2'\
+      '33-2d1b095c7718","ba28e94b-c83d-4759-98e7-ff9c7edb87a1"]}'
+      ))
+
+    # Perform the API call through the SDK function
+    result = self.class.controller.create_confirm_replies_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
+
+  # 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
+  #application or messages that have been sent from a handset to a inbound number associated with
+  #an account, known as a dedicated inbound number (contact <support@messagemedia.com> for more
+  #information on dedicated inbound numbers).
+  #Each request to the check replies endpoint will return any replies received that have not yet
+  #been confirmed using the confirm replies endpoint. A response from the check replies endpoint
+  #will have the following structure:
+  #```json
+  #{
+  #    "replies": [
+  #        {
+  #            "metadata": {
+  #                "key1": "value1",
+  #                "key2": "value2"
+  #            },
+  #            "message_id": "877c19ef-fa2e-4cec-827a-e1df9b5509f7",
+  #            "reply_id": "a175e797-2b54-468b-9850-41a3eab32f74",
+  #            "date_received": "2016-12-07T08:43:00.850Z",
+  #            "callback_url": "https://my.callback.url.com",
+  #            "destination_number": "+61491570156",
+  #            "source_number": "+61491570157",
+  #            "vendor_account_id": {
+  #                "vendor_id": "MessageMedia",
+  #                "account_id": "MyAccount"
+  #            },
+  #            "content": "My first reply!"
+  #        },
+  #        {
+  #            "metadata": {
+  #                "key1": "value1",
+  #                "key2": "value2"
+  #            },
+  #            "message_id": "8f2f5927-2e16-4f1c-bd43-47dbe2a77ae4",
+  #            "reply_id": "3d8d53d8-01d3-45dd-8cfa-4dfc81600f7f",
+  #            "date_received": "2016-12-07T08:43:00.850Z",
+  #            "callback_url": "https://my.callback.url.com",
+  #            "destination_number": "+61491570157",
+  #            "source_number": "+61491570158",
+  #            "vendor_account_id": {
+  #                "vendor_id": "MessageMedia",
+  #                "account_id": "MyAccount"
+  #            },
+  #            "content": "My second reply!"
+  #        }
+  #    ]
+  #}
+  #```
+  #Each reply will contain details about the reply message, as well as details of the message the reply was sent
+  #in response to, including any metadata specified. Every reply will have a reply ID to be used with the
+  #confirm replies endpoint.
+  #*Note: The source number and destination number properties in a reply are the inverse of those
+  #specified in the message the reply is in response to. The source number of the reply message is the
+  #same as the destination number of the original message, and the destination number of the reply
+  #message is the same as the source number of the original message. If a source number
+  #wasn't specified in the original message, then the destination number property will not be present
+  #in the reply message.*
+  #Subsequent requests to the check replies endpoint will return the same reply messages and a maximum
+  #of 100 replies will be returned in each request. Applications should use the confirm replies endpoint
+  #in the following pattern so that replies that have been processed are no longer returned in
+  #subsequent check replies requests.
+  #1. Call check replies endpoint
+  #2. Process each reply message
+  #3. Confirm all processed reply messages using the confirm replies endpoint
+  #*Note: It is recommended to use the Webhooks feature to receive reply messages rather than polling
+  #the check replies endpoint.*
+  def test_check_replies_1()
+
+    # Perform the API call through the SDK function
+    result = self.class.controller.get_check_replies()
+
+    # 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_equal('{  "replies": [    {      "metadata": {        "key1": "value1",        "key2": "value2"      },      "message_id": "877c19ef-fa2e-4cec-827a-e1df9b5509f7",      "reply_id": "a175e797-2b54-468b-9850-41a3eab32f74",      "date_received": "2016-12-07T08:43:00.850Z",      "callback_url": "https://my.callback.url.com",      "destination_number": "+61491570156",      "source_number": "+61491570157",      "vendor_account_id": {        "vendor_id": "MessageMedia",        "account_id": "MyAccount"      },      "content": "My first reply!"    },    {      "metadata": {        "key1": "value1",        "key2": "value2"      },      "message_id": "8f2f5927-2e16-4f1c-bd43-47dbe2a77ae4",      "reply_id": "3d8d53d8-01d3-45dd-8cfa-4dfc81600f7f",      "date_received": "2016-12-07T08:43:00.850Z",      "callback_url": "https://my.callback.url.com",      "destination_number": "+61491570157",      "source_number": "+61491570158",      "vendor_account_id": {        "vendor_id": "MessageMedia",        "account_id": "MyAccount"      },      "content": "My second reply!"    }  ]}', @response_catcher.response.raw_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 < MessageMediaMessages::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

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: messagemedia_messages_sdk
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- MessageMedia Developers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logging
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.5
+  type: :runtime
+  prerelease: false
+  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
+  name: certifi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2016.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2016.09.26
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2016.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2016.09.26
+- !ruby/object:Gem::Dependency
+  name: faraday-http-cache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+description: The MessageMedia Messages API provides a number of endpoints for building
+  powerful two-way messaging applications.
+email: developers@messagemedia.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/message_media_messages.rb
+- lib/message_media_messages/api_helper.rb
+- lib/message_media_messages/configuration.rb
+- lib/message_media_messages/controllers/base_controller.rb
+- lib/message_media_messages/controllers/delivery_reports_controller.rb
+- 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/faraday_client.rb
+- lib/message_media_messages/http/http_call_back.rb
+- lib/message_media_messages/http/http_client.rb
+- lib/message_media_messages/http/http_context.rb
+- lib/message_media_messages/http/http_method_enum.rb
+- lib/message_media_messages/http/http_request.rb
+- lib/message_media_messages/http/http_response.rb
+- lib/message_media_messages/message_media_messages_client.rb
+- lib/message_media_messages/models/base_model.rb
+- lib/message_media_messages/models/cancel_scheduled_message_request.rb
+- 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_replies_as_received_request.rb
+- lib/message_media_messages/models/confirm_replies_as_received_request_8.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/
+licenses:
+- Apache-2.0
+metadata:
+  source_code_uri: https://github.com/messagemedia/messages-ruby-sdk
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: MessageMedia Messages SDK
+test_files: []