gandi_v5 0.1.0 → 0.2.0

data/lib/gandi_v5/live_dns/zone.rb

@@ -63,7 +63,7 @@ class GandiV5
       #   @param name [String] the name to fetch records for.
       #   @param type [String] the record type to fetch.
       # @return [Array<GandiV5::LiveDNS::RecordSet>]
-      # @raise [GandiV5::Error::GandiError::GandiError] if Gandi returns an error.
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
       def fetch_records(name = nil, type = nil)
         GandiV5::LiveDNS.require_valid_record_type type if type
 
@@ -71,7 +71,7 @@ class GandiV5
         url_ += "/#{CGI.escape name}" if name
         url_ += "/#{CGI.escape type}" if type
 
-        data = GandiV5.get url_
+        _response, data = GandiV5.get url_
         data = [data] unless data.is_a?(Array)
         data.map { |item| GandiV5::LiveDNS::RecordSet.from_gandi item }
       end
@@ -86,7 +86,7 @@ class GandiV5
       #   @param name [String] the name to fetch records for.
       #   @param type [String] the record type to fetch.
       # @return [String]
-      # @raise [GandiV5::Error::GandiError::GandiError] if Gandi returns an error.
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
       def fetch_zone_lines(name = nil, type = nil)
         GandiV5::LiveDNS.require_valid_record_type type if type
 
@@ -94,7 +94,7 @@ class GandiV5
         url_ += "/#{CGI.escape name}" if name
         url_ += "/#{CGI.escape type}" if type
 
-        GandiV5.get url_, accept: 'text/plain'
+        GandiV5.get(url_, accept: 'text/plain').last
       end
 
       # Add record to this zone.
@@ -103,7 +103,7 @@ class GandiV5
       # @param ttl [Integer]
       # @param values [Array<String>]
       # @return [String] The confirmation message from Gandi.
-      # @raise [GandiV5::Error::GandiError::GandiError] if Gandi returns an error.
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
       def add_record(name, type, ttl, *values)
         GandiV5::LiveDNS.require_valid_record_type type
         fail ArgumentError, 'ttl must be positive and non-zero' unless ttl.positive?
@@ -115,7 +115,7 @@ class GandiV5
           rrset_ttl: ttl,
           rrset_values: values
         }.to_json
-        data = GandiV5.post "#{url}/records", body
+        _response, data = GandiV5.post "#{url}/records", body
         data['message']
       end
 
@@ -129,14 +129,14 @@ class GandiV5
       #   @param name [String] the name to delete records for.
       #   @param type [String] the record type to delete.
       # @return [nil]
-      # @raise [GandiV5::Error::GandiError::GandiError] if Gandi returns an error.
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
       def delete_records(name = nil, type = nil)
         GandiV5::LiveDNS.require_valid_record_type type if type
 
         url_ = "#{url}/records"
         url_ += "/#{CGI.escape name}" if name
         url_ += "/#{CGI.escape type}" if type
-        GandiV5.delete url_
+        GandiV5.delete(url_).last
       end
 
       # Replace all records for this zone.
@@ -146,9 +146,9 @@ class GandiV5
       # @param text [String] zone file lines to replace the records with.
       # @return [String] The confirmation message from Gandi.
       # @raise [ArgumentError] if neither/both of records & test are passed.
-      # @raise [GandiV5::Error::GandiError::GandiError] if Gandi returns an error.
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
       def replace_records(records: nil, text: nil)
-        unless [records, text].count(&:nil?).eql?(1)
+        unless [records, text].one?(&:nil?)
           fail ArgumentError, 'you must pass ONE of records: or text:'
         end
 
@@ -156,47 +156,52 @@ class GandiV5
           body = {
             items: records.map { |r| r.transform_keys { |k| "rrset_#{k}" } }
           }.to_json
-          data = GandiV5.put "#{url}/records", body
+          _response, data = GandiV5.put "#{url}/records", body
         elsif text
-          data = GandiV5.put "#{url}/records", text, 'content-type': 'text/plain'
+          _response, data = GandiV5.put "#{url}/records", text, 'content-type': 'text/plain'
         end
         data['message']
       end
 
-      # Replace records for a name in this zone.
-      # @param name [String]
-      # @param records
-      #   [Array<Hash<type: String, ttl: Integer, values: Array<String>>>]
-      #   the records to add.
+      # @override replace_records_for(name, records)
+      #   Replace records for a name in this zone.
+      #   @param name [String]
+      #   @param records
+      #     [Array<Hash<type: String, ttl: Integer, values: Array<String>>>]
+      #     the records to add.
+      # @override replace_records_for(name, values, type: nil, ttl: nil)
+      #   Replace records for a name in this zone.
+      #   @param name [String]
+      #   @param type [String] the record type.
+      #   @param ttl [Integer] the TTL to set for the record.
+      #   @param values [Array<String>] the values to set for the record.
+      #   @raise [ArgumentError] if ttl is present and type is absent.
       # @return [String] The confirmation message from Gandi.
-      # @raise [GandiV5::Error::GandiError::GandiError] if Gandi returns an error.
-      def replace_records_for(name, *records)
-        body = {
-          items: records.map { |r| r.transform_keys { |k| "rrset_#{k}" } }
-        }.to_json
-        data = GandiV5.put "#{url}/records/#{name}", body
-        data['message']
-      end
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+      def replace_records_for(name, records, type: nil, ttl: nil)
+        fail ArgumentError, 'missing keyword: type' if ttl && type.nil?
+
+        if type
+          GandiV5::LiveDNS.require_valid_record_type type
+          body = { rrset_values: records, rrset_ttl: ttl }
+          # body[:rrset_ttl] = ttl if ttl
+          _response, data = GandiV5.put "#{url}/records/#{name}/#{type}", body.to_json
 
-      GandiV5::LiveDNS::RECORD_TYPES.each do |type|
-        # Replace records of a given type for a name in this zone.
-        # @return [String] The confirmation message from Gandi.
-        # @raise [GandiV5::Error::GandiError::GandiError] if Gandi returns an error.
-        define_method "replace_#{type.downcase}_records_for" do |name, ttl, *values|
+        else
           body = {
-            rrset_ttl: ttl,
-            rrset_values: values
-          }.to_json
-          data = GandiV5.put "#{url}/records/#{name}/#{type}", body
-          data['message']
+            items: records.map { |r| r.transform_keys { |k| "rrset_#{k}" } }
+          }
+          _response, data = GandiV5.put "#{url}/records/#{name}", body.to_json
         end
+
+        data['message']
       end
 
       # List the domains that use this zone.
       # @return [Array<String>] The FQDNs.
-      # @raise [GandiV5::Error::GandiError::GandiError] if Gandi returns an error.
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
       def list_domains
-        data = GandiV5.get "#{url}/domains"
+        _response, data = GandiV5.get "#{url}/domains"
         data.map { |item| item['fqdn'] }
       end
 
@@ -204,50 +209,49 @@ class GandiV5
       # @param fqdn [String, #fqdn, #to_s] the fully qualified domain name
       #   that should start using this zone.
       # @return [String] The confirmation message from Gandi.
-      # @raise [GandiV5::Error::GandiError::GandiError] if Gandi returns an error.
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
       def attach_domain(fqdn)
         fqdn = fqdn.fqdn if fqdn.respond_to?(:fqdn)
-        data = GandiV5.patch "#{BASE}domains/#{CGI.escape fqdn}", { zone_uuid: uuid }.to_json
+        _resp, data = GandiV5.patch "#{BASE}domains/#{CGI.escape fqdn}", { zone_uuid: uuid }.to_json
         data['message']
       end
 
-      # Get snapshot UUIDs for this zone from Gandi.lib/gandi_v5/domain/auto_renew.rb
-      # @return [Hash{String => Time}] Mapping UUID to time made.
-      # @raise [GandiV5::Error::GandiError::GandiError] if Gandi returns an error.
+      # Get snapshot UUIDs for this zone from Gandi.
+      # @return [Hash{String => Time}] Mapping snapshot UUID to time made.
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
       def snapshots
-        data = GandiV5.get "#{url}/snapshots"
-        Hash[data.map { |snapshot| [snapshot['uuid'], Time.parse(snapshot['date_created'])] }]
+        GandiV5::LiveDNS::Zone::Snapshot.list uuid
       end
 
       # Get snapshot from Gandi.
       # @param uuid [String] the UUID of the snapshot to fetch.
       # @return [GandiV5::LiveDNS::Zone::Snapshot]
-      # @raise [GandiV5::Error::GandiError::GandiError] if Gandi returns an error.
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
       def snapshot(uuid)
         GandiV5::LiveDNS::Zone::Snapshot.fetch self.uuid, uuid
       end
 
       # Take a snapshot of this zone.
       # @return [GandiV5::LiveDNS::Zone::Snapshot]
-      # @raise [GandiV5::Error::GandiError::GandiError] if Gandi returns an error.
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
       def take_snapshot
-        data = GandiV5.post "#{url}/snapshots"
+        _response, data = GandiV5.post "#{url}/snapshots"
         snapshot data['uuid']
       end
 
       # Update this zone.
       # @param name [String, #to_s] new name for the zone.
       # @return [String] The confirmation message from Gandi.
-      # @raise [GandiV5::Error::GandiError::GandiError] if Gandi returns an error.
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
       def update(name:)
-        data = GandiV5.patch url, { name: name }.to_json
+        _response, data = GandiV5.patch url, { name: name }.to_json
         self.name = name
         data['message']
       end
 
       # Delete this zone from Gandi.
       # @return [nil]
-      # @raise [GandiV5::Error::GandiError::GandiError] if Gandi returns an error.
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
       def delete
         GandiV5.delete url
       end
@@ -255,34 +259,34 @@ class GandiV5
       # Create a new zone.
       # @param name [String] the name for the created zone.
       # @param sharing_id [String] the UUID of the account to ceate the zone under.
-      # @return [String] The confirmation message from Gandi.
-      # @raise [GandiV5::Error::GandiError::GandiError] if Gandi returns an error.
-      # TODO: Fetch created zone
+      # @return [GandiV5::LiveDNS::Zone] The created zone.
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
       def self.create(name, sharing_id: nil)
         params = sharing_id ? { sharing_id: sharing_id } : {}
 
-        data = GandiV5.post(
+        response, _data = GandiV5.post(
           url,
           { name: name }.to_json,
           params: params
         )
-        data['message']
+
+        fetch response.headers[:location].split('/').last
       end
 
       # List the zones.
       # @return [Array<GandiV5::LiveDNS::Zone>]
-      # @raise [GandiV5::Error::GandiError::GandiError] if Gandi returns an error.
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
       def self.list
-        data = GandiV5.get url
+        _response, data = GandiV5.get url
         data.map { |item| from_gandi item }
       end
 
       # Get a zone from Gandi.
       # @param uuid [String, #to_s] the UUID of the zone to fetch.
       # @return [GandiV5::LiveDNS::Zone]
-      # @raise [GandiV5::Error::GandiError::GandiError] if Gandi returns an error.
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
       def self.fetch(uuid)
-        data = GandiV5.get url(uuid)
+        _response, data = GandiV5.get url(uuid)
         from_gandi data
       end
 

data/lib/gandi_v5/live_dns.rb

@@ -11,6 +11,26 @@ class GandiV5
       WKS SRV LOC SPF CAA DS SSHFP PTR KEY DNAME TLSA OPENPGPKEY CDS
     ].freeze
 
+    # @see GandiV5::LiveDNS::Domain.fetch
+    def self.domain(fqdn)
+      GandiV5::LiveDNS::Domain.fetch(fqdn)
+    end
+
+    # @see GandiV5::LiveDNS::Domain.list
+    def self.domains
+      GandiV5::LiveDNS::Domain.list
+    end
+
+    # @see GandiV5::LiveDNS::Zone.fetch
+    def self.zone(uuid)
+      GandiV5::LiveDNS::Zone.fetch(uuid)
+    end
+
+    # @see GandiV5::LiveDNS::Zone.list
+    def self.zones
+      GandiV5::LiveDNS::Zone.list
+    end
+
     # Raise an error if passed type is invalid.
     # @param type [String] the record type to check.
     # @return [nil]

data/lib/gandi_v5/organization.rb

@@ -57,9 +57,9 @@ class GandiV5
     # Get information about the current authenticated user.
     # @see https://api.gandi.net/docs/organization#get-v5-organization-user-info
     # @return [GandiV5::Organization]
-    # @raise [GandiV5::Error::GandiError::GandiError] if Gandi returns an error.
+    # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
     def self.fetch
-      data = GandiV5.get "#{BASE}organization/user-info"
+      _response, data = GandiV5.get "#{BASE}organization/user-info"
       from_gandi data
     end
   end

data/lib/gandi_v5/version.rb

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

data/lib/gandi_v5.rb

@@ -26,6 +26,26 @@ require 'securerandom'
 class GandiV5
   BASE = 'https://api.gandi.net/v5/'
 
+  # @see GandiV5::Domain.fetch
+  def self.domain(fqdn)
+    GandiV5::Domain.fetch(fqdn)
+  end
+
+  # @see GandiV5::Domain.list
+  def self.domains(**params)
+    GandiV5::Domain.list(**params)
+  end
+
+  # @see GandiV5::Email::Mailbox.list
+  def self.mailboxes(fqdn, **params)
+    GandiV5::Email::Mailbox.list(fqdn, **params)
+  end
+
+  # @see GandiV5::Email::Slot.list
+  def self.mailbox_slots(fqdn)
+    GandiV5::Email::Slot.list(fqdn)
+  end
+
   class << self
     attr_writer :api_key
 
@@ -41,7 +61,7 @@ class GandiV5
     def get(url, **headers)
       prepare_headers headers, url
       response = RestClient.get url, **headers
-      parse_response response
+      [response, parse_response(response)]
     rescue RestClient::BadRequest => e
       handle_bad_request(e)
     end
@@ -59,7 +79,7 @@ class GandiV5
     def delete(url, **headers)
       prepare_headers headers, url
       response = RestClient.delete url, **headers
-      parse_response response
+      [response, parse_response(response)]
     rescue RestClient::BadRequest => e
       handle_bad_request(e)
     end
@@ -79,7 +99,7 @@ class GandiV5
       prepare_headers headers, url
       headers[:'content-type'] ||= 'application/json'
       response = RestClient.patch url, payload, **headers
-      parse_response response
+      [response, parse_response(response)]
     rescue RestClient::BadRequest => e
       handle_bad_request(e)
     end
@@ -99,7 +119,7 @@ class GandiV5
       prepare_headers headers, url
       headers[:'content-type'] ||= 'application/json'
       response = RestClient.post url, payload, **headers
-      parse_response response
+      [response, parse_response(response)]
     rescue RestClient::BadRequest => e
       handle_bad_request(e)
     end
@@ -119,7 +139,7 @@ class GandiV5
       prepare_headers headers, url
       headers[:'content-type'] ||= 'application/json'
       response = RestClient.put url, payload, **headers
-      parse_response response
+      [response, parse_response(response)]
     rescue RestClient::BadRequest => e
       handle_bad_request(e)
     end

data/spec/features/domain_spec.rb

@@ -2,7 +2,7 @@
 
 describe 'Domain features' do
   it 'List domains', :vcr do
-    list = GandiV5::Domain.list
+    list = GandiV5.domains
 
     expect(list.count).to eq 1
     expect(list.first.fqdn).to eq 'example.net'

data/spec/fixtures/bodies/GandiV5_LiveDNS_Zone_Snapshot/list.yaml

@@ -0,0 +1,3 @@
+---
+- uuid: snapshot-uuid
+  date_created: '2016-12-16T16:51:26Z'

data/spec/units/gandi_v5/billing_spec.rb

@@ -6,7 +6,7 @@ describe GandiV5::Billing do
     before :each do
       body_fixture = File.expand_path(File.join('spec', 'fixtures', 'bodies', 'GandiV5_Billing', 'info.yaml'))
       expect(GandiV5).to receive(:get).with('https://api.gandi.net/v5/billing/info')
-                                      .and_return(YAML.load_file(body_fixture))
+                                      .and_return([nil, YAML.load_file(body_fixture)])
     end
 
     its('annual_balance') { should eq 123.45 }
@@ -25,7 +25,7 @@ describe GandiV5::Billing do
     before :each do
       body_fixture = File.expand_path(File.join('spec', 'fixtures', 'bodies', 'GandiV5_Billing', 'info.yaml'))
       expect(GandiV5).to receive(:get).with('https://api.gandi.net/v5/billing/info/sharing-id')
-                                      .and_return(YAML.load_file(body_fixture))
+                                      .and_return([nil, YAML.load_file(body_fixture)])
     end
 
     its('annual_balance') { should eq 123.45 }

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

@@ -6,7 +6,7 @@ describe GandiV5::Domain::AutoRenew do
 
   it '#disable' do
     expect(GandiV5).to receive(:patch).with(url, '{"enabled":false}')
-                                      .and_return('message' => 'Confirmation message.')
+                                      .and_return([nil, { 'message' => 'Confirmation message.' }])
     expect(subject.disable).to eq 'Confirmation message.'
     expect(subject.enabled).to be false
   end
@@ -14,7 +14,7 @@ describe GandiV5::Domain::AutoRenew do
   describe '#enable' do
     it 'Success' do
       expect(GandiV5).to receive(:patch).with(url, '{"enabled":true,"duration":1,"org_id":"org-uuid"}')
-                                        .and_return('message' => 'Confirmation message.')
+                                        .and_return([nil, { 'message' => 'Confirmation message.' }])
       expect(subject.enable(org_id: 'org-uuid', duration: 1)).to eq 'Confirmation message.'
       expect(subject.enabled).to be true
     end
@@ -36,7 +36,7 @@ describe GandiV5::Domain::AutoRenew do
     describe 'Missing duration' do
       it 'Uses #duration if present' do
         expect(GandiV5).to receive(:patch).with(url, '{"enabled":true,"duration":5,"org_id":"org-uuid"}')
-                                          .and_return('message' => 'Confirmation message.')
+                                          .and_return([nil, { 'message' => 'Confirmation message.' }])
         expect(subject).to receive(:duration).and_return(5)
         expect(subject.enable(org_id: 'org-uuid')).to eq 'Confirmation message.'
         expect(subject.enabled).to be true
@@ -44,7 +44,7 @@ describe GandiV5::Domain::AutoRenew do
 
       it 'Uses 1 if #duration not present' do
         expect(GandiV5).to receive(:patch).with(url, '{"enabled":true,"duration":1,"org_id":"org-uuid"}')
-                                          .and_return('message' => 'Confirmation message.')
+                                          .and_return([nil, { 'message' => 'Confirmation message.' }])
         expect(subject.enable(org_id: 'org-uuid')).to eq 'Confirmation message.'
         expect(subject.enabled).to be true
       end
@@ -53,7 +53,7 @@ describe GandiV5::Domain::AutoRenew do
     describe 'Missing org_id' do
       it 'Uses #org_id if present' do
         expect(GandiV5).to receive(:patch).with(url, '{"enabled":true,"duration":1,"org_id":"org-uuid"}')
-                                          .and_return('message' => 'Confirmation message.')
+                                          .and_return([nil, { 'message' => 'Confirmation message.' }])
         expect(subject).to receive(:org_id).and_return('org-uuid')
         expect(subject.enable).to eq 'Confirmation message.'
         expect(subject.enabled).to be true

data/spec/units/gandi_v5/domain/availability/product/period_spec.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+describe GandiV5::Domain::Availability::Product::Period do
+end

data/spec/units/gandi_v5/domain/availability/product/price_spec.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+describe GandiV5::Domain::Availability::Product::Price do
+end

data/spec/units/gandi_v5/domain/availability/product_spec.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+describe GandiV5::Domain::Availability::Product do
+end

data/spec/units/gandi_v5/domain/availability/tax_spec.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+describe GandiV5::Domain::Availability::Tax do
+end

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+describe GandiV5::Domain::Availability do
+  describe '.fetch' do
+    let(:body_fixture) do
+      File.expand_path(File.join('spec', 'fixtures', 'bodies', 'GandiV5_Domain_Availability', 'fetch.yaml'))
+    end
+
+    describe 'With default values' do
+      subject { described_class.fetch 'example.com' }
+
+      before(:each) do
+        expect(GandiV5).to receive(:get).with('https://api.gandi.net/v5/domain/check', params: { name: 'example.com' })
+                                        .and_return([nil, YAML.load_file(body_fixture)])
+      end
+
+      its('currency') { should eq 'GBP' }
+      its('grid') { should eq 'A' }
+      its('products.size') { should eq 1 }
+      its('products.first.status') { should eq :unavailable }
+      its('products.first.name') { should eq 'example.com' }
+      its('products.first.process') { should eq :create }
+      its('products.first.taxes.size') { should eq 1 }
+      its('products.first.taxes.first.type') { should eq 'service' }
+      its('products.first.taxes.first.rate') { should eq 0 }
+      its('products.first.taxes.first.name') { should eq 'vat' }
+      its('taxes.size') { should eq 1 }
+      its('taxes.first.type') { should eq 'service' }
+      its('taxes.first.rate') { should eq 0 }
+      its('taxes.first.name') { should eq 'vat' }
+    end
+
+    describe 'Passes optional query params' do
+      %i[country currency duration_unit extension grid lang max_duration period processes sharing_uuid].each do |param|
+        it param.to_s do
+          url = 'https://api.gandi.net/v5/domain/check'
+          expect(GandiV5).to receive(:get).with(url, params: { name: 'example.com', param => 5 }).and_return([nil, {}])
+          described_class.fetch('example.com', param => 5)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+describe GandiV5::Domain::TLD do
+  it '.list' do
+    body_fixture = File.expand_path(File.join('spec', 'fixtures', 'bodies', 'GandiV5_Domain_TLD', 'list.yaml'))
+    expect(GandiV5).to receive(:get).with('https://api.gandi.net/v5/domain/tlds')
+                                    .and_return([nil, YAML.load_file(body_fixture)])
+    expect(described_class.list.map(&:name)).to match_array %w[a b c]
+  end
+
+  describe '.fetch' do
+    subject { described_class.fetch 'name' }
+
+    before(:each) do
+      body_fixture = File.expand_path(File.join('spec', 'fixtures', 'bodies', 'GandiV5_Domain_TLD', 'fetch.yaml'))
+      expect(GandiV5).to receive(:get).with('https://api.gandi.net/v5/domain/tlds/name')
+                                      .and_return([nil, YAML.load_file(body_fixture)])
+    end
+
+    its('category') { should eq :ccTLD }
+    its('name') { should eq 'eu' }
+    its('lock') { should be false }
+    its('change_owner') { should be true }
+    its('authinfo_for_transfer') { should be true }
+    its('full_tld') { should eq 'eu' }
+    its('corporate') { should be false }
+    its('ext_trade') { should be true }
+  end
+end