aboutsummaryrefslogtreecommitdiffstats
path: root/spec/mailers/track_mailer_spec.rb
blob: e8094b692468ab70a38fbeaee46ea6829bf1bded (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')

describe TrackMailer do

    describe 'when sending email alerts for tracked things' do

        before do
            mail_mock = mock("mail")
            mail_mock.stub(:deliver)
            TrackMailer.stub!(:event_digest).and_return(mail_mock)
            Time.stub!(:now).and_return(Time.utc(2007, 11, 12, 23, 59))
        end

        it 'should ask for all the users whose last daily track email was sent more than a day ago' do
            expected_conditions = [ "last_daily_track_email < ?", Time.utc(2007, 11, 11, 23, 59)]
            User.should_receive(:find_each).with(:conditions => expected_conditions)
            TrackMailer.alert_tracks
        end

        describe 'for each user' do

            before do
                @user = mock_model(User, :no_xapian_reindex= => false,
                                         :last_daily_track_email= => true,
                                         :save! => true,
                                         :url_name => 'test-name',
                                         :get_locale => 'en',
                                         :should_be_emailed? => true)
                User.stub!(:find_each).and_yield(@user)
                @user.stub!(:receive_email_alerts).and_return(true)
                @user.stub!(:no_xapian_reindex=)
            end

            it 'should ask for any daily track things for the user' do
                expected_conditions = [ "tracking_user_id = ? and track_medium = ?", @user.id, 'email_daily' ]
                TrackThing.should_receive(:find).with(:all, :conditions => expected_conditions).and_return([])
                TrackMailer.alert_tracks
            end


            it 'should set the no_xapian_reindex flag on the user' do
                @user.should_receive(:no_xapian_reindex=).with(true)
                TrackMailer.alert_tracks
            end

            it 'should update the time of the user\'s last daily tracking email' do
                @user.should_receive(:last_daily_track_email=).with(Time.now)
                @user.should_receive(:save!)
                TrackMailer.alert_tracks
            end
            it 'should return true' do
                TrackMailer.alert_tracks.should == true
            end


            describe 'for each tracked thing' do

                before do
                    @track_things_sent_emails_array = []
                    @track_things_sent_emails_array.stub!(:find).and_return([]) # this is for the date range find (created in last 14 days)
                    @track_thing = mock_model(TrackThing, :track_query => 'test query',
                                                          :track_things_sent_emails => @track_things_sent_emails_array,
                                                          :created_at => Time.utc(2007, 11, 9, 23, 59))
                    TrackThing.stub!(:find).and_return([@track_thing])
                    @track_things_sent_email = mock_model(TrackThingsSentEmail, :save! => true,
                                                                                :track_thing_id= => true,
                                                                                :info_request_event_id= => true)
                    TrackThingsSentEmail.stub!(:new).and_return(@track_things_sent_email)
                    @xapian_search = mock('xapian search', :results => [])
                    @found_event = mock_model(InfoRequestEvent, :described_at => @track_thing.created_at + 1.day)
                    @search_result = {:model => @found_event}
                    ActsAsXapian::Search.stub!(:new).and_return(@xapian_search)
                end

                it 'should ask for the events returned by the tracking query' do
                    ActsAsXapian::Search.should_receive(:new).with([InfoRequestEvent], 'test query',
                        :sort_by_prefix => 'described_at',
                        :sort_by_ascending => true,
                        :collapse_by_prefix => nil,
                        :limit => 100).and_return(@xapian_search)
                    TrackMailer.alert_tracks
                end

                it 'should not include in the email any events that the user has already been sent a tracking email about' do
                    sent_email = mock_model(TrackThingsSentEmail, :info_request_event_id => @found_event.id)
                    @track_things_sent_emails_array.stub!(:find).and_return([sent_email]) # this is for the date range find (created in last 14 days)
                    @xapian_search.stub!(:results).and_return([@search_result])
                    TrackMailer.should_not_receive(:event_digest)
                    TrackMailer.alert_tracks
                end

                it 'should not include in the email any events not sent in a previous tracking email that were described before the track was set up' do
                    @found_event.stub!(:described_at).and_return(@track_thing.created_at - 1.day)
                    @xapian_search.stub!(:results).and_return([@search_result])
                    TrackMailer.should_not_receive(:event_digest)
                    TrackMailer.alert_tracks
                end

                it 'should include in the email any events that the user has not been sent a tracking email on that have been described since the track was set up' do
                    @found_event.stub!(:described_at).and_return(@track_thing.created_at + 1.day)
                    @xapian_search.stub!(:results).and_return([@search_result])
                    TrackMailer.should_receive(:event_digest)
                    TrackMailer.alert_tracks
                end

                it 'should raise an error if a non-event class is returned by the tracking query' do
                    @xapian_search.stub!(:results).and_return([{:model => 'string class'}])
                    lambda{ TrackMailer.alert_tracks }.should raise_error('need to add other types to TrackMailer.alert_tracks (unalerted)')
                end

                it 'should record that a tracking email has been sent for each event that has been included in the email' do
                    @xapian_search.stub!(:results).and_return([@search_result])
                    sent_email = mock_model(TrackThingsSentEmail)
                    TrackThingsSentEmail.should_receive(:new).and_return(sent_email)
                    sent_email.should_receive(:track_thing_id=).with(@track_thing.id)
                    sent_email.should_receive(:info_request_event_id=).with(@found_event.id)
                    sent_email.should_receive(:save!)
                    TrackMailer.alert_tracks
                end
            end

        end

        describe 'when a user should not be emailed' do
            before do
                @user = mock_model(User, :no_xapian_reindex= => false,
                                         :last_daily_track_email= => true,
                                         :save! => true,
                                         :url_name => 'test-name',
                                         :should_be_emailed? => false)
                User.stub!(:find_each).and_yield(@user)
                @user.stub!(:receive_email_alerts).and_return(true)
                @user.stub!(:no_xapian_reindex=)
            end

            it 'should not ask for any daily track things for the user' do
                expected_conditions = [ "tracking_user_id = ? and track_medium = ?", @user.id, 'email_daily' ]
                TrackThing.should_not_receive(:find).with(:all, :conditions => expected_conditions)
                TrackMailer.alert_tracks
            end

            it 'should not ask for any daily track things for the user if they have receive_email_alerts off but could otherwise be emailed' do
                @user.stub(:should_be_emailed?).and_return(true)
                @user.stub(:receive_email_alerts).and_return(false)
                expected_conditions = [ "tracking_user_id = ? and track_medium = ?", @user.id, 'email_daily' ]
                TrackThing.should_not_receive(:find).with(:all, :conditions => expected_conditions)
                TrackMailer.alert_tracks
            end

            it 'should not set the no_xapian_reindex flag on the user' do
                @user.should_not_receive(:no_xapian_reindex=).with(true)
                TrackMailer.alert_tracks
            end

            it 'should not update the time of the user\'s last daily tracking email' do
                @user.should_not_receive(:last_daily_track_email=).with(Time.now)
                @user.should_not_receive(:save!)
                TrackMailer.alert_tracks
            end
            it 'should return false' do
                TrackMailer.alert_tracks.should == false
            end
        end

    end

    describe 'delivering the email' do

        before :each do
          @post_redirect = mock_model(PostRedirect, :save! => true,
                                                    :email_token => "token")
          PostRedirect.stub!(:new).and_return(@post_redirect)
          ActionMailer::Base.deliveries = []
          @user = mock_model(User,
            :name_and_email => MailHandler.address_from_name_and_email('Tippy Test', 'tippy@localhost'),
            :url_name => 'tippy_test'
          )
          TrackMailer.event_digest(@user, []).deliver # no items in it email for minimal test
        end

        it 'should deliver one email, with right headers' do
            deliveries = ActionMailer::Base.deliveries
            if deliveries.size > 1 # debugging if there is an error
                deliveries.each do |d|
                    $stderr.puts "------------------------------"
                    $stderr.puts d.body
                    $stderr.puts "------------------------------"
                end
            end
            deliveries.size.should == 1
            mail = deliveries[0]

            mail['Auto-Submitted'].to_s.should == 'auto-generated'
            mail['Precedence'].to_s.should == 'bulk'

            deliveries.clear
        end

        context "force ssl is off" do
            # Force SSL is off in the tests. Since the code that selectively switches the protocols
            # is in the initialiser for Rails it's hard to test. Hmmm...
            # We could AlaveteliConfiguration.stub!(:force_ssl).and_return(true) but the config/environment.rb
            # wouldn't get reloaded

            it "should have http links in the email" do
                deliveries = ActionMailer::Base.deliveries
                deliveries.size.should == 1
                mail = deliveries[0]

                mail.body.should include("http://")
                mail.body.should_not include("https://")
            end
        end
    end

end