Skip to content

intrigueio/NeutrinoAPI-Ruby

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Getting started

The general-purpose API

Initialization

Authentication

In order to setup authentication and initialization of the API client, you need the following information.

Parameter Description
user_id Your user ID
api_key Your API key

API client can be initialized as following.

# Configuration parameters and credentials
user_id = 'user_id' # Your user ID
api_key = 'api_key' # Your API key

client = NeutrinoApi::NeutrinoApiClient.new(
  user_id: user_id,
  api_key: api_key
)

Class Reference

List of Controllers

Class: Imaging

Get singleton instance

The singleton instance of the Imaging class can be accessed from the API Client.

imaging_controller = client.imaging

Method: image_resize

Resize an image and output as either JPEG or PNG. See: https://www.neutrinoapi.com/api/image-resize/

def image_resize(image_url,
                     width,
                     height,
                     format = 'png'); end

Parameters

Parameter Tags Description
image_url Required The URL to the source image
width Required The width to resize to (in px) while preserving aspect ratio
height Required The height to resize to (in px) while preserving aspect ratio
format Optional DefaultValue The output image format, can be either png or jpg

Example Usage

image_url = 'image-url'
width = 105
height = 105
format = 'png'

result = imaging_controller.image_resize(image_url, width, height, format)

Method: qr_code

Generate a QR code as a PNG image. See: https://www.neutrinoapi.com/api/qr-code/

def qr_code(content,
                width = 256,
                height = 256,
                fg_color = '#000000',
                bg_color = '#ffffff'); end

Parameters

Parameter Tags Description
content Required The content to encode into the QR code (e.g. a URL or a phone number)
width Optional DefaultValue The width of the QR code (in px)
height Optional DefaultValue The height of the QR code (in px)
fg_color Optional DefaultValue The QR code foreground color
bg_color Optional DefaultValue The QR code background color

Example Usage

content = 'content'
width = 256
height = 256
fg_color = '#000000'
bg_color = '#ffffff'

result = imaging_controller.qr_code(content, width, height, fg_color, bg_color)

Method: image_watermark

Watermark one image with another image. See: https://www.neutrinoapi.com/api/image-watermark/

def image_watermark(image_url,
                        watermark_url,
                        opacity = 50,
                        format = 'png',
                        position = 'center',
                        width = nil,
                        height = nil); end

Parameters

Parameter Tags Description
image_url Required The URL to the source image
watermark_url Required The URL to the watermark image
opacity Optional DefaultValue The opacity of the watermark (0 to 100)
format Optional DefaultValue The output image format, can be either png or jpg
position Optional DefaultValue The position of the watermark image, possible values are: center, top-left, top-center, top-right, bottom-left, bottom-center, bottom-right
width Optional If set resize the resulting image to this width (in px) while preserving aspect ratio
height Optional If set resize the resulting image to this height (in px) while preserving aspect ratio

Example Usage

image_url = 'image-url'
watermark_url = 'watermark-url'
opacity = 50
format = 'png'
position = 'center'
width = 105
height = 105

result = imaging_controller.image_watermark(image_url, watermark_url, opacity, format, position, width, height)

Method: html5_render

Render HTML content to PDF, JPG or PNG. See: https://www.neutrinoapi.com/api/html5-render/

def html5_render(content,
                     format = 'PDF',
                     page_size = 'A4',
                     title = nil,
                     margin = 0,
                     margin_left = 0,
                     margin_right = 0,
                     margin_top = 0,
                     margin_bottom = 0,
                     landscape = false,
                     zoom = 1,
                     grayscale = false,
                     media_print = false,
                     media_queries = false,
                     forms = false,
                     css = nil,
                     image_width = 1024,
                     image_height = nil,
                     render_delay = 0,
                     header_text_left = nil,
                     header_text_center = nil,
                     header_text_right = nil,
                     header_size = 9,
                     header_font = 'Courier',
                     header_font_size = 11,
                     header_line = false,
                     footer_text_left = nil,
                     footer_text_center = nil,
                     footer_text_right = nil,
                     footer_size = 9,
                     footer_font = 'Courier',
                     footer_font_size = 11,
                     footer_line = false,
                     page_width = nil,
                     page_height = nil); end

Parameters

Parameter Tags Description
content Required The HTML content. This can be either a URL to load HTML from or an actual HTML content string
format Optional DefaultValue Which format to output, available options are: PDF, PNG, JPG
page_size Optional DefaultValue Set the document page size, can be one of: A0 - A9, B0 - B10, Comm10E, DLE or Letter
title Optional The document title
margin Optional DefaultValue The document margin (in mm)
margin_left Optional DefaultValue The document left margin (in mm)
margin_right Optional DefaultValue The document right margin (in mm)
margin_top Optional DefaultValue The document top margin (in mm)
margin_bottom Optional DefaultValue The document bottom margin (in mm)
landscape Optional DefaultValue Set the document to lanscape orientation
zoom Optional DefaultValue Set the zoom factor when rendering the page (2.0 for double size, 0.5 for half size)
grayscale Optional DefaultValue Render the final document in grayscale
media_print Optional DefaultValue Use @media print CSS styles to render the document
media_queries Optional DefaultValue Activate all @media queries before rendering. This can be useful if you wan't to render the mobile version of a responsive website
forms Optional DefaultValue Generate real (fillable) PDF forms from HTML forms
css Optional Inject custom CSS into the HTML. e.g. 'body { background-color: red;}'
image_width Optional DefaultValue If rendering to an image format (PNG or JPG) use this image width (in pixels)
image_height Optional If rendering to an image format (PNG or JPG) use this image height (in pixels). The default is automatic which dynamically sets the image height based on the content
render_delay Optional DefaultValue Number of milliseconds to wait before rendering the page (can be useful for pages with animations etc)
header_text_left Optional Text to print to the left-hand side header of each page. e.g. 'My header - Page {page_number} of {total_pages}'
header_text_center Optional Text to print to the center header of each page
header_text_right Optional Text to print to the right-hand side header of each page
header_size Optional DefaultValue The height of your header (in mm)
header_font Optional DefaultValue Set the header font. Fonts available: Times, Courier, Helvetica, Arial
header_font_size Optional DefaultValue Set the header font size (in pt)
header_line Optional DefaultValue Draw a full page width horizontal line under your header
footer_text_left Optional Text to print to the left-hand side footer of each page. e.g. 'My footer - Page {page_number} of {total_pages}'
footer_text_center Optional Text to print to the center header of each page
footer_text_right Optional Text to print to the right-hand side header of each page
footer_size Optional DefaultValue The height of your footer (in mm)
footer_font Optional DefaultValue Set the footer font. Fonts available: Times, Courier, Helvetica, Arial
footer_font_size Optional DefaultValue Set the footer font size (in pt)
footer_line Optional DefaultValue Draw a full page width horizontal line above your footer
page_width Optional Set the PDF page width explicitly (in mm)
page_height Optional Set the PDF page height explicitly (in mm)

Example Usage

content = 'content'
format = 'PDF'
page_size = 'A4'
title = 'title'
margin = 0
margin_left = 0
margin_right = 0
margin_top = 0
margin_bottom = 0
landscape = false
zoom = 1
grayscale = false
media_print = false
media_queries = false
forms = false
css = 'css'
image_width = 1024
image_height = 105
render_delay = 0
header_text_left = 'header-text-left'
header_text_center = 'header-text-center'
header_text_right = 'header-text-right'
header_size = 9
header_font = 'Courier'
header_font_size = 11
header_line = false
footer_text_left = 'footer-text-left'
footer_text_center = 'footer-text-center'
footer_text_right = 'footer-text-right'
footer_size = 9
footer_font = 'Courier'
footer_font_size = 11
footer_line = false
page_width = 105
page_height = 105

result = imaging_controller.html5_render(content, format, page_size, title, margin, margin_left, margin_right, margin_top, margin_bottom, landscape, zoom, grayscale, media_print, media_queries, forms, css, image_width, image_height, render_delay, header_text_left, header_text_center, header_text_right, header_size, header_font, header_font_size, header_line, footer_text_left, footer_text_center, footer_text_right, footer_size, footer_font, footer_font_size, footer_line, page_width, page_height)

Back to List of Controllers

Class: Telephony

Get singleton instance

The singleton instance of the Telephony class can be accessed from the API Client.

telephony_controller = client.telephony

Method: verify_security_code

Check if a security code from one of the verify APIs is valid. See: https://www.neutrinoapi.com/api/verify-security-code/

def verify_security_code(security_code); end

Parameters

Parameter Tags Description
security_code Required The security code to verify

Example Usage

security_code = 'security-code'

result = telephony_controller.verify_security_code(security_code)

Method: hlr_lookup

Connect to the global mobile cellular network and retrieve the status of a mobile device. See: https://www.neutrinoapi.com/api/hlr-lookup/

def hlr_lookup(number,
                   country_code = nil); end

Parameters

Parameter Tags Description
number Required A phone number
country_code Optional ISO 2-letter country code, assume numbers are based in this country. If not set numbers are assumed to be in international format (with or without the leading + sign)

Example Usage

number = 'number'
country_code = 'country-code'

result = telephony_controller.hlr_lookup(number, country_code)

Method: phone_playback

Make an automated call to any valid phone number and playback an audio message. See: https://www.neutrinoapi.com/api/phone-playback/

def phone_playback(number,
                       audio_url); end

Parameters

Parameter Tags Description
number Required The phone number to call. Must be in valid international format
audio_url Required A URL to a valid audio file. Accepted audio formats are:
  • MP3
  • WAV
  • OGG
You can use the following MP3 URL for testing: https://www.neutrinoapi.com/test-files/test1.mp3

Example Usage

number = 'number'
audio_url = 'audio-url'

result = telephony_controller.phone_playback(number, audio_url)

Method: sms_verify

Send a unique security code to any mobile device via SMS. See: https://www.neutrinoapi.com/api/sms-verify/

def sms_verify(number,
                   code_length = 5,
                   security_code = nil,
                   country_code = nil,
                   language_code = 'en'); end

Parameters

Parameter Tags Description
number Required The phone number to send a verification code to
code_length Optional DefaultValue The number of digits to use in the security code (must be between 4 and 12)
security_code Optional Pass in your own security code. This is useful if you have implemented TOTP or similar 2FA methods. If not set then we will generate a secure random code
country_code Optional ISO 2-letter country code, assume numbers are based in this country. If not set numbers are assumed to be in international format (with or without the leading + sign)
language_code Optional DefaultValue The language to send the verification code in, available languages are:
  • de - German
  • en - English
  • es - Spanish
  • fr - French
  • it - Italian
  • pt - Portuguese
  • ru - Russian

Example Usage

number = 'number'
code_length = 5
security_code = 105
country_code = 'country-code'
language_code = 'en'

result = telephony_controller.sms_verify(number, code_length, security_code, country_code, language_code)

Method: sms_message

Send a free-form message to any mobile device via SMS. See: https://www.neutrinoapi.com/api/sms-message/

def sms_message(number,
                    message,
                    country_code = nil); end

Parameters

Parameter Tags Description
number Required The phone number to send a message to
message Required The SMS message to send. Messages are truncated to a maximum of 150 characters for ASCII content OR 70 characters for UTF content
country_code Optional ISO 2-letter country code, assume numbers are based in this country. If not set numbers are assumed to be in international format (with or without the leading + sign)

Example Usage

number = 'number'
message = 'message'
country_code = 'country-code'

result = telephony_controller.sms_message(number, message, country_code)

Method: phone_verify

Make an automated call to any valid phone number and playback a unique security code. See: https://www.neutrinoapi.com/api/phone-verify/

def phone_verify(number,
                     code_length = 6,
                     security_code = nil,
                     playback_delay = 800,
                     country_code = nil,
                     language_code = 'en'); end

Parameters

Parameter Tags Description
number Required The phone number to send the verification code to
code_length Optional DefaultValue The number of digits to use in the security code (between 4 and 12)
security_code Optional Pass in your own security code. This is useful if you have implemented TOTP or similar 2FA methods. If not set then we will generate a secure random code
playback_delay Optional DefaultValue The delay in milliseconds between the playback of each security code
country_code Optional ISO 2-letter country code, assume numbers are based in this country. If not set numbers are assumed to be in international format (with or without the leading + sign)
language_code Optional DefaultValue The language to playback the verification code in, available languages are:
  • de - German
  • en - English
  • es - Spanish
  • fr - French
  • it - Italian
  • pt - Portuguese
  • ru - Russian

Example Usage

number = 'number'
code_length = 6
security_code = 105
playback_delay = 800
country_code = 'country-code'
language_code = 'en'

result = telephony_controller.phone_verify(number, code_length, security_code, playback_delay, country_code, language_code)

Back to List of Controllers

Class: DataTools

Get singleton instance

The singleton instance of the DataTools class can be accessed from the API Client.

dataTools_controller = client.data_tools

Method: email_validate

Parse, validate and clean an email address. See: https://www.neutrinoapi.com/api/email-validate/

def email_validate(email,
                       fix_typos = false); end

Parameters

Parameter Tags Description
email Required An email address
fix_typos Optional DefaultValue Automatically attempt to fix typos in the address

Example Usage

email = 'email'
fix_typos = false

result = dataTools_controller.email_validate(email, fix_typos)

Method: user_agent_info

Parse, validate and get detailed user-agent information from a user agent string. See: https://www.neutrinoapi.com/api/user-agent-info/

def user_agent_info(user_agent); end

Parameters

Parameter Tags Description
user_agent Required A user agent string

Example Usage

user_agent = 'user-agent'

result = dataTools_controller.user_agent_info(user_agent)

Method: bad_word_filter

Detect bad words, swear words and profanity in a given text. See: https://www.neutrinoapi.com/api/bad-word-filter/

def bad_word_filter(content,
                        censor_character = nil); end

Parameters

Parameter Tags Description
content Required The content to scan. This can be either a URL to load content from or an actual content string
censor_character Optional The character to use to censor out the bad words found

Example Usage

content = 'content'
censor_character = 'censor-character'

result = dataTools_controller.bad_word_filter(content, censor_character)

Method: convert

A powerful unit conversion tool. See: https://www.neutrinoapi.com/api/convert/

def convert(from_value,
                from_type,
                to_type); end

Parameters

Parameter Tags Description
from_value Required The value to convert from (e.g. 10.95)
from_type Required The type of the value to convert from (e.g. USD)
to_type Required The type to convert to (e.g. EUR)

Example Usage

from_value = 'from-value'
from_type = 'from-type'
to_type = 'to-type'

result = dataTools_controller.convert(from_value, from_type, to_type)

Method: phone_validate

Parse, validate and get location information about a phone number. See: https://www.neutrinoapi.com/api/phone-validate/

def phone_validate(number,
                       country_code = nil,
                       ip = nil); end

Parameters

Parameter Tags Description
number Required A phone number. This can be in international format (E.164) or local format. If passing local format you should use the 'country-code' or 'ip' options as well
country_code Optional ISO 2-letter country code, assume numbers are based in this country. If not set numbers are assumed to be in international format (with or without the leading + sign)
ip Optional Pass in a users IP address and we will assume numbers are based in the country of the IP address

Example Usage

number = 'number'
country_code = 'country-code'
ip = 'ip'

result = dataTools_controller.phone_validate(number, country_code, ip)

Back to List of Controllers

Class: SecurityAndNetworking

Get singleton instance

The singleton instance of the SecurityAndNetworking class can be accessed from the API Client.

securityAndNetworking_controller = client.security_and_networking

Method: ip_probe

Analyze and extract provider information for an IP address. See: https://www.neutrinoapi.com/api/ip-probe/

def ip_probe(ip); end

Parameters

Parameter Tags Description
ip Required IPv4 or IPv6 address

Example Usage

ip = 'ip'

result = securityAndNetworking_controller.ip_probe(ip)

Method: email_verify

SMTP based email address verification. See: https://www.neutrinoapi.com/api/email-verify/

def email_verify(email,
                     fix_typos = false); end

Parameters

Parameter Tags Description
email Required An email address
fix_typos Optional DefaultValue Automatically attempt to fix typos in the address

Example Usage

email = 'email'
fix_typos = false

result = securityAndNetworking_controller.email_verify(email, fix_typos)

Method: ip_blocklist

The IP Blocklist API will detect potentially malicious or dangerous IP addresses. See: https://www.neutrinoapi.com/api/ip-blocklist/

def ip_blocklist(ip); end

Parameters

Parameter Tags Description
ip Required An IPv4 or IPv6 address

Example Usage

ip = 'ip'

result = securityAndNetworking_controller.ip_blocklist(ip)

Method: host_reputation

Check the reputation of an IP address, domain name, FQDN or URL against a comprehensive list of blacklists and blocklists. See: https://www.neutrinoapi.com/api/host-reputation/

def host_reputation(host,
                        list_rating = 3); end

Parameters

Parameter Tags Description
host Required An IP address, domain name, FQDN or URL. If you supply a domain/URL it will be checked against the URI DNSBL lists
list_rating Optional DefaultValue Only check lists with this rating or better

Example Usage

host = 'host'
list_rating = 3

result = securityAndNetworking_controller.host_reputation(host, list_rating)

Back to List of Controllers

Class: Geolocation

Get singleton instance

The singleton instance of the Geolocation class can be accessed from the API Client.

geolocation_controller = client.geolocation

Method: geocode_reverse

Convert a geographic coordinate (latitude and longitude) into a real world address. See: https://www.neutrinoapi.com/api/geocode-reverse/

def geocode_reverse(latitude,
                        longitude,
                        language_code = 'en',
                        zoom = 'address'); end

Parameters

Parameter Tags Description
latitude Required The location latitude in decimal degrees format
longitude Required The location longitude in decimal degrees format
language_code Optional DefaultValue The language to display results in, available languages are:
  • de, en, es, fr, it, pt, ru
zoom Optional DefaultValue The zoom level to respond with:
  • address - the most precise address available
  • street - the street level
  • city - the city level
  • state - the state level
  • country - the country level

Example Usage

latitude = 'latitude'
longitude = 'longitude'
language_code = 'en'
zoom = 'address'

result = geolocation_controller.geocode_reverse(latitude, longitude, language_code, zoom)

Method: ip_info

Get location information about an IP address and do reverse DNS (PTR) lookups. See: https://www.neutrinoapi.com/api/ip-info/

def ip_info(ip,
                reverse_lookup = false); end

Parameters

Parameter Tags Description
ip Required IPv4 or IPv6 address
reverse_lookup Optional DefaultValue Do a reverse DNS (PTR) lookup. This option can add extra delay to the request so only use it if you need it

Example Usage

ip = 'ip'
reverse_lookup = false

result = geolocation_controller.ip_info(ip, reverse_lookup)

Method: geocode_address

Geocode an address, partial address or just the name of a place. See: https://www.neutrinoapi.com/api/geocode-address/

def geocode_address(address,
                        country_code = nil,
                        language_code = 'en',
                        fuzzy_search = false); end

Parameters

Parameter Tags Description
address Required The address, partial address or name of a place to try and locate
country_code Optional The ISO 2-letter country code to be biased towards (the default is no country bias)
language_code Optional DefaultValue The language to display results in, available languages are:
  • de, en, es, fr, it, pt, ru
fuzzy_search Optional DefaultValue If no matches are found for the given address, start performing a recursive fuzzy search until a geolocation is found. This option is recommended for processing user input or implementing auto-complete. We use a combination of approximate string matching and data cleansing to find possible location matches

Example Usage

address = 'address'
country_code = 'country-code'
language_code = 'en'
fuzzy_search = false

result = geolocation_controller.geocode_address(address, country_code, language_code, fuzzy_search)

Back to List of Controllers

Class: ECommerce

Get singleton instance

The singleton instance of the ECommerce class can be accessed from the API Client.

eCommerce_controller = client.e_commerce

Method: bin_lookup

Perform a BIN (Bank Identification Number) or IIN (Issuer Identification Number) lookup. See: https://www.neutrinoapi.com/api/bin-lookup/

def bin_lookup(bin_number,
                   customer_ip = nil); end

Parameters

Parameter Tags Description
bin_number Required The BIN or IIN number (the first 6 digits of a credit card number)
customer_ip Optional Pass in the customers IP address and we will return some extra information about them

Example Usage

bin_number = 'bin-number'
customer_ip = 'customer-ip'

result = eCommerce_controller.bin_lookup(bin_number, customer_ip)

Back to List of Controllers

Class: WWW

Get singleton instance

The singleton instance of the WWW class can be accessed from the API Client.

wWW_controller = client.www

Method: url_info

Parse, analyze and retrieve content from the supplied URL. See: https://www.neutrinoapi.com/api/url-info/

def url_info(url,
                 fetch_content = false,
                 ignore_certificate_errors = false,
                 timeout = 20); end

Parameters

Parameter Tags Description
url Required The URL to probe
fetch_content Optional DefaultValue If this URL responds with html, text, json or xml then return the response. This option is useful if you want to perform further processing on the URL content (e.g. with the HTML Extract or HTML Clean APIs)
ignore_certificate_errors Optional DefaultValue Ignore any TLS/SSL certificate errors and load the URL anyway
timeout Optional DefaultValue Timeout in seconds. Give up if still trying to load the URL after this number of seconds

Example Usage

url = 'url'
fetch_content = false
ignore_certificate_errors = false
timeout = 20

result = wWW_controller.url_info(url, fetch_content, ignore_certificate_errors, timeout)

Method: html_clean

Clean and sanitize untrusted HTML. See: https://www.neutrinoapi.com/api/html-clean/

def html_clean(content,
                   output_type); end

Parameters

Parameter Tags Description
content Required The HTML content. This can be either a URL to load HTML from or an actual HTML content string
output_type Required The level of sanitization, possible values are: plain-text: reduce the content to plain text only (no HTML tags at all) simple-text: allow only very basic text formatting tags like b, em, i, strong, u basic-html: allow advanced text formatting and hyper links basic-html-with-images: same as basic html but also allows image tags advanced-html: same as basic html with images but also allows many more common HTML tags like table, ul, dl, pre

Example Usage

content = 'content'
output_type = 'output-type'

result = wWW_controller.html_clean(content, output_type)

Method: browser_bot

Browser bot can extract content, interact with keyboard and mouse events, and execute JavaScript on a website. See: https://www.neutrinoapi.com/api/browser-bot/

def browser_bot(url,
                    timeout = 30,
                    delay = 3,
                    selector = nil,
                    exec = nil,
                    user_agent = nil,
                    ignore_certificate_errors = false); end

Parameters

Parameter Tags Description
url Required The URL to load
timeout Optional DefaultValue Timeout in seconds. Give up if still trying to load the page after this number of seconds
delay Optional DefaultValue Delay in seconds to wait before capturing any page data, executing selectors or JavaScript
selector Optional Extract content from the page DOM using this selector. Commonly known as a CSS selector, you can find a good reference here
exec Optional Collection Execute JavaScript on the page. Each array element should contain a valid JavaScript statement in string form. If a statement returns any kind of value it will be returned in the 'exec-results' response. For your convenience you can also use the following special shortcut functions:
sleep(seconds); Just wait/sleep for the specified number of seconds. click('selector'); Click on the first element matching the given selector. focus('selector'); Focus on the first element matching the given selector. keys('characters'); Send the specified keyboard characters. Use click() or focus() first to send keys to a specific element. enter(); Send the Enter key. tab(); Send the Tab key.
Example:
[ "click('#button-id')", "sleep(1)", "click('.field-class')", "keys('1234')", "enter()" ]
user_agent Optional Override the browsers default user-agent string with this one
ignore_certificate_errors Optional DefaultValue Ignore any TLS/SSL certificate errors and load the page anyway

Example Usage

url = 'url'
timeout = 30
delay = 3
selector = 'selector'
exec = ['exec']
user_agent = 'user-agent'
ignore_certificate_errors = false

result = wWW_controller.browser_bot(url, timeout, delay, selector, exec, user_agent, ignore_certificate_errors)

Back to List of Controllers

About

Neutrino API SDK - A Ruby Gem based on Ruby >= 2.0.0

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Ruby 100.0%