InternetBS Client

InternetBS.configure do |config|
  config.credentials[:production][:api_key] = "B04B4E74C57C37DE4886"
  config.credentials[:production][:api_pwd] = "s3kr3t"
  config.credentials[:production][:api_uri] = "https://api.internet.bs"

  config.credentials[:test][:api_key] = "testapi"
  config.credentials[:test][:api_pwd] = "testpass"
  config.credentials[:test][:api_uri] = "https://testapi.internet.bs"
  
  config.credentials[:development][:api_key] = "testapi"
  config.credentials[:development][:api_pwd] = "testpass"
  config.credentials[:development][:api_uri] = "https://testapi.internet.bs"
end

# Set the environment to development:
InternetBS.environment = :development

# The set the credentials:
InternetBS.api_key = "B04B4E74C57C37DE4886"
InternetBS.api_pwd = "s3kr3t"
InternetBS.api_uri = "https://api.internet.bs"

InternetBS.credentials[:staging][:api_key] = "44CD64EEEFFF887755560B"
InternetBS.credentials[:staging][:api_pwd] = "another_pass"
InternetBS.credentials[:staging][:api_uri] = "https://api.internet.bs"

InternetBS.environments #=> [:production, :test, :development, :staging]

InternetBS.environment #=> :development

@balances = InternetBS::AccountBalances.new

result = @balances.fetch #=> true

# Alternatively you pass the currency you're interested in:
@balances.currency = 'USD'
result = @balances.fetch #=> true

# If the fetch method fails it will return false 
# and populate the errors collection attribute:
unless result
  @balances.errors.each do |error|
    puts error
  end
end

# Iterate the collection of balances:
@balances.each do |balance|
  puts balance.amount   #=> 1234.56
  puts balance.currency #=> 'USD'
end

@domains = InternetBS::AccountDomains.new

result = @domains.fetch #=> true

# If the fetch method fails it will return false 
# and populate the errors collection attribute:
unless result
  @account.errors.each do |error|
    puts error
  end
end

# Iterate the collection of domains:
@domains.list.each do |domain|
  puts domain.name #=> 'example.com'
end

@prices = InternetBS::AccountPrices.new

result = @prices.fetch #=> true

# If the fetch method fails it will return false 
# and populate the errors collection attribute:
unless result
  @prices.errors.each do |error|
    puts error
  end
end

@prices.list #=> an enumerable array of InternetBS::AccountPrice
@prices.list.size #=> 39

# Enumerate each
@prices.list.each do |price|
  puts price.name
  ...
end

# AccountPrice properties
price = @prices.list.select { |p| 
          p.name == '.com' && p.operation == 'registration'
        }
price.is_a?(InternetBS::AccountPrice) #=> true
price.currency #=> USD
price.name #=> .com
price.operation #=> registration
price.price_1_year #=> 8.99
price.price_2_years #=> 8.95
price.price_3_years #=> 8.93
price.price_4_years #=> 8.91
price.price_5_years #=> 8.89
price.price_6_years #=> 8.87
price.price_7_years #=> 8.85
price.price_8_years #=> 8.83
price.price_9_years #=> 8.81
price.price_10_years #=> 8.79

# Display the price level (only available from version 2 query):
@prices.level #=> Basic

@domain = InternetBS::DomainAvailability.new(:domain => 'acme.com')

result = @domain.fetch #=> true

# If the fetch method fails it will return false 
# and populate the errors collection attribute:
unless result
  @domain.errors.each do |error|
    puts error
  end
end

# Is the domain available?
puts @domain.available? #=> true

# Other properties you can check:
puts @domain.transaction_id #=> 234678268342423876
puts @domain.max_registration_period #=> 10 # years
puts @domain.min_registration_period #=> 1 # year
puts @domain.private_whois_allowed #=> true
puts @domain.realtime_registration #=> true
puts @domain.registrar_lock_allowed #=> true

# You can also heck the status attribute which will return a String containing one of the following: AVAILABLE, UNAVAILABLE or FAILURE:
puts @domains.status #=> AVAILABLE

@domain = InternetBS::DomainInformation.new(:domain => 'acme.com')

result = @domain.fetch #=> true

# If the fetch method fails it will return false 
# and populate the errors collection attribute:
unless result
  @domain.errors.each do |error|
    puts error
  end
end

# DomainInformation properties:
puts @domain.domain_status #=> REGISTERED
puts @domain.auto_renew #=> false
puts @domain.domain_extension #=> .com
puts @domain.expiration_date #=> 2011/03/05
puts @domain.private_whois #=> FULL
puts @domain.registrar_lock #=> ENABLED
puts @domain.transfer_auth_info #=> 1542c06388d8e03e14613788ca6bd914
puts @domain.contacts #=> array of DomainContact, see below

# Iterate domain contacts:
@domain.contacts.each do |contact|
  puts contact.contact_type #=> :registrant
  puts contact.city
  puts contact.country
  puts contact.country_code
  puts contact.email
  puts contact.fax
  puts contact.first_name
  puts contact.last_name
  puts contact.obfuscate_email #=> true
  puts contact.organization
  puts contact.phone_number
  puts contact.postal_code
  puts contact.street
  puts contact.street_2
  puts contact.street_3
  puts contact.additional_attributes # see below
end

@ns = InternetBS::DomainHosts.new(:domain => 'acme.com')

# TODO: Document `:compact => false` # default is true

result = @ns.fetch #=> true

# If the fetch method fails it will return false
# and populate the errors collection attribute:
unless result
  @ns.errors.each do |err|
    puts err
  end
end

@ns.list #=> an array of DomainHost
@ns.list.size #=> 3

# Enumerate each
@ns.list.each do |ns|
  puts ns.host
end

# DomainHost properties
ns = @ns.list.first
ns.is_a?(DomainHost) #=> true
puts ns.host #=> ns1.someregistrar.com
puts ns.ip_addresses #> [111.222.333.444]

# Add a domain host (pass in a DomainHost instance):
ns4 = InternetBS::DomainHost.new(
  :host => "ns4.acme.com", 
  :ip_addresses => ['112.223.334.445'] # array of one or more ip addresses
)

@hosts = DomainHosts.new(:domain => 'acme.com')
result = @hosts.add(ns4) #=> true

# Update a domain host (pass in a DomainHost instance):
ns4.ip_addresses[0] = '112.223.334.455'
result = @hosts.update(ns4) #=> true

# Remove a domain host (pass in a DomainHost instance):
result = @hosts.remove(ns4) #=> true

@dns_records = InternetBS::DomainRecords.new(:domain => 'acme.com')

# TODO: Document `:filter_type => DomainRecord::TYPES` # 'A', 'AAAA', 'DYNAMIC', 'CNAME', 'MX', 'SRV', 'TXT', 'NS'

result = @dns_records.fetch #=> true

# If the fetch method fails it will return false
# and populate the errors collection attribute:
unless result
  @dns_records.errors.each do |err|
    puts err
  end
end

@dns_records.list #=> an array of DomainRecord
@dns_records.list.size #=> 8

# Enumerate each
@dns_records.list.each do |record|
  puts record.name #=> www.acme.com
end

# DomainRecord properties
dns = @dns_records.list.first
dns.is_a?(DomainRecord) #=> true
puts dns.type #=> A
puts dns.value #=> 111.222.333.444
puts dns.ttl #=> 3600

# Add a domain record (pass in a DomainRecord instance):
dns_record = InternetBS::DomainRecord.new(
  :name => "api.acme.com", 
  :type => "A",
  :value => "111.222.333.456",
  :ttl => 3600
)

@dns_records = DomainRecords.new(:domain => 'acme.com')
result = @dns_records.add(dns_record) #=> true

# Update a domain record (pass in a Domainrecord instance):
dns_record.value = '111.222.333.457'
result = @dns_records.update(dns_record) #=> true

# Remove a domain record (pass in a DomainRecord instance):
result = @dns_records.remove(dns_record) #=> true

@private_whois = InternetBS::PrivateWhois.new(:domain => "acme.com")

result = @private_whois.fetch #=> true

# If the fetch method fails it will return false
# and populate the errors collection attribute:
unless result
  @private_whois.errors.each do |err|
    puts err
  end
end

@private_whois.privacy_status #=> FULL

# Disable privacy:
result = @private_whois.disable #=> true

# Enable privacy:
@private_whois.privacy_status = 'PARTIAL'
result = @private_whois.enable #=> true

@registrar_lock = InternetBS::RegistrarLock.new(:domain => "acme.com")

result = @registrar_lock.fetch #=> true

# If the fetch method fails it will return false
# and populate the errors collection attribute:
unless result
  @registrar_lock.errors.each do |err|
    puts err
  end
end

@registrar_lock.lock_status #=> FULL

# Disable registrar lock:
result = @registrar_lock.disable #=> true

# Enable registrar lock:
result = @registrar_lock.enable #=> true

@registry_status = InternetBS::RegistryStatus.new(:domain => "acme.com")

result = @registry_status.fetch #=> true

# If the fetch method fails it will return false
# and populate the errors collection attribute:
unless result
  @registry_status.errors.each do |err|
    puts err
  end
end

@registry_status.registry_status #=> clientTransferProhibited

@domain = InternetBS::UpdateDomain.new(:domain => "acme.com")

result = @domain.fetch #=> true

# If the fetch method fails it will return false
# and populate the errors collection attribute:
unless result
  @domain.errors.each do |err|
    puts err
  end
end

# Set properties that need updating on the `@domain` instance:
@domain.auto_renew = false
@domain.private_whois = 'FULL'
@domain.registrar_lock = 'ENABLED'
@domain.transfer_auth_info

registrant = InternetBS::DomainContact.new(
  :contact_type => :registrant,
  :first_name => 'John',
  :last_name => 'Doe',
  ...
)
@domain.contacts = [registrant, billing, technical, admin]

ns_list = ['ns1.example.com', 'ns2.example.com', 'ns3.example.com']
@domain.nameservers = ns_list

# For .tel domains only:
@domain.tel_hosting_account = 'my_username'
@domain.tel_hosting_password = 'my_password'
@domain.tel_hide_whois_data = true

# Then call the `#update!` method:
result = @domain.update! #=> true

@order = InternetBS::OrderDomain.new(
  :domain               => "bigacme.com",
  :currency             => "USD",
  :period               => "1Y",
  :nameservers          => ['ns1.example.com', 'ns2.example.com'],
  :transfer_auth_info   => 'EPP AUTH INFO HERE', # optional
  :registrar_lock       => 'ENABLED', #optional
  :private_whois        => 'FULL', # optional
  :discount_code        => '10PERCENT', # optional
  :auto_renew           => true, # optional
  :contacts             => [registrant, admin, billing, ...],
  :tel_hosting_account  => 'my_username', # optional, .tel only
  :tel_hosting_password => 'my_password', # optional, .tel only
  :tel_hide_whois_data  => true # optional, .tel only
)

result = @order.purchase! #=> true

# If the purchase! method fails it will return false
# and populate the errors collection attribute:
unless result
  @order.errors.each do |err|
    puts err
  end
end

# Order properties
@order.status #=> 'SUCCESS'
@order.transaction_id #=> 820b6791e386b31b354e613a6371c7bc
@order.total_price #=> 13.9

@domain = InternetBS::DomainPush.new(
  :domain        => "bigacme.com", # the domain to push
  :email_address => "jane.doe@somewhere.else.com" # the new manager
)

result = @domain.push! #=> true

# If the push! method fails it will return false
# and populate the errors collection attribute:
unless result
  @domain.errors.each do |err|
    puts err
  end
end

@renewal = InternetBS::RenewDomain.new(
  :domain        => "bigacme.com",
  :currency      => "USD", # default
  :period        => "1Y", # default
  :discount_code => '10PERCENT' # optional
)

result = @renewal.purchase! #=> true

# If the purchase! method fails it will return false
# and populate the errors collection attribute:
unless result
  @renewal.errors.each do |err|
    puts err
  end
end

# Renewal properties
@renewal.status #=> 'SUCCESS'
@renewal.transaction_id #=> 4e74069f2b5d1d62282c21d0a2e49a27
@renewal.total_price #=> 13.9

InternetBS::COUNTRY_CODES['US'] #=> United States

InternetBS::LANGUAGE_CODES['en'] #=> English