gandi_v5 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef84fa55ae8d79f2d6fa178db059e4130ff8ae9ba2eb5f5886a57b9f965d8b48
-  data.tar.gz: b5bc9448754bf08ab28c1e3235d01929a6edf3b82f00dbdf935b58d863035de1
+  metadata.gz: 02621cbb8405cbec872ddcf3d549770535377dc1e6b158e9488f6bddcf65a771
+  data.tar.gz: 73901bcd9e8cb66d5c56c1802915dc849bd66d17d8c013a2895f472ef93f9543
 SHA512:
-  metadata.gz: 90083b929123d60702880dc1fbaa7500c972f38ce1134dbb031d1e5585cad63fbe7265ee38075e5329e2e125f4b441ef0bc02da79137444df4ea27c999c1fa26
-  data.tar.gz: 536d1dae15301728cfda7df6c556913e75025d90f801c5748da598716b887bd0e8c4d25c2f0226ea25d9bab02fa9a3f185d64a5cf9a31694cb21a1ea5f8ac264
+  metadata.gz: e3caf30dc92addf609acb1e5e7f69841a5f896579f55c839813790200170222ede6df0e2c6448af2b3fa5848de5acb1a1cd50dbd1a19d538afc5c24e2d84e217
+  data.tar.gz: e1efdd6ed8ab463d7379b8040aeff61c62be58485464ed09e00bba3d28a4af9e27ac74f9333a74500f98e094b48832ed00439c01909fd9a1e5fb1a9677a7da76

data/.gitignore

@@ -5,6 +5,7 @@ Gemfile.lock
 # And because this is Ruby, ignore the following
 #  (source: https://github.com/github/gitignore/blob/master/Ruby.gitignore):
 
+.ruby-version
 notes.txt
 todo.txt
 *.gem

data/.rubocop.yml

@@ -8,13 +8,23 @@ Metrics/AbcSize:
   Max: 20
 Metrics/ClassLength:
   Max: 250
-Metrics/LineLength:
-  Max: 100
+Metrics/CyclomaticComplexity:
+  Max: 8
 Metrics/MethodLength:
   Max: 15
 Metrics/ModuleLength:
   Max: 200
+Metrics/ParameterLists:
+  Max: 6
 Style/DocumentationMethod:
   Enabled: true
+Style/HashEachMethods:
+  Enabled: true
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true
 Style/SignalException:
   Enabled: false
+Layout/LineLength:
+  Max: 100

data/.travis.yml

@@ -5,6 +5,10 @@ rvm:
   - 2.6.2
   - 2.6.3
   - 2.6.4
+  - 2.6.5
+  - 2.6.6
+  - 2.7.0
+  - 2.7.1
 gemfile:
   - Gemfile
 branches:

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Gandi V5 API Gem Changelog
 
+## Version 0.4.0
+
+* Fix exception when delete returns no content-type
+* Add support for ruby 2.7.0
+* Add up/downgrading mailbox offer
+* Add dry run option to creating a mailbox
+* Add sharing_id & dry run option for renewing domain
+* Add listing customers under a reseller organization (GandiV5::Organization::Customer.list and GandiV5::Organization#customers)
+* Add creating customer under a reseller organization (GandiV5::Organization::Customer.create and GandiV5::Organization#create_customer)
+
 ## Version 0.3.0
 
 * Additions to GandiV5::Domain

data/README.md

@@ -8,7 +8,8 @@
 This gem supports the following versions of ruby, it may work on other versions but is not tested against them so don't rely on it.
 
 * ruby:
-  * 2.6.0 - 2.6.4
+  * 2.6.0 - 2.6.6
+  * 2.7.0 - 2.7.1
 * jruby, once it's reached parity with ruby 2.6.x
 * truffleruby, once it's reached parity with ruby 2.6.x
 * rubinius, once it's reached parity with ruby 2.6.x
@@ -76,6 +77,7 @@ We follow the [Semantic Versioning](http://semver.org/) concept.
 
 | Gem Version     | Gandi API Release Date |
 | --------------- | ---------------------- |
+| 0.4.0           | 2019-10-01             |
 | 0.3.0           | 2019-08-22             |
 | 0.2.0           | 2019-05-16             |
 | 0.1.0           | 2019-05-16             |

data/lib/gandi_v5/data.rb

@@ -179,9 +179,8 @@ class GandiV5
         define_method "#{name}=" do |value|
           instance_variable_set("@#{name}", value)
         end
-        # rubocop:disable Style/AccessModifierDeclarations
+
         private "#{name}="
-        # rubocop:enable Style/AccessModifierDeclarations
       end
 
       # @api private

data/lib/gandi_v5/domain.rb

@@ -211,10 +211,13 @@ class GandiV5
     # @param duration [Integer, #to_s] how long to renew for (in years).
     # @return [String] confirmation message from Gandi.
     # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
-    def renew_for(duration = 1)
+    def renew_for(duration = 1, sharing_id: nil, dry_run: false)
       body = { duration: duration }.to_json
-      _response, data = GandiV5.post url('renew'), body
-      data['message']
+      url_ = url('renew')
+      url_ = sharing_id ? "#{url_}?sharing_id=#{sharing_id}" : url_
+
+      _response, data = GandiV5.post(url_, body, 'Dry-Run': dry_run ? 1 : 0)
+      dry_run ? data : data['message']
     end
 
     # Restoration information for the domain.

data/lib/gandi_v5/email/mailbox.rb

@@ -105,6 +105,39 @@ class GandiV5
         data['message']
       end
 
+      # Upgrade a standard mailbox to premium.
+      # If the current slot is a free one, a new premium slot is created and
+      # used for the mailbox. Otherwise, the slot is upgraded to premium.
+      # @see https://api.gandi.net/docs/email#patch-v5-email-mailboxes-domain-mailbox_id-type
+      # @param sharing_id [String, #to_s, nil] (optional)
+      #   the organisation ID to bill for the mailbox.
+      # @param dry_run [Boolean] whether the details should be checked instead
+      #                          of actually upgrading the mailbox.
+      # @return [true] if the mailbox was upgraded
+      # @return [false] if the mailbox was not upgraded (it's already premium)
+      # @return [Hash] if doing a dry run, you get what Gandi returns
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error
+      def upgrade(sharing_id: nil, dry_run: false)
+        patch_type :premium, sharing_id, dry_run
+      end
+
+      # Downgrade a premium mailbox to standard.
+      # If a free slot is available, the premium slot is destroyed
+      # (and refunded) and the free one is used for the mailbox.
+      # Otherwise, the slot is downgraded to standard.
+      # @see https://api.gandi.net/docs/email#patch-v5-email-mailboxes-domain-mailbox_id-type
+      # @param sharing_id [String, #to_s, nil] (optional)
+      #   the organisation ID to bill for the mailbox.
+      # @param dry_run [Boolean] whether the details should be checked instead
+      #                          of actually downgrading the mailbox.
+      # @return [true] if the mailbox was downgraded
+      # @return [false] if the mailbox was not downgraded (it's already standard)
+      # @return [Hash] if doing a dry run, you get what Gandi returns
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error
+      def downgrade(sharing_id: nil, dry_run: false)
+        patch_type :standard, sharing_id, dry_run
+      end
+
       # Create a new mailbox.
       # Note that before you can create a mailbox, you must have a slot available.
       # @see https://api.gandi.net/docs/email#post-v5-email-mailboxes-domain
@@ -113,10 +146,13 @@ class GandiV5
       # @param password [String, #to_s] the password to use.
       # @param aliases [Array<String, #to_s>] any alternative email address to be used.
       # @param type [:standard, :premium] the type of mailbox slot to use.
+      # @param dry_run [Boolean] whether the details should be checked instead
+      #                          of actually creating the mailbox.
       # @return [GandiV5::Email::Mailbox] The created mailbox.
       # @raise [GandiV5::Error] if no slots are available.
       # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
-      def self.create(fqdn, login, password, aliases: [], type: :standard)
+      # rubocop:disable Metrics/AbcSize
+      def self.create(fqdn, login, password, aliases: [], type: :standard, dry_run: false)
         fail ArgumentError, "#{type.inspect} is not a valid type" unless TYPES.include?(type)
         if GandiV5::Email::Slot.list.none? { |slot| slot.mailbox_type == type && slot.inactive? }
           fail GandiV5::Error, "no available #{type} slots"
@@ -131,9 +167,11 @@ class GandiV5
           aliases: aliases.push
         }.to_json
 
-        response, _data = GandiV5.post url(fqdn), body
-        fetch fqdn, response.headers[:location].split('/').last
+        response, data = GandiV5.post(url(fqdn), body, 'Dry-Run': dry_run ? 1 : 0)
+
+        dry_run ? data : fetch(fqdn, response.headers[:location].split('/').last)
       end
+      # rubocop:enable Metrics/AbcSize
 
       # Get information for a mailbox.
       # @see https://api.gandi.net/docs/email#get-v5-email-mailboxes-domain-mailbox_id
@@ -240,6 +278,20 @@ class GandiV5
       def crypt_password(password)
         self.class.send :crypt_password, password
       end
+
+      def patch_type(new_type, sharing_id, dry_run)
+        fail ArgumentError unless TYPES.include?(new_type)
+        return false if type == new_type
+
+        url_ = "#{url}/type"
+        url_ = sharing_id ? "#{url_}?sharing_id=#{sharing_id}" : url_
+        body = { mailbox_type: new_type }
+
+        _response, data = GandiV5.patch(url_, body.to_json, 'Dry-Run': dry_run ? 1 : 0)
+
+        @type = new_type unless dry_run
+        dry_run ? data : true
+      end
     end
   end
 end

data/lib/gandi_v5/organization/customer.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+class GandiV5
+  class Organization
+    # A customer of a reseller organization
+    # @!attribute [r] id
+    #   @return [String] The main identifier of the customer.
+    #                    Also known as sharing_id in many routes.
+    # @!attribute [r] email
+    #   @return [String] Email of the customer.
+    # @!attribute [r] first_name
+    #   @return [String] First name of the customer.
+    # @!attribute [r] last_name
+    #   @return [String] Last name of the customer.
+    # @!attribute [r] name
+    #   @return [String] Name of the customer.
+    # @!attribute [r] type
+    #   @return [:individual, :company, :association, :publicbody]
+    # @!attribute [r] org_name
+    #   @return [nil, String] Organization legal name of the customer..
+    class Customer
+      include GandiV5::Data
+
+      members :email, :name
+      member :uuid, gandi_key: 'id'
+      member :first_name, gandi_key: 'firstname'
+      member :last_name, gandi_key: 'lastname'
+      member :org_name, gandi_key: 'orgname'
+      member :type, converter: GandiV5::Data::Converter::Symbol
+
+      # Create a new customer for this organization.
+      # @see https://api.gandi.net/docs/organization/#post-v5-organization-organizations-id-customers
+      # @param org_uuid [String] UUID of the organization to create the customer for.
+      # @param firstname [String, #to_s] (required) Customer's first name.
+      # @param lastname [String, #to_s] (required) Customer's last name.
+      # @param type [String, #to_s] (required) Type of customer
+      #   ("individual", "company", "association" or "publicbody").
+      # @param streetaddr [String, #to_s] (required) Customer's street address.
+      # @param city [String, #to_s] (required) Customer's city.
+      # @param country [String, #to_s] (required) Customer's country.
+      # @param email [String, #to_s] (required) Customer's email address.
+      # @param phone [String, #to_s] (required) Customer's phone number.
+      # @param fax [String, #to_s] (optional) Customer's fax number.
+      # @param streetaddr2 [String, #to_s] (optional) Customer's street address (2nd line).
+      # @param state [String, #to_s] (optional) Customer's state/province/region.
+      # @param zip [String, #to_s] (optional) Customer's postal/zip code.
+      # @param reference [String, #to_s] (optional)
+      #   Optional text to display on the invoice, such as your own customer reference info.
+      # @param orgname [String, #to_s] (optional) Customer Organization's legal name.
+      # @return [nil]
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error
+      def self.create(org_uuid, **params)
+        %i[city country email firstname lastname phone streetaddr type].each do |attr|
+          fail ArgumentError, "missing keyword: #{attr}" unless params.key?(attr)
+        end
+        unless %w[individual company association publicbody].include?(params[:type].to_s)
+          fail ArgumentError, "invalid type: #{params[:type].inspect}"
+        end
+
+        _response, _data = GandiV5.post(url(org_uuid), params.to_json)
+        nil
+      end
+
+      # List organisation's customers.
+      # @see https://api.gandi.net/docs/organization/#get-v5-organization-organizations-id-customers
+      # @param org_uuid [String] UUID of the organization to fetch customers for.
+      # @param name [String, #to_s] (optional)
+      #   filters the list by name, with optional patterns.
+      #   e.g. "alice", "ali*", "*ice"
+      # @param permission [String, #to_s] (optional)
+      #   filters the list by the permission the authenticated user has on
+      #   that organization and products in it.
+      # @param sort_by [String, #to_s] (optional default "name") how to sort the list.
+      # @return [Array<GandiV5::Organization>]
+      # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+      def self.list(org_uuid, **params)
+        params['~name'] = params.delete(:name) if params.key?(:name)
+        _resp, data = GandiV5.get url(org_uuid), params: params
+        data.map { |organisation| from_gandi organisation }
+      end
+
+      private
+
+      def self.url(org_uuid)
+        "#{BASE}organization/organizations/#{org_uuid}/customers"
+      end
+      private_class_method :url
+    end
+  end
+end

data/lib/gandi_v5/organization.rb

@@ -50,6 +50,16 @@ class GandiV5
 
     alias organization_uuid uuid
 
+    # @see GandiV5::Organization::Customer.list
+    def customers(org_uuid, **params)
+      GandiV5::Organization::Customer.list(org_uuid, **params)
+    end
+
+    # @see GandiV5::Organization::Customer.create
+    def create_customer(org_uuid, **params)
+      GandiV5::Organization::Customer.create(org_uuid, **params)
+    end
+
     # Get information about the current authenticated user.
     # @see https://api.gandi.net/docs/organization#get-v5-organization-user-info
     # @return [GandiV5::Organization]

data/lib/gandi_v5/version.rb

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

data/lib/gandi_v5.rb

@@ -93,7 +93,10 @@ class GandiV5
     def delete(url, **headers)
       prepare_headers headers, url
       response = RestClient.delete url, **headers
-      [response, parse_response(response)]
+      [
+        response,
+        response.headers.key?(:content_type) ? parse_response(response) : nil
+      ]
     rescue RestClient::BadRequest => e
       handle_bad_request(e)
     end

data/spec/.rubocop.yml

@@ -1,4 +1,11 @@
 Metrics/BlockLength:
   Max: 750
-Metrics/LineLength:
+Layout/LineLength:
   Max: 125
+Style/HashEachMethods:
+  Enabled: true
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true
+

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

@@ -0,0 +1,8 @@
+---
+- id: customer-uuid
+  name: FirstLast
+  firstname: First
+  lastname: Last
+  email: first.last@example.com
+  type: individual
+  orgname: Org

data/spec/units/gandi_v5/domain_spec.rb

@@ -373,10 +373,46 @@ describe GandiV5::Domain do
       its('durations') { should match_array [1, 2] }
     end
 
-    it '#renew_for' do
-      expect(GandiV5).to receive(:post).with('https://api.gandi.net/v5/domain/domains/example.com/renew', '{"duration":2}')
-                                       .and_return([nil, { 'message' => 'Confirmation message.' }])
-      expect(subject.renew_for(2)).to eq 'Confirmation message.'
+    describe '#renew_for' do
+      it 'Defaults to 1 year and current user' do
+        expect(GandiV5).to receive(:post).with(
+          'https://api.gandi.net/v5/domain/domains/example.com/renew',
+          '{"duration":1}',
+          'Dry-Run': 0
+        )
+                                         .and_return([nil, { 'message' => 'Confirmation message.' }])
+        expect(subject.renew_for).to eq 'Confirmation message.'
+      end
+
+      it 'With provided duration' do
+        expect(GandiV5).to receive(:post).with(
+          'https://api.gandi.net/v5/domain/domains/example.com/renew',
+          '{"duration":2}',
+          'Dry-Run': 0
+        )
+                                         .and_return([nil, { 'message' => 'Confirmation message.' }])
+        expect(subject.renew_for(2)).to eq 'Confirmation message.'
+      end
+
+      it 'With provided sharing_id' do
+        expect(GandiV5).to receive(:post).with(
+          'https://api.gandi.net/v5/domain/domains/example.com/renew?sharing_id=def',
+          '{"duration":1}',
+          'Dry-Run': 0
+        )
+                                         .and_return([nil, { 'message' => 'Confirmation message.' }])
+        expect(subject.renew_for(sharing_id: 'def')).to eq 'Confirmation message.'
+      end
+
+      it 'Does a dry run' do
+        expect(GandiV5).to receive(:post).with(
+          'https://api.gandi.net/v5/domain/domains/example.com/renew',
+          '{"duration":1}',
+          'Dry-Run': 1
+        )
+                                         .and_return([nil, { 'status' => 'success' }])
+        expect(subject.renew_for(dry_run: true)).to eq('status' => 'success')
+      end
     end
 
     describe '#renewal_price' do

data/spec/units/gandi_v5/email/mailbox_spec.rb

@@ -87,6 +87,108 @@ describe GandiV5::Email::Mailbox do
     end
   end
 
+  describe '#upgrade' do
+    let(:url) { 'https://api.gandi.net/v5/email/mailboxes/example.com/mailbox-uuid/type' }
+
+    context 'No sharing_id' do
+      it 'Is upgraded' do
+        expect(GandiV5).to receive(:patch).with(url, '{"mailbox_type":"premium"}', 'Dry-Run': 0)
+                                          .and_return([nil, { 'message' => 'Confirmation message.' }])
+        expect(subject.upgrade).to be true
+        expect(subject.type).to be :premium
+      end
+
+      it 'Is already premium' do
+        subject.instance_exec { @type = :premium }
+        expect(GandiV5).to_not receive(:patch)
+        expect(subject.upgrade).to be false
+      end
+    end
+
+    context 'With sharing_id' do
+      let(:url) { 'https://api.gandi.net/v5/email/mailboxes/example.com/mailbox-uuid/type?sharing_id=abc' }
+
+      it 'Is upgraded' do
+        expect(GandiV5).to receive(:patch).with(url, '{"mailbox_type":"premium"}', 'Dry-Run': 0)
+                                          .and_return([nil, { 'message' => 'Confirmation message.' }])
+        expect(subject.upgrade(sharing_id: 'abc')).to be true
+        expect(subject.type).to be :premium
+      end
+
+      it 'Is already premium' do
+        subject.instance_exec { @type = :premium }
+        expect(GandiV5).to_not receive(:patch)
+        expect(subject.upgrade(sharing_id: 'abc')).to be false
+      end
+    end
+
+    context 'Dry run' do
+      it 'Is upgraded' do
+        expect(GandiV5).to receive(:patch).with(url, '{"mailbox_type":"premium"}', 'Dry-Run': 1)
+                                          .and_return([nil, { 'status' => 'success' }])
+        expect(subject.upgrade(dry_run: true)).to eq('status' => 'success')
+        expect(subject.type).to be :standard
+      end
+
+      it 'Is already premium' do
+        subject.instance_exec { @type = :premium }
+        expect(GandiV5).to_not receive(:patch)
+        expect(subject.upgrade(dry_run: true)).to be false
+      end
+    end
+  end
+
+  describe '#downgrade' do
+    let(:url) { 'https://api.gandi.net/v5/email/mailboxes/example.com/mailbox-uuid/type' }
+
+    context 'No sharing_id' do
+      it 'Is downgraded' do
+        subject.instance_exec { @type = :premium }
+        expect(GandiV5).to receive(:patch).with(url, '{"mailbox_type":"standard"}', 'Dry-Run': 0)
+                                          .and_return([nil, { 'message' => 'Confirmation message.' }])
+        expect(subject.downgrade).to be true
+        expect(subject.type).to be :standard
+      end
+
+      it 'Is already premium' do
+        expect(GandiV5).to_not receive(:patch)
+        expect(subject.downgrade).to be false
+      end
+    end
+
+    context 'With sharing_id' do
+      let(:url) { 'https://api.gandi.net/v5/email/mailboxes/example.com/mailbox-uuid/type?sharing_id=abc' }
+
+      it 'Is downgraded' do
+        subject.instance_exec { @type = :premium }
+        expect(GandiV5).to receive(:patch).with(url, '{"mailbox_type":"standard"}', 'Dry-Run': 0)
+                                          .and_return([nil, { 'message' => 'Confirmation message.' }])
+        expect(subject.downgrade(sharing_id: 'abc')).to be true
+        expect(subject.type).to be :standard
+      end
+
+      it 'Is already premium' do
+        expect(GandiV5).to_not receive(:patch)
+        expect(subject.downgrade(sharing_id: 'abc')).to be false
+      end
+    end
+
+    context 'Dry run' do
+      it 'Is downgraded' do
+        subject.instance_exec { @type = :premium }
+        expect(GandiV5).to receive(:patch).with(url, '{"mailbox_type":"standard"}', 'Dry-Run': 1)
+                                          .and_return([nil, { 'status' => 'success' }])
+        expect(subject.downgrade(dry_run: true)).to eq('status' => 'success')
+        expect(subject.type).to be :premium
+      end
+
+      it 'Is already premium' do
+        expect(GandiV5).to_not receive(:patch)
+        expect(subject.downgrade(dry_run: true)).to be false
+      end
+    end
+  end
+
   it '#delete' do
     url = 'https://api.gandi.net/v5/email/mailboxes/example.com/mailbox-uuid'
     expect(GandiV5).to receive(:delete).with(url)
@@ -204,7 +306,7 @@ describe GandiV5::Email::Mailbox do
 
     it 'No aliases and :standard type' do
       body = '{"mailbox_type":"standard","login":"login","password":"crypted_password","aliases":[]}'
-      expect(GandiV5).to receive(:post).with(url, body)
+      expect(GandiV5).to receive(:post).with(url, body, 'Dry-Run': 0)
                                        .and_return([created_response, { 'message' => 'Confirmation message.' }])
       expect(described_class).to receive(:crypt_password).with(good_password).and_return('crypted_password')
       expect(described_class).to receive(:fetch).with('example.com', 'created-mailbox-uuid').and_return(created_mailbox)
@@ -214,7 +316,7 @@ describe GandiV5::Email::Mailbox do
 
     it 'With aliases' do
       body = '{"mailbox_type":"standard","login":"login","password":"crypted_password","aliases":["alias-1"]}'
-      expect(GandiV5).to receive(:post).with(url, body)
+      expect(GandiV5).to receive(:post).with(url, body, 'Dry-Run': 0)
                                        .and_return([created_response, { 'message' => 'Confirmation message.' }])
       expect(described_class).to receive(:crypt_password).with(good_password).and_return('crypted_password')
       expect(described_class).to receive(:fetch).with('example.com', 'created-mailbox-uuid').and_return(created_mailbox)
@@ -224,7 +326,7 @@ describe GandiV5::Email::Mailbox do
 
     it 'With different type' do
       body = '{"mailbox_type":"premium","login":"login","password":"crypted_password","aliases":[]}'
-      expect(GandiV5).to receive(:post).with(url, body)
+      expect(GandiV5).to receive(:post).with(url, body, 'Dry-Run': 0)
                                        .and_return([created_response, { 'message' => 'Confirmation message.' }])
       expect(described_class).to receive(:crypt_password).with(good_password).and_return('crypted_password')
       expect(described_class).to receive(:fetch).with('example.com', 'created-mailbox-uuid').and_return(created_mailbox)
@@ -254,6 +356,16 @@ describe GandiV5::Email::Mailbox do
         'no available standard slots'
       )
     end
+
+    it 'Doing a dry run' do
+      body = '{"mailbox_type":"standard","login":"login","password":"crypted_password","aliases":[]}'
+      expect(GandiV5).to receive(:post).with(url, body, 'Dry-Run': 1)
+                                       .and_return([nil, { 'status' => 'success' }])
+      expect(described_class).to receive(:crypt_password).with(good_password).and_return('crypted_password')
+      expect(described_class).to_not receive(:fetch)
+
+      expect(described_class.create('example.com', 'login', good_password, dry_run: true)).to eq('status' => 'success')
+    end
   end
 
   describe '.fetch' do

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

@@ -64,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

data/spec/units/gandi_v5_spec.rb

@@ -47,6 +47,10 @@ 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
@@ -58,30 +62,30 @@ 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', 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'))
+                                               .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 +96,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 +118,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
@@ -137,14 +147,16 @@ describe GandiV5 do
 
         it 'Adds authentication header' do
           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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gandi_v5
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Robert Gauld
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-03 00:00:00.000000000 Z
+date: 2020-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -340,6 +340,7 @@ files:
 - lib/gandi_v5/live_dns/zone.rb
 - lib/gandi_v5/live_dns/zone/snapshot.rb
 - lib/gandi_v5/organization.rb
+- lib/gandi_v5/organization/customer.rb
 - lib/gandi_v5/version.rb
 - spec/.rubocop.yml
 - spec/features/domain_spec.rb
@@ -371,6 +372,7 @@ files:
 - spec/fixtures/bodies/GandiV5_LiveDNS_Zone_Snapshot/list.yml
 - spec/fixtures/bodies/GandiV5_Organization/fetch.yml
 - spec/fixtures/bodies/GandiV5_Organization/list.yml
+- spec/fixtures/bodies/GandiV5_Organization_Customer/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
@@ -415,6 +417,7 @@ files:
 - 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_spec.rb
 homepage: https://github.com/robertgauld/gandi_v5
@@ -436,7 +439,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.