ruby_hlr_client 0.0.13 → 0.0.14

data/.gitignore

@@ -1,3 +1,3 @@
-pkg/*
-*.gem
+pkg/*
+*.gem
 .bundle

data/Gemfile

@@ -1,4 +1,4 @@
-source 'http://rubygems.org'
-
-# Specify dependencies in ruby_hlr_client.gemspec
-gemspec
+source 'http://rubygems.org'
+
+# Specify dependencies in ruby_hlr_client.gemspec
+gemspec

data/bin/test_callback_handler.rb

@@ -1,23 +1,23 @@
-#!/usr/bin/env ruby
-
-require 'sinatra'
-require 'ruby_hlr_client/hlr_callback_handler'
-
-set :run, true
-
-get '/' do
-
-  client = RubyHlrClient::HlrCallbackHandler.new
-
-  # Parses an asynchronous HLR Lookup callback and returns a JSON string with the results.
-  # @param params
-  # @returns string (JSON)
-  #
-  # Return example: {"success":true,"results":[{"id":"40ebb8d9e7cc","msisdncountrycode":"DE","msisdn":"+491788735001","statuscode":"HLRSTATUS_DELIVERED","hlrerrorcodeid":null,"subscriberstatus":"SUBSCRIBERSTATUS_CONNECTED","imsi":"262032000000000","mccmnc":"26203","mcc":"262","mnc":"03","msin":"2000000000","servingmsc":"491770","servinghlr":null,"originalnetworkname":"178","originalcountryname":"Germany","originalcountrycode":"DE","originalcountryprefix":"+49","originalnetworkprefix":"178","roamingnetworkname":null,"roamingcountryname":null,"roamingcountrycode":null,"roamingcountryprefix":null,"roamingnetworkprefix":null,"portednetworkname":null,"portedcountryname":null,"portedcountrycode":null,"portedcountryprefix":null,"portednetworkprefix":null,"isvalid":"Yes","isroaming":"No","isported":"No","usercharge":"0.0100","inserttime":"2014-12-28 05:53:03.765798+08","storage":"ASYNC-API","route":"IP4"}]}
-  print client.parse_callback(params)
-
-  # send HTTP response body (OK)
-  content_type :text
-  return client.send_response
-
-end
+#!/usr/bin/env ruby
+
+require 'sinatra'
+require 'ruby_hlr_client/hlr_callback_handler'
+
+set :run, true
+
+get '/' do
+
+  client = RubyHlrClient::HlrCallbackHandler.new
+
+  # Parses an asynchronous HLR Lookup callback and returns a JSON string with the results.
+  # @param params
+  # @returns string (JSON)
+  #
+  # Return example: {"success":true,"results":[{"id":"40ebb8d9e7cc","msisdncountrycode":"DE","msisdn":"+491788735001","statuscode":"HLRSTATUS_DELIVERED","hlrerrorcodeid":null,"subscriberstatus":"SUBSCRIBERSTATUS_CONNECTED","imsi":"262032000000000","mccmnc":"26203","mcc":"262","mnc":"03","msin":"2000000000","servingmsc":"491770","servinghlr":null,"originalnetworkname":"178","originalcountryname":"Germany","originalcountrycode":"DE","originalcountryprefix":"+49","originalnetworkprefix":"178","roamingnetworkname":null,"roamingcountryname":null,"roamingcountrycode":null,"roamingcountryprefix":null,"roamingnetworkprefix":null,"portednetworkname":null,"portedcountryname":null,"portedcountrycode":null,"portedcountryprefix":null,"portednetworkprefix":null,"isvalid":"Yes","isroaming":"No","isported":"No","usercharge":"0.0100","inserttime":"2014-12-28 05:53:03.765798+08","storage":"ASYNC-API","route":"IP4"}]}
+  print client.parse_callback(params)
+
+  # send HTTP response body (OK)
+  content_type :text
+  return client.send_response
+
+end

data/bin/test_client.rb

@@ -1,49 +1,84 @@
-#!/usr/bin/env ruby
-
-require 'ruby_hlr_client/hlr_client'
-
-# Initializes the HLR Lookup Client
-# @param username - www.hlr-lookups.com username
-# @param password - www.hlr-lookups.com password
-# @param ssl - set to false to disable SSL
-# @constructor
-client = RubyHlrClient::HlrClient.new(
-    'username',
-    'password'
-)
-print "\n"
-
-# Submits a synchronous HLR Lookup request. The HLR is queried in real time and results presented in the response body.
-# @param msisdn - An MSISDN in international format, e.g. +491788735000
-# @param route - An optional route assignment, see: http://www.hlr-lookups.com/en/routing-options
-# @param storage - An optional storage assignment, see: http://www.hlr-lookups.com/en/storages
-# @returns string (JSON)
-#
-# Return example: {"success":true,"results":[{"id":"e1fdf26531e4","msisdncountrycode":"DE","msisdn":"+491788735000","statuscode":"HLRSTATUS_DELIVERED","hlrerrorcodeid":null,"subscriberstatus":"SUBSCRIBERSTATUS_CONNECTED","imsi":"262031300000000","mccmnc":"26203","mcc":"262","mnc":"03","msin":"1300000000","servingmsc":"140445","servinghlr":null,"originalnetworkname":"E-Plus","originalcountryname":"Germany","originalcountrycode":"DE","originalcountryprefix":"+49","originalnetworkprefix":"178","roamingnetworkname":"Fixed Line Operators and Other Networks","roamingcountryname":"United States","roamingcountrycode":"US","roamingcountryprefix":"+1","roamingnetworkprefix":"404455","portednetworkname":null,"portedcountryname":null,"portedcountrycode":null,"portedcountryprefix":null,"portednetworkprefix":null,"isvalid":"Yes","isroaming":"Yes","isported":"No","usercharge":"0.0100","inserttime":"2014-12-28 06:22:00.328844+08","storage":"SDK-TEST-SYNC-API","route":"IP1"}]}
-print client.submit_sync_lookup_request('+491788735000', 'IP4', 'SDK-TEST')
-print "\n\n"
-
-# Sets the callback URL for asynchronous lookups. Read more about the concept of asynchronous HLR lookups @ http://www.hlr-lookups.com/en/asynchronous-hlr-lookup-api
-# @param url - callback url on your server
-# @returns string (JSON)
-#
-# Return example: {"success":true,"messages":[],"results":{"url":"http:\/\/user:pass@www.your-server.com\/path\/file"}}
-print client.set_async_callback_url('http://user:pass@www.your-server.com/path/file')
-print "\n\n"
-
-# Submits asynchronous HLR Lookups containing up to 1,000 MSISDNs per request. Results are sent back asynchronously to a callback URL on your server. Use \VmgLtd\HlrCallbackHandler to capture them.
-# @param msisdns - A list of MSISDNs in international format, e.g. +491788735000
-# @param route - An optional route assignment, see: http://www.hlr-lookups.com/en/routing-options
-# @param storage - An optional storage assignment, see: http://www.hlr-lookups.com/en/storages
-# @returns string (JSON)
-#
-# Return example: {"success":true,"messages":[],"results":{"acceptedMsisdns":[{"id":"e489a092eba7","msisdn":"+491788735000"},{"id":"23ad48bf0c26","msisdn":"+491788735001"}],"rejectedMsisdns":[],"acceptedMsisdnCount":2,"rejectedMsisdnCount":0,"totalCount":2,"charge":0.02,"storage":"SDK-TEST-ASYNC-API","route":"IP4"}}
-print client.submit_async_lookup_request(['+491788735000', '+491788735001'])
-print "\n\n"
-
-# Returns the remaining balance (EUR) in your account.
-# @returns string (JSON)
-#
-# Return example: {"success":true,"messages":[],"results":{"balance":"5878.24600"}}
-print client.get_balance
+#!/usr/bin/env ruby
+
+require 'ruby_hlr_client/hlr_client'
+
+# Initializes the HLR Lookup Client
+# @param username - www.hlr-lookups.com username
+# @param password - www.hlr-lookups.com password
+# @param ssl - set to false to disable SSL
+# @constructor
+client = RubyHlrClient::HlrClient.new(
+    'username',
+    'password'
+)
+print "\n"
+
+# Submits a synchronous HLR Lookup request. The HLR is queried in real time and results presented in the response body.
+# @param msisdn - An MSISDN in international format, e.g. +491788735000
+# @param route - An optional route assignment, see: http://www.hlr-lookups.com/en/routing-options
+# @param storage - An optional storage assignment, see: http://www.hlr-lookups.com/en/storages
+# @returns string (JSON)
+#
+# Return example: {"success":true,"results":[{"id":"e1fdf26531e4","msisdncountrycode":"DE","msisdn":"+491788735000","statuscode":"HLRSTATUS_DELIVERED","hlrerrorcodeid":null,"subscriberstatus":"SUBSCRIBERSTATUS_CONNECTED","imsi":"262031300000000","mccmnc":"26203","mcc":"262","mnc":"03","msin":"1300000000","servingmsc":"140445","servinghlr":null,"originalnetworkname":"E-Plus","originalcountryname":"Germany","originalcountrycode":"DE","originalcountryprefix":"+49","originalnetworkprefix":"178","roamingnetworkname":"Fixed Line Operators and Other Networks","roamingcountryname":"United States","roamingcountrycode":"US","roamingcountryprefix":"+1","roamingnetworkprefix":"404455","portednetworkname":null,"portedcountryname":null,"portedcountrycode":null,"portedcountryprefix":null,"portednetworkprefix":null,"isvalid":"Yes","isroaming":"Yes","isported":"No","usercharge":"0.0100","inserttime":"2014-12-28 06:22:00.328844+08","storage":"SDK-TEST-SYNC-API","route":"IP1"}]}
+print client.submit_sync_lookup_request('+491788735000', 'IP4', 'SDK-TEST')
+print "\n\n"
+
+# Submits a synchronous number type lookup request. Results are presented in the response body.
+# @param number - An number in international format, e.g. +4989702626
+# @param route - An optional route assignment, see: http://www.hlr-lookups.com/en/routing-options
+# @param storage - An optional storage assignment, see: http://www.hlr-lookups.com/en/storages
+# @returns string (JSON)
+#
+# Return example: { "success":true, "results":[ { "id":"2ed0788379c6", "number":"+4989702626", "numbertype":"LANDLINE", "state":"COMPLETED", "isvalid":"Yes", "ispossiblyported":"No", "isvalidshortnumber":"No", "isvanitynumber":"No", "qualifiesforhlrlookup":"No", "originalcarrier":null, "mccmnc":null, "mcc":null, "mnc":null, "countrycode":"DE", "region":"Munich", "timezones":[ "Europe\/Berlin" ], "infotext":"This is a landline number.", "usercharge":"0.0050", "inserttime":"2015-12-04 10:36:41.866283+00", "storage":"SYNC-API-NT-2015-12", "route":"LC1" } ] }
+print client.submit_sync_number_type_lookup_request('+4989702626', 'LC1', 'SDK-TEST')
+print "\n\n"
+
+# Sets the callback URL for asynchronous lookups. Read more about the concept of asynchronous HLR lookups @ http://www.hlr-lookups.com/en/asynchronous-hlr-lookup-api
+# @param url - callback url on your server
+# @returns string (JSON)
+#
+# Return example: {"success":true,"messages":[],"results":{"url":"http:\/\/user:pass@www.your-server.com\/path\/file"}}
+print client.set_async_callback_url('http://user:pass@www.your-server.com/path/file')
+print "\n\n"
+
+# Sets the callback URL for asynchronous number type lookups.
+# @param url - callback url on your server
+# @returns string (JSON)
+#
+# Return example: {"success":true,"messages":[],"results":{"url":"http:\/\/user:pass@www.your-server.com\/path\/file"}}
+print client.set_nt_async_callback_url('http://user:pass@www.your-server.com/path/file')
+print "\n\n"
+
+# Submits asynchronous HLR Lookups containing up to 1,000 MSISDNs per request. Results are sent back asynchronously to a callback URL on your server. Use \VmgLtd\HlrCallbackHandler to capture them.
+# @param msisdns - A list of MSISDNs in international format, e.g. +491788735000
+# @param route - An optional route assignment, see: http://www.hlr-lookups.com/en/routing-options
+# @param storage - An optional storage assignment, see: http://www.hlr-lookups.com/en/storages
+# @returns string (JSON)
+#
+# Return example: {"success":true,"messages":[],"results":{"acceptedMsisdns":[{"id":"e489a092eba7","msisdn":"+491788735000"},{"id":"23ad48bf0c26","msisdn":"+491788735001"}],"rejectedMsisdns":[],"acceptedMsisdnCount":2,"rejectedMsisdnCount":0,"totalCount":2,"charge":0.02,"storage":"SDK-TEST-ASYNC-API","route":"IP4"}}
+print client.submit_async_lookup_request(['+491788735000', '+491788735001'])
+print "\n\n"
+
+# Submits asynchronous number type lookups containing up to 1,000 numbers per request. Results are sent back asynchronously to a callback URL on your server.
+# @param numbers - A list of numbers in international format, e.g. +4989702626,+491788735000
+# @param route - An optional route assignment, see: http://www.hlr-lookups.com/en/routing-options
+# @param storage - An optional storage assignment, see: http://www.hlr-lookups.com/en/storages
+# @returns string (JSON)
+#
+# Return example: { "success":true, "messages":[], "results":{ "acceptedNumbers":[ { "id":"f09b30014d5e", "number":"+4989702626" }, { "id":"364c0ad33c02", "number":"+491788735000" } ], "rejectedNumbers":[ { "id":null, "number":"asdf" } ], "acceptedNumberCount":2, "rejectedNumberCount":1, "totalCount":3, "charge":0.01, "storage":"ASYNC-API-NT-2015-12", "route":"LC1" } }
+print client.submit_async_number_type_lookup_request(['+4989702626','+491788735000'])
+print "\n\n"
+
+# Returns the remaining balance (EUR) in your account.
+# @returns string (JSON)
+#
+# Return example: {"success":true,"messages":[],"results":{"balance":"5878.24600"}}
+print client.get_balance
+print "\n\n"
+
+# Performs a health check on the system status, the user account and availability of each route.
+# @returns string (JSON)
+#
+# Return example: { "success":true, "results":{ "system":{ "state":"up" }, "routes":{ "states":{ "IP1":"up", "ST2":"up", "SV3":"up", "IP4":"up", "XT5":"up", "XT6":"up", "NT7":"up", "LC1":"up" } }, "account":{ "lookupsPermitted":true, "balance":"295.23000" } } }
+print client.do_health_check
 print "\n"

data/create_gem.txt

@@ -1,2 +1,2 @@
-1. rake install
+1. rake install
 2. cd pkg/; gem push ruby_hlr_client-VERSION.gem

data/lib/ruby_hlr_client.rb

@@ -1,3 +1,3 @@
-module RubyHlrClient
-  # Your code goes here...
+module RubyHlrClient
+  # Your code goes here...
 end

data/lib/ruby_hlr_client/hlr_callback_handler.rb

@@ -1,36 +1,36 @@
-require 'json'
-
-module RubyHlrClient
-  class HlrCallbackHandler
-
-    # Parses an asynchronous HLR Lookup callback and returns a JSON string with the results.
-    # @param params
-    # @returns {*}
-    #
-    # Return example: {"success":true,"results":[{"id":"40ebb8d9e7cc","msisdncountrycode":"DE","msisdn":"+491788735001","statuscode":"HLRSTATUS_DELIVERED","hlrerrorcodeid":null,"subscriberstatus":"SUBSCRIBERSTATUS_CONNECTED","imsi":"262032000000000","mccmnc":"26203","mcc":"262","mnc":"03","msin":"2000000000","servingmsc":"491770","servinghlr":null,"originalnetworkname":"178","originalcountryname":"Germany","originalcountrycode":"DE","originalcountryprefix":"+49","originalnetworkprefix":"178","roamingnetworkname":null,"roamingcountryname":null,"roamingcountrycode":null,"roamingcountryprefix":null,"roamingnetworkprefix":null,"portednetworkname":null,"portedcountryname":null,"portedcountrycode":null,"portedcountryprefix":null,"portednetworkprefix":null,"isvalid":"Yes","isroaming":"No","isported":"No","usercharge":"0.0100","inserttime":"2014-12-28 05:53:03.765798+08","storage":"ASYNC-API","route":"IP4"}]}
-    def parse_callback(params)
-
-      unless params.has_key?('json')
-        return generate_error_result('Invalid callback parameters. Missing json payload.')
-      end
-
-      params['json']
-
-    end
-
-    def send_response
-
-      'OK'
-
-    end
-
-    def generate_error_result(message)
-
-      result = {:success => false, :fieldErrors => [], :globalErrors => ["#{message}"]}
-      result.to_json
-
-    end
-
-  end
-
-end
+require 'json'
+
+module RubyHlrClient
+  class HlrCallbackHandler
+
+    # Parses an asynchronous HLR Lookup callback and returns a JSON string with the results.
+    # @param params
+    # @returns {*}
+    #
+    # Return example: {"success":true,"results":[{"id":"40ebb8d9e7cc","msisdncountrycode":"DE","msisdn":"+491788735001","statuscode":"HLRSTATUS_DELIVERED","hlrerrorcodeid":null,"subscriberstatus":"SUBSCRIBERSTATUS_CONNECTED","imsi":"262032000000000","mccmnc":"26203","mcc":"262","mnc":"03","msin":"2000000000","servingmsc":"491770","servinghlr":null,"originalnetworkname":"178","originalcountryname":"Germany","originalcountrycode":"DE","originalcountryprefix":"+49","originalnetworkprefix":"178","roamingnetworkname":null,"roamingcountryname":null,"roamingcountrycode":null,"roamingcountryprefix":null,"roamingnetworkprefix":null,"portednetworkname":null,"portedcountryname":null,"portedcountrycode":null,"portedcountryprefix":null,"portednetworkprefix":null,"isvalid":"Yes","isroaming":"No","isported":"No","usercharge":"0.0100","inserttime":"2014-12-28 05:53:03.765798+08","storage":"ASYNC-API","route":"IP4"}]}
+    def parse_callback(params)
+
+      unless params.has_key?('json')
+        return generate_error_result('Invalid callback parameters. Missing json payload.')
+      end
+
+      params['json']
+
+    end
+
+    def send_response
+
+      'OK'
+
+    end
+
+    def generate_error_result(message)
+
+      result = {:success => false, :fieldErrors => [], :globalErrors => ["#{message}"]}
+      result.to_json
+
+    end
+
+  end
+
+end

data/lib/ruby_hlr_client/hlr_client.rb

@@ -1,151 +1,237 @@
-require 'rest_client'
-require 'json'
-
-module RubyHlrClient
-
-  class HlrClient
-
-    # Initializes the HLR Lookup Client
-    # @param username - www.hlr-lookups.com username
-    # @param password - www.hlr-lookups.com password
-    # @param ssl - set to false to disable SSL
-    # @constructor
-    def initialize(username, password, ssl = true)
-      @username = username
-      @password = password
-      @url = "#{ssl ? 'https' : 'http'}://www.hlr-lookups.com/api"
-    end
-
-    # Submits a synchronous HLR Lookup request. The HLR is queried in real time and results presented in the response body.
-    # @param msisdn - An MSISDN in international format, e.g. +491788735000
-    # @param route - An optional route assignment, see: http://www.hlr-lookups.com/en/routing-options
-    # @param storage - An optional storage assignment, see: http://www.hlr-lookups.com/en/storages
-    # @returns string (JSON)
-    #
-    # Return example: {"success":true,"results":[{"id":"e1fdf26531e4","msisdncountrycode":"DE","msisdn":"+491788735000","statuscode":"HLRSTATUS_DELIVERED","hlrerrorcodeid":null,"subscriberstatus":"SUBSCRIBERSTATUS_CONNECTED","imsi":"262031300000000","mccmnc":"26203","mcc":"262","mnc":"03","msin":"1300000000","servingmsc":"140445","servinghlr":null,"originalnetworkname":"E-Plus","originalcountryname":"Germany","originalcountrycode":"DE","originalcountryprefix":"+49","originalnetworkprefix":"178","roamingnetworkname":"Fixed Line Operators and Other Networks","roamingcountryname":"United States","roamingcountrycode":"US","roamingcountryprefix":"+1","roamingnetworkprefix":"404455","portednetworkname":null,"portedcountryname":null,"portedcountrycode":null,"portedcountryprefix":null,"portednetworkprefix":null,"isvalid":"Yes","isroaming":"Yes","isported":"No","usercharge":"0.0100","inserttime":"2014-12-28 06:22:00.328844+08","storage":"SDK-TEST-SYNC-API","route":"IP1"}]}
-    def submit_sync_lookup_request(msisdn, route = nil, storage = nil)
-
-      params = {
-        :action => 'submitSyncLookupRequest',
-        :msisdn => msisdn,
-        :username => @username,
-        :password => @password
-      }
-
-      unless route.nil?
-        params.merge!(route: route)
-      end
-
-      unless storage.nil?
-        params.merge!(storage: storage)
-      end
-
-      send_request(params)
-
-    end
-
-    # Submits asynchronous HLR Lookups containing up to 1,000 MSISDNs per request. Results are sent back asynchronously to a callback URL on your server. Use \VmgLtd\HlrCallbackHandler to capture them.
-    # @param msisdns - A list of MSISDNs in international format, e.g. +491788735000
-    # @param route - An optional route assignment, see: http://www.hlr-lookups.com/en/routing-options
-    # @param storage - An optional storage assignment, see: http://www.hlr-lookups.com/en/storages
-    # @returns string (JSON)
-    #
-    # Return example: {"success":true,"messages":[],"results":{"acceptedMsisdns":[{"id":"e489a092eba7","msisdn":"+491788735000"},{"id":"23ad48bf0c26","msisdn":"+491788735001"}],"rejectedMsisdns":[],"acceptedMsisdnCount":2,"rejectedMsisdnCount":0,"totalCount":2,"charge":0.02,"storage":"SDK-TEST-ASYNC-API","route":"IP4"}}
-    def submit_async_lookup_request(msisdns, route = nil, storage = nil)
-
-      params = {
-          :action => 'submitAsyncLookupRequest',
-          :msisdns => msisdns_to_string(msisdns),
-          :username => @username,
-          :password => @password
-      }
-
-      unless route.nil?
-        params.merge!(route: route)
-      end
-
-      unless storage.nil?
-        params.merge!(storage: storage)
-      end
-
-      send_request(params)
-
-    end
-
-    # Sets the callback URL for asynchronous lookups. Read more about the concept of asynchronous HLR lookups @ http://www.hlr-lookups.com/en/asynchronous-hlr-lookup-api
-    # @param url - callback url on your server
-    # @returns string (JSON)
-    #
-    # Return example: {"success":true,"messages":[],"results":{"url":"http:\/\/user:pass@www.your-server.com\/path\/file"}}
-    def set_async_callback_url(url)
-
-      send_request({
-        :action => 'setAsyncCallbackUrl',
-        :url => url,
-        :username => @username,
-        :password => @password
-      })
-
-    end
-
-    # Returns the remaining balance (EUR) in your account.
-    # @returns string (JSON)
-    #
-    # Return example: {"success":true,"messages":[],"results":{"balance":"5878.24600"}}
-    def get_balance
-
-      send_request({
-        :action => 'getBalance',
-        :username => @username,
-        :password => @password
-      })
-
-    end
-
-    private
-    def send_request(query)
-
-      begin
-        response = RestClient.get @url, :params => query
-      rescue => e
-        return generate_error_result("HTTP Status Code #{e.message}")
-      end
-
-      unless response.code == 200
-        return generate_error_result("HTTP Status Code #{response.code}")
-      end
-
-      response.to_str
-
-    end
-
-    private
-    def generate_error_result(message)
-
-      {:success => false, :fieldErrors => [], :globalErrors => ["#{message}"]}.to_json
-
-    end
-
-    def msisdns_to_string(msisdns)
-
-      string = ''
-      c = 0
-      msisdns.each { |msisdn|
-
-        if c > 0
-          string += ','
-        end
-
-        string += msisdn
-
-        c = c+1
-
-      }
-
-      string
-
-    end
-
-  end
-
-end
+require 'rest_client'
+require 'json'
+
+module RubyHlrClient
+
+  class HlrClient
+
+    # Initializes the HLR Lookup Client
+    # @param username - www.hlr-lookups.com username
+    # @param password - www.hlr-lookups.com password
+    # @param ssl - set to false to disable SSL
+    # @constructor
+    def initialize(username, password, ssl = true)
+      @username = username
+      @password = password
+      @url = "#{ssl ? 'https' : 'http'}://www.hlr-lookups.com/api"
+    end
+
+    # Submits a synchronous HLR Lookup request. The HLR is queried in real time and results presented in the response body.
+    # @param msisdn - An MSISDN in international format, e.g. +491788735000
+    # @param route - An optional route assignment, see: http://www.hlr-lookups.com/en/routing-options
+    # @param storage - An optional storage assignment, see: http://www.hlr-lookups.com/en/storages
+    # @returns string (JSON)
+    #
+    # Return example: {"success":true,"results":[{"id":"e1fdf26531e4","msisdncountrycode":"DE","msisdn":"+491788735000","statuscode":"HLRSTATUS_DELIVERED","hlrerrorcodeid":null,"subscriberstatus":"SUBSCRIBERSTATUS_CONNECTED","imsi":"262031300000000","mccmnc":"26203","mcc":"262","mnc":"03","msin":"1300000000","servingmsc":"140445","servinghlr":null,"originalnetworkname":"E-Plus","originalcountryname":"Germany","originalcountrycode":"DE","originalcountryprefix":"+49","originalnetworkprefix":"178","roamingnetworkname":"Fixed Line Operators and Other Networks","roamingcountryname":"United States","roamingcountrycode":"US","roamingcountryprefix":"+1","roamingnetworkprefix":"404455","portednetworkname":null,"portedcountryname":null,"portedcountrycode":null,"portedcountryprefix":null,"portednetworkprefix":null,"isvalid":"Yes","isroaming":"Yes","isported":"No","usercharge":"0.0100","inserttime":"2014-12-28 06:22:00.328844+08","storage":"SDK-TEST-SYNC-API","route":"IP1"}]}
+    def submit_sync_lookup_request(msisdn, route = nil, storage = nil)
+
+      params = {
+        :action => 'submitSyncLookupRequest',
+        :msisdn => msisdn,
+        :username => @username,
+        :password => @password
+      }
+
+      unless route.nil?
+        params.merge!(route: route)
+      end
+
+      unless storage.nil?
+        params.merge!(storage: storage)
+      end
+
+      send_request(params)
+
+    end
+
+    # Submits a synchronous number type lookup request. Results are presented in the response body.
+    # @param number - An number in international format, e.g. +4989702626
+    # @param route - An optional route assignment, see: http://www.hlr-lookups.com/en/routing-options
+    # @param storage - An optional storage assignment, see: http://www.hlr-lookups.com/en/storages
+    # @returns string (JSON)
+    #
+    # Return example: { "success":true, "results":[ { "id":"2ed0788379c6", "number":"+4989702626", "numbertype":"LANDLINE", "state":"COMPLETED", "isvalid":"Yes", "ispossiblyported":"No", "isvalidshortnumber":"No", "isvanitynumber":"No", "qualifiesforhlrlookup":"No", "originalcarrier":null, "mccmnc":null, "mcc":null, "mnc":null, "countrycode":"DE", "region":"Munich", "timezones":[ "Europe\/Berlin" ], "infotext":"This is a landline number.", "usercharge":"0.0050", "inserttime":"2015-12-04 10:36:41.866283+00", "storage":"SYNC-API-NT-2015-12", "route":"LC1" } ] }
+    def submit_sync_lookup_request(number, route = nil, storage = nil)
+
+      params = {
+        :action => 'submitSyncLookupRequest',
+        :number => number,
+        :username => @username,
+        :password => @password
+      }
+
+      unless route.nil?
+        params.merge!(route: route)
+      end
+
+      unless storage.nil?
+        params.merge!(storage: storage)
+      end
+
+      send_request(params)
+
+    end
+
+    # Submits asynchronous HLR Lookups containing up to 1,000 MSISDNs per request. Results are sent back asynchronously to a callback URL on your server.
+    # @param msisdns - A list of MSISDNs in international format, e.g. +491788735000,+491788735001
+    # @param route - An optional route assignment, see: http://www.hlr-lookups.com/en/routing-options
+    # @param storage - An optional storage assignment, see: http://www.hlr-lookups.com/en/storages
+    # @returns string (JSON)
+    #
+    # Return example: {"success":true,"messages":[],"results":{"acceptedMsisdns":[{"id":"e489a092eba7","msisdn":"+491788735000"},{"id":"23ad48bf0c26","msisdn":"+491788735001"}],"rejectedMsisdns":[],"acceptedMsisdnCount":2,"rejectedMsisdnCount":0,"totalCount":2,"charge":0.02,"storage":"SDK-TEST-ASYNC-API","route":"IP4"}}
+    def submit_async_lookup_request(msisdns, route = nil, storage = nil)
+
+      params = {
+          :action => 'submitAsyncLookupRequest',
+          :msisdns => msisdns_to_string(msisdns),
+          :username => @username,
+          :password => @password
+      }
+
+      unless route.nil?
+        params.merge!(route: route)
+      end
+
+      unless storage.nil?
+        params.merge!(storage: storage)
+      end
+
+      send_request(params)
+
+    end
+
+    # Submits asynchronous number type lookups containing up to 1,000 numbers per request. Results are sent back asynchronously to a callback URL on your server.
+    # @param numbers - A list of numbers in international format, e.g. +4989702626,+491788735000
+    # @param route - An optional route assignment, see: http://www.hlr-lookups.com/en/routing-options
+    # @param storage - An optional storage assignment, see: http://www.hlr-lookups.com/en/storages
+    # @returns string (JSON)
+    #
+    # Return example: { "success":true, "messages":[], "results":{ "acceptedNumbers":[ { "id":"f09b30014d5e", "number":"+4989702626" }, { "id":"364c0ad33c02", "number":"+491788735000" } ], "rejectedNumbers":[ { "id":null, "number":"asdf" } ], "acceptedNumberCount":2, "rejectedNumberCount":1, "totalCount":3, "charge":0.01, "storage":"ASYNC-API-NT-2015-12", "route":"LC1" } }
+    def submit_async_number_type_lookup_request(msisdns, route = nil, storage = nil)
+
+      params = {
+          :action => 'submitAsyncNumberTypeLookupRequest',
+          :msisdns => msisdns_to_string(numbers),
+          :username => @username,
+          :password => @password
+      }
+
+      unless route.nil?
+        params.merge!(route: route)
+      end
+
+      unless storage.nil?
+        params.merge!(storage: storage)
+      end
+
+      send_request(params)
+
+    end
+
+    # Sets the callback URL for asynchronous HLR lookups. Read more about the concept of asynchronous HLR lookups @ http://www.hlr-lookups.com/en/asynchronous-hlr-lookup-api
+    # @param url - callback url on your server
+    # @returns string (JSON)
+    #
+    # Return example: {"success":true,"messages":[],"results":{"url":"http:\/\/user:pass@www.your-server.com\/path\/file"}}
+    def set_async_callback_url(url)
+
+      send_request({
+        :action => 'setAsyncCallbackUrl',
+        :url => url,
+        :username => @username,
+        :password => @password
+      })
+
+    end
+
+    # Sets the callback URL for asynchronous number type lookups.
+    # @param url - callback url on your server
+    # @returns string (JSON)
+    #
+    # Return example: {"success":true,"messages":[],"results":{"url":"http:\/\/user:pass@www.your-server.com\/path\/file"}}
+    def set_nt_async_callback_url(url)
+
+      send_request({
+        :action => 'setNtAsyncCallbackUrl',
+        :url => url,
+        :username => @username,
+        :password => @password
+      })
+
+    end
+
+    # Returns the remaining balance (EUR) in your account.
+    # @returns string (JSON)
+    #
+    # Return example: {"success":true,"messages":[],"results":{"balance":"5878.24600"}}
+    def get_balance
+
+      send_request({
+        :action => 'getBalance',
+        :username => @username,
+        :password => @password
+      })
+
+    end
+
+    # Performs a health check on the system status, the user account and availability of each route.
+    # @returns string (JSON)
+    #
+    # Return example: { "success":true, "results":{ "system":{ "state":"up" }, "routes":{ "states":{ "IP1":"up", "ST2":"up", "SV3":"up", "IP4":"up", "XT5":"up", "XT6":"up", "NT7":"up", "LC1":"up" } }, "account":{ "lookupsPermitted":true, "balance":"295.23000" } } }
+    def do_health_check
+
+      send_request({
+        :action => 'doHealthCheck',
+        :username => @username,
+        :password => @password
+      })
+
+    end
+
+    private
+    def send_request(query)
+
+      begin
+        response = RestClient.get @url, :params => query
+      rescue => e
+        return generate_error_result("HTTP Status Code #{e.message}")
+      end
+
+      unless response.code == 200
+        return generate_error_result("HTTP Status Code #{response.code}")
+      end
+
+      response.to_str
+
+    end
+
+    private
+    def generate_error_result(message)
+
+      {:success => false, :fieldErrors => [], :globalErrors => ["#{message}"]}.to_json
+
+    end
+
+    def msisdns_to_string(msisdns)
+
+      string = ''
+      c = 0
+      msisdns.each { |msisdn|
+
+        if c > 0
+          string += ','
+        end
+
+        string += msisdn
+
+        c = c+1
+
+      }
+
+      string
+
+    end
+
+  end
+
+end

data/lib/ruby_hlr_client/version.rb

@@ -1,3 +1,3 @@
-module RubyHlrClient
-  VERSION = '0.0.13'
-end
+module RubyHlrClient
+  VERSION = '0.0.14'
+end

data/ruby_hlr_client.gemspec

@@ -1,26 +1,26 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path('../lib', __FILE__)
-require 'ruby_hlr_client/version'
-
-Gem::Specification.new do |s|
-  s.name        = 'ruby_hlr_client'
-  s.version     = RubyHlrClient::VERSION
-  s.platform    = Gem::Platform::RUBY
-  s.authors     = ['Velocity Made Good Ltd.']
-  s.email       = ['service@hlr-lookups.com']
-  s.homepage    = 'http://www.hlr-lookups.com'
-  s.summary     = %q{Official HLR Lookup API Ruby SDK by www.hlr-lookups.com}
-  s.licenses    = ['Apache-2.0']
-
-
-  s.add_dependency 'sinatra'
-  s.add_dependency 'rest_client'
-  s.add_dependency 'json'
-
-  s.rubyforge_project = 'ruby_hlr_client'
-
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ['lib']
-end
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'ruby_hlr_client/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'ruby_hlr_client'
+  s.version     = RubyHlrClient::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Velocity Made Good Ltd.']
+  s.email       = ['service@hlr-lookups.com']
+  s.homepage    = 'http://www.hlr-lookups.com'
+  s.summary     = %q{Official HLR Lookup API Ruby SDK by www.hlr-lookups.com}
+  s.licenses    = ['Apache-2.0']
+
+
+  s.add_dependency 'sinatra'
+  s.add_dependency 'rest_client'
+  s.add_dependency 'json'
+
+  s.rubyforge_project = 'ruby_hlr_client'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+end

metadata

@@ -1,66 +1,76 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: ruby_hlr_client
-version: !ruby/object:Gem::Version
-  version: 0.0.13
+version: !ruby/object:Gem::Version 
+  hash: 3
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 14
+  version: 0.0.14
 platform: ruby
-authors:
+authors: 
 - Velocity Made Good Ltd.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-06 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2015-12-04 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: sinatra
-  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: rest_client
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rest_client
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: json
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: json
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
 description: 
-email:
+email: 
 - service@hlr-lookups.com
-executables:
+executables: 
 - test_callback_handler.rb
 - test_client.rb
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
 - Gemfile
 - Rakefile
@@ -72,28 +82,39 @@ files:
 - lib/ruby_hlr_client/hlr_client.rb
 - lib/ruby_hlr_client/version.rb
 - ruby_hlr_client.gemspec
+has_rdoc: true
 homepage: http://www.hlr-lookups.com
-licenses:
+licenses: 
 - Apache-2.0
-metadata: {}
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+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'
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: ruby_hlr_client
-rubygems_version: 2.4.5
+rubygems_version: 1.3.7
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Official HLR Lookup API Ruby SDK by www.hlr-lookups.com
 test_files: []
+

checksums.yaml

@@ -1,15 +0,0 @@
----
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    YzUyM2U2YTFkNmQ2YWNmNDBmMzVhNWVjZWFhMjViYmE4MDUyMDIzYQ==
-  data.tar.gz: !binary |-
-    NmJmZGE2MzMyY2I1OTFhZjllMzU0ZmM3YzYxZTBlZGY0NmM0ZTFiOQ==
-SHA512:
-  metadata.gz: !binary |-
-    NDZlMmE5Y2IyYzkxN2IzOWVkZGQyYzE2ZTI5Njg1MWMzOGUwZWYyMmZlZTdl
-    NjMwM2EyZDk0N2RlMWQ0ZTE0NzQ5MzZhNjMyYzgxYzcwYzdiZjdjZmYyNmY1
-    MDgyNzEzZDJhMjlmODAxN2NhY2NmYWIzMGFhYWNkNGJlMGUzM2M=
-  data.tar.gz: !binary |-
-    ZTBjNGM0NDFlOTU3ZWFmZDA2OGE1ZTQwMWJkZWNkODNkMDMxZDc2ZWJiNzVl
-    MGY5Y2IyMGI5OGE4YTMwOWMyYTEyNWUwMTU2NWVkODYyM2U2NDlmOTAwM2Jk
-    ZmRiODdlYjNiMWJjZDQ5NWMxZjYyYjk2M2I0YzY4ZGM1YzgxYTk=