ruby_hlr_client 0.0.15 → 2.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f06ae6d66949dab9f751c2e4adf7449c8f11e7f9f8a804ee1f32d4bfa42c2087
+  data.tar.gz: 384409e63b9cfa4813be4f95f06c20d850f29cd697278094081317d7d9c5b852
+SHA512:
+  metadata.gz: dcc01c7198d6123c466b0b34e5702ba829858cb9e39ac0d462ca9a4410ac95e8ab02eab4ef298b3b6a002dd65338fbed67114101304b6e83ed320c00dd7660d1
+  data.tar.gz: e52e634fcfb799b5b57dbc228b9998863abe5973165a04ff5630e2c8893b8d64473147e8924117182d0750a4603bdc6c2027ebd78f85115c3f8d0ab8d0ea7cee

data/Gemfile

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

data/examples/example.rb

@@ -0,0 +1,64 @@
+#!/usr/bin/env ruby
+require 'ruby_hlr_client/client'
+
+# This file contains examples on how to interact with the HLR Lookup API.
+# All endpoints of the API are documented here: https://www.hlr-lookups.com/en/api-docs
+
+# Create an HLR Lookups API client
+# The constructor takes your API Key, API Secret and an optional log file location as parameters
+# Your API Key and Secret can be obtained here: https://www.hlr-lookups.com.com/en/api-settings
+
+client = HlrLookupsSDK::Client.new(
+    'YOUR-API-KEY',
+    'YOUR-API-SECRET',
+    '/var/log/hlr-lookups-api.log' # an optional log file location
+)
+
+# Invoke a request to GET /auth-test (https://www.hlr-lookups.com/en/api-docs#get-auth-test) to see if everything worked
+response = client.get('/auth-test')
+
+# The API returns an HTTP status code of 200 if the request was successfully processed, let's have a look.
+print "Status Code: " + response.code.to_s + "\n"
+print "Response Body: " + response.body + "\n"
+
+# Submit an HLR Lookup via POST /hlr-lookup (https://www.hlr-lookups.com/en/api-docs#post-hlr-lookup)
+response = client.post('/hlr-lookup', msisdn: '+905536939460')
+
+print "HLR Lookup Status Code: " + response.code.to_s + "\n"
+print "HLR Lookup Response Body: " + response.body + "\n"
+
+if response.code != 200
+  # something went wrong
+  print "Received non-OK status code from server." + "\n"
+end
+
+# do something with the HLR data
+data = JSON.parse(response.body)
+
+# Submit an NT Lookup via POST /nt-lookup (https://www.hlr-lookups.com/en/api-docs#post-nt-lookup)
+response = client.post('/nt-lookup', number: '+905536939460')
+
+print "NT Lookup Status Code: " + response.code.to_s + "\n"
+print "NT Lookup Response Body: " + response.body + "\n"
+
+if response.code != 200
+  # something went wrong
+  print "Received non-OK status code from server." + "\n"
+end
+
+# do something with the NT data
+data = JSON.parse(response.body)
+
+# Submit an MNP Lookup via POST /mnp-lookup (https://www.hlr-lookups.com/en/api-docs#post-mnp-lookup)
+response = client.post('/mnp-lookup', msisdn: '+905536939460')
+
+print "MNP Lookup Status Code: " + response.code.to_s + "\n"
+print "MNP Lookup Response Body: " + response.body + "\n"
+
+if response.code != 200
+  # something went wrong
+  print "Received non-OK status code from server." + "\n"
+end
+
+# do something with the MNP data
+data = JSON.parse(response.body)

data/lib/ruby_hlr_client.rb

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

data/lib/ruby_hlr_client/client.rb

@@ -0,0 +1,185 @@
+require 'rest-client'
+require 'json'
+require 'time'
+require 'ruby_hlr_client/config'
+require 'uri'
+require 'openssl'
+
+ # Ruby implementation of a REST client for the HLR Lookups API
+ # see https://www.hlr-lookups.com/en/api-docs
+module HlrLookupsSDK
+
+  class Client
+
+    # HLR Lookups API client constructor, initialize this with the API key and secret as given by https://www.hlr-lookups.com/en/api-settings
+    # @param key; as given by https://www.hlr-lookups.com/en/api-settings
+    # @param secret; as given by https://www.hlr-lookups.com/en/api-settings
+    # @param log_file; optional log file path
+    # @constructor
+    def initialize(key, secret, log_file = NIL)
+
+      # @string The API Key as given by https://www.hlr-lookups.com/en/api-settings
+      @key = key
+
+      # @string The API Secret as given by https://www.hlr-lookups.com/en/api-settings
+      @secret = secret
+
+      # @string The API version to which we connect (leave it as is)
+      @api_version = HlrLookupsSDK::API_VERSION
+
+      # @string Used in the HTTP user agent (leave it as is)
+      @client_name = HlrLookupsSDK::CLIENT_NAME
+
+      # @string The current version of this SDK, used in the HTTP user agent (leave it as is)
+      @client_version = HlrLookupsSDK::CLIENT_VERSION
+
+      # @string HLR Lookup connect url
+      @connect_url = HlrLookupsSDK::CONNECT_URL
+
+      # @string|NIL Specifies the log file to which to write, if any.
+      @log_file = log_file ? log_file : NIL
+
+    end
+
+    # Use this method to communicate with GET endpoints
+    # @param endpoint (string), e.g. GET /auth-test
+    # @param params (hash), a list of GET parameters to be included in the request
+    # @return RestClient::Response, https://github.com/rest-client/rest-client/blob/2c72a2e77e2e87d25ff38feba0cf048d51bd5eca/lib/restclient/response.rb
+    def get(endpoint, params = {})
+
+      path = build_connect_url(endpoint) + '?' +  URI.encode_www_form(params)
+      headers = build_headers(endpoint, 'GET', params)
+
+      log "GET " + path
+      log headers.to_s
+
+      begin
+        response = RestClient::Request.execute(method: :get, url: path, headers: headers, timeout: 15)
+      rescue RestClient::ExceptionWithResponse => e
+        log e.http_code.to_s + " " + e.response.to_s
+        return e.response
+      end
+
+      log response.code.to_s + " " + response.to_s
+
+      response
+
+    end
+
+    # Use this method to communicate with POST endpoints
+    # @param endpoint (string), e.g. POST /hlr-lookup
+    # @param params (hash), a list of parameters to be included in the request
+    # @return RestClient::Response, https://github.com/rest-client/rest-client/blob/2c72a2e77e2e87d25ff38feba0cf048d51bd5eca/lib/restclient/response.rb
+    def post(endpoint, params = {})
+
+      path = build_connect_url(endpoint)
+      headers = build_headers(endpoint, 'POST', params)
+
+      log "POST " + path + " " + params.to_s
+      log headers.to_s
+
+      begin
+        response = RestClient::Request.execute(method: :post, url: path, payload: params.to_json, headers: headers, timeout: 15)
+      rescue RestClient::ExceptionWithResponse => e
+        log e.http_code.to_s + " " + e.response.to_s
+        return e.response
+      end
+
+      log response.code.to_s + " " + response.to_s
+
+      response
+
+    end
+
+    # Use this method to communicate with PUT endpoints
+    # @param endpoint (string)
+    # @param params (hash), a list of parameters to be included in the request
+    # @return RestClient::Response, https://github.com/rest-client/rest-client/blob/2c72a2e77e2e87d25ff38feba0cf048d51bd5eca/lib/restclient/response.rb
+    def put(endpoint, params = {})
+
+      path = build_connect_url(endpoint)
+      headers = build_headers(endpoint, 'PUT', params)
+
+      log "PUT " + path + " " + params.to_s
+      log headers.to_s
+
+      begin
+        response = RestClient::Request.execute(method: :put, url: path, payload: params.to_json, headers: headers, timeout: 15)
+      rescue RestClient::ExceptionWithResponse => e
+        log e.http_code.to_s + " " + e.response.to_s
+        return e.response
+      end
+
+      log response.code.to_s + " " + response.to_s
+
+      response
+
+    end
+
+    # Use this method to communicate with DELETE endpoints
+    # @param endpoint (string)
+    # @param params (hash), a list of parameters to be included in the request
+    # @return RestClient::Response, https://github.com/rest-client/rest-client/blob/2c72a2e77e2e87d25ff38feba0cf048d51bd5eca/lib/restclient/response.rb
+    def delete(endpoint, params = {})
+
+      path = build_connect_url(endpoint)
+      headers = build_headers(endpoint, 'DELETE', params)
+
+      log "DELETE " + path + " " + params.to_s
+      log headers.to_s
+
+      begin
+        response = RestClient::Request.execute(method: :delete, url: path, payload: params.to_json, headers: headers, timeout: 15)
+      rescue RestClient::ExceptionWithResponse => e
+        log e.http_code.to_s + " " + e.response.to_s
+        return e.response
+      end
+
+      log response.code.to_s + " " + response.to_s
+
+      response
+
+    end
+
+    # private class to generate connect url on HLR Lookups servers
+    private
+    def build_connect_url(endpoint)
+      @connect_url + @api_version + endpoint
+    end
+
+    # private class to generate authentication headers
+    private
+    def build_headers(endpoint, method, params)
+
+      timestamp = Time.now.to_i
+      body = nil
+      if method != 'GET'
+        body = params.length > 0 ? params.to_json : nil
+      end
+      data = endpoint + timestamp.to_s + method + body.to_s
+
+      {
+          :"X-Digest-Key" => @key,
+          :"X-Digest-Signature" => OpenSSL::HMAC.hexdigest('sha256', @secret, data),
+          :"X-Digest-Timestamp" => timestamp,
+          :"User-Agent" => @client_name + " " + @client_version + " (" + @key + ")"
+      }
+
+    end
+
+
+    private
+    def log(text)
+
+      if @log_file == nil
+        return
+      end
+
+      File.open(@log_file, 'a') { |f| f.write(Time.now.utc.rfc822 + " [HlrLookupsSDK] " + text + "\n") }
+      # print Time.now.utc.rfc822 + " [HlrLookupsSDK] " + text + "\n"
+
+    end
+
+  end
+
+end

data/lib/ruby_hlr_client/config.rb

@@ -0,0 +1,11 @@
+module HlrLookupsSDK
+
+  CLIENT_VERSION = '2.0.1'
+
+  CLIENT_NAME = 'ruby_hlr_client'
+
+  API_VERSION = 'v2'
+
+  CONNECT_URL = 'https://www.hlr-lookups.com/api/'
+
+end

data/ruby_hlr_client.gemspec

@@ -1,26 +1,23 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path('../lib', __FILE__)
-require 'ruby_hlr_client/version'
+require 'ruby_hlr_client/config'
 
 Gem::Specification.new do |s|
   s.name        = 'ruby_hlr_client'
-  s.version     = RubyHlrClient::VERSION
+  s.version     = HlrLookupsSDK::CLIENT_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.homepage    = 'https://www.hlr-lookups.com'
+  s.summary     = %q{HLR Lookups SDK. Obtain live mobile phone connectivity and portability data from network operators directly.}
   s.licenses    = ['Apache-2.0']
+  s.required_ruby_version = '>= 2.0.0'
 
-
-  s.add_dependency 'sinatra'
-  s.add_dependency 'rest_client'
-  s.add_dependency 'json'
-
-  s.rubyforge_project = 'ruby_hlr_client'
+  s.add_runtime_dependency 'rest-client', '~> 2.1', '>= 2.1.0'
+  s.add_runtime_dependency 'json', '~> 2.3', '>= 2.3.0'
 
   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
+end

metadata

@@ -1,120 +1,91 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: ruby_hlr_client
-version: !ruby/object:Gem::Version 
-  hash: 1
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 15
-  version: 0.0.15
+version: !ruby/object:Gem::Version
+  version: 2.0.1
 platform: ruby
-authors: 
+authors:
 - Velocity Made Good Ltd.
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-
-date: 2015-12-04 00:00:00 +00:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: sinatra
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+date: 2020-08-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
     - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rest_client
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
     - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
   name: json
-  prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
     - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
   type: :runtime
-  version_requirements: *id003
-description: 
-email: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+description:
+email:
 - service@hlr-lookups.com
-executables: 
-- test_callback_handler.rb
-- test_client.rb
+executables: []
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- .gitignore
+files:
+- ".gitignore"
 - Gemfile
-- Rakefile
-- bin/test_callback_handler.rb
-- bin/test_client.rb
-- create_gem.txt
+- examples/example.rb
 - lib/ruby_hlr_client.rb
-- lib/ruby_hlr_client/hlr_callback_handler.rb
-- lib/ruby_hlr_client/hlr_client.rb
-- lib/ruby_hlr_client/version.rb
+- lib/ruby_hlr_client/client.rb
+- lib/ruby_hlr_client/config.rb
 - ruby_hlr_client.gemspec
-has_rdoc: true
-homepage: http://www.hlr-lookups.com
-licenses: 
+homepage: https://www.hlr-lookups.com
+licenses:
 - Apache-2.0
-post_install_message: 
+metadata: {}
+post_install_message:
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  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
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: ruby_hlr_client
-rubygems_version: 1.3.7
-signing_key: 
-specification_version: 3
-summary: Official HLR Lookup API Ruby SDK by www.hlr-lookups.com
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: HLR Lookups SDK. Obtain live mobile phone connectivity and portability data
+  from network operators directly.
 test_files: []
-

data/Rakefile

@@ -1 +0,0 @@
-require 'bundler/gem_tasks'

data/bin/test_callback_handler.rb

@@ -1,23 +0,0 @@
-#!/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,84 +0,0 @@
-#!/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 +0,0 @@
-1. rake install
-2. cd pkg/; gem push ruby_hlr_client-VERSION.gem

data/lib/ruby_hlr_client/hlr_callback_handler.rb

@@ -1,36 +0,0 @@
-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,237 +0,0 @@
-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_number_type_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 +0,0 @@
-module RubyHlrClient
-  VERSION = '0.0.15'
-end