ruby_ip_client 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4aa99af743da230cf8233c3a7d454f4c43d4afd0
+  data.tar.gz: 9127df5bc0d33c41057630f89ecb908f7652059f
+SHA512:
+  metadata.gz: a679dd2bd92c6803aa8b193852d8c540bf761fa2d072623db42e119ffb531a70e9673444e37e23e1efd4cb5d43bd1cccdee133e82a8955b216287d57a4a60db3
+  data.tar.gz: 0b4dc18485b0c0d3132f2fcce6dc2d732dbb939c95425a516bd06941d1ff02ff4e977886a98bb18f8e7be931f02304700dc07ecd3b1f7b73e67c140e6567a4f2

data/Gemfile

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

data/Rakefile

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

data/bin/test_ip_callback_handler.rb

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+
+require 'sinatra'
+require 'ruby_ip_client/ip_callback_handler'
+
+set :run, true
+
+get '/' do
+
+  client = RubyIpClient::IpCallbackHandler.new
+
+    # Parses an asynchronous IP Lookup callback and returns a JSON string with the results.
+    # @param params
+    # @returns {*}
+    #
+    # Params example: {"success":true,"results":[{"context":{"id":"3ac9069dc6e9","ip":"85.10.208.227","state":"COMPLETED","storage":"ASYNC-API-2017-02","engine":"IV1","interface":"Async API","cost":"0.01000","timeStamp":"2017-02-09 22:57:33.80855+08"},"geolocation":{"country":"Germany","region":"Bavaria","countryCode":"DE","regionCode":"BY","city":"Nuremberg","zip":"90455","latitude":"49.44780","longitude":"11.06830","radius":200,"timeZone":"Europe\/Berlin","averageIncome":null,"populationDensity":null,"dmaCode":null},"network":{"connectionType":"HOSTING","asn":"24940","asnOrganization":"Hetzner Online GmbH","isp":"Hetzner Online GmbH","ispOrganization":"Hetzner Online GmbH","domain":"your-server.de","registeredCountry":"Germany","registeredCountryCode":"DE","isRoutable":true},"threatIntelligence":{"threatLevel":"VERY_HIGH","threatIntelligenceScore":"1.00000","genericBlacklistMatch":false,"proxyBlacklistMatch":false,"torBlacklistMatch":false,"vpnBlacklistMatch":false,"malwareBlacklistMatch":false,"spywareBlacklistMatch":false,"hijackBlacklistMatch":false,"crawlerBlacklistMatch":false,"botBlacklistMatch":false,"spamBotBlacklistMatch":false,"exploitBotBlacklistMatch":false,"dshieldBlacklistMatch":false}}]}
+    print client.parse_callback(params)
+
+  # send HTTP response body (OK)
+  content_type :text
+  return client.send_response
+
+end

data/bin/test_ip_client.rb

@@ -0,0 +1,49 @@
+#!/usr/bin/env ruby
+
+require 'ruby_ip_client/ip_client'
+
+# Initializes the IP Lookup Client
+# @param username - www.ip-lookups.com username
+# @param password - www.ip-lookups.com password
+# @constructor
+client = RubyIpClient::IpClient.new(
+    'username',
+    'password'
+)
+print "\n"
+
+
+# Submits a synchronous IP Lookup request. The IP is queried in real time and results presented in the response body.
+# @param ip - An IPv4 or IPv6 address
+# @param engine - An optional engine assignment, see: http://www.ip-lookups.com/en/data-source-engines
+# @param storage - An optional storage assignment, see: http://www.ip-lookups.com/en/storages
+# @returns string (JSON)
+#
+# Return example: {"success":true,"results":{"context":{"id":"7044a161c662","ip":"23.105.134.61","state":"COMPLETED","storage":"SYNC-API-2017-02","engine":"IV1","interface":"Sync API","cost":"0.01000","timeStamp":"2017-02-18 18:27:50.267098+08"},"geolocation":{"country":"United States","region":"Arizona","countryCode":"US","regionCode":"AZ","city":"Phoenix","zip":"85054","latitude":"33.67480","longitude":"-111.95190","radius":1000,"timeZone":"America\/Phoenix","averageIncome":null,"populationDensity":null,"dmaCode":753},"network":{"connectionType":"HOSTING","asn":"15003","asnOrganization":"Nobis Technology Group, LLC","isp":"Nobis Technology Group, LLC","ispOrganization":"Nobis Technology Group, LLC","domain":"ubiquity.io","registeredCountry":"United States","registeredCountryCode":"US","isRoutable":true},"threatIntelligence":{"threatLevel":"VERY_HIGH","threatIntelligenceScore":"1.00000","genericBlacklistMatch":true,"proxyBlacklistMatch":true,"torBlacklistMatch":false,"vpnBlacklistMatch":true,"malwareBlacklistMatch":false,"spywareBlacklistMatch":false,"hijackBlacklistMatch":false,"crawlerBlacklistMatch":false,"botBlacklistMatch":false,"spamBotBlacklistMatch":false,"exploitBotBlacklistMatch":false,"dshieldBlacklistMatch":false}}}
+print client.submit_sync_lookup('85.10.208.227', 'IV1', 'SDK-TEST')
+print "\n\n"
+
+# Sets the callback URL for asynchronous IP lookups. Read more about the concept of asynchronous IP lookups @ http://www.ip-lookups.com/en/asynchronous-ip-lookup-api
+# @param url - callback url on your server
+# @returns string (JSON)
+#
+# Return example: {"success":true,"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 IP Lookups containing up to 1,000 IPs per request. Results are sent back asynchronously to a callback URL on your server.
+# @param ips - A list of IPv4 or IPv6 addresses
+# @param engine - An optional engine assignment, see: http://www.ip-lookups.com/en/data-source-engines
+# @param storage - An optional storage assignment, see: http://www.ip-lookups.com/en/storages
+# @returns string (JSON)
+#
+# Return example: {"success":true,"results":{"acceptedIps":[{"id":"58cc4f7c4afc","ip":"85.10.208.227"},{"id":"d40499b8605c","ip":"85.10.208.228"},{"id":"8bdc66d4ce52","ip":"85.208.221.221"}],"rejectedIps":[],"acceptedIpCount":3,"rejectedIpCount":0,"totalCount":3,"cost":0.03,"storage":"ASYNC-API-2017-02","engine":"IV1"}}
+print client.submit_async_lookup(['85.10.208.227', '85.10.208.228'])
+print "\n\n"
+
+# Returns the remaining balance (EUR) in your account.
+# @returns string (JSON)
+#
+# Return example: {"success":true,"results":{"balance":"5878.24600"}}
+print client.get_balance
+print "\n\n"

data/create_gem.txt

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

data/lib/ruby_ip_client.rb

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

data/lib/ruby_ip_client/ip_callback_handler.rb

@@ -0,0 +1,36 @@
+require 'json'
+
+module RubyIpClient
+  class IpCallbackHandler
+
+    # Parses an asynchronous IP Lookup callback and returns a JSON string with the results.
+    # @param params
+    # @returns {*}
+    #
+    # Params example: {"success":true,"results":[{"context":{"id":"3ac9069dc6e9","ip":"85.10.208.227","state":"COMPLETED","storage":"ASYNC-API-2017-02","engine":"IV1","interface":"Async API","cost":"0.01000","timeStamp":"2017-02-09 22:57:33.80855+08"},"geolocation":{"country":"Germany","region":"Bavaria","countryCode":"DE","regionCode":"BY","city":"Nuremberg","zip":"90455","latitude":"49.44780","longitude":"11.06830","radius":200,"timeZone":"Europe\/Berlin","averageIncome":null,"populationDensity":null,"dmaCode":null},"network":{"connectionType":"HOSTING","asn":"24940","asnOrganization":"Hetzner Online GmbH","isp":"Hetzner Online GmbH","ispOrganization":"Hetzner Online GmbH","domain":"your-server.de","registeredCountry":"Germany","registeredCountryCode":"DE","isRoutable":true},"threatIntelligence":{"threatLevel":"VERY_HIGH","threatIntelligenceScore":"1.00000","genericBlacklistMatch":false,"proxyBlacklistMatch":false,"torBlacklistMatch":false,"vpnBlacklistMatch":false,"malwareBlacklistMatch":false,"spywareBlacklistMatch":false,"hijackBlacklistMatch":false,"crawlerBlacklistMatch":false,"botBlacklistMatch":false,"spamBotBlacklistMatch":false,"exploitBotBlacklistMatch":false,"dshieldBlacklistMatch":false}}]}
+    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_ip_client/ip_client.rb

@@ -0,0 +1,150 @@
+require 'rest-client'
+require 'json'
+
+module RubyIpClient
+
+  class IpClient
+
+    # Initializes the IP Lookup Client
+    # @param username - www.ip-lookups.com username
+    # @param password - www.ip-lookups.com password
+    # @constructor
+    def initialize(username, password)
+      @username = username
+      @password = password
+      @url = "https://www.ip-lookups.com/api"
+    end
+
+    # Submits a synchronous IP Lookup request. The IP is queried in real time and results presented in the response body.
+    # @param ip - An IPv4 or IPv6 address
+    # @param engine - An optional engine assignment, see: http://www.ip-lookups.com/en/data-source-engines
+    # @param storage - An optional storage assignment, see: http://www.ip-lookups.com/en/storages
+    # @returns string (JSON)
+    #
+    # Return example: {"success":true,"results":{"context":{"id":"7044a161c662","ip":"23.105.134.61","state":"COMPLETED","storage":"SYNC-API-2017-02","engine":"IV1","interface":"Sync API","cost":"0.01000","timeStamp":"2017-02-18 18:27:50.267098+08"},"geolocation":{"country":"United States","region":"Arizona","countryCode":"US","regionCode":"AZ","city":"Phoenix","zip":"85054","latitude":"33.67480","longitude":"-111.95190","radius":1000,"timeZone":"America\/Phoenix","averageIncome":null,"populationDensity":null,"dmaCode":753},"network":{"connectionType":"HOSTING","asn":"15003","asnOrganization":"Nobis Technology Group, LLC","isp":"Nobis Technology Group, LLC","ispOrganization":"Nobis Technology Group, LLC","domain":"ubiquity.io","registeredCountry":"United States","registeredCountryCode":"US","isRoutable":true},"threatIntelligence":{"threatLevel":"VERY_HIGH","threatIntelligenceScore":"1.00000","genericBlacklistMatch":true,"proxyBlacklistMatch":true,"torBlacklistMatch":false,"vpnBlacklistMatch":true,"malwareBlacklistMatch":false,"spywareBlacklistMatch":false,"hijackBlacklistMatch":false,"crawlerBlacklistMatch":false,"botBlacklistMatch":false,"spamBotBlacklistMatch":false,"exploitBotBlacklistMatch":false,"dshieldBlacklistMatch":false}}}
+    def submit_sync_lookup(ip, engine = nil, storage = nil)
+
+      params = {
+        :action => 'submitSyncLookup',
+        :ip => ip,
+        :username => @username,
+        :password => @password
+      }
+
+      unless engine.nil?
+        params.merge!(engine: engine)
+      end
+
+      unless storage.nil?
+        params.merge!(storage: storage)
+      end
+
+      send_request(params)
+
+    end
+
+    # Submits asynchronous IP Lookups containing up to 1,000 IPs per request. Results are sent back asynchronously to a callback URL on your server.
+    # @param ips - A list of IPv4 or IPv6 addresses
+    # @param engine - An optional engine assignment, see: http://www.ip-lookups.com/en/data-source-engines
+    # @param storage - An optional storage assignment, see: http://www.ip-lookups.com/en/storages
+    # @returns string (JSON)
+    #
+    # Return example: {"success":true,"results":{"acceptedIps":[{"id":"58cc4f7c4afc","ip":"85.10.208.227"},{"id":"d40499b8605c","ip":"85.10.208.228"},{"id":"8bdc66d4ce52","ip":"85.208.221.221"}],"rejectedIps":[],"acceptedIpCount":3,"rejectedIpCount":0,"totalCount":3,"cost":0.03,"storage":"ASYNC-API-2017-02","engine":"IV1"}}
+    def submit_async_lookup(ips, engine = nil, storage = nil)
+
+      params = {
+          :action => 'submitAsyncLookup',
+          :ips => ips_to_string(ips),
+          :username => @username,
+          :password => @password
+      }
+
+      unless engine.nil?
+        params.merge!(engine: engine)
+      end
+
+      unless storage.nil?
+        params.merge!(storage: storage)
+      end
+
+      send_request(params)
+
+    end
+
+    # Sets the callback URL for asynchronous IP lookups. Read more about the concept of asynchronous IP lookups @ http://www.ip-lookups.com/en/asynchronous-ip-lookup-api
+    # @param url - callback url on your server
+    # @returns string (JSON)
+    #
+    # Return example: {"success":true,"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,"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 ips_to_string(ips)
+
+      string = ''
+      c = 0
+      ips.each { |ip|
+
+        if c > 0
+          string += ','
+        end
+
+        string += ip
+
+        c = c+1
+
+      }
+
+      string
+
+    end
+
+  end
+
+end

data/lib/ruby_ip_client/version.rb

@@ -0,0 +1,3 @@
+module RubyIpClient
+  VERSION = '1.0.0'
+end

data/ruby_ip_client.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'ruby_ip_client/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'ruby_ip_client'
+  s.version     = RubyIpClient::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Velocity Made Good Ltd.']
+  s.email       = ['service@ip-lookups.com']
+  s.homepage    = 'http://www.ip-lookups.com'
+  s.summary     = %q{Official HLR Lookup API Ruby SDK by www.ip-lookups.com}
+  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_ip_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,98 @@
+--- !ruby/object:Gem::Specification
+name: ruby_ip_client
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Velocity Made Good Ltd.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-19 00:00:00.000000000 Z
+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'
+  type: :runtime
+  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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- service@ip-lookups.com
+executables:
+- test_ip_callback_handler.rb
+- test_ip_client.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Rakefile
+- bin/test_ip_callback_handler.rb
+- bin/test_ip_client.rb
+- create_gem.txt
+- lib/ruby_ip_client.rb
+- lib/ruby_ip_client/ip_callback_handler.rb
+- lib/ruby_ip_client/ip_client.rb
+- lib/ruby_ip_client/version.rb
+- ruby_ip_client.gemspec
+homepage: http://www.ip-lookups.com
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: ruby_ip_client
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Official HLR Lookup API Ruby SDK by www.ip-lookups.com
+test_files: []