contactology 0.0.1

data/spec/models/contactology/campaigns/standard_spec.rb

@@ -0,0 +1,84 @@
+require 'spec_helper'
+
+describe Contactology::Campaigns::Standard do
+  context '.create' do
+    context 'when successful' do
+      use_vcr_cassette 'campaigns/standard/create/success'
+      let(:list) { Factory :list, :name => 'campaign-standard-create-success' }
+      let(:campaign) { create_campaign :recipients => list }
+      after(:each) { list.destroy; campaign.destroy }
+
+      subject { campaign }
+
+      it { should be_instance_of Contactology::Campaigns::Standard }
+      its(:id) { should_not be_nil }
+    end
+
+    context 'with invalid data' do
+      use_vcr_cassette 'campaigns/standard/create/invalid'
+      let(:list) { Factory :list, :name => 'campaign-standard-create-invalid' }
+      let(:campaign) { create_campaign :sender_email => 'bad@example', :recipients => list }
+      after(:each) { list.destroy }
+
+      subject { campaign }
+
+      it { should be_false }
+    end
+
+    context 'with required attributes missing' do
+      use_vcr_cassette 'campaigns/standard/create/failure'
+      let(:list) { Factory :list, :name => 'campaign-standard-create-failure' }
+      let(:campaign) { create_campaign :name => nil, :recipients => list }
+      after(:each) { list.destroy }
+
+      subject { campaign }
+
+      it 'raises an ArgumentError' do
+        expect { subject }.to raise_error(ArgumentError, /The property 'name' is required/)
+      end
+    end
+  end
+
+  context '#send_campaign' do
+    context 'when successful' do
+      use_vcr_cassette 'campaigns/standard/send_campaign/success'
+      let(:list) { Factory :list, :name => 'send-standard-campaign-success' }
+      let(:contact) { Factory :contact }
+      let(:campaign) { Factory :standard_campaign, :recipients => list }
+
+      before(:each) { list.subscribe contact }
+      after(:each) { list.destroy; contact.destroy; campaign.destroy }
+
+      subject { campaign.send_campaign }
+
+      it { should be_instance_of Contactology::SendResult }
+      it { should be_successful }
+      its(:issues) { should be_empty }
+    end
+
+    context 'when unsuccessful (high spam score)' do
+      use_vcr_cassette 'campaigns/standard/send_campaign/failure'
+      let(:list) { Factory :list, :name => 'send-standard-campaign-failure' }
+      let(:contact) { Factory :contact }
+      let(:campaign) { Factory :standard_campaign, :recipients => list, :content => {'text' => 'OMG BUY VIAGRA'} }
+
+      before(:each) { list.subscribe(contact) }
+      after(:each) { list.destroy; contact.destroy; campaign.destroy }
+
+      subject { campaign.send_campaign }
+
+      it { should be_instance_of Contactology::SendResult }
+      it { should_not be_successful }
+      its(:issues) { should_not be_empty }
+      its(:score) { should be < 100 }
+    end
+  end
+
+
+  private
+
+
+  def create_campaign(attributes = {})
+    Contactology::Campaigns::Standard.create Factory.attributes_for(:standard_campaign).merge(attributes)
+  end
+end

data/spec/models/contactology/campaigns/transactional_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe Contactology::Campaigns::Transactional do
+  context '.create' do
+    context 'when successful' do
+      use_vcr_cassette 'campaigns/transactional/create/success'
+      let(:campaign) { Contactology::Campaigns::Transactional.create Factory.attributes_for(:transactional_campaign) }
+      after(:each) { campaign.destroy }
+
+      subject { campaign }
+
+      it { should be_instance_of Contactology::Campaigns::Transactional }
+      its(:id) { should_not be_nil }
+      its(:object_id) { should == campaign.object_id }
+    end
+
+    context 'when unsuccessful' do
+      use_vcr_cassette 'campaigns/transactional/create/failure'
+      let(:campaign) { Contactology::Campaigns::Transactional.create Factory.attributes_for(:transactional_campaign).merge(:content => {:text => 'bad'}) }
+
+      subject { campaign }
+
+      it { should be_kind_of Contactology::SendResult }
+      it { should_not be_successful }
+      its(:issues) { should_not be_empty }
+    end
+  end
+end

data/spec/models/contactology/configuration_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe Contactology::Configuration do
+  let(:configuration) { Contactology::Configuration.new }
+
+  context '#endpoint' do
+    it 'defaults to http://api.emailcampaigns.net/2/REST/' do
+      configuration.endpoint.should == 'https://api.emailcampaigns.net/2/REST/'
+    end
+
+    it 'may be overridden' do
+      expect {
+        configuration.endpoint = 'https://example.local/'
+      }.to change(configuration, :endpoint).to('https://example.local/')
+    end
+  end
+
+  context '#key' do
+    it 'is unset by default' do
+      configuration.key.should be_nil
+    end
+
+    it 'may be set' do
+      expect {
+        configuration.key = 'abcdefg'
+      }.to change(configuration, :key).to('abcdefg')
+    end
+  end
+end

data/spec/models/contactology/contact_spec.rb

@@ -0,0 +1,175 @@
+require 'spec_helper'
+
+describe Contactology::Contact do
+  context '.create' do
+    use_vcr_cassette 'contact/create'
+
+    it 'raises an ArgumentError without an :email given' do
+      expect {
+        Contactology::Contact.create
+      }.to raise_error(ArgumentError)
+    end
+
+    context 'when successful' do
+      let(:contact) { Contactology::Contact.create :email => 'created@example.com' }
+      subject { contact }
+      after(:each) { contact.destroy }
+
+      it 'creates a new contact' do
+        subject
+        Contactology::Contact.find('created@example.com').should_not be_nil
+      end
+
+      it { should be_kind_of Contactology::Contact }
+      its(:email) { should eql 'created@example.com' }
+      its(:active?) { should be_true }
+    end
+  end
+
+  context '.find' do
+    context 'for a matching, active contact' do
+      use_vcr_cassette 'contact/find/active'
+      let(:contact) { Contactology::Contact.create(:email => 'found@example.com') }
+      after(:each) { contact.destroy }
+      subject { Contactology::Contact.find(contact.email) }
+
+      it { should be_kind_of Contactology::Contact }
+      its(:email) { should eql 'found@example.com' }
+      it { should be_active }
+    end
+
+    context 'for a matching, suppressed contact' do
+      use_vcr_cassette 'contact/find/suppressed'
+      let(:contact) { Contactology::Contact.create(:email => 'found-suppressed@example.com') }
+      before(:each) { contact.suppress }
+      after(:each) { contact.destroy }
+      subject { Contactology::Contact.find('found-suppressed@example.com') }
+
+      it { should be_kind_of Contactology::Contact }
+      its(:email) { should eql 'found-suppressed@example.com' }
+      it { should be_suppressed }
+    end
+
+    context 'for an unknown email' do
+      use_vcr_cassette 'contact/find/unknown'
+      subject { Contactology::Contact.find('unknown@example.com') }
+      it { should be_nil }
+    end
+  end
+
+  context '#active?' do
+    use_vcr_cassette 'contact/active'
+    let(:contact) do
+      Contactology::Contact.create :email => 'active@example.com'
+      Contactology::Contact.find 'active@example.com'
+    end
+    subject { contact.active? }
+    after(:each) { contact.destroy }
+
+    it { should be_true }
+  end
+
+  context '#change_email' do
+    context 'for a known contact' do
+      use_vcr_cassette 'contact/change_email/success'
+      let(:contact) { Contactology::Contact.create :email => 'change-email-3@example.com' }
+      let(:new_email) { 'changed-3@example.com' }
+      subject { contact.change_email new_email }
+      after(:each) { contact.destroy }
+
+      it 'updates the Contactology email' do
+        expect { subject }.to change { Contactology::Contact.find new_email }.from(nil)
+      end
+
+      it { should be_true }
+      
+      it 'updates the local contact email' do
+        expect { subject }.to change(contact, :email).to(new_email)
+      end
+    end
+
+    context 'for an unknown contact' do
+      use_vcr_cassette 'contact/change_email/unknown'
+      let(:contact) { Contactology::Contact.new(:email => 'unknown@example.com') }
+      subject { contact.change_email 'changefail@example.com' }
+
+      it { should be_false }
+      
+      it 'does not update the local contact email' do
+        expect { subject }.to_not change(contact, :email)
+      end
+    end
+  end
+
+  context '#destroy' do
+    use_vcr_cassette 'contact/destroy'
+
+    context 'when successful' do
+      let(:contact) { Contactology::Contact.create :email => 'destroy@example.com' }
+      subject { contact.destroy }
+
+      it 'deletes the contact on Contactology' do
+        expect { subject }.to change(contact, :deleted?).to(true)
+      end
+
+      it { should be_true }
+    end
+  end
+
+  context '#lists' do
+    context 'for a known contact with subscription lists' do
+      use_vcr_cassette 'contact/lists/full'
+      let(:contact) { Contactology::Contact.create :email => 'lists@example.com' }
+      let(:list) { Contactology::List.create :name => 'contact-list-test' }
+      before(:each) { list.subscribe contact.email }
+      after(:each) { contact.destroy; list.destroy }
+
+      subject { contact.lists }
+
+      it { should be_kind_of Enumerable }
+      it { should_not be_empty }
+      
+      it 'contains the subscribed list' do
+        subject.any? { |remote_list| remote_list.id == list.id }.should be_true
+      end
+    end
+
+    context 'for a known contact without subscription lists' do
+      use_vcr_cassette 'contact/lists/empty'
+      let(:contact) { Contactology::Contact.create :email => 'emptylists@example.com' }
+      subject { contact.lists }
+      after(:each) { contact.destroy }
+
+      it { should be_kind_of Enumerable }
+      it { should be_empty }
+    end
+
+    context 'for an unknown contact' do
+      use_vcr_cassette 'contact/lists/unknown'
+      let(:contact) { Contactology::Contact.new :email => 'unknown@example.com' }
+      subject { contact.lists }
+      after(:each) { contact.destroy }
+
+      it { should be_kind_of Enumerable }
+      it { should be_empty }
+    end
+  end
+
+  context '#suppress' do
+    use_vcr_cassette 'contact/suppress'
+    let(:contact) do
+      Contactology::Contact.create :email => 'suppressed@example.com'
+      Contactology::Contact.find 'suppressed@example.com'
+    end
+    subject { contact.suppress }
+    after(:each) { contact.destroy }
+
+    it { should be_true }
+
+    context 'the contact' do
+      subject { contact.suppress; contact }
+
+      its(:suppressed?) { should be_true }
+    end
+  end
+end

data/spec/models/contactology/issues_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe Contactology::Issues do
+  let(:issues) { Contactology::Issues.new }
+  subject { issues }
+
+  it 'is empty by default' do
+    issues.should be_empty
+  end
+
+  it 'holds Contactology::Issue objects' do
+    issues = Contactology::Issues.new('issues' => [Factory.attributes_for(:issue)])
+    issues.should_not be_empty
+    issues.all? { |i| i.kind_of?(Contactology::Issue) }.should be_true
+  end
+
+  it 'converts pushed objects to Issue instances' do
+    expect {
+      issues << Factory.attributes_for(:issue)
+    }.to change(issues, :size).by(1)
+
+    issues.all? { |i| i.kind_of? Contactology::Issue }.should be_true
+  end
+
+  context '#score' do
+    it 'defaults to 0' do
+      Contactology::Issues.new.score.should == 0
+    end
+
+    it 'may be set during initialization' do
+      Contactology::Issues.new('score' => 95).score.should == 95
+    end
+  end
+end

data/spec/models/contactology/list_spec.rb

@@ -0,0 +1,125 @@
+require 'spec_helper'
+
+describe Contactology::List do
+  context '.all' do
+    use_vcr_cassette 'list/all'
+    let!(:list) { Contactology::List.create :name => 'all-test-list' }
+    after(:each) { list.destroy }
+
+    subject { Contactology::List.all }
+
+    it { should be_kind_of Enumerable }
+    it { should_not be_empty }
+
+    it 'contains List instances' do
+      subject.each do |o|
+        o.should be_kind_of Contactology::List
+      end
+    end
+
+    it 'contains the created list' do
+      subject.any? { |remote_list|
+        remote_list.id == list.id &&
+          remote_list.name == list.name
+      }.should be_true
+    end
+  end
+
+  context '.create' do
+    it 'raises an ArgumentError without a name given' do
+      expect {
+        Contactology::List.create
+      }.to raise_error(ArgumentError)
+    end
+
+    context 'when successful' do
+      use_vcr_cassette 'list/create'
+      let(:list) { Contactology::List.create :name => 'creationtest' }
+      subject { list }
+      after(:each) { list.destroy }
+
+      it { should be_instance_of Contactology::List }
+      it { should be_public }
+
+      its(:name) { should eql 'creationtest' }
+      its(:id) { should_not be_empty }
+      its(:type) { should eql 'public' }
+    end
+  end
+
+  context '.find' do
+    context 'when successful' do
+      use_vcr_cassette 'list/find/success'
+      let(:list) { Contactology::List.create :name => 'find-success' }
+      subject { Contactology::List.find list.id }
+      after(:each) { list.destroy }
+
+      it { should be_kind_of Contactology::List }
+      it { should be_public }
+      it { should_not be_opt_in }
+      its(:id) { should == list.id }
+      its(:name) { should == list.name }
+    end
+
+    context 'for an unknown list' do
+      use_vcr_cassette 'list/find/unknown'
+      subject { Contactology::List.find '123456789' }
+
+      it { should be_nil }
+    end
+  end
+
+  context '#destroy' do
+    use_vcr_cassette 'list/destroy'
+    let(:list) { Contactology::List.create :name => 'destroy-list' }
+    subject { list.destroy }
+
+    it 'removes the list from Contactology' do
+      expect { list.destroy }.to change { Contactology::List.find list.id }.to(nil)
+    end
+
+    it { should be_true }
+  end
+
+  context '#import' do
+    context 'when successful' do
+      use_vcr_cassette 'list/import/success'
+      let(:list) { Contactology::List.create :name => 'import-test' }
+      let(:email) { 'import@example.com' }
+      let(:contact) { Contactology::Contact.find email }
+      after(:each) { list.destroy; contact.destroy if contact }
+
+      subject { list.import [{'email' => email}] }
+
+      it { should be_true }
+    end
+
+    context 'with an failure' do
+    end
+  end
+
+  context '#subscribe' do
+    context 'when successful' do
+      use_vcr_cassette 'list/subscribe/success'
+      let(:contact) { Contactology::Contact.create :email => 'successful-subscribe@example.com' }
+      let(:list) { Contactology::List.create :name => 'subscribe-test' }
+      after(:each) { contact.destroy; list.destroy }
+      subject { list.subscribe contact.email }
+
+      it { should be_true }
+    end
+  end
+
+  context '#unsubscribe' do
+    context 'when successful' do
+      use_vcr_cassette 'list/unsubscribe/success'
+      let(:contact) { Contactology::Contact.create :email => 'successful-unsubscribe@example.com' }
+      let(:list) { Contactology::List.create :name => 'unsubscribe-test' }
+      before(:each) { list.subscribe contact.email }
+      after(:each) { contact.destroy; list.destroy }
+      subject { list.unsubscribe contact.email }
+
+      it { should be_true }
+    end
+  end
+end