parity-sendgrid-api 0.0.4

data/spec/sendgrid/api/newsletter/schedule_spec.rb

@@ -0,0 +1,263 @@
+require 'spec_helper'
+
+module Sendgrid
+  module API
+    module Newsletter
+      module Schedule
+        describe Services do
+
+          subject { service }
+          let(:service) { described_class.new(resource) }
+          let(:resource) { REST::Resource.new(user, key) }
+          let(:user) { 'my_user' }
+          let(:key) { 'my_key' }
+          let(:sg_mock) { Sendgrid::Mock.new(user, key) }
+
+          let(:marketing_email_name) { 'my marketing email' }
+          let(:marketing_email) { Entities::MarketingEmail.new(:name => marketing_email_name) }
+
+          describe '#add' do
+            let(:url) { 'newsletter/schedule/add.json' }
+            let(:stub_post) { sg_mock.stub_post(url, :name => marketing_email_name) }
+            subject { service.add(marketing_email) }
+
+            context 'when add a schedule successfully' do
+              context 'with object' do
+                it_behaves_like 'a success response'
+              end
+
+              context 'with name' do
+                subject { service.add(marketing_email_name) }
+                it_behaves_like 'a success response'
+              end
+
+              context 'with after option' do
+                let(:after) { 10 }
+                let(:stub_post) { sg_mock.stub_post(url, :name => marketing_email_name, :after => after.to_s) }
+                subject { service.add(marketing_email_name, :after => after) }
+                it_behaves_like 'a success response'
+              end
+
+              context 'with at option' do
+                context 'when at is a string object' do
+                  let(:at) { 'time in string' }
+                  let(:stub_post) { sg_mock.stub_post(url, :name => marketing_email_name, :at => at) }
+                  subject { service.add(marketing_email_name, :at => at) }
+                  it_behaves_like 'a success response'
+                end
+
+                context 'when at is a time object' do
+                  let(:at) { Time.now }
+                  let(:stub_post) { sg_mock.stub_post(url, :name => marketing_email_name, :at => at.strftime('%Y-%m-%d %H:%M:%S%:z')) }
+                  subject { service.add(marketing_email_name, :at => at) }
+                  it_behaves_like 'a success response'
+                end
+              end
+
+              context 'with invalid options' do
+                let(:other) { 'other' }
+                let(:stub_post) { sg_mock.stub_post(url, :name => marketing_email_name) }
+                subject { service.add(marketing_email_name, :other => other) }
+                it_behaves_like 'a success response'
+              end
+            end
+
+            context 'when the schedule params are invalid' do
+              it_behaves_like 'an invalid fields response'
+            end
+
+            context 'when the marketing email does not exist' do
+              it_behaves_like 'a does not exist response'
+            end
+
+            context 'when permission failed' do
+              it_behaves_like 'a forbidden response'
+            end
+          end
+
+          describe '#get' do
+            let(:url) { 'newsletter/schedule/get.json' }
+            let(:stub_post) { sg_mock.stub_post(url, :name => marketing_email_name) }
+            subject { service.get(marketing_email) }
+
+            context 'when get the schedule successfully' do
+              before do
+                stub_post.to_return(:body => fixture('schedule.json'))
+              end
+
+              context 'with object' do
+                its(:date) { should == '2013-10-30 18:01:40' }
+              end
+
+              context 'with name' do
+                subject { service.get(marketing_email_name) }
+                its(:date) { should == '2013-10-30 18:01:40' }
+              end
+            end
+
+            context 'when the marketing email does not exist' do
+              it_behaves_like 'a does not exist response'
+            end
+
+            context 'when permission failed' do
+              it_behaves_like 'a forbidden response'
+            end
+          end
+
+          describe '#delete' do
+            let(:url) { 'newsletter/schedule/delete.json' }
+            let(:stub_post) { sg_mock.stub_post(url, :name => marketing_email_name) }
+            subject { service.delete(marketing_email) }
+
+            context 'when delete the schedule successfully' do
+              context 'with object' do
+                it_behaves_like 'a success response'
+              end
+
+              context 'with name' do
+                subject { service.delete(marketing_email_name) }
+                it_behaves_like 'a success response'
+              end
+            end
+
+            context 'when there is no previous schedule' do
+              it_behaves_like 'a not scheduled response'
+            end
+
+            context 'when the marketing email does not exist' do
+              it_behaves_like 'a does not exist response'
+            end
+
+            context 'when permission failed' do
+              it_behaves_like 'a forbidden response'
+            end
+          end
+
+          describe 'online tests', :online => true do
+            include_examples 'online tests'
+            let(:online) { Online.new(env_user, env_key) }
+            let(:marketing_email) { online.marketing_email_example }
+            let(:client) { online.client }
+
+            context 'when credentials are valid' do
+              let(:resource) { REST::Resource.new(env_user, env_key) }
+
+              describe '#add' do
+                context 'when add a schedule successfully' do
+                  before do
+                    online.add_marketing_email_with_list
+                  end
+                  after do
+                    online.delete_marketing_email_with_list
+                  end
+                  context 'with after option' do
+                    it 'schedules a marketing email' do
+                      subject.add(marketing_email, :after => 10).success?.should be_true
+                    end
+                  end
+                  context 'with at option' do
+                    it 'schedules a marketing email' do
+                      subject.add(marketing_email, :at => (Time.now + 10*60)).success?.should be_true
+                    end
+                  end
+                end
+
+                context 'when the schedule params are invalid' do
+                  before do
+                    online.add_marketing_email
+                  end
+                  after do
+                    online.delete_marketing_email
+                  end
+                  it 'raises an error' do
+                    expect { subject.add(marketing_email, :at => '2013') }.to raise_error(REST::Errors::BadRequest)
+                  end
+                end
+
+                context 'when the marketing email does not exist' do
+                  it 'raises an error' do
+                    expect { subject.add(marketing_email) }.to raise_error(REST::Errors::Unauthorized)
+                  end
+                end
+              end
+
+              describe '#get' do
+                context 'when get the schedule successfully' do
+                  before do
+                    online.add_marketing_email_with_list
+                    subject.add(marketing_email, :after => 10)
+                  end
+                  after do
+                    online.delete_marketing_email_with_list
+                  end
+                  it 'gets the schedule' do
+                    subject.get(marketing_email).date.should_not be_empty
+                  end
+                end
+
+                context 'when the marketing email does not exist' do
+                  it 'raises an error' do
+                    expect { subject.get(marketing_email) }.to raise_error(REST::Errors::Unauthorized)
+                  end
+                end
+              end
+
+              describe '#delete' do
+                context 'when delete the schedule successfully' do
+                  before do
+                    online.add_marketing_email_with_list
+                    subject.add(marketing_email, :after => 10)
+                  end
+                  after do
+                    online.delete_marketing_email_with_list
+                  end
+                  it 'deletes the schedule' do
+                    subject.delete(marketing_email).success?.should be_true
+                  end
+                end
+
+                context 'when there is no previous schedule' do
+                  before do
+                    online.add_marketing_email
+                  end
+                  after do
+                    online.delete_marketing_email
+                  end
+                  it 'raises an error' do
+                    expect { subject.delete(marketing_email) }.to raise_error(REST::Errors::Unauthorized)
+                  end
+                end
+
+                context 'when the marketing email does not exist' do
+                  it 'raises an error' do
+                    expect { subject.delete(marketing_email) }.to raise_error(REST::Errors::Unauthorized)
+                  end
+                end
+              end
+            end
+
+            context 'when credentials are invalid' do
+              describe '#add' do
+                it 'raises an error' do
+                  expect { subject.add(marketing_email) }.to raise_error(REST::Errors::Forbidden)
+                end
+              end
+
+              describe '#get' do
+                it 'raises an error' do
+                  expect { subject.get(marketing_email) }.to raise_error(REST::Errors::Forbidden)
+                end
+              end
+
+              describe '#delete' do
+                it 'raises an error' do
+                  expect { subject.delete(marketing_email) }.to raise_error(REST::Errors::Forbidden)
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/sendgrid/api/newsletter/sender_addresses_spec.rb

@@ -0,0 +1,300 @@
+require 'spec_helper'
+
+module Sendgrid
+  module API
+    module Newsletter
+      module SenderAddresses
+        describe Services do
+
+          subject { service }
+          let(:service) { described_class.new(resource) }
+          let(:resource) { REST::Resource.new(user, key) }
+          let(:user) { 'my_user' }
+          let(:key) { 'my_key' }
+          let(:sg_mock) { Sendgrid::Mock.new(user, key) }
+
+          let(:sender_address) { Entities::SenderAddress.new(:identity => identity, :email => email) }
+          let(:identity) { 'my sender address' }
+          let(:email) { 'john@example.com' }
+
+          describe '#add' do
+            let(:url) { 'newsletter/identity/add.json' }
+            let(:stub_post) { sg_mock.stub_post(url, sender_address.as_json) }
+            subject { service.add(sender_address) }
+
+            context 'when add a sender address successfully' do
+              it_behaves_like 'a success response'
+            end
+
+            context 'when the sender address already exists' do
+              it_behaves_like 'an unauthorized response'
+            end
+
+            context 'when the sender address is invalid' do
+              it_behaves_like 'an invalid fields response'
+            end
+
+            context 'when permission failed' do
+              it_behaves_like 'a forbidden response'
+            end
+          end
+
+          describe '#edit' do
+            let(:url) { 'newsletter/identity/edit.json' }
+            let(:stub_post) { sg_mock.stub_post(url, sender_address.as_json) }
+            subject { service.edit(sender_address) }
+
+            context 'when edit a sender address successfully' do
+              it_behaves_like 'a success response'
+            end
+
+            context 'when edit the sender address identity successfully' do
+              let(:stub_post) { sg_mock.stub_post(url, sender_address.as_json.merge(:newidentity => new_identity)) }
+              let(:new_identity) { 'my new sender address' }
+              subject { service.edit(sender_address, new_identity) }
+              it_behaves_like 'a success response'
+            end
+
+            context 'when the sender address is invalid' do
+              it_behaves_like 'a does not exist response'
+            end
+
+            context 'when permission failed' do
+              it_behaves_like 'a forbidden response'
+            end
+          end
+
+          describe '#get' do
+            let(:url) { 'newsletter/identity/get.json' }
+            let(:stub_post) { sg_mock.stub_post(url, :identity => identity) }
+            subject { service.get(sender_address) }
+
+            context 'when get the sender address successfully' do
+              before do
+                stub_post.to_return(:body => fixture('sender_addresses/sender_address.json'))
+              end
+
+              context 'with name' do
+                subject { service.get(identity) }
+                its(:identity) { should == 'sendgrid' }
+              end
+
+              context 'with object' do
+                its(:identity) { should == 'sendgrid' }
+              end
+            end
+
+            context 'when the sender address is not found' do
+              before do
+                stub_post.to_return(:body => fixture('errors/does_not_exist.json'), :status => 401)
+              end
+
+              it 'raises an error' do
+                expect { subject }.to raise_error(REST::Errors::Unauthorized)
+              end
+            end
+
+            context 'when permission failed' do
+              it_behaves_like 'a forbidden response'
+            end
+          end
+
+          describe '#list' do
+            let(:url) { 'newsletter/identity/list.json' }
+            let(:stub_post) { sg_mock.stub_post(url) }
+            subject { service.list }
+
+            context 'when list sender addresses successfully' do
+              before do
+                stub_post.to_return(:body => fixture('sender_addresses/sender_addresses.json'))
+              end
+              it { should have(3).items }
+              describe 'first item' do
+                subject { service.list.first }
+                its(:identity) { should == 'sendgrid' }
+              end
+            end
+
+            context 'when permission failed' do
+              it_behaves_like 'a forbidden response'
+            end
+          end
+
+          describe '#delete' do
+            let(:url) { 'newsletter/identity/delete.json' }
+            let(:stub_post) { sg_mock.stub_post(url, :identity => identity) }
+            subject { service.delete(sender_address) }
+
+            context 'when delete the sender address successfully' do
+              it_behaves_like 'a success response'
+            end
+
+            context 'when the sender address is not found' do
+              it_behaves_like 'a does not exist response'
+            end
+
+            context 'when permission failed' do
+              it_behaves_like 'a forbidden response'
+            end
+          end
+
+          describe 'online tests', :online => true do
+            include_examples 'online tests'
+            let(:online) { Online.new(env_user, env_key) }
+            let(:sender_address) { online.sender_address_example }
+
+            context 'when credentials are valid' do
+              let(:resource) { REST::Resource.new(env_user, env_key) }
+
+              describe '#add' do
+                context 'when add a sender address successfully' do
+                  after do
+                    subject.delete(sender_address)
+                  end
+                  it 'adds the sender address' do
+                    subject.add(sender_address).success?.should be_true
+                  end
+                end
+
+                context 'when the sender address already exists' do
+                  before do
+                    subject.add(sender_address)
+                  end
+                  after do
+                    subject.delete(sender_address)
+                  end
+                  it 'raises an error' do
+                    expect { subject.add(sender_address) }.to raise_error(Sendgrid::API::REST::Errors::Unauthorized)
+                  end
+                end
+
+                context 'when the sender address is invalid' do
+                  let(:email) { nil }
+                  it 'raises an error' do
+                    sender_address.email = email
+                    expect { subject.add(sender_address) }.to raise_error(Sendgrid::API::REST::Errors::BadRequest)
+                  end
+                end
+              end
+
+              describe '#edit' do
+                context 'when edit a sender address successfully' do
+                  let(:address) { 'new address' }
+                  before do
+                    subject.add(sender_address)
+                  end
+                  after do
+                    subject.delete(sender_address)
+                  end
+                  it 'edits the sender address' do
+                    sender_address.address = address
+                    subject.edit(sender_address).success?.should be_true
+                  end
+                end
+
+                context 'when edit the sender address identity successfully' do
+                  let(:newidentity) { 'sendgrid-api sender address new' }
+                  before do
+                    subject.add(sender_address)
+                  end
+                  after do
+                    subject.delete(newidentity)
+                  end
+                  it 'edits the sender address' do
+                    subject.edit(sender_address, newidentity).success?.should be_true
+                  end
+                end
+
+                context 'when the sender address is invalid' do
+                  it 'raises an error' do
+                    expect { subject.edit(sender_address) }.to raise_error(Sendgrid::API::REST::Errors::Unauthorized)
+                  end
+                end
+              end
+
+              describe '#get' do
+                context 'when get the sender address successfully' do
+                  before do
+                    subject.add(sender_address)
+                  end
+                  after do
+                    subject.delete(sender_address)
+                  end
+                  it 'edits the sender address' do
+                    sender = subject.get(sender_address)
+                    sender.name.should == sender_address.name
+                    sender.address.should == sender_address.address
+                  end
+                end
+
+                context 'when the sender address is not found' do
+                  it 'raises an error' do
+                    expect { subject.edit(sender_address) }.to raise_error(Sendgrid::API::REST::Errors::Unauthorized)
+                  end
+                end
+              end
+
+              describe '#list' do
+                context 'when list sender addresses successfully' do
+                  it 'gets all the sender addresses' do
+                    subject.list.should_not be_empty
+                  end
+                end
+              end
+
+              describe '#delete' do
+                context 'when delete the sender address successfully' do
+                  before do
+                    subject.add(sender_address)
+                  end
+                  it 'deletes the sender address' do
+                    subject.delete(sender_address).success?.should be_true
+                  end
+                end
+
+                context 'when the sender address is not found' do
+                  it 'raises an error' do
+                    expect { subject.delete(sender_address) }.to raise_error(Sendgrid::API::REST::Errors::Unauthorized)
+                  end
+                end
+              end
+            end
+
+            context 'when credentials are invalid' do
+              describe '#add' do
+                it 'raises an error' do
+                  expect { subject.add(sender_address) }.to raise_error(REST::Errors::Forbidden)
+                end
+              end
+
+              describe '#edit' do
+                it 'raises an error' do
+                  expect { subject.edit(sender_address) }.to raise_error(REST::Errors::Forbidden)
+                end
+              end
+
+              describe '#get' do
+                it 'raises an error' do
+                  expect { subject.get(sender_address) }.to raise_error(REST::Errors::Forbidden)
+                end
+              end
+
+              describe '#list' do
+                it 'raises an error' do
+                  expect { subject.list }.to raise_error(REST::Errors::Forbidden)
+                end
+              end
+
+              describe '#delete' do
+                it 'raises an error' do
+                  expect { subject.delete(sender_address) }.to raise_error(REST::Errors::Forbidden)
+                end
+              end
+            end
+          end
+
+        end
+      end
+    end
+  end
+end