File: helpers_spec.rb

package info (click to toggle)
ruby-email-spec 2.2.0-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, forky, sid, trixie
  • size: 980 kB
  • sloc: ruby: 2,420; makefile: 3
file content (332 lines) | stat: -rw-r--r-- 11,585 bytes parent folder | download
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
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
require File.dirname(__FILE__) + '/../spec_helper'

describe EmailSpec::Helpers do
  include EmailSpec::Helpers

  describe "#visit_in_email" do
    it "visits the link in the email" do
      @to = "jimmy_bean@yahoo.com"
      @body = "<a href='/hello'>Hello!</a>"
      @email = Mail::Message.new(:to => @to, :from => "foo@bar.com", :body => @body)
      allow(self).to receive(:mailbox_for).with(@to).and_return([@email])
      expect(open_email(@to, :from => "foo@bar.com")).to eq(@email)

      expect do
        expect(self).to(receive(:visit).with('/hello'))
        visit_in_email("Hello!")
      end.not_to raise_error
    end

    it "raises an exception when an email is not found" do
      expect do
        visit_in_email("Hello!", 'jon@example.com')
      end.to raise_error(EmailSpec::CouldNotFindEmailError)
    end
  end

  describe "#parse_email_for_link" do
    it "properly finds links with text" do
      email = Mail.new(:body =>  %(<a href="/path/to/page">Click Here</a>))
      expect(parse_email_for_link(email, "Click Here")).to eq("/path/to/page")
    end

    it "properly finds links with text surrounded by tags" do
      email = Mail.new(:body =>  %(
        <a href="/path/to/app">Welcome</a><a href="/path/to/page"><strong>Click Here</strong></a>))

      expect(parse_email_for_link(email, "Click Here")).to eq("/path/to/page")
    end

    it "properly finds links with tags and text in new lines" do
      email = Mail.new(:body =>  <<-HTML
        <a href="/path/to/app">Welcome</a>
        <a href="/path/to/page">
          <strong>
            Click Here
          </strong>
        </a>
        HTML
      )

      expect(parse_email_for_link(email, "Click Here")).to eq("/path/to/page")
    end

    it "recognizes img alt properties as text" do
      email = Mail.new(:body => %(<a href="/path/to/page"><img src="http://host.com/images/image.gif" alt="an image" /></a>))
      expect(parse_email_for_link(email, "an image")).to eq("/path/to/page")
    end

    it "causes a spec to fail if the body doesn't contain the text specified to click" do
      email = Mail.new(:body => "")
      expect { parse_email_for_link(email, "non-existent text") }.to raise_error(  RSpec::Expectations::ExpectationNotMetError)
    end
  end

  describe "#set_current_email" do
    it "should cope with a nil email" do
      expect do
        out = set_current_email(nil)
        expect(out).to be_nil
        expect(email_spec_hash[:current_email]).to be_nil
      end.not_to raise_error
    end

    it "should cope with a real email" do
      email = Mail.new
      expect do
        out = set_current_email(email)
        expect(out).to eq(email)
        expect(email_spec_hash[:current_email]).to eq(email)
      end.not_to raise_error
    end

    shared_examples_for 'something that sets the current email for recipients' do
      before do
        @email = Mail.new(@recipient_type => 'dave@example.com')
      end

      it "should record that the email has been read for that recipient" do
        set_current_email(@email)
        expect(email_spec_hash[:read_emails]['dave@example.com']).to include(@email)
      end

      it "should record that the email has been read for all the recipient of that type" do
        @email.send(@recipient_type) << 'dave_2@example.com'
        set_current_email(@email)
        expect(email_spec_hash[:read_emails]['dave@example.com']).to include(@email)
        expect(email_spec_hash[:read_emails]['dave_2@example.com']).to include(@email)
      end

      it "should record that the email is the current email for the recipient" do
        set_current_email(@email)
        expect(email_spec_hash[:current_emails]['dave@example.com']).to eq(@email)
      end

      it "should record that the email is the current email for all the recipients of that type" do
        @email.send(@recipient_type) << 'dave_2@example.com'
        set_current_email(@email)
        expect(email_spec_hash[:current_emails]['dave@example.com']).to eq(@email)
        expect(email_spec_hash[:current_emails]['dave_2@example.com']).to eq(@email)
      end

      it "should overwrite current email for the recipient with this one" do
        other_mail = Mail.new
        email_spec_hash[:current_emails]['dave@example.com'] = other_mail
        set_current_email(@email)
        expect(email_spec_hash[:current_emails]['dave@example.com']).to eq(@email)
      end

      it "should overwrite the current email for all the recipients of that type" do
        other_mail = Mail.new
        email_spec_hash[:current_emails]['dave@example.com'] = other_mail
        email_spec_hash[:current_emails]['dave_2@example.com'] = other_mail
        @email.send(@recipient_type) << 'dave_2@example.com'
        set_current_email(@email)
        expect(email_spec_hash[:current_emails]['dave@example.com']).to eq(@email)
        expect(email_spec_hash[:current_emails]['dave_2@example.com']).to eq(@email)
      end

      it "should not complain when the email has recipients of that type" do
        @email.send(:"#{@recipient_type}=", nil)
        expect { set_current_email(@email) }.not_to raise_error
      end
    end

    describe "#request_uri(link)" do
      context "without query and anchor" do
        it "returns the path" do
          expect(request_uri('http://www.path.se/to/page')).to eq('/to/page')
        end
      end

      context "with query and anchor" do
        it "returns the path and query and the anchor" do
          expect(request_uri('http://www.path.se/to/page?q=adam#task')).to eq('/to/page?q=adam#task')
        end
      end

      context "with anchor" do
        it "returns the path and query and the anchor" do
          expect(request_uri('http://www.path.se/to/page#task')).to eq('/to/page#task')
        end
      end
    end

    describe 'for mails with recipients in the to address' do
      before do
        @recipient_type = :to
      end

      it_should_behave_like 'something that sets the current email for recipients'
    end

    describe 'for mails with recipients in the cc address' do
      before do
        @recipient_type = :cc
      end

      it_should_behave_like 'something that sets the current email for recipients'
    end

    describe 'for mails with recipients in the bcc address' do
      before do
        @recipient_type = :bcc
      end

      it_should_behave_like 'something that sets the current email for recipients'
    end
  end

  describe '#open_email' do

    describe 'from' do

      before do
        @to = "jimmy_bean@yahoo.com"
        @email = Mail::Message.new(:to => @to, :from => "foo@bar.com")
        allow(self).to receive(:mailbox_for).with(@to).and_return([@email])
      end

      it "should open the email from someone" do
        expect(open_email(@to, :from => "foo@bar.com")).to eq(@email)
      end

    end

    describe 'with subject' do
      shared_examples_for 'something that opens the email with subject' do
        before do
          @to = "jimmy_bean@yahoo.com"
          @email = Mail::Message.new(:to => @to, :subject => @subject)
          allow(self).to receive(:mailbox_for).with(@to).and_return([@email])
        end

        it "should open the email with subject" do
          expect(open_email(@to, :with_subject => @expected)).to eq(@email)
        end
      end

      describe 'simple string subject' do
        before do
          @subject  = 'This is a simple subject'
          @expected = 'a simple'
        end

        it_should_behave_like 'something that opens the email with subject'
      end

      describe 'string with regex sensitive characters' do
        before do
          @subject  = '[app name] Contains regex characters?'
          @expected = 'regex characters?'
        end

        it_should_behave_like 'something that opens the email with subject'
      end

      describe 'regular expression' do
        before do
          @subject = "This is a simple subject"
          @expected = /a simple/
        end

        it_should_behave_like 'something that opens the email with subject'
      end
    end

    describe 'with text' do
      shared_examples_for 'something that opens the email with text' do
        before do
          @to = "jimmy_bean@yahoo.com"
          @email = Mail::Message.new(:to => @to, :body => @body)
          allow(self).to receive(:mailbox_for).with(@to).and_return([@email])
        end

        it "should open the email with text" do
          expect(open_email(@to, :with_text => @text)).to eq(@email)
        end
      end

      describe 'simple string text' do
        before do
          @body = 'This is an email body that is very simple'
          @text = 'email body'
        end

        it_should_behave_like 'something that opens the email with text'
      end

      describe 'string with regex sensitive characters' do
        before do
          @body = 'This is an email body. It contains some [regex] characters?'
          @text = '[regex] characters?'
        end

        it_should_behave_like 'something that opens the email with text'
      end

      describe 'regular expression' do
        before do
          @body = 'This is an email body.'
          @text = /an\ email/
        end

        it_should_behave_like 'something that opens the email with text'
      end
    end

    describe "when the email isn't found" do
      it "includes the mailbox that was looked in when an address was provided" do
        @email_address = "foo@bar.com"
        expect { open_email(@email_address, :with_subject => "baz") }.to raise_error(EmailSpec::CouldNotFindEmailError) { |error| expect(error.message).to include(@email_address) }
      end

      it "includes a warning that no mailboxes were searched when no address was provided" do
        allow(subject).to receive(:last_email_address).and_return nil
        expect { open_email(nil, :with_subject => "baz") }.to raise_error(EmailSpec::NoEmailAddressProvided) { |error| expect(error.message).to eq("No email address has been provided. Make sure current_email_address is returning something.") }
      end

      describe "search by with_subject" do
        before do
          @email_subject = "Subject of 'Nonexistent Email'"
          begin
            open_email("foo@bar.com", :with_subject => @email_subject)
          rescue EmailSpec::CouldNotFindEmailError => e
            @error = e
          end

          expect(@error).not_to be_nil, "expected an error to get thrown so we could test against it, but didn't catch one"
        end

        it "includes the subject that wasn't found in the error message" do
          expect(@error.message).to include(@email_subject)
        end

        it "includes 'with subject' in the error message" do
          expect(@error.message).to include('with subject')
        end
      end

      describe "search by with_text" do
        before do
          @email_text = "This is a line of text from a 'Nonexistent Email'."
          begin
            open_email("foo@bar.com", :with_text => @email_text)
          rescue EmailSpec::CouldNotFindEmailError => e
            @error = e
          end

          expect(@error).not_to be_nil, "expected an error to get thrown so we could test against it, but didn't catch one"
        end

        it "includes the text that wasn't found in the error message" do
          expect(@error.message).to include(@email_text)
        end

        it "includes 'with text' in the error message" do
          expect(@error.message).to include('with text')
        end
      end
    end
  end
end