gandi_v5 0.1.0 → 0.6.0

data/lib/gandi_v5/live_dns/zone/snapshot.rb

@@ -28,32 +28,51 @@ class GandiV5
 
         # Delete this snapshot.
         # @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 delete
-          data = GandiV5.delete url
+          _response, data = GandiV5.delete url
           data['message']
         end
 
+        # @see GandiV5::LiveDNS::Zone.fetch
+        def fetch_zone
+          GandiV5::LiveDNS::Zone.fetch zone_uuid
+        end
+
+        # The snapshot's zone (fetching from Gandi if required).
+        # @return [GandiV5::LiveDNS::Zone]
+        # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+        def zone
+          @zone ||= fetch_zone
+        end
+
+        # Get snapshot UUIDs for this zone from Gandi.
+        # @return [Hash{String => Time}] Mapping UUID to time made.
+        # @raise [GandiV5::Error::GandiError] if Gandi returns an error.
+        def self.list(zone_uuid)
+          _response, data = GandiV5.get url(zone_uuid)
+          Hash[data.map { |snapshot| [snapshot['uuid'], Time.parse(snapshot['date_created'])] }]
+        end
+
         # Get snapshot from Gandi.
         # @param zone_uuid [String, #to_s] the UUID of the zone the snapshot was made of.
         # @param snapshot_uuid [String, #to_s] 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 self.fetch(zone_uuid, snapshot_uuid)
-          data = GandiV5.get url(zone_uuid, snapshot_uuid)
+          _response, data = GandiV5.get url(zone_uuid, snapshot_uuid)
           from_gandi data
         end
 
-        # TODO: Move listing snapshots to here
-
         private
 
         def url
           "#{BASE}zones/#{CGI.escape zone_uuid}/snapshots/#{CGI.escape uuid}"
         end
 
-        def self.url(zone_uuid, snapshot_uuid)
-          "#{BASE}zones/#{CGI.escape zone_uuid}/snapshots/#{CGI.escape snapshot_uuid}"
+        def self.url(zone_uuid, snapshot_uuid = nil)
+          "#{BASE}zones/#{CGI.escape zone_uuid}/snapshots" +
+            (snapshot_uuid ? "/#{CGI.escape snapshot_uuid}" : '')
         end
         private_class_method :url
       end

data/lib/gandi_v5/organization.rb

@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'email/mailbox'
-require_relative 'email/offer'
-require_relative 'email/slot'
-
 class GandiV5
   # The Organization API is a read-only API.
   # All organization management must be performed via the web interface.
@@ -54,13 +50,50 @@ 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]
-    # @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 "#{url}/user-info"
       from_gandi data
     end
+
+    # List organisations.
+    # @see https://api.gandi.net/docs/domains#get-v5-organization-organizations
+    # @param name [String, #to_s] (optional)
+    #   filters the list by name, with optional patterns.
+    #   e.g. "alice", "ali*", "*ice"
+    # @param type [String, #to_s] (optional)
+    #   filters the list by type of organization.
+    #   One of: "individual", "company", "association", "publicbody"
+    # @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(**params)
+      params['~name'] = params.delete(:name) if params.key?(:name)
+      _resp, data = GandiV5.get "#{url}/organizations", params: params
+      data.map { |organisation| from_gandi organisation }
+    end
+
+    private
+
+    def self.url
+      "#{BASE}organization"
+    end
+    private_class_method :url
   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/version.rb

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

data/spec/.rubocop.yml

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

data/spec/features/domain_spec.rb

@@ -2,12 +2,12 @@
 
 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'
     expect(list.first.fqdn_unicode).to eq 'example.net'
-    expect(list.first.name_servers).to be nil
+    expect(list.first.name_servers).to eq []
     expect(list.first.services).to be nil
     expect(list.first.sharing_space).to be nil
     expect(list.first.status).to match_array [:clientTransferProhibited]

data/spec/features/livedns_zone_spec.rb

@@ -25,21 +25,20 @@ describe 'LiveDNS Zone features' do
   end
 
   it 'Make and save snapshot', :vcr do
-    yaml = "--- !ruby/object:GandiV5::LiveDNS::Zone::Snapshot\n" \
-           "uuid: snapshot-uuid\n" \
-           "zone_uuid: zone-uuid\n" \
-           "created_at: 2016-12-16 16:51:26.000000000 Z\n" \
-           "records:\n" \
-           "- !ruby/object:GandiV5::LiveDNS::RecordSet\n" \
-           "  type: A\n" \
-           "  ttl: 10800\n" \
-           "  name: www\n" \
-           "  values:\n" \
-           "  - 10.0.1.42\n"
-    expect(File).to receive(:write).with('/path/to/file', yaml)
+    hash = {
+      uuid: 'snapshot-uuid',
+      zone_uuid: 'zone-uuid',
+      created_at: Time.new(2016, 12, 16, 16, 51, 26),
+      records: [
+        type: 'A',
+        ttl: 10_800,
+        name: 'www',
+        values: ['10.0.1.42']
+      ]
+    }
 
     zone = GandiV5::LiveDNS::Zone.new uuid: 'zone-uuid'
     snapshot = zone.take_snapshot
-    File.write '/path/to/file', snapshot.to_yaml
+    expect(snapshot.to_h).to eq hash
   end
 end

data/spec/fixtures/bodies/GandiV5_Domain/{get.yaml → fetch.yml}

@@ -35,3 +35,11 @@ contacts:
 services:
 - gandilivedns
 - dnssec
+sharing_space:
+  id: SHARING-UUID
+  name: User
+  type: user
+  reseller: true
+  sharing_space:
+    id: RESELLER-UUID
+    name: Reseller

data/spec/fixtures/bodies/GandiV5_Domain/fetch_glue_records.yml

@@ -0,0 +1,7 @@
+---
+- name: ns1
+  fqdn: example.com
+  fqdn_unicode: example.com
+  href: http://api.test/v5/domain/domains/example.com/hosts/ns1
+  ips:
+  - '1.2.3.4'

data/spec/fixtures/bodies/GandiV5_Domain/fetch_livedns.yml

@@ -0,0 +1,6 @@
+---
+current: livedns
+nameservers:
+  - '1.2.3.4'
+dnssec_available: true
+livednssec_available: true

data/spec/fixtures/bodies/GandiV5_Domain/fetch_name_servers.yml

@@ -0,0 +1,2 @@
+---
+- '1.2.3.4'

data/spec/fixtures/bodies/GandiV5_Domain/{renewal_info.yaml → fetch_renewal_info.yml}

@@ -7,6 +7,3 @@ renew:
   maximum: 2
   minimum: 1
   prohibited: false
-contracts:
-  - id: uuid
-    name: Name

data/spec/fixtures/bodies/GandiV5_Domain/{list.yaml → list.yml}

@@ -18,3 +18,4 @@
     current: livedns
   href: https://api.gandi.net/v5/domain/domains/example.com
   fqdn_unicode: example.com
+  nameservers: []

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

@@ -0,0 +1,6 @@
+---
+- source: alice
+  href: https://api.test/api/v5/email/forwards/example.com/alice
+  destinations:
+  - bob@example.com
+  - charlie@example.com

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

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

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

@@ -0,0 +1,7 @@
+---
+- id: organization-uuid
+  name: FirstLast
+  corporate: false
+  firstname: First
+  lastname: Last
+  reseller: false

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/fixtures/vcr/Domain_features/List_domains.yml

@@ -46,7 +46,8 @@ http_interactions:
               "current": "livedns"
             },
             "href": "https://api.test/v5/domain/domains/example.net",
-            "fqdn_unicode": "example.net"
+            "fqdn_unicode": "example.net",
+            "nameservers": []
           }
         ]
     http_version: 

data/spec/spec_helper.rb

@@ -13,12 +13,12 @@ allow_http_connections_to = %w[localhost 127.0.0.1]
 
 Dotenv.load File.join(__dir__, 'test.env')
 
-SimpleCov.coverage_dir(File.join('tmp', 'coverage'))
+SimpleCov.coverage_dir(File.join('tmp', 'coverage')) unless ENV.key?('TRAVIS')
 SimpleCov.start do
   add_filter 'spec/'
 end
 
-if ENV['TRAVIS']
+if ENV.key?('TRAVIS')
   Coveralls.wear!
   allow_http_connections_to.push 'coveralls.io'
 end

data/spec/units/gandi_v5/billing_spec.rb

@@ -4,9 +4,9 @@ describe GandiV5::Billing do
   describe '.info' do
     subject { described_class.info }
     before :each do
-      body_fixture = File.expand_path(File.join('spec', 'fixtures', 'bodies', 'GandiV5_Billing', 'info.yaml'))
+      body_fixture = File.expand_path(File.join('spec', 'fixtures', 'bodies', 'GandiV5_Billing', 'info.yml'))
       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 }
@@ -23,9 +23,9 @@ describe GandiV5::Billing do
   describe '.info (for a sharing_id)' do
     subject { described_class.info('sharing-id') }
     before :each do
-      body_fixture = File.expand_path(File.join('spec', 'fixtures', 'bodies', 'GandiV5_Billing', 'info.yaml'))
+      body_fixture = File.expand_path(File.join('spec', 'fixtures', 'bodies', 'GandiV5_Billing', 'info.yml'))
       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 }