messagemedia_webhooks_sdk 1.0.0

data/lib/message_media_webhooks/models/create_webhook_request.rb

@@ -0,0 +1,76 @@
+
+module MessageMediaWebhooks
+  # CreateWebhookRequest Model.
+  class CreateWebhookRequest < BaseModel
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :url
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :method
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :encoding
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    attr_accessor :headers
+
+    # TODO: Write general description for this method
+    # @return [List of String]
+    attr_accessor :events
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :template
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['url'] = 'url'
+      @_hash['method'] = 'method'
+      @_hash['encoding'] = 'encoding'
+      @_hash['headers'] = 'headers'
+      @_hash['events'] = 'events'
+      @_hash['template'] = 'template'
+      @_hash
+    end
+
+    def initialize(url = nil,
+                   method = nil,
+                   encoding = nil,
+                   headers = nil,
+                   events = nil,
+                   template = nil)
+      @url = url
+      @method = method
+      @encoding = encoding
+      @headers = headers
+      @events = events
+      @template = template
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      url = hash['url']
+      method = hash['method']
+      encoding = hash['encoding']
+      headers = hash['headers']
+      events = hash['events']
+      template = hash['template']
+
+      # Create object from extracted values.
+      CreateWebhookRequest.new(url,
+                               method,
+                               encoding,
+                               headers,
+                               events,
+                               template)
+    end
+  end
+end

data/lib/message_media_webhooks/models/update_webhook_request.rb

@@ -0,0 +1,67 @@
+
+module MessageMediaWebhooks
+  # UpdateWebhookRequest Model.
+  class UpdateWebhookRequest < BaseModel
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :url
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :method
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :encoding
+
+    # TODO: Write general description for this method
+    # @return [List of String]
+    attr_accessor :events
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :template
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['url'] = 'url'
+      @_hash['method'] = 'method'
+      @_hash['encoding'] = 'encoding'
+      @_hash['events'] = 'events'
+      @_hash['template'] = 'template'
+      @_hash
+    end
+
+    def initialize(url = nil,
+                   method = nil,
+                   encoding = nil,
+                   events = nil,
+                   template = nil)
+      @url = url
+      @method = method
+      @encoding = encoding
+      @events = events
+      @template = template
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      url = hash['url']
+      method = hash['method']
+      encoding = hash['encoding']
+      events = hash['events']
+      template = hash['template']
+
+      # Create object from extracted values.
+      UpdateWebhookRequest.new(url,
+                               method,
+                               encoding,
+                               events,
+                               template)
+    end
+  end
+end

data/test/controllers/controller_test_base.rb

@@ -0,0 +1,30 @@
+
+require 'json'
+require 'test/unit'
+require 'message_media_webhooks.rb'
+require_relative '../test_helper.rb'
+require_relative '../http_response_catcher.rb'
+
+class ControllerTestBase < Test::Unit::TestCase
+  include MessageMediaWebhooks
+
+  class << self
+    attr_accessor :controller
+  end
+
+  # Called only once for a test class before any test has executed.
+  def self.startup
+    @@api_client = MessageMediaWebhooksClient.new
+    @@request_timeout = 30
+    @@assert_precision = 0.01
+
+    Configuration.basic_auth_user_name = ENV['MessageMediaApiTestsKey']
+    Configuration.basic_auth_password = ENV['MessageMediaApiTestsSecret']
+  end
+
+  # Called once before every test case.
+  def setup
+    @response_catcher = HttpResponseCatcher.new
+    self.class.controller.http_call_back = @response_catcher
+  end
+end

data/test/controllers/test_webhooks_controller.rb

@@ -0,0 +1,56 @@
+
+require_relative 'controller_test_base'
+
+class WebhooksControllerTests < ControllerTestBase
+  # Called only once for the class before any test has executed
+  def self.startup
+    self.controller = @@api_client.webhooks
+  end
+
+  # Delete a webhook that was previously created for the connected account.
+  #A webhook can be cancelled by appending the UUID of the webhook to the endpoint and submitting a DELETE request to the /webhooks/messages endpoint.
+  #*Note: Only pre-created webhooks can be deleted. If an invalid or non existent webhook ID parameter is specified in the request, then a HTTP 404 Not Found response will be returned.*
+  def test_delete_webhook_1()
+    # Parameters for the API call
+    webhook_id = 'a7f11bb0-f299-4861-a5ca-9b29d04bc5ad'
+
+    # Perform the API call through the SDK function
+    self.class.controller.delete_webhook(webhook_id)
+
+    # Test response code
+    assert_equal(@response_catcher.response.status_code, 204)
+  end
+
+  # Update a webhook. You can update individual attributes or all of them by submitting a PATCH request to the /webhooks/messages endpoint (the same endpoint used above to delete a webhook)
+  #A successful request to the retrieve webhook endpoint will return a response body as follows:
+  #```
+  #{
+  #    "url": "https://webhook.com",
+  #    "method": "POST",
+  #    "id": "04442623-0961-464e-9cbc-ec50804e0413",
+  #    "encoding": "JSON",
+  #    "events": [
+  #        "RECEIVED_SMS"
+  #    ],
+  #    "headers": {},
+  #    "template": "{\"id\":\"$mtId\", \"status\":\"$statusCode\"}"
+  #}
+  #```
+  #*Note: Only pre-created webhooks can be deleted. If an invalid or non existent webhook ID parameter is specified in the request, then a HTTP 404 Not Found response will be returned.*
+  def test_update_webhook_1()
+    # Parameters for the API call
+    webhook_id = 'a7f11bb0-f299-4861-a5ca-9b29d04bc5ad'
+    body = UpdateWebhookRequest.from_hash(JSON.parse(
+      '{"url":"https://myurl.com","method":"POST","encoding":"FORM_ENCODED","event'\
+      's":["ENROUTE_DR"],"template":"{\\"id\\":\\"$mtId\\", \\"status\\":\\"$statu'\
+      'sCode\\"}"}'
+      ))
+
+    # Perform the API call through the SDK function
+    result = self.class.controller.update_webhook(webhook_id, body)
+
+    # Test response code
+    assert_equal(@response_catcher.response.status_code, 200)
+  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 < MessageMediaWebhooks::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,155 @@
+--- !ruby/object:Gem::Specification
+name: messagemedia_webhooks_sdk
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- MessageMedia Developers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-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.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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 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.
+email: developers@messagemedia.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/message_media_webhooks.rb
+- lib/message_media_webhooks/api_helper.rb
+- lib/message_media_webhooks/configuration.rb
+- lib/message_media_webhooks/controllers/base_controller.rb
+- lib/message_media_webhooks/controllers/webhooks_controller.rb
+- lib/message_media_webhooks/exceptions/api_exception.rb
+- lib/message_media_webhooks/exceptions/create_webhook_400_response_exception.rb
+- lib/message_media_webhooks/exceptions/retrieve_webhook_400_response_exception.rb
+- lib/message_media_webhooks/exceptions/update_webhook_400_response_exception.rb
+- lib/message_media_webhooks/http/auth/basic_auth.rb
+- lib/message_media_webhooks/http/faraday_client.rb
+- lib/message_media_webhooks/http/http_call_back.rb
+- lib/message_media_webhooks/http/http_client.rb
+- lib/message_media_webhooks/http/http_context.rb
+- lib/message_media_webhooks/http/http_method_enum.rb
+- lib/message_media_webhooks/http/http_request.rb
+- lib/message_media_webhooks/http/http_response.rb
+- lib/message_media_webhooks/message_media_webhooks_client.rb
+- lib/message_media_webhooks/models/base_model.rb
+- lib/message_media_webhooks/models/create_webhook_request.rb
+- lib/message_media_webhooks/models/update_webhook_request.rb
+- test/controllers/controller_test_base.rb
+- test/controllers/test_webhooks_controller.rb
+- test/http_response_catcher.rb
+- test/test_helper.rb
+homepage: https://developers.messagemedia.com
+licenses:
+- Apache-2.0
+metadata: {}
+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.5.2
+signing_key: 
+specification_version: 4
+summary: message_media_webhooks
+test_files: []