sendgrid-ruby 1.1.6 → 6.6.2

data/spec/sendgrid/helpers/eventwebhook/eventwebhook_spec.rb

@@ -0,0 +1,105 @@
+require 'spec_helper'
+require './spec/fixtures/event_webhook'
+
+describe SendGrid::EventWebhook do
+  describe '.verify_signature' do
+    it 'verifies a valid signature' do
+      unless skip_jruby
+        expect(verify(
+                 Fixtures::EventWebhook::PUBLIC_KEY,
+                 Fixtures::EventWebhook::PAYLOAD,
+                 Fixtures::EventWebhook::SIGNATURE,
+                 Fixtures::EventWebhook::TIMESTAMP
+               )).to be true
+      end
+    end
+
+    it 'rejects a bad key' do
+      unless skip_jruby
+        expect(verify(
+                 Fixtures::EventWebhook::FAILING_PUBLIC_KEY,
+                 Fixtures::EventWebhook::PAYLOAD,
+                 Fixtures::EventWebhook::SIGNATURE,
+                 Fixtures::EventWebhook::TIMESTAMP
+               )).to be false
+      end
+    end
+
+    it 'rejects a bad payload' do
+      unless skip_jruby
+        expect(verify(
+                 Fixtures::EventWebhook::PUBLIC_KEY,
+                 'payload',
+                 Fixtures::EventWebhook::SIGNATURE,
+                 Fixtures::EventWebhook::TIMESTAMP
+               )).to be false
+      end
+    end
+
+    it 'rejects a bad signature' do
+      unless skip_jruby
+        expect(verify(
+                 Fixtures::EventWebhook::PUBLIC_KEY,
+                 Fixtures::EventWebhook::PAYLOAD,
+                 Fixtures::EventWebhook::FAILING_SIGNATURE,
+                 Fixtures::EventWebhook::TIMESTAMP
+               )).to be false
+      end
+    end
+
+    it 'rejects a bad timestamp' do
+      unless skip_jruby
+        expect(verify(
+                 Fixtures::EventWebhook::PUBLIC_KEY,
+                 Fixtures::EventWebhook::PAYLOAD,
+                 Fixtures::EventWebhook::SIGNATURE,
+                 'timestamp'
+               )).to be false
+      end
+    end
+
+    it 'rejects a missing signature' do
+      unless skip_jruby
+        expect(verify(
+                 Fixtures::EventWebhook::PUBLIC_KEY,
+                 Fixtures::EventWebhook::PAYLOAD,
+                 nil,
+                 Fixtures::EventWebhook::TIMESTAMP
+               )).to be false
+      end
+    end
+
+    it 'throws an error when using jruby' do
+      if skip_jruby
+        expect do
+          verify(
+            Fixtures::EventWebhook::PUBLIC_KEY,
+            Fixtures::EventWebhook::PAYLOAD,
+            Fixtures::EventWebhook::SIGNATURE,
+            Fixtures::EventWebhook::TIMESTAMP
+          )
+        end.to raise_error(SendGrid::EventWebhook::NotSupportedError)
+      end
+    end
+  end
+end
+
+describe SendGrid::EventWebhookHeader do
+  it 'sets the signature header constant' do
+    expect(SendGrid::EventWebhookHeader::SIGNATURE).to eq("HTTP_X_TWILIO_EMAIL_EVENT_WEBHOOK_SIGNATURE")
+  end
+
+  it 'sets the timestamp header constant' do
+    expect(SendGrid::EventWebhookHeader::TIMESTAMP).to eq("HTTP_X_TWILIO_EMAIL_EVENT_WEBHOOK_TIMESTAMP")
+  end
+end
+
+def verify(public_key, payload, signature, timestamp)
+  ew = SendGrid::EventWebhook.new
+  ec_public_key = ew.convert_public_key_to_ecdsa(public_key)
+  ew.verify_signature(ec_public_key, payload, signature, timestamp)
+end
+
+def skip_jruby
+  RUBY_PLATFORM == 'java'
+end

data/spec/sendgrid/helpers/ip_management/ip_management_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe SendGrid::IpManagement do
+  let(:sendgrid_client) { SendGrid::API.new(api_key: 'fake_key').client }
+  let(:ip_management) { SendGrid::IpManagement.new(sendgrid_client: sendgrid_client) }
+
+  describe '.new' do
+    it 'initializes correctly' do
+      expect(ip_management).to be_a SendGrid::IpManagement
+    end
+  end
+end

data/spec/sendgrid/helpers/settings/mail_settings_dto_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe SendGrid::MailSettingsDto do
+  let(:sendgrid_client) { SendGrid::API.new(api_key: 'fake_key').client }
+  let(:mail_settings) { SendGrid::MailSettingsDto }
+  let(:setting_name) { 'bcc' }
+  let(:setting_params) { { email: Faker::Internet.email, enabled: rand(1..100).even? } }
+
+  it { should respond_to :bcc }
+  it { should respond_to :address_whitelist }
+  it { should respond_to :bounce_purge }
+  it { should respond_to :footer }
+  it { should respond_to :forward_spam }
+  it { should respond_to :forward_bounce }
+  it { should respond_to :plain_content }
+  it { should respond_to :spam_check }
+  it { should respond_to :template }
+
+  describe '.fetch' do
+    it 'calls get on sendgrid_client' do
+      args = { sendgrid_client: sendgrid_client, name: setting_name, query_params: {} }
+      expect(mail_settings.fetch(**args)).to be_a SendGrid::Response
+    end
+  end
+
+  describe '.update' do
+    it 'calls patch on sendgrid_client' do
+      args = { sendgrid_client: sendgrid_client, name: setting_name, request_body: setting_params }
+      expect(mail_settings.update(**args)).to be_a SendGrid::Response
+    end
+  end
+end

data/spec/sendgrid/helpers/settings/partner_settings_dto_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe SendGrid::PartnerSettingsDto do
+  let(:sendgrid_client) { SendGrid::API.new(api_key: 'fake_key').client }
+  let(:partner_settings) { SendGrid::PartnerSettingsDto }
+  let(:setting_name) { 'new_relic' }
+  let(:setting_params) { { license_key: 'key', enabled: rand(1..100).even? } }
+
+  it { should respond_to :new_relic }
+
+  describe '.fetch' do
+    it 'calls get on sendgrid_client' do
+      args = { sendgrid_client: sendgrid_client, name: setting_name, query_params: {} }
+      expect(partner_settings.fetch(**args)).to be_a SendGrid::Response
+    end
+  end
+
+  describe '.update' do
+    it 'calls patch on sendgrid_client' do
+      args = { sendgrid_client: sendgrid_client, name: setting_name, request_body: setting_params }
+      expect(partner_settings.update(**args)).to be_a SendGrid::Response
+    end
+  end
+end

data/spec/sendgrid/helpers/settings/settings_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe SendGrid::Settings do
+  let(:sendgrid_client) { SendGrid::API.new(api_key: 'fake_key').client }
+  let(:settings) { SendGrid::Settings.new(sendgrid_client: sendgrid_client) }
+
+  describe '.new' do
+    it 'initializes correctly' do
+      expect(settings).to be_a SendGrid::Settings
+    end
+  end
+
+  describe '.bcc' do
+    it 'fetches bcc data' do
+      expect(settings.bcc).to be_a SendGrid::Response
+    end
+  end
+
+  describe '.update_bcc' do
+    it 'updates bcc' do
+      bcc_response = settings.update_bcc(enabled: true, email: 'email@example.com')
+      expect(bcc_response).to be_a SendGrid::Response
+    end
+  end
+end

data/spec/sendgrid/helpers/settings/tracking_settings_dto_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe SendGrid::TrackingSettingsDto do
+  let(:sendgrid_client) { SendGrid::API.new(api_key: 'fake_key').client }
+  let(:tracking_settings) { SendGrid::TrackingSettingsDto }
+  let(:setting_name) { 'open_tracking' }
+  let(:setting_params) { { enabled: rand(1..100).even? } }
+
+  it { should respond_to :open_tracking }
+  it { should respond_to :click_tracking }
+  it { should respond_to :google_analytics }
+  it { should respond_to :subscription_tracking }
+
+  describe '.fetch' do
+    it 'calls get on sendgrid_client' do
+      args = { sendgrid_client: sendgrid_client, name: setting_name, query_params: {} }
+      expect(tracking_settings.fetch(**args)).to be_a SendGrid::Response
+    end
+  end
+
+  describe '.update' do
+    it 'calls patch on sendgrid_client' do
+      args = { sendgrid_client: sendgrid_client, name: setting_name, request_body: setting_params }
+      expect(tracking_settings.update(**args)).to be_a SendGrid::Response
+    end
+  end
+end

data/spec/sendgrid/helpers/settings/user_settings_dto_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe SendGrid::UserSettingsDto do
+  let(:sendgrid_client) { SendGrid::API.new(api_key: 'fake_key').client }
+  let(:user_settings) { SendGrid::UserSettingsDto }
+  let(:setting_name) { 'enforced_tls' }
+  let(:setting_params) { { require_tls: rand(1..100).even? } }
+
+  it { should respond_to :enforced_tls }
+
+  describe '.fetch' do
+    it 'calls get on sendgrid_client' do
+      args = { sendgrid_client: sendgrid_client, name: setting_name, query_params: {} }
+      expect(user_settings.fetch(**args)).to be_a SendGrid::Response
+    end
+  end
+
+  describe '.update' do
+    it 'calls patch on sendgrid_client' do
+      args = { sendgrid_client: sendgrid_client, name: setting_name, request_body: setting_params }
+      expect(user_settings.update(**args)).to be_a SendGrid::Response
+    end
+  end
+end

data/spec/sendgrid/helpers/stats/email_stats_spec.rb

@@ -0,0 +1,111 @@
+require 'spec_helper'
+
+describe SendGrid::EmailStats do
+  let(:sg_client) { SendGrid::API.new(api_key: 'abcd').client }
+  let(:stats) { SendGrid::EmailStats.new(sendgrid_client: sg_client) }
+  let(:sg_response) { double('SendGrid::Response') }
+
+  let(:sample_response) do
+    [{
+      'date' => '2017-10-01',
+      'stats' => [
+        { 'metrics' =>
+          {
+            'blocks' => 101,
+            'bounce_drops' => 102,
+            'bounces' => 103,
+            'clicks' => 104,
+            'deferred' => 105,
+            'delivered' => 106,
+            'invalid_emails' => 107,
+            'opens' => 108,
+            'processed' => 109,
+            'requests' => 110,
+            'spam_report_drops' => 111,
+            'spam_reports' => 112,
+            'unique_clicks' => 113,
+            'unique_opens' => 114,
+            'unsubscribe_drops' => 115,
+            'unsubscribes' => 116
+          } }
+      ]
+    }]
+  end
+
+  let(:error_response) do
+    {
+      'errors' => [
+        {
+          'message' => 'end_date should be a YYYY-MM-DD formatted date'
+        }
+      ]
+    }
+  end
+
+  describe '.new' do
+    it 'initializes with SendGrid::Client' do
+      expect(stats).to be_a SendGrid::EmailStats
+    end
+  end
+
+  describe 'successful response' do
+    before do
+      allow_any_instance_of(SendGrid::Response).to receive(:body) { sample_response.to_json }
+    end
+
+    describe '#by_day' do
+      it 'fetches data aggregated by day' do
+        day_stats = stats.by_day('2017-10-01', '2017-10-02')
+        day_metrics = day_stats.metrics.first
+
+        expect(day_metrics).to be_a SendGrid::Metrics
+        expect(day_metrics.date.to_s).to eq('2017-10-01')
+        expect(day_metrics.requests).to eq(110)
+        expect(day_metrics.clicks).to eq(104)
+        expect(day_metrics.bounces).to eq(103)
+        expect(day_metrics.opens).to eq(108)
+      end
+    end
+
+    describe '#by_week' do
+      it 'fetches data aggregated by week' do
+        day_stats = stats.by_week('2017-10-01', '2017-10-12')
+        day_metrics = day_stats.metrics.first
+
+        expect(day_metrics).to be_a SendGrid::Metrics
+        expect(day_metrics.date.to_s).to eq('2017-10-01')
+        expect(day_metrics.requests).to eq(110)
+        expect(day_metrics.clicks).to eq(104)
+        expect(day_metrics.bounces).to eq(103)
+        expect(day_metrics.opens).to eq(108)
+      end
+    end
+
+    describe '#by_month' do
+      it 'fetches data aggregated by month' do
+        day_stats = stats.by_month('2017-10-01', '2017-11-01')
+        day_metrics = day_stats.metrics.first
+
+        expect(day_metrics).to be_a SendGrid::Metrics
+        expect(day_metrics.date.to_s).to eq('2017-10-01')
+        expect(day_metrics.requests).to eq(110)
+        expect(day_metrics.clicks).to eq(104)
+        expect(day_metrics.bounces).to eq(103)
+        expect(day_metrics.opens).to eq(108)
+      end
+    end
+  end
+
+  describe 'error response' do
+    before do
+      allow_any_instance_of(SendGrid::Response).to receive(:body) { error_response.to_json }
+    end
+
+    it 'fetches data aggregated by month' do
+      day_stats = stats.by_month('2017-10-01', '2017-10-02')
+
+      expect(day_stats.errors).to include('end_date should be a YYYY-MM-DD formatted date')
+      expect(day_stats.error?).to be_truthy
+    end
+  end
+end

data/spec/sendgrid/helpers/stats/metrics_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe SendGrid::Metrics do
+  let(:params) do
+    {
+      'date' => '2017-10-01',
+      'blocks' => 101,
+      'bounce_drops' => 102,
+      'bounces' => 103,
+      'clicks' => 104,
+      'deferred' => 105,
+      'delivered' => 106,
+      'invalid_emails' => 107,
+      'opens' => 108,
+      'processed' => 109,
+      'requests' => 110,
+      'spam_report_drops' => 111,
+      'spam_reports' => 112,
+      'unique_clicks' => 113,
+      'unique_opens' => 114,
+      'unsubscribe_drops' => 115,
+      'unsubscribes' => 116
+    }
+  end
+
+  subject { described_class.new(params) }
+
+  it 'initializes with metric parameters' do
+    expect(subject).to be_a SendGrid::Metrics
+  end
+
+  it 'returns date as object' do
+    expect(subject.date).to be_a Date
+  end
+
+  %w[
+    blocks bounce_drops bounces clicks deferred delivered invalid_emails
+    opens processed requests spam_report_drops spam_reports unique_clicks
+    unique_opens unsubscribe_drops unsubscribes
+  ].each do |attribute|
+    it "responds to #{attribute}" do
+      expect(subject).to respond_to(attribute.to_sym)
+    end
+  end
+end

data/spec/sendgrid/helpers/stats/stats_response_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+
+describe SendGrid::StatsResponse do
+  let(:params) do
+    [{
+      'date' => '2017-10-01',
+      'stats' => [
+        { 'metrics' =>
+          {
+            'blocks' => 101,
+            'bounce_drops' => 102,
+            'bounces' => 103,
+            'clicks' => 104,
+            'deferred' => 105,
+            'delivered' => 106,
+            'invalid_emails' => 107,
+            'opens' => 108,
+            'processed' => 109,
+            'requests' => 110,
+            'spam_report_drops' => 111,
+            'spam_reports' => 112,
+            'unique_clicks' => 113,
+            'unique_opens' => 114,
+            'unsubscribe_drops' => 115,
+            'unsubscribes' => 116
+          } }
+      ]
+    }]
+  end
+
+  subject { described_class.new(params) }
+
+  it 'initialized with JSON response body' do
+    expect(subject).to be_a SendGrid::StatsResponse
+  end
+
+  describe '#metrics' do
+    it 'returns an array of metrics' do
+      metric = subject.metrics.first
+
+      expect(subject.metrics).to be_a Array
+      expect(metric.date.to_s).to eq('2017-10-01')
+      expect(metric.requests).to eq(110)
+      expect(metric.clicks).to eq(104)
+      expect(metric.bounces).to eq(103)
+      expect(metric.opens).to eq(108)
+    end
+  end
+
+  context 'errors' do
+    let(:error_params) do
+      {
+        'errors' => [
+          {
+            'message' => 'end_date should be a YYYY-MM-DD formatted date'
+          }
+        ]
+      }
+    end
+
+    subject { described_class.new(error_params) }
+
+    describe '#errors' do
+      it 'shows a list of errors' do
+        expect(subject.errors).to include('end_date should be a YYYY-MM-DD formatted date')
+      end
+    end
+
+    describe '#error?' do
+      it 'returns true if there is an error' do
+        expect(subject.error?).to be_truthy
+      end
+    end
+  end
+end

data/spec/sendgrid/sendgrid_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe SendGrid::API do
+  describe '.new' do
+    it 'initializes correctly' do
+      mail_client = SendGrid::API.new(api_key: 'fake_key')
+      expect(mail_client.request_headers['Authorization']).to eq('Bearer fake_key')
+      expect(mail_client.host).to eq('https://api.sendgrid.com')
+    end
+  end
+end

data/spec/sendgrid/twilio_email_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe TwilioEmail::API do
+  describe '.new' do
+    it 'initializes correctly' do
+      mail_client = TwilioEmail::API.new(username: 'username', password: 'password')
+      expect(mail_client.request_headers['Authorization']).to eq('Basic dXNlcm5hbWU6cGFzc3dvcmQ=')
+      expect(mail_client.host).to eq('https://email.twilio.com')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1 +1,12 @@
-require_relative '../lib/sendgrid-ruby'
+require 'simplecov'
+SimpleCov.start
+require 'rubygems'
+require 'bundler/setup'
+require 'pry'
+require 'faker'
+
+RSpec.configure do |config|
+  Dir["#{File.dirname(__FILE__)}/../lib/sendgrid-ruby.rb"].sort.each { |ext| require ext }
+
+  config.color = true
+end

data/test/sendgrid/helpers/mail/test_attachment.rb

@@ -0,0 +1,33 @@
+require_relative "../../../../lib/sendgrid/helpers/mail/attachment"
+include SendGrid
+require "json"
+require "minitest/autorun"
+
+class TestAttachment < Minitest::Test
+  SAMPLE_INPUT = "Es blüht so grün wie Blüten blüh'n im Frühling
+Es blüht so grün wie Blüten blüh'n im Frühling
+Es blüht so grün wie Blüten blüh'n im Frühling
+Es blüht so grün wie Blüten blüh'n im Frühling
+Es blüht so grün wie Blüten blüh'n im Frühling
+".force_encoding('UTF-8').encode
+
+  def setup; end
+
+  def test_io_enocding
+    attachment = Attachment.new
+    attachment.content = StringIO.new(SAMPLE_INPUT)
+
+    expected = {
+      "content" => "RXMgYmzDvGh0IHNvIGdyw7xuIHdpZSBCbMO8dGVuIGJsw7xoJ24gaW0gRnLD\nvGhsaW5nCkVzIGJsw7xodCBzbyBncsO8biB3aWUgQmzDvHRlbiBibMO8aCdu\nIGltIEZyw7xobGluZwpFcyBibMO8aHQgc28gZ3LDvG4gd2llIEJsw7x0ZW4g\nYmzDvGgnbiBpbSBGcsO8aGxpbmcKRXMgYmzDvGh0IHNvIGdyw7xuIHdpZSBC\nbMO8dGVuIGJsw7xoJ24gaW0gRnLDvGhsaW5nCkVzIGJsw7xodCBzbyBncsO8\nbiB3aWUgQmzDvHRlbiBibMO8aCduIGltIEZyw7xobGluZwo=\n"
+    }
+
+    json = attachment.to_json
+
+    # Double check that the decoded json matches original input.
+    decoded = Base64.decode64(json["content"]).force_encoding('UTF-8').encode
+
+    assert_equal(decoded, SAMPLE_INPUT)
+
+    assert_equal(json, expected)
+  end
+end

data/test/sendgrid/helpers/mail/test_category.rb

@@ -0,0 +1,25 @@
+require_relative '../../../../lib/sendgrid/helpers/mail/mail'
+require 'minitest/autorun'
+
+class TestCategory < Minitest::Test
+  include SendGrid
+
+  def setup
+    @category = Category.new(name: 'foo')
+  end
+
+  def test_aliases
+    assert_equal @category.method(:name), @category.method(:category)
+  end
+
+  def test_name
+    assert_equal @category.name, 'foo'
+  end
+
+  def test_to_json
+    expected_json = {
+      'category' => 'foo'
+    }
+    assert_equal @category.to_json, expected_json
+  end
+end

data/test/sendgrid/helpers/mail/test_email.rb

@@ -0,0 +1,41 @@
+require_relative '../../../../lib/sendgrid/helpers/mail/email'
+require 'minitest/autorun'
+
+class TestEmail < Minitest::Test
+  include SendGrid
+
+  def test_split_email_full_email
+    @email = Email.new(email: 'Example User <test1@example.com>')
+    expected_json = {
+      'email' => 'test1@example.com',
+      'name' => 'Example User'
+    }
+    assert_equal @email.to_json, expected_json
+  end
+
+  def test_split_email_only_email
+    @email = Email.new(email: 'test1@example.com')
+    expected_json = {
+      'email' => 'test1@example.com'
+    }
+    assert_equal @email.to_json, expected_json
+  end
+
+  def test_split_email_name_and_email
+    @email = Email.new(name: 'Example User', email: 'test1@example.com')
+    expected_json = {
+      'email' => 'test1@example.com',
+      'name' => 'Example User'
+    }
+    assert_equal @email.to_json, expected_json
+  end
+
+  def test_mandatory_email_missing
+    assert_raises(ArgumentError) { Email.new(email: nil) }
+    assert_raises(ArgumentError) { Email.new(email: "") }
+  end
+
+  def test_invalid_email
+    assert_raises(ArgumentError) { Email.new(email: "some-invalid-string") }
+  end
+end