gandi_v5 0.8.0 → 0.9.0

data/lib/gandi_v5/email.rb

@@ -2,6 +2,7 @@
 
 class GandiV5
   # Gandi Email Mailbox Management API.
+  # @see https://api.gandi.net/docs/email/
   class Email
   end
 end

data/lib/gandi_v5/email/mailbox.rb

@@ -43,7 +43,7 @@ class GandiV5
       alias mailbox_uuid uuid
 
       # Create a new GandiV5::Email::Mailbox
-      # @param members [Hash<Symbol => Object>]
+      # @param members [Hash{Symbol => Object}]
       # @return [GandiV5::Email::Slot]
       def initialize(**members)
         super(**members)

data/lib/gandi_v5/error/gandi_error.rb

@@ -5,6 +5,7 @@ class GandiV5
     # Generic error class for errors returned by Gandi.
     class GandiError < GandiV5::Error
       # Generate a new GandiV5::Error::GandiError from the hash returned by Gandi.
+      # @api private
       # @param hash [Hash] the hash returned by Gandi.
       # @return [GandiV5::Error::GandiError]
       def self.from_hash(hash)

data/lib/gandi_v5/live_dns.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
 # Namespace for classes which access LiveDNS details.
+# @see https://api.gandi.net/docs/livedns/
 class GandiV5
   # Gandi LiveDNS Management API.
   class LiveDNS
+    # Permitted record types.
     RECORD_TYPES = %w[
       A AAAA CNAME MX NS TXT ALIAS
       WKS SRV LOC SPF CAA DS SSHFP PTR KEY DNAME TLSA OPENPGPKEY CDS

data/lib/gandi_v5/live_dns/domain.rb

@@ -21,6 +21,7 @@ class GandiV5
       end
 
       # Update this domain's settings.
+      # @see https://api.gandi.net/docs/livedns/#patch-v5-livedns-domains-fqdn
       # @param automatic_snapshots [String, #to_s]
       #   Enable or disable the automatic creation of new snapshots when records are changed.
       # @return [String] The confirmation message from Gandi.
@@ -33,12 +34,14 @@ class GandiV5
 
       # @overload fetch_records()
       #   Fetch all records for this domain.
+      #   @see https://api.gandi.net/docs/livedns/#get-v5-livedns-domains-fqdn-records
       #   @param page [Integer, #each<Integer>] which page(s) of results to get.
       #     If page is not provided keep querying until an empty list is returned.
       #     If page responds to .each then iterate until an empty list is returned.
       #   @param per_page [Integer, #to_s] (optional default 100) how many results ot get per page.
       # @overload fetch_records(name)
       #   Fetch records for a name.
+      #   @see https://api.gandi.net/docs/livedns/#get-v5-livedns-domains-fqdn-records-rrset_name
       #   @param name [String] the name to fetch records for.
       #   @param page [Integer, #each<Integer>] which page(s) of results to get.
       #     If page is not provided keep querying until an empty list is returned.
@@ -46,6 +49,7 @@ class GandiV5
       #   @param per_page [Integer, #to_s] (optional default 100) how many results ot get per page.
       # @overload fetch_records(name, type)
       #   Fetch records of a type for a name.
+      #   @see https://api.gandi.net/docs/livedns/#get-v5-livedns-domains-fqdn-records-rrset_name-rrset_type
       #   @param name [String] the name to fetch records for.
       #   @param type [String] the record type to fetch.
       #   @param page [Integer, #each<Integer>] which page(s) of results to get.
@@ -70,11 +74,14 @@ class GandiV5
 
       # @overload fetch_zone_lines()
       #   Fetch all records for this domain.
+      #   @see https://api.gandi.net/docs/livedns/#get-v5-livedns-domains-fqdn-records
       # @overload fetch_zone_lines(name)
       #   Fetch records for a name.
+      #   @see https://api.gandi.net/docs/livedns/#get-v5-livedns-domains-fqdn-records-rrset_name
       #   @param name [String] the name to fetch records for.
       # @overload fetch_zone_lines(name, type)
       #   Fetch records of a type for a name.
+      #   @see https://api.gandi.net/docs/livedns/#get-v5-livedns-domains-fqdn-records-rrset_name-rrset_type
       #   @param name [String] the name to fetch records for.
       #   @param type [String] the record type to fetch.
       # @return [String]
@@ -90,6 +97,7 @@ class GandiV5
       end
 
       # Add record to this domain.
+      # @see https://api.gandi.net/docs/livedns/#post-v5-livedns-domains-fqdn-records
       # @param name [String]
       # @param type [String]
       # @param ttl [Integer]
@@ -113,11 +121,14 @@ class GandiV5
 
       # @overload delete_records()
       #   Delete all records for this domain.
+      #   @see https://api.gandi.net/docs/livedns/#delete-v5-livedns-domains-fqdn-records
       # @overload delete_records(name)
       #   Delete records for a name.
+      #   @see https://api.gandi.net/docs/livedns/#delete-v5-livedns-domains-fqdn-records-rrset_name
       #   @param name [String] the name to delete records for.
       # @overload delete_records(name, type)
       #   Delete records of a type for a name.
+      #   @see https://api.gandi.net/docs/livedns/#delete-v5-livedns-domains-fqdn-records-rrset_name-rrset_type
       #   @param name [String] the name to delete records for.
       #   @param type [String] the record type to delete.
       # @return [nil]
@@ -136,6 +147,9 @@ class GandiV5
       #   @param type [String, nil] only replaces record of this type (requires name).
       #   @param values [Array<String>] the values to set for the record.
       #   @raise [ArgumentError] if ttl is present and type is absent.
+      # @see https://api.gandi.net/docs/livedns/#put-v5-livedns-domains-fqdn-records
+      # @see https://api.gandi.net/docs/livedns/#put-v5-livedns-domains-fqdn-records-rrset_name
+      # @see https://api.gandi.net/docs/livedns/#put-v5-livedns-domains-fqdn-records-rrset_name-rrset_type
       # @return [String] The confirmation message from Gandi.
       # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
       # rubocop:disable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
@@ -161,6 +175,7 @@ class GandiV5
       # rubocop:enable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
 
       # Replace all records for this domain.
+      # @see https://api.gandi.net/docs/livedns/#put-v5-livedns-domains-fqdn-records
       # @param text [String] zone file lines to replace the records with.
       # @return [String] The confirmation message from Gandi.
       # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
@@ -199,6 +214,7 @@ class GandiV5
       end
 
       # Requery Gandi for the domain's DNSSEC keys.
+      # @see https://api.gandi.net/docs/livedns/#get-v5-livedns-domains-fqdn-keys
       # @return [Array<GandiV5::LiveDNS::Domain::DnssecKey>]
       # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
       def fetch_dnssec_keys
@@ -215,6 +231,7 @@ class GandiV5
       end
 
       # Requery Gandi for the domain's TSIG keys.
+      # @see https://api.gandi.net/docs/livedns/#get-v5-livedns-domains-fqdn-axfr-tsig
       # @return [Array<GandiV5::LiveDNS::Domain::TsigKey>]
       # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
       def fetch_tsig_keys
@@ -223,6 +240,7 @@ class GandiV5
       end
 
       # Add a Tsig key to this domain.
+      # @see https://api.gandi.net/docs/livedns/#put-v5-livedns-domains-fqdn-axfr-tsig-id
       # @param key [GandiV5::LiveDNS::Domain::TsigKey, #uuid, String, #to_s]
       #   the key to add.
       # @param sharing_id [nil, String, #to_s]
@@ -235,6 +253,7 @@ class GandiV5
       end
 
       # Remove a Tsig key from this domain.
+      # @see https://api.gandi.net/docs/livedns/#delete-v5-livedns-domains-fqdn-axfr-tsig-id
       # @param key [GandiV5::LiveDNS::Domain::TsigKey, #uuid, String, #to_s]
       #   the key to remove.
       # @param sharing_id [nil, String, #to_s]
@@ -254,6 +273,7 @@ class GandiV5
       end
 
       # Requery Gandi for the domain's AXFR clients.
+      # @see https://api.gandi.net/docs/livedns/#get-v5-livedns-domains-fqdn-axfr-slaves
       # @return [Array<String>] list of IP addresses.
       # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
       def fetch_axfr_clients
@@ -262,6 +282,7 @@ class GandiV5
       end
 
       # Add an AXFR client to this domain.
+      # @see https://api.gandi.net/docs/livedns/#put-v5-livedns-domains-fqdn-axfr-slaves-ip
       # @param ip [String, #to_s] the IP address to add.
       # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
       def add_axfr_client(ip)
@@ -269,6 +290,7 @@ class GandiV5
       end
 
       # Remove and AXFR client from this domain.
+      # @see https://api.gandi.net/docs/livedns/#delete-v5-livedns-domains-fqdn-axfr-slaves-ip
       # @param ip [String, #to_s] the IP address to remove.
       # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
       def remove_axfr_client(ip)
@@ -276,6 +298,7 @@ class GandiV5
       end
 
       # List the domains.
+      # @see https://api.gandi.net/docs/livedns/#get-v5-livedns-domains
       # @param page [#each<Integer, #to_s>] the page(s) of results to retrieve.
       #   If page is not provided keep querying until an empty list is returned.
       #   If page responds to .each then iterate until an empty list is returned.
@@ -300,6 +323,7 @@ class GandiV5
       end
 
       # Get a domain.
+      # @see https://api.gandi.net/docs/livedns/#get-v5-livedns-domains-fqdn
       # @param fqdn [String, #to_s] the fully qualified domain name to fetch.
       # @return [GandiV5::LiveDNS::Domain]
       # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
@@ -310,6 +334,7 @@ class GandiV5
 
       # Create a new domain in the LiveDNS system.
       # You must have sufficent permission to manage the domain to do this.
+      # @see https://api.gandi.net/docs/livedns/#post-v5-livedns-domains
       # @param fqdn [String, #to_s] the fully qualified domain to add to LiveDNS.
       # @param records [Array<Hash, GandiV5::LiveDNS::Domain::Record, #to_h, nil>]
       # @param ttl [Integer, #to_s, nil] the TTL of the SOA record.
@@ -335,6 +360,7 @@ class GandiV5
       end
 
       # Fetch the list of known record types (A, CNAME, etc.)
+      # @see https://api.gandi.net/docs/livedns/#get-v5-livedns-dns-rrtypes
       # @return [Array<String>]
       # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
       def self.record_types
@@ -342,7 +368,8 @@ class GandiV5
       end
 
       # Get the LiveDNS servers to use for a domain.
-      # Does not take into account any NS records that exist in the zone.
+      # @note Does not take into account any NS records that exist in the zone.
+      # @see https://api.gandi.net/docs/livedns/#get-v5-livedns-nameservers-fqdn
       # @param fqdn [String, #to_s] the fully qualified domain to hash in
       #   in order to get the LiveDNS servers to use.
       # @return [Array<String>]

data/lib/gandi_v5/live_dns/domain/dnssec_key.rb

@@ -4,27 +4,27 @@ class GandiV5
   class LiveDNS
     class Domain
       # A DNSSEC key for a domain's DNS records.
-      # @!attribyte [r] uuid
+      # @!attribute [r] uuid
       #   @return [String]
-      # @!attribyte [r] status
+      # @!attribute [r] status
       #   @return [String]
-      # @!attribyte [r] fqdn
+      # @!attribute [r] fqdn
       #   @return [String]
-      # @!attribyte [r] algorithm_id
+      # @!attribute [r] algorithm_id
       #   @return [Integer]
-      # @!attribyte [r] algorithm_name
+      # @!attribute [r] algorithm_name
       #   @return [String]
-      # @!attribyte [r] deleted
+      # @!attribute [r] deleted
       #   @return [Boolean]
-      # @!attribyte [r] ds
+      # @!attribute [r] ds
       #   @return [String]
-      # @!attribyte [r] flags
+      # @!attribute [r] flags
       #   @return [Integer]
-      # @!attribyte [r] fingerprint
+      # @!attribute [r] fingerprint
       #   @return [String]
-      # @!attribyte [r] public_key
+      # @!attribute [r] public_key
       #   @return [String]
-      # @!attribyte [r] tag
+      # @!attribute [r] tag
       #   @return [String]
       class DnssecKey
         include GandiV5::Data
@@ -36,6 +36,7 @@ class GandiV5
         member :algorithm_id, gandi_key: 'algorithm'
 
         # Delete this key.
+        # @see https://api.gandi.net/docs/livedns/#delete-v5-livedns-domains-fqdn-keys-id
         # @return [String] The confirmation message from Gandi.
         # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
         def delete
@@ -45,6 +46,7 @@ class GandiV5
         end
 
         # Undelete this key.
+        # @see https://api.gandi.net/docs/livedns/#patch-v5-livedns-domains-fqdn-keys-id
         # @return [String] The confirmation message from Gandi.
         # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
         def undelete
@@ -66,6 +68,7 @@ class GandiV5
         end
 
         # Create a new DNSSEC key for a zone.
+        # @see https://api.gandi.net/docs/livedns/#post-v5-livedns-domains-fqdn-keys
         # @param fqdn [String, #to_s] the fully qualified domain to create the key for.
         # @param flags [Integer, :key_signing_key, :zone_signing_key] the key's flags.
         # @return [GandiV5::LiveDNS::Domain::DnssecKey]
@@ -80,6 +83,7 @@ class GandiV5
         end
 
         # Get keys for a FQDN from Gandi.
+        # @see https://api.gandi.net/docs/livedns/#get-v5-livedns-domains-fqdn-keys
         # @param fqdn [String, #to_s] The fully qualified domain name to get the keys for.
         # @return [Array<GandiV5::LiveDNS::Domain::DnssecKey>]
         # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
@@ -89,6 +93,7 @@ class GandiV5
         end
 
         # Get DNSSEC key from Gandi.
+        # @see https://api.gandi.net/docs/livedns/#get-v5-livedns-domains-fqdn-keys-id
         # @param fqdn [String, #to_s] The fully qualified domain name the key was made for.
         # @param uuid [String, #to_s] the UUID of the key to fetch.
         # @return [GandiV5::LiveDNS::Domain::DnssecKey]

data/lib/gandi_v5/live_dns/domain/snapshot.rb

@@ -30,6 +30,7 @@ class GandiV5
         alias snapshot_uuid uuid
 
         # Delete this snapshot.
+        # @see https://api.gandi.net/docs/livedns/#delete-v5-livedns-domains-fqdn-snapshots-id
         # @return [String] The confirmation message from Gandi.
         # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
         def delete
@@ -38,6 +39,7 @@ class GandiV5
         end
 
         # Update this snapshot.
+        # @see https://api.gandi.net/docs/livedns/#patch-v5-livedns-domains-fqdn-snapshots-id
         # @param name [String, #to_s] new name for the snapshot.
         # @return [String] The confirmation message from Gandi.
         # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
@@ -48,6 +50,7 @@ class GandiV5
         end
 
         # Get snapshot details for this FQDN from Gandi.
+        # @see https://api.gandi.net/docs/livedns/#get-v5-livedns-domains-fqdn-snapshots
         # @param fqdn [String, #to_s] The fully qualified domain name to get the snapshots for.
         # @param page [#each<Integer, #to_s>] the page(s) of results to retrieve.
         #   If page is not provided keep querying until an empty list is returned.
@@ -67,6 +70,7 @@ class GandiV5
         end
 
         # Get snapshot from Gandi.
+        # @see https://api.gandi.net/docs/livedns/#get-v5-livedns-domains-fqdn-snapshots-id
         # @param fqdn [String, #to_s] The fully qualified domain name the snapshot was made for.
         # @param uuid [String, #to_s] the UUID of the snapshot to fetch.
         # @return [GandiV5::LiveDNS::Domain::Snapshot]

data/lib/gandi_v5/live_dns/domain/tsig_key.rb

@@ -4,13 +4,13 @@ class GandiV5
   class LiveDNS
     class Domain
       # A Tsig key.
-      # @!attribyte [r] uuid
+      # @!attribute [r] uuid
       #   @return [String]
-      # @!attribyte [r] name
+      # @!attribute [r] name
       #   @return [String]
-      # @!attribyte [r] secret
+      # @!attribute [r] secret
       #   @return [String]
-      # @!attribyte [r] config_examples
+      # @!attribute [r] config_examples
       #   @return [Hash<Symbol -> String>]
       class TsigKey
         include GandiV5::Data
@@ -28,6 +28,7 @@ class GandiV5
         )
 
         # Create a new DNSSEC key for a zone.
+        # @see https://api.gandi.net/docs/livedns/#post-v5-livedns-axfr-tsig
         # @param sharing_id [nil, String, #to_s]
         # @return [GandiV5::LiveDNS::Domain::DnssecKey]
         # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
@@ -42,6 +43,7 @@ class GandiV5
         # Get keys from Gandi.
         # If you need the secret, fingerprint, public_key or tag attributes you'll need
         # to use GandiV5::LiveDNS::Domain::DnssecKey.fetch on each item.
+        # @see https://api.gandi.net/docs/livedns/#get-v5-livedns-axfr-tsig
         # @return [Array<GandiV5::LiveDNS::Domain::TsigKey>]
         # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
         def self.list
@@ -50,6 +52,7 @@ class GandiV5
         end
 
         # Get Tsig key from Gandi.
+        # @see https://api.gandi.net/docs/livedns/#get-v5-livedns-axfr-tsig-id
         # @param uuid [String, #to_s] the UUID of the key to fetch.
         # @return [GandiV5::LiveDNS::Domain::TsigKey]
         # @raise [GandiV5::Error::GandiError] if Gandi returns an error.

data/lib/gandi_v5/simple_hosting.rb

@@ -3,6 +3,7 @@
 # Namespace for classes which access LiveDNS details.
 class GandiV5
   # Gandi Simple Hosting management API.
+  # @see https://api.gandi.net/docs/simplehosting/
   class SimpleHosting
     # @see GandiV5::Simplehosting::Instance.list
     def self.instances

data/lib/gandi_v5/simple_hosting/instance.rb

@@ -117,6 +117,7 @@ class GandiV5
       )
 
       # Instruct Gandi to restart this instance.
+      # @see https://api.gandi.net/docs/simplehosting/#post-v5-simplehosting-instances-instance_id-action
       # @return [String] confirmation message.
       # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
       def restart
@@ -125,6 +126,7 @@ class GandiV5
       end
 
       # Instruct Gandi to console this instance.
+      # @see https://api.gandi.net/docs/simplehosting/#post-v5-simplehosting-instances-instance_id-action
       # @return [String] confirmation message.
       # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
       def console
@@ -133,6 +135,7 @@ class GandiV5
       end
 
       # Instruct Gandi to reset the database password for this instance.
+      # @see https://api.gandi.net/docs/simplehosting/#post-v5-simplehosting-instances-instance_id-action
       # @return [String] confirmation message.
       # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
       def reset_database_password

data/lib/gandi_v5/simple_hosting/instance/application.rb

@@ -3,6 +3,7 @@
 class GandiV5
   class SimpleHosting
     class Instance
+      # An application running on a simple hosting instance.
       # @!attribute [r] name
       #   @return [String]
       # @!attribute [r] parameters

data/lib/gandi_v5/simple_hosting/instance/database.rb

@@ -3,6 +3,7 @@
 class GandiV5
   class SimpleHosting
     class Instance
+      # A simple hosting instance.
       # @!attribute [r] name
       #   @return [String]
       # @!attribute [r] status

data/lib/gandi_v5/simple_hosting/instance/language.rb

@@ -3,7 +3,7 @@
 class GandiV5
   class SimpleHosting
     class Instance
-      # Sharing space which contains other billable items.
+      # A language running on a simple hosting instance.
       # @!attribute [r] name
       #   @return [String]
       # @!attribute [r] single_application

data/lib/gandi_v5/simple_hosting/instance/upgrade.rb

@@ -3,6 +3,7 @@
 class GandiV5
   class SimpleHosting
     class Instance
+      # An available upgrade on a simple hosting instance.
       # @!attribute [r] name
       #   @return [String]
       # @!attribute [r] status

data/lib/gandi_v5/simple_hosting/instance/virtual_host.rb

@@ -4,7 +4,7 @@
 class GandiV5
   class SimpleHosting
     class Instance
-      # A simple hosting virtual host.
+      # A virtual host on a simple hosting instance.
       # @see https://api.gandi.net/docs/simplehosting/
       # @!attribute [r] created_at
       #   @return [Time]
@@ -139,7 +139,7 @@ class GandiV5
 
         # Get information on a virtual host.
         # @see https://api.gandi.net/docs/simplehosting#get-v5-simplehosting-instances-instance_id-vhosts-vhost_fqdn
-        # @param uuid [String, #to_s] the UUID of the simple hosting instance.
+        # @param instance_uuid [String, #to_s] the UUID of the simple hosting instance.
         # @param fqdn [String, #to_s] the fully qualified domain name of the virtual host.
         # @return [GandiV5::SimpleHosting::Instance]
         # @raise [GandiV5::Error::GandiError] if Gandi returns an error.