gandi_v5 0.1.0 → 0.6.0

data/spec/units/gandi_v5/live_dns/zone_spec.rb

@@ -30,14 +30,14 @@ describe GandiV5::LiveDNS::Zone do
   describe '#fetch_records' do
     it 'All of them' do
       expect(GandiV5).to receive(:get).with('https://dns.api.gandi.net/api/v5/zones/zone-uuid/records')
-                                      .and_return([])
+                                      .and_return([nil, []])
 
       expect(subject.fetch_records).to eq []
     end
 
     it 'All for a name' do
       expect(GandiV5).to receive(:get).with('https://dns.api.gandi.net/api/v5/zones/zone-uuid/records/name')
-                                      .and_return([])
+                                      .and_return([nil, []])
 
       expect(subject.fetch_records('name')).to eq []
     end
@@ -46,12 +46,15 @@ describe GandiV5::LiveDNS::Zone do
       expect(GandiV5).to receive(:get).with('https://dns.api.gandi.net/api/v5/zones/zone-uuid/records/name/TXT')
                                       .and_return(
                                         [
-                                          {
-                                            'rrset_type' => 'TXT',
-                                            'rrset_name' => 'name',
-                                            'rrset_ttl' => 600,
-                                            'rrset_values' => %w[a b]
-                                          }
+                                          nil,
+                                          [
+                                            {
+                                              'rrset_type' => 'TXT',
+                                              'rrset_name' => 'name',
+                                              'rrset_ttl' => 600,
+                                              'rrset_values' => %w[a b]
+                                            }
+                                          ]
                                         ]
                                       )
 
@@ -71,19 +74,19 @@ describe GandiV5::LiveDNS::Zone do
   describe '#fetch_zone_lines' do
     it 'All of them' do
       url = 'https://dns.api.gandi.net/api/v5/zones/zone-uuid/records'
-      expect(GandiV5).to receive(:get).with(url, accept: 'text/plain').and_return('returned')
+      expect(GandiV5).to receive(:get).with(url, accept: 'text/plain').and_return([nil, 'returned'])
       expect(subject.fetch_zone_lines).to eq 'returned'
     end
 
     it 'All for a name' do
       url = 'https://dns.api.gandi.net/api/v5/zones/zone-uuid/records/name'
-      expect(GandiV5).to receive(:get).with(url, accept: 'text/plain').and_return('returned')
+      expect(GandiV5).to receive(:get).with(url, accept: 'text/plain').and_return([nil, 'returned'])
       expect(subject.fetch_zone_lines('name')).to eq 'returned'
     end
 
     it 'A type for a name' do
       url = 'https://dns.api.gandi.net/api/v5/zones/zone-uuid/records/name/TXT'
-      expect(GandiV5).to receive(:get).with(url, accept: 'text/plain').and_return('returned')
+      expect(GandiV5).to receive(:get).with(url, accept: 'text/plain').and_return([nil, 'returned'])
       expect(subject.fetch_zone_lines('name', 'TXT')).to eq 'returned'
     end
 
@@ -96,7 +99,7 @@ describe GandiV5::LiveDNS::Zone do
     it 'Success' do
       url = 'https://dns.api.gandi.net/api/v5/zones/zone-uuid/records'
       body = '{"rrset_name":"name","rrset_type":"TXT","rrset_ttl":900,"rrset_values":["a","b"]}'
-      expect(GandiV5).to receive(:post).with(url, body).and_return('message' => 'Confirmation message.')
+      expect(GandiV5).to receive(:post).with(url, body).and_return([nil, { 'message' => 'Confirmation message.' }])
       expect(subject.add_record('name', 'TXT', 900, 'a', 'b')).to eq 'Confirmation message.'
     end
 
@@ -122,19 +125,19 @@ describe GandiV5::LiveDNS::Zone do
   describe '#delete_records' do
     it 'All of them' do
       url = 'https://dns.api.gandi.net/api/v5/zones/zone-uuid/records'
-      expect(GandiV5).to receive(:delete).with(url)
+      expect(GandiV5).to receive(:delete).with(url).and_return([nil, nil])
       subject.delete_records
     end
 
     it 'All for a name' do
       url = 'https://dns.api.gandi.net/api/v5/zones/zone-uuid/records/name'
-      expect(GandiV5).to receive(:delete).with(url)
+      expect(GandiV5).to receive(:delete).with(url).and_return([nil, nil])
       subject.delete_records 'name'
     end
 
     it 'A type for a name' do
       url = 'https://dns.api.gandi.net/api/v5/zones/zone-uuid/records/name/TXT'
-      expect(GandiV5).to receive(:delete).with(url)
+      expect(GandiV5).to receive(:delete).with(url).and_return([nil, nil])
       subject.delete_records 'name', 'TXT'
     end
 
@@ -152,7 +155,7 @@ describe GandiV5::LiveDNS::Zone do
       url = 'https://dns.api.gandi.net/api/v5/zones/zone-uuid/records'
       body = '{"items":[{"rrset_name":"name","rrset_ttl":600,"rrset_type":"TXT","rrset_values":["a"]}]}'
       expect(GandiV5).to receive(:put).with(url, body)
-                                      .and_return('message' => 'Confirmation message.')
+                                      .and_return([nil, { 'message' => 'Confirmation message.' }])
       expect(subject.replace_records(records: records)).to eq 'Confirmation message.'
     end
 
@@ -164,7 +167,7 @@ describe GandiV5::LiveDNS::Zone do
 
       url = 'https://dns.api.gandi.net/api/v5/zones/zone-uuid/records'
       expect(GandiV5).to receive(:put).with(url, records, 'content-type': 'text/plain')
-                                      .and_return('message' => 'Confirmation message.')
+                                      .and_return([nil, { 'message' => 'Confirmation message.' }])
       expect(subject.replace_records(text: records)).to eq 'Confirmation message.'
     end
 
@@ -180,36 +183,41 @@ describe GandiV5::LiveDNS::Zone do
     end
   end
 
-  it '#replace_records_for' do
-    url = 'https://dns.api.gandi.net/api/v5/zones/zone-uuid/records/name'
-    body = '{"items":[{"rrset_type":"TXT","rrset_values":["a"]}]}'
-    expect(GandiV5).to receive(:put).with(url, body)
-                                    .and_return('message' => 'Confirmation message.')
-    records = { type: 'TXT', values: ['a'] }
-    expect(subject.replace_records_for('name', records)).to eq 'Confirmation message.'
-  end
+  describe '#replace_records_for' do
+    it 'Given no type or ttl' do
+      url = 'https://dns.api.gandi.net/api/v5/zones/zone-uuid/records/name'
+      body = '{"items":[{"rrset_type":"TXT","rrset_values":["a"]}]}'
+      expect(GandiV5).to receive(:put).with(url, body)
+                                      .and_return([nil, { 'message' => 'Confirmation message.' }])
+      records = [{ type: 'TXT', values: ['a'] }]
+      expect(subject.replace_records_for('name', records)).to eq 'Confirmation message.'
+    end
 
-  describe '#replace_??_records_for' do
-    it '#replace_a_records_for' do
-      url = 'https://dns.api.gandi.net/api/v5/zones/zone-uuid/records/name/A'
-      body = '{"rrset_ttl":600,"rrset_values":["192.168.0.1","192.168.0.2"]}'
+    it 'Given type and ttl' do
+      url = 'https://dns.api.gandi.net/api/v5/zones/zone-uuid/records/name/TXT'
+      body = '{"rrset_values":["a"],"rrset_ttl":600}'
       expect(GandiV5).to receive(:put).with(url, body)
-                                      .and_return('message' => 'Confirmation message.')
-      expect(subject.replace_a_records_for('name', 600, '192.168.0.1', '192.168.0.2')).to eq 'Confirmation message.'
+                                      .and_return([nil, { 'message' => 'Confirmation message.' }])
+      expect(subject.replace_records_for('name', ['a'], type: 'TXT', ttl: 600)).to eq 'Confirmation message.'
     end
 
-    it '#replace_txt_records_for' do
+    it 'Given type but no ttl' do
       url = 'https://dns.api.gandi.net/api/v5/zones/zone-uuid/records/name/TXT'
-      body = '{"rrset_ttl":600,"rrset_values":["a","b"]}'
+      body = '{"rrset_values":["a"],"rrset_ttl":null}'
       expect(GandiV5).to receive(:put).with(url, body)
-                                      .and_return('message' => 'Confirmation message.')
-      expect(subject.replace_txt_records_for('name', 600, 'a', 'b')).to eq 'Confirmation message.'
+                                      .and_return([nil, { 'message' => 'Confirmation message.' }])
+      expect(subject.replace_records_for('name', ['a'], type: 'TXT')).to eq 'Confirmation message.'
+    end
+
+    it 'Given ttl but no type' do
+      expect(GandiV5).to_not receive(:put)
+      expect { subject.replace_records_for 'name', 'a', ttl: 600 }.to raise_error ArgumentError, 'missing keyword: type'
     end
   end
 
   it '#list_domains' do
     expect(GandiV5).to receive(:get).with('https://dns.api.gandi.net/api/v5/zones/zone-uuid/domains')
-                                    .and_return([{ 'fqdn' => 'example.com' }])
+                                    .and_return([nil, [{ 'fqdn' => 'example.com' }]])
     expect(subject.list_domains).to match_array ['example.com']
   end
 
@@ -218,7 +226,7 @@ describe GandiV5::LiveDNS::Zone do
       url = 'https://dns.api.gandi.net/api/v5/domains/example.com'
       body = '{"zone_uuid":"zone-uuid"}'
       expect(GandiV5).to receive(:patch).with(url, body)
-                                        .and_return('message' => 'Confirmation message.')
+                                        .and_return([nil, { 'message' => 'Confirmation message.' }])
       expect(subject.attach_domain('example.com')).to eq 'Confirmation message.'
     end
 
@@ -226,17 +234,17 @@ describe GandiV5::LiveDNS::Zone do
       url = 'https://dns.api.gandi.net/api/v5/domains/example.com'
       body = '{"zone_uuid":"zone-uuid"}'
       expect(GandiV5).to receive(:patch).with(url, body)
-                                        .and_return('message' => 'Confirmation message.')
+                                        .and_return([nil, { 'message' => 'Confirmation message.' }])
       domain = double GandiV5::LiveDNS::Domain, fqdn: 'example.com'
       expect(subject.attach_domain(domain)).to eq 'Confirmation message.'
     end
   end
 
   it '#snapshots' do
-    returns = [{ 'uuid' => 'snapshot-uuid', 'date_created' => '2016-12-16T16:51:26Z' }]
-    expect(GandiV5).to receive(:get).with('https://dns.api.gandi.net/api/v5/zones/zone-uuid/snapshots')
-                                    .and_return(returns)
-    expect(subject.snapshots).to eq('snapshot-uuid' => Time.new(2016, 12, 16, 16, 51, 26, 0))
+    returns = double Hash
+    expect(GandiV5::LiveDNS::Zone::Snapshot).to receive(:list).with('zone-uuid')
+                                                              .and_return(returns)
+    expect(subject.snapshots).to be returns
   end
 
   it '#snapshot' do
@@ -249,7 +257,7 @@ describe GandiV5::LiveDNS::Zone do
   it '#take_snapshot' do
     returns = double GandiV5::LiveDNS::Zone::Snapshot
     expect(GandiV5).to receive(:post).with('https://dns.api.gandi.net/api/v5/zones/zone-uuid/snapshots')
-                                     .and_return('message' => 'Confirmation message.', 'uuid' => 'snapshot-uuid')
+                                     .and_return([nil, { 'message' => 'Confirmation message.', 'uuid' => 'snapshot-uuid' }])
     expect(GandiV5::LiveDNS::Zone::Snapshot).to receive(:fetch).with('zone-uuid', 'snapshot-uuid')
                                                                .and_return(returns)
     expect(subject.take_snapshot).to be returns
@@ -258,7 +266,7 @@ describe GandiV5::LiveDNS::Zone do
   it '#update' do
     body = '{"name":"new-name"}'
     expect(GandiV5).to receive(:patch).with('https://dns.api.gandi.net/api/v5/zones/zone-uuid', body)
-                                      .and_return('message' => 'Confirmation message.')
+                                      .and_return([nil, { 'message' => 'Confirmation message.' }])
     expect(subject.update(name: 'new-name')).to eq 'Confirmation message.'
   end
 
@@ -268,19 +276,29 @@ describe GandiV5::LiveDNS::Zone do
   end
 
   describe '.create' do
+    let(:created_response) do
+      double(
+        RestClient::Response,
+        headers: { location: 'https://dns.api.gandi.net/v5/zones/created-zone-uuid' }
+      )
+    end
+    let(:created_zone) { double GandiV5::LiveDNS::Zone }
+
     it 'With sharing-id' do
       body = '{"name":"Name"}'
       params = { sharing_id: 'sharing-id' }
       expect(GandiV5).to receive(:post).with('https://dns.api.gandi.net/api/v5/zones', body, params: params)
-                                       .and_return('message' => 'Confirmation message.')
-      expect(described_class.create('Name', sharing_id: 'sharing-id')).to eq 'Confirmation message.'
+                                       .and_return([created_response, { 'message' => 'Confirmation message.' }])
+      expect(described_class).to receive(:fetch).with('created-zone-uuid').and_return(created_zone)
+      expect(described_class.create('Name', sharing_id: 'sharing-id')).to be created_zone
     end
 
     it 'Without sharing-id' do
       body = '{"name":"Name"}'
       expect(GandiV5).to receive(:post).with('https://dns.api.gandi.net/api/v5/zones', body, params: {})
-                                       .and_return('message' => 'Confirmation message.')
-      expect(described_class.create('Name')).to eq 'Confirmation message.'
+                                       .and_return([created_response, { 'message' => 'Confirmation message.' }])
+      expect(described_class).to receive(:fetch).with('created-zone-uuid').and_return(created_zone)
+      expect(described_class.create('Name')).to be created_zone
     end
   end
 
@@ -288,9 +306,9 @@ describe GandiV5::LiveDNS::Zone do
     subject { described_class.list }
 
     before :each do
-      body_fixture = File.expand_path(File.join('spec', 'fixtures', 'bodies', 'GandiV5_LiveDNS_Zone', 'list.yaml'))
+      body_fixture = File.expand_path(File.join('spec', 'fixtures', 'bodies', 'GandiV5_LiveDNS_Zone', 'list.yml'))
       expect(GandiV5).to receive(:get).with('https://dns.api.gandi.net/api/v5/zones')
-                                      .and_return(YAML.load_file(body_fixture))
+                                      .and_return([nil, YAML.load_file(body_fixture)])
     end
 
     its('count') { should eq 1 }
@@ -310,9 +328,9 @@ describe GandiV5::LiveDNS::Zone do
     subject { described_class.fetch 'zone-uuid' }
 
     before :each do
-      body_fixture = File.expand_path(File.join('spec', 'fixtures', 'bodies', 'GandiV5_LiveDNS_Zone', 'get.yaml'))
+      body_fixture = File.expand_path(File.join('spec', 'fixtures', 'bodies', 'GandiV5_LiveDNS_Zone', 'fetch.yml'))
       expect(GandiV5).to receive(:get).with('https://dns.api.gandi.net/api/v5/zones/zone-uuid')
-                                      .and_return(YAML.load_file(body_fixture))
+                                      .and_return([nil, YAML.load_file(body_fixture)])
     end
 
     its('uuid') { should eq 'zone-uuid' }

data/spec/units/gandi_v5/live_dns_spec.rb

@@ -1,6 +1,30 @@
 # frozen_string_literal: true
 
 describe GandiV5::LiveDNS do
+  it '.domain' do
+    returns = double GandiV5::LiveDNS::Domain
+    expect(GandiV5::LiveDNS::Domain).to receive(:fetch).with('example.com').and_return(returns)
+    expect(described_class.domain('example.com')).to be returns
+  end
+
+  it '.domains' do
+    returns = double Array
+    expect(GandiV5::LiveDNS::Domain).to receive(:list).and_return(returns)
+    expect(described_class.domains).to be returns
+  end
+
+  it '.zone' do
+    returns = double GandiV5::LiveDNS::Zone
+    expect(GandiV5::LiveDNS::Zone).to receive(:fetch).with('zone-uuid').and_return(returns)
+    expect(described_class.zone('zone-uuid')).to be returns
+  end
+
+  it '.zones' do
+    returns = double Array
+    expect(GandiV5::LiveDNS::Zone).to receive(:list).and_return(returns)
+    expect(described_class.zones).to be returns
+  end
+
   describe '.require_valid_record_type' do
     it 'Does nothing for valid type' do
       expect { described_class.require_valid_record_type 'A' }.to_not raise_error

data/spec/units/gandi_v5/organization/customer_spec.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+describe GandiV5::Organization::Customer do
+  let(:body_fixtures) { File.expand_path(File.join('spec', 'fixtures', 'bodies', 'GandiV5_Organization_Customer')) }
+
+  describe '.create' do
+    let(:url) { 'https://api.gandi.net/v5/organization/organizations/uuid/customers' }
+    let(:attrs) do
+      {
+        city: 'Ci',
+        country: 'Co',
+        email: 'a@e',
+        firstname: 'f',
+        lastname: 'l',
+        phone: '0',
+        streetaddr: 'sa',
+        type: :individual
+      }
+    end
+
+    it 'Success' do
+      response = double RestClient::Response, headers: { location: '' }
+      expect(GandiV5).to receive(:post).with(url, attrs.to_json).and_return([response, nil])
+      expect(described_class.create('uuid', **attrs)).to be nil
+    end
+
+    describe 'Checks for required attributes' do
+      %i[city country email firstname lastname phone streetaddr type].each do |attr|
+        it attr do
+          attrs.delete attr
+          expect { described_class.new('org_uuid', **attrs) }.to raise_exception ArgumentError
+        end
+      end
+    end
+
+    it 'Invalid type' do
+      attrs[:type] = :invalid
+      expect { described_class.new('org_uuid', **attrs) }.to raise_exception ArgumentError
+    end
+  end
+
+  describe '.list' do
+    describe 'With default values' do
+      subject { described_class.list('uuid') }
+
+      before :each do
+        url = 'https://api.gandi.net/v5/organization/organizations/uuid/customers'
+        expect(GandiV5).to receive(:get).with(url, params: {})
+                                        .and_return([nil, YAML.load_file(File.join(body_fixtures, 'list.yml'))])
+      end
+
+      its('count') { should eq 1 }
+      its('first.uuid') { should eq 'customer-uuid' }
+      its('first.name') { should eq 'FirstLast' }
+      its('first.first_name') { should eq 'First' }
+      its('first.last_name') { should eq 'Last' }
+      its('first.email') { should eq 'first.last@example.com' }
+      its('first.type') { should eq :individual }
+      its('first.org_name') { should eq 'Org' }
+    end
+
+    describe 'Passes optional query params' do
+      let(:url) { 'https://api.gandi.net/v5/organization/organizations/org_uuid/customers' }
+
+      it 'name' do
+        expect(GandiV5).to receive(:get).with(url, params: { '~name' => '5' })
+                                        .and_return([nil, []])
+        expect(described_class.list('org_uuid', name: '5')).to eq []
+      end
+
+      %i[permission sort_by].each do |param|
+        it param.to_s do
+          headers = { param => 5 }
+          expect(GandiV5).to receive(:get).with(url, params: headers)
+                                          .and_return([nil, []])
+          expect(described_class.list('org_uuid', **headers)).to eq []
+        end
+      end
+    end
+  end
+end

data/spec/units/gandi_v5/organization_spec.rb

@@ -3,11 +3,48 @@
 describe GandiV5::Organization do
   let(:body_fixtures) { File.expand_path(File.join('spec', 'fixtures', 'bodies', 'GandiV5_Organization')) }
 
+  describe '.list' do
+    describe 'With default values' do
+      subject { described_class.list }
+
+      before :each do
+        expect(GandiV5).to receive(:get).with('https://api.gandi.net/v5/organization/organizations', params: {})
+                                        .and_return([nil, YAML.load_file(File.join(body_fixtures, 'list.yml'))])
+      end
+
+      its('count') { should eq 1 }
+      its('first.uuid') { should eq 'organization-uuid' }
+      its('first.name') { should eq 'FirstLast' }
+      its('first.first_name') { should eq 'First' }
+      its('first.last_name') { should eq 'Last' }
+    end
+
+    describe 'Passes optional query params' do
+      it 'name' do
+        expect(GandiV5).to receive(:get).with(
+          'https://api.gandi.net/v5/organization/organizations',
+          params: { '~name' => '5' }
+        )
+                                        .and_return([nil, []])
+        expect(described_class.list(name: '5')).to eq []
+      end
+
+      %i[type permission sort_by].each do |param|
+        it param.to_s do
+          headers = { param => 5 }
+          expect(GandiV5).to receive(:get).with('https://api.gandi.net/v5/organization/organizations', params: headers)
+                                          .and_return([nil, []])
+          expect(described_class.list(**headers)).to eq []
+        end
+      end
+    end
+  end
+
   describe '.fetch' do
     subject { described_class.fetch }
     before :each do
       expect(GandiV5).to receive(:get).with('https://api.gandi.net/v5/organization/user-info')
-                                      .and_return(YAML.load_file(File.join(body_fixtures, 'get.yaml')))
+                                      .and_return([nil, YAML.load_file(File.join(body_fixtures, 'fetch.yml'))])
     end
 
     its('uuid') { should eq 'organization-uuid' }
@@ -27,4 +64,18 @@ describe GandiV5::Organization do
     its('security_email_validated') { should eq true }
     its('security_email_validation_deadline') { should eq Time.new(2017, 11, 22, 17, 13, 33) }
   end
+
+  it '#customers' do
+    subject = described_class.new uuid: 'org_uuid'
+    returns = double Array
+    expect(GandiV5::Organization::Customer).to receive(:list).with('org_uuid', param: :value).and_return(returns)
+    expect(subject.customers('org_uuid', param: :value)).to be returns
+  end
+
+  it '#create_customer' do
+    subject = described_class.new uuid: 'org_uuid'
+    returns = double Object
+    expect(GandiV5::Organization::Customer).to receive(:create).with('org_uuid', param: :value).and_return(returns)
+    expect(subject.create_customer('org_uuid', param: :value)).to be returns
+  end
 end