Merge pull request #72 from i7an/contact-imports-api

Contact Imports API

Author: i7an

examples/contacts_api.rb

@@ -4,6 +4,7 @@
 contact_lists = Mailtrap::ContactListsAPI.new 3229, client
 contacts = Mailtrap::ContactsAPI.new 3229, client
 contact_fields = Mailtrap::ContactFieldsAPI.new 3229, client
+contact_imports = Mailtrap::ContactImportsAPI.new 3229, client
 
 # Set your API credentials as environment variables
 # export MAILTRAP_API_KEY='your-api-key'
@@ -12,83 +13,84 @@
 # contact_lists = Mailtrap::ContactListsAPI.new
 # contacts = Mailtrap::ContactsAPI.new
 # contact_fields = Mailtrap::ContactFieldsAPI.new
+# contact_imports = Mailtrap::ContactImportsAPI.new
 
 # Create new contact list
 list = contact_lists.create(name: 'Test List')
-# => ContactList.new(id: 1, name: 'Test List')
+# => #<struct Mailtrap::ContactList id=1, name="Test List">
 
 # Get all contact lists
 contact_lists.list
-# => [ContactList.new(id: 1, name: 'Test List')]
+# => [#<struct Mailtrap::ContactList id=1, name="Test List">]
 
 # Update contact list
 contact_lists.update(list.id, name: 'Test List Updated')
-# => ContactList.new(id: 1, name: 'Test List Updated')
+# => #<struct Mailtrap::ContactList id=1, name="Test List Updated">
 
 # Get contact list
 list = contact_lists.get(list.id)
-# => ContactList.new(id: 1, name: 'Test List Updated')
+# => #<struct Mailtrap::ContactList id=1, name="Test List Updated">
+
+# Delete contact list
+contact_lists.delete(list.id)
 
 # Create new contact field
 field = contact_fields.create(name: 'Nickname', data_type: 'text', merge_tag: 'nickname')
-# => ContactField.new(id: 1, name: 'Nickname', data_type: 'text', merge_tag: 'nickname')
+# => #<struct Mailtrap::ContactField id=1, name="Nickname", data_type="text", merge_tag="nickname">
 
 # Get all contact fields
 contact_fields.list
-# => [ContactField.new(id: 1, name: 'Nickname', data_type: 'text', merge_tag: 'nickname')]
+# => [#<struct Mailtrap::ContactField id=1, name="Nickname", data_type="text", merge_tag="nickname">]
 
 # Update contact field
 contact_fields.update(field.id, name: 'Nickname 2', merge_tag: 'nickname')
-# => ContactField.new(id: 1, name: 'Nickname 2', data_type: 'text', merge_tag: 'nickname')
+# => #<struct Mailtrap::ContactField id=1, name="Nickname 2", data_type="text", merge_tag="nickname">
 
 # Get contact field
 field = contact_fields.get(field.id)
-# => ContactField.new(id: 1, name: 'Nickname 2', data_type: 'text', merge_tag: 'nickname')
+# => #<struct Mailtrap::ContactField id=1, name="Nickname 2", data_type="text", merge_tag="nickname">
 
 # Create new contact with all possible fields
 contact = contacts.create(
   email: '[email protected]',
   fields: { field.merge_tag => 'John Doe' },
   list_ids: [list.id]
 )
-# => Contact.new(
-#      id: 1,
-#      email: '[email protected]',
-#      fields: { 'nickname' => 'John Doe' },
-#      list_ids: [1],
-#      status: 'subscribed',
-#      created_at: 1721212345,
-#      updated_at: 1721212345
-#    )
+# => #<struct Mailtrap::Contact
+#      id=1,
+#      email="[email protected]",
+#      fields={ "nickname" => "John Doe" },
+#      list_ids=[1],
+#      status="subscribed",
+#      created_at=1721212345,
+#      updated_at=1721212345>
 contact.newly_created? # => true
 
 # Get contact
 contact = contacts.get(contact.id)
-# => Contact.new(
-#      id: 1,
-#      email: '[email protected]',
-#      fields: { 'nickname' => 'John Doe' },
-#      list_ids: [1],
-#      status: 'subscribed',
-#      created_at: 1721212345,
-#      updated_at: 1721212345
-#    )
+# => #<struct Mailtrap::Contact
+#      id=1,
+#      email="[email protected]",
+#      fields={ "nickname" => "John Doe" },
+#      list_ids=[1],
+#      status="subscribed",
+#      created_at=1721212345,
+#      updated_at=1721212345>
 
 # Update contact using id
 updated_contact = contacts.upsert(
   contact.id,
   email: '[email protected]',
   fields: { field.merge_tag => 'Jane Doe' }
 )
-# => Contact.new(
-#      id: 1,
-#      email: '[email protected]',
-#      fields: { 'nickname' => 'Jane Doe' },
-#      list_ids: [1],
-#      status: 'subscribed',
-#      created_at: 1721212345,
-#      updated_at: 1721212350
-#    )
+# => #<struct Mailtrap::Contact
+#      id=1,
+#      email="[email protected]",
+#      fields={ "nickname" => "Jane Doe" },
+#      list_ids=[1],
+#      status="subscribed",
+#      created_at=1721212345,
+#      updated_at=1721212350>
 updated_contact.newly_created? # => false
 
 # Update contact using email
@@ -97,46 +99,79 @@
   email: '[email protected]',
   fields: { field.merge_tag => 'Jane Doe' }
 )
-# => Contact.new(
-#      id: 1,
-#      email: '[email protected]',
-#      fields: { 'nickname' => 'Jane Doe' },
-#      list_ids: [1],
-#      status: 'subscribed',
-#      created_at: 1721212345,
-#      updated_at: 1721212355
-#    )
+# => #<struct Mailtrap::Contact
+#      id=1,
+#      email="[email protected]",
+#      fields={ "nickname" => "Jane Doe" },
+#      list_ids=[1],
+#      status="subscribed",
+#      created_at=1721212345,
+#      updated_at=1721212355>
 updated_contact.newly_created? # => false
 
 # Remove contact from lists
 contacts.remove_from_lists(contact.id, [list.id])
-# => Contact.new(
-#      id: 1,
-#      email: '[email protected]',
-#      fields: { 'nickname' => 'Jane Doe' },
-#      list_ids: [],
-#      status: 'subscribed',
-#      created_at: 1721212345,
-#      updated_at: 1721212360
-#    )
+# => #<struct Mailtrap::Contact
+#      id=1,
+#      email="[email protected]",
+#      fields={ "nickname" => "Jane Doe" },
+#      list_ids=[],
+#      status="subscribed",
+#      created_at=1721212345,
+#      updated_at=1721212360>
 
 # Add contact to lists
 contacts.add_to_lists(contact.id, [list.id])
-# => Contact.new(
-#      id: 1,
-#      email: '[email protected]',
-#      fields: { 'nickname' => 'Jane Doe' },
-#      list_ids: [1],
-#      status: 'subscribed',
-#      created_at: 1721212345,
-#      updated_at: 1721212365
-#    )
+# => #<struct Mailtrap::Contact
+#      id=1,
+#      email="[email protected]",
+#      fields={ "nickname" => "Jane Doe" },
+#      list_ids=[1],
+#      status="subscribed",
+#      created_at=1721212345,
+#      updated_at=1721212365>
 
 # Delete contact
 contacts.delete(contact.id)
 
-# Delete contact list
-contact_lists.delete(list.id)
-
 # Delete contact field
 contact_fields.delete(field.id)
+
+# Create a new contact import using ContactsImportRequest builder
+import_request = Mailtrap::ContactsImportRequest.new.tap do |req|
+  req.upsert(email: '[email protected]', fields: { first_name: 'John' })
+     .add_to_lists(email: '[email protected]', list_ids: [1])
+     .remove_from_lists(email: '[email protected]', list_ids: [2])
+
+  req.upsert(email: '[email protected]', fields: { first_name: 'Jane' })
+     .add_to_lists(email: '[email protected]', list_ids: [1])
+     .remove_from_lists(email: '[email protected]', list_ids: [2])
+end
+
+# Execute the import
+contact_import = contact_imports.create(import_request)
+# => #<struct Mailtrap::ContactImport
+#      id=1,
+#      status="created",
+#      created_contacts_count=nil,
+#      updated_contacts_count=nil,
+#      contacts_over_limit_count=nil>
+
+# Wait for the import to complete (if needed)
+
+# Get the import status
+contact_imports.get(contact_import.id)
+# => #<struct Mailtrap::ContactImport
+#      id=1,
+#      status="finished",
+#      created_contacts_count=2,
+#      updated_contacts_count=0,
+#      contacts_over_limit_count=0>
+
+# Import using plain hash
+contact_imports.create(
+  [
+    { email: '[email protected]', fields: { first_name: 'John' }, list_ids_included: [1], list_ids_excluded: [2] },
+    { email: '[email protected]', fields: { first_name: 'Jane' }, list_ids_included: [1], list_ids_excluded: [2] }
+  ]
+)

lib/mailtrap.rb

@@ -8,6 +8,7 @@
 require_relative 'mailtrap/contacts_api'
 require_relative 'mailtrap/contact_lists_api'
 require_relative 'mailtrap/contact_fields_api'
+require_relative 'mailtrap/contact_imports_api'
 
 module Mailtrap
   # @!macro api_errors

lib/mailtrap/contact_import.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Mailtrap
+  # Data Transfer Object for Contact Import
+  # @attr_reader id [Integer] The contact import ID
+  # @attr_reader status [String] The status of the import (created, started, finished, failed)
+  # @attr_reader created_contacts_count [Integer, nil] Number of contacts created in this import
+  # @attr_reader updated_contacts_count [Integer, nil] Number of contacts updated in this import
+  # @attr_reader contacts_over_limit_count [Integer, nil] Number of contacts over the allowed limit
+  ContactImport = Struct.new(
+    :id,
+    :status,
+    :created_contacts_count,
+    :updated_contacts_count,
+    :contacts_over_limit_count,
+    keyword_init: true
+  ) do
+    # @return [Hash] The contact attributes as a hash
+    def to_h
+      super.compact
+    end
+  end
+end

lib/mailtrap/contact_imports_api.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require_relative 'contact_import'
+require_relative 'contacts_import_request'
+
+module Mailtrap
+  class ContactImportsAPI
+    include BaseAPI
+
+    self.supported_options = %i[email fields list_ids_included list_ids_excluded]
+
+    self.response_class = ContactImport
+
+    # Retrieves a specific contact import
+    # @param import_id [Integer] The contact import identifier
+    # @return [ContactImport] Contact import object
+    # @!macro api_errors
+    def get(import_id)
+      base_get(import_id)
+    end
+
+    # Create contacts import
+    #
+    # @example Using Mailtrap::ContactsImportRequest
+    #   import_request = Mailtrap::ContactsImportRequest.new.tap do |req|
+    #     req.upsert(email: '[email protected]', fields: { first_name: 'Jane' })
+    #       .add_to_lists(email: '[email protected]', list_ids: [1])
+    #       .remove_from_lists(email: '[email protected]', list_ids: [2])
+    #     req.upsert(email: '[email protected]', fields: { first_name: 'John' })
+    #       .add_to_lists(email: '[email protected]', list_ids: [1])
+    #       .remove_from_lists(email: '[email protected]', list_ids: [2])
+    #   end
+    #   contact_imports.create(import_request)
+    #
+    # @example Using plain hash
+    #   contact_imports.create([
+    #     {email: '[email protected]', fields: { first_name: 'John' }, list_ids_included: [1], list_ids_excluded: [2]},
+    #     {email: '[email protected]', fields: { first_name: 'Jane' }, list_ids_included: [1], list_ids_excluded: [2]}
+    #   ])
+    #
+    # @param contacts [Mailtrap::ContactsImportRequest, Array<Hash>] The contacts import request
+    #
+    # @return [ContactImport] Created contact import object
+    # @!macro api_errors
+    # @raise [ArgumentError] If invalid options are provided
+    def create(contacts)
+      contact_data = contacts.to_a.each do |contact|
+        validate_options!(contact, supported_options)
+      end
+      response = client.post(base_path, contacts: contact_data)
+      handle_response(response)
+    end
+    alias start create
+
+    private
+
+    def base_path
+      "/api/accounts/#{account_id}/contacts/imports"
+    end
+  end
+end

lib/mailtrap/contacts_import_request.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Mailtrap
+  # A builder class for creating contact import requests
+  # Allows you to build a collection of contacts with their associated fields and list memberships
+  class ContactsImportRequest
+    def initialize
+      @data = Hash.new do |h, k|
+        h[k] = { email: k, fields: {}, list_ids_included: [], list_ids_excluded: [] }
+      end
+    end
+
+    # Creates or updates a contact with the provided email and fields
+    # @param email [String] The contact's email address
+    # @param fields [Hash] Contact fields in the format: field_merge_tag => String, Integer, Float, Boolean, or
+    #   ISO-8601 date string (yyyy-mm-dd)
+    # @return [ContactsImportRequest] Returns self for method chaining
+    def upsert(email:, fields: {})
+      validate_email!(email)
+
+      @data[email][:fields].merge!(fields)
+
+      self
+    end
+
+    # Adds a contact to the specified lists
+    # @param email [String] The contact's email address
+    # @param list_ids [Array<Integer>] Array of list IDs to add the contact to
+    # @return [ContactsImportRequest] Returns self for method chaining
+    def add_to_lists(email:, list_ids:)
+      validate_email!(email)
+
+      append_list_ids email:, list_ids:, key: :list_ids_included
+
+      self
+    end
+
+    # Removes a contact from the specified lists
+    # @param email [String] The contact's email address
+    # @param list_ids [Array<Integer>] Array of list IDs to remove the contact from
+    # @return [ContactsImportRequest] Returns self for method chaining
+    def remove_from_lists(email:, list_ids:)
+      validate_email!(email)
+
+      append_list_ids email:, list_ids:, key: :list_ids_excluded
+
+      self
+    end
+
+    # @return [Array<Hash>] Array of contact objects ready for import
+    def to_a
+      @data.values
+    end
+
+    private
+
+    def validate_email!(email)
+      raise ArgumentError, 'email must be present' if email.nil? || email.empty?
+    end
+
+    def append_list_ids(email:, list_ids:, key:)
+      raise ArgumentError, 'list_ids must be present' if list_ids.empty?
+
+      @data[email][key] |= list_ids
+    end
+  end
+end