Add extended API support (Templates, ContactLists)

Author: Viktorkosandyak

lib/mailtrap.rb

@@ -6,5 +6,7 @@
 require_relative 'mailtrap/version'
 require_relative 'mailtrap/resources/batch_sender'
 require_relative 'mailtrap/resources/contacts'
+require_relative 'mailtrap/resources/templates'
+require_relative 'mailtrap/resources/contact_lists'
 
 module Mailtrap; end

lib/mailtrap/resources/contact_lists.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module Mailtrap
+  module Resources
+    class ContactLists
+      ALLOWED_CREATE_KEYS = %i[name description].freeze
+      ALLOWED_UPDATE_KEYS = %i[name description].freeze
+
+      EXPECTED_KEYS = %i[
+        id name description contacts_count created_at updated_at
+      ].freeze
+
+      def initialize(api_client, strict_mode: false)
+        @client = api_client
+        @strict_mode = strict_mode
+      end
+
+      def list(account_id:, page: 1, per_page: 50)
+        response = @client.get("/api/accounts/#{account_id}/contact_lists", params: {
+          page: page,
+          per_page: per_page
+        })
+        validate_response_keys!(response[:data]) if @strict_mode
+        response
+      end
+
+      def find(account_id:, list_id:)
+        response = @client.get("/api/accounts/#{account_id}/contact_lists/#{list_id}")
+        validate_response_keys!([response]) if @strict_mode
+        response
+      end
+
+      def create(account_id:, **attrs)
+        validate_keys!(attrs, ALLOWED_CREATE_KEYS)
+        @client.post("/api/accounts/#{account_id}/contact_lists", body: attrs)
+      end
+
+      def update(account_id:, list_id:, **attrs)
+        validate_keys!(attrs, ALLOWED_UPDATE_KEYS)
+        @client.patch("/api/accounts/#{account_id}/contact_lists/#{list_id}", body: attrs.compact)
+      end
+
+      def delete(account_id:, list_id:)
+        @client.delete("/api/accounts/#{account_id}/contact_lists/#{list_id}")
+      end
+
+      private
+
+      def validate_keys!(input, allowed_keys)
+        return unless @strict_mode
+
+        input.each_key do |key|
+          raise ArgumentError, "Unexpected key in payload: #{key}" unless allowed_keys.include?(key)
+        end
+      end
+
+      def validate_response_keys!(records)
+        records.each do |record|
+          record.each_key do |key|
+            raise ArgumentError, "Unexpected key in response: #{key}" unless EXPECTED_KEYS.include?(key)
+          end
+
+          EXPECTED_KEYS.each do |key|
+            raise ArgumentError, "Missing key in contact list object: #{key}" unless record.key?(key)
+          end
+        end
+      end
+    end
+  end
+end

lib/mailtrap/resources/templates.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module Mailtrap
+  module Resources
+    class Templates
+      ALLOWED_CREATE_KEYS = %i[name subject category body_html body_text].freeze
+      ALLOWED_UPDATE_KEYS = ALLOWED_CREATE_KEYS
+      ALLOWED_RESPONSE_KEYS = %i[
+        id uuid name subject category body_html body_text created_at updated_at
+      ].freeze
+
+      def initialize(api_client, strict_mode: false)
+        @client = api_client
+        @strict_mode = strict_mode
+      end
+
+      def list(account_id:, page: 1, per_page: 50)
+        response = @client.get("/api/accounts/#{account_id}/email_templates", params: {
+          page: page,
+          per_page: per_page
+        })
+      
+        validate_response_keys!(response[:data]) if @strict_mode
+        response
+      end
+
+      def find(account_id:, template_id:)
+        response = @client.get("/api/accounts/#{account_id}/email_templates/#{template_id}")
+        validate_response_keys!([response]) if @strict_mode
+        response
+      end
+
+      def create(account_id:, **attrs)
+        validate_keys!(attrs, ALLOWED_CREATE_KEYS)
+
+        @client.post("/api/accounts/#{account_id}/email_templates", body: {
+          email_template: attrs
+        })
+      end
+
+      def patch(account_id:, template_id:, **attrs)
+        validate_keys!(attrs, ALLOWED_UPDATE_KEYS)
+
+        @client.patch("/api/accounts/#{account_id}/email_templates/#{template_id}", body: {
+          email_template: attrs.compact
+        })
+      end
+
+      def delete(account_id:, template_id:)
+        @client.delete("/api/accounts/#{account_id}/email_templates/#{template_id}")
+      end
+
+      private
+
+      EXPECTED_KEYS = %i[id uuid name subject category body_html body_text created_at updated_at].freeze
+
+      def validate_keys!(input, allowed_keys)
+        return unless @strict_mode
+
+        input.each_key do |key|
+          unless allowed_keys.include?(key)
+            raise ArgumentError, "Unexpected key in payload: #{key}"
+          end
+        end
+      end
+
+      def validate_response_keys!(records)
+        records.each do |record|
+          record.each_key do |key|
+            unless EXPECTED_KEYS.include?(key)
+              raise ArgumentError, "Unexpected key in response: #{key}"
+            end
+          end
+      
+          EXPECTED_KEYS.each do |key|
+            unless record.key?(key)
+              raise ArgumentError, "Missing key in template object: #{key}"
+            end
+          end
+        end
+      end
+    end
+  end
+end

spec/mailtrap/resources/contact_lists_spec.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'mailtrap/api/client'
+require 'mailtrap/resources/contact_lists'
+
+RSpec.describe Mailtrap::Resources::ContactLists do
+  let(:client) { instance_double(Mailtrap::Api::Client) }
+  let(:resource) { described_class.new(client, strict_mode: true) }
+  let(:account_id) { '12345' }
+  let(:list_id) { 'list-uuid-999' }
+
+  let(:valid_response) do
+    {
+      id: list_id,
+      name: 'VIP Clients',
+      description: 'Top-tier clients',
+      contacts_count: 42,
+      created_at: 1_716_400_000,
+      updated_at: 1_716_400_000
+    }
+  end
+
+  describe '#list' do
+    let(:response_data) { { data: [valid_response] } }
+
+    it 'returns list and validates keys' do
+      expect(client).to receive(:get).with(
+        "/api/accounts/#{account_id}/contact_lists",
+        params: { page: 1, per_page: 50 }
+      ).and_return(response_data)
+
+      expect(resource.list(account_id: account_id)).to eq(response_data)
+    end
+
+    it 'raises error if extra key present' do
+      bad_response = { data: [valid_response.merge(extra: 'oops')] }
+      allow(client).to receive(:get).and_return(bad_response)
+
+      expect {
+        resource.list(account_id: account_id)
+      }.to raise_error(ArgumentError, /Unexpected key in response: extra/)
+    end
+
+    it 'raises error if required key missing' do
+      bad_response = { data: [valid_response.except(:description)] }
+      allow(client).to receive(:get).and_return(bad_response)
+
+      expect {
+        resource.list(account_id: account_id)
+      }.to raise_error(ArgumentError, /Missing key in contact list object: description/)
+    end
+  end
+
+  describe '#find' do
+    it 'returns single contact list' do
+      expect(client).to receive(:get).with(
+        "/api/accounts/#{account_id}/contact_lists/#{list_id}"
+      ).and_return(valid_response)
+
+      expect(resource.find(account_id: account_id, list_id: list_id)).to eq(valid_response)
+    end
+  end
+
+  describe '#create' do
+    let(:params) { { name: 'New List', description: 'Optional desc' } }
+
+    it 'creates a contact list with allowed keys' do
+      expect(client).to receive(:post).with(
+        "/api/accounts/#{account_id}/contact_lists",
+        body: params
+      ).and_return(valid_response)
+
+      expect(resource.create(account_id: account_id, **params)).to eq(valid_response)
+    end
+
+    it 'raises error with unexpected keys' do
+      expect {
+        resource.create(account_id: account_id, name: 'Test', bad: 'key')
+      }.to raise_error(ArgumentError, /Unexpected key in payload: bad/)
+    end
+  end
+
+  describe '#update' do
+    let(:attrs) { { name: 'Renamed', description: 'Updated description' } }
+
+    it 'updates a contact list' do
+      expect(client).to receive(:patch).with(
+        "/api/accounts/#{account_id}/contact_lists/#{list_id}",
+        body: attrs
+      ).and_return(valid_response)
+
+      expect(resource.update(account_id: account_id, list_id: list_id, **attrs)).to eq(valid_response)
+    end
+
+    it 'raises error with unexpected update key' do
+      expect {
+        resource.update(account_id: account_id, list_id: list_id, foo: 'bar')
+      }.to raise_error(ArgumentError, /Unexpected key in payload: foo/)
+    end
+  end
+
+  describe '#delete' do
+    it 'deletes a contact list' do
+      expect(client).to receive(:delete).with(
+        "/api/accounts/#{account_id}/contact_lists/#{list_id}"
+      ).and_return({})
+
+      expect(resource.delete(account_id: account_id, list_id: list_id)).to eq({})
+    end
+  end
+end