ruby_hlr_client 0.0.9

data/.gitignore

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

data/Gemfile

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

data/Rakefile

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

data/bin/test_callback_handler.rb

@@ -0,0 +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

data/bin/test_client.rb

@@ -0,0 +1,47 @@
+#!/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
+print "\n"

data/lib/ruby_hlr_client/hlr_callback_handler.rb

@@ -0,0 +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

data/lib/ruby_hlr_client/hlr_client.rb

@@ -0,0 +1,142 @@
+require 'rest_client'
+
+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
+
+    def send_request(params)
+
+      response = RestClient.get @url, :params => params
+
+      unless response.code == 200
+        return generate_error_result("HTTP Status Code #{response.code}")
+      end
+
+      response.to_str
+
+    end
+
+    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

@@ -0,0 +1,3 @@
+module RubyHlrClient
+  VERSION = '0.0.9'
+end

data/lib/ruby_hlr_client.rb

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

data/ruby_hlr_client.gemspec

@@ -0,0 +1,24 @@
+# -*- 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.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

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: ruby_hlr_client
+version: !ruby/object:Gem::Version
+  version: 0.0.9
+  prerelease: 
+platform: ruby
+authors:
+- Velocity Made Good Ltd.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rest_client
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- service@hlr-lookups.com
+executables:
+- test_callback_handler.rb
+- test_client.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Rakefile
+- bin/test_callback_handler.rb
+- bin/test_client.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
+- ruby_hlr_client.gemspec
+homepage: http://www.hlr-lookups.com
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: ruby_hlr_client
+rubygems_version: 1.8.29
+signing_key: 
+specification_version: 3
+summary: Official HLR Lookup API Ruby SDK by www.hlr-lookups.com
+test_files: []