Module: Namecheap

Extended by:
Namecheap
Included in:
Namecheap
Defined in:
lib/namecheap.rb,
lib/namecheap/ns.rb,
lib/namecheap/api.rb,
lib/namecheap/dns.rb,
lib/namecheap/ssl.rb,
lib/namecheap/users.rb,
lib/namecheap/config.rb,
lib/namecheap/domains.rb,
lib/namecheap/version.rb,
lib/namecheap/transfers.rb,
lib/namecheap/whois_guard.rb

Defined Under Namespace

Modules: Config Classes: Api, Dns, Domains, Ns, Ssl, Transfers, Users, Whois_Guard

Constant Summary collapse

VERSION =
"0.3.0"

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#dnsObject

Returns the value of attribute dns.



32
33
34
# File 'lib/namecheap.rb', line 32

def dns
  @dns
end

#domainsObject

Returns the value of attribute domains.



32
33
34
# File 'lib/namecheap.rb', line 32

def domains
  @domains
end

#nsObject

Returns the value of attribute ns.



32
33
34
# File 'lib/namecheap.rb', line 32

def ns
  @ns
end

#sslObject

Returns the value of attribute ssl.



32
33
34
# File 'lib/namecheap.rb', line 32

def ssl
  @ssl
end

#transfersObject

Returns the value of attribute transfers.



32
33
34
# File 'lib/namecheap.rb', line 32

def transfers
  @transfers
end

#usersObject

Returns the value of attribute users.



32
33
34
# File 'lib/namecheap.rb', line 32

def users
  @users
end

#whois_guardObject

Returns the value of attribute whois_guard.



32
33
34
# File 'lib/namecheap.rb', line 32

def whois_guard
  @whois_guard
end

Instance Method Details

#configureConfig Also known as: config

Sets the Namecheap configuration options. Best used by passing a block.

Examples:

Set up configuration options.

Namecheap.configure do |config|
  config.key = "apikey"
  config.username = "apiuser"
  config.client_ip = "127.0.0.1"
end

Returns:

  • (Config)

    The configuration obejct.



27
28
29
# File 'lib/namecheap.rb', line 27

def configure
  block_given? ? yield(Config) : Config
end