messagemedia_webhooks_sdk 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9927701b5cbe6a65e500841d8fab5e5d232db51f
+  data.tar.gz: 2d493415a68f09ff555371c20515d8e0a9ae7bd9
+SHA512:
+  metadata.gz: 180bc2cfbcb15e9cbc5849d84746fba27016b5f632c3758f6fbe6cfd7f7747dac0c65f64003074ebd0c53806bd616880a2a209c5bb892a829c1b14b7411b1051
+  data.tar.gz: 31ed43df6cee695b070a0b3b03fd44ed4ff82e21bcc49d9786a6f72f69885f286b6029c6ab2c300541ad7c121ccb82eaec838c3309e164ddd4b0102d6e8291f5

data/LICENSE

@@ -0,0 +1,28 @@
+License: 
+========
+The MIT License (MIT)
+http://opensource.org/licenses/MIT
+
+Copyright (c) 2014 - 2016 APIMATIC Limited
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+Trade Mark:
+==========
+APIMATIC is a trade mark for APIMATIC Limited

data/README.md

@@ -0,0 +1,132 @@
+# MessageMedia Webhooks NodeJS SDK
+[![Travis Build Status](https://api.travis-ci.org/messagemedia/webhooks-ruby-sdk.svg?branch=master)](https://travis-ci.org/messagemedia/webhooks-ruby-sdk)
+[![gems version](https://badge.fury.io/js/messagemedia-webhooks-sdk.svg)](https://badge.fury.io/js/messagemedia-webhooks-sdk)
+
+The MessageMedia Webhooks allows you to subscribe to one or several events and when one of those events is triggered, an HTTP request is sent to the URL of your choice along with the message or payload. In simpler terms, it allows applications to "speak" to one another and get notified automatically when something new happens.
+
+## ⭐️ Installing via RubyGems
+Run the following command to install the SDK via RubyGems:
+* `gem install messagemedia-webhooks-sdk`
+
+## 🎬 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.
+
+### 🚀 Create a webhook
+```ruby
+require 'message_media_webhooks'
+require 'pp'
+
+# Configuration parameters and credentials
+basic_auth_user_name = 'API_KEY' # The username to use with basic authentication
+basic_auth_password = 'API_SECRET' # The password to use with basic authentication
+
+client = MessageMediaWebhooks::MessageMediaWebhooksClient.new(
+  basic_auth_user_name: basic_auth_user_name,
+  basic_auth_password: basic_auth_password
+)
+
+webhooks_controller = client.webhooks
+
+body = MessageMediaWebhooks::CreateWebhookRequest.new("http://webhook2.com",
+  "POST",
+  "JSON",
+  nil,
+  ["ENROUTE_DR"],
+  "{\"id\":\"$mtId\",\"status\":\"$statusCode\"}"
+)
+
+result = webhooks_controller.create_webhook(body)
+pp result
+
+```
+
+### 📥 Retrieve all webhooks
+```ruby
+require 'message_media_webhooks'
+require 'pp'
+
+# Configuration parameters and credentials
+basic_auth_user_name = 'API_KEY' # The username to use with basic authentication
+basic_auth_password = 'API_SECRET' # The password to use with basic authentication
+
+client = MessageMediaWebhooks::MessageMediaWebhooksClient.new(
+  basic_auth_user_name: basic_auth_user_name,
+  basic_auth_password: basic_auth_password
+)
+
+webhooks_controller = client.webhooks
+
+page = 0
+page_size = 0
+
+result = webhooks_controller.retrieve_webhook(page, page_size)
+pp result
+
+```
+
+### 🔄 Update a webhook
+You can get a webhook ID by looking at the `id` of each webhook created from the response of the above example.
+```ruby
+require 'message_media_webhooks'
+require 'pp'
+
+# Configuration parameters and credentials
+basic_auth_user_name = 'API_KEY' # The username to use with basic authentication
+basic_auth_password = 'API_SECRET' # The password to use with basic authentication
+
+client = MessageMediaWebhooks::MessageMediaWebhooksClient.new(
+  basic_auth_user_name: basic_auth_user_name,
+  basic_auth_password: basic_auth_password
+)
+
+webhooks_controller = client.webhooks
+
+webhook_id = "WEBHOOK_ID"
+
+body_value = "{
+  \"url\": \"https://myurl.com\",        
+  \"method\": \"POST\",        
+  \"encoding\": \"FORM_ENCODED\",        
+  \"events\": [\"ENROUTE_DR\"],        
+  \"template\": \"{\\\"id\\\":\\\"$mtId\\\", \\\"status\\\":\\\"$statusCode\\\"}\"    
+}";
+
+body = JSON.parse(body_value);
+
+result = webhooks_controller.update_webhook(webhook_id, body)
+pp result
+
+```
+
+### ❌ Delete a webhook
+You can get a webhook ID by looking at the `id` of each webhook created from the response of the retrieve webhooks example.
+```ruby
+require 'message_media_webhooks'
+require 'pp'
+
+# Configuration parameters and credentials
+basic_auth_user_name = 'API_KEY' # The username to use with basic authentication
+basic_auth_password = 'API_SECRET' # The password to use with basic authentication
+
+client = MessageMediaWebhooks::MessageMediaWebhooksClient.new(
+  basic_auth_user_name: basic_auth_user_name,
+  basic_auth_password: basic_auth_password
+)
+
+webhooks_controller = client.webhooks
+
+webhook_id = "WEBHOOK_ID"
+
+webhooks_controller.delete_webhook(webhook_id)
+pp result
+
+```
+
+## 📕 Documentation
+Check out the [full API documentation](DOCUMENTATION.md) for more detailed information.
+
+## 😕 Need help?
+Please contact developer support at developers@messagemedia.com or check out the developer portal at [developers.messagemedia.com](https://developers.messagemedia.com/)
+
+## 📃 License
+Apache License. See the [LICENSE](LICENSE) file.

data/lib/message_media_webhooks.rb

@@ -0,0 +1,39 @@
+
+require 'date'
+require 'json'
+require 'faraday'
+require 'certifi'
+require 'logging'
+
+require_relative 'message_media_webhooks/api_helper.rb'
+require_relative 'message_media_webhooks/message_media_webhooks_client.rb'
+
+# Http
+require_relative 'message_media_webhooks/http/http_call_back.rb'
+require_relative 'message_media_webhooks/http/http_client.rb'
+require_relative 'message_media_webhooks/http/http_method_enum.rb'
+require_relative 'message_media_webhooks/http/http_request.rb'
+require_relative 'message_media_webhooks/http/http_response.rb'
+require_relative 'message_media_webhooks/http/http_context.rb'
+require_relative 'message_media_webhooks/http/faraday_client.rb'
+require_relative 'message_media_webhooks/http/auth/basic_auth.rb'
+
+# Models
+require_relative 'message_media_webhooks/models/base_model.rb'
+require_relative 'message_media_webhooks/models/create_webhook_request.rb'
+require_relative 'message_media_webhooks/models/update_webhook_request.rb'
+
+# Exceptions
+require_relative 'message_media_webhooks/exceptions/api_exception.rb'
+require_relative 'message_media_webhooks/exceptions/update_webhook_400' \
+                 '_response_exception.rb'
+require_relative 'message_media_webhooks/exceptions/retrieve_webhook_400' \
+                 '_response_exception.rb'
+require_relative 'message_media_webhooks/exceptions/create_webhook_400' \
+                 '_response_exception.rb'
+
+require_relative 'message_media_webhooks/configuration.rb'
+
+# Controllers
+require_relative 'message_media_webhooks/controllers/base_controller.rb'
+require_relative 'message_media_webhooks/controllers/webhooks_controller.rb'

data/lib/message_media_webhooks/api_helper.rb

@@ -0,0 +1,272 @@
+
+
+module MessageMediaWebhooks
+  # API utility class
+  class APIHelper
+    # Serializes an array parameter (creates key value pairs).
+    # @param [String] The name of the parameter.
+    # @param [Array] The value of the parameter.
+    # @param [String] The format of the serialization.
+    def self.serialize_array(key, array, formatting: 'indexed')
+      tuples = []
+
+      if formatting == 'unindexed'
+        tuples += array.map { |element| ["#{key}[]", element] }
+      elsif formatting == 'indexed'
+        tuples += array.map.with_index do |element, index|
+          ["#{key}[#{index}]", element]
+        end
+      elsif formatting == 'plain'
+        tuples += array.map { |element| [key, element] }
+      else
+        raise ArgumentError, 'Invalid format provided.'
+      end
+      tuples
+    end
+
+    # Replaces template parameters in the given url.
+    # @param [String] The query string builder to replace the template
+    # parameters.
+    # @param [Hash] The parameters to replace in the url.
+    def self.append_url_with_template_parameters(query_builder, parameters)
+      # perform parameter validation
+      unless query_builder.instance_of? String
+        raise ArgumentError, 'Given value for parameter \"query_builder\" is
+          invalid.'
+      end
+
+      # Return if there are no parameters to replace.
+      return query_builder if parameters.nil?
+
+      # Iterate and append parameters.
+      parameters.each do |key, value|
+        replace_value = ''
+
+        if value.nil?
+          replace_value = ''
+        elsif value.instance_of? Array
+          value.map! { |element| CGI.escape(element.to_s) }
+          replace_value = value.join('/')
+        else
+          replace_value = CGI.escape(value.to_s)
+        end
+
+        # Find the template parameter and replace it with its value.
+        query_builder = query_builder.gsub('{' + key.to_s + '}', replace_value)
+      end
+      query_builder
+    end
+
+    # Appends the given set of parameters to the given query string.
+    # @param [String] The query string builder to add the query parameters to.
+    # @param [Hash] The parameters to append.
+    # @param [String] The format of array parameter serialization.
+    def self.append_url_with_query_parameters(query_builder, parameters,
+                                              array_serialization: 'indexed')
+      # Perform parameter validation.
+      unless query_builder.instance_of? String
+        raise ArgumentError, 'Given value for parameter \"query_builder\"
+          is invalid.'
+      end
+
+      # Return if there are no parameters to replace.
+      return query_builder if parameters.nil?
+
+      parameters.each do |key, value|
+        seperator = query_builder.include?('?') ? '&' : '?'
+        unless value.nil?
+          if value.instance_of? Array
+            value.compact!
+            query_builder += if array_serialization == 'csv'
+                               "#{seperator}#{key}=#{value.map do |element|
+                                 CGI.escape(element.to_s)
+                               end.join(',')}"
+                             elsif array_serialization == 'psv'
+                               "#{seperator}#{key}=#{value.map do |element|
+                                 CGI.escape(element.to_s)
+                               end.join('|')}"
+                             elsif array_serialization == 'tsv'
+                               "#{seperator}#{key}=#{value.map do |element|
+                                 CGI.escape(element.to_s)
+                               end.join("\t")}"
+                             else
+                               "#{seperator}#{APIHelper.serialize_array(
+                                 key, value, formatting: array_serialization
+                               ).map { |k, v| "#{k}=#{CGI.escape(v.to_s)}" }
+                               .join('&')}"
+                             end
+          else
+            query_builder += "#{seperator}#{key}=#{CGI.escape(value.to_s)}"
+          end
+        end
+      end
+      query_builder
+    end
+
+    # Validates and processes the given Url.
+    # @param [String] The given Url to process.
+    # @return [String] Pre-processed Url as string.
+    def self.clean_url(url)
+      # Perform parameter validation.
+      raise ArgumentError, 'Invalid Url.' unless url.instance_of? String
+
+      # Ensure that the urls are absolute.
+      matches = url.match(%r{^(https?:\/\/[^\/]+)})
+      raise ArgumentError, 'Invalid Url format.' if matches.nil?
+
+      # Get the http protocol match.
+      protocol = matches[1]
+
+      # Check if parameters exist.
+      index = url.index('?')
+
+      # Remove redundant forward slashes.
+      query = url[protocol.length...(!index.nil? ? index : url.length)]
+      query.gsub!(%r{\/\/+}, '/')
+
+      # Get the parameters.
+      parameters = !index.nil? ? url[url.index('?')...url.length] : ''
+
+      # Return processed url.
+      protocol + query + parameters
+    end
+
+    # Parses JSON string.
+    # @param [String] A JSON string.
+    def self.json_deserialize(json)
+      return JSON.parse(json)
+    rescue StandardError
+      raise TypeError, 'Server responded with invalid JSON.'
+    end
+
+    # Removes elements with empty values from a hash.
+    # @param [Hash] The hash to clean.
+    def self.clean_hash(hash)
+      hash.delete_if { |_key, value| value.to_s.strip.empty? }
+    end
+
+    # Form encodes a hash of parameters.
+    # @param [Hash] The hash of parameters to encode.
+    # @return [Hash] A hash with the same parameters form encoded.
+    def self.form_encode_parameters(form_parameters)
+      encoded = {}
+      form_parameters.each do |key, value|
+        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, 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
+
+      # Create a form encoded hash for this object.
+      if obj.nil?
+        nil
+      elsif obj.instance_of? Array
+        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 + ']', 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
+
+# Extend types to support to_bool.
+module ToBoolean
+  def to_bool
+    return true if self == true || to_s.strip =~ /^(true|yes|y|1)$/i
+    false
+  end
+end
+
+# Extend NilClass type to support to_bool.
+class NilClass; include ToBoolean; end
+# Extend TrueClass type to support to_bool.
+class TrueClass; include ToBoolean; end
+# Extend FalseClass type to support to_bool.
+class FalseClass; include ToBoolean; end
+# Extend Numeric type to support to_bool.
+class Numeric; include ToBoolean; end
+# Extend String type to support to_bool.
+class String; include ToBoolean; end