namecheap-client 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 03c4ea68d701b6b743bf6289f826fae4e7ac8af5c1dfe65aa1ba0f4734851d8b
+  data.tar.gz: e005d6a732e26397d16d663e94cff09915527a9d00308d2b2b44e58a94f60da5
+SHA512:
+  metadata.gz: 770a4fbd5c5029087822c8f71d8799a8986989a0daacc9be5c33d8b39021744b2ab1f8e5ae93763d05c4f16d9a35def47b0ac1140d58b0f818280c371f0cbd7e
+  data.tar.gz: 35d06f859aced4784b136b6a524c46e60afa20387c9c26f86bed0f05f5bdcbaa7f9cb3c85152bb7b1ea285ee45edff321d5f48d7e5b453fe04cb90e1b0bfb567

data/lib/namecheap-client.rb

@@ -0,0 +1,163 @@
+require 'net/http'
+require 'uri'
+require 'nokogiri'
+#require 'pry'
+
+class NamecheapClient
+  API_URL = 'https://api.namecheap.com/xml.response'
+
+  def initialize(api_user:, api_key:, username:, client_ip:)
+    @api_user = api_user
+    @api_key = api_key
+    @username = username
+    @client_ip = client_ip
+  end
+
+  # List all domains in the account
+  def list_domains
+    params = {
+      'Command' => 'namecheap.domains.getList',
+      'PageSize' => '100'
+    }
+    response = make_request(params)
+    parse_domain_list(response)
+  end
+
+  # Add DNS record to a domain
+  def add_dns_record(domain, record_type, host_name, address, ttl = '1800')
+    # First, get existing records
+    existing_records = get_dns_records(domain)
+
+    # Add the new record
+    existing_records << {
+      'Type' => record_type,
+      'Name' => host_name,
+      'Address' => address,
+      'TTL' => ttl
+    }
+
+    # Set the records
+    set_dns_records(domain, existing_records)
+  end
+
+  # Remove DNS record from a domain
+  def remove_dns_record(domain, record_type, host_name)
+    # Get existing records
+    existing_records = get_dns_records(domain)
+
+    # Remove the specified record(s)
+    updated_records = existing_records.reject do |record|
+      record['Type'] == record_type && record['Name'] == host_name
+    end
+
+    # Set the updated records
+    set_dns_records(domain, updated_records)
+  end
+
+  private
+
+  def make_request(extra_params)
+    uri = URI.parse(API_URL)
+    params = {
+      'ApiUser' => @api_user,
+      'ApiKey' => @api_key,
+      'UserName' => @username,
+      'ClientIp' => @client_ip
+    }.merge(extra_params)
+
+    response = Net::HTTP.post_form(uri, params)
+    Nokogiri::XML(response.body)
+  end
+
+  def parse_domain_list(xml_response)
+    # Define the namespace
+    namespaces = { 'nc' => 'http://api.namecheap.com/xml.response' }
+  
+    domains = []
+    # Use the namespace in the XPath query
+    xml_response.xpath('//nc:DomainGetListResult/nc:Domain', namespaces).each do |domain_node|
+      domains << {
+        'ID' => domain_node['ID'],
+        'Name' => domain_node['Name'],
+        'User' => domain_node['User'],
+        'Created' => domain_node['Created'],
+        'Expires' => domain_node['Expires'],
+        'IsExpired' => domain_node['IsExpired'],
+        'IsLocked' => domain_node['IsLocked'],
+        'AutoRenew' => domain_node['AutoRenew'],
+        'WhoisGuard' => domain_node['WhoisGuard'],
+        'IsPremium' => domain_node['IsPremium'],
+        'IsOurDNS' => domain_node['IsOurDNS']
+      }
+    end
+    domains
+  end  
+
+  def get_dns_records(domain)
+    params = {
+      'Command' => 'namecheap.domains.dns.getHosts',
+      'SLD' => domain_label(domain),
+      'TLD' => domain_extension(domain)
+    }
+    response = make_request(params)
+    parse_dns_records(response)
+  end
+
+  def set_dns_records(domain, records)
+    params = {
+      'Command' => 'namecheap.domains.dns.setHosts',
+      'SLD' => domain_label(domain),
+      'TLD' => domain_extension(domain)
+    }
+  
+    records.each_with_index do |record, index|
+      idx = index + 1
+      params["HostName#{idx}"] = record['Name']
+      params["RecordType#{idx}"] = record['Type']
+      params["Address#{idx}"] = record['Address']
+      params["TTL#{idx}"] = record['TTL'] || '1800'
+    end
+  
+    response = make_request(params)
+    namespaces = { 'nc' => 'http://api.namecheap.com/xml.response' }
+  
+    # Check the IsSuccess attribute in the DomainDNSSetHostsResult element
+    result_node = response.at_xpath('//nc:DomainDNSSetHostsResult', namespaces)
+  
+    if result_node && result_node['IsSuccess'] == 'true'
+      return true
+    else
+      # If IsSuccess is not 'true', parse and raise errors
+      error_message = parse_errors(response)
+      raise StandardError, error_message.empty? ? 'Failed to set DNS records' : error_message
+    end
+  end  
+
+  def parse_dns_records(xml_response)
+    records = []
+    xml_response.xpath('//DomainDNSGetHostsResult/host').each do |host_node|
+      records << {
+        'Type' => host_node['Type'],
+        'Name' => host_node['Name'],
+        'Address' => host_node['Address'],
+        'TTL' => host_node['TTL']
+      }
+    end
+    records
+  end
+
+  def parse_errors(xml_response)
+    errors = xml_response.xpath('//Errors/Error').map(&:text)
+    errors.join('; ')
+  end
+
+  def domain_label(domain)
+    domain_parts = domain.split('.')
+    domain_parts[0..-2].join('.')
+  end
+
+  def domain_extension(domain)
+    domain_parts = domain.split('.')
+    domain_parts[-1]
+  end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: namecheap-client
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Leandro Daniel Sardi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-09-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: net-http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+- !ruby/object:Gem::Dependency
+  name: uri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.2
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.10
+description: A simple Ruby client library for interacting with the [Namecheap API](https://www.namecheap.com/support/api/intro/),
+  allowing you to manage your domains programmatically.
+email: leandro@massprospecting.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/namecheap-client.rb
+homepage: https://rubygems.org/gems/namecheap-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: []
+rubygems_version: 3.3.7
+signing_key: 
+specification_version: 4
+summary: A simple Ruby client library for interacting with the [Namecheap API](https://www.namecheap.com/support/api/intro/),
+  allowing you to manage your domains programmatically.
+test_files: []