parity-sendgrid-api 0.0.4

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

@@ -0,0 +1,265 @@
+require 'spec_helper'
+
+module Sendgrid
+  module API
+    module Newsletter
+      module Emails
+        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(:listname) { 'my list' }
+          let(:email) { Entities::Email.new(:email => 'john@example.com', :name => 'John') }
+          let(:email2) { Entities::Email.new(:email => 'brian@example.com', :name => 'Brian') }
+          let(:emails) { [email, email2] }
+
+          describe '#add' do
+            let(:url) { 'newsletter/lists/email/add.json' }
+
+            context 'when add an email successfully' do
+              before do
+                sg_mock.stub_post(url, :list => listname, :data => [email.to_json]).
+                  to_return(:body => {:inserted => 1}.to_json)
+              end
+              subject { service.add(listname, email) }
+              its(:inserted) { should == 1 }
+              its(:any?) { should be_true }
+              its(:none?) { should be_false }
+            end
+
+            context 'when add multiple emails successfully' do
+              before do
+                sg_mock.stub_post(url, :list => listname, :data => emails.map(&:to_json)).
+                  to_return(:body => {:inserted => 2}.to_json)
+              end
+              subject { service.add(listname, emails) }
+              its(:inserted) { should == 2 }
+              its(:any?) { should be_true }
+              its(:none?) { should be_false }
+            end
+
+            context 'when add an email that already exists' do
+              before do
+                sg_mock.stub_post(url, :list => listname, :data => [email.to_json]).
+                  to_return(:body => {:inserted => 0}.to_json)
+              end
+              subject { service.add(listname, email) }
+              its(:inserted) { should == 0 }
+              its(:any?) { should be_false }
+              its(:none?) { should be_true }
+            end
+
+            context 'when permission failed' do
+              let(:stub_post) { sg_mock.stub_post(url, :list => listname, :data => [email.to_json]) }
+              subject { service.add(listname, email) }
+              it_behaves_like 'a forbidden response'
+            end
+          end
+
+          describe '#get' do
+            let(:url) { 'newsletter/lists/email/get.json' }
+
+            context 'when get all emails successfully' do
+              before do
+                sg_mock.stub_post(url, :list => listname).
+                  to_return(:body => fixture('emails/emails.json'))
+              end
+              let(:response) { service.get(listname) }
+              subject { response }
+              it { should have(2).items }
+              describe 'first result' do
+                subject { response.first }
+                its(:email) { should == 'john@example.com' }
+                its(:name) { should == 'John' }
+              end
+            end
+
+            context 'when get an email successfully' do
+              before do
+                sg_mock.stub_post(url, :list => listname, :email => [email.email]).
+                  to_return(:body => fixture('emails/email.json'))
+              end
+              let(:response) { service.get(listname, email) }
+              subject { response }
+              it { should have(1).item }
+              describe 'first result' do
+                subject { response.first }
+                its(:email) { should == 'john@example.com' }
+                its(:name) { should == 'John' }
+              end
+            end
+
+            context 'when permission failed' do
+              let(:stub_post) { sg_mock.stub_post(url, :list => listname) }
+              subject { service.get(listname) }
+              it_behaves_like 'a forbidden response'
+            end
+          end
+
+          describe '#delete' do
+            let(:url) { 'newsletter/lists/email/delete.json' }
+
+            context 'when delete an email successfully' do
+              before do
+                sg_mock.stub_post(url, :list => listname, :email => [email.email]).
+                  to_return(:body =>  {:removed => 1}.to_json)
+              end
+              let(:response) { service.delete(listname, email) }
+              subject { response }
+              its(:removed) { should == 1 }
+              its(:any?) { should be_true }
+              its(:none?) { should be_false }
+            end
+
+            context 'when delete multiple emails successfully' do
+              before do
+                sg_mock.stub_post(url, :list => listname, :email => emails.map(&:email)).
+                  to_return(:body =>  {:removed => 2}.to_json)
+              end
+              let(:response) { service.delete(listname, emails) }
+              subject { response }
+              its(:removed) { should == 2 }
+              its(:any?) { should be_true }
+              its(:none?) { should be_false }
+            end
+
+            context 'when no emails were deleted' do
+              before do
+                sg_mock.stub_post(url, :list => listname, :email => [email.email]).
+                  to_return(:body =>  {:removed => 0}.to_json)
+              end
+              let(:response) { service.delete(listname, email) }
+              subject { response }
+              its(:removed) { should == 0 }
+              its(:any?) { should be_false }
+              its(:none?) { should be_true }
+            end
+
+            context 'when permission failed' do
+              let(:stub_post) { sg_mock.stub_post(url, :list => listname, :email => [email.email]) }
+              subject { service.delete(listname, email) }
+              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(:list) { online.list_example }
+            let(:emails) { online.emails_example }
+            let(:email) { emails.first }
+
+            context 'when credentials are valid' do
+              let(:lists) { Newsletter::Lists::Services.new(resource) }
+              let(:resource) { REST::Resource.new(env_user, env_key) }
+
+              before do
+                lists.add(list).success? or raise 'could not create the list'
+              end
+              after do
+                lists.delete(list).success? or raise 'could not remove the created list'
+              end
+
+              describe '#add' do
+                context 'when add an email successfully' do
+                  it 'adds the email' do
+                    response = subject.add(list, email)
+                    response.any?.should be_true
+                    response.inserted.should == 1
+                  end
+                end
+
+                context 'when add multiple emails successfully' do
+                  it 'adds the emails' do
+                    response = subject.add(list, emails)
+                    response.any?.should be_true
+                    response.inserted.should == 2
+                  end
+                end
+
+                context 'when add an email that already exists' do
+                  before do
+                    subject.add(list, email)
+                  end
+                  it 'do not add the email' do
+                    response = subject.add(list, email)
+                    response.any?.should be_false
+                    response.inserted.should == 0
+                  end
+                end
+              end
+
+              describe '#get' do
+                before do
+                  service.add(list, emails)
+                end
+
+                context 'when get all emails successfully' do
+                  it 'gets the emails' do
+                    response = subject.get(list)
+                    response.should have(2).items
+                  end
+                end
+
+                context 'when get an email successfully' do
+                  it 'gets the email' do
+                    response = subject.get(list, email)
+                    response.should have(1).item
+                  end
+                end
+              end
+
+              describe '#delete' do
+                before do
+                  service.add(list, emails)
+                end
+
+                context 'when delete an email successfully' do
+                  it 'deletes the email' do
+                    response = service.delete(list, email)
+                    response.any?.should be_true
+                    response.removed.should == 1
+                  end
+                end
+
+                context 'when delete multiple emails successfully' do
+                  it 'deletes the emails' do
+                    response = service.delete(list, emails)
+                    response.any?.should be_true
+                    response.removed.should == 2
+                  end
+                end
+              end
+            end
+
+            context 'when credentials are invalid' do
+              describe '#add' do
+                it 'raises an error' do
+                  expect { subject.add(list, email) }.to raise_error(REST::Errors::Forbidden)
+                end
+              end
+
+              describe '#get' do
+                it 'raises an error' do
+                  expect { subject.get(list, email) }.to raise_error(REST::Errors::Forbidden)
+                end
+              end
+
+              describe '#delete' do
+                it 'raises an error' do
+                  expect { subject.delete(list, email) }.to raise_error(REST::Errors::Forbidden)
+                end
+              end
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,307 @@
+require 'spec_helper'
+
+module Sendgrid
+  module API
+    module Newsletter
+      module Lists
+        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) }
+
+          describe '#add' do
+            let(:url) { 'newsletter/lists/add.json' }
+            let(:listname) { 'list 1' }
+            let(:stub_post) { sg_mock.stub_post(url, :list => listname) }
+
+            subject { service.add(listname) }
+
+            context 'when add a list successfully' do
+              context 'with name' do
+                it_behaves_like 'a success response'
+              end
+
+              context 'with object' do
+                let(:list) { Entities::List.new(:list => listname) }
+                subject { service.add(list) }
+                it_behaves_like 'a success response'
+              end
+            end
+
+            context 'when permission failed' do
+              it_behaves_like 'a forbidden response'
+            end
+
+            context 'when list already exists' do
+              it_behaves_like 'an already exists response'
+            end
+          end
+
+          describe '#edit' do
+            let(:url) { 'newsletter/lists/edit.json' }
+            let(:listname) { 'list 1' }
+            let(:newlistname) { 'new list 1' }
+            let(:stub_post) { sg_mock.stub_post(url, :list => listname, :newlist => newlistname) }
+
+            subject { service.edit(listname, newlistname) }
+
+            context 'when edit a list successfully' do
+              context 'with name' do
+                it_behaves_like 'a success response'
+              end
+
+              context 'with object' do
+                let(:list) { Entities::List.new(:list => listname) }
+                let(:newlist) { Entities::List.new(:list => newlistname) }
+                subject { service.edit(list, newlist) }
+                it_behaves_like 'a success response'
+              end
+            end
+
+            context 'when permission failed' do
+              it_behaves_like 'a forbidden response'
+            end
+
+            context 'when list already exists' do
+              it_behaves_like 'an already exists response'
+            end
+
+            context 'when list does not exist' do
+              it_behaves_like 'a does not exist response'
+            end
+          end
+
+          describe '#delete' do
+            let(:url) { 'newsletter/lists/delete.json' }
+            let(:listname) { 'list 1' }
+            let(:stub_post) { sg_mock.stub_post(url, :list => listname) }
+
+            subject { service.delete(listname) }
+
+            context 'when delete a list successfully' do
+              context 'with name' do
+                it_behaves_like 'a success response'
+              end
+
+              context 'with object' do
+                let(:list) { Entities::List.new(:list => listname) }
+                subject { service.delete(list) }
+                it_behaves_like 'a success response'
+              end
+            end
+
+            context 'when permission failed' do
+              it_behaves_like 'a forbidden response'
+            end
+
+            context 'when list does not exist' do
+              it_behaves_like 'a does not exist response'
+            end
+          end
+
+          describe '#get' do
+            let(:url) { 'newsletter/lists/get.json' }
+            let(:response) { service.get(listname) }
+            let(:listname) { 'list 1' }
+            let(:stub_post) { sg_mock.stub_post(url, :list => listname) }
+            subject { response }
+
+            context 'when get all lists successfully' do
+              let(:stub_post) { sg_mock.stub_post(url) }
+              let(:response) { service.get }
+
+              before do
+                stub_post.to_return(:body => fixture('lists/lists.json'))
+              end
+
+              it { should_not be_empty }
+              it { should have(3).items }
+
+              describe 'first list' do
+                subject { response.first }
+                it { should be_instance_of(Entities::List) }
+                its(:list) { should == 'list 1' }
+              end
+            end
+
+            context 'when get a list successfully' do
+              before do
+                stub_post.to_return(:body => fixture('lists/list.json'))
+              end
+
+              context 'with name' do
+                it { should_not be_empty }
+                it { should have(1).item }
+              end
+
+              context 'with object' do
+                let(:response) { service.get(list) }
+                let(:list) { Entities::List.new(:list => listname) }
+
+                it { should_not be_empty }
+                it { should have(1).item }
+              end
+            end
+
+            context 'when permission failed' do
+              it_behaves_like 'a forbidden response'
+            end
+
+            context 'when not found' do
+              it_behaves_like 'a does not exist response'
+            end
+          end
+
+          describe 'online tests', :online => true do
+            include_examples 'online tests'
+            let(:online) { Online.new(env_user, env_key) }
+            let(:list) { online.list_example }
+            let(:newlistname) { 'sendgrid-api new list test' }
+
+            context 'when credentials are valid' do
+              let(:resource) { REST::Resource.new(env_user, env_key) }
+
+              describe '#add' do
+                after do
+                  subject.delete(list).success? or raise 'could not remove the created list'
+                end
+
+                context 'when add a list successfully' do
+                  it 'adds a list' do
+                    subject.add(list).success?.should be_true
+                  end
+                end
+
+                context 'when list already exists' do
+                  before do
+                    subject.add(list).success? or raise 'could not create the list'
+                  end
+                  it 'raises an error' do
+                    expect { subject.add(list) }.to raise_error(REST::Errors::UnprocessableEntity)
+                  end
+                end
+              end
+
+              describe '#edit' do
+                context 'when edit a list successfully' do
+                  before do
+                    subject.add(list).success? or raise 'could not create the list'
+                  end
+                  after do
+                    subject.delete(newlistname).success? or raise 'could not remove the created list'
+                  end
+                  it 'edits a list' do
+                    subject.edit(list, newlistname).success?.should be_true
+                  end
+                end
+
+                context 'when list does not exist' do
+                  before do
+                    subject.add(newlistname).success? or raise 'could not create the list'
+                  end
+                  after do
+                    subject.delete(newlistname).success? or raise 'could not remove the created list'
+                  end
+                  it 'raises an error' do
+                    expect { subject.edit(list, newlistname) }.to raise_error(REST::Errors::Unauthorized)
+                  end
+                end
+
+                context 'when list already exists' do
+                  before do
+                    subject.add(list).success? or raise 'could not create the list'
+                    subject.add(newlistname).success? or raise 'could not create the list'
+                  end
+                  after do
+                    subject.delete(list).success? or raise 'could not remove the created list'
+                    subject.delete(newlistname).success? or raise 'could not remove the created list'
+                  end
+                  it 'raises an error' do
+                    expect { subject.edit(list, newlistname) }.to raise_error(REST::Errors::Unauthorized)
+                  end
+                end
+              end
+
+              describe '#delete' do
+                context 'when delete a list successfully' do
+                  before do
+                    subject.add(list).success? or raise 'could not create the list'
+                  end
+                  it 'deletes a list' do
+                    subject.delete(list).success?.should be_true
+                  end
+                end
+
+                context 'when list does not exist' do
+                  it 'raises an error' do
+                    expect { subject.delete(list) }.to raise_error(REST::Errors::UnprocessableEntity)
+                  end
+                end
+              end
+
+              describe '#get' do
+                context 'when get all lists successfully' do
+                  before do
+                    subject.add(list).success? or raise 'could not create the list'
+                  end
+                  after do
+                    subject.delete(list).success? or raise 'could not remove the created list'
+                  end
+                  it 'gets a list' do
+                    subject.get.should_not be_empty
+                  end
+                end
+
+                context 'when get a list successfully' do
+                  before do
+                    subject.add(list).success? or raise 'could not create the list'
+                  end
+                  after do
+                    subject.delete(list).success? or raise 'could not remove the created list'
+                  end
+                  it 'gets a list' do
+                    subject.get(list).should_not be_empty
+                  end
+                end
+
+                context 'when list does not exist' do
+                  it 'raises an error' do
+                    expect { subject.get(list) }.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) }.to raise_error(REST::Errors::Forbidden)
+                end
+              end
+              describe '#edit' do
+                it 'raises an error' do
+                  expect { subject.edit(list, newlistname) }.to raise_error(REST::Errors::Forbidden)
+                end
+              end
+              describe '#delete' do
+                it 'raises an error' do
+                  expect { subject.delete(list) }.to raise_error(REST::Errors::Forbidden)
+                end
+              end
+              describe '#get' do
+                it 'raises an error' do
+                  expect { subject.get(list) }.to raise_error(REST::Errors::Forbidden)
+                end
+              end
+            end
+          end
+
+        end
+      end
+    end
+  end
+end