sendgrid-api 0.0.2 → 0.0.3

data/spec/sendgrid/api/entities/category_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+module Sendgrid
+  module API
+    module Entities
+      describe Category do
+        subject { described_class.new }
+
+        it { should respond_to(:category) }
+
+      end
+    end
+  end
+end

data/spec/sendgrid/api/entities/email_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+module Sendgrid
+  module API
+    module Entities
+      describe Email do
+        subject { described_class.new }
+
+        it { should respond_to(:email) }
+        it { should respond_to(:name) }
+
+      end
+    end
+  end
+end

data/spec/sendgrid/api/entities/list_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+module Sendgrid
+  module API
+    module Entities
+      describe List do
+        subject { described_class.new }
+
+        it { should respond_to(:list) }
+
+        describe '.from_object' do
+          context 'when object is a String' do
+            let(:object) { 'my list name' }
+            subject { described_class.from_object(object) }
+            it { should be_instance_of(described_class) }
+            its(:list) { should == object }
+          end
+
+          context 'when object is a List' do
+            let(:object) { described_class.new(:list => 'my list name') }
+            subject { described_class.from_object(object) }
+            it { should == object }
+          end
+
+          context 'when object is nil' do
+            let(:object) { nil }
+            subject { described_class.from_object(object) }
+            it { should be_nil }
+          end
+        end
+      end
+    end
+  end
+end

data/spec/sendgrid/api/entities/marketing_email_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+module Sendgrid
+  module API
+    module Entities
+      describe MarketingEmail do
+        subject { described_class.new }
+
+        it { should respond_to(:identity) }
+        it { should respond_to(:name) }
+        it { should respond_to(:subject) }
+        it { should respond_to(:text) }
+        it { should respond_to(:html) }
+
+        it { should respond_to(:can_edit) }
+        it { should respond_to(:content_preview) }
+        it { should respond_to(:date_schedule) }
+        it { should respond_to(:is_deleted) }
+        it { should respond_to(:is_split) }
+        it { should respond_to(:is_winner) }
+        it { should respond_to(:newsletter_id) }
+        it { should respond_to(:nl_type) }
+        it { should respond_to(:timezone_id) }
+        it { should respond_to(:total_recipients) }
+        it { should respond_to(:type) }
+        it { should respond_to(:winner_sending_time) }
+
+      end
+    end
+  end
+end

data/spec/sendgrid/api/entities/response_insert_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+module Sendgrid
+  module API
+    module Entities
+      describe ResponseInsert do
+        subject { described_class.new }
+
+        it { should respond_to(:inserted) }
+        
+        context 'with inserts' do
+          subject { described_class.new(:inserted => 3) }
+
+          its(:any?) { should be_true }
+          its(:none?) { should be_false }
+        end
+
+        context 'without inserts' do
+          subject { described_class.new(:inserted => 0) }
+
+          its(:any?) { should be_false }
+          its(:none?) { should be_true }
+        end
+
+      end
+    end
+  end
+end

data/spec/sendgrid/api/entities/response_remove_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+module Sendgrid
+  module API
+    module Entities
+      describe ResponseRemove do
+        subject { described_class.new }
+
+        it { should respond_to(:removed) }
+        
+        context 'with removals' do
+          subject { described_class.new(:removed => 3) }
+
+          its(:any?) { should be_true }
+          its(:none?) { should be_false }
+        end
+
+        context 'without removals' do
+          subject { described_class.new(:removed => 0) }
+
+          its(:any?) { should be_false }
+          its(:none?) { should be_true }
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+module Sendgrid
+  module API
+    module Entities
+      describe Schedule do
+        subject { described_class.new }
+
+        it { should respond_to(:date) }
+
+      end
+    end
+  end
+end

data/spec/sendgrid/api/entities/sender_address_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+module Sendgrid
+  module API
+    module Entities
+      describe SenderAddress do
+        subject { described_class.new }
+
+        it { should respond_to(:identity) }
+        it { should respond_to(:name) }
+        it { should respond_to(:email) }
+        it { should respond_to(:replyto) }
+        it { should respond_to(:address) }
+        it { should respond_to(:city) }
+        it { should respond_to(:state) }
+        it { should respond_to(:zip) }
+        it { should respond_to(:country) }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,247 @@
+require 'spec_helper'
+
+module Sendgrid
+  module API
+    module Newsletter
+      module Categories
+        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 '#create' do
+            let(:url) { 'newsletter/category/create.json' }
+            let(:category_name) { 'my category' }
+            let(:stub_post) { sg_mock.stub_post(url, :category => category_name) }
+            subject { service.create(category_name) }
+
+            context 'when create a category successfully' do
+              context 'with name' do
+                it_behaves_like 'a success response'
+              end
+
+              context 'with objects' do
+                let(:category) { Entities::Category.new(:category => category_name) }
+                subject { service.create(category) }
+                it_behaves_like 'a success response'
+              end
+            end
+
+            context 'when the category already exists' do
+              it_behaves_like 'an already exists unauthorized response'
+            end
+
+            context 'when permission failed' do
+              it_behaves_like 'a forbidden response'
+            end
+          end
+
+          describe '#add' do
+            let(:url) { 'newsletter/category/add.json' }
+            let(:category_name) { 'my category' }
+            let(:marketing_email_name) { 'my marketing email' }
+            let(:stub_post) { sg_mock.stub_post(url, :name => marketing_email_name, :category => category_name) }
+            subject { service.add(marketing_email_name, category_name) }
+
+            context 'when add a category successfully' do
+              context 'with name' do
+                it_behaves_like 'a success response'
+              end
+
+              context 'with objects' do
+                let(:category) { Entities::Category.new(:category => category_name) }
+                let(:marketing_email) { Entities::MarketingEmail.new(:name => marketing_email_name) }
+                subject { service.add(marketing_email, category) }
+                it_behaves_like 'a success response'
+              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 '#remove' do
+            let(:url) { 'newsletter/category/remove.json' }
+            let(:category_name) { 'my category' }
+            let(:marketing_email_name) { 'my marketing email' }
+            let(:stub_post) { sg_mock.stub_post(url, :name => marketing_email_name, :category => category_name) }
+            subject { service.remove(marketing_email_name, category_name) }
+
+            context 'when remove a category successfully' do
+              context 'with name' do
+                it_behaves_like 'a success response'
+              end
+
+              context 'with objects' do
+                let(:category) { Entities::Category.new(:category => category_name) }
+                let(:marketing_email) { Entities::MarketingEmail.new(:name => marketing_email_name) }
+                subject { service.remove(marketing_email, category) }
+                it_behaves_like 'a success response'
+              end
+            end
+
+            context 'when the category does not exist' do
+              it_behaves_like 'a does not exist 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 '#list' do
+            let(:url) { 'newsletter/category/list.json' }
+            let(:stub_post) { sg_mock.stub_post(url) }
+            subject { service.list }
+
+            context 'when list all categories successfully' do
+              before do
+                stub_post.to_return(:body => fixture('categories.json'))
+              end
+
+              it { should have(3).items }
+
+              describe 'first item' do
+                subject { service.list.first }
+                its(:category) { should == 'sendgrid' }
+              end
+            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(:category) { online.category_example }
+            let(:marketing_email) { online.marketing_email_example }
+
+            context 'when credentials are valid' do
+              before do
+                # try to create the test category
+                # note: categories can't be removed for now
+                begin
+                  subject.create(category)
+                rescue REST::Errors::Unauthorized
+                  # it already exists, do nothing
+                end
+              end
+              let(:resource) { REST::Resource.new(env_user, env_key) }
+
+              describe '#create' do
+                context 'when the category already exists' do
+                  it 'raises an error' do
+                    expect { subject.create(category) }.to raise_error(REST::Errors::Unauthorized)
+                  end
+                end
+              end
+
+              describe '#add' do
+                context 'when add a category successfully' do
+                  before do
+                    online.add_marketing_email
+                  end
+                  after do
+                    online.delete_marketing_email
+                  end
+                  it 'adds the category' do
+                    subject.add(marketing_email, category).success?.should be_true
+                  end
+                end
+
+                context 'when the marketing email does not exist' do
+                  it 'raises an error' do
+                    expect { subject.add(marketing_email, category) }.to raise_error(REST::Errors::Unauthorized)
+                  end
+                end
+              end
+
+              describe '#remove' do
+                context 'when remove a category successfully' do
+                  before do
+                    online.add_marketing_email
+                    subject.add(marketing_email, category)
+                  end
+                  after do
+                    online.delete_marketing_email
+                  end
+                  it 'removes the category' do
+                    subject.remove(marketing_email, category).success?.should be_true
+                  end
+                end
+
+                context 'when the marketing email does not exist' do
+                  it 'raises an error' do
+                    expect { subject.remove(marketing_email, category) }.to raise_error(REST::Errors::Unauthorized)
+                  end
+                end
+
+                context 'when the category 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.remove(marketing_email, category) }.to raise_error(REST::Errors::Unauthorized)
+                  end
+                end
+              end
+
+              describe '#list' do
+                context 'when list all categories successfully' do
+                  it 'get all categories' do
+                    subject.list.should_not be_empty
+                  end
+                end
+              end
+            end
+
+            context 'when credentials are invalid' do
+              describe '#create' do
+                it 'raises an error' do
+                  expect { subject.create(category) }.to raise_error(REST::Errors::Forbidden)
+                end
+              end
+
+              describe '#add' do
+                it 'raises an error' do
+                  expect { subject.add(marketing_email, category) }.to raise_error(REST::Errors::Forbidden)
+                end
+              end
+
+              describe '#remove' do
+                it 'raises an error' do
+                  expect { subject.remove(marketing_email, category) }.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
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

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