messagemedia_messages_sdk 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 64507452df46cd3053f21a48c11d2de7a73a1e75
-  data.tar.gz: bcef3fa3ac201bd1873b3114dd7a3294de9d7001
+  metadata.gz: c1967fd352134b073366c5ebcc98c1fb88800fe5
+  data.tar.gz: 3c457dc2d431cb3f3ff1e3d41a824ff3069233c5
 SHA512:
-  metadata.gz: 208053caf2e5f80b12ccd4e8ca814dce587954e2d1a614036a6cb80a568814324da33c4806b16ea0ea671071338a05176e784c651e188d945e859e49693f0123
-  data.tar.gz: adea3750c6ea3f266bc46d7a3104417f8a9e7f6a08c17600dd594945f1150f6f16086716d93ab78d19cc4bf75db2314fc2c5bef496d54cf76dcdf7597e14abb2
+  metadata.gz: '089c61c24350ad64f69e0d035187e4ad43311299b368d72c2e80b51ebf269394dc19ba02f7ad6b94afbadc1af420e6c2096b8a61e323991e4c4c378e80296cd4'
+  data.tar.gz: 1630fd4caa437af32a658d1b72a5250e3df0c108a63dc912971eef0239ec31095581d2daa82e7133a9fea653623f2f16eef31de612996fe284ea320aa3cc61b7

data/LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright [yyyy] [name of copyright owner]
+   Copyright 2018 MessageMedia
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

data/README.md

@@ -1,108 +1,293 @@
+
 # MessageMedia Messages Ruby SDK
-[![Travis Build Status](https://api.travis-ci.org/messagemedia/messages-ruby-sdk.svg?branch=master)](https://travis-ci.org/messagemedia/messages-ruby-sdk)
-[![gem](https://img.shields.io/badge/gem-v1.1.0-red.svg)](https://rubygems.org/gems/messagemedia_messages_sdk)
+[![Pull Requests Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat)](http://makeapullrequest.com)
+[![HitCount](http://hits.dwyl.io/messagemedia/messages-ruby-sdk.svg)](http://hits.dwyl.io/messagemedia/messages-ruby-sdk)
+[![gem](https://badge.fury.io/rb/messagemedia_messages_sdk.svg)](https://rubygems.org/gems/messagemedia_messages_sdk)
 
 The MessageMedia Messages API provides a number of endpoints for building powerful two-way messaging applications.
 
-![Alt Text](https://media.giphy.com/media/l0Exov2QmxF5Xwjkc/giphy.gif)
+![Isometric](https://i.imgur.com/jJeHwf5.png)
+
+## Table of Contents
+* [Authentication](#closed_lock_with_key-authentication)
+* [Errors](#interrobang-errors)
+* [Information](#newspaper-information)
+  * [Slack and Mailing List](#slack-and-mailing-list)
+  * [Bug Reports](#bug-reports)
+  * [Contributing](#contributing)
+* [Installation](#star-installation)
+* [Get Started](#clapper-get-started)
+* [API Documentation](#closed_book-api-documentation)
+* [Need help?](#confused-need-help)
+* [License](#page_with_curl-license)
+
+## :closed_lock_with_key: Authentication
+
+Authentication is done via API keys. Sign up at https://developers.messagemedia.com/register/ to get your API keys.
+
+Requests are authenticated using HTTP Basic Auth or HMAC. For Basic Auth, your API key will be basicAuthUserName and API secret will be basicAuthPassword. For HMAC, your API key will be hmacAuthUserName and API secret will be hmacAuthPassword. This is demonstrated in the [Send an SMS example](https://github.com/messagemedia/messages-ruby-sdk/blob/master/README.md#send-an-sms) below.
+
+## :interrobang: Errors
+
+Our API returns standard HTTP success or error status codes. For errors, we will also include extra information about what went wrong encoded in the response as JSON. The most common status codes are listed below.
+
+#### HTTP Status Codes
+
+| Code      | Title       | Description |
+|-----------|-------------|-------------|
+| 400 | Invalid Request | The request was invalid |
+| 401 | Unauthorized | Your API credentials are invalid |
+| 403 | Disabled feature | Feature not enabled |
+| 404 | Not Found |	The resource does not exist |
+| 50X | Internal Server Error | An error occurred with our API |
+
+## :newspaper: Information
+
+#### Slack and Mailing List
+
+If you have any questions, comments, or concerns, please join our Slack channel:
+https://developers.messagemedia.com/collaborate/slack/
+
+Alternatively you can email us at:
+developers@messagemedia.com
+
+#### Bug reports
+
+If you discover a problem with the SDK, we would like to know about it. You can raise an [issue](https://github.com/messagemedia/signingkeys-nodejs-sdk/issues) or send an email to: developers@messagemedia.com
 
-## ⭐️ Install via .gem file
-* Download [messagemedia_messages_sdk-1.0.0.gem](https://github.com/messagemedia/messages-ruby-sdk/releases/download/v1.0.0/messagemedia_messages_sdk-1.0.0.gem)
-run `gem install messagemedia_messages_sdk-1.0.0.gem`
+#### Contributing
 
-## 🎬 Get Started
+We welcome your thoughts on how we could best provide you with SDKs that would simplify how you consume our services in your application. You can fork and create pull requests for any features you would like to see or raise an [issue](https://github.com/messagemedia/messages-nodejs-sdk/issues). Please be aware that a large share of the files are auto-generated by our backend tool.
+
+## :star Installation
+* Run the following command to install the SDK via RubyGems:
+```
+gem install messagemedia_messages_sdk
+```
+
+## :clapper: Get Started
 It's easy to get started. Simply enter the API Key and secret you obtained from the [MessageMedia Developers Portal](https://developers.messagemedia.com) into the code snippet below and a mobile number you wish to send to.
 
-### 🚀 Send an SMS
-* Destination numbers (`destination_number`) should be in the [E.164](http://en.wikipedia.org/wiki/E.164) format. For example, `+61491570156`.
+### Send an SMS
+Destination (`destinationNumber`) and source number (`sourceNumber`) should be in the [E.164](http://en.wikipedia.org/wiki/E.164) format. For example, `+61491570156` NOT `0491570156`. The code snippet below comprises of only the bare minimum parameters required to send a message. You can view the full list of parameters over [here](https://github.com/messagemedia/messages-ruby-sdk/wiki/Message-Body-Parameters). Alternatively, you can refer [this](https://github.com/messagemedia/messages-ruby-sdk/blob/master/examples/sendMessage.rb) code snippet with all the parameters in use.
+
+```ruby
+require 'message_media_messages'
+require 'pp'
+
+include MessageMediaMessages
+
+auth_user_name = 'API_KEY'
+auth_password = 'API_SECRET'
+use_hmac = false
+
+client = MessageMediaMessages::MessageMediaMessagesClient.new(
+    auth_user_name: auth_user_name,
+    auth_password: auth_password,
+    use_hmac_authentication: use_hmac
+)
+
+messages_controller = client.messages
+body = SendMessagesRequest.new
+body.messages = []
+
+body.messages[0] = Message.new
+body.messages[0].content = 'My first message'
+body.messages[0].destination_number = '+61491570156'
+
+begin
+  result = messages_controller.send_messages(body)
+  pp result
+rescue SendMessages400ResponseException => ex
+  puts "Caught SendMessages400ResponseException: #{ex.message}"
+rescue APIException => ex
+  puts "Caught APIException: #{ex.message}"
+end
+```
+
+## Send an MMS
+Destination (`destinationNumber`) and source number (`sourceNumber`) should be in the [E.164](http://en.wikipedia.org/wiki/E.164) format. For example, `+61491570156` NOT `0491570156`. The code snippet below comprises of only the bare minimum parameters required to send a message. You can view the full list of parameters over [here](https://github.com/messagemedia/messages-ruby-sdk/wiki/Message-Body-Parameters). Alternatively, you can refer [this](https://github.com/messagemedia/messages-ruby-sdk/blob/master/examples/sendMessage.rb) code snippet with all the parameters in use.
+
 ```ruby
 require 'message_media_messages'
+require 'pp'
 
-# Configuration parameters and credentials
-basic_auth_user_name = 'YOUR_API_KEY' # The username to use with basic authentication
-basic_auth_password = 'YOUR_API_SECRET' # The password to use with basic authentication
+include MessageMediaMessages
+
+auth_user_name = 'API_KEY'
+auth_password = 'API_SECRET'
+use_hmac = false
 
 client = MessageMediaMessages::MessageMediaMessagesClient.new(
-  basic_auth_user_name: basic_auth_user_name,
-  basic_auth_password: basic_auth_password
+    auth_user_name: auth_user_name,
+    auth_password: auth_password,
+    use_hmac_authentication: use_hmac
 )
 
-messages = client.messages
-body_value = '{
-   "messages":[
-      {
-         "content":"My first message",
-         "destination_number":"YOUR_MOBILE_NUMBER"
-      }
-   ]
-}';
+messages_controller = client.messages
+body = SendMessagesRequest.new
+body.messages = []
 
-body = JSON.parse(body_value);
+body.messages[0] = Message.new
+body.messages[0].content = 'My second message'
+body.messages[0].destination_number = '+61491570158'
+body.messages[0].format = FormatEnum::MMS
+body.messages[0].media = ['https://images.pexels.com/photos/1018350/pexels-photo-1018350.jpeg?cs=srgb&dl=architecture-buildings-city-1018350.jpg']
+body.messages[0].subject = 'This is an MMS message'
 
-result = messages.create_send_messages(body)
+begin
+  result = messages_controller.send_messages(body)
+  pp result
+rescue SendMessages400ResponseException => ex
+  puts "Caught SendMessages400ResponseException: #{ex.message}"
+rescue APIException => ex
+  puts "Caught APIException: #{ex.message}"
+end
 ```
 
-### 🕓 Get Status of a Message
+### Get Status of a Message
 You can get a messsage ID from a sent message by looking at the `message_id` from the response of the above example.
 ```ruby
 require 'message_media_messages'
+require 'pp'
+
+include MessageMediaMessages
 
-# Configuration parameters and credentials
-basic_auth_user_name = 'YOUR_API_KEY' # The username to use with basic authentication
-basic_auth_password = 'YOUR_API_SECRET' # The password to use with basic authentication
+auth_user_name = 'API_KEY'
+auth_password = 'API_SECRET'
+use_hmac = false
 
 client = MessageMediaMessages::MessageMediaMessagesClient.new(
-  basic_auth_user_name: basic_auth_user_name,
-  basic_auth_password: basic_auth_password
+    auth_user_name: auth_user_name,
+    auth_password: auth_password,
+    use_hmac_authentication: use_hmac
 )
 
-messages = client.messages
-message_id = 'YOUR_MESSAGE_ID'
+messages_controller = client.messages
+message_id = '877c19ef-fa2e-4cec-827a-e1df9b5509f7'
 
-result = messages.get_message_status(message_id)
-print result
+begin
+  result = messages_controller.get_message_status(message_id)
+  pp result
+rescue APIException => ex
+  puts "Caught APIException: #{ex.message}"
+end
 ```
 
-### 💬 Get replies to a message
+### Get replies to a message
 You can check for replies that are sent to your messages
 ```ruby
 require 'message_media_messages'
+require 'pp'
 
-# Configuration parameters and credentials
-basic_auth_user_name = 'YOUR_API_KEY' # The username to use with basic authentication
-basic_auth_password = 'YOUR_API_SECRET' # The password to use with basic authentication
+include MessageMediaMessages
+
+auth_user_name = 'API_KEY'
+auth_password = 'API_SECRET'
+use_hmac = false
 
 client = MessageMediaMessages::MessageMediaMessagesClient.new(
-  basic_auth_user_name: basic_auth_user_name,
-  basic_auth_password: basic_auth_password
+    auth_user_name: auth_user_name,
+    auth_password: auth_password,
+    use_hmac_authentication: use_hmac
 )
 
-replies = client.replies
-
-result = replies.get_check_replies()
+replies_controller = client.replies
+begin
+  result = replies_controller.check_replies()
+  pp replies
+rescue APIException => ex
+  puts "Caught APIException: #{ex.message}"
+end
 ```
 
-### ✅ Check Delivery Reports
+### Check Delivery Reports
 This endpoint allows you to check for delivery reports to inbound and outbound messages.
 ```ruby
 require 'message_media_messages'
+require 'pp'
 
-# Configuration parameters and credentials
-basic_auth_user_name = 'YOUR_API_KEY' # The username to use with basic authentication
-basic_auth_password = 'YOUR_API_SECRET' # The password to use with basic authentication
+auth_user_name = 'API_KEY'
+auth_password = 'API_SECRET'
+use_hmac = false
 
 client = MessageMediaMessages::MessageMediaMessagesClient.new(
-  basic_auth_user_name: basic_auth_user_name,
-  basic_auth_password: basic_auth_password
+    auth_user_name: auth_user_name,
+    auth_password: auth_password,
+    use_hmac_authentication: use_hmac
 )
 
-deliveryReports = client.delivery_reports
+delivery_reports_controller = client.delivery_reports
+begin
+  result = delivery_reports_controller.check_delivery_reports()
+  pp result
+rescue APIException => ex
+  puts "Caught APIException: #{ex.message}"
+end
+```
+
+### Confirm Delivery Reports
+This endpoint allows you to mark delivery reports as confirmed so they're no longer returned by the Check Delivery Reports function.
+```ruby
+require 'message_media_messages'
+require 'pp'
 
-result = deliveryReports.get_check_delivery_reports()
+include MessageMediaMessages
+
+auth_user_name = 'API_KEY'
+auth_password = 'API_SECRET'
+use_hmac = false
+
+client = MessageMediaMessages::MessageMediaMessagesClient.new(
+    auth_user_name: auth_user_name,
+    auth_password: auth_password,
+    use_hmac_authentication: use_hmac
+)
+
+delivery_reports_controller = client.delivery_reports
+body = ConfirmDeliveryReportsAsReceivedRequest.new
+body.delivery_report_ids = ['011dcead-6988-4ad6-a1c7-6b6c68ea628d', '3487b3fa-6586-4979-a233-2d1b095c7718', 'ba28e94b-c83d-4759-98e7-ff9c7edb87a1']
+
+begin
+  result = delivery_reports_controller.confirm_delivery_reports_as_received(body)
+  pp result
+rescue APIException => ex
+  puts "Caught APIException: #{ex.message}"
+end
+```
+
+###  Check credits remaining (Prepaid accounts only)
+This endpoint allows you to check for credits remaining on your prepaid account.
+```ruby
+require 'message_media_messages'
+require 'pp'
+
+include MessageMediaMessages
+
+auth_user_name = 'API_KEY'
+auth_password = 'API_SECRET'
+use_hmac = false
+
+client = MessageMediaMessages::MessageMediaMessagesClient.new(
+    auth_user_name: auth_user_name,
+    auth_password: auth_password,
+    use_hmac_authentication: use_hmac
+)
+
+messages_controller = client.messages
+begin
+  result = messages_controller.check_credits_remaining()
+  pp result
+rescue APIException => ex
+  puts "Caught APIException: #{ex.message}"
+end
 ```
 
-## 📕 Documentation
-The Ruby SDK Documentation can be viewed [here](DOCUMENTATION.md)
+## :closed_book: API Reference Documentation
+Check out the [full API documentation](https://developers.messagemedia.com/code/messages-api-documentation/) for more detailed information.
 
-## 😕 Got Stuck?
+## :confused: Need help?
 Please contact developer support at developers@messagemedia.com or check out the developer portal at [developers.messagemedia.com](https://developers.messagemedia.com/)
+
+## :page_with_curl: License
+Apache License. See the [LICENSE](LICENSE) file.

data/lib/message_media_messages.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 'date'
 require 'json'
 require 'faraday'
@@ -17,34 +20,45 @@ require_relative 'message_media_messages/http/http_request.rb'
 require_relative 'message_media_messages/http/http_response.rb'
 require_relative 'message_media_messages/http/http_context.rb'
 require_relative 'message_media_messages/http/faraday_client.rb'
-require_relative 'message_media_messages/http/auth/basic_auth.rb'
-require_relative 'message_media_messages/http/auth/hmac_auth.rb'
-
+require_relative 'message_media_messages/http/auth/auth_manager.rb'
 # Models
 require_relative 'message_media_messages/models/base_model.rb'
-require_relative 'message_media_messages/models' \
-                 '/check_delivery_reports_response.rb'
-require_relative 'message_media_messages/models' \
-                 '/confirm_replies_as_received_request_8.rb'
-require_relative 'message_media_messages/models' \
-                 '/confirm_replies_as_received_request.rb'
+require_relative 'message_media_messages/models/confirm_delivery_reports_as' \
+                 '_received_request1.rb'
+require_relative 'message_media_messages/models/confirm_delivery_reports_as' \
+                 '_received_request.rb'
+require_relative 'message_media_messages/models/check_delivery_reports' \
+                 '_response.rb'
+require_relative 'message_media_messages/models/confirm_replies_as_received' \
+                 '_request1.rb'
+require_relative 'message_media_messages/models/confirm_replies_as_received' \
+                 '_request.rb'
+require_relative 'message_media_messages/models/vendor_account_id.rb'
 require_relative 'message_media_messages/models/check_replies_response.rb'
-require_relative 'message_media_messages/models' \
-                 '/cancel_scheduled_message_request.rb'
-require_relative 'message_media_messages/models/send_messages_response.rb'
+require_relative 'message_media_messages/models/cancel_scheduled_message' \
+                 '_request.rb'
 require_relative 'message_media_messages/models/send_messages_request.rb'
-require_relative 'message_media_messages/models' \
-                 '/confirm_delivery_reports_as_received_request.rb'
-require_relative 'message_media_messages/models' \
-                 '/confirm_delivery_reports_as_received_request_11.rb'
+require_relative 'message_media_messages/models/reply.rb'
+require_relative 'message_media_messages/models/delivery_report.rb'
+require_relative 'message_media_messages/models/get_message_status_response.rb'
+require_relative 'message_media_messages/models/message.rb'
+require_relative 'message_media_messages/models/send_messages_response.rb'
+require_relative 'message_media_messages/models/source_number_type_enum.rb'
+require_relative 'message_media_messages/models/status2_enum.rb'
+require_relative 'message_media_messages/models/status_enum.rb'
+require_relative 'message_media_messages/models/format1_enum.rb'
+require_relative 'message_media_messages/models/format_enum.rb'
 
 # Exceptions
 require_relative 'message_media_messages/exceptions/api_exception.rb'
+require_relative 'message_media_messages/exceptions/send_messages400_response' \
+                 '_exception.rb'
 
 require_relative 'message_media_messages/configuration.rb'
 
 # Controllers
 require_relative 'message_media_messages/controllers/base_controller.rb'
 require_relative 'message_media_messages/controllers/messages_controller.rb'
-require_relative 'message_media_messages/controllers/delivery_reports_controller.rb'
+require_relative 'message_media_messages/controllers/delivery_reports' \
+                 '_controller.rb'
 require_relative 'message_media_messages/controllers/replies_controller.rb'

data/lib/message_media_messages/api_helper.rb

@@ -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
   # API utility class
-  # noinspection RubyClassMethodNamingConvention
   class APIHelper
     # Serializes an array parameter (creates key value pairs).
     # @param [String] The name of the parameter.
@@ -42,6 +43,8 @@ module MessageMediaMessages
 
       # Iterate and append parameters.
       parameters.each do |key, value|
+        replace_value = ''
+
         if value.nil?
           replace_value = ''
         elsif value.instance_of? Array
@@ -88,7 +91,7 @@ module MessageMediaMessages
                              elsif array_serialization == 'tsv'
                                "#{seperator}#{key}=#{value.map do |element|
                                  CGI.escape(element.to_s)
-                               end.join('\t')}"
+                               end.join("\t")}"
                              else
                                "#{seperator}#{APIHelper.serialize_array(
                                  key, value, formatting: array_serialization
@@ -151,19 +154,52 @@ module MessageMediaMessages
     def self.form_encode_parameters(form_parameters)
       encoded = {}
       form_parameters.each do |key, value|
-        encoded.merge!(APIHelper.form_encode(value, key))
+        encoded.merge!(APIHelper.form_encode(value, key, formatting:
+          Configuration.array_serialization))
       end
       encoded
     end
 
+    def self.custom_merge(a, b)
+      x = {}
+      a.each do |key, value_a|
+        b.each do |k, value_b|
+          next unless key == k
+          x[k] = []
+          if value_a.instance_of? Array
+            value_a.each do |v|
+              x[k].push(v)
+            end
+          else
+            x[k].push(value_a)
+          end
+          if value_b.instance_of? Array
+            value_b.each do |v|
+              x[k].push(v)
+            end
+          else
+            x[k].push(value_b)
+          end
+          a.delete(k)
+          b.delete(k)
+        end
+      end
+      x.merge!(a)
+      x.merge!(b)
+      x
+    end
+
     # Form encodes an object.
     # @param [Dynamic] An object to form encode.
     # @param [String] The name of the object.
     # @return [Hash] A form encoded representation of the object in the form
     # of a hash.
-    def self.form_encode(obj, instance_name)
+    def self.form_encode(obj, instance_name, formatting: 'indexed')
       retval = {}
 
+      serializable_types = [String, Numeric, TrueClass,
+                            FalseClass, Date, DateTime]
+
       # If this is a structure, resolve it's field names.
       obj = obj.to_hash if obj.is_a? BaseModel
 
@@ -171,20 +207,51 @@ module MessageMediaMessages
       if obj.nil?
         nil
       elsif obj.instance_of? Array
-        obj.each_with_index do |value, index|
-          retval.merge!(APIHelper.form_encode(value, instance_name + '[' +
-            index.to_s + ']'))
+        if formatting == 'indexed'
+          obj.each_with_index do |value, index|
+            retval.merge!(APIHelper.form_encode(value, instance_name + '[' +
+              index.to_s + ']'))
+          end
+        elsif serializable_types.map { |x| obj[0].is_a? x }.any?
+          obj.each do |value|
+            abc = if formatting == 'unindexed'
+                    APIHelper.form_encode(value, instance_name + '[]',
+                                          formatting: formatting)
+                  else
+                    APIHelper.form_encode(value, instance_name,
+                                          formatting: formatting)
+                  end
+            retval = APIHelper.custom_merge(retval, abc)
+            # print retval
+          end
+        else
+          obj.each_with_index do |value, index|
+            retval.merge!(APIHelper.form_encode(value, instance_name + '[' +
+              index.to_s + ']', formatting: formatting))
+          end
         end
       elsif obj.instance_of? Hash
         obj.each do |key, value|
           retval.merge!(APIHelper.form_encode(value, instance_name + '[' +
-            key + ']'))
+            key + ']', formatting: formatting))
         end
       else
         retval[instance_name] = obj
       end
       retval
     end
+
+    # Safely converts a string into an rfc3339 DateTime object
+    # @param [String] The datetime string
+    # @return [DateTime] A DateTime object of rfc3339 format
+    def self.rfc3339(date_time)
+      # missing timezone information
+      if date_time.end_with?('Z') || date_time.index('+')
+        DateTime.rfc3339(date_time)
+      else
+        DateTime.rfc3339(date_time + 'Z')
+      end
+    end
   end
 end