messagemedia-ruby 0.7.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MjM5ZTNkNjA1YzUzMGY2YmQ1ZmUwYWU2NzBlNDE3NDgwYjQxNGZhMg==
+  data.tar.gz: !binary |-
+    YjRjNjM1YjgxNjZhN2QwYmIxMjE4NmMyMDRlYzhiZmY1ZGM4MTJjMA==
+SHA512:
+  metadata.gz: !binary |-
+    ZjI4ZDYyNTQ1YTBhMmVhN2E5MWY1ZTk1OGUzMGIyYWYzMDkwNThjN2UwZDRh
+    ZDdhNWQ4MjQwZTRkZmI5N2YwZWQ0ZDJiOWI1ZTc5OTU0NmI0OWI1ZDI0NmM0
+    Nzg2ODQyY2ViMTI1ZTIxODQ3OTk4ZjQ4YWQyYjdlNWQ2ZDgyNTE=
+  data.tar.gz: !binary |-
+    YTc5NWQ0M2IzNGI0ZTAzODM1M2ZjYzE0MDU0ZWYzZmE1Y2EyMjg2MjEwN2Vh
+    MjM4YmE4NmU4OTI5OTE3NmYzMmI3NTM4N2FhZDBmY2MzYjI0ZWEzMWRkZjQ2
+    YTk2NTdmMzI1ODgzYmY2YzgzZWMzYjAyMGU5YjkwNDViMDljY2Q=

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.rakeTasks
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,21 @@
+sudo: false
+language: ruby
+cache: bundler
+bundler_args: --without development
+rvm:
+  - ruby-head
+  - ruby
+  - 2.2.0
+  - 2.1.0
+  - 2.0.0
+  - 1.9.3
+  - jruby-head
+  - jruby
+  - jruby-19mode
+matrix:
+  fast_finish: true
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: ruby
+    - rvm: jruby-head
+    - rvm: jruby

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in messagemedia.gemspec
+gemspec
+

data/LICENSE.txt

@@ -0,0 +1,201 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,64 @@
+[![Gem Version](https://badge.fury.io/rb/messagemedia-soap.svg)](http://badge.fury.io/rb/messagemedia-soap)
+[![Build Status](https://travis-ci.org/messagemedia/messagemedia-ruby.svg)](https://travis-ci.org/messagemedia/messagemedia-ruby)
+
+# MessageMedia Ruby SDK
+This library provides a simple interface for sending and receiving messages using the [MessageMedia SOAP API](http://www.messagemedia.com.au/wp-content/uploads/2013/05/MessageMedia_Messaging_Web_Service.pdf?eacfbb).
+
+If you have any issue using this sample code, or would like to report a defect, you could [create a new Issue](https://github.com/messagemedia/messagemedia-ruby/issues/new) in Github or [Contact us](http://www.messagemedia.com.au/contact-us).
+
+## Installation
+The messagemedia-ruby Gem can be installed from Rubygems:
+
+    gem install messagemedia-ruby
+
+## Usage
+The following actions have been implemented:
+
+  * sendMessages
+  * checkUser
+  * checkReplies
+  * checkReports
+  * confirmReplies
+  * confirmReports
+
+### Initialise the client
+Initialise the client using your MessageMedia username and password:
+
+    require 'messagemedia-ruby'
+
+    client = Messagemedia::SOAP::Client.new(YOUR_USERNAME, YOUR_PASSWORD)
+
+### Send Messages
+To send a single message:
+
+    client.send_message(<TO_NUMBER>, <MESSAGE>, <MESSSAGE_ID>)
+
+To send multiple messages:
+
+    # Construct the first Message object
+    message1 = Messagemedia::SOAP::Message.new
+    message1.content = "Content of Message"
+    message1.delivery_report = true
+    message1.origin = "My Company"
+    message1.add_recipient(FIRST_MESSAGE_ID, TO_NUMBER)
+
+    # Construct the second Message object
+    message2 = Messagemedia::SOAP::Message.new
+    message2.content = "Content of Message"
+    message2.delivery_report = false
+    message2.origin = "My Company"
+    message2.add_recipient(SECOND_MESSAGE_ID, TO_NUMBER)
+
+    client.send_messages([message1, message2])
+
+### Other Actions
+Check out 'example.rb' in the 'bin' directory to see examples of how you can use the other actions provided by this SDK.
+
+## Contributing
+We welcome contributions from our users. Contributing is easy:
+
+  1.  Fork this repo
+  2.  Create your feature branch (`git checkout -b my-new-feature`)
+  3.  Commit your changes (`git commit -am 'Add some feature'`)
+  4.  Push to the branch (`git push origin my-new-feature`)
+  5.  Create a Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc 'Run tests'
+task :default => :test

data/bin/example.rb

@@ -0,0 +1,174 @@
+#!/usr/bin/env ruby
+
+require "messagemedia-ruby"
+
+USER_ID            = "<your username>";        # Your username goes here
+PASSWORD           = "<your password>";        # Your password goes here
+DESTINATION_NUMBER = "<destination number>";   # Destination number
+
+##
+# Method used for rendering the results to the console screen.
+#
+def display_result(result)
+
+    puts "Messages sent #{result[:'@sent']}"
+    puts "Messages failed #{result[:'@failed']}"
+    puts "Messages scheduled #{result[:'@scheduled']}"
+
+    if not result[:errors].nil? then
+        puts result.errors
+    end
+
+end
+
+##
+# Example demonstrates how to quickly send a single message with the default
+# settings.
+#
+def send_message
+
+    puts "EXECUTING SEND MESSAGE..."
+    messageId = 1234567890;
+
+    client = Messagemedia::SOAP::Client.new(USER_ID, PASSWORD)
+    result = client.send_message(DESTINATION_NUMBER, "Test Message", messageId)
+    display_result result
+
+end
+
+##
+# Example shows how to send a batch of messages. It's possible to send
+# multiple individual messages in a single batch.
+#
+def send_multiple_messages
+
+    puts "EXECUTING SEND MULTIPLE MESSAGES..."
+
+    client = Messagemedia::SOAP::Client.new(USER_ID, PASSWORD)
+
+    # Construct the message
+    message1 = Messagemedia::SOAP::Message.new
+    message1.content = "Content of Message 1 to Recipient 1"
+    message1.delivery_report = true
+    message1.format = Messagemedia::SOAP::FORMAT_SMS
+    message1.validity_period = 1
+    # (Optional) This attribute specifies a sequence number that is assigned to the message and is used to identify the message if an error occurs. Each message error in the response will specify the sequence number of the message that caused the error. Sequence numbers should be unique within the request. 1 to 2147483647.
+    message1.sequence_number = 1
+    # (Optional) This element specifies the message source address. The specified address will be used wherever possible, however due to limitations with various carriers, legislation etc, the final message is not guaranteed to come from the specified address.
+    message1.origin = "Origin_1"
+    message1.add_recipient(1234567890, DESTINATION_NUMBER)
+
+    # Construct the message
+    message2 = Messagemedia::SOAP::Message.new
+    message2.content = "Content of Message 2 to Recipient 2"
+    message2.delivery_report = true
+    message2.format = Messagemedia::SOAP::FORMAT_SMS
+    message2.validity_period = 1
+    # (Optional) This attribute specifies a sequence number that is assigned to the message and is used to identify the message if an error occurs. Each message error in the response will specify the sequence number of the message that caused the error. Sequence numbers should be unique within the request. 1 to 2147483647.
+    message2.sequence_number = 1
+    # (Optional) This element specifies the message source address. The specified address will be used wherever possible, however due to limitations with various carriers, legislation etc, the final message is not guaranteed to come from the specified address.
+    message2.origin = "Origin_2"
+    message2.add_recipient(234567890, DESTINATION_NUMBER)
+
+    result = client.send_messages([ message1, message2 ])
+    display_result result
+
+end
+
+##
+# Example demonstrates how to get account and credit remaining information.
+#
+def check_user_info
+
+    puts "EXECUTING CHECK USER INFO..."
+
+    client = Messagemedia::SOAP::Client.new(USER_ID, PASSWORD)
+    user_info = client.get_user_info
+
+    account_details = user_info[:account_details]
+    puts "Credit limit: #{account_details[:'@credit_limit']}"
+    puts "Remaining credits: #{account_details[:'@credit_remaining']}"
+    puts "Account type: #{account_details[:'@type']}"
+
+end
+
+##
+# Example demonstrates how to check for replies and to confirm them.
+#
+def check_and_confirm_replies
+
+    puts "EXECUTING CHECK REPLIES..."
+
+    client = Messagemedia::SOAP::Client.new(USER_ID, PASSWORD)
+    replies = client.check_replies
+
+    puts "Remaining replies: #{replies[:'@remaining']}"
+
+    receipt_ids = []
+
+    if not replies[:replies].nil? then
+        replies[:replies].each do |reply|
+            puts "Reply receipt id: #{reply[:'@receipt_id']}"
+            puts "Reply uid: #{reply[:'@uid']}"
+            puts "Reply received date time: #{reply[:received]}"
+            puts "Reply origin: #{reply[:origin]}"
+            puts "Reply content: #{reply[:content]}"
+            puts "Reply format: #{reply[:'@format']}"
+            receipt_ids.push reply[:'@receipt_id']
+        end
+
+        if receipt_ids.length > 0
+            puts "EXECUTING CONFIRM REPLIES..."
+            confirmation = client.confirm_replies(receipt_ids)
+            puts "Replies confirmed: #{confirmation}"
+        end
+    end
+end
+
+##
+# Example demonstrates how to check for delivery reports and to confirm them.
+#
+def check_and_confirm_reports
+
+    puts "EXECUTING CHECK REPORTS..."
+
+    client = Messagemedia::SOAP::Client.new(USER_ID, PASSWORD)
+    replies = client.check_reports
+
+    puts "Remaining replies: #{replies[:'@remaining']}"
+
+    receipt_ids = []
+
+    if not replies[:replies].nil? then
+        replies[:replies].each do |reply|
+            puts "Reply receipt id: #{reply[:receipt_id]}"
+            puts "Reply uid: #{reply[:uid]}"
+            puts "Reply received date time: #{reply[:received]}"
+            puts "Reply origin: #{reply[:origin]}"
+            puts "Reply content: #{reply[:content]}"
+            puts "Reply format: #{reply[:format]}"
+            receipt_ids.push reply[:receipt_id]
+        end
+
+        if receipt_ids > 0
+            puts "EXECUTING CONFIRM REPORTS..."
+            confirmation = client.confirm_replies(receipt_ids)
+            puts "Replies confirmed: #{confirmation}"
+        end
+
+    end
+
+end
+
+check_user_info
+send_message
+check_and_confirm_replies
+check_and_confirm_reports
+
+# For example purposes, sending more than one message is unnecessary. However,
+# if you would like to test sending more than one message as part of a single
+# SOAP request, uncomment the following line of code:
+
+#send_multiple_messages
+
+

data/lib/messagemedia-ruby.rb

@@ -0,0 +1,4 @@
+require 'messagemedia/version'
+require 'messagemedia/soap/recipient'
+require 'messagemedia/soap/message'
+require 'messagemedia/soap/client'

data/lib/messagemedia/soap/client.rb

@@ -0,0 +1,236 @@
+require 'savon'
+
+module Messagemedia
+  module SOAP
+
+    SOAP_ENDPOINT = 'https://soap.m4u.com.au/?wsdl'
+
+    #
+    # This class is a light-weight wrapper around the MessageMedia SOAP API.
+    #
+    class Client
+
+      #
+      # Initialize the SOAP client.
+      #
+      # Your MessageMedia username and password must be provided.
+      #
+      # These credentials will not be authenticated until an actual request
+      # is made using one of the other methods available in this class.
+      #
+      def initialize(username, password, debug = false)
+        # Store the credentials for use with other methods
+        @credentials = {
+            :'api:userId' => username,
+            :'api:password' => password
+        }
+
+        # Create a new Savon-based SOAP client
+        @client = Savon.client(wsdl: SOAP_ENDPOINT, log: debug)
+
+      end
+
+      #
+      # Send a message to a recipient.
+      #
+      # A destination number (destination_number) is required.
+      #
+      # The source number (source_number), message content (content), and
+      # message identifier (messageId) are optional. Optional arguments
+      # may be omitted by providing nil as an argument.
+      #
+      # If a message identifier is provided, then it will be returned as
+      # part of any replies or delivery reports produced as a result of
+      # this message.
+      #
+      # If a source number is not provided, the message will be sent using
+      # the MessageMedia rotary.
+      #
+      def send_message(destination_number, content, message_id, source_number = nil)
+
+        # Construct a Message object to represent the message
+        message = Message.new
+        message.content = content
+        message.delivery_report = true
+        message.format = FORMAT_SMS
+        message.validity_period = 1
+        message.origin = source_number
+        message.add_recipient(message_id, destination_number)
+
+        messages = {
+            :'@sendMode' => "normal",
+            :'api:message' => [message.to_api_hash]
+        }
+
+        body = {
+            :'api:authentication' => @credentials,
+            :'api:requestBody' => {:'api:messages' => messages}
+        }
+
+        # Make a request to the MessageMedia SOAP service. Note that the
+        # message parameter below refers to the body of the SOAP request,
+        # not the message object that we constructed above.
+        response = @client.call(:send_messages, message: body)
+
+        response.body[:send_messages_response][:result]
+      end
+
+      #
+      # Send multiple messages using a single request.
+      #
+      # An array of Message objects must be provided. Unlike the send_message
+      # method, this method requires the Message objects to be constructed
+      # manually.
+      #
+      # Constructing an instance of Message is straight-forward:
+      #   message = Message.new
+      #   message.content = <message content>
+      #   message.delivery_report = <true|false>
+      #   message.format = <FORMAT_SMS|FORMAT_VOICE>
+      #   message.validity_period = 1
+      #   message.origin = <source_number>
+      #   message.add_recipient(<message ID>, <destination number>)
+      #
+      def send_messages(messages)
+        messages = {
+            :'@sendMode' => 'normal',
+            :'api:message' => messages.map { |m| m.to_api_hash }
+        }
+
+        body = {
+            :'api:authentication' => @credentials,
+            :'api:requestBody' => {:'api:messages' => messages}
+        }
+
+        response = @client.call(:send_messages, message: body)
+
+        response.body[:send_messages_response][:result]
+      end
+
+      #
+      # Retrieve the credit info and other metadata that is available for
+      # a MessageMedia account.
+      #
+      def get_user_info
+        body = {
+            :'api:authentication' => @credentials
+        }
+
+        response = @client.call(:check_user, message: body)
+
+        response.body[:check_user_response][:result]
+      end
+
+      #
+      # Check for, and return, the replies that are available.
+      #
+      # A maximum number of replies (max_replies) may be specified, in order
+      # to limit the size of the response.
+      #
+      # Note that the same replies will be returned by subsequent calls to
+      # this method, unless you also call confirm_replies to confirm that
+      # the replies have been received.
+      #
+      def check_replies(max_replies = nil)
+        body = {
+            :'api:authentication' => @credentials,
+            :'api:requestBody' => {}
+        }
+
+        unless max_replies.nil?
+          body[:'api:requestBody'][:'api:maxReplies'] = max_replies
+        end
+
+        response = @client.call(:check_replies, message: body).body[:check_replies_response][:result]
+        if response[:replies]
+          response[:replies] = response[:replies][:reply]
+        else
+          response[:replies] = []
+        end
+
+        response
+      end
+
+      #
+      # Confirm that replies have been received.
+      #
+      # An array of reply IDs (reply_ids) must be provided. Each of the IDs
+      # in this array should correspond to a reply that was received using
+      # the check_replies method.
+      #
+      def confirm_replies(reply_ids)
+        body = {
+            :'api:authentication' => @credentials,
+            :'api:requestBody' => {
+                :'api:replies' => {
+                    :'api:reply' => reply_ids.map do |reply_id|
+                      {:'@receiptId' => reply_id}
+                    end
+                }
+            }
+        }
+
+        response = @client.call(:confirm_replies, message: body)
+
+        response.body[:confirm_replies_response][:result][:'@confirmed']
+      end
+
+      #
+      # Check for, and return, the Delivery Reports that are available.
+      #
+      # A maximum number of reports (max_reports) may be specified, in order
+      # to limit the size of the response.
+      #
+      # Note that the same delivery reports will be returned by subsequent
+      # calls to this method, unless you also call confirm_replies to confirm
+      # that the replies have been received.
+      #
+      # Note also that Delivery Reports are often called Delivery Receipts,
+      # and the terms can be used interchangeably.
+      #
+      def check_reports(max_reports = nil)
+        body = {
+            :'api:authentication' => @credentials,
+            :'api:requestBody' => {}
+        }
+
+        unless max_reports.nil?
+          body[:'api:requestBody'][:'api:maxReports'] = max_reports
+        end
+
+        response = @client.call(:check_reports, message: body).body[:check_reports_response][:result]
+        if response[:reports]
+          response[:reports] = response[:reports][:report]
+        else
+          response[:reports] = []
+        end
+
+        response
+      end
+
+      #
+      # Confirm that Delivery Reports have been received.
+      #
+      # An array of delivery report IDs (report_ids) must be provided. Each
+      # of the IDs in this array should correspond to a Delivery Report that
+      # was received using the check_reports method.
+      #
+      def confirm_reports(report_ids)
+        body = {
+            :'api:authentication' => @credentials,
+            :'api:requestBody' => {
+                :'api:reports' => {
+                    :'api:report' => report_ids.map do |report_id|
+                      {:'@receiptId' => report_id}
+                    end
+                }
+            }
+        }
+
+        response = @client.call(:confirm_reports, message: body)
+
+        response.body[:confirm_reports_response][:result][:'@confirmed']
+      end
+    end
+  end
+end

data/lib/messagemedia/soap/message.rb

@@ -0,0 +1,81 @@
+module Messagemedia
+  module SOAP
+
+    FORMAT_SMS = 'SMS'
+    FORMAT_VOICE = 'voice'
+
+    #
+    # This class is a light-weight wrapper around the message structure used
+    # by the MessageMedia SOAP Client interface.
+    #
+    class Message
+      attr_accessor :sequence_number, :origin, :recipients, :content,
+                    :validity_period, :format, :delivery_report
+
+      #
+      # Initialize an empty Message object
+      #
+      # By default, delivery reports will be enabled, the validity
+      # period will be set to 10 minutes, and the message will be sent as
+      # an SMS.
+      #
+      def initialize
+        @recipients = []
+        @delivery_report = true
+        @validity_period = 1
+        @sequence_number = 0
+        @format = FORMAT_SMS
+      end
+
+      #
+      # Add a recipient.
+      #
+      # An optional message ID (message_id) may be provided. This allows
+      # for the correlation of replies and delivery reports with messages
+      # that have been sent.
+      #
+      # A recipient number (recipient) must be provided.
+      #
+      def add_recipient(message_id, recipient)
+        @recipients.push(Recipient.new(message_id, recipient))
+      end
+
+      #
+      # Return a hash that can be passed to the Savon SOAP library to
+      # represent a message.
+      #
+      def to_api_hash
+        hash = {
+            :'api:content' => @content,
+            :'api:recipients' => {
+                :'api:recipient' => @recipients.map { |r| r.destination_number },
+                :attributes! => {
+                    :'api:recipient' => {
+                        :uid => @recipients.map { |r| r.message_id }
+                    }
+                }
+            }
+        }
+
+        unless @format.nil?
+          hash[:'@format'] = @format
+        end
+        unless @sequence_number.nil?
+          hash[:'@sequenceNumber'] = @sequence_number
+        end
+        unless @delivery_report.nil?
+          hash[:'api:deliveryReport'] = @delivery_report
+        end
+        unless @validity_period.nil?
+          hash[:'api:validityPeriod'] = @validity_period
+        end
+        unless @origin.nil?
+          hash[:'api:origin'] = @origin
+        end
+
+        hash
+      end
+    end
+
+  end
+end

data/lib/messagemedia/soap/recipient.rb

@@ -0,0 +1,27 @@
+module Messagemedia
+  module SOAP
+
+    #
+    # This class is a light-weight wrapper around the Recipient structure used
+    # by the MessageMedia SoapClient interface.
+    #
+    class Recipient
+      attr_accessor :message_id, :destination_number
+
+      #
+      # Initialize an empty Recipient object.
+      #
+      # This object represents a single recipient of a message, and allows
+      # an optional message ID (message_id) to be assigned to the message
+      # that will be sent to that recipient.
+      #
+      # A destination number (destination_number) must be provided
+      #
+      def initialize(message_id, destination_number)
+        @message_id = message_id
+        @destination_number = destination_number
+      end
+
+    end
+  end
+end

data/lib/messagemedia/version.rb

@@ -0,0 +1,3 @@
+module Messagemedia
+  VERSION = '0.7.0'
+end

data/messagemedia-ruby.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require File.dirname(__FILE__) + '/lib/messagemedia/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'messagemedia-ruby'
+  spec.version       = Messagemedia::VERSION
+  spec.authors       = ['Tristan Penman']
+  spec.email         = ['tristan.penman@messagemedia.com.au']
+  spec.summary       = 'Simple Ruby interface for the MessageMedia SOAP API'
+  spec.description   = 'Support for Ruby applications to integrate with the MessageMedia SOAP API'
+  spec.homepage      = 'http://www.messagemedia.com/'
+  spec.license       = 'Apache'
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_dependency 'rake'
+  spec.add_dependency 'savon', '~> 2.4'
+  spec.add_dependency 'test-unit'
+
+end

data/test/test_message.rb

@@ -0,0 +1,46 @@
+require 'test/unit'
+
+require_relative '../lib/messagemedia/soap/recipient'
+require_relative '../lib/messagemedia/soap/message'
+
+class TestMessage < Test::Unit::TestCase
+
+  def test_to_api_hash
+    message = Messagemedia::SOAP::Message.new
+
+    # First test recipient, with a custom message ID
+    message_id_1 = 100
+    recipient_1 = 123456
+    message.add_recipient(message_id_1, recipient_1)
+
+    # Second test recipient, no message ID
+    recipient_2 = 456789
+    message.add_recipient(nil, recipient_2)
+
+    expected_hash = {
+        :'@format' => message.format,
+        :'@sequenceNumber' => message.sequence_number,
+        :'api:deliveryReport' => message.delivery_report,
+        :'api:validityPeriod' => message.validity_period,
+        :'api:content' => message.content,
+        :'api:recipients' => {
+            :'api:recipient' => [
+                recipient_1,
+                recipient_2
+            ],
+            :attributes! => {
+                :'api:recipient' => {
+                    :uid => [
+                        message_id_1,
+                        nil
+                    ]
+                }
+            }
+        }
+    }
+
+    assert_equal(expected_hash, message.to_api_hash)
+
+  end
+
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: messagemedia-ruby
+version: !ruby/object:Gem::Version
+  version: 0.7.0
+platform: ruby
+authors:
+- Tristan Penman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Support for Ruby applications to integrate with the MessageMedia SOAP
+  API
+email:
+- tristan.penman@messagemedia.com.au
+executables:
+- example.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/example.rb
+- lib/messagemedia-ruby.rb
+- lib/messagemedia/soap/client.rb
+- lib/messagemedia/soap/message.rb
+- lib/messagemedia/soap/recipient.rb
+- lib/messagemedia/version.rb
+- messagemedia-ruby.gemspec
+- test/test_message.rb
+homepage: http://www.messagemedia.com/
+licenses:
+- Apache
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Simple Ruby interface for the MessageMedia SOAP API
+test_files:
+- test/test_message.rb