mailersend-ruby 3.1.0 → 3.4.0

data/spec/whatsapp_activities_rspec.rb

@@ -0,0 +1,38 @@
+require 'rspec'
+require 'vcr'
+require 'json'
+
+VCR.configure do |config|
+  config.cassette_library_dir = './fixtures'
+  config.hook_into :webmock
+  config.filter_sensitive_data('<AUTH>') do |interaction|
+    interaction.request.headers['Authorization'][0]
+  end
+end
+
+RSpec.describe Mailersend::WhatsAppActivities do
+  let(:client) { Mailersend::Client.new(API_TOKEN) }
+  let(:whatsapp_activities) { Mailersend::WhatsAppActivities.new(client) }
+
+  it 'returns a list of WhatsApp activities' do
+    VCR.use_cassette('whatsapp_activities/whatsapp_activities_list', match_requests_on: %i[method host path query]) do
+      response = whatsapp_activities.list(
+        whatsapp_item_id: '67f91abe2202f3705540234a',
+        whatsapp_message_id: '67f91abd69f79df391e9d78d',
+        recipient: '48600000001',
+        type: %w[delivered read],
+        date_from: 1_791_936_000,
+        date_to: 1_792_022_400,
+        page: 1,
+        limit: 25
+      )
+      parsed_response = JSON.parse(response.body)
+
+      expect(response.status).to eq(200)
+      expect(parsed_response['data']).to be_an(Array)
+      expect(parsed_response['data'].map { |activity| activity['type'] }).to eq(%w[read delivered])
+      expect(parsed_response['links']['last']).to be_nil
+      expect(parsed_response['meta']).not_to have_key('total')
+    end
+  end
+end

data/spec/whatsapp_inbound_messages_rspec.rb

@@ -0,0 +1,49 @@
+require 'rspec'
+require 'vcr'
+require 'json'
+
+VCR.configure do |config|
+  config.cassette_library_dir = './fixtures'
+  config.hook_into :webmock
+  config.filter_sensitive_data('<AUTH>') do |interaction|
+    interaction.request.headers['Authorization'][0]
+  end
+end
+
+RSpec.describe Mailersend::WhatsAppInboundMessages do
+  let(:client) { Mailersend::Client.new(API_TOKEN) }
+  let(:whatsapp_inbound_messages) { Mailersend::WhatsAppInboundMessages.new(client) }
+
+  it 'returns a list of WhatsApp inbound messages' do
+    VCR.use_cassette('whatsapp_inbound_messages/whatsapp_inbound_messages_list', match_requests_on: %i[method host path query]) do
+      response = whatsapp_inbound_messages.list(
+        whatsapp_account_id: '3enl6x27wmrxrl2v',
+        from: '48600000001',
+        type: %w[text image],
+        date_from: 1_790_000_000,
+        date_to: 1_790_086_400,
+        page: 1,
+        limit: 25
+      )
+      parsed_response = JSON.parse(response.body)
+
+      expect(response.status).to eq(200)
+      expect(parsed_response['data']).to be_an(Array)
+      expect(parsed_response['data'][0]['meta']['body']).to eq('Hello, I would like to check my order status.')
+      expect(parsed_response['data'][1]).not_to have_key('context')
+      expect(parsed_response['links']['last']).to be_nil
+      expect(parsed_response['meta']).not_to have_key('total')
+    end
+  end
+
+  it 'returns a single WhatsApp inbound message' do
+    VCR.use_cassette('whatsapp_inbound_messages/whatsapp_inbound_messages_get') do
+      response = whatsapp_inbound_messages.get(whatsapp_inbound_message_id: '62f114a3165fe0d8db0288d1')
+      parsed_response = JSON.parse(response.body)
+
+      expect(response.status).to eq(200)
+      expect(parsed_response['data']['meta']['reply_type']).to eq('list_reply')
+      expect(parsed_response['data']['context']['message_id']).to start_with('wamid.')
+    end
+  end
+end

data/spec/whatsapp_items_rspec.rb

@@ -0,0 +1,52 @@
+require 'rspec'
+require 'vcr'
+require 'json'
+
+VCR.configure do |config|
+  config.cassette_library_dir = './fixtures'
+  config.hook_into :webmock
+  config.filter_sensitive_data('<AUTH>') do |interaction|
+    interaction.request.headers['Authorization'][0]
+  end
+end
+
+RSpec.describe Mailersend::WhatsAppItems do
+  let(:client) { Mailersend::Client.new(API_TOKEN) }
+  let(:whatsapp_items) { Mailersend::WhatsAppItems.new(client) }
+
+  it 'returns a list of WhatsApp items' do
+    VCR.use_cassette('whatsapp_items/whatsapp_items_list', match_requests_on: %i[method host path query]) do
+      response = whatsapp_items.list(
+        recipient: '48600000002',
+        whatsapp_message_id: '67f91abd69f79df391e9d78d',
+        status: %w[failed read],
+        whatsapp_account_id: '3enl6x27wmrxrl2v',
+        from: '15550001234',
+        template_id: '23zxk54v6gjy6v7m',
+        date_from: 1_791_936_000,
+        date_to: 1_792_022_400,
+        page: 1,
+        limit: 25
+      )
+      parsed_response = JSON.parse(response.body)
+
+      expect(response.status).to eq(200)
+      expect(parsed_response['data']).to be_an(Array)
+      expect(parsed_response['data'][0]['status']).to eq('failed')
+      expect(parsed_response['data'][0]['error_code']).to eq(131_026)
+      expect(parsed_response['links']['last']).to be_nil
+      expect(parsed_response['meta']).not_to have_key('total')
+    end
+  end
+
+  it 'returns a single WhatsApp item' do
+    VCR.use_cassette('whatsapp_items/whatsapp_items_get') do
+      response = whatsapp_items.get(whatsapp_item_id: '67f91abe2202f3705540234a')
+      parsed_response = JSON.parse(response.body)
+
+      expect(response.status).to eq(200)
+      expect(parsed_response['data']['recipient']['id']).to eq('67f91abe2202f37055402301')
+      expect(parsed_response['data']['activity'].map { |activity| activity['type'] }).to eq(%w[queued sent delivered read])
+    end
+  end
+end

data/spec/whatsapp_messages_rspec.rb

@@ -0,0 +1,50 @@
+require 'rspec'
+require 'vcr'
+require 'json'
+
+VCR.configure do |config|
+  config.cassette_library_dir = './fixtures'
+  config.hook_into :webmock
+  config.filter_sensitive_data('<AUTH>') do |interaction|
+    interaction.request.headers['Authorization'][0]
+  end
+end
+
+RSpec.describe Mailersend::WhatsAppMessages do
+  let(:client) { Mailersend::Client.new(API_TOKEN) }
+  let(:whatsapp_messages) { Mailersend::WhatsAppMessages.new(client) }
+
+  it 'returns a list of WhatsApp messages' do
+    VCR.use_cassette('whatsapp_messages/whatsapp_messages_list', match_requests_on: %i[method host path query]) do
+      response = whatsapp_messages.list(
+        whatsapp_account_id: '3enl6x27wmrxrl2v',
+        from: '15550001234',
+        template_id: '23zxk54v6gjy6v7m',
+        date_from: 1_791_936_000,
+        date_to: 1_792_022_400,
+        page: 1,
+        limit: 25
+      )
+      parsed_response = JSON.parse(response.body)
+
+      expect(response.status).to eq(200)
+      expect(parsed_response['data']).to be_an(Array)
+      expect(parsed_response['data'][0]['to']).to eq(%w[48600000001 48600000002])
+      expect(parsed_response['data'][0]).not_to have_key('items')
+      expect(parsed_response['links']['last']).to be_nil
+      expect(parsed_response['meta']).not_to have_key('total')
+      expect(parsed_response['meta']).not_to have_key('last_page')
+    end
+  end
+
+  it 'returns a single WhatsApp message' do
+    VCR.use_cassette('whatsapp_messages/whatsapp_messages_get') do
+      response = whatsapp_messages.get(whatsapp_message_id: '67f91abd69f79df391e9d78d')
+      parsed_response = JSON.parse(response.body)
+
+      expect(response.status).to eq(200)
+      expect(parsed_response['data']['items']).to be_an(Array)
+      expect(parsed_response['data']['items'].map { |item| item['status'] }).to eq(%w[read failed])
+    end
+  end
+end

data/spec/whatsapp_recipient_rspec.rb

@@ -0,0 +1,40 @@
+require 'rspec'
+require 'vcr'
+require 'json'
+
+VCR.configure do |config|
+  config.cassette_library_dir = './fixtures'
+  config.hook_into :webmock
+  config.filter_sensitive_data('<AUTH>') do |interaction|
+    interaction.request.headers['Authorization'][0]
+  end
+end
+
+RSpec.describe Mailersend::WhatsAppRecipient do
+  let(:client) { Mailersend::Client.new(API_TOKEN) }
+  let(:whatsapp_recipient) { Mailersend::WhatsAppRecipient.new(client) }
+
+  it 'returns a list of WhatsApp recipients' do
+    VCR.use_cassette('whatsapp_recipient/whatsapp_recipient_list', match_requests_on: %i[method host path query]) do
+      response = whatsapp_recipient.list(status: 'active', phone_number: '48600000001', page: 1, limit: 25)
+      parsed_response = JSON.parse(response.body)
+
+      expect(response.status).to eq(200)
+      expect(parsed_response['data']).to be_an(Array)
+      expect(parsed_response['data'][0]).not_to have_key('bsuid')
+      expect(parsed_response['links']['last']).to be_nil
+      expect(parsed_response['meta']).not_to have_key('total')
+    end
+  end
+
+  it 'returns a single WhatsApp recipient' do
+    VCR.use_cassette('whatsapp_recipient/whatsapp_recipient_get') do
+      response = whatsapp_recipient.get(whatsapp_recipient_id: '67f91abe2202f37055402301')
+      parsed_response = JSON.parse(response.body)
+
+      expect(response.status).to eq(200)
+      expect(parsed_response['data']['items']).to be_an(Array)
+      expect(parsed_response['data']['items'][0]['whatsapp_message_id']).to eq('67f91abd69f79df391e9d78d')
+    end
+  end
+end

data/spec/whatsapp_rspec.rb

@@ -0,0 +1,65 @@
+require 'rspec'
+require 'vcr'
+require 'json'
+
+VCR.configure do |config|
+  config.cassette_library_dir = './fixtures'
+  config.hook_into :webmock
+  config.filter_sensitive_data('<AUTH>') do |interaction|
+    interaction.request.headers['Authorization'][0]
+  end
+end
+
+RSpec.describe Mailersend::WhatsApp do
+  let(:client) { Mailersend::Client.new(API_TOKEN) }
+  let(:whatsapp) { Mailersend::WhatsApp.new(client) }
+
+  it 'sends a WhatsApp message' do
+    VCR.use_cassette('whatsapp/whatsapp_send') do
+      whatsapp.add_from('15550001234')
+      whatsapp.add_to('+48600000001')
+      whatsapp.add_template_id('23zxk54v6gjy6v7m')
+
+      response = whatsapp.send
+      parsed_response = JSON.parse(response.body)
+
+      expect(response.status).to eq(202)
+      expect(parsed_response['data']['id']).to eq('67f91abd69f79df391e9d78d')
+    end
+  end
+
+  it 'includes the personalization in the request body when set' do
+    # Cassette is matched on the request body, so this passes only when
+    # the serialized payload contains the personalization field.
+    VCR.use_cassette('whatsapp/whatsapp_send_personalization', match_requests_on: %i[method uri body]) do
+      whatsapp.add_from('15550001234')
+      whatsapp.add_to('+48600000001')
+      whatsapp.add_template_id('23zxk54v6gjy6v7m')
+      whatsapp.add_personalization(
+        {
+          'to' => '+48600000001',
+          'data' => {
+            'header' => ['Order #12345'],
+            'body' => ['John', 'December 31, 2026'],
+            'buttons' => ['orders/12345']
+          }
+        }
+      )
+
+      response = whatsapp.send
+      expect(response.status).to eq(202)
+    end
+  end
+
+  it 'sends to multiple recipients' do
+    VCR.use_cassette('whatsapp/whatsapp_send_multiple_recipients', match_requests_on: %i[method uri body]) do
+      whatsapp.add_from('15550001234')
+      whatsapp.add_to('+48600000001')
+      whatsapp.add_to('+48600000002')
+      whatsapp.add_template_id('23zxk54v6gjy6v7m')
+
+      response = whatsapp.send
+      expect(response.status).to eq(202)
+    end
+  end
+end

data/spec/whatsapp_templates_rspec.rb

@@ -0,0 +1,48 @@
+require 'rspec'
+require 'vcr'
+require 'json'
+
+VCR.configure do |config|
+  config.cassette_library_dir = './fixtures'
+  config.hook_into :webmock
+  config.filter_sensitive_data('<AUTH>') do |interaction|
+    interaction.request.headers['Authorization'][0]
+  end
+end
+
+RSpec.describe Mailersend::WhatsAppTemplates do
+  let(:client) { Mailersend::Client.new(API_TOKEN) }
+  let(:whatsapp_templates) { Mailersend::WhatsAppTemplates.new(client) }
+
+  it 'returns a list of WhatsApp templates' do
+    VCR.use_cassette('whatsapp_templates/whatsapp_templates_list', match_requests_on: %i[method host path query]) do
+      response = whatsapp_templates.list(
+        whatsapp_account_id: '3enl6x27wmrxrl2v',
+        status: 'approved',
+        category: 'UTILITY',
+        language: 'en_US',
+        page: 1,
+        limit: 25
+      )
+      parsed_response = JSON.parse(response.body)
+
+      expect(response.status).to eq(200)
+      expect(parsed_response['data']).to be_an(Array)
+      expect(parsed_response['data'][1]['components']['header']).to be_nil
+      expect(parsed_response['links']['last']).to be_nil
+      expect(parsed_response['meta']).not_to have_key('total')
+    end
+  end
+
+  it 'returns a single WhatsApp template' do
+    VCR.use_cassette('whatsapp_templates/whatsapp_templates_get') do
+      response = whatsapp_templates.get(whatsapp_template_id: '23zxk54v6gjy6v7m')
+      parsed_response = JSON.parse(response.body)
+
+      expect(response.status).to eq(200)
+      expect(parsed_response['data']['name']).to eq('order_confirmation')
+      expect(parsed_response['data']['components']['header']).to eq({ 'format' => 'TEXT', 'text' => '{{1}}' })
+      expect(parsed_response['data']['components']['buttons'][0]['url']).to eq('https://shop.example.com/{{1}}')
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mailersend-ruby
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.4.0
 platform: ruby
 authors:
 - Nikola Milojević
@@ -62,6 +62,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".env.example"
+- ".envrc"
 - ".github/CODEOWNERS"
 - ".github/workflows/main.yml"
 - ".github/workflows/publish_gem.yml"
@@ -97,6 +98,10 @@ files:
 - fixtures/domains/domains_single.yml
 - fixtures/domains/domains_verify.yml
 - fixtures/email/email_send.yml
+- fixtures/email/email_send_template_language.yml
+- fixtures/emails/emails_list_emails.yml
+- fixtures/emails/emails_list_emails_empty_page.yml
+- fixtures/emails/emails_single_email.yml
 - fixtures/inbound_routing/inbound_routing_delete.yml
 - fixtures/inbound_routing/inbound_routing_list.yml
 - fixtures/inbound_routing/inbound_routing_single.yml
@@ -149,6 +154,23 @@ files:
 - fixtures/webhooks/webhooks_delete.yml
 - fixtures/webhooks/webhooks_list.yml
 - fixtures/webhooks/webhooks_single.yml
+- fixtures/whatsapp/whatsapp_send.yml
+- fixtures/whatsapp/whatsapp_send_multiple_recipients.yml
+- fixtures/whatsapp/whatsapp_send_personalization.yml
+- fixtures/whatsapp_activities/whatsapp_activities_list.yml
+- fixtures/whatsapp_inbound_messages/whatsapp_inbound_messages_get.yml
+- fixtures/whatsapp_inbound_messages/whatsapp_inbound_messages_list.yml
+- fixtures/whatsapp_items/whatsapp_items_get.yml
+- fixtures/whatsapp_items/whatsapp_items_list.yml
+- fixtures/whatsapp_messages/whatsapp_messages_get.yml
+- fixtures/whatsapp_messages/whatsapp_messages_list.yml
+- fixtures/whatsapp_recipient/whatsapp_recipient_get.yml
+- fixtures/whatsapp_recipient/whatsapp_recipient_list.yml
+- fixtures/whatsapp_templates/whatsapp_templates_get.yml
+- fixtures/whatsapp_templates/whatsapp_templates_list.yml
+- flake.lock
+- flake.nix
+- lefthook.yml
 - lib/mailersend-ruby.rb
 - lib/mailersend.rb
 - lib/mailersend/activity/activity.rb
@@ -160,6 +182,7 @@ files:
 - lib/mailersend/domains/domains.rb
 - lib/mailersend/email/email.rb
 - lib/mailersend/email_verification/email_verification.rb
+- lib/mailersend/emails/emails.rb
 - lib/mailersend/inbound_routing/inbound_routing.rb
 - lib/mailersend/messages/messages.rb
 - lib/mailersend/recipients/recipients.rb
@@ -177,6 +200,13 @@ files:
 - lib/mailersend/tokens/tokens.rb
 - lib/mailersend/version.rb
 - lib/mailersend/webhooks/webhooks.rb
+- lib/mailersend/whatsapp/whatsapp.rb
+- lib/mailersend/whatsapp_activities/whatsapp_activities.rb
+- lib/mailersend/whatsapp_inbound_messages/whatsapp_inbound_messages.rb
+- lib/mailersend/whatsapp_items/whatsapp_items.rb
+- lib/mailersend/whatsapp_messages/whatsapp_messages.rb
+- lib/mailersend/whatsapp_recipient/whatsapp_recipient.rb
+- lib/mailersend/whatsapp_templates/whatsapp_templates.rb
 - mailersend-ruby.gemspec
 - renovate.json
 - spec/activity_rspec.rb
@@ -185,6 +215,7 @@ files:
 - spec/dmarc_monitoring_rspec.rb
 - spec/domains_rspec.rb
 - spec/email_rspec.rb
+- spec/emails_rspec.rb
 - spec/inbound_routing_rspec.rb
 - spec/messages_rspec.rb
 - spec/recipients_rspec.rb
@@ -200,6 +231,13 @@ files:
 - spec/templates_rspec.rb
 - spec/tokens_rspec.rb
 - spec/webhooks_rspec.rb
+- spec/whatsapp_activities_rspec.rb
+- spec/whatsapp_inbound_messages_rspec.rb
+- spec/whatsapp_items_rspec.rb
+- spec/whatsapp_messages_rspec.rb
+- spec/whatsapp_recipient_rspec.rb
+- spec/whatsapp_rspec.rb
+- spec/whatsapp_templates_rspec.rb
 homepage: https://www.mailersend.com
 licenses:
 - MIT