namesilo_client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 62389c4531a2fc1ab8aaaa8e3a52bfb1931032ecc8c834d889695e10251c32c5
+  data.tar.gz: 4b96a5f68f50dd022600eb61aabff436d6533fb9ee22b9d571e50c1c05b3822c
+SHA512:
+  metadata.gz: 5bf480b7a22da3e9987d51b98bd41b9cf0bc8b38246108ccd294f3c05ebc75844808f5a81d913487a3db538c4a45aecc463e6b70c27dacbf120aa53a65c56b17
+  data.tar.gz: 3409ca0f885af3e105c559d2caf103638d71ce9f63e7d76f7e21d173bf4fa85eeab9393187556817e6a1ae4fd417d07040e4430ef621aa60dddaf81472a81123

data/lib/namesilo_client.rb

@@ -0,0 +1,212 @@
+require 'faraday'
+require 'json'
+require 'addressable'
+
+module NamesiloClient
+  class API
+	    
+    # Class constructor
+    def initialize(apikey)
+      @apikey = apikey
+      @host   = 'https://www.namesilo.com/api/'
+    end
+
+    # Establish connection
+    def get_connection()
+      conn = Faraday.new(:url => @host) do |c|
+        c.use Faraday::Request::UrlEncoded 
+        c.use Faraday::Adapter::NetHttp     
+      end
+    end
+
+    # Default parameters for Namesilio REST APIs
+    def get_default_parameters()
+      {"version":"1","type":"xml","key":@apikey}
+    end
+
+    def get_request(endpoint)
+      get_connection().get endpoint
+    end
+
+    # Construct URL parameters, combing with default parameters
+    def get_url_parameters(params)
+      uri = Addressable::URI.new
+      uri.query_values = params.merge(get_default_parameters())
+      uri.query
+    end
+
+    # Return namesilo contact information
+    # By default, it returns all contact informaton
+    # Optional parameter: contact_id
+    # e.g. get_contact_list(params={contact_id:'11111111'})
+    def get_contact_list(params={})
+      get_request('contactList?'+get_url_parameters(params)).body
+    end
+
+    # add a contact information
+    # params is a JSON string
+    # required fields:
+    #   fn: First Name
+    #   ln: Last Name
+    #   ad: Mailing Address
+    #   cy: Mailing City
+    #   st: Mailing State/Province/Territory
+    #   If country is US or CA, you must use the correct abbreviation
+    #   zp: Mailing Zip/Postal Code
+    #   ct: Mailing Country
+    #   Country must use the correct abbreviation
+    #   em: Email Address
+    #   ph: Phone Number
+    # Optional Fields
+    #   nn: Nickname (24)
+    #   cp: Company (64)
+    #   ad2: Mailing Address 2 (128)
+    #   fx: Fax (32)
+    #   US Fields:
+    #     usnc: .US Nexus Category (3) (must use correct abbreviation)
+    #     usap: .US Application Purpose (2) (must use correct abbreviation)
+    #   CA Optional Fields
+    #     calf: CIRA Legal Form (correct abbreviations)
+    #     caln: CIRA Language (correct abbreviations)
+    #     caag: CIRA Agreement Version (correct abbreviations)
+    #     cawd: CIRA WHOIS Display
+    def add_contact(params)
+      get_request('contactAdd?'+get_url_parameters(params)).body
+    end
+
+    # List all domains
+    # Returns XML
+    # xpath: /namesilo/reply/domains/domain
+    def list_domains()
+      get_request('listDomains?'+get_url_parameters({})).body
+    end
+
+    # Get domain info
+    # Parameter: domain name
+    # returns XML containing all domain info
+    # xpath: /namesilo/reply
+    def get_domain_info(domain)
+      get_request('getDomainInfo?'+get_url_parameters({'domain':domain})).body
+    end
+
+    # List DNS records
+    # Parameter: domain name
+    # returns XML containing all DNS records
+    # xpath: /namesilo/reply/resource_record
+    def list_dns_records(domain)
+      get_request('dnsListRecords?'+get_url_parameters({'domain':domain})).body
+    end
+
+    # Add a DNS record
+    # Parameters:
+    #   domain: The domain being updated
+    #   rrtype: DNS record type, e.g. "A", "AAAA", "CNAME", "MX" and "TXT"
+    #   rrhost: hostname for the new record 
+    #   rrvalue: The value for the resource record
+    #   rrdistance: Only used for MX (default is 10 if not provided)
+    #   rrttl: The TTL for the new record (default is 7207 if not provided)
+    def add_dns_record(params)
+      get_request('dnsAddRecord?'+get_url_parameters(params)).body
+    end
+
+    # Update DNS record
+    # Parameters:
+    #   domain
+    #   rrid: The unique ID of the resource record. 
+    #   rrhost: The hostname
+    #   rrvalue: The value for the resource record
+    #   rrdistance: Only used for MX
+    #   rrttl: The TTL for this record (default is 7207 if not provided)
+    def update_dns_record(params)
+      get_request('dnsUpdateRecord?'+get_url_parameters(params)).body
+    end
+
+    # Delete DNS record
+    # Parameters:
+    #  domain
+    #  rrid: The unique ID of the resource record
+    def delete_dns_record(params)
+      get_request('dnsDeleteRecord?'+get_url_parameters(params)).body
+    end
+
+    # checkTransferStatus
+    # Parameter: domain name
+    # returns XML containing domain transfer status
+    # xpath: /namesilo/reply
+    def check_transfer_status(domain)
+      get_request('checkTransferStatus?'+get_url_parameters({'domain':domain})).body
+    end
+
+    # checkRegisterAvailability
+    # Parameter: register domain names in JSON, seperated by comma
+    #        e.g. {'domains':'namesilo.com,namesilo.net,namesilo.org'}
+    # returns XML with available, unavailable, and invalid domains
+    # xpath: /namesilo/reply
+    def check_register_availability(domains)
+      get_request('checkRegisterAvailability?'+get_url_parameters({'domains':domains})).body
+    end
+
+    # retrieveAuthCode
+    # Have the EPP transfer code for the domain emailed to the administrative contact.
+    def retrieve_auth_code(domain)
+      get_request('retrieveAuthCode?'+get_url_parameters({'domain':domain})).body
+    end
+
+    # Get a list of all active portfolios within your account.
+    # returns XML containing all portfolios
+    # xpath: /namesilo/reply/portfolios
+    def get_portfolio_list()
+      get_request('portfolioList?'+get_url_parameters({})).body
+    end
+
+    # listRegisteredNameServers
+    # returns XML containing all name servers
+    # xpath: /namesilo/reply/hosts
+    def list_name_servers(domain)
+      get_request('listRegisteredNameServers?'+get_url_parameters({'domain':domain})).body
+    end
+
+    # listEmailForwards
+    # returns all email forwards
+    # xpath: /namesilo/reply/addresses
+    def list_email_forwards(domain)
+      get_request('listEmailForwards?'+get_url_parameters({'domain':domain})).body
+    end
+
+    # registrantVerificationStatus
+    # Shows the verification status for any Registrant email addresses
+    # xpath: /namesilo/reply/email
+    def get_registrant_verification_status()
+      get_request('registrantVerificationStatus?'+get_url_parameters({})).body
+    end
+
+    # getAccountBalance
+    # returns current account funds balance.
+    # xpath: /namesilo/reply
+    def get_account_balance()
+      get_request('getAccountBalance?'+get_url_parameters({})).body
+    end
+
+    # getPrices
+    # returns price list
+    # xpath: /namesilo/reply
+    def get_prices()
+      get_request('getPrices?'+get_url_parameters({})).body
+    end
+
+    # listOrders
+    # Returns Complete Account Order History
+    # xpath: /namesilo/reply/order
+    def list_orders()
+      get_request('listOrders?'+get_url_parameters({})).body
+    end
+
+    # orderDetails
+    # returns details for provided order number
+    # xpath: /namesilo/reply
+    def order_details(order_number)
+      get_request('orderDetails?'+get_url_parameters({'order_number':order_number})).body
+    end
+
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: namesilo_client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Yuxi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-06-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+description: Namesilo API client is a wrapper of Namesilo REST APIs.
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/namesilo_client.rb
+homepage: http://rubygems.org/gems/namesilo_client
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Namesilo API client
+test_files: []