gandi_v5 0.6.0 → 0.10.0

data/lib/gandi_v5/template/payload/web_forwarding.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+class GandiV5
+  class Template
+    class Payload
+      # Web forwarding details of a configuration template.
+      # @!attribute [r] type
+      #   @return [:cloak, :http301, :http302]
+      # @!attribute [r] target
+      #   @return [String]
+      # @!attribute [r] fqdn
+      #   @return [String, nil]
+      # @!attribute [r] override
+      #   @return [Boolean, nil]
+      #     when you create a redirection on a domain, a DNS record is created if it does not exist.
+      #     When the record already exists and this parameter is set to true it will
+      #     overwrite the record. Otherwise it will trigger an error.
+      # @!attribute [r] protocol
+      #   @return [:http, :https, :https_only, nil]
+      class WebForwarding
+        include GandiV5::Data
+
+        member :type, converter: GandiV5::Data::Converter::Symbol
+        member :target, gandi_key: 'url'
+        member :fqdn, gandi_key: 'host'
+        member :override
+        member(
+          :protocol,
+          converter: GandiV5::Data::Converter.new(
+            from_gandi: lambda { |value|
+              {
+                'http' => :http,
+                'https' => :https,
+                'httpsonly' => :https_only
+              }.fetch(value)
+            }
+          )
+        )
+
+        # Check if this is an HTTP 301 (permanent) redirection.
+        def http301?
+          type == :http301
+        end
+
+        # Check if this is an HTTP 302 (found) redirection.
+        def http302?
+          type == :http302
+        end
+
+        # Check if this is an HTTP 301 (permanent) redirection.
+        def permanent?
+          type == :http301
+        end
+
+        # Check if this is an HTTP 302 (found) redirection.
+        def found?
+          type == :http302
+        end
+
+        # Check if this is a temporary redirection.
+        def temporary?
+          type == :http302
+        end
+
+        # Check if it's an http end point
+        def http?
+          protocol == :http || protocol == :https
+        end
+
+        # Check if it's an https end point
+        def https?
+          protocol == :https || protocol == :https_only
+        end
+
+        # Check if it's an https only
+        def https_only?
+          protocol == :https_only
+        end
+      end
+    end
+  end
+end

data/lib/gandi_v5/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class GandiV5
-  VERSION = '0.6.0'
+  VERSION = '0.10.0'
 end

data/spec/.rubocop.yml

@@ -1,11 +1,11 @@
-Metrics/BlockLength:
-  Max: 750
+require:
+- rubocop-performance
+AllCops:
+  TargetRubyVersion: 2.6.0
+  NewCops: enable
 Layout/LineLength:
   Max: 125
-Style/HashEachMethods:
-  Enabled: true
-Style/HashTransformKeys:
-  Enabled: true
-Style/HashTransformValues:
-  Enabled: true
-
+Lint/ConstantDefinitionInBlock:
+  Enabled: false
+Metrics/BlockLength:
+  Max: 750

data/spec/features/list_domain_renewals_spec.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+describe 'Examples', :vcr do
+  it 'List domain renewals' do
+    expect($stdout).to receive(:puts).with("2021-03-12\t£8.87\texample.com")
+
+    # For each domain (sorted by assending renewal date) print <date>\t<cost>\t<fqdn>
+    GandiV5::Domain.list.each do |domain|
+      puts [
+        domain.dates.registry_ends_at.to_date,
+        "£#{domain.renewal_price.price_after_taxes}",
+        domain.fqdn
+      ].join("\t")
+    end
+  end
+end

data/spec/features/list_email_addresses_spec.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+describe 'Examples', :vcr do
+  it 'List email addresses' do
+    expect($stdout).to receive(:puts).with("alias@example.com\talias for user@example.com").ordered
+    expect($stdout).to receive(:puts).with("forward@example.com\tforwards to user@example.com").ordered
+    expect($stdout).to receive(:puts).with("user@example.com\tstandard mailbox (0% of 3GB used)").ordered
+
+    # For each domain:
+    #   1. Create an empty hash to store address => description
+    #   2. Get the mailboxes and add them to the hash
+    #   3. Get the forwards and add them to the hash
+    #   4. Sort the hash by email address
+    #   5. Print the list
+    GandiV5::Domain.list.each do |domain|
+      emails = {}
+
+      mailboxes = GandiV5::Email::Mailbox.list(domain.fqdn)
+      mailboxes.each do |mailbox|
+        mailbox.refresh
+        emails["#{mailbox.login}@#{domain.fqdn}"] = "#{mailbox.type} mailbox " \
+                                             "(#{mailbox.quota_usage.to_i}% " \
+                                             "of #{(mailbox.quota / 1024**3).round}GB used)"
+        mailbox.aliases.each do |alias_name|
+          emails["#{alias_name}@#{domain.fqdn}"] = "alias for #{mailbox.login}@#{domain.fqdn}"
+        end
+      end
+
+      forwards = GandiV5::Email::Forward.list(domain.fqdn)
+      forwards.each do |forward|
+        emails["#{forward.source}@#{domain.fqdn}"] = "forwards to #{forward.destinations.join(', ')}"
+      end
+
+      emails.sort.each do |address, text|
+        puts "#{address}\t#{text}"
+      end
+    end
+  end
+end

data/spec/fixtures/bodies/GandiV5_Domain_TransferIn/fetch.yml

@@ -0,0 +1,21 @@
+---
+created_at: '2011-02-21T10:39:00Z'
+owner_contact: owner contact
+params:
+  domain: example.com
+  duration: 1
+  reseller: reseller-uuid
+  tld: com
+  version: 0
+step: step text
+step_nb: 2
+updated_at: '2011-02-22T10:39:00Z'
+errortype: error-type
+errortype_label: error label
+foa:
+- answer: ans
+  email: user@example.com
+inner_step: inner-step
+regac_at: '2011-02-23T10:39:00Z'
+start_at: '2011-02-24T10:39:00Z'
+transfer_procedure: transfer-procedure

data/spec/fixtures/bodies/GandiV5_Domain_TransferIn_Availability/fetch.yml

@@ -0,0 +1,10 @@
+---
+available: true
+fqdn: example.com
+fqdn_ulabel: EXAMPLE.COM
+corporate: false
+internal: false
+durations: [1, 2, 3]
+minimum_duration: 1
+maximum_duration: 3
+msg: This is a message

data/spec/fixtures/bodies/GandiV5_Domain_WebForwarding/fetch.yml

@@ -0,0 +1,9 @@
+---
+created_at: '2020-11-29T14:57:14Z'
+updated_at: '2020-11-29T14:57:15Z'
+type: http301
+host: here.example.com
+protocol: https
+url: https://example.com/here
+cert_status: '?'
+cert_uuid: cert-uuid

data/spec/fixtures/bodies/GandiV5_Domain_WebForwarding/list.yml

@@ -0,0 +1,9 @@
+---
+- created_at: '2020-11-29T14:57:14Z'
+  updated_at: '2020-11-29T14:57:15Z'
+  type: http301
+  host: here.example.com
+  protocol: https
+  url: https://example.com/here
+  cert_status: '?'
+  cert_uuid: cert-uuid

data/spec/fixtures/bodies/GandiV5_LiveDNS_Domain/fetch.yml

@@ -1,4 +1,3 @@
 ---
-  zonedata: /zones/zone-uuid/recprds
   fqdn: example.com
-  zone: /zones/zone-uuid
+  automatic_snapshots: true

data/spec/fixtures/bodies/GandiV5_LiveDNS_Domain/list_tsig.yml

@@ -0,0 +1,3 @@
+---
+- id: key-uuid
+  key_name: key-name

data/spec/fixtures/bodies/GandiV5_LiveDNS_Domain/nameservers.yml

@@ -0,0 +1,3 @@
+---
+- a.example.com
+- b.example.com

data/spec/fixtures/bodies/GandiV5_LiveDNS_Domain_DnssecKey/fetch.yml

@@ -0,0 +1,12 @@
+---
+id: key-uuid
+status: status
+fqdn: example.com
+algorithm: 2
+algorithm_name: Diffie-Hellman
+deleted: false
+ds: ds-record
+flags: 256
+fingerprint: fp
+public_key: pub-key
+tag: tag

data/spec/fixtures/bodies/GandiV5_LiveDNS_Domain_DnssecKey/list.yml

@@ -0,0 +1,9 @@
+---
+- id: key-uuid
+  status: status
+  fqdn: example.com
+  algorithm: 2
+  algorithm_name: Diffie-Hellman
+  deleted: false
+  ds: ds-record
+  flags: 256

data/spec/fixtures/bodies/{GandiV5_LiveDNS_Zone_Snapshot → GandiV5_LiveDNS_Domain_Snapshot}/fetch.yml

@@ -1,7 +1,8 @@
 ---
-date_created: '2016-12-16T16:51:26Z'
-uuid: snapshot-uuid
-zone_uuid: zone-uuid
+created_at: '2016-12-16T16:51:26Z'
+id: snapshot-uuid
+name: snapshot-name
+automatic: true
 zone_data:
 - rrset_type: A
   rrset_ttl: 10800

data/spec/fixtures/bodies/GandiV5_LiveDNS_Domain_Snapshot/list.yml

@@ -0,0 +1,5 @@
+---
+- id: snapshot-uuid
+  name: snapshot-name
+  automatic: true
+  created_at: '2016-12-16T16:51:26Z'

data/spec/fixtures/bodies/GandiV5_LiveDNS_Domain_TsigKey/fetch.yml

@@ -0,0 +1,9 @@
+---
+id: key-uuid
+key_name: key-name
+secret: key-secret
+config_samples:
+  bind: bind-sample
+  knot: knot-sample
+  nsd: nsd-sample
+  powerdns: powerdns-sample

data/spec/fixtures/bodies/GandiV5_LiveDNS_Domain_TsigKey/list.yml

@@ -0,0 +1,4 @@
+---
+- id: key-uuid
+  key_name: key-name
+  secret: key-secret

data/spec/fixtures/bodies/GandiV5_SimpleHosting_Instance/fetch.yml

@@ -0,0 +1,80 @@
+---
+access_information:
+  admin_url: admin.example.com/
+  database:
+    admins:
+    - type: phpMyAdmin
+      url: admin.example.com/phpmyadmin
+      username: database admin username
+    host: database.example.com
+    port: 1234
+    socket: /socket/for/database
+  deploy:
+  - cli:
+      init: cli init string
+    git:
+      deploy: git deploy string
+      remote: git remote string
+      url: git url string
+    sftp:
+      directory: sftp directory
+      document_root: sftp document root
+      server: sftp server
+      url: sftp url
+    vhost:
+      fqdn: example.com
+      href: link/to/href/details/virtualhost-uuid
+  user: A user
+available_upgrade: false
+console:
+  enabled: true
+  url: console.example.com/
+created_at: 2020-01-02T12:34:56+00
+database:
+  name: database name
+  status: database status
+  version: database version
+datacenter:
+  code: FR-SD5
+  name: SD5
+  region: FR
+expire_at: 2021-01-02T12:34:56+00
+id: instance-uuid
+is_trial: false
+language:
+  name: ruby
+  single_application: true
+  status: great
+  version: "2.7"
+name: instance name
+sharing_space:
+  id: sharing-space-uuid
+  name: sharing space name
+size: s+
+snapshot_enabled: true
+status: active
+storage:
+  additional:
+    unit: GB
+    value: 10
+  base:
+    unit: GB
+    value: 20
+  total:
+    unit: GB
+    value: 30
+vhosts:
+  - fqdn: vhost1.example.com
+    href: link/to.vhost/details
+autorenew:
+  duration: 1
+  duration_type: m
+compatible_applications:
+- name: compatable name
+  parameters: {}
+password_updated_at: 2020-06-02T12:34:56+00
+upgrade_to:
+- name: upgrade to name
+  status: upgrade to status
+  type: database
+  version: upgrade to version

data/spec/fixtures/bodies/GandiV5_SimpleHosting_Instance/list.yml

@@ -0,0 +1,38 @@
+---
+- available_upgrade: true
+  created_at: 2020-01-02T12:34:56+00
+  database:
+    name: database name
+    status: database status
+    version: database version
+  datacenter:
+    code: FR-SD5
+    name: SD5
+    region: FR
+  expire_at: 2021-01-02T12:34:56+00
+  id: instance-uuid
+  language:
+    name: ruby
+    single_application: true
+    status: great
+    version: "2.7"
+  name: instance name
+  sharing_space:
+    id: sharing-space-uuid
+    name: sharing space name
+  size: s+
+  snapshot_enabled: true
+  status: active
+  storage:
+    additional:
+      unit: GB
+      value: 10
+    base:
+      unit: GB
+      value: 20
+    total:
+      unit: GB
+      value: 30
+  autorenew:
+    duration: 1
+    duration_type: m

data/spec/fixtures/bodies/GandiV5_SimpleHosting_Instance_VirtualHost/fetch.yml

@@ -0,0 +1,26 @@
+---
+created_at: 2020-01-02T12:34:56+00
+fqdn: vh.example.com
+is_a_test_vhost: false
+linked_dns_zone:
+  allow_alteration: true
+  cname: cn
+  domain: example.com
+  ipv4: 1.2.3.4
+  ipv6: 1:2::3:4
+  is_alterable: true
+  is_root: true
+  key: www
+  txt: abcd1234
+  last_checked_status: unknown
+  last_checked_at: 2020-02-03T23:45:56+00
+status: running
+application:
+  name: app-name
+  status: being_created
+  parameters: {}
+certificates:
+- href: example.com
+  id: cert-id
+  pending: true
+https_strategy: redirect_HTTP_to_HTTPS