gandi_v5 0.3.0 → 0.8.0

data/spec/units/gandi_v5/simple_hosting_spec.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+describe GandiV5::SimpleHosting do
+  it '.instances' do
+    returns = double Array
+    expect(GandiV5::SimpleHosting::Instance).to receive(:list).and_return(returns)
+    expect(described_class.instances).to be returns
+  end
+end

data/spec/units/gandi_v5_spec.rb

@@ -47,41 +47,47 @@ describe GandiV5 do
   end
 
   describe 'Uses RestClient' do
+    let(:response) do
+      double RestClient::Response, body: 'Hello world!', headers: { content_type: 'text/plain' }
+    end
+
     %i[get delete].each do |method|
       describe ":#{method}" do
         it 'As JSON' do
           response_data = { 'hello' => 'world' }
           response = double RestClient::Response, body: response_data.to_json, headers: { content_type: 'application/json' }
           expect(described_class).to receive(:prepare_headers)
-          expect(RestClient).to receive(method).with('url', hash_including(accept: 'application/json')).and_return(response)
-          expect(described_class.send(method, 'url', accept: 'application/json')).to match_array [response, response_data]
+          expect(RestClient).to receive(method).with('url', hash_including(accept: 'application/json'))
+                                               .and_return(response)
+          expect(described_class.send(method, 'url', accept: 'application/json'))
+            .to match_array [response, response_data]
         end
 
         it 'As text' do
-          response_data = 'Hello world!'
-          response = double RestClient::Response, body: response_data, headers: { content_type: 'text/plain' }
           expect(described_class).to receive(:prepare_headers)
           expect(RestClient).to receive(method).with('url', hash_including(accept: 'text/plain')).and_return(response)
-          expect(described_class.send(method, 'url', accept: 'text/plain')).to match_array [response, response_data]
+          expect(described_class.send(method, 'url', accept: 'text/plain')).to match_array [response, 'Hello world!']
         end
 
         it 'Passes request headers' do
           expect(described_class).to receive(:prepare_headers)
           expect(described_class).to receive(:parse_response)
-          expect(RestClient).to receive(method).with(anything, header: 'value')
-          expect(described_class.send(method, 'url', header: 'value')).to match_array [nil, nil]
+          expect(RestClient).to receive(method).with(anything, header: 'value').and_return(response)
+          expect(described_class.send(method, 'url', header: 'value')).to match_array [response, nil]
         end
 
         it 'Adds authentication header' do
-          expect(RestClient).to receive(method).with(anything, hash_including(Authorization: 'Apikey abdce12345'))
+          expect(RestClient).to receive(method).with(anything, hash_including(authorization: 'Apikey abdce12345'))
+                                               .and_return(response)
           expect(described_class).to receive(:parse_response)
-          expect(described_class.send(method, 'https://api.gandi.net/v5/')).to match_array [nil, nil]
+          expect(described_class.send(method, 'https://api.gandi.net/v5/')).to match_array [response, nil]
         end
 
         it 'Default accept header' do
           expect(RestClient).to receive(method).with(any_args, hash_including(accept: 'application/json'))
+                                               .and_return(response)
           expect(described_class).to receive(:parse_response)
-          expect(described_class.send(method, 'https://api.gandi.net/v5/')).to match_array [nil, nil]
+          expect(described_class.send(method, 'https://api.gandi.net/v5/')).to match_array [response, nil]
         end
 
         it 'Converts a 406 (bad request) exception' do
@@ -92,6 +98,13 @@ describe GandiV5 do
       end
     end
 
+    it ':delete handles no content-type' do
+      response = double RestClient::Response, headers: {}
+      expect(described_class).to receive(:prepare_headers)
+      expect(RestClient).to receive(:delete).with('url', hash_including(accept: 'text/plain')).and_return(response)
+      expect(described_class.delete('url', accept: 'text/plain')).to match_array [response, nil]
+    end
+
     %i[patch post put].each do |method|
       describe ":#{method}" do
         let(:payload) { '{"say":"hello world"}' }
@@ -107,26 +120,25 @@ describe GandiV5 do
         end
 
         it 'As text' do
-          response_data = 'hello world'
-          response = double RestClient::Response, body: response_data, headers: { content_type: 'text/plain' }
           expect(described_class).to receive(:prepare_headers)
           expect(RestClient).to receive(method).with('url', payload, hash_including(accept: 'text/plain'))
                                                .and_return(response)
-          expect(described_class.send(method, 'url', payload, accept: 'text/plain')).to match_array [response, response_data]
+          array = [response, 'Hello world!']
+          expect(described_class.send(method, 'url', payload, accept: 'text/plain')).to match_array array
         end
 
         it 'Passes payload' do
           expect(described_class).to receive(:prepare_headers)
           expect(described_class).to receive(:parse_response)
-          expect(RestClient).to receive(method).with(anything, payload, any_args)
-          expect(described_class.send(method, 'url', payload)).to match_array [nil, nil]
+          expect(RestClient).to receive(method).with(anything, payload, any_args).and_return(response)
+          expect(described_class.send(method, 'url', payload)).to match_array [response, nil]
         end
 
         it 'Passes request headers' do
           expect(described_class).to receive(:prepare_headers)
           expect(described_class).to receive(:parse_response)
-          expect(RestClient).to receive(method).with(any_args, hash_including(header: 'value'))
-          expect(described_class.send(method, 'url', payload, header: 'value')).to match_array [nil, nil]
+          expect(RestClient).to receive(method).with(any_args, hash_including(header: 'value')).and_return(response)
+          expect(described_class.send(method, 'url', payload, header: 'value')).to match_array [response, nil]
         end
 
         it 'Adds content type header' do
@@ -136,15 +148,17 @@ describe GandiV5 do
         end
 
         it 'Adds authentication header' do
-          expect(RestClient).to receive(method).with(any_args, hash_including(Authorization: 'Apikey abdce12345'))
+          expect(RestClient).to receive(method).with(any_args, hash_including(authorization: 'Apikey abdce12345'))
+                                               .and_return(response)
           expect(described_class).to receive(:parse_response)
-          expect(described_class.send(method, 'https://api.gandi.net/v5/', payload)).to match_array [nil, nil]
+          expect(described_class.send(method, 'https://api.gandi.net/v5/', payload)).to match_array [response, nil]
         end
 
         it 'Default accept header' do
           expect(RestClient).to receive(method).with(any_args, hash_including(accept: 'application/json'))
+                                               .and_return(response)
           expect(described_class).to receive(:parse_response)
-          expect(described_class.send(method, 'https://api.gandi.net/v5/', payload)).to match_array [nil, nil]
+          expect(described_class.send(method, 'https://api.gandi.net/v5/', payload)).to match_array [response, nil]
         end
 
         it 'Converts a 406 (bad request) exception' do
@@ -156,20 +170,23 @@ describe GandiV5 do
     end
   end
 
-  describe 'Generates correct authorisation header' do
-    it 'When requesting from main V5 API' do
-      expect(described_class.send(:authorisation_header, 'https://api.gandi.net/v5/example'))
-        .to eq(Authorization: "Apikey #{api_key}")
+  describe 'Prepares headers' do
+    it 'Sets accept it not present' do
+      headers = {}
+      described_class.send(:prepare_headers, headers, GandiV5::BASE)
+      expect(headers[:accept]).to eq 'application/json'
     end
 
-    it 'When requesting from main LiveDNS V5 API' do
-      expect(described_class.send(:authorisation_header, 'https://dns.api.gandi.net/api/v5/example'))
-        .to eq('X-Api-Key': api_key)
+    it 'Leaves accept alone if present' do
+      headers = { accept: 'leave/alone' }
+      described_class.send(:prepare_headers, headers, GandiV5::BASE)
+      expect(headers[:accept]).to eq 'leave/alone'
     end
 
-    it 'Raises ArgumentError when requesting an unknown url' do
-      expect { described_class.send(:authorisation_header, 'https://unknown.example.com') }
-        .to raise_error ArgumentError, 'Don\'t know how to authorise for url: https://unknown.example.com'
+    it 'Sets authorization' do
+      headers = {}
+      described_class.send(:prepare_headers, headers, GandiV5::BASE)
+      expect(headers[:authorization]).to eq "Apikey #{api_key}"
     end
   end
 
@@ -226,4 +243,96 @@ describe GandiV5 do
         .to raise_error GandiV5::Error::GandiError, 'field: message'
     end
   end
+
+  describe '.paginated_get' do
+    let(:url) { "#{GandiV5::BASE}test/url" }
+    let(:do_nothing) { ->(_this_data) { nil } }
+
+    it 'Keeps fetching until getting a partial list' do
+      headers1 = { params: { 'page' => 1, 'per_page' => 2 } }
+      headers2 = { params: { 'page' => 2, 'per_page' => 2 } }
+      expect(GandiV5).to receive(:get).with(url, headers1)
+                                      .ordered
+                                      .and_return([nil, %i[a b]])
+      expect(GandiV5).to receive(:get).with(url, headers2)
+                                      .ordered
+                                      .and_return([nil, %i[c]])
+
+      described_class.paginated_get(url, (1..2), 2, &do_nothing)
+    end
+
+    it 'Keeps fetching until getting an empty list' do
+      headers1 = { params: { 'page' => 1, 'per_page' => 2 } }
+      headers2 = { params: { 'page' => 2, 'per_page' => 2 } }
+      expect(GandiV5).to receive(:get).with(url, headers1)
+                                      .ordered
+                                      .and_return([nil, %i[a b]])
+      expect(GandiV5).to receive(:get).with(url, headers2)
+                                      .ordered
+                                      .and_return([nil, []])
+
+      described_class.paginated_get(url, (1..2), 2, &do_nothing)
+    end
+
+    it 'Passes per_page option' do
+      headers = { params: { 'page' => 1, 'per_page' => 100 } }
+      expect(GandiV5).to receive(:get).with(url, headers)
+                                      .and_return([nil, []])
+      described_class.paginated_get(url, 1, 100, &do_nothing)
+    end
+
+    it 'Passes on other params' do
+      headers = { params: { 'page' => 1, 'per_page' => 100, 'custom' => 'value' } }
+      expect(GandiV5).to receive(:get).with(url, headers)
+                                      .and_return([nil, []])
+      described_class.paginated_get(url, 1, 100, params: { custom: 'value' }, &do_nothing)
+    end
+
+    it 'Passes on other headers' do
+      headers = { params: { 'page' => 1, 'per_page' => 100 }, custom: :value }
+      expect(GandiV5).to receive(:get).with(url, headers)
+                                      .and_return([nil, []])
+      described_class.paginated_get(url, 1, 100, custom: :value, &do_nothing)
+    end
+
+    describe 'Honors passed pages' do
+      it 'Has an each method' do
+        headers1 = { params: { 'page' => 1, 'per_page' => 2 } }
+        headers2 = { params: { 'page' => 2, 'per_page' => 2 } }
+        expect(GandiV5).to receive(:get).with(url, headers1)
+                                        .ordered
+                                        .and_return([nil, %i[a b]])
+        expect(GandiV5).to receive(:get).with(url, headers2)
+                                        .ordered
+                                        .and_return([nil, %i[c d]])
+
+        described_class.paginated_get(url, (1..2), 2, &do_nothing)
+      end
+
+      it 'Positive integer' do
+        headers = { params: { 'page' => 3, 'per_page' => 2 } }
+        expect(GandiV5).to receive(:get).with(url, headers)
+                                        .ordered
+                                        .and_return([nil, %i[a b c]])
+        described_class.paginated_get(url, 3, 2, &do_nothing)
+      end
+
+      it 'Nonpositive integer' do
+        expect { described_class.paginated_get(url, -3, 2, &do_nothing) }.to \
+          raise_error ArgumentError, 'page must be positive'
+      end
+    end
+
+    it 'Relies on caller to build their list' do
+      this_data = [:a]
+      expect(GandiV5).to receive(:get).and_return([nil, this_data])
+      expect { |b| described_class.paginated_get(url, 1, 100, &b) }.to yield_with_args(this_data)
+    end
+
+    it 'Requires a block' do
+      allow(GandiV5).to receive(:get).and_return([nil, [:a]])
+
+      expect { described_class.paginated_get(url) }.to raise_error LocalJumpError
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gandi_v5
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Robert Gauld
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-03 00:00:00.000000000 Z
+date: 2020-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -202,28 +202,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.73'
+        version: '0.87'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.73'
+        version: '0.87'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -308,6 +308,7 @@ files:
 - lib/gandi_v5/data.rb
 - lib/gandi_v5/data/converter.rb
 - lib/gandi_v5/data/converter/array_of.rb
+- lib/gandi_v5/data/converter/integer.rb
 - lib/gandi_v5/data/converter/symbol.rb
 - lib/gandi_v5/data/converter/time.rb
 - lib/gandi_v5/domain.rb
@@ -323,7 +324,6 @@ files:
 - lib/gandi_v5/domain/live_dns.rb
 - lib/gandi_v5/domain/renewal_information.rb
 - lib/gandi_v5/domain/restore_information.rb
-- lib/gandi_v5/domain/sharing_space.rb
 - lib/gandi_v5/domain/tld.rb
 - lib/gandi_v5/email.rb
 - lib/gandi_v5/email/forward.rb
@@ -335,17 +335,23 @@ files:
 - lib/gandi_v5/error/gandi_error.rb
 - lib/gandi_v5/live_dns.rb
 - lib/gandi_v5/live_dns/domain.rb
-- lib/gandi_v5/live_dns/has_zone_records.rb
-- lib/gandi_v5/live_dns/record_set.rb
-- lib/gandi_v5/live_dns/zone.rb
-- lib/gandi_v5/live_dns/zone/snapshot.rb
+- lib/gandi_v5/live_dns/domain/dnssec_key.rb
+- lib/gandi_v5/live_dns/domain/record.rb
+- lib/gandi_v5/live_dns/domain/snapshot.rb
+- lib/gandi_v5/live_dns/domain/tsig_key.rb
 - lib/gandi_v5/organization.rb
+- lib/gandi_v5/organization/customer.rb
+- lib/gandi_v5/sharing_space.rb
+- lib/gandi_v5/simple_hosting.rb
+- lib/gandi_v5/simple_hosting/instance.rb
+- lib/gandi_v5/simple_hosting/instance/application.rb
+- lib/gandi_v5/simple_hosting/instance/database.rb
+- lib/gandi_v5/simple_hosting/instance/language.rb
+- lib/gandi_v5/simple_hosting/instance/upgrade.rb
+- lib/gandi_v5/simple_hosting/instance/virtual_host.rb
+- lib/gandi_v5/simple_hosting/instance/virtual_host/linked_dns_zone.rb
 - lib/gandi_v5/version.rb
 - spec/.rubocop.yml
-- spec/features/domain_spec.rb
-- spec/features/livedns_domain_spec.rb
-- spec/features/livedns_zone_spec.rb
-- spec/features/mailbox_spec.rb
 - spec/fixtures/bodies/GandiV5_Billing/info.yml
 - spec/fixtures/bodies/GandiV5_Domain/fetch.yml
 - spec/fixtures/bodies/GandiV5_Domain/fetch_contacts.yml
@@ -365,25 +371,28 @@ files:
 - spec/fixtures/bodies/GandiV5_Email_Slot/list.yml
 - spec/fixtures/bodies/GandiV5_LiveDNS_Domain/fetch.yml
 - spec/fixtures/bodies/GandiV5_LiveDNS_Domain/list.yml
-- spec/fixtures/bodies/GandiV5_LiveDNS_Zone/fetch.yml
-- spec/fixtures/bodies/GandiV5_LiveDNS_Zone/list.yml
-- spec/fixtures/bodies/GandiV5_LiveDNS_Zone_Snapshot/fetch.yml
-- spec/fixtures/bodies/GandiV5_LiveDNS_Zone_Snapshot/list.yml
+- spec/fixtures/bodies/GandiV5_LiveDNS_Domain/list_tsig.yml
+- spec/fixtures/bodies/GandiV5_LiveDNS_Domain/nameservers.yml
+- spec/fixtures/bodies/GandiV5_LiveDNS_Domain_DnssecKey/fetch.yml
+- spec/fixtures/bodies/GandiV5_LiveDNS_Domain_DnssecKey/list.yml
+- spec/fixtures/bodies/GandiV5_LiveDNS_Domain_Snapshot/fetch.yml
+- spec/fixtures/bodies/GandiV5_LiveDNS_Domain_Snapshot/list.yml
+- spec/fixtures/bodies/GandiV5_LiveDNS_Domain_TsigKey/fetch.yml
+- spec/fixtures/bodies/GandiV5_LiveDNS_Domain_TsigKey/list.yml
 - spec/fixtures/bodies/GandiV5_Organization/fetch.yml
 - spec/fixtures/bodies/GandiV5_Organization/list.yml
-- spec/fixtures/vcr/Domain_features/List_domains.yml
-- spec/fixtures/vcr/Domain_features/Renew_domain.yml
-- spec/fixtures/vcr/LiveDNS_Domain_features/List_domains.yml
-- spec/fixtures/vcr/LiveDNS_Zone_features/List_zones.yml
-- spec/fixtures/vcr/LiveDNS_Zone_features/Make_and_save_snapshot.yml
-- spec/fixtures/vcr/LiveDNS_Zone_features/Save_zone_to_file.yml
-- spec/fixtures/vcr/Mailbox_features/List_mailboxes.yml
+- spec/fixtures/bodies/GandiV5_Organization_Customer/list.yml
+- spec/fixtures/bodies/GandiV5_SimpleHosting_Instance/fetch.yml
+- spec/fixtures/bodies/GandiV5_SimpleHosting_Instance/list.yml
+- spec/fixtures/bodies/GandiV5_SimpleHosting_Instance_VirtualHost/fetch.yml
+- spec/fixtures/bodies/GandiV5_SimpleHosting_Instance_VirtualHost/list.yml
 - spec/spec_helper.rb
 - spec/test.env
 - spec/units/gandi_v5/billing/info/prepaid_spec.rb
 - spec/units/gandi_v5/billing/info_spec.rb
 - spec/units/gandi_v5/billing_spec.rb
 - spec/units/gandi_v5/data/converter/array_of_spec.rb
+- spec/units/gandi_v5/data/converter/integer_spec.rb
 - spec/units/gandi_v5/data/converter/symbol_spec.rb
 - spec/units/gandi_v5/data/converter/time_spec.rb
 - spec/units/gandi_v5/data/converter_spec.rb
@@ -400,7 +409,6 @@ files:
 - spec/units/gandi_v5/domain/live_dns_spec.rb
 - spec/units/gandi_v5/domain/renewal_information_spec.rb
 - spec/units/gandi_v5/domain/restore_information_spec.rb
-- spec/units/gandi_v5/domain/sharing_space_spec.rb
 - spec/units/gandi_v5/domain/tld_spec.rb
 - spec/units/gandi_v5/domain_spec.rb
 - spec/units/gandi_v5/email/forward_spec.rb
@@ -410,12 +418,23 @@ files:
 - spec/units/gandi_v5/email/slot_spec.rb
 - spec/units/gandi_v5/error/gandi_error_spec.rb
 - spec/units/gandi_v5/error_spec.rb
+- spec/units/gandi_v5/live_dns/domain/dnssec_key_spec.rb
+- spec/units/gandi_v5/live_dns/domain/record_spec.rb
+- spec/units/gandi_v5/live_dns/domain/snapshot_spec.rb
+- spec/units/gandi_v5/live_dns/domain/tsig_key_spec.rb
 - spec/units/gandi_v5/live_dns/domain_spec.rb
-- spec/units/gandi_v5/live_dns/record_set_spec.rb
-- spec/units/gandi_v5/live_dns/zone/snapshot_spec.rb
-- spec/units/gandi_v5/live_dns/zone_spec.rb
 - spec/units/gandi_v5/live_dns_spec.rb
+- spec/units/gandi_v5/organization/customer_spec.rb
 - spec/units/gandi_v5/organization_spec.rb
+- spec/units/gandi_v5/sharing_space_spec.rb
+- spec/units/gandi_v5/simple_hosting/instance/application_spec.rb
+- spec/units/gandi_v5/simple_hosting/instance/database_spec.rb
+- spec/units/gandi_v5/simple_hosting/instance/language_spec.rb
+- spec/units/gandi_v5/simple_hosting/instance/upgrade_spec.rb
+- spec/units/gandi_v5/simple_hosting/instance/virtual_host/linked_dns_zone_spec.rb
+- spec/units/gandi_v5/simple_hosting/instance/virtual_host_spec.rb
+- spec/units/gandi_v5/simple_hosting/instance_spec.rb
+- spec/units/gandi_v5/simple_hosting_spec.rb
 - spec/units/gandi_v5_spec.rb
 homepage: https://github.com/robertgauld/gandi_v5
 licenses:
@@ -436,7 +455,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 2.6.14
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Make use of Gandi's V5 API.

data/lib/gandi_v5/domain/sharing_space.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-class GandiV5
-  class Domain
-    # Sharing space which contains a domain.
-    # @!attribute [r] uuid
-    #   @return [String]
-    # @!attribute [r] name
-    #   @return [String]
-    # @!attribute [r] reseller
-    #   @return [nil, Boolean]
-    class SharingSpace
-      include GandiV5::Data
-
-      members :name, :reseller
-      member :uuid, gandi_key: 'id'
-
-      alias sharing_space_uuid uuid
-    end
-  end
-end