gandi_v5 0.9.1 → 0.10.0

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+class GandiV5
+  class Template
+    class Payload
+      # DNS Record details of a configuration template.
+      # @!attribute [r] name
+      #   @return [String]
+      # @!attribute [r] type
+      #   @return [String]
+      # @!attribute [r] values
+      #   @return [Array<String>]
+      # @!attribute [r] ttl
+      #   @return [Integer, nil] 300-2592000.
+      class DNSRecord
+        include GandiV5::Data
+
+        members :name, :type, :ttl
+        member :values, array: true
+      end
+    end
+  end
+end

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.9.1'
+  VERSION = '0.10.0'
 end

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_Template/fetch.yml

@@ -0,0 +1,41 @@
+---
+description: description of template
+editable: true
+href: https://api.gandi.net/v5/template/templates/template-uuid
+id: template-uuid
+name: template name
+namespaces:
+- dns:record
+- domain:mailboxes
+- domain:nameservers
+- domain:webredirs
+orgname: org-name
+sharing_space:
+  id: sharing-space-uuid
+  name: sharing-space-name
+  reseller: true
+  type: user
+  sharing_space:
+    id: reseller-uuid
+    name: reseller-name
+variables: []
+payload:
+  'dns:records':
+    records:
+    - name: record-name
+      type: TXT
+      values: ['record-value']
+      ttl: 600
+  'domain:mailboxes':
+    values:
+    - login: user-name
+  'domain:nameservers':
+    addresses: ['1.1.1.1']
+    service: custom
+  'domain:webredirs':
+    values:
+    - type: http301
+      url: https://example.com/here
+      host: here.example.com
+      override: true
+      protocol: https

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

@@ -0,0 +1,20 @@
+---
+- description: description of template
+  editable: true
+  href: https://api.gandi.net/v5/template/templates/template-uuid
+  id: template-uuid
+  name: template name
+  namespaces:
+  - dns:record
+  - domain:mailboxes
+  - domain:nameservers
+  - domain:webredirs
+  orgname: org-name
+  sharing_space:
+    id: sharing-space-uuid
+    name: sharing-space-name
+    reseller: true
+    type: user
+    sharing_space:
+      id: reseller-uuid
+      name: reseller-name

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

@@ -0,0 +1,49 @@
+---
+attempt: 1
+created_at: '2020-11-29T14:57:14Z'
+id: dispatch-uuid
+sharing_id: sharing-uuid
+state: 10
+state_msg: state message
+task_updated_at: '2020-11-29T14:57:15Z'
+template_id: template-uuid
+template_name: template
+target:
+  name: domain-api-test1.net
+  type: domain
+target_id: target-uuid
+task_history:
+- namespace: 'domain:nameservers'
+  date: '2020-11-29T16:57:47Z'
+  status: 20
+  message: ''
+task_status:
+  'dns:records':
+    status: 0
+  'domain:mailboxes':
+    status: 10
+  'domain:nameservers':
+    status: 20
+  'domain:webredirs':
+    status: 30
+payload:
+  'dns:records':
+    default: false
+    records:
+    - name: record-name
+      type: TXT
+      values: ['record-value']
+      ttl: 600
+  'domain:mailboxes':
+    values:
+    - login: user-name
+  'domain:nameservers':
+    addresses: ['1.1.1.1']
+    service: custom
+  'domain:webredirs':
+    values:
+    - type: http301
+      url: https://example.com/here
+      host: here.example.com
+      override: true
+      protocol: https

data/spec/spec_helper.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 require 'dotenv'
-require 'coveralls'
 require 'rspec/its'
 require 'simplecov'
+require 'simplecov-lcov'
 require 'timecop'
 require 'vcr'
 require 'webmock/rspec'
@@ -13,14 +13,15 @@ allow_http_connections_to = %w[localhost 127.0.0.1]
 
 Dotenv.load File.join(__dir__, 'test.env')
 
-SimpleCov.coverage_dir(File.join('tmp', 'coverage')) unless ENV.key?('TRAVIS')
+if ENV.key?('GITHUB_ACTIONS')
+  SimpleCov::Formatter::LcovFormatter.config.report_with_single_file = true
+  SimpleCov.formatter = SimpleCov::Formatter::LcovFormatter
+else
+  SimpleCov.coverage_dir File.join('tmp', 'coverage')
+end
 SimpleCov.start do
   add_filter 'spec/'
-end
-
-if ENV.key?('TRAVIS')
-  Coveralls.wear!
-  allow_http_connections_to.push 'coveralls.io'
+  add_filter '.github/'
 end
 
 RSpec.configure do |config|

data/spec/units/gandi_v5/domain/web_forwarding_spec.rb

@@ -0,0 +1,150 @@
+# frozen_string_literal: true
+
+describe GandiV5::Domain::WebForwarding do
+  subject { described_class.new fqdn: 'host.example.com' }
+
+  describe '#update' do
+    let(:url) { 'https://api.gandi.net/v5/domain/domains/example.com/webredirs/host.example.com' }
+    let(:updated_forwarding) { double GandiV5::Domain::WebForwarding }
+
+    before :each do
+      expect(subject).to receive(:refresh).and_return(updated_forwarding)
+      subject.instance_exec { @domain = 'example.com' }
+    end
+
+    it 'nothing' do
+      expect(GandiV5).to receive(:patch).with(url, '{}')
+      expect(subject.update).to be updated_forwarding
+    end
+
+    it 'target' do
+      expect(GandiV5).to receive(:patch).with(url, '{"url":"new"}')
+      expect(subject.update(target: 'new')).to be updated_forwarding
+    end
+
+    it 'override' do
+      expect(GandiV5).to receive(:patch).with(url, '{"override":false}')
+      expect(subject.update(override: false)).to be updated_forwarding
+    end
+
+    it 'protocol' do
+      expect(GandiV5).to receive(:patch).with(url, '{"protocol":"httpsonly"}')
+      expect(subject.update(protocol: :httpsonly)).to be updated_forwarding
+    end
+
+    it 'type' do
+      expect(GandiV5).to receive(:patch).with(url, '{"type":"http302"}')
+      expect(subject.update(type: :http302)).to be updated_forwarding
+    end
+  end
+
+  it '#delete' do
+    url = 'https://api.gandi.net/v5/domain/domains/example.com/webredirs/host.example.com'
+    expect(GandiV5).to receive(:delete).with(url).and_return([nil, { 'message' => 'Confirmation message.' }])
+    subject.instance_exec { @domain = 'example.com' }
+    expect(subject.delete).to eq 'Confirmation message.'
+  end
+
+  describe 'helper methods' do
+    context 'an HTTP 301 redirect' do
+      subject { described_class.new type: :http301 }
+      it('#permanent?') { expect(subject.permanent?).to be true }
+      it('#http301?') { expect(subject.http301?).to be true }
+      it('#temporary?') { expect(subject.temporary?).to be false }
+      it('#http302?') { expect(subject.http302?).to be false }
+      it('#found?') { expect(subject.found?).to be false }
+    end
+
+    context 'an HTTP 302 redirect' do
+      subject { described_class.new type: :http302 }
+      it('#permanent?') { expect(subject.permanent?).to be false }
+      it('#http301?') { expect(subject.http301?).to be false }
+      it('#temporary?') { expect(subject.temporary?).to be true }
+      it('#http302?') { expect(subject.http302?).to be true }
+      it('#found?') { expect(subject.found?).to be true }
+    end
+
+    context 'an http endpoint' do
+      subject { described_class.new protocol: :http }
+      it('#http?') { expect(subject.http?).to be true }
+      it('#https?') { expect(subject.https?).to be false }
+      it('#https_only?') { expect(subject.https_only?).to be false }
+    end
+
+    context 'an https endpoint' do
+      subject { described_class.new protocol: :https }
+      it('#http?') { expect(subject.http?).to be true }
+      it('#https?') { expect(subject.https?).to be true }
+      it('#https_only?') { expect(subject.https_only?).to be false }
+    end
+
+    context 'an https_only endpoint' do
+      subject { described_class.new protocol: :https_only }
+      it('#http?') { expect(subject.http?).to be false }
+      it('#https?') { expect(subject.https?).to be true }
+      it('#https_only?') { expect(subject.https_only?).to be true }
+    end
+  end
+
+  describe '.fetch' do
+    subject { described_class.fetch 'example.com', 'host' }
+
+    before :each do
+      body_fixture = File.expand_path(File.join('spec', 'fixtures', 'bodies', 'GandiV5_Domain_WebForwarding', 'fetch.yml'))
+      url = 'https://api.gandi.net/v5/domain/domains/example.com/webredirs/host.example.com'
+      expect(GandiV5).to receive(:get).with(url).and_return([nil, YAML.load_file(body_fixture)])
+    end
+
+    its('created_at') { should eq Time.new(2020, 11, 29, 14, 57, 14) }
+    its('updated_at') { should eq Time.new(2020, 11, 29, 14, 57, 15) }
+    its('type') { should eq :http301 }
+    its('fqdn') { should eq 'here.example.com' }
+    its('protocol') { should eq :https }
+    its('target') { should eq 'https://example.com/here' }
+    its('cert_status') { should eq '?' }
+    its('cert_uuid') { should eq 'cert-uuid' }
+  end
+
+  describe '.list' do
+    subject { described_class.list 'example.com' }
+
+    before :each do
+      body_fixture = File.expand_path(File.join('spec', 'fixtures', 'bodies', 'GandiV5_Domain_WebForwarding', 'list.yml'))
+      url = 'https://api.gandi.net/v5/domain/domains/example.com/webredirs'
+      expect(GandiV5).to receive(:paginated_get).with(url, (1..), 100)
+                                                .and_yield(YAML.load_file(body_fixture))
+    end
+
+    its('count') { should eq 1 }
+    its('first.created_at') { should eq Time.new(2020, 11, 29, 14, 57, 14) }
+    its('first.updated_at') { should eq Time.new(2020, 11, 29, 14, 57, 15) }
+    its('first.type') { should eq :http301 }
+    its('first.fqdn') { should eq 'here.example.com' }
+    its('first.protocol') { should eq :https }
+    its('first.target') { should eq 'https://example.com/here' }
+    its('first.cert_status') { should eq '?' }
+    its('first.cert_uuid') { should eq 'cert-uuid' }
+  end
+
+  it '.create' do
+    url = 'https://api.gandi.net/v5/domain/domains/example.com/webredirs'
+    body = '{"host":"host","protocol":"httpsonly","type":"http302","url":"example.com","override":true}'
+    response = double(
+      RestClient::Response,
+      headers: { location: ' https://api.gandi.net/v5/domain/domains/example.com/webredirs/host.example.com' }
+    )
+    created_forwarding = double GandiV5::Domain::WebForwarding
+    expect(GandiV5).to receive(:post).with(url, body).and_return([response, 'Confirmation message'])
+    expect(described_class).to receive(:fetch).with('example.com', 'host').and_return(created_forwarding)
+
+    create = {
+      domain: 'example.com',
+      host: 'host',
+      target: 'example.com',
+      protocol: :https_only,
+      type: :http302,
+      override: true
+    }
+    expect(described_class.create(**create)).to be created_forwarding
+  end
+end

data/spec/units/gandi_v5/domain_spec.rb

@@ -208,6 +208,18 @@ describe GandiV5::Domain do
     expect(subject.email_forwards(param: :value)).to be returns
   end
 
+  it '.webforwardings' do
+    returns = double Array
+    expect(GandiV5::Domain::WebForwarding).to receive(:list).with('example.com', param: :value).and_return(returns)
+    expect(subject.web_forwardings(param: :value)).to be returns
+  end
+
+  it '.webforwarding' do
+    returns = double Array
+    expect(GandiV5::Domain::WebForwarding).to receive(:fetch).with('example.com', 'host').and_return(returns)
+    expect(subject.web_forwarding('host')).to be returns
+  end
+
   describe '#to_s' do
     it 'Has identical fqdn and fqdn_unicode' do
       domain = described_class.new fqdn: 'example.com', fqdn_unicode: 'example.com'
@@ -494,6 +506,44 @@ describe GandiV5::Domain do
     end
   end
 
+  describe '#transfer_lock' do
+    it 'Passing nothing' do
+      expect(GandiV5).to receive(:patch).with(
+        'https://api.gandi.net/v5/domain/domains/example.com/status',
+        '{"clientTransferProhibited":true}'
+      ).and_return([nil, { 'message' => 'Confirmation message.' }])
+      expect(subject.transfer_lock).to eq 'Confirmation message.'
+      expect(subject.status).to eq 'clientTransferProhibited'
+    end
+
+    it 'Passing true' do
+      expect(GandiV5).to receive(:patch).with(
+        'https://api.gandi.net/v5/domain/domains/example.com/status',
+        '{"clientTransferProhibited":true}'
+      ).and_return([nil, { 'message' => 'Confirmation message.' }])
+      expect(subject.transfer_lock(true)).to eq 'Confirmation message.'
+      expect(subject.status).to eq 'clientTransferProhibited'
+    end
+
+    it 'Passing false' do
+      expect(GandiV5).to receive(:patch).with(
+        'https://api.gandi.net/v5/domain/domains/example.com/status',
+        '{"clientTransferProhibited":false}'
+      ).and_return([nil, { 'message' => 'Confirmation message.' }])
+      expect(subject.transfer_lock(false)).to eq 'Confirmation message.'
+      expect(subject.status).to be nil
+    end
+  end
+
+  it '#transfer_unlock' do
+    expect(GandiV5).to receive(:patch).with(
+      'https://api.gandi.net/v5/domain/domains/example.com/status',
+      '{"clientTransferProhibited":false}'
+    ).and_return([nil, { 'message' => 'Confirmation message.' }])
+    expect(subject.transfer_unlock).to eq 'Confirmation message.'
+    expect(subject.status).to be nil
+  end
+
   describe '#glue_records' do
     let(:glue_records) { double Hash }