messagemedia_lookups_sdk 1.0.0

data/lib/message_media_lookups/http/http_context.rb

@@ -0,0 +1,16 @@
+
+module MessageMediaLookups
+  # Represents an Http call in context.
+  class HttpContext
+    attr_accessor :request, :response
+
+    # The constructor.
+    # @param [HttpRequest] An HttpRequest object representing the HTTP request.
+    # @param [HttpResponse] An HttpResponse object representing the HTTP
+    # response.
+    def initialize(request, response)
+      @request = request
+      @response = response
+    end
+  end
+end

data/lib/message_media_lookups/http/http_method_enum.rb

@@ -0,0 +1,9 @@
+
+module MessageMediaLookups
+  # HTTP Methods Enumeration.
+  class HttpMethodEnum
+    HTTPMETHODENUM = [GET = 'GET'.freeze, POST = 'POST'.freeze,
+                      PUT = 'PUT'.freeze, PATCH = 'PATCH'.freeze,
+                      DELETE = 'DELETE'.freeze].freeze
+  end
+end

data/lib/message_media_lookups/http/http_request.rb

@@ -0,0 +1,46 @@
+
+module MessageMediaLookups
+  # Represents a single Http Request.
+  class HttpRequest
+    attr_accessor :http_method, :query_url, :headers,
+                  :parameters, :username, :password
+
+    # The constructor.
+    # @param [HttpMethodEnum] The HTTP method.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    # @param [Hash, Optional] The parameters for the HTTP Request.
+    def initialize(http_method,
+                   query_url,
+                   headers: {},
+                   parameters: {})
+      @http_method = http_method
+      @query_url = query_url
+      @headers = headers
+      @parameters = parameters
+    end
+
+    # Add a header to the HttpRequest.
+    # @param [String] The name of the header.
+    # @param [String] The value of the header.
+    def add_header(name, value)
+      @headers[name] = value
+    end
+
+    # Add a parameter to the HttpRequest.
+    # @param [String] The name of the parameter.
+    # @param [String] The value of the parameter.
+    def add_parameter(name, value)
+      @parameters[name] = value
+    end
+
+    # Add a query parameter to the HttpRequest.
+    # @param [String] The name of the query parameter.
+    # @param [String] The value of the query parameter.
+    def add_query_parameter(name, value)
+      @query_url = APIHelper.append_url_with_query_parameters(@query_url,
+                                                              name => value)
+      @query_url = APIHelper.clean_url(@query_url)
+    end
+  end
+end

data/lib/message_media_lookups/http/http_response.rb

@@ -0,0 +1,19 @@
+
+module MessageMediaLookups
+  # Http response received.
+  class HttpResponse
+    attr_accessor :status_code, :headers, :raw_body
+
+    # The constructor
+    # @param [Integer] The status code returned by the server.
+    # @param [Hash] The headers sent by the server in the response.
+    # @param [String] The raw body of the response.
+    def initialize(status_code,
+                   headers,
+                   raw_body)
+      @status_code = status_code
+      @headers = headers
+      @raw_body = raw_body
+    end
+  end
+end

data/lib/message_media_lookups/message_media_lookups_client.rb

@@ -0,0 +1,28 @@
+
+module MessageMediaLookups
+  #  message_media_lookups client class.
+  class MessageMediaLookupsClient
+    # Singleton access to lookups controller.
+    # @return [LookupsController] Returns the controller instance.
+    def lookups
+      LookupsController.instance
+    end
+
+    # Returns the configuration class for easy access.
+    # @return [Configuration] Returns the actual configuration class.
+    def config
+      Configuration
+    end
+
+    # Initializer with authentication and configuration parameters.
+    def initialize(auth_user_name: nil, auth_password: nil, use_hmac: false)
+      if (use_hmac == false)
+        Configuration.basic_auth_user_name = auth_user_name
+        Configuration.basic_auth_password = auth_password
+      else
+        Configuration.hmac_auth_user_name = auth_user_name
+        Configuration.hmac_auth_password = auth_password
+      end
+    end
+  end
+end

data/lib/message_media_lookups/models/base_model.rb

@@ -0,0 +1,32 @@
+
+module MessageMediaLookups
+  # Base model.
+  class BaseModel
+    # Returns a Hash representation of the current object.
+    def to_hash
+      hash = {}
+      instance_variables.each do |name|
+        value = instance_variable_get(name)
+        name = name[1..-1]
+        key = self.class.names.key?(name) ? self.class.names[name] : name
+        if value.instance_of? Array
+          hash[key] = value.map { |v| v.is_a?(BaseModel) ? v.to_hash : v }
+        elsif value.instance_of? Hash
+          hash[key] = {}
+          value.each do |k, v|
+            hash[key][k] = v.is_a?(BaseModel) ? v.to_hash : v
+          end
+        else
+          hash[key] = value.is_a?(BaseModel) ? value.to_hash : value
+        end
+      end
+      hash
+    end
+
+    # Returns a JSON representation of the curent object.
+    def to_json(options = {})
+      hash = to_hash
+      hash.to_json(options)
+    end
+  end
+end

data/lib/message_media_lookups/models/lookup_a_phone_number_response.rb

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

data/test/controllers/controller_test_base.rb

@@ -0,0 +1,31 @@
+
+require 'json'
+require 'test/unit'
+require 'message_media_lookups.rb'
+require_relative '../test_helper.rb'
+require_relative '../http_response_catcher.rb'
+
+class ControllerTestBase < Test::Unit::TestCase
+  include MessageMediaLookups
+
+  class << self
+    attr_accessor :controller
+  end
+
+  # Called only once for a test class before any test has executed.
+  def self.startup
+    @@api_client = MessageMediaLookupsClient.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_lookups_controller.rb

@@ -0,0 +1,58 @@
+
+require_relative 'controller_test_base'
+
+class LookupsControllerTests < ControllerTestBase
+  # Called only once for the class before any test has executed
+  def self.startup
+    self.controller = @@api_client.lookups
+  end
+
+  # Use the Lookups API to find information about a phone number.
+  #A request to the lookups API has the following format:
+  #```/v1/lookups/phone/{phone_number}?options={carrier,type}```
+  #The `{phone_number}` parameter is a required field and should be set to the phone number to be looked up.
+  #The options query parameter can also be used to request additional information about the phone number.
+  #By default, a request will only return the `country_code` and `phone_number` properties in the response.
+  #To request details about the the carrier, include `carrier` as a value of the options parameter.
+  #To request details about the type, include `type` as a value of the options parameter. To pass multiple values
+  #to the options parameter, use a comma separated list, i.e. `carrier,type`.
+  #A successful request to the lookups endpoint will return a response body as follows:
+  #```json
+  #{
+  #  "country_code": "AU",
+  #  "phone_number": "+61491570156",
+  #  "type": "mobile",
+  #  "carrier": {
+  #    "name": "Telstra"
+  #  }
+  #}
+  #```
+  #Each property in the response body is defined as follows:
+  #- ```country_code``` ISO ALPHA 2 country code of the phone number
+  #- ```phone_number``` E.164 formatted phone number
+  #- ```type``` The type of number. This can be ```"mobile"``` or ```"landline"```
+  #- ```carrier``` Holds information about the specific carrier (if available)
+  #  - ```name``` The carrier's name as reported by the network
+  def test_lookup_a_phone_number()
+    # Parameters for the API call
+    phone_number = '+61491570156'
+    options = 'carrier,type'
+
+    # Perform the API call through the SDK function
+    result = self.class.controller.get_lookup_a_phone_number(phone_number, options)
+
+    # Test response code
+    assert_equal(@response_catcher.response.status_code, 200)
+
+    # Test headers
+    expected_headers = {}
+    expected_headers['content-type'] = nil
+
+    assert(TestHelper.match_headers(expected_headers, @response_catcher.response.headers))
+
+    # Test whether the captured response is as we expected
+    assert_not_nil(result)
+    assert_equal('{"carrier":{"name":"AU Landline Carrier"},"country_code":"AU","phone_number":"+61491570156","type":"MOBILE"}', @response_catcher.response.raw_body)
+  end
+
+end

data/test/http_response_catcher.rb

@@ -0,0 +1,12 @@
+
+class HttpResponseCatcher < MessageMediaLookups::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,90 @@
+
+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,158 @@
+--- !ruby/object:Gem::Specification
+name: messagemedia_lookups_sdk
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- MessageMedia Developers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-04-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logging
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.5
+- !ruby/object:Gem::Dependency
+  name: certifi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2016.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2016.09.26
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2016.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2016.09.26
+- !ruby/object:Gem::Dependency
+  name: faraday-http-cache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+description: The MessageMedia Lookups API provides a number of endpoints for validating
+  the phone numbers you’re sending to by checking their validity, type and carrier
+  records.
+email: developers@messagemedia.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/message_media_lookups.rb
+- lib/message_media_lookups/api_helper.rb
+- lib/message_media_lookups/configuration.rb
+- lib/message_media_lookups/controllers/base_controller.rb
+- lib/message_media_lookups/controllers/lookups_controller.rb
+- lib/message_media_lookups/exceptions/api_exception.rb
+- lib/message_media_lookups/http/auth/basic_auth.rb
+- lib/message_media_lookups/http/auth/hmac_auth.rb
+- lib/message_media_lookups/http/faraday_client.rb
+- lib/message_media_lookups/http/http_call_back.rb
+- lib/message_media_lookups/http/http_client.rb
+- lib/message_media_lookups/http/http_context.rb
+- lib/message_media_lookups/http/http_method_enum.rb
+- lib/message_media_lookups/http/http_request.rb
+- lib/message_media_lookups/http/http_response.rb
+- lib/message_media_lookups/message_media_lookups_client.rb
+- lib/message_media_lookups/models/base_model.rb
+- lib/message_media_lookups/models/lookup_a_phone_number_response.rb
+- test/controllers/controller_test_base.rb
+- test/controllers/test_lookups_controller.rb
+- test/http_response_catcher.rb
+- test/test_helper.rb
+homepage: https://developers.messagemedia.com/
+licenses:
+- Apache-2.0
+metadata:
+  source_code_uri: https://github.com/messagemedia/lookups-ruby-sdk
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: MessageMedia Lookups SDK
+test_files: []