sendgrid-api 0.0.2 → 0.0.3

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

@@ -0,0 +1,252 @@
+require 'spec_helper'
+
+module Sendgrid
+  module API
+    module Newsletter
+      module Recipients
+        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(:listname) { 'my list' }
+          let(:marketing_email) { Entities::MarketingEmail.new(:name => marketing_email_name) }
+          let(:list) { Entities::List.new(:list => listname) }
+
+          describe '#add' do
+            let(:url) { 'newsletter/recipients/add.json' }
+            let(:stub_post) { sg_mock.stub_post(url, :name => marketing_email_name, :list => listname) }
+            subject { service.add(list, marketing_email) }
+
+            context 'when add a recipient list successfully' do
+              context 'with object' do
+                it_behaves_like 'a success response'
+              end
+
+              context 'with name' do
+                subject { service.add(listname, marketing_email_name) }
+                it_behaves_like 'a success response'
+              end
+            end
+
+            context 'when the list does not exist' do
+              it_behaves_like 'a database error 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/recipients/get.json' }
+            let(:stub_post) { sg_mock.stub_post(url, :name => marketing_email_name) }
+            subject { service.get(marketing_email) }
+
+            context 'when get the recipient lists successfully' do
+              before do
+                stub_post.to_return(:body => fixture('recipients.json'))
+              end
+
+              context 'with object' do
+                it { should have(2).items }
+
+                describe 'first item' do
+                  subject { service.get(marketing_email).first }
+                  its(:list) { should == 'list 1' }
+                end
+              end
+
+              context 'with name' do
+                subject { service.get(marketing_email_name) }
+
+                it { should have(2).items }
+              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/recipients/delete.json' }
+            let(:stub_post) { sg_mock.stub_post(url, :name => marketing_email_name, :list => listname) }
+            subject { service.delete(list, marketing_email) }
+
+            context 'when delete a recipient list successfully' do
+              context 'with object' do
+                it_behaves_like 'a success response'
+              end
+
+              context 'with name' do
+                subject { service.delete(listname, marketing_email_name) }
+                it_behaves_like 'a success response'
+              end
+            end
+
+            context 'when the list does not exist' do
+              it_behaves_like 'a database error 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(:list) { online.list_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 recipient list successfully' do
+                  before do
+                    online.add_marketing_email
+                    online.add_list
+                  end
+                  after do
+                    online.delete_marketing_email
+                    online.delete_list
+                  end
+
+                  it 'adds the recipient list' do
+                    online.add_recipient_list.should be_true
+                  end
+                end
+
+                context 'when the list does not exist' do
+                  before do
+                    online.add_marketing_email
+                  end
+                  after do
+                    online.delete_marketing_email
+                  end
+                  it 'raises an error' do
+                    expect { subject.add(list, marketing_email) }.to raise_error(REST::Errors::Unknown)
+                  end
+                end
+
+                context 'when the marketing email does not exist' do
+                  before do
+                    online.add_list
+                  end
+                  after do
+                    online.delete_list
+                  end
+                  it 'raises an error' do
+                    expect { subject.add(list, marketing_email) }.to raise_error(REST::Errors::Unauthorized)
+                  end
+                end
+              end
+
+              describe '#get' do
+                context 'when get the recipient lists successfully' do
+                  before do
+                    online.add_marketing_email
+                  end
+                  after do
+                    online.delete_marketing_email
+                  end
+                  it 'gets the recipient lists' do
+                    expect { subject.get(marketing_email) }.to_not raise_error
+                  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 a recipient list successfully' do
+                  before do
+                    online.add_marketing_email
+                    online.add_list
+                    online.add_recipient_list
+                  end
+                  after do
+                    online.delete_marketing_email
+                    online.delete_list
+                  end
+
+                  it 'deletes the recipient list' do
+                    subject.delete(list, marketing_email).success?.should be_true
+                  end
+                end
+
+                context 'when the list does not exist' do
+                  before do
+                    online.add_marketing_email
+                  end
+                  after do
+                    online.delete_marketing_email
+                  end
+                  it 'raises an error' do
+                    expect { subject.delete(list, marketing_email) }.to raise_error(REST::Errors::Unknown)
+                  end
+                end
+
+                context 'when the marketing email does not exist' do
+                  before do
+                    online.add_list
+                  end
+                  after do
+                    online.delete_list
+                  end
+                  it 'raises an error' do
+                    expect { subject.delete(list, 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(list, 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(list, marketing_email) }.to raise_error(REST::Errors::Forbidden)
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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